Origami Frontend Components & Services

JSDoc: o-cookie-message

It looks like JsDocs for o-cookie-message@4.6.3 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

Links

CookieMessage#shouldShowCookieMessage

Instance Method

Checks whether cookie is set

Links

CookieMessage#showCookieMessage

Instance Method

Displays cookie message banner, based on existing cookies.

Links

CookieMessage#removeCookieMessage

Instance Method

Removes cookie message banner.

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

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

Links

Switch component view

GitHub Repository

Install o-cookie-message

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

If running a Manual Build, run bower install --save "o-cookie-message@^4.6.3".

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: #ft-origami
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: #ft-origami
Email: origami.support@ft.com