Origami Frontend Components & Services

JSDoc: o-cookie-message

It looks like JsDocs for o-cookie-message@6.5.0 are missing or formatted incorrectly.

For component documentation see the readme.

CookieMessage#updateConsent

Instance Method

Enables cookie setting behaviour from the FT consent service https://github.com/Financial-Times/next-consent-proxy/tree/master/src

Returns

  • void

Links

CookieMessage#shouldShowCookieMessage

Instance Method

Checks whether cookie is set

Returns

  • boolean - - should the cookie message be shown

Links

CookieMessage#showCookieMessage

Instance Method

Displays cookie message banner, based on existing cookies.

Returns

  • void

Links

CookieMessage#removeCookieMessage

Instance Method

Removes cookie message banner.

Returns

  • void

Links

CookieMessage#destroy

Instance Method

Undo theme and event listeners set on init.

Returns

  • void

Links

CookieMessage.getOptionsFromDom(cookieMessageElement)

Static Method

Get the data attributes from the cookieMessageElement. If the cookie message is being set up declaratively, this method is used to extract the data attributes from the DOM.

parameter type default description
cookieMessageElement HTMLElement The cookie message element in the DOM

Returns

  • Object.<string, any> - - The options

Links

CookieMessage.init(rootElement, options)

Static Method

Initialise cookie message components.

parameter type default description
rootElement HTMLElement | string The root element to intialise cookie messages in, or a CSS selector for the root element
options (optional) object {} An options object for configuring the cookie messages

Returns

  • CookieMessage | Array.<CookieMessage> - - The newly instantiated CookieMessage (or CookieMessages, if rootElement was not a banner)

Links

Status
active
Switch component view

GitHub: o-cookie-message@6.5.0

Install o-cookie-message

If using the Build Service, add o-cookie-message@^6.5.0 to your script and link tags.

If using the npm package manager for a Manual Build, run npm install --save-peer "@financial-times/o-cookie-message@^6.5.0".

Help & Support

o-cookie-message is maintained directly by the Origami team. If you have any questions about o-cookie-message or Origami in general, we are happy to help. 😊

Slack: #origami-support
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #origami-support
Email: origami.support@ft.com