Skip to main content

Message

One message with its author and time.

In Accessible first

See it live​

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

When to use it​

In Accessible first: Conversations or comments, each with author and time. Not system status, which an alert carries.

  • Use it when: Conversations, comments and activity feeds.
  • Not when: Status about the system (alert or toast).

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 message

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

Tokens it reads​

Message reads 7 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 Message's tokens to change Message 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
Message
Gapcomponent.message.gapcomponent-spacing-map.x3var(--message-gap)space.20:1.25rem
Text sizecomponent.message.font-sizetype.body.font-sizevar(--message-font-size)font.size.19:1.1875rem
Gap 2component.message.gap-2space.gap.tightvar(--message-gap-2)space.12:0.75rem
Gap xcomponent.message.gap-xspace.gap.defaultvar(--message-gap-x)space.16:1rem
Author
Weightcomponent.message.author.font-weighttype.label.font-weightvar(--message-author-font-weight)font.weight.700:700
Time
Text sizecomponent.message.time.font-sizetype.caption.font-sizevar(--message-time-font-size)font.size.16:1rem
Text
Changes with theme		component.message.time.labelcolor.text.mutedvar(--message-time-label)Lightgray.light.500:#595959Darkgray.dark.500:#949494