@sableui/react 0.15.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +73 -0
- package/bin/sable-lint.mjs +5 -1
- package/dist/{_contract-CkqXDVww.d.ts → _contract-CDa9-NdB.d.ts} +47 -1
- package/dist/blocks/wallet-block.js +2 -2
- package/dist/components/app-shell/app-shell-frame.js +16 -0
- package/dist/components/app-shell/app-shell-main.js +12 -0
- package/dist/components/app-shell/app-shell.js +28 -4
- package/dist/components/app-shell/app-shell.meta.js +88 -4
- package/dist/components/area-chart/area-chart.meta.js +6 -1
- package/dist/components/attachment/attachment.meta.js +2 -1
- package/dist/components/attachment/attachment.variants.js +1 -1
- package/dist/components/badge/badge.meta.js +8 -1
- package/dist/components/badge/badge.variants.js +7 -7
- package/dist/components/banner/banner.meta.js +6 -1
- package/dist/components/banner/banner.variants.js +5 -5
- package/dist/components/bar-chart/bar-chart.meta.js +6 -1
- package/dist/components/caret-menu/caret-menu.js +5 -6
- package/dist/components/chat-composer/chat-composer.meta.js +2 -2
- package/dist/components/chat-composer/chat-composer.variants.js +1 -1
- package/dist/components/color-field/color-field.js +6 -8
- package/dist/components/combobox/combobox.js +27 -5
- package/dist/components/combobox/combobox.meta.js +10 -2
- package/dist/components/command-menu/command-menu.js +14 -3
- package/dist/components/command-menu/command-menu.meta.js +9 -1
- package/dist/components/date-picker/date-picker.meta.js +2 -2
- package/dist/components/feedback/feedback.js +1 -1
- package/dist/components/feedback/feedback.meta.js +2 -1
- package/dist/components/gradient-art/gradient-art.js +8 -5
- package/dist/components/gradient-art/gradient-art.meta.js +35 -2
- package/dist/components/input/input.meta.js +11 -3
- package/dist/components/input-group/input-group.js +1 -1
- package/dist/components/input-group/input-group.meta.js +1 -1
- package/dist/components/line-chart/line-chart.meta.js +6 -1
- package/dist/components/menu/menu.js +1 -1
- package/dist/components/meter/meter.js +53 -7
- package/dist/components/meter/meter.meta.js +51 -4
- package/dist/components/meter/meter.variants.js +43 -7
- package/dist/components/note/note.meta.js +5 -1
- package/dist/components/note/note.variants.js +4 -4
- package/dist/components/number-field/number-field.meta.js +2 -2
- package/dist/components/otp-field/otp-field.meta.js +2 -2
- package/dist/components/panel-group/panel-group.js +5 -8
- package/dist/components/pie-chart/pie-chart.meta.js +6 -1
- package/dist/components/radar-chart/radar-chart.meta.js +6 -1
- package/dist/components/radial-chart/radial-chart.meta.js +6 -1
- package/dist/components/search-input/search-input.meta.js +11 -3
- package/dist/components/segmented-bar/segmented-bar.meta.js +8 -1
- package/dist/components/segmented-bar/segmented-bar.variants.js +7 -7
- package/dist/components/select/select.js +1 -1
- package/dist/components/select/select.meta.js +2 -2
- package/dist/components/sheet/sheet.js +5 -4
- package/dist/components/sidebar/sidebar.js +16 -1
- package/dist/components/sidebar/sidebar.meta.js +7 -2
- package/dist/components/sparkline/sparkline.meta.js +8 -1
- package/dist/components/status-dot/status-dot.meta.js +8 -1
- package/dist/components/status-dot/status-dot.variants.js +7 -7
- package/dist/components/stepper/stepper.meta.js +2 -1
- package/dist/components/stepper/stepper.variants.js +1 -1
- package/dist/components/table/table.meta.js +4 -4
- package/dist/components/textarea/textarea.js +5 -0
- package/dist/components/textarea/textarea.meta.js +3 -3
- package/dist/file-hashes.json +91 -88
- package/dist/foundations/accessibility.js +5 -0
- package/dist/index.d.ts +132 -24
- package/dist/index.js +9 -1
- package/dist/lib/chart/types.js +8 -8
- package/dist/lib/chart/use-arrival.js +5 -4
- package/dist/lib/field-shell.js +1 -1
- package/dist/lib/highlight-glide.js +6 -6
- package/dist/lib/scrub-gesture.js +6 -6
- package/dist/lib/use-caret-trigger.js +11 -18
- package/dist/lib/use-match-highlight.js +69 -0
- package/dist/lib/use-smooth-wheel.js +10 -8
- package/dist/presets/index.d.ts +13 -2
- package/dist/presets/index.js +17 -1
- package/dist/styles.css +100 -0
- package/dist/{theme-provider-CdSicAad.d.ts → theme-provider-BydfM5Z0.d.ts} +1 -1
- package/dist/themes/_contract.js +14 -0
- package/dist/themes/atelier/atelier.css +18 -0
- package/dist/themes/atelier/index.d.ts +1 -1
- package/dist/themes/contrast.js +48 -1
- package/dist/themes/ember/ember.css +18 -0
- package/dist/themes/ember/index.d.ts +1 -1
- package/dist/themes/index.d.ts +2 -2
- package/dist/themes/meridian/index.d.ts +1 -1
- package/dist/themes/meridian/meridian.css +18 -0
- package/dist/themes/poppy/index.d.ts +1 -1
- package/dist/themes/poppy/poppy.css +18 -0
- package/dist/themes/prism/index.d.ts +1 -1
- package/dist/themes/prism/prism.css +18 -0
- package/dist/themes/sable/index.d.ts +1 -1
- package/dist/themes/sable/sable.css +18 -0
- package/dist/themes/verdant/index.d.ts +1 -1
- package/dist/themes/verdant/verdant.css +18 -0
- package/llms/blocks/wallet-block.md +5 -4
- package/llms/components/app-shell.md +72 -3
- package/llms/components/area-chart.md +1 -1
- package/llms/components/attachment.md +1 -1
- package/llms/components/badge.md +1 -1
- package/llms/components/banner.md +1 -1
- package/llms/components/bar-chart.md +1 -1
- package/llms/components/chat-composer.md +1 -1
- package/llms/components/combobox.md +2 -1
- package/llms/components/command-menu.md +3 -2
- package/llms/components/date-picker.md +1 -1
- package/llms/components/feedback.md +1 -1
- package/llms/components/gradient-art.md +28 -1
- package/llms/components/input-group.md +1 -1
- package/llms/components/input.md +4 -2
- package/llms/components/line-chart.md +1 -1
- package/llms/components/meter.md +33 -4
- package/llms/components/note.md +1 -1
- package/llms/components/number-field.md +1 -1
- package/llms/components/otp-field.md +1 -1
- package/llms/components/pie-chart.md +1 -1
- package/llms/components/radar-chart.md +1 -1
- package/llms/components/radial-chart.md +1 -1
- package/llms/components/search-input.md +20 -2
- package/llms/components/segmented-bar.md +1 -1
- package/llms/components/select.md +1 -1
- package/llms/components/sidebar.md +3 -2
- package/llms/components/sparkline.md +1 -1
- package/llms/components/status-dot.md +1 -1
- package/llms/components/stepper.md +1 -1
- package/llms/components/table.md +2 -2
- package/llms/components/textarea.md +2 -2
- package/llms/foundations/accessibility.md +1 -0
- package/llms/reference/token-intent.md +22 -2
- package/llms/reference/utilities.md +5 -2
- package/llms-full.txt +222 -49
- package/llms.txt +2 -2
- package/package.json +1 -1
- package/registry.json +396 -57
- package/scripts/lint-rules.mjs +6 -3
package/llms-full.txt
CHANGED
|
@@ -4083,6 +4083,7 @@ Sable's components ship accessible behavior from Base UI. These rules cover what
|
|
|
4083
4083
|
- **Never:** Color as the only signal (a red border with no message). **Instead:** Color plus text or an icon. Roughly 1 in 12 men cannot tell red from green.
|
|
4084
4084
|
- **Never:** Opacity on the focus ring. **Instead:** ring-ring at full opacity; tune the token in the theme. A faded ring loses the contrast the theme tested. *Enforced by sable-lint: faded-focus-ring.*
|
|
4085
4085
|
- **Never:** A brand or status fill retuned under its old label — dark ink on a bright red that passes 4.5:1 at APCA Lc 42. **Instead:** A label that clears 4.5:1 and APCA Lc 60 in both modes. Move the fill's lightness, not its hue, keeping the ink its colour takes. A status colour on a surface is its own token (`--destructive-text`), so the fill can move freely. The ratio alone passes labels that read muddy. A deliberate brand pair is allowed with a recorded reason (lint disable or preset exceptions). *Enforced by sable-lint: label-contrast.*
|
|
4086
|
+
- **Never:** A label fill painted on a mark that carries no text — a meter, a segmented bar, a status dot, a chart series, a soft tint. **Instead:** The colour's `-mark` token (`bg-success-mark`, `bg-tone-warning-mark/15`): the same hue lifted and saturated, held to 2:1 on the page. Text contrast is for text; a graphic owes visibility, and 3:1 (WCAG 1.4.11) only when it is the sole carrier of its meaning. A fill is pinned dark enough for a white label. On a bar or dot with nothing to label, that darkness only reads as mud: a brown warning, a forest-green success.
|
|
4086
4087
|
- **Never:** Blocking paste, or type="number" for codes and card numbers. **Instead:** type="text" inputMode="numeric" with the right autocomplete. Blocking paste breaks password managers; number inputs scroll-change identifiers.
|
|
4087
4088
|
- **Never:** forced-color-adjust: none to 'fix' high-contrast mode. **Instead:** Let the system colors apply; verify the result. It removes the user's chosen colors exactly where they need them.
|
|
4088
4089
|
- **Never:** outline: none without a replacement. **Instead:** focus-visible:ring-2 ring-ring. Keyboard users lose their place.
|
|
@@ -10269,7 +10270,10 @@ const activity = [
|
|
|
10269
10270
|
{ title: "Subscription", detail: "Team plan · 2h ago", amount: "+49.00", tone: "1" },
|
|
10270
10271
|
{ title: "Refund", detail: "Order 1042 · Yesterday", amount: "-24.00", tone: "2" },
|
|
10271
10272
|
{ title: "Payout", detail: "To checking · Mon", amount: "-850.00", tone: "3" },
|
|
10272
|
-
]
|
|
10273
|
+
] as const
|
|
10274
|
+
|
|
10275
|
+
/** Each row's mark: its tone at graphic strength, which every theme tunes. */
|
|
10276
|
+
const TONE_MARK = { "1": "bg-tone-1-mark", "2": "bg-tone-2-mark", "3": "bg-tone-3-mark" } as const
|
|
10273
10277
|
|
|
10274
10278
|
export interface WalletBlockProps {
|
|
10275
10279
|
className?: string
|
|
@@ -10303,9 +10307,7 @@ export function WalletBlock({ className, framed = true, onSend, onReceive }: Wal
|
|
|
10303
10307
|
leading={
|
|
10304
10308
|
<span
|
|
10305
10309
|
aria-hidden
|
|
10306
|
-
className="block size-8 rounded-full"
|
|
10307
|
-
// design-lint-disable-next-line inline-color -- relative colour derived from the theme's own --tone token, so it follows every look
|
|
10308
|
-
style={{ background: `oklch(from var(--tone-${item.tone}) clamp(0.5, calc(l + 0.16), 0.9) max(calc(c * 1.25), 0.1) h)` }}
|
|
10310
|
+
className={cn("block size-8 rounded-full", TONE_MARK[item.tone])}
|
|
10309
10311
|
/>
|
|
10310
10312
|
}
|
|
10311
10313
|
title={item.title}
|
|
@@ -11102,7 +11104,7 @@ import { AppHeader, AppShell, PageHeader, Region } from "@sableui/react"
|
|
|
11102
11104
|
|
|
11103
11105
|
The application frame: slots for status banners, a mobile header, a desktop sidebar, main content, a mobile bottom nav, a persistent dock (a now-playing or call bar), and floating overlays — plus a built-in skip link and #main-content target.
|
|
11104
11106
|
|
|
11105
|
-
**Keywords:** app shell, layout, frame, sidebar, header, bottom nav, mobile, banners, main, dock, player bar, now playing, persistent
|
|
11107
|
+
**Keywords:** app shell, layout, frame, sidebar, header, bottom nav, mobile, banners, main, dock, player bar, now playing, persistent, inset, inset frame, floating panel, rounded content, scroll container
|
|
11106
11108
|
|
|
11107
11109
|
## Usage
|
|
11108
11110
|
|
|
@@ -11114,7 +11116,10 @@ Use AppShell as the outer product frame for authenticated or app-like experience
|
|
|
11114
11116
|
- Do: Pass app-wide outage or status messages through banners so they remain above the frame.
|
|
11115
11117
|
- Do: Use Region inside the main content to choose each route's reading width.
|
|
11116
11118
|
- Do: Wrap EVERY return of a route in its own Page or Region — including early returns for loading, empty and error states. AppShell's <main> deliberately carries no padding (it is a frame, and padding belongs to the region that chose the width), so a route that returns a bare spinner or error renders flush against the chrome. This is the most common conversion bug: the happy path gets a Page, the three early returns do not.
|
|
11119
|
+
- Do: Use frame="inset" for dense, multi-pane product apps — a CRM, an issue tracker, an AI workspace — where framing the content as one raised panel on the rail's ground helps it read as the workspace and the rail as chrome. Keep the Sidebar on surface="rail" so its tint is the ground. Inset moves the page scroll from the window to <main id="main-content"> on desktop: point scroll listeners, scroll restoration and scroll-to-top at that element, not window.
|
|
11117
11120
|
- Don't: Nest AppShell inside route cards or panels. It is page chrome, not local content.
|
|
11121
|
+
- Don't: Wrap a route in its own h-full overflow-y-auto box inside an inset shell. main is already the page's scroll container; a second one traps the scrollbar inside a smaller box and breaks sticky headers and the skip link's scroll target. Scroll a genuinely separate pane (a list beside a detail view) with Scroller. → use **Scroller**
|
|
11122
|
+
- Don't: Combine frame="inset" with a full-width header bar above the rail. The inset ground is the rail running the full height of the window; a bar across the top cuts it off. Use the flush frame with Sidebar surface="page" for that layout.
|
|
11118
11123
|
- Don't: Put desktop-only navigation in the mobile header slot or mobile-only controls in the sidebar slot.
|
|
11119
11124
|
|
|
11120
11125
|
### Anatomy
|
|
@@ -11124,7 +11129,7 @@ Use AppShell as the outer product frame for authenticated or app-like experience
|
|
|
11124
11129
|
| Banners | no | Full-width app status messages rendered above the shell. |
|
|
11125
11130
|
| Header | no | Mobile top chrome, usually AppHeader. |
|
|
11126
11131
|
| Sidebar | no | Desktop navigation chrome, usually Sidebar. |
|
|
11127
|
-
| Main | yes | The route content landmark with id main-content. |
|
|
11132
|
+
| Main | yes | The route content landmark with id main-content. With frame="inset", from lg it is a rounded, bordered panel that scrolls inside itself. |
|
|
11128
11133
|
| Bottom nav | no | Mobile fixed navigation with reserved bottom space. |
|
|
11129
11134
|
| Dock | no | Persistent bottom chrome that outlives routes — a now-playing bar, a call bar. Sticky above the bottom nav; the desktop Sidebar shortens to clear it. |
|
|
11130
11135
|
|
|
@@ -11144,10 +11149,11 @@ Use AppShell as the outer product frame for authenticated or app-like experience
|
|
|
11144
11149
|
| bottomNav | ReactNode | — | Mobile bottom navigation (e.g. BottomNav); fixed to the bottom edge. main reserves space for it. |
|
|
11145
11150
|
| dock | ReactNode | — | Persistent chrome kept on screen across routes (a now-playing bar, an active-call bar, an upload tray). Full width, sticky to the bottom edge and above bottomNav on mobile; its height is published as --dock-height and the app Sidebar subtracts it. In flow, so main needs no reserved space. The contents paint their own surface and top border, and name themselves (e.g. <section aria-label="Player">). Mount AppShell in a layout that survives navigation, or the playback restarts. |
|
|
11146
11151
|
| overlays | ReactNode | — | Floating overlays — a message launcher, FAB, or modal mount points. |
|
|
11152
|
+
| frame | "flush" \| "inset" | "flush" | How the desktop frame (lg and up) holds the content; below lg both are the same mobile layout with page scroll. "flush": main sits on the page beside the rail and the document scrolls. "inset": the shell fills the viewport and paints the shell-ground token (one step off the rail's surface, tunable with --theme-shell-ground) behind the rail and around the panel; main becomes a rounded-lg panel with a hairline border and shadow-sm, inset by a spacing step from the window edges, that scrolls inside itself (scrollbar-quiet) while the rail stays put. The Sidebar in the sidebar slot drops its right border and fills the row. main stays the #main-content target (tabIndex -1, so the skip link lands focus in the scroller) and the inline-size query container; sticky children stick to the panel's top; banners and the dock stay in flow, so the panel's bottom gap sits above a dock. With Sidebar surface="page" the ground is the page colour and the panel's border alone lifts it. |
|
|
11147
11153
|
|
|
11148
11154
|
## Tokens used
|
|
11149
11155
|
|
|
11150
|
-
`background`, `foreground`, `primary`, `primary-foreground`
|
|
11156
|
+
`background`, `foreground`, `primary`, `primary-foreground`, `sidebar`, `shell-ground`, `border`
|
|
11151
11157
|
|
|
11152
11158
|
## Accessibility
|
|
11153
11159
|
|
|
@@ -11155,6 +11161,7 @@ Use AppShell as the outer product frame for authenticated or app-like experience
|
|
|
11155
11161
|
- Wraps content in a <main id="main-content"> landmark.
|
|
11156
11162
|
- Slot components own their own ARIA (nav landmarks, labels).
|
|
11157
11163
|
- The dock follows <main> in DOM order, so keyboard and screen-reader users reach the player after the page content, not before it.
|
|
11164
|
+
- With frame="inset", <main> is the desktop scroll container and takes tabIndex -1: the skip link moves focus into it, so PageDown and the arrow keys scroll the content, without adding a tab stop.
|
|
11158
11165
|
|
|
11159
11166
|
## Related
|
|
11160
11167
|
|
|
@@ -11194,6 +11201,70 @@ import { AppHeader, AppShell, Banner, BottomNav, BottomNavItem, Icon, PageHeader
|
|
|
11194
11201
|
</AppShell>
|
|
11195
11202
|
```
|
|
11196
11203
|
|
|
11204
|
+
### Inset frame
|
|
11205
|
+
|
|
11206
|
+
```tsx
|
|
11207
|
+
import { AppHeader, AppShell, BottomNav, BottomNavItem, Button, Card, CardContent, Icon, Page, PageHeader, Sidebar, SidebarBrand, SidebarHeader, SidebarItem, SidebarNav, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from "@sableui/react"
|
|
11208
|
+
// <Link> = your router's link (react-router, next/link, @tanstack/router, …)
|
|
11209
|
+
|
|
11210
|
+
<AppShell
|
|
11211
|
+
frame="inset"
|
|
11212
|
+
header={<AppHeader title="Pipeline" />}
|
|
11213
|
+
sidebar={
|
|
11214
|
+
<Sidebar>
|
|
11215
|
+
<SidebarHeader>
|
|
11216
|
+
<SidebarBrand mark={<Icon name="gem" variant="solid" />} label="Relay" render={<Link to="/" />} />
|
|
11217
|
+
</SidebarHeader>
|
|
11218
|
+
<SidebarNav>
|
|
11219
|
+
<SidebarItem icon={<Icon name="inbox" />} label="Inbox" render={<Link to="/inbox" />} />
|
|
11220
|
+
<SidebarItem icon={<Icon name="user" />} label="People" active render={<Link to="/people" />} />
|
|
11221
|
+
<SidebarItem icon={<Icon name="folder" />} label="Companies" render={<Link to="/companies" />} />
|
|
11222
|
+
</SidebarNav>
|
|
11223
|
+
</Sidebar>
|
|
11224
|
+
}
|
|
11225
|
+
bottomNav={
|
|
11226
|
+
<BottomNav>
|
|
11227
|
+
<BottomNavItem icon={<Icon name="inbox" />} label="Inbox" render={<Link to="/inbox" />} />
|
|
11228
|
+
<BottomNavItem icon={<Icon name="user" />} label="People" active render={<Link to="/people" />} />
|
|
11229
|
+
<BottomNavItem icon={<Icon name="folder" />} label="Companies" render={<Link to="/companies" />} />
|
|
11230
|
+
</BottomNav>
|
|
11231
|
+
}
|
|
11232
|
+
>
|
|
11233
|
+
<Page max="wide" gap={4} className="py-6">
|
|
11234
|
+
<PageHeader
|
|
11235
|
+
title="People"
|
|
11236
|
+
description="Everyone in your pipeline, newest first."
|
|
11237
|
+
actions={<Button><Icon name="plus" />Add person</Button>}
|
|
11238
|
+
/>
|
|
11239
|
+
<Card>
|
|
11240
|
+
<CardContent flush>
|
|
11241
|
+
<Table>
|
|
11242
|
+
<TableHeader>
|
|
11243
|
+
<TableRow>
|
|
11244
|
+
<TableHead>Name</TableHead>
|
|
11245
|
+
<TableHead>Company</TableHead>
|
|
11246
|
+
<TableHead numeric>Deals</TableHead>
|
|
11247
|
+
</TableRow>
|
|
11248
|
+
</TableHeader>
|
|
11249
|
+
<TableBody>
|
|
11250
|
+
<TableRow>
|
|
11251
|
+
<TableCell>Ada Lovelace</TableCell>
|
|
11252
|
+
<TableCell>Northwind</TableCell>
|
|
11253
|
+
<TableCell numeric>4</TableCell>
|
|
11254
|
+
</TableRow>
|
|
11255
|
+
<TableRow>
|
|
11256
|
+
<TableCell>Grace Hopper</TableCell>
|
|
11257
|
+
<TableCell>Harbor Labs</TableCell>
|
|
11258
|
+
<TableCell numeric>2</TableCell>
|
|
11259
|
+
</TableRow>
|
|
11260
|
+
</TableBody>
|
|
11261
|
+
</Table>
|
|
11262
|
+
</CardContent>
|
|
11263
|
+
</Card>
|
|
11264
|
+
</Page>
|
|
11265
|
+
</AppShell>
|
|
11266
|
+
```
|
|
11267
|
+
|
|
11197
11268
|
### SkipLink in a layout of your own
|
|
11198
11269
|
|
|
11199
11270
|
```tsx
|
|
@@ -11292,7 +11363,7 @@ Use AreaChart for volume over time — visitors, revenue, usage — where the fi
|
|
|
11292
11363
|
|
|
11293
11364
|
## Tokens used
|
|
11294
11365
|
|
|
11295
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`
|
|
11366
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
11296
11367
|
|
|
11297
11368
|
## Motion
|
|
11298
11369
|
|
|
@@ -11415,7 +11486,7 @@ The card a file takes in a conversation — in the composer while it uploads, an
|
|
|
11415
11486
|
|
|
11416
11487
|
## Tokens used
|
|
11417
11488
|
|
|
11418
|
-
`card`, `border`, `border-strong`, `muted`, `muted-foreground`, `foreground`, `destructive`, `overlay`, `overlay-foreground`, `ring`
|
|
11489
|
+
`card`, `border`, `border-strong`, `muted`, `muted-foreground`, `foreground`, `destructive`, `overlay`, `overlay-foreground`, `ring`, `destructive-mark`
|
|
11419
11490
|
|
|
11420
11491
|
## Motion
|
|
11421
11492
|
|
|
@@ -11702,7 +11773,7 @@ Use Badge for any short static label: metadata, categories, tone-coded labels, a
|
|
|
11702
11773
|
|
|
11703
11774
|
## Tokens used
|
|
11704
11775
|
|
|
11705
|
-
`palette-wash`, `palette-wash-strong`, `palette-edge`, `palette-dot`, `palette-solid`, `palette-text`, `palette-solid-ink`, `secondary`, `secondary-foreground`, `border`, `foreground`, `background`, `muted`, `muted-foreground`, `tone-1`, `tone-2`, `tone-3`, `tone-info`, `success`, `tone-warning`, `destructive`, `overlay`, `overlay-foreground`, `tone-1-foreground`, `tone-2-foreground`, `tone-3-foreground`, `tone-info-foreground`, `success-foreground`, `tone-warning-foreground`, `destructive-foreground`
|
|
11776
|
+
`palette-wash`, `palette-wash-strong`, `palette-edge`, `palette-dot`, `palette-solid`, `palette-text`, `palette-solid-ink`, `secondary`, `secondary-foreground`, `border`, `foreground`, `background`, `muted`, `muted-foreground`, `tone-1`, `tone-2`, `tone-3`, `tone-info`, `success`, `tone-warning`, `destructive`, `overlay`, `overlay-foreground`, `tone-1-foreground`, `tone-2-foreground`, `tone-3-foreground`, `tone-info-foreground`, `success-foreground`, `tone-warning-foreground`, `destructive-foreground`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
11706
11777
|
|
|
11707
11778
|
## Accessibility
|
|
11708
11779
|
|
|
@@ -11831,7 +11902,7 @@ Use Banner for page-level or app-level messages that affect the current experien
|
|
|
11831
11902
|
|
|
11832
11903
|
## Tokens used
|
|
11833
11904
|
|
|
11834
|
-
`secondary`, `secondary-foreground`, `foreground`, `background`, `tone-info`, `tone-info-foreground`, `success`, `success-foreground`, `tone-warning`, `tone-warning-foreground`, `tone-1`, `tone-1-foreground`, `destructive`, `destructive-foreground`
|
|
11905
|
+
`secondary`, `secondary-foreground`, `foreground`, `background`, `tone-info`, `tone-info-foreground`, `success`, `success-foreground`, `tone-warning`, `tone-warning-foreground`, `tone-1`, `tone-1-foreground`, `destructive`, `destructive-foreground`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`
|
|
11835
11906
|
|
|
11836
11907
|
## Accessibility
|
|
11837
11908
|
|
|
@@ -11955,7 +12026,7 @@ Use BarChart to compare amounts across categories — the default chart for "how
|
|
|
11955
12026
|
|
|
11956
12027
|
## Tokens used
|
|
11957
12028
|
|
|
11958
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`
|
|
12029
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
11959
12030
|
|
|
11960
12031
|
## Motion
|
|
11961
12032
|
|
|
@@ -13214,7 +13285,7 @@ Pairs with MessageScroller to make a working chat. A single surface rather than
|
|
|
13214
13285
|
|
|
13215
13286
|
## Tokens used
|
|
13216
13287
|
|
|
13217
|
-
`
|
|
13288
|
+
`field`, `field-border`, `ring`, `destructive`, `foreground`, `muted-foreground`, `primary`, `primary-foreground`, `secondary`, `secondary-foreground`, `accent`, `accent-foreground`
|
|
13218
13289
|
|
|
13219
13290
|
## Motion
|
|
13220
13291
|
|
|
@@ -13930,13 +14001,14 @@ Use Combobox when users choose from a list that benefits from typing, filtering,
|
|
|
13930
14001
|
| items | readonly any[] \| readonly ComboboxItemGroup[] | — | The pool of options, flat or grouped ({ value, items }). Drives type-to-filter and is required for ComboboxEmpty to render its fallback. |
|
|
13931
14002
|
| multiple | boolean | false | Select several items instead of one. `value` / `defaultValue` / `onValueChange` become arrays, choosing an item toggles its membership, and the popup stays open between picks. Pair it with ComboboxChips in place of ComboboxInput; every other part is unchanged. |
|
|
13932
14003
|
| filter | null \| ((item, query, itemToString?) => boolean) | Base UI's locale-aware contains | How items match the query. `null` turns matching off, for items a server already filtered: pair it with `onInputValueChange` to fetch. |
|
|
14004
|
+
| highlightMatches | boolean | true | Paints the typed text wherever it appears in a row's label, on the `highlight` / `highlight-foreground` pair, through the CSS Custom Highlight API — no `<mark>` in the row, and the accessible name is unchanged. Only typed text counts: a field still holding the selected item's label lists everything and lights nothing. A literal, case-insensitive match within the label; a `filter` that matches differently leaves rows it kept unpainted. `false` turns it off. |
|
|
13933
14005
|
| onInputValueChange | (inputValue: string, eventDetails) => void | — | Fires as the reader types. The place to fetch results for a server-backed combobox. |
|
|
13934
14006
|
| itemToStringLabel | (item) => string | item.label for { value, label } items | The text an object item shows in the input once chosen, and is matched by. Needed for object items without a `label` field. |
|
|
13935
14007
|
| virtualized | boolean | false | Tells Base UI the DOM holds only part of the list. Required when using ComboboxVirtualList. |
|
|
13936
14008
|
|
|
13937
14009
|
## Tokens used
|
|
13938
14010
|
|
|
13939
|
-
`
|
|
14011
|
+
`highlight`, `highlight-foreground`, `field-border`, `field`, `foreground`, `muted-foreground`, `ring`, `destructive`, `popover`, `popover-foreground`, `border`, `accent`, `accent-foreground`, `primary`, `secondary`, `secondary-foreground`
|
|
13940
14012
|
|
|
13941
14013
|
## Motion
|
|
13942
14014
|
|
|
@@ -14058,7 +14130,7 @@ Use CommandMenu for global or contextual keyboard-driven actions: navigation, cr
|
|
|
14058
14130
|
|
|
14059
14131
|
| Name | Type | Description |
|
|
14060
14132
|
| --- | --- | --- |
|
|
14061
|
-
| CommandMenuTrigger | { onOpen?: () => void; placeholder?: string; shortcut?: string \| false; size?: "sm" \| "md"; disabled?: boolean } | The search field in a header that is really a button. Wears SearchInput's shell (
|
|
14133
|
+
| CommandMenuTrigger | { onOpen?: () => void; placeholder?: string; shortcut?: string \| false; size?: "sm" \| "md"; disabled?: boolean } | The search field in a header that is really a button. Wears SearchInput's shell (the field fill and outline, leading magnifier, muted placeholder) on the control ladder, with a trailing Kbd: ⌘K on macOS, Ctrl K elsewhere. onOpen runs on click and on the shortcut, which it listens for page-wide (useCommandMenuShortcut). shortcut is the key (default "k"); false drops both the hint and the listener. size is sm in a header beside small buttons, md (default) beside Input and SearchInput. It sits outside CommandMenu, so the Dialog returns focus to it on close. |
|
|
14062
14134
|
| useCommandMenuShortcut | (onShortcut: (event: KeyboardEvent) => void, key?: string \| false) => void | The page-wide ⌘K / Ctrl+K listener CommandMenuTrigger installs, for a palette with no visible trigger. Ignored while focus is in a text field, textarea, select or contenteditable (Ctrl+K belongs to the field there) except the palette's own input, so the callback may toggle. It calls preventDefault() on a match and skips an event already prevented, so two listeners on one page fire once. key defaults to "k"; false turns it off. Removed on unmount. |
|
|
14063
14135
|
| CommandMenuPanel | { items?: CommandItem[]; query?: string; onQueryChange?: (query: string) => void; filter?: CommandFilter; listClassName?: string; placeholder?: string; emptyMessage?: string; title?: string; scope?: ReactNode; inputProps?: ComponentProps<'input'>; className?: string; children?: ReactNode } | The palette rendered in place: the same search header, filtered and grouped listbox, keyboard model and result-count live region, on a static card (border-border, bg-card, no shadow) instead of in a Dialog. Takes every CommandMenu prop except open, onOpenChange, finalFocus and description; className lands on the card, title names the listbox. Focus is not trapped and the input does not take focus on mount (inputProps.autoFocus opts in). Esc clears the query, and passes through once it is empty, so a Popover around the panel still closes. A chosen row runs its onSelect and the panel stays as it was. The page-wide shortcut does not fire from its input. |
|
|
14064
14136
|
| CommandMenuGroup | { label: string; children } | A labelled group of command rows. |
|
|
@@ -14076,6 +14148,7 @@ Use CommandMenu for global or contextual keyboard-driven actions: navigation, cr
|
|
|
14076
14148
|
| query | string | — | Controlled query. Leave undefined to let the palette own it; either way it resets on close (a controlled caller gets onQueryChange('')). |
|
|
14077
14149
|
| onQueryChange | (query: string) => void | — | Called on every query change. Required to control query, optional otherwise. |
|
|
14078
14150
|
| filter | ((items: CommandItem[], query: string) => CommandItem[]) \| null | case-insensitive substring match on label | Replaces or disables the built-in match. A function ranks and filters items itself and its order is kept verbatim; null renders items exactly as given. Either also stops declarative CommandMenuItem children self-filtering. The query arrives raw — trimming and case are policy, and this is the prop that hands policy over. |
|
|
14151
|
+
| highlightMatches | boolean | true | Paints the query wherever it appears in a row's label (not its detail or hint), on the `highlight` / `highlight-foreground` pair, through the CSS Custom Highlight API — no `<mark>` in the row, and the accessible name is unchanged. A literal, case-insensitive match, so under a fuzzy `filter` a row that matched as a subsequence keeps an unpainted label. `false` turns it off. Applies to CommandMenuPanel too. |
|
|
14079
14152
|
| listClassName | string | — | Classes for the scrolling list. className lands on the dialog surface, so this is the seam for the list's own height cap — listClassName="max-h-[60vh]". The list is a Scroller, so the cap lands on the element that scrolls and the edge fades come free. |
|
|
14080
14153
|
| placeholder | string | "Type a command or search…" | Placeholder for the search input. |
|
|
14081
14154
|
| emptyMessage | string | "No results found." | Copy shown when the query matches nothing. |
|
|
@@ -14086,7 +14159,7 @@ Use CommandMenu for global or contextual keyboard-driven actions: navigation, cr
|
|
|
14086
14159
|
|
|
14087
14160
|
## Tokens used
|
|
14088
14161
|
|
|
14089
|
-
`card`, `card-foreground`, `border`, `foreground`, `muted-foreground`, `accent`, `accent-foreground`
|
|
14162
|
+
`highlight`, `highlight-foreground`, `card`, `card-foreground`, `border`, `foreground`, `muted-foreground`, `accent`, `accent-foreground`
|
|
14090
14163
|
|
|
14091
14164
|
## Motion
|
|
14092
14165
|
|
|
@@ -14622,7 +14695,7 @@ Use DatePicker when users need to choose one date — or, with granularity="minu
|
|
|
14622
14695
|
|
|
14623
14696
|
## Tokens used
|
|
14624
14697
|
|
|
14625
|
-
`primary`, `primary-foreground`, `accent`, `accent-foreground`, `foreground`, `muted-foreground`, `popover`, `popover-foreground`, `border`, `
|
|
14698
|
+
`primary`, `primary-foreground`, `accent`, `accent-foreground`, `foreground`, `muted-foreground`, `popover`, `popover-foreground`, `border`, `field-border`, `field`, `ring`
|
|
14626
14699
|
|
|
14627
14700
|
## Accessibility
|
|
14628
14701
|
|
|
@@ -15374,7 +15447,7 @@ Use Feedback to collect lightweight sentiment, usefulness, or quality signals fr
|
|
|
15374
15447
|
|
|
15375
15448
|
## Tokens used
|
|
15376
15449
|
|
|
15377
|
-
`popover`, `popover-foreground`, `border`, `input`, `card`, `foreground`, `muted-foreground`, `accent`, `accent-foreground`, `ring`, `success`
|
|
15450
|
+
`popover`, `popover-foreground`, `border`, `input`, `card`, `foreground`, `muted-foreground`, `accent`, `accent-foreground`, `ring`, `success`, `success-mark`
|
|
15378
15451
|
|
|
15379
15452
|
## Motion
|
|
15380
15453
|
|
|
@@ -16005,13 +16078,15 @@ Placeholder artwork painted by a static WebGL shader from the preset's own art d
|
|
|
16005
16078
|
|
|
16006
16079
|
## Usage
|
|
16007
16080
|
|
|
16008
|
-
Use GradientArt where a real image belongs but none exists yet, or where the image is decoration: a product cover before upload, a profile banner, an album tile, an avatar with no photo. It reads the theme's own tokens, so it follows every preset, mode and live edit; `seed` fixes each item's composition so a list of covers or avatars stays individually recognisable.
|
|
16081
|
+
Use GradientArt where a real image belongs but none exists yet, or where the image is decoration: a product cover before upload, a profile banner, an album tile, an avatar with no photo. It reads the theme's own tokens, so it follows every preset, mode and live edit; `seed` fixes each item's composition so a list of covers or avatars stays individually recognisable. `intensity="soft"` paints the same art as a pastel wash — the iridescent aura AI products use as a card or modal header band, and as a stage for floating chips and logo tiles.
|
|
16009
16082
|
|
|
16010
16083
|
### Best practices
|
|
16011
16084
|
|
|
16012
16085
|
- Do: Pass a stable `seed` per item — the name for an avatar, the title for a cover. Each item then keeps the same art across renders, reloads and themes, which is what lets someone recognise it.
|
|
16013
16086
|
- Do: Size it with layout classes (`aspect-[4/3]`, `h-20`, `size-10 rounded-full`) and put any glyph or initials inside as children; they render above the art.
|
|
16014
16087
|
- Do: Keep the default `mesh` for covers, tiles and avatars. Reach for `grain` where a printed, tactile surface suits — a banner, a hero card — and keep one variant per surface type so art reads as a system.
|
|
16088
|
+
- Do: Use `intensity="soft"` as a stage: a card or modal header band, the art on an integration or pricing card, a field behind floating prompt chips or rounded logo tiles. Make the tiles and chips floating surfaces (`bg-popover` with `border-border-floating` and a shadow, or a `floating` Button) so they lift off the wash; soft stays light in dark mode too, so the same composition holds in both.
|
|
16089
|
+
- Don't: Do not put text straight on soft art with `text-overlay-foreground` ink. Soft is a light ground in every mode, so overlay ink washes out on it; put the content on a Card or a chip over the art, or use the default vivid intensity for a short overlay label.
|
|
16015
16090
|
- Don't: Do not put body text over it. The art spans the palette's lightest and most saturated tones, so no single ink is guaranteed to clear contrast across it; reserve overlays for a short label on a scrim or an avatar's initials.
|
|
16016
16091
|
- Don't: Do not pass colours, and reach for `tones` rarely. The art follows the preset's --art-* tokens on purpose; to change how a product's art looks, set the --theme-art-* hooks in its theme or preset, so every cover, banner and avatar changes together.
|
|
16017
16092
|
- Don't: Do not use it as a page or hero background. It paints at the element's pixel size, so a full-viewport instance costs a large frame on every theme change; it is sized for covers, banners and tiles.
|
|
@@ -16023,12 +16098,14 @@ Use GradientArt where a real image belongs but none exists yet, or where the ima
|
|
|
16023
16098
|
| variant | "mesh" \| "grain" | "mesh" | mesh: soft spots of colour pulled together by gentle waves. grain: glowing light over deep corners with a printed texture. |
|
|
16024
16099
|
| tones | ("info" \| "3" \| "2" \| "1" \| "warning")[] | — | Paint these `--tone-*` colours instead of the preset's art palette. Leave unset to follow the preset's art direction. |
|
|
16025
16100
|
| seed | string \| number | — | Fixes the composition: the same seed paints the same art in every theme. Pass a stable id. |
|
|
16101
|
+
| intensity | "vivid" \| "soft" | "vivid" | vivid: the preset's art at full strength. soft: every colour and the ground lifted to a light pastel of itself (high lightness, half chroma) — a wash for header bands and for staging chips and logo tiles, light in both modes. |
|
|
16026
16102
|
| children | ReactNode | — | Rendered above the art — initials, a glyph, a short label. |
|
|
16027
16103
|
| className | string | — | Size and shape: aspect, height, rounding. |
|
|
16028
16104
|
|
|
16029
16105
|
## Variants
|
|
16030
16106
|
|
|
16031
16107
|
- **variant**: mesh, grain
|
|
16108
|
+
- **intensity**: vivid, soft
|
|
16032
16109
|
|
|
16033
16110
|
## Tokens used
|
|
16034
16111
|
|
|
@@ -16076,6 +16153,29 @@ import { GradientArt } from "@sableui/react"
|
|
|
16076
16153
|
<GradientArt seed="Mara Okafor" className="grid size-10 place-items-center rounded-full text-label-md text-overlay-foreground">MO</GradientArt>
|
|
16077
16154
|
```
|
|
16078
16155
|
|
|
16156
|
+
### Soft header band with logo tiles
|
|
16157
|
+
|
|
16158
|
+
```tsx
|
|
16159
|
+
import { Button, Card, CardDescription, CardFooter, CardHeader, CardTitle, GradientArt, Icon } from "@sableui/react"
|
|
16160
|
+
|
|
16161
|
+
<Card className="w-full max-w-sm">
|
|
16162
|
+
<GradientArt intensity="soft" seed="Integrations" className="flex h-32 items-center justify-center gap-3 rounded-t-lg">
|
|
16163
|
+
{["mail", "calendar", "chart"].map((name) => (
|
|
16164
|
+
<span key={name} className="grid size-12 place-items-center rounded-lg border border-border-floating bg-popover text-popover-foreground shadow-md">
|
|
16165
|
+
<Icon name={name} className="text-xl" />
|
|
16166
|
+
</span>
|
|
16167
|
+
))}
|
|
16168
|
+
</GradientArt>
|
|
16169
|
+
<CardHeader>
|
|
16170
|
+
<CardTitle>Connect your tools</CardTitle>
|
|
16171
|
+
<CardDescription>Bring mail, calendar and analytics into one place.</CardDescription>
|
|
16172
|
+
</CardHeader>
|
|
16173
|
+
<CardFooter>
|
|
16174
|
+
<Button>Connect</Button>
|
|
16175
|
+
</CardFooter>
|
|
16176
|
+
</Card>
|
|
16177
|
+
```
|
|
16178
|
+
|
|
16079
16179
|
---
|
|
16080
16180
|
|
|
16081
16181
|
# InlineStatus
|
|
@@ -16147,7 +16247,7 @@ import { InlineStatus, Spinner } from "@sableui/react"
|
|
|
16147
16247
|
|
|
16148
16248
|
**Status:** stable
|
|
16149
16249
|
|
|
16150
|
-
Styled native text input. Soft-square (rounded-sm),
|
|
16250
|
+
Styled native text input. Soft-square (rounded-sm), the theme's field surface (outlined or filled), 2px focus ring; aria-invalid raises the destructive error treatment.
|
|
16151
16251
|
|
|
16152
16252
|
**Keywords:** input, text input, field, form, email, search, file, invalid, validation
|
|
16153
16253
|
|
|
@@ -16161,6 +16261,8 @@ Use Input for short freeform text, search, email, password, file, and native inp
|
|
|
16161
16261
|
- Do: Use type, inputMode, autoComplete, and placeholder as progressive hints, not as the only label.
|
|
16162
16262
|
- Do: Set aria-invalid or use Field error copy when validation fails.
|
|
16163
16263
|
- Do: Keep a focusable field at 16px or larger on mobile. iOS Safari zooms the whole page when a focused input computes under 16px and never zooms back out. Input handles this itself — below the sm breakpoint it renders text-body-lg (17px) and returns to text-body-md at sm and up. Build a custom field the same way: a second paired tier under a max-sm: variant, never a hand-set font-size.
|
|
16264
|
+
- Do: Choose outlined or filled fields once, in the theme: `--theme-field: var(--muted)` with `--theme-field-border: transparent` turns every Input, Textarea, Select, Combobox, SearchInput, InputGroup and ChatComposer into a borderless filled well; unset, they are outlined on the card. Every field reads the `field` / `field-border` pair, so they change together.
|
|
16265
|
+
- Don't: Restyle one Input as a filled chip with `bg-muted border-transparent`. It drifts from every other field on the page, and the theme can no longer move them together; set the field tokens instead.
|
|
16164
16266
|
- Don't: Override an Input's type with a page tier below 16px (text-body-md, text-body-sm, text-label-*) without a >=16px mobile arm — that reintroduces the iOS focus zoom.
|
|
16165
16267
|
- Don't: Use placeholder text as the label; it disappears once the user types and is not enough context.
|
|
16166
16268
|
- Don't: Use Input for long body copy. Use Textarea for multi-line content.
|
|
@@ -16190,7 +16292,7 @@ Use Input for short freeform text, search, email, password, file, and native inp
|
|
|
16190
16292
|
|
|
16191
16293
|
## Tokens used
|
|
16192
16294
|
|
|
16193
|
-
`
|
|
16295
|
+
`field-border`, `field`, `foreground`, `muted-foreground`, `ring`, `destructive`
|
|
16194
16296
|
|
|
16195
16297
|
## Accessibility
|
|
16196
16298
|
|
|
@@ -16305,7 +16407,7 @@ Use InputGroup when something belongs inside the field with the text: a unit, a
|
|
|
16305
16407
|
|
|
16306
16408
|
## Tokens used
|
|
16307
16409
|
|
|
16308
|
-
`
|
|
16410
|
+
`field-border`, `field`, `ring`, `destructive`, `muted-foreground`, `foreground`
|
|
16309
16411
|
|
|
16310
16412
|
## Motion
|
|
16311
16413
|
|
|
@@ -16651,7 +16753,7 @@ Use LineChart to compare how two or more measures change over the same sequence,
|
|
|
16651
16753
|
|
|
16652
16754
|
## Tokens used
|
|
16653
16755
|
|
|
16654
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`
|
|
16756
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
16655
16757
|
|
|
16656
16758
|
## Motion
|
|
16657
16759
|
|
|
@@ -17648,7 +17750,7 @@ import { Bubble, Button, Message, MessageScroller } from "@sableui/react"
|
|
|
17648
17750
|
|
|
17649
17751
|
A role=meter reading over Base UI Meter, drawn as a bar or a ring — how full something is within a known range (storage, quota, strength), with a tone for good/caution/bad. Not task progress.
|
|
17650
17752
|
|
|
17651
|
-
**Keywords:** meter, usage bar, storage, quota, capacity, limit, password strength, level
|
|
17753
|
+
**Keywords:** meter, usage bar, storage, quota, capacity, limit, password strength, level, segmented, tick bar, score, credits, spend limit
|
|
17652
17754
|
|
|
17653
17755
|
## Usage
|
|
17654
17756
|
|
|
@@ -17659,15 +17761,17 @@ Use Meter to show a static measurement against a known maximum — storage used,
|
|
|
17659
17761
|
- Do: Label it and show the reading in units people use ("7.2 of 10 GB"), with MeterLabel and MeterValue. The bar shows proportion; the number is what gets acted on.
|
|
17660
17762
|
- Do: Pick `tone` from thresholds you own and apply them consistently across the page — warning near the limit, destructive at or over it. The component does not guess where good becomes bad.
|
|
17661
17763
|
- Do: Use shape="ring" when the reading is a score that belongs in a small, glanceable spot on a card. It is the same measurement drawn as a circular gauge, not a different component.
|
|
17764
|
+
- Do: Use `segments` (a tick bar, ▮▮▮▮▮▮▯▯▯▯) for a discrete budget, score or quota read at a glance — a spend limit, credits left, an ICP lead score, months of data coverage. Pick a count that matches the unit when there is one (10 for a score out of 10, 12 for months) and otherwise size it to the track: a tick reads as a tick when it is taller than it is wide, about one per 8px of track (40 across a card row, 20 in a narrow table cell). Any reading above min shows at least one tick.
|
|
17662
17765
|
- Don't: Do not use Meter for a task in flight — an upload, an install, a step count. That is Progress; Meter tells assistive tech nothing is happening. → use **Progress**
|
|
17663
17766
|
- Don't: Do not use it for a value without a meaningful maximum (followers, total spend). A bar implies a full scale; an unbounded count is a stat.
|
|
17767
|
+
- Don't: Do not segment a fine-grained continuous value where the exact proportion matters (disk at 73.4%) — ticks round it to the nearest mark; use the continuous bar. And do not use a tick bar for a task in flight or steps completed: that is Progress, or a Stepper for named steps. → use **Progress**
|
|
17664
17768
|
|
|
17665
17769
|
### Anatomy
|
|
17666
17770
|
|
|
17667
17771
|
| Part | Required | Description |
|
|
17668
17772
|
| --- | --- | --- |
|
|
17669
17773
|
| MeterTrack | yes | The rail that represents the full range. |
|
|
17670
|
-
| MeterIndicator | yes | The fill, sized from value and coloured by tone. |
|
|
17774
|
+
| MeterIndicator | yes | The fill, sized from value and coloured by tone. Not used with `segments`: the track draws its ticks instead. |
|
|
17671
17775
|
| MeterLabel | no | The visible name; also names the meter for assistive tech. |
|
|
17672
17776
|
| MeterValue | no | The formatted reading. |
|
|
17673
17777
|
|
|
@@ -17675,7 +17779,7 @@ Use Meter to show a static measurement against a known maximum — storage used,
|
|
|
17675
17779
|
|
|
17676
17780
|
| Name | Type | Description |
|
|
17677
17781
|
| --- | --- | --- |
|
|
17678
|
-
| MeterTrack | Base UI Track props + className + size | The rail. Rendered automatically when Meter has no children; renders a MeterIndicator by default. |
|
|
17782
|
+
| MeterTrack | Base UI Track props + className + size | The rail. Rendered automatically when Meter has no children; renders a MeterIndicator by default — or, when the Meter has `segments`, its row of ticks (children are not rendered then). |
|
|
17679
17783
|
| MeterIndicator | Base UI Indicator props + className + tone | The fill. Inherits the Meter's tone unless given its own. |
|
|
17680
17784
|
| MeterLabel | Base UI Label props + className | Visible label; wires aria-labelledby on the root. |
|
|
17681
17785
|
| MeterValue | Base UI Value props + className | Formatted reading. Accepts a `(formatted, value) => ReactNode` child. |
|
|
@@ -17691,6 +17795,7 @@ Use Meter to show a static measurement against a known maximum — storage used,
|
|
|
17691
17795
|
| shape | "bar" \| "ring" | "bar" | bar is a horizontal track; ring is a circular gauge for a small, glanceable reading — the same value, min, max and tones. |
|
|
17692
17796
|
| size | "sm" \| "md" \| "lg" | "md" | Ring diameter (40 / 64 / 96px at the default spacing; the centre value steps with it), or bar thickness on the same sm / md / lg rails as Progress. |
|
|
17693
17797
|
| showValue | boolean | — | Print the value in the ring's centre (formatted like MeterValue). |
|
|
17798
|
+
| segments | number | — | Draw the bar as this many separate ticks instead of a continuous fill (a quota, score or spend limit). Filled ticks = round(share × N), at least one for any reading above min, none at min. Ticks take the tone; empty ones sit on the rail colour. The segmented track has its own, taller sm / md / lg ladder. Bar only: ignored for shape="ring". |
|
|
17694
17799
|
| strokeWidth | number | 6 | Ring stroke width, in viewBox units of 100. |
|
|
17695
17800
|
| format | Intl.NumberFormatOptions | — | Formatting for MeterValue and aria-valuetext (percent, unit, currency). |
|
|
17696
17801
|
| getAriaValueText | (formatted: string, value: number) => string | — | Human-readable reading for assistive tech ("7.2 of 10 gigabytes used"). |
|
|
@@ -17704,13 +17809,14 @@ Use Meter to show a static measurement against a known maximum — storage used,
|
|
|
17704
17809
|
|
|
17705
17810
|
## Tokens used
|
|
17706
17811
|
|
|
17707
|
-
`secondary`, `primary`, `success`, `tone-warning`, `destructive`, `foreground`, `muted-foreground`
|
|
17812
|
+
`secondary`, `primary`, `tone-3`, `success`, `tone-warning`, `destructive`, `foreground`, `muted-foreground`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-3-mark`
|
|
17708
17813
|
|
|
17709
17814
|
## Motion
|
|
17710
17815
|
|
|
17711
17816
|
- **arrival** · Meter · _no motion_ — A meter is a reading, present with the page that reports it. Animating the fill up from zero on load would act out a change that did not happen.
|
|
17712
17817
|
- **response** · Meter · _no motion_ — It reports and accepts no input. A bar that reacted to the pointer would read as a Slider the user could drag.
|
|
17713
17818
|
- **transition** · MeterIndicator · _custom (outside the recipe layer)_ — Width and colour ease on the motion tokens (no recipe animates width) when the reading changes — freeing space after a delete visibly shrinks the bar, so the user sees the cause and effect rather than a different bar.
|
|
17819
|
+
- **transition** · MeterTrack (segments) · _custom (outside the recipe layer)_ — With segments, the fill runs through the ticks from the edge it is leaving — left to right as it grows, right to left as it shrinks — each tick easing its colour on the fast token after a stagger that is a share of the slow token (a full sweep is one slow duration) × --motion-expressive. Every tick switching at once would read as a different bar, not the same budget moving; `subtle` lands them together and off is instant.
|
|
17714
17820
|
- **activity** · Meter · _no motion_ — A meter has no indeterminate state; a reading is either known or not shown. Unknown-but-working is Progress with no value.
|
|
17715
17821
|
|
|
17716
17822
|
## Accessibility
|
|
@@ -17755,6 +17861,31 @@ import { Meter, MeterLabel, MeterTrack, MeterValue } from "@sableui/react"
|
|
|
17755
17861
|
</Meter>
|
|
17756
17862
|
```
|
|
17757
17863
|
|
|
17864
|
+
### Segmented spend limit
|
|
17865
|
+
|
|
17866
|
+
```tsx
|
|
17867
|
+
import { Meter, MeterLabel, MeterTrack, MeterValue } from "@sableui/react"
|
|
17868
|
+
|
|
17869
|
+
<Meter value={1240} max={2000} segments={40} getAriaValueText={() => "€1,240 of €2,000 spent this month"}>
|
|
17870
|
+
<div className="mb-2 flex flex-wrap items-center justify-between gap-x-3 gap-y-1">
|
|
17871
|
+
<MeterLabel>Monthly spend limit</MeterLabel>
|
|
17872
|
+
<MeterValue>{() => "€1,240 / €2,000"}</MeterValue>
|
|
17873
|
+
</div>
|
|
17874
|
+
<MeterTrack />
|
|
17875
|
+
</Meter>
|
|
17876
|
+
```
|
|
17877
|
+
|
|
17878
|
+
### Segmented score cell
|
|
17879
|
+
|
|
17880
|
+
```tsx
|
|
17881
|
+
import { Meter } from "@sableui/react"
|
|
17882
|
+
|
|
17883
|
+
<div className="flex items-center gap-3">
|
|
17884
|
+
<Meter value={8} max={10} segments={10} size="sm" tone="success" className="w-24" aria-label="ICP score" getAriaValueText={(_, v) => `${v} out of 10`} />
|
|
17885
|
+
<span className="text-mono-sm text-foreground">8/10</span>
|
|
17886
|
+
</div>
|
|
17887
|
+
```
|
|
17888
|
+
|
|
17758
17889
|
### Tones
|
|
17759
17890
|
|
|
17760
17891
|
```tsx
|
|
@@ -17987,7 +18118,7 @@ Use Note for helpful supporting information that should sit near the relevant co
|
|
|
17987
18118
|
|
|
17988
18119
|
## Tokens used
|
|
17989
18120
|
|
|
17990
|
-
`foreground`, `border`, `muted`, `muted-foreground`, `tone-info`, `tone-warning`, `success`, `destructive`
|
|
18121
|
+
`foreground`, `border`, `muted`, `muted-foreground`, `tone-info`, `tone-warning`, `success`, `destructive`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-info-mark`
|
|
17991
18122
|
|
|
17992
18123
|
## Motion
|
|
17993
18124
|
|
|
@@ -18154,7 +18285,7 @@ Use NumberField for numeric values that benefit from validation, min/max bounds,
|
|
|
18154
18285
|
|
|
18155
18286
|
## Tokens used
|
|
18156
18287
|
|
|
18157
|
-
`
|
|
18288
|
+
`field-border`, `field`, `foreground`, `muted-foreground`, `accent`, `accent-foreground`, `ring`
|
|
18158
18289
|
|
|
18159
18290
|
## Accessibility
|
|
18160
18291
|
|
|
@@ -18332,7 +18463,7 @@ Use OtpField for a short, fixed-length code the user copies from somewhere else
|
|
|
18332
18463
|
|
|
18333
18464
|
## Tokens used
|
|
18334
18465
|
|
|
18335
|
-
`
|
|
18466
|
+
`field-border`, `field`, `foreground`, `muted-foreground`, `border-strong`, `primary`, `ring`, `destructive`
|
|
18336
18467
|
|
|
18337
18468
|
## Motion
|
|
18338
18469
|
|
|
@@ -19159,7 +19290,7 @@ Use PieChart for a share of one total across two to six categories — traffic s
|
|
|
19159
19290
|
|
|
19160
19291
|
## Tokens used
|
|
19161
19292
|
|
|
19162
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`
|
|
19293
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
19163
19294
|
|
|
19164
19295
|
## Motion
|
|
19165
19296
|
|
|
@@ -19543,7 +19674,7 @@ Use RadarChart to compare the shape of a profile across five to eight dimensions
|
|
|
19543
19674
|
|
|
19544
19675
|
## Tokens used
|
|
19545
19676
|
|
|
19546
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`
|
|
19677
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
19547
19678
|
|
|
19548
19679
|
## Motion
|
|
19549
19680
|
|
|
@@ -19655,7 +19786,7 @@ Use RadialChart for progress toward goals (several rings), a single score or usa
|
|
|
19655
19786
|
|
|
19656
19787
|
## Tokens used
|
|
19657
19788
|
|
|
19658
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`
|
|
19789
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `primary`, `muted-foreground`, `border`, `popover`, `popover-foreground`, `foreground`, `background`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
19659
19790
|
|
|
19660
19791
|
## Motion
|
|
19661
19792
|
|
|
@@ -20315,7 +20446,7 @@ import { PropertyRow, ScrubField, Slider } from "@sableui/react"
|
|
|
20315
20446
|
|
|
20316
20447
|
**Status:** stable
|
|
20317
20448
|
|
|
20318
|
-
Styled search field with a leading magnifier and a clearable X. Soft-square (rounded-sm),
|
|
20449
|
+
Styled search field with a leading magnifier and a clearable X. Soft-square (rounded-sm), the theme's field surface, 2px focus ring; the clear button appears only when there is a value.
|
|
20319
20450
|
|
|
20320
20451
|
**Keywords:** search, input, filter, query
|
|
20321
20452
|
|
|
@@ -20328,6 +20459,7 @@ Use SearchInput for text queries that filter or search a known content set.
|
|
|
20328
20459
|
- Do: Use a clear placeholder that names the content being searched.
|
|
20329
20460
|
- Do: Provide a visible clear affordance when query state persists.
|
|
20330
20461
|
- Do: When a button stands in for search (a header trigger that opens CommandMenu with ⌘K), use CommandMenuTrigger. It wears this field's shell from the same source, so the two cannot drift; a hand-styled button already did once, into a borderless chip that matched neither the field nor a button.
|
|
20462
|
+
- Do: Light the query in the results it filters with `useMatchHighlight(query)` — a callback ref for the results container, with `selector` to keep it to titles. It paints on the `highlight` pair without wrapping matches in `<mark>`, the same paint Combobox and CommandMenu use for their rows.
|
|
20331
20463
|
- Don't: Do not use SearchInput as a command palette; use CommandMenu for global commands, opened from the header by CommandMenuTrigger. A SearchInput that opens a dialog on focus is a text box you cannot type in.
|
|
20332
20464
|
- Don't: Do not search on every keystroke against an expensive backend without debouncing. The user sees results flicker and reorder under them, and you send a request per character.
|
|
20333
20465
|
|
|
@@ -20347,7 +20479,7 @@ Use SearchInput for text queries that filter or search a known content set.
|
|
|
20347
20479
|
|
|
20348
20480
|
## Tokens used
|
|
20349
20481
|
|
|
20350
|
-
`
|
|
20482
|
+
`field-border`, `field`, `foreground`, `muted-foreground`, `ring`, `destructive`
|
|
20351
20483
|
|
|
20352
20484
|
## Motion
|
|
20353
20485
|
|
|
@@ -20395,6 +20527,23 @@ import { Field, SearchInput } from "@sableui/react"
|
|
|
20395
20527
|
<Field label="Search posts"><SearchInput defaultValue="roadmap" className="max-w-80" /></Field>
|
|
20396
20528
|
```
|
|
20397
20529
|
|
|
20530
|
+
### Highlighting matches in the results
|
|
20531
|
+
|
|
20532
|
+
```tsx
|
|
20533
|
+
import { SearchInput, useMatchHighlight } from "@sableui/react"
|
|
20534
|
+
|
|
20535
|
+
const [q, setQ] = useState("")
|
|
20536
|
+
const results = useMatchHighlight<HTMLUListElement>(q, { selector: "[data-title]" })
|
|
20537
|
+
const shown = posts.filter((post) => post.title.toLowerCase().includes(q.trim().toLowerCase()))
|
|
20538
|
+
|
|
20539
|
+
<SearchInput value={q} onValueChange={setQ} placeholder="Search posts" />
|
|
20540
|
+
<ul ref={results}>
|
|
20541
|
+
{shown.map((post) => (
|
|
20542
|
+
<li key={post.id}><span data-title>{post.title}</span></li>
|
|
20543
|
+
))}
|
|
20544
|
+
</ul>
|
|
20545
|
+
```
|
|
20546
|
+
|
|
20398
20547
|
### Disabled
|
|
20399
20548
|
|
|
20400
20549
|
```tsx
|
|
@@ -20594,7 +20743,7 @@ Use SegmentedBar when a stat card or row needs to show how a total divides into
|
|
|
20594
20743
|
|
|
20595
20744
|
## Tokens used
|
|
20596
20745
|
|
|
20597
|
-
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `primary`, `muted-foreground`, `success`, `tone-warning`, `destructive`
|
|
20746
|
+
`tone-1`, `tone-2`, `tone-3`, `tone-info`, `primary`, `muted-foreground`, `success`, `tone-warning`, `destructive`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
20598
20747
|
|
|
20599
20748
|
## Motion
|
|
20600
20749
|
|
|
@@ -20709,7 +20858,7 @@ Use Select when users choose one value from a known, finite set. Use Combobox fo
|
|
|
20709
20858
|
|
|
20710
20859
|
## Tokens used
|
|
20711
20860
|
|
|
20712
|
-
`
|
|
20861
|
+
`field-border`, `field`, `foreground`, `ring`, `border`, `popover`, `popover-foreground`, `accent`, `accent-foreground`, `muted-foreground`
|
|
20713
20862
|
|
|
20714
20863
|
## Motion
|
|
20715
20864
|
|
|
@@ -21194,6 +21343,7 @@ Use Sidebar for persistent desktop navigation or application chrome outside the
|
|
|
21194
21343
|
- Do: Use it for stable app destinations that should remain visible while content changes.
|
|
21195
21344
|
- Do: Keep item labels predictable and active state obvious.
|
|
21196
21345
|
- Do: Set surface="page" when a full-width top bar sits above the rail. A theme's tinted or dark rail is for a full-height rail that frames the app.
|
|
21346
|
+
- Do: Keep surface="rail" inside AppShell frame="inset": the rail's tint becomes the ground the main panel floats on. Do not add a border-r class back — the gap is the divider.
|
|
21197
21347
|
- Don't: Do not use Sidebar for page-local settings, filters, or temporary action groups.
|
|
21198
21348
|
- Don't: Do not put page content in it. It is fixed-width chrome OUTSIDE the content grid, so anything in it is exempt from the page's measure and rhythm.
|
|
21199
21349
|
|
|
@@ -21219,7 +21369,7 @@ Use Sidebar for persistent desktop navigation or application chrome outside the
|
|
|
21219
21369
|
| collapsed | boolean | false | Collapse the rail to an icon-only width (--sidebar-width-collapsed). Items hide their label + badge and reveal the label in a hover tooltip; the content area reflows. Controlled — wire a toggle from app state. Read the state in custom header/footer content via useSidebar(). |
|
|
21220
21370
|
| icons | boolean | true | Render the leading icon on each SidebarItem. Set false for a text-only rail. Ignored while collapsed (icon-only by definition). |
|
|
21221
21371
|
| variant | "app" \| "inline" | "app" | Where the rail lives. "app" is the page's chrome column — sticky, full viewport height, hidden below lg where AppHeader + BottomNav take over. "inline" is always visible and fills its parent's height, for a rail inside a bounded frame (a nested shell, an embedded preview). Use it instead of overriding the layout with !important classes. |
|
|
21222
|
-
| surface | "rail" \| "page" | "rail" | Which surface the rail is painted on. "rail" is its own --sidebar-* surface with a border — right for a full-height rail that frames the app, which a theme may tint or paint dark. "page" uses the page's surface and ink with no border — use it when a full-width header sits above the rail, where a tinted column starting under a page-coloured bar reads as pasted on. Use it instead of overriding bg-/text- classes, which the rail's re-pointed tokens defeat. |
|
|
21372
|
+
| surface | "rail" \| "page" | "rail" | Which surface the rail is painted on. "rail" is its own --sidebar-* surface with a border — right for a full-height rail that frames the app, which a theme may tint or paint dark. "page" uses the page's surface and ink with no border — use it when a full-width header sits above the rail, where a tinted column starting under a page-coloured bar reads as pasted on. Use it instead of overriding bg-/text- classes, which the rail's re-pointed tokens defeat. In AppShell's sidebar slot with frame="inset", the rail's surface is also the shell's ground: from lg a "rail" rail drops its border (the gap around the main panel divides them) and either surface stretches to the shell's body row instead of sizing to the viewport. AppShell signals this to its sidebar slot only, so a Sidebar elsewhere in the page is unaffected. |
|
|
21223
21373
|
| motion | "full" \| "subtle" \| "off" | "full" | How much motion this component uses: `full` inherits the app's policy, `subtle` keeps feedback and drops the collapse ease and the current-page glide, `off` stills it. It can only turn motion down — it never overrides a reader's reduce-motion setting. |
|
|
21224
21374
|
|
|
21225
21375
|
## Variants
|
|
@@ -21228,7 +21378,7 @@ Use Sidebar for persistent desktop navigation or application chrome outside the
|
|
|
21228
21378
|
|
|
21229
21379
|
## Tokens used
|
|
21230
21380
|
|
|
21231
|
-
`sidebar`, `sidebar-foreground`, `sidebar-border`, `sidebar-accent`, `sidebar-accent-foreground`, `sidebar-ring`
|
|
21381
|
+
`sidebar`, `sidebar-foreground`, `sidebar-border`, `sidebar-accent`, `sidebar-accent-foreground`, `sidebar-ring`, `shell-ground`
|
|
21232
21382
|
|
|
21233
21383
|
## Motion
|
|
21234
21384
|
|
|
@@ -21636,7 +21786,7 @@ Use Sparkline next to a number to show where it has been — a KPI's last 30 day
|
|
|
21636
21786
|
|
|
21637
21787
|
## Tokens used
|
|
21638
21788
|
|
|
21639
|
-
`primary`, `tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `muted-foreground`, `success`, `destructive`
|
|
21789
|
+
`primary`, `tone-1`, `tone-2`, `tone-3`, `tone-info`, `tone-warning`, `muted-foreground`, `success`, `destructive`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
21640
21790
|
|
|
21641
21791
|
## Motion
|
|
21642
21792
|
|
|
@@ -21907,7 +22057,7 @@ Use StatusDot as a compact visual state cue next to text, avatars, rows, or labe
|
|
|
21907
22057
|
|
|
21908
22058
|
## Tokens used
|
|
21909
22059
|
|
|
21910
|
-
`palette-dot`, `muted-foreground`, `tone-3`, `success`, `tone-warning`, `tone-info`, `tone-1`, `tone-2`, `destructive`
|
|
22060
|
+
`palette-dot`, `muted-foreground`, `tone-3`, `success`, `tone-warning`, `tone-info`, `tone-1`, `tone-2`, `destructive`, `destructive-mark`, `success-mark`, `tone-warning-mark`, `tone-info-mark`, `tone-1-mark`, `tone-2-mark`, `tone-3-mark`
|
|
21911
22061
|
|
|
21912
22062
|
## Accessibility
|
|
21913
22063
|
|
|
@@ -21992,7 +22142,7 @@ Use Stepper above or beside a flow that is split into a known, small number of n
|
|
|
21992
22142
|
|
|
21993
22143
|
## Tokens used
|
|
21994
22144
|
|
|
21995
|
-
`primary`, `primary-foreground`, `background`, `foreground`, `muted-foreground`, `border-strong`, `destructive`, `destructive-foreground`, `ring`
|
|
22145
|
+
`primary`, `primary-foreground`, `background`, `foreground`, `muted-foreground`, `border-strong`, `destructive`, `destructive-foreground`, `ring`, `destructive-mark`
|
|
21996
22146
|
|
|
21997
22147
|
## Motion
|
|
21998
22148
|
|
|
@@ -22285,8 +22435,8 @@ Use Table for structured data with consistent columns and rows. Use DataTable wh
|
|
|
22285
22435
|
| TableBody | ComponentPropsWithRef<"tbody"> | The data row group (tbody). |
|
|
22286
22436
|
| TableFooter | ComponentPropsWithRef<"tfoot"> | Summary row group (tfoot) with a muted fill. |
|
|
22287
22437
|
| TableRow | ComponentPropsWithRef<"tr"> | A row (tr) — hairline bottom border, hover lift, and a selected state via the data-selected attribute. |
|
|
22288
|
-
| TableHead | ComponentPropsWithRef<"th"> | A column header cell (th) in muted label styling. |
|
|
22289
|
-
| TableCell | ComponentPropsWithRef<"td"> | A data cell (td). |
|
|
22438
|
+
| TableHead | ComponentPropsWithRef<"th"> & { numeric?: boolean } | A column header cell (th) in muted label styling. `numeric` marks a number column: end-aligned, tabular figures — set it on the column's cells too. |
|
|
22439
|
+
| TableCell | ComponentPropsWithRef<"td"> & { numeric?: boolean } | A data cell (td). `numeric` end-aligns it with tabular figures, matching its column's header. |
|
|
22290
22440
|
| TableCaption | ComponentPropsWithRef<"caption"> | Accessible description of the table (caption), muted. |
|
|
22291
22441
|
|
|
22292
22442
|
## Props
|
|
@@ -22478,7 +22628,7 @@ import { Tabs, TabsList, TabsPanel, TabsTrigger } from "@sableui/react"
|
|
|
22478
22628
|
|
|
22479
22629
|
**Status:** stable
|
|
22480
22630
|
|
|
22481
|
-
Styled native multi-line text control. Soft-square,
|
|
22631
|
+
Styled native multi-line text control. Soft-square, the theme's field surface, --ring focus, and an aria-invalid destructive error state.
|
|
22482
22632
|
|
|
22483
22633
|
**Keywords:** textarea, multi line input, form, text
|
|
22484
22634
|
|
|
@@ -22507,7 +22657,7 @@ Use Textarea for multi-line freeform text entry such as notes, descriptions, or
|
|
|
22507
22657
|
|
|
22508
22658
|
## Tokens used
|
|
22509
22659
|
|
|
22510
|
-
`
|
|
22660
|
+
`field-border`, `field`, `foreground`, `muted-foreground`, `ring`, `destructive`
|
|
22511
22661
|
|
|
22512
22662
|
## Accessibility
|
|
22513
22663
|
|
|
@@ -24033,7 +24183,7 @@ Which token to reach for, and what it is most often confused with. Generated fro
|
|
|
24033
24183
|
- **Not** `border-strong`. Reach for `border-strong` when the line carries *structure* (a grid rule, a table divider, a section separator) and for `border` when it merely bounds a control.
|
|
24034
24184
|
- **`border-strong`** — A structural divider. Visibly stronger than `border`. *Use for:* Grid lines, table rules, separators between major sections.
|
|
24035
24185
|
- **Not** `border`. If removing the line would make the layout ambiguous, it is structural and belongs here.
|
|
24036
|
-
- **`input`** — The outline of a form control specifically. *Use for:* Text inputs, textareas and selects. Not the edge of a checkbox, radio or switch — that is `control-border`.
|
|
24186
|
+
- **`input`** — The outline of a form control specifically. *Use for:* Text inputs, textareas and selects (through `field-border`, which derives from it). Not the edge of a checkbox, radio or switch — that is `control-border`.
|
|
24037
24187
|
- **Not** `border`. They are often the same value, but a theme is entitled to make form controls read differently from other chrome, and only this token gives it the hook.
|
|
24038
24188
|
- **`control-border`** — The resting edge of a control whose outline is the whole control. Held to 3:1 (WCAG 1.4.11) on every surface. *Use for:* An unchecked checkbox, an unselected radio, an off switch track, a selection card's check or radio mark — anywhere removing the edge would make the control disappear.
|
|
24039
24189
|
- **Not** `input`. A text field is also found by its fill, caret and placeholder, so its outline may stay quiet; a checkbox has nothing else, and at `input`'s strength it measures about 1.4:1.
|
|
@@ -24323,7 +24473,7 @@ Which token to reach for, and what it is most often confused with. Generated fro
|
|
|
24323
24473
|
- **`type-mono-sm-tracking`** — The monospace family: mono-xl through mono-sm, plus mono-caption. *Use for:* Code, identifiers, hashes, keyboard keys, and any figure where digits must align in a column.
|
|
24324
24474
|
- **Not** the sans tiers for numeric data. Proportional digits make a column of numbers ragged; that is what `text-ui-num` solves in chrome and mono solves on a page.
|
|
24325
24475
|
|
|
24326
|
-
### derived (
|
|
24476
|
+
### derived (20)
|
|
24327
24477
|
|
|
24328
24478
|
- **`canvas`** — The WORK surface — the artboard, the document being edited. *Use for:* Behind the thing the tool operates on. `WorkspaceCanvas` uses it.
|
|
24329
24479
|
- **Not** `background`. The thing being edited is not the page behind the UI, and collapsing the two makes the document indistinguishable from its chrome.
|
|
@@ -24345,6 +24495,26 @@ Which token to reach for, and what it is most often confused with. Generated fro
|
|
|
24345
24495
|
- **Not** `hairline`, when the line would otherwise disappear against what it bounds.
|
|
24346
24496
|
- **`border-floating`** — The edge of a floating surface. Fainter than `border`: the shadow carries the elevation. *Use for:* Every floating surface — popover, menu, select, tooltip, dialog, sheet, toast, a floating panel — as `border-border-floating` or `ring-border-floating`, together with `bg-popover` and a `shadow-md`+ shadow. Derived for every theme (a faint alpha of the foreground); a theme may tune it with `--theme-border-floating`.
|
|
24347
24497
|
- **Not** `border`. A full hairline plus a shadow stacks into a heavy outline around anything that floats. `border` is for resting edges: inputs, cards, badges.
|
|
24498
|
+
- **`field`** — The fill of a text field: Input, Textarea, Select, Combobox, SearchInput, InputGroup, ChatComposer. *Use for:* Read by every field through its shell, so you rarely name it. Derived for every theme (`card`, an outlined field on the card); a theme fills its fields instead with `--theme-field: var(--muted)` and `--theme-field-border: transparent`, and every field changes at once. Name it only for a field-shaped surface of your own that must match.
|
|
24499
|
+
- **Not** `card` or `muted` on a hand-built field. A field that paints `card` keeps its outline when the theme fills the rest, and one that paints `muted` stays filled when the theme outlines them.
|
|
24500
|
+
- **`field-border`** — The outline of a text field. Derived from `input`; `transparent` in a theme with filled fields. *Use for:* With `field`, on the same field-shaped surfaces. Tune it with `--theme-field-border`.
|
|
24501
|
+
- **Not** `input` on a text field. `input` stays the theme's outline colour for form chrome; this is the field's outline, which a filled theme turns off.
|
|
24502
|
+
- **`shell-ground`** — The ground of an inset app frame: the rail and the gap around the raised main panel. *Use for:* Painted by `<AppShell frame="inset">` and the Sidebar in its slot; you rarely name it. Derived for every theme as one step off `sidebar` toward its ink, so the panel reads as lifted even where the rail is the page colour. Tune it with `--theme-shell-ground`.
|
|
24503
|
+
- **Not** `sidebar` or `canvas` behind an inset panel. `sidebar` is the page colour in most themes, so the panel would sit on itself; `canvas` is a workspace's artboard, not app chrome.
|
|
24504
|
+
- **`destructive-mark`** — `destructive` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-destructive-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-destructive-mark` or gets one derived from `destructive`.
|
|
24505
|
+
- **Not** `bg-destructive` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-destructive` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24506
|
+
- **`success-mark`** — `success` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-success-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-success-mark` or gets one derived from `success`.
|
|
24507
|
+
- **Not** `bg-success` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-success` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24508
|
+
- **`tone-warning-mark`** — `tone-warning` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-tone-warning-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-tone-warning-mark` or gets one derived from `tone-warning`.
|
|
24509
|
+
- **Not** `bg-tone-warning` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-tone-warning` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24510
|
+
- **`tone-info-mark`** — `tone-info` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-tone-info-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-tone-info-mark` or gets one derived from `tone-info`.
|
|
24511
|
+
- **Not** `bg-tone-info` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-tone-info` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24512
|
+
- **`tone-1-mark`** — `tone-1` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-tone-1-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-tone-1-mark` or gets one derived from `tone-1`.
|
|
24513
|
+
- **Not** `bg-tone-1` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-tone-1` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24514
|
+
- **`tone-2-mark`** — `tone-2` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-tone-2-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-tone-2-mark` or gets one derived from `tone-2`.
|
|
24515
|
+
- **Not** `bg-tone-2` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-tone-2` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24516
|
+
- **`tone-3-mark`** — `tone-3` at graphic strength: the same hue lifted and saturated, for a mark that carries no text. *Use for:* A meter's or progress fill, a segmented bar, a status dot, a chart series, and the soft tint behind a badge or note (`bg-tone-3-mark/15`). Held to 2:1 on the page — visibility, not a text ratio — because each of these sits beside text that says the same thing. Every bundled theme tunes its own; a preset sets `--theme-tone-3-mark` or gets one derived from `tone-3`.
|
|
24517
|
+
- **Not** `bg-tone-3` on a mark. The fill is pinned dark enough to carry a white label, so a meter or dot painted with it reads brown, forest or plum. And not for text — that is `text-tone-3` — nor for a graphic that is the only carrier of its meaning, which owes 3:1 (WCAG 1.4.11): use the fill or add the text.
|
|
24348
24518
|
|
|
24349
24519
|
### Generated palette
|
|
24350
24520
|
|
|
@@ -24594,7 +24764,7 @@ The `@utility` and `@custom-variant` layer in `styles.css`: what each one is, wh
|
|
|
24594
24764
|
- **Instead of** A hand-written dash-offset animation with literal timing, which keeps animating, or keeps its delay, under reduced motion.
|
|
24595
24765
|
- `<Reveal><svg viewBox="0 0 100 100"><path className="motion-draw" pathLength="1" d="M10 50 L90 50" /></svg></Reveal>`
|
|
24596
24766
|
|
|
24597
|
-
### helper (
|
|
24767
|
+
### helper (6)
|
|
24598
24768
|
|
|
24599
24769
|
- **`hit-target`** — Grows an element's tap target to 44px with a transparent `::after`, without moving its layout by a pixel. `--hit-target-size` overrides the size. *Use for:* A deliberately small mark — a tag's remove ×, a tiny disclosure, a toast close — that must still meet the WCAG touch floor. Shrink it (`[--hit-target-size:32px]`) where targets sit side by side, or the later one steals the taps.
|
|
24600
24770
|
- **Instead of** Padding the glyph up (moves it off the row's grid and pushes siblings) or a bigger icon. Never on an `<input>` or other replaced element — pseudo-elements silently do nothing there; wrap it in a label.
|
|
@@ -24611,3 +24781,6 @@ The `@utility` and `@custom-variant` layer in `styles.css`: what each one is, wh
|
|
|
24611
24781
|
- **`checkerboard`** — The transparency checkerboard, painted from `--panel` and a derived darker step so it reads in both modes. `--checkerboard-size` (default 16px) and `--checkerboard-alt` tune it. *Use for:* Behind anything that can be translucent: a colour swatch with alpha, an image or artboard preview, an alpha slider track.
|
|
24612
24782
|
- **Instead of** A hand-rolled `repeating-conic-gradient` with two hardcoded greys. Deliberately not named `bg-checkerboard`, so `cn()` never merges it away against a real `bg-*` colour — you can layer a colour over it.
|
|
24613
24783
|
- `<div className="checkerboard [--checkerboard-size:8px] size-6 rounded-sm" />`
|
|
24784
|
+
- **`texture-dither`** — A faint pixel / halftone dither field that dissolves: a small pseudo-random tile of squares painted in `--border-strong` and faded out by a gradient mask. Static, pure CSS, follows every theme and mode. Hooks: `--dither-fade` (direction, any linear-gradient side or angle, default `to bottom`), `--dither-size` (tile, default 48px = 2px squares) and `--dither-color` (default `var(--border-strong)`). *Use for:* Decoration at the top of a content area, a panel or a card, or behind an empty-state heading. Put it on its own `aria-hidden` element, `absolute -z-10` as the first child of a `relative isolate` parent, so the content after it paints on top with no z-index of its own. It sets `pointer-events: none` and no position, so it never takes layout or catches clicks.
|
|
24785
|
+
- **Instead of** A hand-written `radial-gradient` dot grid (reads as graph paper, not dither), a PNG noise texture, a canvas, or hardcoded greys. Deliberately not named `bg-dither`, so `cn()` never merges it away against a real `bg-*` colour class.
|
|
24786
|
+
- `<div className="relative isolate"><div aria-hidden className="texture-dither absolute inset-x-0 top-0 -z-10 h-40" /></div>`
|