Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Paragon's Segment Events List

Name

Description

Parameters

openedx.paragon.docs.leave_feedback.clicked

A link that allows you to leave feedback about the page of the documentation site on GitHub.

-

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

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

Code Block
languagejsx
{
  properties: <component name>
}

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

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

Code Block
languagejsx
{
  value: <component name and category> id text by default
}

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.

Code Block
languagejsx
{
  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
languagejsx
{
  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
languagejsx
{
  project: <project name>,
  component: <component name>,
  linkToUsage
}

openedx.paragon.docs.settings.direction.changed

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

Code Block
languagejsx
{
  direction: <direction name>
}

openedx.paragon.docs.settings.language.changed

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

Code Block
languagejsx
{
  language: <language name>
}

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.generator.updated

Segment event dispatched after changed box-shadow value at the Elevation page.

Code Block
languagejsx
{
  property,
  value
}

openedx.paragon.elevation.generator.layer.added

Segment event dispatched after adding new box-shadow layer at the Elevation page.

-

openedx.paragon.elevation.shadow-generator.layer.removed

Segment event, dispatched after removing the box-shadow layer on the Elevation page.

-

openedx.paragon.elevation.shadow-generator.layer.disabled

Segment event, dispatched after disabling the box-shadow layer on the Elevation page.

-

openedx.paragon.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.clicked

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

-

openedx.paragon.docs.insights.tabs.hooks.clicked

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

-

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

-