Skip to main content

Data table

Many records in one view, with search, filters, sorting, column choice, selection and paging.

Left out of Content first Content first avoids data-heavy tools. It has no dense tables, and its rows are read, not scanned. Use instead: Card, Pagination

See it live​

Start Storybook to see it live: npm run storybook

When to use it​

  • Use it when: People find, compare and act on many records, often in bulk.
  • Not when: A handful of rows (a plain table), or items people browse rather than compare (cards).

Instead:

  • Table: A few rows, no tools.
  • Card: Items to browse, not compare.

How Content first uses it​

A number in a table
Use type.body
Not A mono font
Tables are rare and read row by row, so digits never need to line up in columns. A mono font would break the reading voice.
A selected row or item
Use color.surface.selected
Not Bold text only
A tint shows the choice clearly on warm paper.
Table row height
Use size.row (comfortable)
Not A compact row
Rows are read, not scanned.
An action on one row or item
Use Button ghost with a word
Not An icon on its own
Occasional visitors need the word.

Words​

  • Write to one person: "you", not "users".
  • Short sentences with room to breathe.
  • Explain why before asking for anything.
  • Use: Read, Save for later, You, Next issue. Avoid: Click here, Submit, Users, Content.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Not now
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Browse guides

See Voice and tone for the whole voice.

Accessibility and keyboard​

KeyboardWhat happensNot
undefinedEvery tool and row action is reachable by keyboard.undefined

Test before you ship:

  • It stays a real table with headers; sorting and selection are announced. undefined

Use it in code​

npx open-ds add data-table

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

Tokens it reads​

Data table reads 12 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 Data table's tokens to change Data table alone.

Changes with theme

Content 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
Shared
Card radiuscomponent.card.radiusradius.containervar(--card-radius)radius.12:0.75rem
Table row heightcomponent.table.row-heightsize.rowvar(--table-row-height)size.48:3rem
Table row border
Changes with theme
component.table.row-bordercolor.border.defaultvar(--table-row-border)Lightstone.light.200:#E4DDD0Darkstone.dark.100:#2E2A24
Data table
Gapcomponent.data-table.gapspace.gap.tightvar(--data-table-gap)space.8:0.5rem
Label hover
Changes with theme
on hover
component.data-table.label-hovercolor.text.primaryvar(--data-table-label-hover)Lightstone.light.900:#1F1B16Darkstone.dark.900:#FFFDF8
Paddingcomponent.data-table.paddingcomponent-spacing-map.x2var(--data-table-padding)space.8:0.5rem
Gap 2component.data-table.gap-2space.gap.defaultvar(--data-table-gap-2)space.16:1rem
Cornercomponent.data-table.radiusradius.badgevar(--data-table-radius)radius.999:9999px
Padding, left and rightcomponent.data-table.padding-xcomponent-spacing-map.x2var(--data-table-padding-x)space.8:0.5rem
Padding, top and bottomcomponent.data-table.padding-ycomponent-spacing-map.x1var(--data-table-padding-y)space.4:0.25rem
Background hover
Changes with theme
on hover
component.data-table.background-hovercolor.surface.sunkenvar(--data-table-background-hover)Lightstone.light.100:#F6F2EADarkstone.dark.100:#2E2A24
Text
Changes with theme
component.data-table.labelcolor.text.mutedvar(--data-table-label)Lightstone.light.600:#61594DDarkstone.dark.400:#A39A8B
From the system
Edge
Changes with theme
color.border.default
straight from the system, through --border
Lightstone.light.200 · #E4DDD0Darkstone.dark.100 · #2E2A24