JSDoc: o-banner

new Banner(bannerElement, options)

Represents a banner.

Class constructor.

Methods

• render - (instance) Render the banner.
• open - (instance) Open the banner.
• close - (instance) Close the banner.
• buildBannerElement(bannerElement) - (instance) Build a full banner element. This is used when no banner or a partial banner exists in the DOM.
• buildCloseButtonElement - (instance) Build a close button element.
• getOptionsFromDom(bannerElement) - (static) Get the data attributes from the bannerElement. If the banner is being set up declaratively, this method is used to extract the data attributes from the DOM.
• init(rootElement, options) - (static) Initialise banner components.

Links

• "Banner" class on Github

Banner#render

Instance Method

Render the banner.

Links

• "render" function on Github

Banner#open

Instance Method

Open the banner.

Links

• "open" function on Github

Banner#close

Instance Method

Close the banner.

Links

• "close" function on Github

Banner#buildBannerElement(bannerElement)

Instance Method

Build a full banner element. This is used when no banner or a partial banner exists in the DOM.

Returns

• HTMLElement - Returns the new banner element

Links

• "buildBannerElement" function on Github

Banner#buildCloseButtonElement

Instance Method

Build a close button element.

Returns

• HTMLElement - Returns the new close button element

Links

• "buildCloseButtonElement" function on Github

Banner.getOptionsFromDom(bannerElement)

Static Method

Get the data attributes from the bannerElement. If the banner is being set up declaratively, this method is used to extract the data attributes from the DOM.

Links

• "getOptionsFromDom" function on Github

Banner.init(rootElement, options)

Static Method

Initialise banner components.

Links

• "init" function on Github