Skip to main content

Marker

A divider or status line inside a conversation, such as a date or someone joining.

In Accessible first

See it live​

Start Storybook to see it live: npm run storybook
Live from StorybookOpen Marker in StorybookSee it in dark

When to use it​

In Accessible first: Dividing a long conversation into days, in plain words. Not a message someone wrote.

  • Use it when: Breaking a long conversation into days or showing events in it.
  • Not when: A message someone wrote.

Instead:

Words​

  • Use common words. Explain any term you must use.
  • One idea per sentence. Put the action first.
  • Never blame the person.
  • Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.

The labels components use, from the voice tokens:

  • content.action.commit: Continue
  • content.action.cancel: Go back
  • content.action.destroy: Delete
  • content.action.retry: Try again
  • content.action.empty-action: Start a new application

See Voice and tone for the whole voice.

Use it in code​

npx open-ds add marker

The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.

Tokens it reads​

Marker reads 4 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Marker's tokens to change Marker alone.

Changes with theme

Accessible first decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.

PartIts token and the semantic it aliasesValue
Marker
Gapcomponent.marker.gapcomponent-spacing-map.x3var(--marker-gap)space.20:1.25rem
Text sizecomponent.marker.font-sizetype.caption.font-sizevar(--marker-font-size)font.size.16:1rem
Text
Changes with theme		component.marker.labelcolor.text.mutedvar(--marker-label)Lightgray.light.500:#595959Darkgray.dark.500:#949494
Fill
Changes with theme		component.marker.backgroundcolor.border.defaultvar(--marker-background)Lightgray.light.200:#D6D6D6Darkgray.dark.100:#222222