Page Comparison

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.

...

Name

Description

Parameters

openedx.paragon.docs.leave_-feedback.clicked

A link that allows you to leave feedback about the page of the

documentation site

Paragon on GitHub.

-

openedx.paragon.functions.track-generate-component.created

Event dispatched to the Segment about the component after its creation.

Code Block

language	jsx

{
  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.

Code Block

language	jsx

{
  value: <component name and category, default heading id>
}

openedx.paragon.docs.uiexample-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.

Code Block

language	jsx

{
  value: <component name and category, empty id>
}

openedx.paragon.docs.example-code-block.opened

Sends the name of the component, category and

its category

heading id after clicking on the Collapsible button and opening the code example. If the component has no heading, the default id is sent.

Code Block

language	jsx

{
  value: <component name and category>category, id text by defaultheading id>
}

openedx.paragon.docs.ui.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.

jsx

Code Block
language

{ value: <component name and category, heading id> }

openedx.paragon.docs.icons-table.selected-icon.copied

Sends the name of the copied icon at the Icons page.

Code Block

language	jsx

{
  name: <icon name>
}

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.

Code Block

language	jsx

{
  project: <project name>,
  component: <component name>,
  linkToUsage
}

openedx.paragon.docs.settings.directionsetting.changed

Dispatches a Segment event after changing

direction

in the sidebar settings.

Code Block

language	jsx

{ 
  directionsetting: <direction<setting name>
}

openedx.paragon.docs.settings.language.changed

Dispatches a Segment event after changing language in the sidebar settings.

Code Block

language	jsx

{
  language: <language name>, <setting value>, 
}

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.

Code Block

language	jsx

{
  property,
  value
}

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.insights.tabs.summary.clicked

Segment event, dispatched after clicking on the “Summary“ tab on the Usage Insights page.

-

openedx.paragon.docs.insights.tabs.projects.clicked

Segment event, dispatched after clicking on the “Projects“ tab on the Usage Insights page.

-

openedx.paragon.docs.insights.tabs.components.usage-insights.tab.clicked

Segment event, dispatched after clicking

on the “Components“ tab

on the

Usage Insights page.

-

openedx.paragon.docs.insights.

tabs

.hooks.clickedSegment event, dispatched after clicking

on the

“Hooks“ tab on the

Usage Insights page.

-{ tabName: <tab name> }

openedx.paragon.docs.insights.tabs.utils.clicked

Segment event, dispatched after clicking on the “Utils“ tab on the Usage Insights page.

-

openedx.paragon.docs.insights.tabs.icons.clicked

Segment event, dispatched after clicking on the “Icons“ tab on the Usage Insights page.

-

openedx.paragon.docs.playground.url-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.

-

Versions Compared

Old Version 12

New Version 13

Key