zabi-components 8.0.0 → 8.1.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 +1924 -0
- package/README.md +243 -10
- package/THEME.md +149 -332
- package/THEMING.md +1192 -266
- package/dist/atoms/ActionPanel.svelte +15 -5
- package/dist/atoms/Avatar.svelte +104 -0
- package/dist/atoms/Avatar.svelte.d.ts +34 -0
- package/dist/atoms/Badge.svelte +36 -7
- package/dist/atoms/Badge.svelte.d.ts +2 -2
- package/dist/atoms/Button.svelte +177 -27
- package/dist/atoms/Button.svelte.d.ts +30 -2
- package/dist/atoms/Card.svelte +4 -4
- package/dist/atoms/CardHeader.svelte +16 -4
- package/dist/atoms/Checkbox.svelte +48 -21
- package/dist/atoms/Checkbox.svelte.d.ts +4 -2
- package/dist/atoms/CodeBlock.svelte +20 -2
- package/dist/atoms/CodeBlock.svelte.d.ts +4 -0
- package/dist/atoms/ColorPicker.svelte +259 -49
- package/dist/atoms/ColorPicker.svelte.d.ts +3 -0
- package/dist/atoms/Container.svelte +16 -8
- package/dist/atoms/DateField.svelte +107 -0
- package/dist/atoms/DateField.svelte.d.ts +53 -0
- package/dist/atoms/FieldMessages.svelte +69 -0
- package/dist/atoms/FieldMessages.svelte.d.ts +23 -0
- package/dist/atoms/FloatingActionButton.svelte +174 -0
- package/dist/atoms/FloatingActionButton.svelte.d.ts +51 -0
- package/dist/atoms/Heading.svelte +37 -5
- package/dist/atoms/Heading.svelte.d.ts +7 -0
- package/dist/atoms/IconButton.svelte +220 -24
- package/dist/atoms/IconButton.svelte.d.ts +49 -4
- package/dist/atoms/Input.svelte +253 -52
- package/dist/atoms/Input.svelte.d.ts +32 -2
- package/dist/atoms/List.svelte +4 -1
- package/dist/atoms/ListItem.svelte +44 -11
- package/dist/atoms/ListItem.svelte.d.ts +5 -0
- package/dist/atoms/Progress.svelte +27 -8
- package/dist/atoms/Progress.svelte.d.ts +4 -0
- package/dist/atoms/Radio.svelte +19 -3
- package/dist/atoms/Radio.svelte.d.ts +4 -2
- package/dist/atoms/Rating.svelte +494 -0
- package/dist/atoms/Rating.svelte.d.ts +56 -0
- package/dist/atoms/Select.svelte +433 -91
- package/dist/atoms/Select.svelte.d.ts +49 -3
- package/dist/atoms/SelectionControl.svelte +94 -17
- package/dist/atoms/SelectionControl.svelte.d.ts +4 -3
- package/dist/atoms/Skeleton.svelte +1 -1
- package/dist/atoms/Slider.svelte +309 -0
- package/dist/atoms/Slider.svelte.d.ts +40 -0
- package/dist/atoms/Spinner.svelte +57 -0
- package/dist/atoms/Spinner.svelte.d.ts +19 -0
- package/dist/atoms/Table.svelte +151 -6
- package/dist/atoms/Table.svelte.d.ts +15 -3
- package/dist/atoms/TemporalField.svelte +140 -0
- package/dist/atoms/TemporalField.svelte.d.ts +32 -0
- package/dist/atoms/Text.svelte +23 -11
- package/dist/atoms/Text.svelte.d.ts +6 -3
- package/dist/atoms/Textarea.svelte +55 -44
- package/dist/atoms/Textarea.svelte.d.ts +14 -2
- package/dist/atoms/ThemeToggle.svelte +223 -44
- package/dist/atoms/ThemeToggle.svelte.d.ts +26 -3
- package/dist/atoms/TimeField.svelte +108 -0
- package/dist/atoms/TimeField.svelte.d.ts +54 -0
- package/dist/atoms/Toast.svelte +17 -4
- package/dist/atoms/Toast.svelte.d.ts +2 -0
- package/dist/atoms/Toggle.svelte +41 -8
- package/dist/atoms/Toggle.svelte.d.ts +11 -2
- package/dist/atoms/Tooltip.svelte +508 -23
- package/dist/atoms/Tooltip.svelte.d.ts +11 -0
- package/dist/atoms/ZabiStringsProvider.svelte +45 -0
- package/dist/atoms/ZabiStringsProvider.svelte.d.ts +27 -0
- package/dist/atoms/index.d.ts +17 -0
- package/dist/atoms/index.js +12 -0
- package/dist/atoms/selection-control.styles.d.ts +36 -5
- package/dist/atoms/selection-control.styles.js +40 -9
- package/dist/components/atoms/index.d.ts +17 -0
- package/dist/components/atoms/index.d.ts.map +1 -1
- package/dist/components/atoms/selection-control.styles.d.ts +36 -5
- package/dist/components/atoms/selection-control.styles.d.ts.map +1 -1
- package/dist/components/index.d.ts +80 -2
- package/dist/components/index.d.ts.map +1 -1
- package/dist/components/molecules/index.d.ts +46 -0
- package/dist/components/molecules/index.d.ts.map +1 -1
- package/dist/components/molecules/toast-store.d.ts +53 -7
- package/dist/components/molecules/toast-store.d.ts.map +1 -1
- package/dist/components/organisms/index.d.ts +5 -0
- package/dist/components/organisms/index.d.ts.map +1 -1
- package/dist/components/types/variants.d.ts +15 -1
- package/dist/components/types/variants.d.ts.map +1 -1
- package/dist/components/util/app-shell.d.ts +28 -0
- package/dist/components/util/app-shell.d.ts.map +1 -0
- package/dist/components/util/avatar.d.ts +36 -0
- package/dist/components/util/avatar.d.ts.map +1 -0
- package/dist/components/util/bottom-sheet.d.ts +30 -0
- package/dist/components/util/bottom-sheet.d.ts.map +1 -0
- package/dist/components/util/bottom-tab-bar.d.ts +35 -0
- package/dist/components/util/bottom-tab-bar.d.ts.map +1 -0
- package/dist/components/util/calendar.d.ts +56 -0
- package/dist/components/util/calendar.d.ts.map +1 -0
- package/dist/components/util/collapsible.d.ts +58 -0
- package/dist/components/util/collapsible.d.ts.map +1 -0
- package/dist/components/util/confirm-dialog.d.ts +12 -0
- package/dist/components/util/confirm-dialog.d.ts.map +1 -0
- package/dist/components/util/date.d.ts +96 -0
- package/dist/components/util/date.d.ts.map +1 -0
- package/dist/components/util/drawer.d.ts +13 -0
- package/dist/components/util/drawer.d.ts.map +1 -0
- package/dist/components/util/dropdown.d.ts +47 -0
- package/dist/components/util/dropdown.d.ts.map +1 -0
- package/dist/components/util/field.d.ts +39 -0
- package/dist/components/util/field.d.ts.map +1 -0
- package/dist/components/util/fit-in-viewport.d.ts +201 -0
- package/dist/components/util/fit-in-viewport.d.ts.map +1 -0
- package/dist/components/util/focus-utils.d.ts +75 -2
- package/dist/components/util/focus-utils.d.ts.map +1 -1
- package/dist/components/util/hydration.d.ts +45 -0
- package/dist/components/util/hydration.d.ts.map +1 -0
- package/dist/components/util/keyboard-inset.d.ts +18 -0
- package/dist/components/util/keyboard-inset.d.ts.map +1 -0
- package/dist/components/util/media-grid.d.ts +51 -0
- package/dist/components/util/media-grid.d.ts.map +1 -0
- package/dist/components/util/media.d.ts +6 -0
- package/dist/components/util/media.d.ts.map +1 -0
- package/dist/components/util/overlay-chrome.d.ts +53 -0
- package/dist/components/util/overlay-chrome.d.ts.map +1 -0
- package/dist/components/util/overlay.d.ts +72 -0
- package/dist/components/util/overlay.d.ts.map +1 -0
- package/dist/components/util/photo.d.ts +215 -0
- package/dist/components/util/photo.d.ts.map +1 -0
- package/dist/components/util/portal.d.ts +23 -0
- package/dist/components/util/portal.d.ts.map +1 -0
- package/dist/components/util/pull-to-refresh.d.ts +27 -0
- package/dist/components/util/pull-to-refresh.d.ts.map +1 -0
- package/dist/components/util/radio-keys.d.ts +25 -0
- package/dist/components/util/radio-keys.d.ts.map +1 -0
- package/dist/components/util/rating.d.ts +23 -0
- package/dist/components/util/rating.d.ts.map +1 -0
- package/dist/components/util/ready-made-strings.d.ts +77 -0
- package/dist/components/util/ready-made-strings.d.ts.map +1 -0
- package/dist/components/util/scroll-padding.d.ts +20 -0
- package/dist/components/util/scroll-padding.d.ts.map +1 -0
- package/dist/components/util/segmented-control.d.ts +16 -0
- package/dist/components/util/segmented-control.d.ts.map +1 -0
- package/dist/components/util/select.d.ts +41 -0
- package/dist/components/util/select.d.ts.map +1 -0
- package/dist/components/util/sheet-drag.d.ts +60 -0
- package/dist/components/util/sheet-drag.d.ts.map +1 -0
- package/dist/components/util/sidebar.d.ts +63 -0
- package/dist/components/util/sidebar.d.ts.map +1 -0
- package/dist/components/util/sortable-list.d.ts +65 -0
- package/dist/components/util/sortable-list.d.ts.map +1 -0
- package/dist/components/util/stepper.d.ts +40 -0
- package/dist/components/util/stepper.d.ts.map +1 -0
- package/dist/components/util/swipeable-list-item.d.ts +36 -0
- package/dist/components/util/swipeable-list-item.d.ts.map +1 -0
- package/dist/components/util/theme-mode.d.ts +80 -0
- package/dist/components/util/theme-mode.d.ts.map +1 -0
- package/dist/components/util/toaster.d.ts +93 -0
- package/dist/components/util/toaster.d.ts.map +1 -0
- package/dist/components/util/tooltip.d.ts +10 -0
- package/dist/components/util/tooltip.d.ts.map +1 -0
- package/dist/components/util/top-navbar.d.ts +11 -0
- package/dist/components/util/top-navbar.d.ts.map +1 -0
- package/dist/components/util/touch-target.d.ts +31 -0
- package/dist/components/util/touch-target.d.ts.map +1 -0
- package/dist/components/util/zabi-strings.d.ts +133 -0
- package/dist/components/util/zabi-strings.d.ts.map +1 -0
- package/dist/create-theme/cli.js +169 -0
- package/dist/create-theme/index.d.ts +176 -0
- package/dist/create-theme/index.js +817 -0
- package/dist/create-theme/lib/ramp-math.js +128 -0
- package/dist/create-theme/lib/resolve.js +141 -0
- package/dist/create-theme/theme-data.js +1116 -0
- package/dist/index.d.ts +80 -2
- package/dist/index.js +57 -2
- package/dist/molecules/Alert.svelte +33 -5
- package/dist/molecules/Alert.svelte.d.ts +2 -0
- package/dist/molecules/AppBar.svelte +415 -0
- package/dist/molecules/AppBar.svelte.d.ts +69 -0
- package/dist/molecules/AvatarGroup.svelte +116 -0
- package/dist/molecules/AvatarGroup.svelte.d.ts +40 -0
- package/dist/molecules/BottomSheet.svelte +540 -0
- package/dist/molecules/BottomSheet.svelte.d.ts +93 -0
- package/dist/molecules/BottomTabBar.svelte +297 -0
- package/dist/molecules/BottomTabBar.svelte.d.ts +64 -0
- package/dist/molecules/Calendar.svelte +597 -0
- package/dist/molecules/Calendar.svelte.d.ts +72 -0
- package/dist/molecules/Collapsible.svelte +243 -0
- package/dist/molecules/Collapsible.svelte.d.ts +44 -0
- package/dist/molecules/CollapsibleGroup.svelte +126 -0
- package/dist/molecules/CollapsibleGroup.svelte.d.ts +14 -0
- package/dist/molecules/ComponentDemo.svelte +16 -4
- package/dist/molecules/ComponentDemo.svelte.d.ts +3 -0
- package/dist/molecules/ConfirmDialog.svelte +253 -0
- package/dist/molecules/ConfirmDialog.svelte.d.ts +55 -0
- package/dist/molecules/ContactForm.svelte +34 -17
- package/dist/molecules/ContactForm.svelte.d.ts +8 -0
- package/dist/molecules/Drawer.svelte +394 -0
- package/dist/molecules/Drawer.svelte.d.ts +55 -0
- package/dist/molecules/Dropdown.svelte +509 -48
- package/dist/molecules/Dropdown.svelte.d.ts +45 -6
- package/dist/molecules/DropdownItem.svelte +122 -0
- package/dist/molecules/DropdownItem.svelte.d.ts +28 -0
- package/dist/molecules/EmptyState.svelte +55 -10
- package/dist/molecules/EmptyState.svelte.d.ts +8 -0
- package/dist/molecules/FormField.svelte +9 -1
- package/dist/molecules/FormField.svelte.d.ts +2 -0
- package/dist/molecules/Header.svelte +1 -1
- package/dist/molecules/ImageUpload.svelte +383 -70
- package/dist/molecules/ImageUpload.svelte.d.ts +47 -2
- package/dist/molecules/MediaGrid.svelte +527 -0
- package/dist/molecules/MediaGrid.svelte.d.ts +77 -0
- package/dist/molecules/Modal.svelte +288 -72
- package/dist/molecules/Modal.svelte.d.ts +51 -2
- package/dist/molecules/NavigationMenuContent.svelte +58 -1
- package/dist/molecules/NavigationMenuItem.svelte +0 -1
- package/dist/molecules/NavigationMenuLink.svelte +1 -1
- package/dist/molecules/NavigationMenuList.svelte +10 -3
- package/dist/molecules/NavigationMenuTrigger.svelte +2 -2
- package/dist/molecules/Page.svelte +32 -2
- package/dist/molecules/Page.svelte.d.ts +11 -0
- package/dist/molecules/PhotoGrid.svelte +433 -0
- package/dist/molecules/PhotoGrid.svelte.d.ts +62 -0
- package/dist/molecules/PhotoViewer.svelte +1116 -0
- package/dist/molecules/PhotoViewer.svelte.d.ts +56 -0
- package/dist/molecules/PropsTable.svelte +22 -10
- package/dist/molecules/PropsTable.svelte.d.ts +3 -0
- package/dist/molecules/PullToRefresh.svelte +263 -0
- package/dist/molecules/PullToRefresh.svelte.d.ts +52 -0
- package/dist/molecules/RadioGroup.svelte +52 -14
- package/dist/molecules/RadioGroup.svelte.d.ts +14 -3
- package/dist/molecules/Section.svelte +1 -1
- package/dist/molecules/SegmentedControl.svelte +323 -0
- package/dist/molecules/SegmentedControl.svelte.d.ts +34 -0
- package/dist/molecules/SidebarBrandHeader.svelte +11 -1
- package/dist/molecules/SidebarBrandHeader.svelte.d.ts +3 -0
- package/dist/molecules/SidebarFooter.svelte +29 -6
- package/dist/molecules/SidebarFooter.svelte.d.ts +3 -0
- package/dist/molecules/SlideUp.svelte +220 -61
- package/dist/molecules/SlideUp.svelte.d.ts +26 -0
- package/dist/molecules/SortableList.svelte +632 -0
- package/dist/molecules/SortableList.svelte.d.ts +69 -0
- package/dist/molecules/Stepper.svelte +548 -0
- package/dist/molecules/Stepper.svelte.d.ts +39 -0
- package/dist/molecules/StickyActionBar.svelte +191 -0
- package/dist/molecules/StickyActionBar.svelte.d.ts +65 -0
- package/dist/molecules/SwipeableListItem.svelte +334 -0
- package/dist/molecules/SwipeableListItem.svelte.d.ts +54 -0
- package/dist/molecules/Tabs.svelte +233 -9
- package/dist/molecules/Tabs.svelte.d.ts +7 -0
- package/dist/molecules/Toaster.svelte +350 -5
- package/dist/molecules/Toaster.svelte.d.ts +95 -2
- package/dist/molecules/ToasterToast.svelte +253 -67
- package/dist/molecules/ToasterToast.svelte.d.ts +9 -0
- package/dist/molecules/UnsavedChangesBar.svelte +212 -0
- package/dist/molecules/UnsavedChangesBar.svelte.d.ts +43 -0
- package/dist/molecules/index.d.ts +46 -0
- package/dist/molecules/index.js +27 -0
- package/dist/molecules/toast-store.d.ts +53 -7
- package/dist/molecules/toast-store.js +21 -0
- package/dist/organisms/AppShell.svelte +196 -0
- package/dist/organisms/AppShell.svelte.d.ts +61 -0
- package/dist/organisms/SidebarAccountPanel.svelte +107 -12
- package/dist/organisms/SidebarAccountPanel.svelte.d.ts +19 -0
- package/dist/organisms/SidebarNavigation.svelte +96 -15
- package/dist/organisms/SidebarNavigation.svelte.d.ts +29 -1
- package/dist/organisms/SidebarPanel.svelte +31 -10
- package/dist/organisms/SidebarShell.svelte +162 -11
- package/dist/organisms/SidebarShell.svelte.d.ts +56 -2
- package/dist/organisms/TopNavbar.svelte +256 -31
- package/dist/organisms/TopNavbar.svelte.d.ts +26 -0
- package/dist/organisms/index.d.ts +5 -0
- package/dist/organisms/index.js +3 -0
- package/dist/types/components.d.ts +4 -0
- package/dist/types/components.d.ts.map +1 -1
- package/dist/types/index.d.ts +605 -25
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/variants.ts +17 -1
- package/dist/util/app-shell.d.ts +27 -0
- package/dist/util/app-shell.js +72 -0
- package/dist/util/avatar.d.ts +35 -0
- package/dist/util/avatar.js +52 -0
- package/dist/util/bottom-sheet.d.ts +29 -0
- package/dist/util/bottom-sheet.js +43 -0
- package/dist/util/bottom-tab-bar.d.ts +34 -0
- package/dist/util/bottom-tab-bar.js +54 -0
- package/dist/util/calendar.d.ts +55 -0
- package/dist/util/calendar.js +74 -0
- package/dist/util/collapsible.d.ts +57 -0
- package/dist/util/collapsible.js +23 -0
- package/dist/util/confirm-dialog.d.ts +11 -0
- package/dist/util/confirm-dialog.js +2 -0
- package/dist/util/date.d.ts +95 -0
- package/dist/util/date.js +237 -0
- package/dist/util/drawer.d.ts +12 -0
- package/dist/util/drawer.js +7 -0
- package/dist/util/dropdown.d.ts +46 -0
- package/dist/util/dropdown.js +21 -0
- package/dist/util/field.d.ts +38 -0
- package/dist/util/field.js +38 -0
- package/dist/util/fit-in-viewport.d.ts +200 -0
- package/dist/util/fit-in-viewport.js +399 -0
- package/dist/util/focus-utils.d.ts +75 -2
- package/dist/util/focus-utils.js +182 -9
- package/dist/util/hydration.d.ts +44 -0
- package/dist/util/hydration.js +58 -0
- package/dist/util/keyboard-inset.d.ts +17 -0
- package/dist/util/keyboard-inset.js +53 -0
- package/dist/util/media-grid.d.ts +50 -0
- package/dist/util/media-grid.js +81 -0
- package/dist/util/media.d.ts +5 -0
- package/dist/util/media.js +10 -0
- package/dist/util/overlay-chrome.d.ts +52 -0
- package/dist/util/overlay-chrome.js +56 -0
- package/dist/util/overlay.d.ts +71 -0
- package/dist/util/overlay.js +240 -0
- package/dist/util/photo.d.ts +214 -0
- package/dist/util/photo.js +206 -0
- package/dist/util/portal.d.ts +22 -0
- package/dist/util/portal.js +50 -0
- package/dist/util/pull-to-refresh.d.ts +26 -0
- package/dist/util/pull-to-refresh.js +30 -0
- package/dist/util/radio-keys.d.ts +24 -0
- package/dist/util/radio-keys.js +49 -0
- package/dist/util/rating.d.ts +22 -0
- package/dist/util/rating.js +26 -0
- package/dist/util/ready-made-strings.d.ts +76 -0
- package/dist/util/ready-made-strings.js +67 -0
- package/dist/util/scroll-padding.d.ts +19 -0
- package/dist/util/scroll-padding.js +44 -0
- package/dist/util/segmented-control.d.ts +15 -0
- package/dist/util/segmented-control.js +1 -0
- package/dist/util/select.d.ts +40 -0
- package/dist/util/select.js +63 -0
- package/dist/util/sheet-drag.d.ts +59 -0
- package/dist/util/sheet-drag.js +241 -0
- package/dist/util/sidebar.d.ts +62 -0
- package/dist/util/sidebar.js +38 -0
- package/dist/util/sortable-list.d.ts +64 -0
- package/dist/util/sortable-list.js +53 -0
- package/dist/util/stepper.d.ts +39 -0
- package/dist/util/stepper.js +38 -0
- package/dist/util/swipeable-list-item.d.ts +35 -0
- package/dist/util/swipeable-list-item.js +32 -0
- package/dist/util/theme-mode.d.ts +79 -0
- package/dist/util/theme-mode.js +121 -0
- package/dist/util/toaster.d.ts +92 -0
- package/dist/util/toaster.js +75 -0
- package/dist/util/tooltip.d.ts +9 -0
- package/dist/util/tooltip.js +18 -0
- package/dist/util/top-navbar.d.ts +10 -0
- package/dist/util/top-navbar.js +5 -0
- package/dist/util/touch-target.d.ts +30 -0
- package/dist/util/touch-target.js +30 -0
- package/dist/util/zabi-strings.d.ts +132 -0
- package/dist/util/zabi-strings.js +105 -0
- package/dist/zabi-components-colors.css +5 -2
- package/dist/zabi-components-theme-dark-only.css +543 -241
- package/dist/zabi-components-theme-dark.css +543 -241
- package/dist/zabi-components-theme-only.css +1584 -367
- package/dist/zabi-components-theme.css +1584 -367
- package/dist/zabi-components.css +3885 -518
- package/docs/lucide-icons.md +40 -17
- package/docs/theme-imports.md +81 -11
- package/package.json +35 -8
package/THEMING.md
CHANGED
|
@@ -1,186 +1,966 @@
|
|
|
1
|
-
# Theming
|
|
1
|
+
# Theming guide
|
|
2
|
+
|
|
3
|
+
An app gives the whole library its own brand from one generated file of token
|
|
4
|
+
overrides. There is no component CSS to write and nothing to repeat for dark
|
|
5
|
+
mode.
|
|
6
|
+
|
|
7
|
+
This guide is the token API. The tokens under
|
|
8
|
+
[Tokens an app may set](#tokens-an-app-may-set) and
|
|
9
|
+
[Roles: read them, do not set them](#roles-read-them-do-not-set-them) are
|
|
10
|
+
public: renaming or removing one is a breaking change (see
|
|
11
|
+
[Stability](#stability)).
|
|
12
|
+
|
|
13
|
+
The same guide, with a brand switcher to try it on real components, is on the
|
|
14
|
+
docs site at [/theming](https://zabi-components.vercel.app/theming).
|
|
15
|
+
|
|
16
|
+
- [The first thing to know: your colour is not pinned to a step](#the-first-thing-to-know-your-colour-is-not-pinned-to-a-step)
|
|
17
|
+
- [Quick start](#quick-start)
|
|
18
|
+
- [Import order](#import-order)
|
|
19
|
+
- [Tokens an app may set](#tokens-an-app-may-set)
|
|
20
|
+
- [Roles: read them, do not set them](#roles-read-them-do-not-set-them)
|
|
21
|
+
- [Light, dark and auto](#light-dark-and-auto)
|
|
22
|
+
- [Text and controls on a brand or accent block](#text-and-controls-on-a-brand-or-accent-block)
|
|
23
|
+
- [Component-level properties](#component-level-properties)
|
|
24
|
+
- [The generator](#the-generator)
|
|
25
|
+
- [What does not follow an override](#what-does-not-follow-an-override)
|
|
26
|
+
- [Stability](#stability)
|
|
27
|
+
- [Reference: how the theme is built](#reference-how-the-theme-is-built)
|
|
28
|
+
- [For maintainers](#for-maintainers)
|
|
29
|
+
|
|
30
|
+
## The first thing to know: your colour is not pinned to a step
|
|
31
|
+
|
|
32
|
+
**Need the exact brand colour on buttons? Use `--pin`.**
|
|
33
|
+
`npx zabi-theme --brand "#0026EA" --pin` makes the primary button `#0026ea`
|
|
34
|
+
itself in light, with a checked label colour. The rest of this section is what
|
|
35
|
+
happens without it, and [`--pin`](#--pin-the-exact-brand-colour-on-buttons)
|
|
36
|
+
has the trade-off.
|
|
37
|
+
|
|
38
|
+
`zabi-theme` takes one brand colour and builds an 11-step ramp from it. The
|
|
39
|
+
colour supplies the **hue and chroma**. The lightness of each step comes from
|
|
40
|
+
the library's own curve (see [Calibrated colour ramps](#calibrated-colour-ramps)),
|
|
41
|
+
so step 600 is as dark as every built-in 600 and every role keeps the contrast
|
|
42
|
+
it was designed with.
|
|
43
|
+
|
|
44
|
+
So the exact hex you give may not be in the ramp, and it is usually not the
|
|
45
|
+
colour of the primary button:
|
|
46
|
+
|
|
47
|
+
| You give | Nearest step | Primary button, light (step 600) | Primary button, dark (step 400) |
|
|
48
|
+
|---|---|---|---|
|
|
49
|
+
| `#0026EA` | 800, `#0024e1` (ΔE 3.5) | `#2b65ff` | `#84acff` |
|
|
50
|
+
| `#C17B00` | 500, exact | `#9b6200` | `#d99f58` |
|
|
51
|
+
|
|
52
|
+
`#0026EA` is darker than a 600, so it lands near step 800 and the button is the
|
|
53
|
+
lighter `#2b65ff`. The header of the generated file, the command's summary line
|
|
54
|
+
and `closest` from `createTheme()` all name the nearest step.
|
|
55
|
+
|
|
56
|
+
A very bright colour has no step that bright at its chroma. `#FFE600` lands
|
|
57
|
+
nearest step 300 at ΔE 14.8, and the generator says so:
|
|
2
58
|
|
|
3
|
-
|
|
59
|
+
```
|
|
60
|
+
zabi-theme: warning: brand #ffe600 is not in the ramp built from it: the nearest step is 300 (#dcc600, ΔE 14.8). The ramp keeps its hue on the library's lightness curve; fills use step 600 in light and 400 in dark.
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
If the brand colour itself has to be the button, use
|
|
64
|
+
[`--pin`](#--pin-the-exact-brand-colour-on-buttons). If it only has to appear
|
|
65
|
+
somewhere (a logo plate, a brand screen), use the step the generator names
|
|
66
|
+
(`var(--zabi-brand-500)` for the amber above), not the hex.
|
|
67
|
+
|
|
68
|
+
## Quick start
|
|
69
|
+
|
|
70
|
+
1. Generate the brand file. Commit it; the output has no timestamp, and the
|
|
71
|
+
same input gives the same bytes.
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npx zabi-theme --brand "#C17B00" --neutral "#78716c" --out src/lib/brand.generated.css
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
2. Import it after the theme files.
|
|
78
|
+
|
|
79
|
+
```css
|
|
80
|
+
/* src/lib/theme.css — the app's brand */
|
|
81
|
+
@import "zabi-components/theme-only";
|
|
82
|
+
@import "zabi-components/theme-dark-only";
|
|
83
|
+
@import "./brand.generated.css"; /* --zabi-brand-*, --zabi-accent-*, --zabi-base-* */
|
|
4
84
|
|
|
5
|
-
|
|
85
|
+
:root {
|
|
86
|
+
--font-family-heading: "Your Display Font", var(--font-family-sans);
|
|
87
|
+
}
|
|
88
|
+
```
|
|
6
89
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
- Typography settings
|
|
13
|
-
- Spacing, border radius, and z-index values
|
|
90
|
+
```css
|
|
91
|
+
/* src/app.css */
|
|
92
|
+
@import "tailwindcss";
|
|
93
|
+
@import "./lib/theme.css";
|
|
94
|
+
```
|
|
14
95
|
|
|
15
|
-
|
|
96
|
+
3. Choose how dark mode is selected, on `<html>`.
|
|
16
97
|
|
|
17
|
-
|
|
18
|
-
|
|
98
|
+
```html
|
|
99
|
+
<html lang="en" data-theme="auto">
|
|
100
|
+
```
|
|
19
101
|
|
|
20
|
-
|
|
21
|
-
|
|
102
|
+
That is the whole rebrand: primary actions, focus rings, links, tints, text,
|
|
103
|
+
borders, the page, cards and the dark surface levels follow, in light and dark.
|
|
22
104
|
|
|
23
|
-
##
|
|
105
|
+
## Import order
|
|
24
106
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
107
|
+
| Order | Import | Why here |
|
|
108
|
+
|---|---|---|
|
|
109
|
+
| 1 | `tailwindcss` | The theme files are Tailwind v4 `@theme` blocks. |
|
|
110
|
+
| 2 | `zabi-components/theme-only` | Declares every token, light values, and the raw ramps. |
|
|
111
|
+
| 3 | `zabi-components/theme-dark-only` | Only remaps roles for dark. It declares no ramp, so it does nothing without the light theme. |
|
|
112
|
+
| 4 | your generated file | `:root` overrides. After both theme files, so they win in dark as well. |
|
|
113
|
+
| 5 | your own `:root { … }` | Fonts, radius and anything else from the tables below. |
|
|
114
|
+
|
|
115
|
+
Keep the brand file last. `:root`, `.dark` and `[data-theme="dark"]` have the
|
|
116
|
+
same specificity, so between them the later rule wins: a brand file imported
|
|
117
|
+
before the dark theme loses, in dark, every token the dark file restates (a
|
|
118
|
+
role moved with `--set`, `--shadow-color`). The ramps happen to apply from
|
|
119
|
+
either position in a Tailwind build, because Tailwind puts the theme's own
|
|
120
|
+
values in a cascade layer and your `:root` rule is outside it. With
|
|
121
|
+
`zabi-components/colors`, which is plain CSS, an override placed before the
|
|
122
|
+
import does nothing at all.
|
|
33
123
|
|
|
34
|
-
|
|
124
|
+
If the app has no Tailwind, `zabi-components/css` replaces steps 1 to 3 (see
|
|
125
|
+
[docs/theme-imports.md](./docs/theme-imports.md)); the brand file still goes
|
|
126
|
+
after it.
|
|
35
127
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
128
|
+
Set the overrides on `:root`, not on an element further down. The roles are
|
|
129
|
+
resolved on the root element, so `--zabi-brand-600` set on a `<section>`
|
|
130
|
+
changes nothing inside it.
|
|
39
131
|
|
|
40
|
-
|
|
41
|
-
- ✅ `src/app.css` - **THIS IS THE ONLY FILE YOU NEED TO EDIT**
|
|
42
|
-
- ✅ Removed deprecated files (`src/styles/colors.css`, `src/styles/base.css`, `src/styles/simple.css`, `src/app-simple.css`)
|
|
132
|
+
## Tokens an app may set
|
|
43
133
|
|
|
44
|
-
|
|
134
|
+
Set these on `:root`, after the imports. One declaration covers light and dark
|
|
135
|
+
unless the table says otherwise. All of them were checked in a browser against
|
|
136
|
+
the built theme files.
|
|
45
137
|
|
|
46
|
-
|
|
138
|
+
### Colour
|
|
47
139
|
|
|
48
|
-
|
|
140
|
+
`zabi-theme` writes every token in this table. Write them by hand only if you
|
|
141
|
+
have your own ramps.
|
|
49
142
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
143
|
+
| Token | Steps | What follows |
|
|
144
|
+
|---|---|---|
|
|
145
|
+
| `--zabi-brand-50` … `--zabi-brand-950` | 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 950 | Primary actions, focus rings, links, brand tints, `--color-primary*` |
|
|
146
|
+
| `--zabi-accent-50` … `--zabi-accent-950` | the same 11 | `--color-accent` and its roles: `bg-accent`, `text-accent`, `border-accent`. Defaults to the citron ramp. |
|
|
147
|
+
| `--zabi-base-50` … `--zabi-base-950` | 50, 75, 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800, 850, 900, 925, 950 | Text, borders, inputs, the page, cards and the four dark surface levels |
|
|
148
|
+
| `--zabi-on-brand` | | Label on a primary fill in light. Default `#ffffff`. |
|
|
149
|
+
| `--zabi-on-brand-dark` | | The same in dark. Default `var(--zabi-brand-950)`. |
|
|
150
|
+
| `--zabi-on-accent` | | Label on a solid accent fill in light. Default `#ffffff`. |
|
|
151
|
+
| `--zabi-on-accent-dark` | | The same in dark. Default `var(--zabi-accent-950)`. |
|
|
55
152
|
|
|
56
|
-
|
|
153
|
+
Each ramp runs light (50) to dark (950). Light mode puts fills on step 600;
|
|
154
|
+
dark mode mirrors the ramp, so the fill is step 400.
|
|
57
155
|
|
|
58
|
-
|
|
156
|
+
A ramp you write by hand should keep the library's lightness per step, or the
|
|
157
|
+
contrast the roles were designed with is gone. Run it through
|
|
158
|
+
`zabi-theme --set` to have it checked (see [`--set`](#--set-and-overrides)).
|
|
59
159
|
|
|
60
|
-
|
|
61
|
-
|------|--------|
|
|
62
|
-
| Tailwind + full `@theme` (app has no Tailwind yet) | `zabi-components/theme` |
|
|
63
|
-
| Tailwind already in app — merge `@theme` only | `zabi-components/theme-only` |
|
|
64
|
-
| Dark overrides (+ Tailwind import in file) | `zabi-components/theme-dark` |
|
|
65
|
-
| Dark overrides only (Tailwind already loaded) | `zabi-components/theme-dark-only` |
|
|
66
|
-
| CSS variables only, no Tailwind | `zabi-components/colors` |
|
|
67
|
-
| Full compiled CSS (utilities + everything) | `zabi-components/css` |
|
|
160
|
+
### Type
|
|
68
161
|
|
|
69
|
-
|
|
162
|
+
| Token | Default | What follows |
|
|
163
|
+
|---|---|---|
|
|
164
|
+
| `--font-family-sans` | `'Nunito Sans', ui-sans-serif, system-ui, sans-serif` | Body text and every component |
|
|
165
|
+
| `--font-family-heading` | `var(--font-family-sans)` | `h1` to `h6` and the Heading component |
|
|
166
|
+
| `--font-family-mono` | `"Monaco", "Menlo", "Ubuntu Mono", monospace` | CodeBlock |
|
|
167
|
+
| `--font-weight-regular` | `400` | `font-normal` |
|
|
168
|
+
| `--font-weight-medium` | `500` | `font-medium` |
|
|
169
|
+
| `--font-weight-semibold` | `600` | `font-semibold` |
|
|
170
|
+
| `--font-weight-bold` | `700` | `font-bold` |
|
|
171
|
+
|
|
172
|
+
Loading the font files is up to the app. The heading face is applied in the
|
|
173
|
+
base layer, so a `font-*` utility on a heading still wins.
|
|
174
|
+
|
|
175
|
+
Tailwind's own font utilities follow these tokens: `font-sans` is
|
|
176
|
+
`--font-family-sans`, `font-mono` is `--font-family-mono`, and `font-heading`
|
|
177
|
+
is `--font-family-heading`. The theme maps Tailwind's `--font-sans` and
|
|
178
|
+
`--font-mono` (and a `--font-heading` of its own) onto them. Before 8.1
|
|
179
|
+
`font-sans` was Tailwind's system stack, so `class="font-sans"` on a heading
|
|
180
|
+
dropped it out of the brand face. Set the `--font-family-*` tokens, not the
|
|
181
|
+
short names: the short ones follow.
|
|
182
|
+
|
|
183
|
+
### Shape, depth and stacking
|
|
184
|
+
|
|
185
|
+
| Token | Default | What follows |
|
|
186
|
+
|---|---|---|
|
|
187
|
+
| `--radius-control` | `0.5rem` | Buttons, inputs, selects, toggles |
|
|
188
|
+
| `--radius-container` | `0.75rem` | Cards, alerts, panels, list items, code blocks |
|
|
189
|
+
| `--radius-overlay` | `1rem` | Modals, sheets, menus, popovers, toasts |
|
|
190
|
+
| `--radius-pill` | `9999px` | Badges, avatars, status dots |
|
|
191
|
+
| `--shadow-color` | `24 24 27` (dark: `0 0 0`) | The colour of `shadow-sm` and `shadow-lg`, as three space-separated RGB channels |
|
|
192
|
+
| `--shadow-opacity` | `0.14` (dark: `0.3`) | Their strength |
|
|
193
|
+
| `--z-dropdown`, `--z-sticky`, `--z-fixed`, `--z-modal-backdrop`, `--z-modal`, `--z-popover`, `--z-tooltip`, `--z-toast` | 1000 to 1080 | The layer of each floating component, when the app has its own stacking order to fit into |
|
|
194
|
+
|
|
195
|
+
The two shadow tokens are the only ones here with a separate dark value. A
|
|
196
|
+
`:root` override after the imports replaces both; to keep two values, declare
|
|
197
|
+
the dark one under the dark selectors (see
|
|
198
|
+
[One role in dark only](#one-role-in-dark-only)).
|
|
199
|
+
|
|
200
|
+
### Not on the list
|
|
201
|
+
|
|
202
|
+
These tokens exist, and their names are kept, but setting them does not restyle
|
|
203
|
+
the components:
|
|
204
|
+
|
|
205
|
+
- `--spacing-xs` … `--spacing-2xl` feed the `p-md`, `gap-lg` utilities for your
|
|
206
|
+
own markup. Components use Tailwind's numeric scale.
|
|
207
|
+
- `--control-height-sm`, `-md`, `-lg` record the 32, 40 and 48px control
|
|
208
|
+
heights. Components set those heights with `h-8`, `h-10` and `h-12`.
|
|
209
|
+
- `--radius-sm`, `-md`, `-lg`, `-xl` are legacy aliases. No component uses them.
|
|
210
|
+
- `--shadow-sm`, `--shadow-md`, `--shadow-lg`, `--shadow-xl` are built from the
|
|
211
|
+
two shadow tokens above. Set those instead.
|
|
212
|
+
|
|
213
|
+
## Roles: read them, do not set them
|
|
214
|
+
|
|
215
|
+
A role says what a colour is for. Components paint with roles, and your own CSS
|
|
216
|
+
should too: `var(--color-action-primary)` or the `bg-action-primary` class, not
|
|
217
|
+
`var(--zabi-brand-600)`. A role is already the right step in each mode.
|
|
218
|
+
|
|
219
|
+
| Roles | For |
|
|
220
|
+
|---|---|
|
|
221
|
+
| `--color-action-primary`, `-hover`, `-active`, `-text`, `-subtle`, `-subtle-hover` | Primary buttons and controls. The same set exists for `secondary` and `danger`; `--color-action-disabled`, `-disabled-text`, `-disabled-border` for disabled ones. |
|
|
222
|
+
| `--color-on-brand`, `--color-on-accent` | Text on a primary fill and on a solid accent fill |
|
|
223
|
+
| `--color-accent`, `-hover`, `-active`, `-subtle`, `-border`, `-text` | The second brand colour |
|
|
224
|
+
| `--color-focus-ring`, `--color-focus-ring-offset`, `--color-focus` | The focus ring and the gap around it |
|
|
225
|
+
| `--color-focus-ring-muted` | The neutral ring of ghost and link controls (`.focus-ring--muted`); 3:1 or more on every surface level |
|
|
226
|
+
| `--color-focus-ring-danger` | The ring of a destructive control (`.focus-ring--danger`). It is `--color-error`; a role of its own so that a brand or accent block can re-point it |
|
|
227
|
+
| `--color-control-border` | The edge of a control that has nothing else to be seen by, such as an empty Rating star; 3:1 or more on every surface level |
|
|
228
|
+
| `--color-link`, `--color-link-hover` | Links |
|
|
229
|
+
| `--color-headline`, `--color-body`, `--color-description`, `--color-caption`, `--color-label` | Text |
|
|
230
|
+
| `--color-surface-base`, `-raised`, `-elevated`, `-overlay`, `-inset` | The page, cards, nested cards, floating panels, wells |
|
|
231
|
+
| `--color-surface-hover`, `--color-surface-active`, `--color-surface-overlay-hover` | Hover and pressed fills |
|
|
232
|
+
| `--color-border`, `-weak`, `-medium`, `-strong`, `--color-border-overlay` | Borders and dividers |
|
|
233
|
+
| `--color-input`, `-border`, `-border-hover`, `-hover`, `-active`, `-focus`, `-disabled`, `-placeholder` | Form fields; `-active` is the pressed Select trigger; `--color-input-border` is the field edge, 3:1 or more on the field fill, the page and the card in both themes |
|
|
234
|
+
| `--color-<family>`, `-weak`, `-medium`, `-strong`, `-subtle`, `-border`, `-text` | `success`, `warning`, `error`, `info`, `energetic`, `neutral` (see [Semantic families](#semantic-families)) |
|
|
235
|
+
|
|
236
|
+
Aliases kept from earlier versions resolve to the same values: `--color-background`,
|
|
237
|
+
`--color-card`, `--color-surface-1` … `-4`, `--color-primary*`,
|
|
238
|
+
`--color-secondary*`, `--color-page`.
|
|
239
|
+
|
|
240
|
+
**Why not set them.** A role set on `:root` after the imports is one value for
|
|
241
|
+
both modes: it replaces the dark value as well, and nothing checks its
|
|
242
|
+
contrast. If one role has to move, do it through the generator, which checks
|
|
243
|
+
it: see [`--set`](#--set-and-overrides).
|
|
244
|
+
|
|
245
|
+
**Do not set `--color-brand-*`, `--color-accent-<step>` or `--color-base-*`
|
|
246
|
+
either.** Those are the mirrored steps: `--color-brand-600` is
|
|
247
|
+
`--zabi-brand-600` in light and `--zabi-brand-400` in dark. Set on `:root`
|
|
248
|
+
after the imports, one of them becomes the same colour in both modes and stops
|
|
249
|
+
mirroring. Override the `--zabi-*` ramp instead.
|
|
250
|
+
|
|
251
|
+
### One role in dark only
|
|
252
|
+
|
|
253
|
+
Declare it under all three dark selectors, after the imports:
|
|
70
254
|
|
|
71
255
|
```css
|
|
72
|
-
|
|
73
|
-
|
|
256
|
+
.dark,
|
|
257
|
+
[data-theme="dark"] {
|
|
258
|
+
--color-link: var(--zabi-brand-200);
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
@media (prefers-color-scheme: dark) {
|
|
262
|
+
[data-theme="auto"] {
|
|
263
|
+
--color-link: var(--zabi-brand-200);
|
|
264
|
+
}
|
|
265
|
+
}
|
|
74
266
|
```
|
|
75
267
|
|
|
76
|
-
|
|
77
|
-
|
|
268
|
+
## Light, dark and auto
|
|
269
|
+
|
|
270
|
+
The mode is chosen on the `<html>` element, by an attribute or a class:
|
|
271
|
+
|
|
272
|
+
| On `<html>` | Result |
|
|
273
|
+
|---|---|
|
|
274
|
+
| nothing | light, also on a dark system |
|
|
275
|
+
| `data-theme="light"` | light |
|
|
276
|
+
| `data-theme="dark"` | dark |
|
|
277
|
+
| `data-theme="auto"` | follows the system (`prefers-color-scheme`) |
|
|
278
|
+
| `class="dark"` | dark, the same as `data-theme="dark"` |
|
|
279
|
+
|
|
280
|
+
- **Following the system is opt-in.** A page with no attribute and no class
|
|
281
|
+
stays light on a dark system, as it always has. `data-theme="auto"` needs no
|
|
282
|
+
script.
|
|
283
|
+
- **`<html>` only.** A `.dark` or `data-theme` on an element further down is
|
|
284
|
+
not supported. It re-themes the roles the dark file restates (the card
|
|
285
|
+
surface, the label on a primary button) and leaves the rest (text, borders,
|
|
286
|
+
the primary fill) light, so the subtree comes out half dark.
|
|
287
|
+
- `color-scheme` comes with the theme, so what the browser draws itself (date
|
|
288
|
+
and time pickers, scrollbars, autofill) matches: dark under `.dark`,
|
|
289
|
+
`data-theme="dark"` and `data-theme="auto"` on a dark system, and light
|
|
290
|
+
everywhere else, a page with no class and no attribute included. That
|
|
291
|
+
overrides a `<meta name="color-scheme">` tag, so the page needs neither the
|
|
292
|
+
tag nor an inline `color-scheme` on `<html>`; `ThemeToggle` writes none and
|
|
293
|
+
removes a stale `light` or `dark` one. Before 8.1 only the attributes set
|
|
294
|
+
it.
|
|
295
|
+
- The dark file must be imported together with a light one. It only remaps
|
|
296
|
+
roles onto ramps the light theme declares.
|
|
297
|
+
- Tailwind's own `dark:` variant follows the system unless you redefine it, and
|
|
298
|
+
does not read `data-theme`.
|
|
299
|
+
|
|
300
|
+
### A theme control: system, light, dark
|
|
301
|
+
|
|
302
|
+
`ThemeToggle` reads the mode from `<html>` and follows whatever else changes
|
|
303
|
+
it.
|
|
304
|
+
|
|
305
|
+
| | Press | Writes |
|
|
306
|
+
|---|---|---|
|
|
307
|
+
| `<ThemeToggle />` (`modes="two"`) | light ↔ dark | `data-theme` when `<html>` has the attribute, the `dark` class otherwise. It is a switch named "Dark mode" (`labels.darkMode`), with `aria-pressed` for its state |
|
|
308
|
+
| `<ThemeToggle modes="three" />` | system → light → dark → system | always `data-theme` (`auto`, `light` or `dark`); it adds the attribute and removes a leftover `dark` class |
|
|
309
|
+
|
|
310
|
+
With two modes, a press on a page that is on `auto` sets `light` or `dark`, and
|
|
311
|
+
there is no way back to `auto` from that button. An app whose default is
|
|
312
|
+
`data-theme="auto"` wants three modes.
|
|
313
|
+
|
|
314
|
+
The three-mode button shows a monitor, a sun or a moon, and its accessible name
|
|
315
|
+
states the mode and what a press does: "Theme: system. Switch to light". The
|
|
316
|
+
words are replaceable:
|
|
317
|
+
|
|
318
|
+
```svelte
|
|
319
|
+
<ThemeToggle
|
|
320
|
+
modes="three"
|
|
321
|
+
labels={{
|
|
322
|
+
auto: "följ telefonen",
|
|
323
|
+
light: "ljust",
|
|
324
|
+
dark: "mörkt",
|
|
325
|
+
describe: (current, next) => `Tema: ${current}. Byt till ${next}`,
|
|
326
|
+
}}
|
|
327
|
+
/>
|
|
78
328
|
```
|
|
79
329
|
|
|
80
|
-
|
|
81
|
-
|
|
330
|
+
**Remembering the choice.** The choice is kept in `localStorage` under
|
|
331
|
+
`storageKey` (default `"theme"`) and applied again when the button mounts, with
|
|
332
|
+
two modes and with three, on a `data-theme` page and on a class page: the
|
|
333
|
+
two-way button on a `data-theme="auto"` page that finds `"dark"` stored sets
|
|
334
|
+
`data-theme="dark"`.
|
|
335
|
+
`storageKey={null}` keeps nothing. To store it in your own backend, bind the
|
|
336
|
+
mode or listen for it:
|
|
337
|
+
|
|
338
|
+
```svelte
|
|
339
|
+
<ThemeToggle modes="three" storageKey={null} bind:mode onmodechange={(mode) => saveToProfile(mode)} />
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
`mode` is `"auto" | "light" | "dark"`. It follows the page, and assigning it
|
|
343
|
+
switches the page.
|
|
344
|
+
|
|
345
|
+
**No flash on load.** A component mounts after the first paint, so a visitor
|
|
346
|
+
who chose dark would see light first. `themeInitScript(storageKey?)` returns a
|
|
347
|
+
small script that applies the stored mode from `<head>`. It is a plain string
|
|
348
|
+
with no dependencies. In SvelteKit, print it once and paste it into
|
|
349
|
+
`src/app.html`, or inject it from `hooks.server.ts`:
|
|
350
|
+
|
|
351
|
+
```html
|
|
352
|
+
<!-- src/app.html -->
|
|
353
|
+
<html lang="sv" data-theme="auto">
|
|
354
|
+
<head>
|
|
355
|
+
<script>
|
|
356
|
+
(function(){try{var m=localStorage.getItem("theme");if(m!=="auto"&&m!=="light"&&m!=="dark")return;var r=document.documentElement;if(r.hasAttribute("data-theme")||m==="auto"){r.setAttribute("data-theme",m);r.classList.remove("dark")}else{r.classList.toggle("dark",m==="dark")}}catch(e){}})();
|
|
357
|
+
</script>
|
|
358
|
+
%sveltekit.head%
|
|
82
359
|
```
|
|
83
360
|
|
|
84
|
-
|
|
361
|
+
```ts
|
|
362
|
+
// src/hooks.server.ts: the same, generated, so it follows the package.
|
|
363
|
+
// Put %theme-init% in the <head> of src/app.html where the script should go.
|
|
364
|
+
import { themeInitScript } from "zabi-components";
|
|
85
365
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
366
|
+
export const handle = ({ event, resolve }) =>
|
|
367
|
+
resolve(event, {
|
|
368
|
+
transformPageChunk: ({ html }) => html.replace("%theme-init%", `<script>${themeInitScript()}</script>`),
|
|
369
|
+
});
|
|
90
370
|
```
|
|
91
371
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
- Semantic dark mapping is generated with `S -> 1000 - S` (for example `50 <-> 950`, `75 <-> 925`, `500` unchanged).
|
|
372
|
+
With nothing stored the script does nothing, and the `data-theme` in your
|
|
373
|
+
markup stands.
|
|
95
374
|
|
|
96
|
-
|
|
375
|
+
**Your own control.** A settings screen usually wants three labelled options,
|
|
376
|
+
not a cycling button. Drive the theme with the same helpers and any
|
|
377
|
+
`ThemeToggle` on the page follows:
|
|
97
378
|
|
|
98
|
-
|
|
379
|
+
```svelte
|
|
380
|
+
<script lang="ts">
|
|
381
|
+
import { onMount } from "svelte";
|
|
382
|
+
import { SegmentedControl, getThemeMode, setThemeMode, type ThemeMode } from "zabi-components";
|
|
383
|
+
|
|
384
|
+
let mode = $state<ThemeMode>("auto");
|
|
385
|
+
onMount(() => (mode = getThemeMode()));
|
|
386
|
+
</script>
|
|
387
|
+
|
|
388
|
+
<SegmentedControl
|
|
389
|
+
label="Tema"
|
|
390
|
+
options={[
|
|
391
|
+
{ value: "auto", label: "Följ telefonen" },
|
|
392
|
+
{ value: "light", label: "Ljust" },
|
|
393
|
+
{ value: "dark", label: "Mörkt" },
|
|
394
|
+
]}
|
|
395
|
+
value={mode}
|
|
396
|
+
onchange={(value) => {
|
|
397
|
+
mode = value as ThemeMode;
|
|
398
|
+
setThemeMode(mode); // or setThemeMode(mode, { storageKey: null }) and save it yourself
|
|
399
|
+
}}
|
|
400
|
+
/>
|
|
401
|
+
```
|
|
99
402
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
403
|
+
| Helper | |
|
|
404
|
+
|---|---|
|
|
405
|
+
| `getThemeMode()` | `"auto"`, `"light"` or `"dark"`, from `data-theme`; without the attribute, `"dark"` with the `dark` class and `"light"` without. |
|
|
406
|
+
| `setThemeMode(mode, { storageKey? })` | Writes `data-theme`, removes a leftover `dark` class and inline `color-scheme`, stores the choice (`storageKey: null` stores nothing). |
|
|
407
|
+
| `isThemeDark()` | Whether the page is dark right now; on `auto` that is the system's answer. |
|
|
408
|
+
| `getStoredThemeMode(storageKey?)`, `storeThemeMode(mode, storageKey?)` | The stored choice. |
|
|
409
|
+
| `themeInitScript(storageKey?)` | The `<head>` script above, as a string. |
|
|
410
|
+
|
|
411
|
+
All of them are safe to call on the server, where they read `"light"` and
|
|
412
|
+
write nothing.
|
|
413
|
+
|
|
414
|
+
```js
|
|
415
|
+
document.documentElement.dataset.theme = "dark"; // "light" | "auto"
|
|
416
|
+
// or
|
|
417
|
+
document.documentElement.classList.toggle("dark");
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
## Text and controls on a brand or accent block
|
|
421
|
+
|
|
422
|
+
A block filled with the brand colour (`bg-action-primary`) or the accent
|
|
423
|
+
(`bg-accent`) is not a surface level: the text roles (`--color-headline`,
|
|
424
|
+
`--color-body`) are chosen for the page and for cards, and on a brand fill
|
|
425
|
+
they are about 2:1 to 3.7:1. Three things make a block work.
|
|
426
|
+
|
|
427
|
+
**1. Say what the block is.** Add `on-brand` beside `bg-action-primary`, or
|
|
428
|
+
`on-accent` beside `bg-accent`:
|
|
429
|
+
|
|
430
|
+
```svelte
|
|
431
|
+
<section class="bg-action-primary on-brand rounded-container p-6">
|
|
432
|
+
<Heading level={2} tone="inherit">Dagens quiz</Heading>
|
|
433
|
+
<Text tone="inherit">Tio frågor om Sverige.</Text>
|
|
434
|
+
<Button variant="accent">Spela</Button>
|
|
435
|
+
</section>
|
|
115
436
|
```
|
|
116
437
|
|
|
117
|
-
|
|
438
|
+
The class sets the block's text colour to the fill's label colour
|
|
439
|
+
(`--color-on-brand` or `--color-on-accent`). For everything inside the block
|
|
440
|
+
it re-points the focus rings, and the roles a control writes with when it has
|
|
441
|
+
no fill of its own (see 3).
|
|
442
|
+
|
|
443
|
+
**2. Give text a tone that belongs on a fill.** `Heading` and `Text` take:
|
|
118
444
|
|
|
119
|
-
|
|
120
|
-
|
|
445
|
+
| `tone` | Colour | Use |
|
|
446
|
+
|---|---|---|
|
|
447
|
+
| `inherit` | the block's own text colour | inside `on-brand` / `on-accent`, or any block that sets a colour |
|
|
448
|
+
| `on-brand` | `--color-on-brand` | on `bg-action-primary`, wherever the element is |
|
|
449
|
+
| `on-accent` | `--color-on-accent` | on `bg-accent` |
|
|
450
|
+
|
|
451
|
+
`Heading` is `tone="headline"` by default and `Text` `tone="body"`. Inside a
|
|
452
|
+
block both roles are the block's label colour, so the defaults are legible
|
|
453
|
+
there too; `inherit` says it outright, and is what works on a block of a
|
|
454
|
+
colour of your own.
|
|
455
|
+
|
|
456
|
+
**3. Controls on the block.** A control with no fill of its own writes with
|
|
457
|
+
the page's roles: a Checkbox's label is `--color-label`, an outline Button's
|
|
458
|
+
`--color-headline` with a `--color-border` edge, help text
|
|
459
|
+
`--color-description`. On a brand fill those were 1.5:1 to 3.7:1. Inside
|
|
460
|
+
`on-brand` and `on-accent` they are re-pointed at the block's label colour:
|
|
461
|
+
|
|
462
|
+
- the text roles: `--color-headline`, `--color-body`, `--color-label`,
|
|
463
|
+
`--color-description`, `--color-caption`, `--color-link`,
|
|
464
|
+
`--color-link-hover`
|
|
465
|
+
- the edges: `--color-border`, `--color-border-medium`,
|
|
466
|
+
`--color-border-strong`, `--color-control-border`
|
|
467
|
+
- the rings: `--color-focus-ring`, `--color-focus-ring-muted`,
|
|
468
|
+
`--color-focus-ring-danger`, `--color-nav-menu-focus`, with the gap
|
|
469
|
+
(`--color-focus-ring-offset`) in the block's own colour
|
|
470
|
+
|
|
471
|
+
So every one of them measures what the label colour measures against the
|
|
472
|
+
fill, which the theme holds to 4.5:1 (`scripts/check-contrast.js` fails when a
|
|
473
|
+
block stops re-pointing one, or points it at something that does not read):
|
|
474
|
+
|
|
475
|
+
| Inside | Default theme, light | Default theme, dark | `#0026EA` pinned + `#FDD715` pinned accent, light | The same, dark |
|
|
476
|
+
|---|---|---|---|---|
|
|
477
|
+
| `on-brand` | 4.86 | 7.21 | 8.52 | 7.07 |
|
|
478
|
+
| `on-accent` | 5.02 | 7.11 | 11.66 | 11.66 |
|
|
479
|
+
|
|
480
|
+
That is the label of a Checkbox, Radio, Toggle, Input, Select, Textarea and
|
|
481
|
+
Rating, a field's help text, `Text` and `Heading` in their default tones, a
|
|
482
|
+
plain link, the label of an `outline`, `ghost` and `link` Button and
|
|
483
|
+
IconButton, the border of an `outline` one, and the focus ring of all of
|
|
484
|
+
them, the danger ring included. They were, on a brand block in the default
|
|
485
|
+
theme: labels 2.15 (light) and 1.52 (dark), `outline` and `ghost` 3.65 and
|
|
486
|
+
2.05, `link` 1.39 and 1.34, the danger ring 1.06 and 1.04.
|
|
487
|
+
|
|
488
|
+
The Button variants, on a brand block (`bg-action-primary`). "Label" is
|
|
489
|
+
against the button's own fill, or against the block where the button has
|
|
490
|
+
none; "fill" is the button's fill against the block (3:1 for the button to be
|
|
491
|
+
seen as a shape):
|
|
492
|
+
|
|
493
|
+
| `Button variant` | Default theme, light | Default theme, dark | `#0026EA` + `#FDD715` pinned, light | The same, dark |
|
|
494
|
+
|---|---|---|---|---|
|
|
495
|
+
| `outline`, `ghost`, `link` | label 4.86 | label 7.21 | label 8.52 | label 7.07 |
|
|
496
|
+
| `secondary` | label 5.65 | label 7.75 | label 9.58 | label 7.63 |
|
|
497
|
+
| `accent` | label 5.02, fill 1.03 | label 7.11, fill 1.03 | label 11.66, fill 6.05 | label 11.66, fill 1.60 |
|
|
498
|
+
| `danger` | label 4.78, fill 1.06 | label 7.10, fill 1.04 | label 4.78, fill 1.65 | label 7.10, fill 1.03 |
|
|
499
|
+
| `primary` | the block's own colour: invisible | invisible | invisible | invisible |
|
|
500
|
+
|
|
501
|
+
On an accent block (`bg-accent`):
|
|
502
|
+
|
|
503
|
+
| `Button variant` | Default theme, light | Default theme, dark | `#0026EA` + `#FDD715` pinned, light | The same, dark |
|
|
504
|
+
|---|---|---|---|---|
|
|
505
|
+
| `outline`, `ghost`, `link` | label 5.02 | label 7.11 | label 11.66 | label 11.66 |
|
|
506
|
+
| `secondary` | label 5.86 | label 7.73 | label 9.43 | label 11.92 |
|
|
507
|
+
| `primary` | label 4.86, fill 1.03 | label 7.21, fill 1.03 | label 8.52, fill 6.05 | label 7.07, fill 1.60 |
|
|
508
|
+
| `danger` | label 4.78, fill 1.03 | label 7.10, fill 1.01 | label 4.78, fill 3.66 | label 7.10, fill 1.65 |
|
|
509
|
+
| `accent` | invisible | invisible | invisible | invisible |
|
|
510
|
+
|
|
511
|
+
So the quiet variants (`outline`, `ghost`, `link`, `secondary`) are legible on
|
|
512
|
+
either block in any theme. A solid one keeps its own label; whether it also
|
|
513
|
+
stands out as a shape depends on how far apart the two brand colours are: an
|
|
514
|
+
ultramarine and a yellow are 6:1 apart in light, the library's own blue and
|
|
515
|
+
citron 1.03:1. Where they are close, use a quiet variant for a second action,
|
|
516
|
+
or put the action on a card.
|
|
517
|
+
|
|
518
|
+
**What a block cannot make legible: put it on a card.** Some parts of a
|
|
519
|
+
control are not written with a role that a block can re-point. They are drawn
|
|
520
|
+
with a neutral step, with the primary fill itself, or with a status colour.
|
|
521
|
+
Against the block:
|
|
522
|
+
|
|
523
|
+
| Part | On a brand block (default light, dark; pinned light, dark) | On an accent block |
|
|
524
|
+
|---|---|---|
|
|
525
|
+
| Checkbox or Radio box, and the Toggle track, empty | 1.89, 3.44; 3.32, 3.43 | 1.96, 3.35; 1.82, 5.49 |
|
|
526
|
+
| the same, ticked or on, and a filled Rating star (the primary fill) | 1.00 in all four | 1.03, 1.03; 6.05, 1.60 |
|
|
527
|
+
| the text of an error or other status message | 1.47, 1.31; 1.19, 1.31 | 1.42, 1.34; 5.07, 1.22 |
|
|
528
|
+
| the fill of a field (Input, Select, Textarea) | 4.86, 7.31; 8.52, 7.30 | 5.02, 7.12; 1.41, 11.67 |
|
|
529
|
+
|
|
530
|
+
The label of such a control is legible on the block and the control itself
|
|
531
|
+
may not be: a ticked Checkbox on a brand block is a tick with no box around
|
|
532
|
+
it. Put Checkbox, Radio, Toggle, Calendar and anything that shows a validation
|
|
533
|
+
message on a card inside the block. A field is a surface of its own and
|
|
534
|
+
carries its text; it only disappears on an accent as light as the field (the
|
|
535
|
+
pinned yellow, 1.41). Rating has properties for its colours
|
|
536
|
+
(`--zabi-rating-on`, `--zabi-rating-off`, below).
|
|
537
|
+
|
|
538
|
+
**A surface inside a block is a surface again.** Anything inside the block
|
|
539
|
+
that paints a surface (a `Card`, a field, an `Alert`, a `list-group`: the
|
|
540
|
+
`bg-card`, `bg-surface-*`, `bg-input` and `bg-*-subtle` fills) gets the
|
|
541
|
+
theme's own roles back, and its own text colour, so a card needs nothing: a
|
|
542
|
+
Checkbox on it has the page's label colour and the theme's focus ring. For a
|
|
543
|
+
background the library cannot recognise (an inline style, a class of your
|
|
544
|
+
own), add `on-surface`:
|
|
545
|
+
|
|
546
|
+
```svelte
|
|
547
|
+
<section class="bg-action-primary on-brand p-6">
|
|
548
|
+
<Button variant="outline">Hoppa över</Button>
|
|
549
|
+
<div class="on-surface rounded-container p-4" style="background: #fffbeb">
|
|
550
|
+
<Checkbox label="Kom ihåg mig" />
|
|
551
|
+
</div>
|
|
552
|
+
</section>
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
A block inside that surface is a block again.
|
|
556
|
+
|
|
557
|
+
**The focus ring.** The default ring (`--color-focus-ring`) is the primary
|
|
558
|
+
fill, so on a brand block it measures 1.00:1 against the background and only
|
|
559
|
+
its 2px gap shows; the danger ring is the error colour, 1.0:1 to 1.7:1 there.
|
|
560
|
+
Inside a block every ring is the block's label colour and the gap is the
|
|
561
|
+
block's colour: the numbers of the first table above.
|
|
562
|
+
|
|
563
|
+
To do the same on a block of another colour, set the colour and the ring on
|
|
564
|
+
it yourself, and give text `tone="inherit"`:
|
|
121
565
|
|
|
122
566
|
```css
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
--color-
|
|
126
|
-
|
|
127
|
-
/* Or use a completely custom color */
|
|
128
|
-
--color-action-primary: #your-color-here;
|
|
567
|
+
.my-block {
|
|
568
|
+
color: #ffffff;
|
|
569
|
+
--color-focus-ring: #ffffff;
|
|
570
|
+
--color-focus-ring-offset: #7a1f5c; /* the block's own colour */
|
|
129
571
|
}
|
|
130
572
|
```
|
|
131
573
|
|
|
132
|
-
|
|
574
|
+
The roles of 3 are not re-pointed there: a quiet Button or a Checkbox on such
|
|
575
|
+
a block keeps the page's colours. Re-point the ones you need the same way
|
|
576
|
+
(`--color-label: #ffffff`, `--color-headline: #ffffff`, `--color-border:
|
|
577
|
+
#ffffff`), and then mark any card inside it `on-surface` and set them back
|
|
578
|
+
there.
|
|
133
579
|
|
|
134
|
-
|
|
580
|
+
## Component-level properties
|
|
135
581
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
- **brand-700**: Primary hover, links
|
|
141
|
-
- **brand-800**: Primary active, link hover
|
|
142
|
-
- **brand-900 / 950**: Darkest brand shades
|
|
582
|
+
A few components read custom properties of their own, for colours that are not
|
|
583
|
+
roles of the theme. They are not tokens: the theme does not declare them, and
|
|
584
|
+
they do not appear in the generated files. Set them on the component, or on
|
|
585
|
+
anything around it; they inherit.
|
|
143
586
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
587
|
+
| Component | Property | What it colours | Default |
|
|
588
|
+
|---|---|---|---|
|
|
589
|
+
| `Rating` | `--zabi-rating-on` | a filled star | `--color-action-primary`; `--color-accent` with `tone="accent"` |
|
|
590
|
+
| `Rating` | `--zabi-rating-on-hover`, `--zabi-rating-on-active` | the same under the pointer and while pressed | `--zabi-rating-on` if you set it, else the tone's hover and pressed roles |
|
|
591
|
+
| `Rating` | `--zabi-rating-on-edge` | the outline of a filled star | the fill; `--color-accent-text` with `tone="accent"` |
|
|
592
|
+
| `Rating` | `--zabi-rating-off` | the outline of an empty star | `--color-control-border` |
|
|
148
593
|
|
|
149
|
-
|
|
594
|
+
```svelte
|
|
595
|
+
<Rating label="Betyg" tone="accent" bind:value />
|
|
150
596
|
|
|
151
|
-
|
|
152
|
-
-
|
|
153
|
-
|
|
597
|
+
<!-- or a colour of your own, here for every rating in a block -->
|
|
598
|
+
<section class="bg-action-primary on-brand" style="--zabi-rating-on: var(--color-accent); --zabi-rating-off: var(--color-on-brand)">
|
|
599
|
+
<Rating label="Betyg" bind:value />
|
|
600
|
+
</section>
|
|
601
|
+
```
|
|
154
602
|
|
|
155
|
-
|
|
603
|
+
A star is a control whose shape has to be seen (3:1 against what it sits on).
|
|
604
|
+
`tone="accent"` fills the star with the accent and outlines it in the accent's
|
|
605
|
+
text step, because an accent can be a colour no fill can show on white:
|
|
156
606
|
|
|
157
|
-
|
|
607
|
+
| Filled star, `tone="accent"` | page | card | inset |
|
|
608
|
+
|---|---|---|---|
|
|
609
|
+
| Default accent, light: fill / outline | 4.25 / 5.93 | 5.02 / 7.00 | 4.56 / 6.37 |
|
|
610
|
+
| Default accent, dark: fill / outline | 7.68 / 10.34 | 6.54 / 8.81 | 7.12 / 9.60 |
|
|
611
|
+
| `#FDD715` pinned, light: fill / outline | 1.19 / 5.94 | 1.41 / 7.01 | 1.28 / 6.38 |
|
|
612
|
+
| `#FDD715` pinned, dark: fill / outline | 12.58 / 10.27 | 10.71 / 8.75 | 11.67 / 9.53 |
|
|
158
613
|
|
|
159
|
-
|
|
614
|
+
A yellow star cannot reach 3:1 on a white card: its fill is 1.41:1 there. The
|
|
615
|
+
outline keeps the star's shape at 7:1, so the stars are always there to see.
|
|
616
|
+
What tells a filled star from an empty one on white is then the yellow inside
|
|
617
|
+
the outline and the outline's own colour, which is less than 3:1; the rating
|
|
618
|
+
also has its value as text (`showValue`, on by default when `readonly`) and in
|
|
619
|
+
its accessible name. On a dark or a brand block the yellow fill itself is
|
|
620
|
+
6:1 or more. If you set `--zabi-rating-on` to a light colour yourself, set
|
|
621
|
+
`--zabi-rating-on-edge` too.
|
|
160
622
|
|
|
161
|
-
|
|
162
|
-
- **No explicit dark mode override needed** - Brand colors are automatically inverted
|
|
163
|
-
- `brand-800` (light mode) → `brand-200` (dark mode) automatically
|
|
623
|
+
## The generator
|
|
164
624
|
|
|
165
|
-
|
|
166
|
-
- **No explicit dark mode override needed** - Base colors are automatically inverted
|
|
167
|
-
- `base-600` (light mode) → `base-400` (dark mode) automatically
|
|
625
|
+
Exact brand colour on buttons: use `--pin`.
|
|
168
626
|
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
627
|
+
```bash
|
|
628
|
+
npx zabi-theme --brand "#0026EA" --pin --out src/lib/brand.generated.css
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
Without it, every fill is a step of a ramp built from the colour:
|
|
632
|
+
|
|
633
|
+
```bash
|
|
634
|
+
npx zabi-theme --brand "#0026EA" --out src/lib/brand.generated.css
|
|
635
|
+
npx zabi-theme --brand "#C17B00" --accent "#ff3366" --neutral "#78716c" --out src/lib/brand.generated.css
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
| Option | |
|
|
639
|
+
|---|---|
|
|
640
|
+
| `--brand <hex>` | Required. Builds `--zabi-brand-50 … 950`. |
|
|
641
|
+
| `--pin` | The primary action is the exact brand colour in light. See [`--pin`](#--pin-the-exact-brand-colour-on-buttons). |
|
|
642
|
+
| `--accent <hex>` | Builds `--zabi-accent-50 … 950`. Omitted: the library's citron. |
|
|
643
|
+
| `--pin-accent` | The same for the solid accent fill. Needs `--accent`. |
|
|
644
|
+
| `--neutral <hex>` | Tints the 21-step `--zabi-base-50 … 950`. Omitted: the library's greys. Takes the hue only, at no more than 0.03 chroma. |
|
|
645
|
+
| `--neutral-chroma <n>` | OKLCH chroma at the neutral ramp's peak, 0 to 0.1; needs `--neutral`. Lifts the 0.03 cap (0.04 to 0.06 gives a clearly tinted neutral such as a blue-slate), and makes the ink roles follow the neutral ramp. See [`--neutral-chroma`](#neutral-chroma-a-strongly-tinted-neutral). |
|
|
646
|
+
| `--out <file>` | Where to write. Omitted: stdout. |
|
|
647
|
+
| `--strict` | Exit 1 when a role pair is below WCAG AA. |
|
|
648
|
+
| `--set <token>=<value>` | Also write this declaration, in light and dark; repeatable. |
|
|
649
|
+
| `--set-light <token>=<value>` | The same for light only: dark keeps the library's value. Repeatable. See [`--set` and overrides](#--set-and-overrides). |
|
|
650
|
+
| `--set-dark <token>=<value>` | The same for dark only. Repeatable. |
|
|
651
|
+
| `--help` | Usage. |
|
|
652
|
+
|
|
653
|
+
Colours are hex, `#rgb` or `#rrggbb`. Warnings and the one-line summary go to
|
|
654
|
+
stderr. Exit codes: 0 done, 1 `--strict` with a failed pair, 2 bad usage
|
|
655
|
+
(missing `--brand`, not a hex colour).
|
|
656
|
+
|
|
657
|
+
### `--neutral-chroma`: a strongly tinted neutral
|
|
658
|
+
|
|
659
|
+
`--neutral` gives the neutral ramp its hue and never more chroma than 0.03, so
|
|
660
|
+
it stays a tinted grey. For a UI that reads as one hue with the brand, say a
|
|
661
|
+
blue-slate under an ultramarine brand, give the chroma yourself:
|
|
662
|
+
|
|
663
|
+
```bash
|
|
664
|
+
npx zabi-theme --brand "#0026EA" --neutral "#607296" --neutral-chroma 0.05 --out src/lib/brand.generated.css
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
The ramp has the same 21 lightness steps and the same shape; only its peak
|
|
668
|
+
chroma is the number you gave (`0` to `0.1`). The contrast check runs on the
|
|
669
|
+
result as always. Without `--neutral-chroma` the output is exactly what it was.
|
|
670
|
+
|
|
671
|
+
With it, the translucent ink roles stop being grey and follow the ramp, as
|
|
672
|
+
`color-mix()` over `--zabi-base-900` (light) or `--zabi-base-50` (dark) at the
|
|
673
|
+
alpha the library gives each role:
|
|
674
|
+
`--color-action-secondary`, `-hover`, `-active`, `--color-surface-hover`,
|
|
675
|
+
`--color-surface-active` and, in light, `--color-border-overlay`.
|
|
676
|
+
`--shadow-color` becomes the RGB triplet of step 900 in light and stays `0 0 0`
|
|
677
|
+
in dark. The modal scrim `--color-overlay` stays black. Because a role on
|
|
678
|
+
`:root` is one value in both modes, the file restates the dark values under the
|
|
679
|
+
dark selectors, as `--pin` does. A role you set with `--set`, `--set-light` or
|
|
680
|
+
`--set-dark` keeps your value.
|
|
681
|
+
The contrast check does not evaluate these translucent roles, with or without
|
|
682
|
+
the option; the library's own guard (`npm run check:design`) does for the
|
|
683
|
+
defaults.
|
|
684
|
+
|
|
685
|
+
### `--pin`: the exact brand colour on buttons
|
|
686
|
+
|
|
687
|
+
Unpinned, the primary button is step 600 of the ramp: for `#0026EA` that is
|
|
688
|
+
`#2b65ff`, visibly lighter than the brand. With `--pin` the ramp is the same
|
|
689
|
+
ramp, and the roles that *are* the brand colour are written as role overrides:
|
|
690
|
+
|
|
691
|
+
| | Unpinned | `--pin` |
|
|
692
|
+
|---|---|---|
|
|
693
|
+
| Primary button, light | step 600, `#2b65ff` | the colour itself, `#0026ea` |
|
|
694
|
+
| Its label | white, 4.76:1 | white, 8.52:1 |
|
|
695
|
+
| Hover, pressed | steps 700, 800 | the same hue, darker by the same distances: `#0100c4`, `#000e78` |
|
|
696
|
+
| Focus ring, links, checked boxes | steps 600 and 700 | the colour itself, because every guarded pair still passes |
|
|
697
|
+
| Tints and borders (`-subtle`, `-border`), `--color-brand-*` | on the ramp | on the ramp, unchanged |
|
|
698
|
+
| Dark | step 400, `#84acff` | step 400, `#84acff`: not pinned |
|
|
699
|
+
|
|
700
|
+
What it decides, and how:
|
|
701
|
+
|
|
702
|
+
- **The fill is never moved.** If the colour fails a pair, the pair is a
|
|
703
|
+
warning (and `--strict` exits 1). `#C17B00` pinned is 2.92:1 against the
|
|
704
|
+
light page, where a button needs 3:1, and the generator says so.
|
|
705
|
+
- **The label** is white or the ramp's 950 step, whichever reaches 4.5:1 on the
|
|
706
|
+
fill and both its states. An amber gets the dark label, and its hover and
|
|
707
|
+
pressed states go lighter, since darker states would lose the label.
|
|
708
|
+
- **Focus ring and links follow only if they pass.** The ring needs 3:1 on
|
|
709
|
+
every surface and a link 4.5:1 on the page and on a card. A yellow passes
|
|
710
|
+
neither, so both stay on the ramp. The header lists which followed.
|
|
711
|
+
- **Dark is not pinned unless the colour passes there.** `#0026EA` is 2.08:1
|
|
712
|
+
against a dark page and 1.77:1 against a dark card, where a fill needs 3:1:
|
|
713
|
+
no label makes that a button. Dark keeps the
|
|
714
|
+
mirrored step 400, exactly as without `--pin`, and the header says so. A
|
|
715
|
+
colour that does pass in dark (the amber, the yellow) is pinned there too,
|
|
716
|
+
with lighter states.
|
|
717
|
+
|
|
718
|
+
The trade-off: a ramp step is guaranteed to pass, in both modes, for any
|
|
719
|
+
colour. A pinned colour is exact and passes only if the colour can. Unpinned,
|
|
720
|
+
a brand rarely warns; pinned, read the warnings.
|
|
721
|
+
|
|
722
|
+
The file then has three rules, not one: `:root` with the ramp and the light
|
|
723
|
+
roles, and the dark values of those roles under `.dark, [data-theme="dark"]`
|
|
724
|
+
and under `[data-theme="auto"]` in the dark media query. A role set on `:root`
|
|
725
|
+
alone would be one value in both modes. To force a dark value the generator
|
|
726
|
+
declined, write the role in your own dark rule after the file (see
|
|
727
|
+
[One role in dark only](#one-role-in-dark-only)).
|
|
728
|
+
|
|
729
|
+
A role you pass with `--set` (or `--set-light`, `--set-dark`) is left to you:
|
|
730
|
+
`--pin` does not write it in either mode. With `--set` it is your value in both
|
|
731
|
+
modes; with `--set-light` or `--set-dark`, only in that mode.
|
|
732
|
+
|
|
733
|
+
### What it does
|
|
734
|
+
|
|
735
|
+
- **Brand and accent ramps** on the library's lightness curve, from the hue and
|
|
736
|
+
chroma of the colour you give. See
|
|
737
|
+
[the first section](#the-first-thing-to-know-your-colour-is-not-pinned-to-a-step).
|
|
738
|
+
- **Neutral ramp.** It keeps the base scale's own 21 lightness steps and takes
|
|
739
|
+
only the hue, at low chroma (0.03 at most). A saturated colour gives a tinted
|
|
740
|
+
grey, not a coloured page. `neutralChroma` lifts that cap.
|
|
741
|
+
- **"On" colours.** It sets `--zabi-on-brand` and `--zabi-on-brand-dark` (and
|
|
742
|
+
the accent pair when `--accent` is given) to white or the ramp's 950 step,
|
|
743
|
+
whichever reaches 4.5:1 on the fill, its hover and its active step.
|
|
744
|
+
- **Contrast check.** Every pair the library holds itself to is resolved in
|
|
745
|
+
light and dark with the new ramps in place: 4.5:1 for text and
|
|
746
|
+
3:1 for focus rings and UI parts.
|
|
747
|
+
|
|
748
|
+
### What it does not do
|
|
749
|
+
|
|
750
|
+
- It does not put your exact hex in the ramp. `--pin` puts it on the primary
|
|
751
|
+
action; the ramp steps stay on the curve.
|
|
752
|
+
- It does not write fonts, radius or shadow unless you pass them with `--set`.
|
|
753
|
+
- It does not check the hover, pressed and secondary-button alpha tints. They
|
|
754
|
+
are not part of the contrast list.
|
|
755
|
+
- It does not check that a `--set` token exists. A misspelt name is written as
|
|
756
|
+
given.
|
|
757
|
+
- It does not load or check fonts.
|
|
758
|
+
|
|
759
|
+
### Warnings
|
|
760
|
+
|
|
761
|
+
A plain brand passes, because the ramps share the library's curve. Warnings
|
|
762
|
+
come from two places.
|
|
763
|
+
|
|
764
|
+
An input that will not give the ramp its author probably expects:
|
|
765
|
+
|
|
766
|
+
```
|
|
767
|
+
zabi-theme: warning: brand #808080 has almost no colour in it, so the ramp is a grey scale. Give a more saturated colour for a visible hue.
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
A role pair below AA, which only happens when `--set` moves a role or `--pin`
|
|
771
|
+
pins a colour that cannot carry it:
|
|
772
|
+
|
|
773
|
+
```
|
|
774
|
+
zabi-theme: warning: light · on-brand label on primary: #2f1b00 on #9b6200 is 3.24:1, needs 4.5:1 (--color-on-brand on --color-action-primary)
|
|
775
|
+
```
|
|
776
|
+
|
|
777
|
+
### `--strict` in CI
|
|
778
|
+
|
|
779
|
+
Without `--strict` a failed pair is a warning and the file is still written.
|
|
780
|
+
With it the command exits 1. Because the output is deterministic, one line
|
|
781
|
+
checks both that the brand passes and that the committed file is current:
|
|
782
|
+
|
|
783
|
+
```bash
|
|
784
|
+
npx zabi-theme --brand "#C17B00" --neutral "#78716c" --strict --out src/lib/brand.generated.css && git diff --exit-code src/lib/brand.generated.css
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
### `--set` and overrides
|
|
788
|
+
|
|
789
|
+
`--set` writes one more declaration into the file. It applies in light and in
|
|
790
|
+
dark, and it takes part in the contrast check and in the choice of the "on"
|
|
791
|
+
colours. `--set-light` and `--set-dark` do the same for one mode.
|
|
792
|
+
|
|
793
|
+
```bash
|
|
794
|
+
npx zabi-theme --brand "#C17B00" --set "--color-link=var(--color-brand-800)" --out src/lib/brand.generated.css
|
|
795
|
+
npx zabi-theme --brand "#C17B00" --set '--font-family-heading="Fraunces", var(--font-family-sans)' --out src/lib/brand.generated.css
|
|
796
|
+
```
|
|
797
|
+
|
|
798
|
+
Point a role at a **semantic** step, `var(--color-brand-800)`, not at a
|
|
799
|
+
physical one. The semantic step mirrors in dark; `var(--zabi-brand-800)` is
|
|
800
|
+
the same dark brown in both modes, and as a link colour it fails in dark:
|
|
801
|
+
|
|
802
|
+
```
|
|
803
|
+
zabi-theme: warning: dark · link on page: #613b00 on #18181b is 1.8:1, needs 4.5:1 (--color-link on --color-surface-base)
|
|
804
|
+
```
|
|
805
|
+
|
|
806
|
+
#### One mode only: `--set-light` and `--set-dark`
|
|
807
|
+
|
|
808
|
+
Dark is derived from light, so `--set "--color-surface-raised=#f8faff"` also
|
|
809
|
+
paints the dark cards `#f8faff`. To tint the light card and keep the dark mix
|
|
810
|
+
the library gives it:
|
|
175
811
|
|
|
176
|
-
|
|
812
|
+
```bash
|
|
813
|
+
npx zabi-theme --brand "#0026EA" \
|
|
814
|
+
--set-light "--color-surface-raised=#f8faff" --set-light "--color-surface-overlay=#f8faff" \
|
|
815
|
+
--out src/lib/brand.generated.css
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
The value goes on `:root`. A `:root` value would win in dark too, so the file
|
|
819
|
+
restates, under both dark selectors, the library's own dark value of every token
|
|
820
|
+
you set in light only (the ramp the file writes, for a ramp step; the light
|
|
821
|
+
default if the library has no dark value for it). `--set-dark` writes only under
|
|
822
|
+
the dark selectors. A token given to `--set` and to a mode flag takes the mode's
|
|
823
|
+
value in that mode. The contrast check evaluates each mode with that mode's own
|
|
824
|
+
values, and a warning names the mode as before.
|
|
825
|
+
|
|
826
|
+
A token the library has no dark value for, or one you made up
|
|
827
|
+
(`--set-light "--my-gap=4px"`), cannot be put back in dark: it keeps the light
|
|
828
|
+
value there unless you also pass `--set-dark`.
|
|
177
829
|
|
|
178
|
-
|
|
179
|
-
- **`dist/zabi-components-theme-dark-only.css`**: Has dark mode action colors at lines 119-130 (only danger has explicit overrides)
|
|
180
|
-
- **`dist/zabi-components-theme-only.css`**: Only has light mode (@theme block), no dark mode
|
|
181
|
-
- **`dist/zabi-components-theme.css`**: Only has light mode (@theme block), no dark mode
|
|
830
|
+
### `createTheme()`
|
|
182
831
|
|
|
183
|
-
|
|
832
|
+
The same thing as a function, for a build script:
|
|
833
|
+
|
|
834
|
+
```js
|
|
835
|
+
import { writeFileSync } from "node:fs";
|
|
836
|
+
import { createTheme } from "zabi-components/create-theme";
|
|
837
|
+
|
|
838
|
+
const { css, tokens, warnings, closest } = createTheme({
|
|
839
|
+
brand: "#C17B00",
|
|
840
|
+
accent: "#ff3366", // optional
|
|
841
|
+
neutral: "#78716c", // optional
|
|
842
|
+
neutralChroma: 0.05, // optional, 0 to 0.1, needs neutral: a clearly tinted neutral; the ink roles follow it
|
|
843
|
+
overrides: { "--color-link": "var(--color-brand-800)" }, // optional; both modes. Or { light, dark, both }
|
|
844
|
+
pin: true, // optional: the exact brand on the primary action; or { brand: true, accent: true }
|
|
845
|
+
});
|
|
846
|
+
|
|
847
|
+
for (const warning of warnings) console.warn(warning.message);
|
|
848
|
+
console.log(`Brand is closest to step ${closest.brand.step} (${closest.brand.hex}).`);
|
|
849
|
+
|
|
850
|
+
if (warnings.some((warning) => warning.type === "contrast")) process.exit(1);
|
|
851
|
+
writeFileSync("src/lib/brand.generated.css", css);
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
| Returned | |
|
|
855
|
+
|---|---|
|
|
856
|
+
| `css` | The stylesheet: a header comment and one `:root { … }` rule. With `pin`, `neutralChroma` or `light` / `dark` overrides, two dark rules follow it. |
|
|
857
|
+
| `tokens` | Every declaration of the `:root` rule, name to value. |
|
|
858
|
+
| `darkTokens` | Only with `pin`, `neutralChroma` or `light` / `dark` overrides: every declaration of the dark rules. |
|
|
859
|
+
| `pinned` | Only with `pin`: `{ brand?, accent? }`, each `{ hex, light: { followed, onRamp, states }, dark: { pinned, followed, onRamp, states?, failed? } }`. |
|
|
860
|
+
| `warnings` | `{ type: "contrast", pair, mode, ratio, required, foreground, background, message }` for each role pair below AA, and `{ type: "input", option, message }` notes about the colours given. Empty when everything passes. |
|
|
861
|
+
| `closest` | `{ brand, accent?, neutral? }`, each `{ step, hex, deltaE, exact }`: where the input landed in its ramp. |
|
|
862
|
+
|
|
863
|
+
`overrides` is either the flat map above, one value for both modes, or an object
|
|
864
|
+
with any of `light`, `dark` and `both`, each a flat map:
|
|
865
|
+
|
|
866
|
+
```js
|
|
867
|
+
createTheme({
|
|
868
|
+
brand: "#0026EA",
|
|
869
|
+
overrides: {
|
|
870
|
+
light: { "--color-surface-raised": "#f8faff", "--color-surface-overlay": "#f8faff" }, // dark keeps its mix
|
|
871
|
+
dark: { "--color-link": "var(--color-brand-300)" }, // dark only
|
|
872
|
+
both: { "--color-focus": "var(--color-brand-700)" }, // same as the flat form
|
|
873
|
+
},
|
|
874
|
+
});
|
|
875
|
+
```
|
|
876
|
+
|
|
877
|
+
Flat `--token` keys beside the three count as `both`. A token in `both` and in
|
|
878
|
+
`light` or `dark` takes the mode's value in that mode. `tokens` holds the `:root`
|
|
879
|
+
rule (`both`, then `light`); `darkTokens` holds what the dark rules say: the
|
|
880
|
+
`dark` map, and for every token set in `light`, the library's dark value for it
|
|
881
|
+
(or the `both` value), so `:root` does not reach dark. See
|
|
882
|
+
[One mode only](#one-mode-only---set-light-and---set-dark).
|
|
883
|
+
|
|
884
|
+
It throws a `TypeError` when `brand` is missing, a colour is not hex,
|
|
885
|
+
`pin.accent` is set without `accent`, `neutralChroma` is not a number from 0
|
|
886
|
+
to 0.1 or is given without `neutral`, or an override is not a custom property
|
|
887
|
+
name with a non-empty string value (the message names the key path, for example
|
|
888
|
+
`overrides.light["--color-link"]`). Without these options the result and the
|
|
889
|
+
file are exactly what they were before the option existed.
|
|
890
|
+
|
|
891
|
+
## What does not follow an override
|
|
892
|
+
|
|
893
|
+
- **Hover, pressed and secondary-button fills.** `--color-surface-hover`,
|
|
894
|
+
`--color-surface-active` and `--color-action-secondary` (and `-hover`,
|
|
895
|
+
`-active`) are fixed near-black (light) and near-white (dark) alpha tints.
|
|
896
|
+
They do not take the hue of `--zabi-base-*`, unless you give `neutralChroma`
|
|
897
|
+
(`--neutral-chroma`): then they are mixes of the neutral ramp's ink at the
|
|
898
|
+
same alphas.
|
|
899
|
+
- **The overlay edge and the modal backdrop.** `--color-border-overlay` in
|
|
900
|
+
light is a fixed alpha tint too, and follows the ramp with `neutralChroma`
|
|
901
|
+
(in dark it is already a ramp step). `--color-overlay`, the scrim, stays black.
|
|
902
|
+
- **The shadow colour.** `--shadow-color` is the default neutral's ink, not
|
|
903
|
+
your neutral's. With `neutralChroma` it is the ramp's step 900 in light;
|
|
904
|
+
otherwise set it yourself, it is on the list above.
|
|
905
|
+
- **The `energetic` family.** It points at the citron ramp, not at the accent,
|
|
906
|
+
so it stays yellow when `--zabi-accent-*` changes. `success`, `warning`,
|
|
907
|
+
`error` and `info` keep their own ramps as well.
|
|
908
|
+
- **The size of the dark surface steps.** The four dark levels are mixed from
|
|
909
|
+
your neutral ramp, so they take its hue. The mix amounts were solved for the
|
|
910
|
+
default greys; a neutral whose 900 or 50 step is far from `#18181b` /
|
|
911
|
+
`#fafafa` gives steps of a different size.
|
|
912
|
+
- **Browsers without `color-mix()`.** Where Tailwind compiles the dark file
|
|
913
|
+
(your build, or the `zabi-components/css` bundle) it adds the default hex as
|
|
914
|
+
a fallback before each mixed surface. Those browsers get the default dark
|
|
915
|
+
surfaces whatever the app overrides.
|
|
916
|
+
- **Tokens set below `<html>`.** See [Import order](#import-order).
|
|
917
|
+
- **Semantic steps.** `--color-brand-*` and friends do not rebrand both modes;
|
|
918
|
+
see [Roles](#roles-read-them-do-not-set-them).
|
|
919
|
+
|
|
920
|
+
## Stability
|
|
921
|
+
|
|
922
|
+
Every token named in [Tokens an app may set](#tokens-an-app-may-set) and
|
|
923
|
+
[Roles](#roles-read-them-do-not-set-them) is public API, and so is every other
|
|
924
|
+
token the theme files publish. **Renaming or removing one is a breaking
|
|
925
|
+
change.** Adding a token is not. Regenerating the library's own ramps is
|
|
926
|
+
breaking too, because it changes every colour an app has not overridden.
|
|
927
|
+
`RELEASING.md` says the same from the release side.
|
|
928
|
+
|
|
929
|
+
This is enforced, not just promised.
|
|
930
|
+
`tests/__snapshots__/theme-token-names.snap.json` lists every published token
|
|
931
|
+
name. `npm run test:themes` reads the names out of the built
|
|
932
|
+
`zabi-components/colors` file and fails if one on the list is missing. The
|
|
933
|
+
list only grows: refreshing the snapshots adds new names and never drops one,
|
|
934
|
+
so taking a name off is a hand edit of that file in a commit, which is where a
|
|
935
|
+
breaking change gets noticed.
|
|
936
|
+
|
|
937
|
+
The CSS export paths (`zabi-components/theme-only` and the rest) are public in
|
|
938
|
+
the same way: removing one is breaking.
|
|
939
|
+
|
|
940
|
+
---
|
|
941
|
+
|
|
942
|
+
## Reference: how the theme is built
|
|
943
|
+
|
|
944
|
+
Background for the tables above. An app does not need any of it to rebrand.
|
|
945
|
+
|
|
946
|
+
### Which step does what
|
|
947
|
+
|
|
948
|
+
The brand scale is used throughout the system:
|
|
949
|
+
|
|
950
|
+
- **brand-50 to brand-100**: Subtle backgrounds, hover states
|
|
951
|
+
- **brand-300 to brand-400**: Light accents, disabled states
|
|
952
|
+
- **brand-500**: Medium emphasis
|
|
953
|
+
- **brand-600**: **Primary buttons** (`action-primary`) and the focus ring, in both modes
|
|
954
|
+
- **brand-700**: Primary hover, links
|
|
955
|
+
- **brand-800**: Primary active, link hover
|
|
956
|
+
- **brand-900 / 950**: Darkest brand shades
|
|
957
|
+
|
|
958
|
+
Hover and active always move *toward* the dark end in light mode. The `.dark`
|
|
959
|
+
mirror flips that automatically, so "more pressed" means "more contrast against
|
|
960
|
+
the page" in both themes. Never point `-active` at a step on the far side of the
|
|
961
|
+
ramp — that is how the pressed primary label ended up at 1.66:1.
|
|
962
|
+
|
|
963
|
+
### Calibrated colour ramps
|
|
184
964
|
|
|
185
965
|
Every chromatic ramp (`brand`, `citron`, `pine`, `iris`, `warning`, `error`) is
|
|
186
966
|
**generated against one shared lightness curve**, so `<ramp>-600` means the same
|
|
@@ -194,22 +974,29 @@ as one family instead of six unrelated colours.
|
|
|
194
974
|
Step **600** is the solid-fill step: dark enough to clear 4.5:1 against white,
|
|
195
975
|
light enough to still read as a colour. Every semantic token points at it.
|
|
196
976
|
|
|
197
|
-
- **Source of truth:** `tokens/chromatic-scales.js` — hue
|
|
198
|
-
chroma envelope
|
|
977
|
+
- **Source of truth:** `tokens/chromatic-scales.js` — hue and peak chroma per
|
|
978
|
+
ramp. The target curve, the chroma envelope and the solver are in
|
|
979
|
+
`create-theme/lib/ramp-math.js`, which the theme generator ships, so a
|
|
980
|
+
generated brand sits on the same curve.
|
|
199
981
|
- **Regenerate:** `node scripts/generate-ramps.js` (runs inside `npm run sync:tokens`).
|
|
200
982
|
- **Verify:** `node scripts/check-ramp-lightness.js` — fails if any step drifts
|
|
201
983
|
more than ±1.5 L\* off the curve, or if two adjacent steps differ by more than
|
|
202
984
|
15 L\* (a cliff rather than a ramp).
|
|
203
985
|
|
|
204
|
-
To
|
|
205
|
-
and re-run the generator. **Do not hand-edit
|
|
206
|
-
|
|
986
|
+
To change the library's own ramps, edit `hue` / `peakChroma` for a ramp in
|
|
987
|
+
`tokens/chromatic-scales.js` and re-run the generator. **Do not hand-edit
|
|
988
|
+
`--zabi-<ramp>-*` in `src/app.css`** — the generator overwrites them. They live
|
|
989
|
+
in `@theme` only; `.dark` no longer holds a copy. (An app rebrands by overriding
|
|
990
|
+
them on `:root` instead; see [Tokens an app may set](#tokens-an-app-may-set).)
|
|
991
|
+
|
|
992
|
+
`--zabi-accent-*` is not a generated ramp: each step aliases the citron step of
|
|
993
|
+
the same number.
|
|
207
994
|
|
|
208
995
|
The `base` (neutral) ramp is deliberately **not** on this curve: it is wider on
|
|
209
996
|
purpose because it also drives text, borders and the surface levels. Semantic
|
|
210
997
|
`neutral` aliases the base step closest to the chromatic 600s.
|
|
211
998
|
|
|
212
|
-
|
|
999
|
+
### Semantic families
|
|
213
1000
|
|
|
214
1001
|
Each family exposes the same roles, built from the same steps:
|
|
215
1002
|
|
|
@@ -219,53 +1006,118 @@ Each family exposes the same roles, built from the same steps:
|
|
|
219
1006
|
| `--color-<family>-weak` | 700 | pressed / emphasis |
|
|
220
1007
|
| `--color-<family>-medium` | 800 | strongest fill |
|
|
221
1008
|
| `--color-<family>-strong` | 900 | darkest |
|
|
222
|
-
| `--color-<family>-subtle` | 100 | tinted fill — badges, alerts |
|
|
223
|
-
| `--color-<family>-border` | 200 | tinted edge |
|
|
1009
|
+
| `--color-<family>-subtle` | 200 (dark: 100) | tinted fill — badges, alerts |
|
|
1010
|
+
| `--color-<family>-border` | 300 (dark: 200) | tinted edge |
|
|
224
1011
|
| `--color-<family>-text` | 700 | text on a subtle fill or a page surface |
|
|
225
1012
|
|
|
226
1013
|
Families: `success`, `warning`, `error`, `info`, `energetic`, `neutral`.
|
|
227
1014
|
|
|
1015
|
+
`accent` has the subtle trio on the same steps, and action-style `-hover` (700)
|
|
1016
|
+
and `-active` (800) instead of `-weak` / `-medium` / `-strong`.
|
|
1017
|
+
|
|
1018
|
+
The tints are the one role that does not simply mirror. A step-100 fill is
|
|
1019
|
+
1.16:1 on a white card, too pale to read as a fill, so light uses steps 200 and
|
|
1020
|
+
300 (1.36:1 and about 1.7:1). Mirrored, those would be too heavy on a dark
|
|
1021
|
+
surface, so `.dark` pins 100 and 200. `neutral` follows the same shape on the
|
|
1022
|
+
base ramp: `base-250` fill and `base-300` edge in light, `base-300` and
|
|
1023
|
+
`base-200` in dark.
|
|
1024
|
+
|
|
228
1025
|
Prefer the **subtle** trio (`-subtle` fill + `-border` edge + `-text` label) for
|
|
229
1026
|
anything informational. Solid fills are for the one element on a screen that has
|
|
230
1027
|
to shout.
|
|
231
1028
|
|
|
232
|
-
|
|
1029
|
+
### Surface elevation levels
|
|
233
1030
|
|
|
234
|
-
|
|
235
|
-
and IconButton of the same size line up in a row:
|
|
1031
|
+
Every surface uses one of four semantic levels. Use these tokens instead of raw `base-*` steps for backgrounds:
|
|
236
1032
|
|
|
237
|
-
|
|
|
238
|
-
|
|
239
|
-
| `
|
|
240
|
-
| `
|
|
241
|
-
| `
|
|
1033
|
+
| Level | Token / utility | Use for | Light (OKLCH L) | Dark (OKLCH L) |
|
|
1034
|
+
|---|---|---|---|---|
|
|
1035
|
+
| Base | `--color-surface-base` · `bg-surface-base` | Page / app shell (the darkest level in both themes) | `base-150` · 94 | `--zabi-base-900` `#18181b` · 21 |
|
|
1036
|
+
| Raised | `--color-surface-raised` · `bg-surface-raised` | Cards, panels, sidebars | `#ffffff` · 100 | 6.4% wash `#262629` · 27 |
|
|
1037
|
+
| Elevated | `--color-surface-elevated` · `bg-surface-elevated` | Nested cards, hover and active fills | `base-100` · 97 | 13.1% wash `#363638` · 33 |
|
|
1038
|
+
| Overlay | `--color-surface-overlay` · `bg-surface-overlay` | Modals, sheets, dropdown/select menus, navigation panels, toasts | `#ffffff` · 100 | 19.7% wash `#454547` · 39 |
|
|
1039
|
+
| Inset | `--color-surface-inset` · `bg-surface-inset` | A recessed area on a raised surface: a well, a stat strip, a code sample inside a card | `base-100` · 97 | `base-150` `#1f1f22` · 24 |
|
|
1040
|
+
|
|
1041
|
+
**Inset is not a fifth rung.** The four levels say how far a surface is lifted;
|
|
1042
|
+
inset says it is cut into the card it sits on. It is the ramp step between the
|
|
1043
|
+
page and the raised surface in both themes, about 3 lightness points below
|
|
1044
|
+
`raised`, and every text token passes AA on it. In dark it is the step the input
|
|
1045
|
+
field has always used, and `--color-input` now points at it. In light it shares
|
|
1046
|
+
`base-100` with `elevated`: under a white card the only direction left is down,
|
|
1047
|
+
so a nested card and a well are the same colour there and differ only in dark.
|
|
1048
|
+
Do not use `--color-input` for a well. It is white in light mode, because a
|
|
1049
|
+
light field is a raised surface.
|
|
242
1050
|
|
|
243
|
-
|
|
1051
|
+
Supporting tokens:
|
|
1052
|
+
- `--color-surface-overlay-hover` (`bg-surface-overlay-hover`): row and icon-button hover **inside** an overlay. It is lighter than the overlay in dark mode.
|
|
1053
|
+
- `--color-border-overlay` (`border-border-overlay`): 1px edge on overlays. A 10% ink tint in light mode, so a white menu on a white card has an outline; a solid step in dark mode.
|
|
1054
|
+
|
|
1055
|
+
**The light ladder runs downwards.** Light cannot go lighter than white, so
|
|
1056
|
+
below the card it is ordered page → elevated → raised, with overlay equal to
|
|
1057
|
+
raised and separated from it by `shadow-lg` and the overlay edge. The page is
|
|
1058
|
+
`base-150`, not `base-100`: at `base-100` a card was 1.10:1 on the page and a
|
|
1059
|
+
nested card 1.04:1 on its parent.
|
|
1060
|
+
|
|
1061
|
+
**The dark levels are generated, not hand-picked.** The page is
|
|
1062
|
+
`--zabi-base-900`, and each level above it is `--zabi-base-50` — the same light
|
|
1063
|
+
as the dark hover tint `--color-surface-hover` — washed over the page at
|
|
1064
|
+
6.4% / 13.1% / 19.7%, so every level is literally the level below it with more
|
|
1065
|
+
light on it. The ladder lives in `tokens/surface-ladder.js`; edit the alphas
|
|
1066
|
+
there and run `npm run sync:tokens`, never the values in `app.css`.
|
|
244
1067
|
|
|
245
|
-
|
|
1068
|
+
The levels ship as `color-mix()` over the neutral ramp, not as baked hex:
|
|
246
1069
|
|
|
247
|
-
|
|
248
|
-
|
|
1070
|
+
```css
|
|
1071
|
+
--color-surface-base: var(--zabi-base-900);
|
|
1072
|
+
--color-surface-raised: color-mix(in srgb, var(--zabi-base-50) 6.4%, var(--zabi-base-900));
|
|
1073
|
+
```
|
|
249
1074
|
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
1075
|
+
That is how the ladder follows an app's `--zabi-base-*` override: a warm grey
|
|
1076
|
+
gets four warm dark levels, with no surface tokens of its own. Mixing two
|
|
1077
|
+
opaque colours in sRGB is the same arithmetic as the old build-time composite,
|
|
1078
|
+
so the default theme resolves to exactly the hex in the table, and an overlay
|
|
1079
|
+
is still opaque. The static checks evaluate the mix themselves
|
|
1080
|
+
(`scripts/resolve-tokens.js`), so `check-contrast.js` still resolves every AA
|
|
1081
|
+
pair against a dark surface and `check-surface-elevation.js` still measures the
|
|
1082
|
+
steps. The trade is unchanged: nesting past the four levels is not automatic. A
|
|
1083
|
+
card inside a card does not self-lighten, it names the next level up.
|
|
1084
|
+
|
|
1085
|
+
Two things to know. The step size depends on the app's neutrals: the alphas are
|
|
1086
|
+
solved for the default greys, and a ramp whose 900 or 50 step is far from
|
|
1087
|
+
`#18181b` / `#fafafa` can land outside the 5–8 point window the guard holds the
|
|
1088
|
+
default to. And wherever Tailwind compiles the dark file (the
|
|
1089
|
+
`zabi-components/css` bundle, or an app's own build) it adds a static fallback,
|
|
1090
|
+
the default hex, before each mix for browsers without `color-mix()`; those get
|
|
1091
|
+
the default dark surfaces whatever the app overrides.
|
|
256
1092
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
1093
|
+
**Why dark mode steps lightness instead of using shadows:** a drop shadow simulates light blocked by a raised object, which reads on a light page. On a dark page the shadow is as dark as the background, so the signal disappears. In dark mode each level is therefore **lighter** than the one below it, by +6 OKLCH lightness points on the neutral base hue. Light mode keeps white surfaces and uses shadows for elevation.
|
|
1094
|
+
|
|
1095
|
+
**Rules:**
|
|
1096
|
+
- Anything that floats above content must use a lighter level than what it floats over. Floating components (Modal, SlideUp, Dropdown/Select menu, NavigationMenu panel, Toaster/Toast) use `bg-surface-overlay`.
|
|
1097
|
+
- Hover fills on overlays use `bg-surface-overlay-hover`, not `bg-base-*`, which would go darker in dark mode.
|
|
1098
|
+
- Existing tokens remain as aliases: `background` → base, `card` / `surface-1` → raised, `surface-2` / `card-hover` → elevated, `surface-3` → overlay (dark), `card-elevated` → overlay (light) / elevated (dark).
|
|
1099
|
+
|
|
1100
|
+
**Enforced by** `scripts/check-surface-elevation.js`, which `validate-theme.js` runs during `npm run build:css`. It fails when:
|
|
1101
|
+
- dark levels aren't strictly increasing;
|
|
1102
|
+
- any dark step is outside 5–8 OKLCH L points;
|
|
1103
|
+
- the light levels are not ordered base < elevated < raised, either step is under 2 points, or the overlay is darker than raised;
|
|
1104
|
+
- the inset surface is less than 2 points below raised, or darker than the page, in either theme;
|
|
1105
|
+
- a text token falls below AA on any level or on the inset surface;
|
|
1106
|
+
- overlay hover or tooltip fills are darker than the overlay;
|
|
1107
|
+
- a floating component paints a surface class below overlay.
|
|
260
1108
|
|
|
261
|
-
|
|
1109
|
+
To retune the dark levels, edit `SURFACE_ALPHA` in `tokens/surface-ladder.js`, run `npm run sync:tokens`, and then `node scripts/check-surface-elevation.js`.
|
|
1110
|
+
|
|
1111
|
+
> The light surface tokens must stay **below** the `/* Background Colors */` marker in `@theme`. `scripts/sync-theme-tokens.js` regenerates everything between the base-scale aliases and that marker.
|
|
1112
|
+
|
|
1113
|
+
### Interaction fills
|
|
262
1114
|
|
|
263
1115
|
Hover and active fills are **surface-relative alpha tints**, not fixed ramp steps:
|
|
264
1116
|
|
|
265
1117
|
```css
|
|
266
1118
|
/* light */
|
|
267
|
-
--color-surface-hover: rgba(9, 9, 11, 0.
|
|
268
|
-
--color-surface-active: rgba(9, 9, 11, 0.
|
|
1119
|
+
--color-surface-hover: rgba(9, 9, 11, 0.09);
|
|
1120
|
+
--color-surface-active: rgba(9, 9, 11, 0.15);
|
|
269
1121
|
/* dark */
|
|
270
1122
|
--color-surface-hover: rgba(250, 250, 250, 0.08);
|
|
271
1123
|
--color-surface-active: rgba(250, 250, 250, 0.14);
|
|
@@ -274,88 +1126,82 @@ Hover and active fills are **surface-relative alpha tints**, not fixed ramp step
|
|
|
274
1126
|
A fixed step can coincide exactly with the surface it sits on — `base-100` in
|
|
275
1127
|
dark mode *is* `--color-surface-base`, which is how ghost-button hover became
|
|
276
1128
|
invisible. `check-token-violations.js` now fails on `hover:bg-base-*` /
|
|
277
|
-
`active:bg-base-*` in component source
|
|
1129
|
+
`active:bg-base-*` in component source, in `src/routes` and in the `@apply`
|
|
1130
|
+
lines of `src/app.css`.
|
|
1131
|
+
|
|
1132
|
+
Being one step away is not the same as being visible. `check-contrast.js`
|
|
1133
|
+
composites each tint over every surface level and requires 1.2:1 for the
|
|
1134
|
+
resting hover and the secondary button, and a further 1.08:1 for each state
|
|
1135
|
+
after it. Light hover was 6% ink, 1.14:1, and passed every check until then.
|
|
278
1136
|
|
|
279
1137
|
Use `hover:bg-surface-hover` / `active:bg-surface-active` for quiet controls, and
|
|
280
1138
|
the `action-*-hover` / `action-*-active` tokens for filled ones.
|
|
281
1139
|
|
|
282
|
-
|
|
1140
|
+
**State variants next to a hand-written colour class.** `text-description`,
|
|
1141
|
+
`border-border`, `bg-card` and the other semantic colour classes are written by
|
|
1142
|
+
hand in `src/app.css`, outside every cascade layer, so they beat any generated
|
|
1143
|
+
utility on the same element, including the state variant meant to replace
|
|
1144
|
+
them. `text-description hover:text-headline` compiled and never changed on
|
|
1145
|
+
hover. Each such variant a component uses is restated by hand in the block
|
|
1146
|
+
headed "STATE VARIANTS OF THE HAND-WRITTEN COLOUR CLASSES". When a component
|
|
1147
|
+
needs a new one, add the rule there; `tests/state-variants.test.ts`
|
|
1148
|
+
(`scripts/check-state-variants.js`) fails until it exists.
|
|
1149
|
+
|
|
1150
|
+
### Contrast
|
|
283
1151
|
|
|
284
1152
|
`scripts/check-contrast.js` resolves every fill/foreground pair a component can
|
|
285
1153
|
render — through the same token chain the CSS uses — in **both** themes, and
|
|
286
|
-
fails below WCAG AA.
|
|
1154
|
+
fails below WCAG AA. It also holds the focus ring to 3:1 against the page, a
|
|
1155
|
+
card, and the offset gap that separates it from a primary button. The muted
|
|
1156
|
+
ring (`--color-focus-ring-muted`), the danger ring (`--color-focus-ring-danger`) and the control boundary
|
|
1157
|
+
(`--color-control-border`), and the brand and nav rings, are held to 3:1 on
|
|
1158
|
+
all five surfaces: page, card, inset, elevated and overlay. The colour a focus-ring rule
|
|
1159
|
+
uses must be a token in that list (`scripts/contrast-pairs.js`), so a ring
|
|
1160
|
+
cannot read a raw ramp step.
|
|
1161
|
+
`--color-input-border`, the edge of a form field, is held to 3:1 on the field
|
|
1162
|
+
fill (`--color-input`), the page and the card (WCAG 1.4.11). The same pairs are
|
|
1163
|
+
in the list `createTheme` checks, so a generated theme that lets a field's edge
|
|
1164
|
+
fall below 3:1 is reported. Run it after
|
|
1165
|
+
re-pointing any token:
|
|
287
1166
|
|
|
288
1167
|
```bash
|
|
289
|
-
npm run check:contrast # or: npm run check:design (all
|
|
1168
|
+
npm run check:contrast # or: npm run check:design (all five guards)
|
|
290
1169
|
```
|
|
291
1170
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
Every surface uses one of four semantic levels. Use these tokens instead of raw `base-*` steps for backgrounds:
|
|
1171
|
+
### Border radius
|
|
295
1172
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
| Base | `--color-surface-base` · `bg-surface-base` | Page / app shell (the darkest level in dark mode) | `base-100` | `#18181b` · 21 |
|
|
299
|
-
| Raised | `--color-surface-raised` · `bg-surface-raised` | Cards, panels, sidebars | `#ffffff` | `#262629` · 27 |
|
|
300
|
-
| Elevated | `--color-surface-elevated` · `bg-surface-elevated` | Nested cards, hover and active fills | `base-50` | `#35353a` · 33 |
|
|
301
|
-
| Overlay | `--color-surface-overlay` · `bg-surface-overlay` | Modals, sheets, dropdown/select menus, navigation panels, toasts | `#ffffff` | `#44444c` · 39 |
|
|
302
|
-
|
|
303
|
-
Supporting tokens:
|
|
304
|
-
- `--color-surface-overlay-hover` (`bg-surface-overlay-hover`): row and icon-button hover **inside** an overlay. It is lighter than the overlay in dark mode.
|
|
305
|
-
- `--color-border-overlay` (`border-border-overlay`): 1px edge on overlays. Transparent in light mode, visible in dark mode.
|
|
306
|
-
|
|
307
|
-
**The dark levels are generated, not hand-picked.** Each one is `#fafafa` — the
|
|
308
|
-
same light as the dark hover tint `--color-surface-hover` — washed over the page
|
|
309
|
-
at 6.4% / 13.1% / 19.7%, so every level is literally the level below it with more
|
|
310
|
-
light on it. The ladder lives in `tokens/surface-ladder.js`; edit the alphas
|
|
311
|
-
there and run `npm run sync:tokens`, never the hex in `app.css`.
|
|
312
|
-
|
|
313
|
-
The composite is baked to an opaque hex at build time rather than shipped as
|
|
314
|
-
`rgba()`. Flat colours keep the static toolchain working — `check-contrast.js`
|
|
315
|
-
can resolve every AA pair against a surface, `check-surface-elevation.js` can
|
|
316
|
-
measure the steps — and an opaque overlay means a modal never lets the page bleed
|
|
317
|
-
through it. The trade: nesting past the four levels is not automatic. A card
|
|
318
|
-
inside a card does not self-lighten, it names the next level up.
|
|
319
|
-
|
|
320
|
-
**Why dark mode steps lightness instead of using shadows:** a drop shadow simulates light blocked by a raised object, which reads on a light page. On a dark page the shadow is as dark as the background, so the signal disappears. In dark mode each level is therefore **lighter** than the one below it, by +6 OKLCH lightness points on the neutral base hue. Light mode keeps white surfaces and uses shadows for elevation.
|
|
321
|
-
|
|
322
|
-
**Rules:**
|
|
323
|
-
- Anything that floats above content must use a lighter level than what it floats over. Floating components (Modal, SlideUp, Dropdown/Select menu, NavigationMenu panel, Toaster/Toast) use `bg-surface-overlay`.
|
|
324
|
-
- Hover fills on overlays use `bg-surface-overlay-hover`, not `bg-base-*`, which would go darker in dark mode.
|
|
325
|
-
- Existing tokens remain as aliases: `background` → base, `card` / `surface-1` → raised, `surface-2` / `card-hover` → elevated, `surface-3` → overlay (dark), `card-elevated` → overlay (light) / elevated (dark).
|
|
326
|
-
|
|
327
|
-
**Enforced by** `scripts/check-surface-elevation.js`, which `validate-theme.js` runs during `npm run build:css`. It fails when:
|
|
328
|
-
- dark levels aren't strictly increasing;
|
|
329
|
-
- any step is outside 5–8 OKLCH L points;
|
|
330
|
-
- overlay hover or tooltip fills are darker than the overlay;
|
|
331
|
-
- a floating component paints a surface class below overlay.
|
|
1173
|
+
Four radii, chosen by **role**, never by size. A large button is a bigger box
|
|
1174
|
+
with the same corner as a small one.
|
|
332
1175
|
|
|
333
|
-
|
|
1176
|
+
| token | value | use |
|
|
1177
|
+
|---|---|---|
|
|
1178
|
+
| `--radius-control` | 8px | buttons, inputs, selects, toggles |
|
|
1179
|
+
| `--radius-container` | 12px | cards, alerts, panels, list items, code blocks |
|
|
1180
|
+
| `--radius-overlay` | 16px | modals, sheets, menus, popovers, toasts |
|
|
1181
|
+
| `--radius-pill` | full | badges, avatars, status dots |
|
|
334
1182
|
|
|
335
|
-
|
|
1183
|
+
`--radius-sm/md/lg/xl` remain as legacy aliases so that existing consumer
|
|
1184
|
+
stylesheets keep compiling, but components must not use them — `check-control-geometry.js` fails the build if a
|
|
1185
|
+
component reaches for a t-shirt radius.
|
|
336
1186
|
|
|
337
|
-
|
|
1187
|
+
### Control geometry
|
|
338
1188
|
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
tailwind-merge) to be true: `rounded-control` and `rounded-container` are
|
|
342
|
-
equal-specificity utilities, so plain concatenation leaves the winner to
|
|
343
|
-
whichever one Tailwind emits later in the stylesheet, not to the caller.
|
|
1189
|
+
One height scale is shared by **every** form control, so a Button, Input, Select,
|
|
1190
|
+
IconButton and Slider of the same size line up in a row:
|
|
344
1191
|
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
1192
|
+
| size | height | token |
|
|
1193
|
+
|---|---|---|
|
|
1194
|
+
| `sm` | 32px | `--control-height-sm` |
|
|
1195
|
+
| `md` | 40px | `--control-height-md` |
|
|
1196
|
+
| `lg` | 48px | `--control-height-lg` |
|
|
348
1197
|
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
because `control`/`container`/`overlay`/`pill` are role names rather than scale
|
|
353
|
-
values. **Add any future custom scale to that config**, or tailwind-merge keeps
|
|
354
|
-
both classes and stylesheet order silently decides again.
|
|
1198
|
+
IconButton also has `xs`, a 24px box for dense pointer-first layouts. No text
|
|
1199
|
+
control is that small, so it sits outside the shared scale, and the check pins
|
|
1200
|
+
it separately.
|
|
355
1201
|
|
|
356
|
-
|
|
1202
|
+
Enforced by `scripts/check-control-geometry.js`.
|
|
357
1203
|
|
|
358
|
-
|
|
1204
|
+
### Shadow scale
|
|
359
1205
|
|
|
360
1206
|
Elevation in light mode is **two steps**, not a ramp. A shadow says "this is
|
|
361
1207
|
above the page" or "this floats over it" — there is no third meaning, and an
|
|
@@ -378,11 +1224,13 @@ Rules:
|
|
|
378
1224
|
`shadow` utility is the sneaky one: it resolves to a Tailwind default that
|
|
379
1225
|
`app.css` never defines, so no token controls it.
|
|
380
1226
|
- Shadows carry elevation in **light mode only**. In dark mode the surface
|
|
381
|
-
levels above do the work — see Surface
|
|
1227
|
+
levels above do the work — see [Surface elevation levels](#surface-elevation-levels).
|
|
1228
|
+
- The light shadow is the ramp's own ink (`--shadow-color: 24 24 27`) at
|
|
1229
|
+
`--shadow-opacity: 0.14`. Dark keeps black at 0.3.
|
|
382
1230
|
|
|
383
1231
|
Enforced by `scripts/check-token-violations.js`.
|
|
384
1232
|
|
|
385
|
-
|
|
1233
|
+
### Spacing rhythm
|
|
386
1234
|
|
|
387
1235
|
Layout spacing rides a **4px grid**. Half-steps (`gap-1.5`, `px-2.5`, `py-2.5`)
|
|
388
1236
|
set up a second rhythm competing with the first: a 6px gap beside an 8px gap is
|
|
@@ -398,7 +1246,7 @@ a 2px wobble nobody chose, and it accumulates down a dense form.
|
|
|
398
1246
|
|
|
399
1247
|
Enforced by `scripts/check-token-violations.js`.
|
|
400
1248
|
|
|
401
|
-
|
|
1249
|
+
### Type scale
|
|
402
1250
|
|
|
403
1251
|
`Heading` and `Text` sit on **one** ramp rather than each carrying its own, so a
|
|
404
1252
|
heading and the copy beneath it share line boxes instead of nearly matching.
|
|
@@ -414,65 +1262,143 @@ heading and the copy beneath it share line boxes instead of nearly matching.
|
|
|
414
1262
|
| 14px | — | `size="sm"` |
|
|
415
1263
|
| 12px | — | `size="xs"` |
|
|
416
1264
|
|
|
417
|
-
Headings
|
|
1265
|
+
Headings use `--font-family-heading` (the sans family unless an app sets it),
|
|
1266
|
+
tighten tracking as they grow and are `semibold`/`bold`; `Text` takes a
|
|
418
1267
|
`weight` prop (`normal` · `medium` · `semibold` · `bold`) so body copy can carry
|
|
419
1268
|
emphasis without being promoted to a heading. `tone="label"` defaults to
|
|
420
1269
|
`medium`; every other tone defaults to `normal`.
|
|
421
1270
|
|
|
422
|
-
|
|
1271
|
+
### Overriding a component's classes
|
|
423
1272
|
|
|
1273
|
+
`class` is the public prop on every component and is merged **last**, so a
|
|
1274
|
+
call-site utility wins. That promise needs `cn()` (`src/components/util/cn.ts`,
|
|
1275
|
+
tailwind-merge) to be true: `rounded-control` and `rounded-container` are
|
|
1276
|
+
equal-specificity utilities, so plain concatenation leaves the winner to
|
|
1277
|
+
whichever one Tailwind emits later in the stylesheet, not to the caller.
|
|
1278
|
+
|
|
1279
|
+
```svelte
|
|
1280
|
+
<Card class="rounded-pill" /> <!-- rounded-container is dropped, not fought -->
|
|
424
1281
|
```
|
|
425
|
-
src/
|
|
426
|
-
└── app.css ← 🎯 EDIT THIS FILE FOR ALL THEMING (single source of truth)
|
|
427
1282
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
1283
|
+
Most semantic utilities work with stock tailwind-merge — `bg-card` vs
|
|
1284
|
+
`bg-surface-overlay`, `text-headline` vs `text-description` all resolve. The
|
|
1285
|
+
role-based radii are the exception and are declared explicitly in `cn.ts`,
|
|
1286
|
+
because `control`/`container`/`overlay`/`pill` are role names rather than scale
|
|
1287
|
+
values. **Add any future custom scale to that config**, or tailwind-merge keeps
|
|
1288
|
+
both classes and stylesheet order silently decides again.
|
|
1289
|
+
|
|
1290
|
+
Covered by `tests/class-merge.test.ts`.
|
|
1291
|
+
|
|
1292
|
+
---
|
|
435
1293
|
|
|
436
|
-
|
|
437
|
-
└── theme-extensions/
|
|
438
|
-
├── 02-custom-brand-colors.css
|
|
439
|
-
└── 03-custom-semantic-colors.css
|
|
440
|
-
```
|
|
1294
|
+
## For maintainers
|
|
441
1295
|
|
|
442
|
-
|
|
1296
|
+
This part is about changing the library's own theme, not an app's.
|
|
443
1297
|
|
|
444
|
-
|
|
445
|
-
2. **All theming is in `src/app.css`** - This is the single source of truth
|
|
446
|
-
3. **Always edit `src/app.css`** - This is your single source of truth
|
|
447
|
-
4. The `examples/` folder contains examples, not your actual theme
|
|
448
|
-
5. **Dist files are overwritten** every time you run `npm run build:css`
|
|
1298
|
+
### One source file
|
|
449
1299
|
|
|
450
|
-
|
|
1300
|
+
All theming is in `src/app.css`:
|
|
451
1301
|
|
|
452
|
-
|
|
1302
|
+
- the `@theme` block holds every token and the light values, including the raw
|
|
1303
|
+
`--zabi-*` ramps, declared once;
|
|
1304
|
+
- one `.dark { … }` rule remaps roles for dark. No `--zabi-*` token and no hex
|
|
1305
|
+
literal belongs in it; `validate-theme.js` fails the build on either.
|
|
453
1306
|
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
- `zabi-components-theme.css` - Theme block with Tailwind import (light mode only)
|
|
459
|
-
- `zabi-components-theme-only.css` - Theme block only (light mode only)
|
|
460
|
-
- `zabi-components-theme-dark.css` - Dark mode theme with Tailwind import
|
|
461
|
-
- `zabi-components-theme-dark-only.css` - Dark mode theme only
|
|
462
|
-
- `zabi-components-colors.css` - Standalone CSS custom properties (both light and dark)
|
|
1307
|
+
The files under `dist/` are generated from it by `scripts/build-css.js` and are
|
|
1308
|
+
overwritten on every build. Never edit them. Which file is which is in
|
|
1309
|
+
[docs/theme-imports.md](./docs/theme-imports.md). `examples/theme-extensions/`
|
|
1310
|
+
holds examples, not the theme.
|
|
463
1311
|
|
|
464
|
-
|
|
1312
|
+
Parts of `src/app.css` are generated too, so edit the source instead:
|
|
465
1313
|
|
|
466
|
-
|
|
467
|
-
|
|
1314
|
+
| To change | Edit | Then run |
|
|
1315
|
+
|---|---|---|
|
|
1316
|
+
| A chromatic ramp (`brand`, `citron`, `pine`, `iris`, `warning`, `error`) | `hue` / `peakChroma` in `tokens/chromatic-scales.js` | `npm run sync:tokens` |
|
|
1317
|
+
| The neutral ramp | `tokens/base-scale.js` | `npm run sync:tokens` |
|
|
1318
|
+
| The dark surface levels | `SURFACE_ALPHA` in `tokens/surface-ladder.js` | `npm run sync:tokens` |
|
|
1319
|
+
| A role, a font, a radius | `src/app.css` | nothing in development |
|
|
468
1320
|
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
1321
|
+
Before a release, `npm run build:css` regenerates the `dist/` files and
|
|
1322
|
+
`npm run build:lib` does that and verifies them (`scripts/verify-build.js`).
|
|
1323
|
+
|
|
1324
|
+
### Dark mode selectors
|
|
1325
|
+
|
|
1326
|
+
`src/app.css` holds one `.dark { … }` rule. `scripts/build-css.js` publishes it,
|
|
1327
|
+
in every file that carries dark tokens, as:
|
|
1328
|
+
|
|
1329
|
+
```css
|
|
1330
|
+
:root, [data-theme="light"] { color-scheme: light; } /* in the light files */
|
|
1331
|
+
[data-theme="light"] { color-scheme: light; }
|
|
1332
|
+
[data-theme="dark"] { color-scheme: dark; }
|
|
1333
|
+
[data-theme="auto"] { color-scheme: light dark; }
|
|
1334
|
+
.dark, [data-theme="dark"] { …; color-scheme: dark; }
|
|
1335
|
+
@media (prefers-color-scheme: dark) { [data-theme="auto"] { …; color-scheme: dark; } }
|
|
473
1336
|
```
|
|
474
1337
|
|
|
475
|
-
|
|
1338
|
+
- The light rule is written by hand in `src/app.css`, above `.dark`, and has
|
|
1339
|
+
to stay above it: all of these have the specificity of one class, so the
|
|
1340
|
+
later one wins. `validate-theme.js` fails the build if a light file lacks
|
|
1341
|
+
the rule or has it after a dark one.
|
|
1342
|
+
- `color-scheme: dark` is the last declaration of the source `.dark` rule, so
|
|
1343
|
+
every dark selector carries it. The three attribute rules come first: with
|
|
1344
|
+
`class="dark" data-theme="light"` the class brings the dark tokens, and so
|
|
1345
|
+
the dark scheme with them.
|
|
1346
|
+
- All selectors have the specificity of `.dark`.
|
|
1347
|
+
- Keep it as one `.dark` rule in the source and do not write the others by
|
|
1348
|
+
hand; `scripts/dark-selectors.js` generates them.
|
|
1349
|
+
- The dev site and Storybook read `src/app.css` directly. `postcss.config.cjs`
|
|
1350
|
+
runs the same expansion on it, so `data-theme` works there as it does in the
|
|
1351
|
+
published files.
|
|
1352
|
+
|
|
1353
|
+
`validate-theme.js` fails the build if a dark-carrying file lacks any of the
|
|
1354
|
+
three, or if the `auto` copy differs from `.dark`.
|
|
1355
|
+
|
|
1356
|
+
### Dark mode action colours
|
|
1357
|
+
|
|
1358
|
+
- **Primary.** No dark override: `--color-brand-*` mirrors, so `brand-800` in
|
|
1359
|
+
light is `brand-200` in dark. The label is `--color-on-brand`, which `.dark`
|
|
1360
|
+
points at `--zabi-on-brand-dark`.
|
|
1361
|
+
- **Secondary.** No dark override: `--color-base-*` mirrors the same way.
|
|
1362
|
+
- **Danger.** Resolves through `--color-error-*`, which mirrors like every
|
|
1363
|
+
other ramp. The `.dark` block restates the aliases only so that
|
|
1364
|
+
`zabi-components/theme-dark-only` remains a complete standalone import
|
|
1365
|
+
(`validate-theme.js` enforces that).
|
|
1366
|
+
|
|
1367
|
+
Hover and active always move toward the dark end in light mode, and the mirror
|
|
1368
|
+
flips that, so "more pressed" means "more contrast against the page" in both
|
|
1369
|
+
themes. Never point `-active` at a step on the far side of the ramp; that is
|
|
1370
|
+
how the pressed primary label once ended up at 1.66:1.
|
|
1371
|
+
|
|
1372
|
+
### Building the generator
|
|
1373
|
+
|
|
1374
|
+
The source is `create-theme/`. It ships as plain ESM in `dist/create-theme/`
|
|
1375
|
+
and needs `culori` at runtime, so `culori` is a dependency.
|
|
1376
|
+
`scripts/build-create-theme.js` copies it and writes `theme-data.js`, the
|
|
1377
|
+
default theme and the pair list, from `src/app.css` and
|
|
1378
|
+
`scripts/contrast-pairs.js` on every build. `verify-build.js` fails if that
|
|
1379
|
+
file differs from its sources, and runs the bin from `dist/`. Tests:
|
|
1380
|
+
`tests/create-theme.test.js`, part of `npm run test:themes`.
|
|
1381
|
+
|
|
1382
|
+
### Where the two-brand proof lives
|
|
1383
|
+
|
|
1384
|
+
- `tests/theme-output.test.js` (`npm run test:themes`) proves from the built
|
|
1385
|
+
CSS that one ramp override rebrands light and dark, and keeps the list of
|
|
1386
|
+
published token names.
|
|
1387
|
+
- The docs site runs under two brands: the default, and Amber, which
|
|
1388
|
+
`vite-plugin-brand-themes.js` builds with `createTheme` from the inputs in
|
|
1389
|
+
`src/lib/marketing/brand-inputs.ts` each time the site starts or builds. The
|
|
1390
|
+
switcher is in the top bar and on `/theming`; `?brand=amber` opens any page
|
|
1391
|
+
in it.
|
|
1392
|
+
- `playwright/theme-brands.spec.ts` (`npm run test:e2e`) loads component pages
|
|
1393
|
+
under both brands, in light and dark, at desktop width and at 375px, and
|
|
1394
|
+
checks from computed styles that the primary fill, its label, the focus ring,
|
|
1395
|
+
the card surface and the heading face change with the brand and that the
|
|
1396
|
+
label keeps 4.5:1.
|
|
1397
|
+
- `tests/theming-guide.test.ts` (`npm test`) fails if this guide, `THEME.md`,
|
|
1398
|
+
`docs/theme-imports.md` or the site's token tables name a token the theme
|
|
1399
|
+
does not publish.
|
|
1400
|
+
|
|
1401
|
+
### Optional perceptual midpoint generation (OKLCH)
|
|
476
1402
|
|
|
477
1403
|
Base midpoints are frozen hex by default (`fixed` mode).
|
|
478
1404
|
For experimentation, you can generate midpoint steps in OKLCH interpolation and commit the resulting frozen values:
|