[ { "name": "ariaLabel", "type": "string", "required": false, "description": "The text for the `aria-label` which labels the cookie banner region. This region applies to all messages that the cookie banner includes. For example, the cookie message and the confirmation message. Defaults to 'Cookie banner'." }, { "name": "hidden", "type": "boolean", "required": false, "description": "Defaults to `false`. If you set this option to `true`, the whole cookie banner is hidden, including all messages within the banner. You can use `hidden` for client-side implementations where the cookie banner HTML is present, but hidden until the cookie banner is shown using JavaScript." }, { "name": "classes", "type": "string", "required": false, "description": "The additional classes that you want to add to the cookie banner." }, { "name": "attributes", "type": "object", "required": false, "description": "The additional attributes that you want to add to the cookie banner. For example, data attributes." }, { "name": "messages", "type": "array", "required": true, "description": "The different messages you can pass into the cookie banner. For example, the cookie message and the confirmation message.", "params": [ { "name": "headingText", "type": "string", "required": false, "description": "The heading text that displays in the message. You can use any string with this option. If you set `headingHtml`, `headingText` is ignored." }, { "name": "headingHtml", "type": "string", "required": false, "description": "The heading HTML to use within the message. You can use any string with this option. If you set `headingHtml`, `headingText` is ignored. If you are not passing HTML, use `headingText`." }, { "name": "text", "type": "string", "required": true, "description": "The text for the main content within the message. You can use any string with this option. If you set `html`, `text` is not required and is ignored." }, { "name": "html", "type": "string", "required": true, "description": "The HTML for the main content within the message. You can use any string with this option. If you set `html`, `text` is not required and is ignored. If you are not passing HTML, use `text`." }, { "name": "actions", "type": "array", "required": false, "description": "The buttons and links that you want to display in the message. `actions` defaults to `button` unless you set `href`, which renders the action as a link.", "params": [ { "name": "text", "type": "string", "required": true, "description": "The button or link text." }, { "name": "type", "type": "string", "required": false, "description": "The type of button. You can set `button` or `submit`. Set `button` and `href` to render a link styled as a button. If you set `href`, it overrides `submit`." }, { "name": "href", "type": "string", "required": false, "description": "The `href` for a link. Set `button` and `href` to render a link styled as a button." }, { "name": "name", "type": "string", "required": false, "description": "The name attribute for the button. Does not apply if you set `href`, which makes a link." }, { "name": "value", "type": "string", "required": false, "description": "The value attribute for the button. Does not apply if you set `href`, which makes a link." }, { "name": "classes", "type": "string", "required": false, "description": "The additional classes that you want to add to the button or link." }, { "name": "attributes", "type": "object", "required": false, "description": "The additional attributes that you want to add to the button or link. For example, data attributes." } ] }, { "name": "hidden", "type": "boolean", "required": false, "description": "Defaults to `false`. If you set it to `true`, the message is hidden. You can use `hidden` for client-side implementations where the confirmation message HTML is present, but hidden on the page." }, { "name": "role", "type": "string", "required": false, "description": "Set `role` to `alert` on confirmation messages to allow assistive tech to automatically read the message. You will also need to move focus to the confirmation message using JavaScript you have written yourself." }, { "name": "classes", "type": "string", "required": false, "description": "The additional classes that you want to add to the message." }, { "name": "attributes", "type": "object", "required": false, "description": "The additional attributes that you want to add to the message. For example, data attributes." } ] } ]