Expand Accordion
Fire whenever a user expands an accordion item.
If using data attributes, the data-layer-event
attribute should be dynamically updated from collapse_accordion
to expand_accordion
whenever the accordion is expanded so this event will fire.
HTML Data Attributes
<a href="<link_url>"
data-layer-event="expand_accordion",
data-layer-identifier="<identifier>"
data-layer-name="<name>"
data-layer-heading="<heading>"
data-layer-index="<index>"
data-layer-type="<type>"
>
Javascript Code
// When:
// User expands accordion item.
// Code:
window.dataLayer = window.dataLayer || [];
dataLayer.push({ event_data: null }); // Clear the previous event_data object.
dataLayer.push({
event: "expand_accordion",
event_data: {
identifier: "<identifier>", // REQUIRED | string | ex. 12345abcde12345
name: "<name>", // REQUIRED | string | ex. FAQs, How it works, Ingredients
heading: "<heading>", // REQUIRED | string | ex. "Are our products safe?"
index: "<index>", // contextual | integer | ex. 1 | min. lgth. 1 | min. 1
type: "<type>" // contextual | string | ex. FAQ, product
}
});
Variable Definitions
Field | Type | Required | Description | Example | Minimum Length | Maximum Length | Minimum |
---|---|---|---|---|---|---|---|
identifier | string | required | The computer-readable machine name of the accordion. Use UUID provided by the component. | 12345abcde12345 |
100 |
||
name | string | required | The human-readable name of the accordion. If user does not input one, populate with numerical index of which accordion this is on the page (1-indexed). FAQs are the big one that currently need to be broken out in reporting, so getting a name for those should be the priority. | FAQs , How it works ,Ingredients |
100 |
||
heading | string | required | The text heading of the accordion item that was opened/closed | "Are our products safe?" |
100 |
||
index | integer | contextual | The ordinal slot number of the accordion item. E.g. - the top item in the accordion will be slot 1. (1-indexed) | 1 |
1 |
100 |
1 |
type | string | contextual | The type of accordion. | FAQ , product |