Paragon's Segment Events Documentation

The Paragon Segment Events Documentation page is a centralized resource within the Open edX wiki, providing a comprehensive list and details of all Segment events related to the Paragon design system. This documentation is continuously updated as new events are added or modified, ensuring accurate information for developers and contributors. It is a valuable reference for integrating Paragon and tracking user interactions in the Open edX platform.

Paragon's Segment Events List

Name	Description	Parameters

Name	Description	Parameters
`openedx.paragon.docs.leave-feedback.clicked`	A link that allows you to leave feedback about the page of the Paragon on GitHub.	-
`openedx.paragon.functions.track-generate-component.created`	Event dispatched to the Segment about the component after its creation.	`{ properties: <component name> }`
`openedx.paragon.docs.example-code-block.without-heading.opened`	Sends the name of the component, category, and default heading id after clicking on the Collapsible button and closing the code example.	`{ value: <component name and category, default heading id> }`
`openedx.paragon.docs.example-code-block.without-heading.closed`	Sends the name of the component, category, and default heading id after clicking on the Collapsible button and closing the code example.	`{ value: <component name and category, empty id> }`
`openedx.paragon.docs.example-code-block.opened`	Sends the name of the component, category and heading id after clicking on the Collapsible button and opening the code example. If the component has no heading, the default id is sent.
`openedx.paragon.docs.example-code-block.closed`	Sends the name of the component, category, and heading id after clicking on the Collapsible button and closing the code example. If the component has no heading, the default id is sent.
`openedx.paragon.docs.icons-table.selected-icon.copied`	Sends the name of the copied icon at the Icons page.
`openedx.paragon.docs.menu.playground.visit-playground.clicked`	Send Segment event after clicking on the link to Playground.	-
`openedx.paragon.docs.usage-insights.component-usage-link.clicked`	Dispatches a Segment event after clicking on a link leading to a place of use in a project.
`openedx.paragon.docs.setting.changed`	Dispatches a Segment event after changing in the sidebar settings.
`openedx.paragon.docs.settings.opened`	Segment event dispatched after opened settings sidebar.	-
`openedx.paragon.docs.settings.closed`	Segment event dispatched after closed settings sidebar.	-
`openedx.paragon.docs.elevation.shadow-generator.layer.updated`	Segment event dispatched after changed box-shadow value at the Elevation page.
`openedx.paragon.docs.elevation.shadow-generator.layer.added`	Segment event dispatched after adding new box-shadow layer at the Elevation page.	-
`openedx.paragon.docs.elevation.shadow-generator.layer.removed`	Segment event, dispatched after removing the box-shadow layer on the Elevation page.	-
`openedx.paragon.docs.elevation.shadow-generator.layer.disabled`	Segment event, dispatched after disabling the box-shadow layer on the Elevation page.	-
`openedx.paragon.docs.elevation.shadow-generator.layer.enabled`	Segment event, dispatched after enabling the box-shadow layer on the Elevation page.	-
`openedx.paragon.docs.usage-insights.tab.clicked`	Segment event, dispatched after clicking on the tabs on the Usage Insights page.
`openedx.paragon.docs.playground.copy-url.copied`	The segment event is dispatched after clicking the "Copy" button on the Playground page.	-
`openedx.paragon.docs.menu.tools.visit-contrast-checker.clicked`	Segment event, dispatched after clicking on the “Contrast checker“ link in the Tools category.	-
`openedx.paragon.docs.page-edit.clicked`	Segment event, dispatched after clicking on the “Edit this page“ link.	-