@cube-dev/ui-kit 0.0.0-canary-a2deb22 → 0.0.0-canary-e397738
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/dist/_internal/hooks/use-chained-callback.js +1 -1
- package/dist/_internal/hooks/use-debounced-value.js +1 -1
- package/dist/_internal/hooks/use-deprecation-warning.js +1 -1
- package/dist/_internal/hooks/use-event.js +1 -1
- package/dist/_internal/hooks/use-is-first-render.js +1 -1
- package/dist/_internal/hooks/use-sync-ref.js +1 -1
- package/dist/_internal/hooks/use-timer/timer.js +1 -1
- package/dist/_internal/hooks/use-timer/use-timer.js +1 -1
- package/dist/_internal/hooks/use-warn.js +1 -1
- package/dist/components/Block.js +1 -1
- package/dist/components/CollectionItem.js +1 -1
- package/dist/components/GlobalStyles.js +9 -30
- package/dist/components/GlobalStyles.js.map +1 -1
- package/dist/components/GridProvider.js +1 -1
- package/dist/components/HiddenInput.js +1 -1
- package/dist/components/Root.js +1 -1
- package/dist/components/actions/Action/Action.js +1 -1
- package/dist/components/actions/Banner/Banner.js +1 -1
- package/dist/components/actions/Button/Button.js +1 -1
- package/dist/components/actions/ButtonGroup/ButtonGroup.js +1 -1
- package/dist/components/actions/ButtonSplit/ButtonSplit.js +1 -1
- package/dist/components/actions/ButtonSplit/context.js +1 -1
- package/dist/components/actions/CommandMenu/CommandMenu.js +1 -1
- package/dist/components/actions/CommandMenu/styled.js +1 -1
- package/dist/components/actions/ItemAction/ItemAction.js +1 -1
- package/dist/components/actions/ItemActionContext.js +1 -1
- package/dist/components/actions/ItemButton/ItemButton.js +1 -1
- package/dist/components/actions/Link/Link.js +1 -1
- package/dist/components/actions/Menu/Menu.js +1 -1
- package/dist/components/actions/Menu/MenuItem.js +1 -1
- package/dist/components/actions/Menu/MenuSection.js +1 -1
- package/dist/components/actions/Menu/MenuTrigger.js +1 -1
- package/dist/components/actions/Menu/MenuTrigger.js.map +1 -1
- package/dist/components/actions/Menu/SubMenuTrigger.js +1 -1
- package/dist/components/actions/Menu/SubmenuTriggerContext.js +1 -1
- package/dist/components/actions/Menu/context.js +1 -1
- package/dist/components/actions/Menu/styled.js +1 -1
- package/dist/components/actions/index.js +1 -1
- package/dist/components/actions/use-action.js +1 -1
- package/dist/components/actions/use-action.js.map +1 -1
- package/dist/components/actions/use-anchored-menu.js +1 -1
- package/dist/components/actions/use-context-menu.js +1 -1
- package/dist/components/content/ActiveZone/ActiveZone.js +1 -1
- package/dist/components/content/Alert/Alert.js +1 -1
- package/dist/components/content/Alert/use-alert.js +1 -1
- package/dist/components/content/Avatar/Avatar.js +1 -1
- package/dist/components/content/Badge/Badge.js +1 -1
- package/dist/components/content/Card/Card.js +1 -1
- package/dist/components/content/Content.js +1 -1
- package/dist/components/content/CopyPasteBlock/CopyPasteBlock.js +1 -1
- package/dist/components/content/CopySnippet/CopySnippet.js +4 -4
- package/dist/components/content/CopySnippet/CopySnippet.js.map +1 -1
- package/dist/components/content/Disclosure/Disclosure.js +1 -1
- package/dist/components/content/Divider.js +1 -1
- package/dist/components/content/Footer.js +1 -1
- package/dist/components/content/Header.js +1 -1
- package/dist/components/content/HotKeys/HotKeys.js +1 -1
- package/dist/components/content/InlineInput/InlineInput.js +1 -1
- package/dist/components/content/Item/Item.js +1 -1
- package/dist/components/content/ItemBadge/ItemBadge.js +1 -1
- package/dist/components/content/ItemCard/ItemCard.js +1 -1
- package/dist/components/content/Layout/GridLayout.js +1 -1
- package/dist/components/content/Layout/Layout.js +1 -1
- package/dist/components/content/Layout/LayoutBlock.js +1 -1
- package/dist/components/content/Layout/LayoutCenter.js +1 -1
- package/dist/components/content/Layout/LayoutContainer.js +1 -1
- package/dist/components/content/Layout/LayoutContent.js +1 -1
- package/dist/components/content/Layout/LayoutContext.js +1 -1
- package/dist/components/content/Layout/LayoutFlex.js +1 -1
- package/dist/components/content/Layout/LayoutFooter.js +1 -1
- package/dist/components/content/Layout/LayoutGrid.js +1 -1
- package/dist/components/content/Layout/LayoutHeader.js +1 -1
- package/dist/components/content/Layout/LayoutPane.js +1 -1
- package/dist/components/content/Layout/LayoutPanel.js +1 -1
- package/dist/components/content/Layout/LayoutPanelHeader.js +1 -1
- package/dist/components/content/Layout/LayoutToolbar.js +1 -1
- package/dist/components/content/Layout/hooks/useTinyScrollbar.js +1 -1
- package/dist/components/content/Layout/index.js +1 -1
- package/dist/components/content/Layout/utils.js +1 -1
- package/dist/components/content/Paragraph.js +1 -1
- package/dist/components/content/Placeholder/Placeholder.js +1 -1
- package/dist/components/content/PrismCode/PrismCode.d.ts +0 -1
- package/dist/components/content/PrismCode/PrismCode.js +2 -7
- package/dist/components/content/PrismCode/PrismCode.js.map +1 -1
- package/dist/components/content/PrismCode/prismSetup.js +1 -1
- package/dist/components/content/PrismDiffCode/PrismDiffCode.js +1 -1
- package/dist/components/content/Result/Result.js +1 -1
- package/dist/components/content/Skeleton/Skeleton.js +1 -1
- package/dist/components/content/Tag/Tag.js +1 -1
- package/dist/components/content/Text.d.ts +7 -7
- package/dist/components/content/Text.js +1 -1
- package/dist/components/content/TextItem/TextItem.js +1 -1
- package/dist/components/content/Title.js +1 -1
- package/dist/components/content/Tree/Tree.js +1 -1
- package/dist/components/content/Tree/TreeNode.js +1 -1
- package/dist/components/content/Tree/styled.js +1 -1
- package/dist/components/content/Tree/tree-index.js +1 -1
- package/dist/components/content/Tree/use-checkbox-tree.js +1 -1
- package/dist/components/content/Tree/use-load-data.js +1 -1
- package/dist/components/content/highlightText.js +1 -1
- package/dist/components/content/use-auto-tooltip.js +1 -1
- package/dist/components/fields/Checkbox/Checkbox.js +1 -1
- package/dist/components/fields/Checkbox/CheckboxGroup.js +1 -1
- package/dist/components/fields/Checkbox/context.js +1 -1
- package/dist/components/fields/ComboBox/ComboBox.js +1 -1
- package/dist/components/fields/CommandTextArea/CommandTextArea.js +1 -1
- package/dist/components/fields/CommandTextArea/caretPosition.js +2 -2
- package/dist/components/fields/CommandTextArea/caretPosition.js.map +1 -1
- package/dist/components/fields/CommandTextArea/useCaretAnchor.js +1 -1
- package/dist/components/fields/DatePicker/DateInput.js +1 -1
- package/dist/components/fields/DatePicker/DateInputBase.js +1 -1
- package/dist/components/fields/DatePicker/DatePicker.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerButton.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerElement.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerInput.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerSegment.js +1 -1
- package/dist/components/fields/DatePicker/DateRangePicker.js +1 -1
- package/dist/components/fields/DatePicker/DateRangeSeparatedPicker.js +1 -1
- package/dist/components/fields/DatePicker/TimeInput.js +1 -1
- package/dist/components/fields/DatePicker/parseDate.js +1 -1
- package/dist/components/fields/DatePicker/props.js +1 -1
- package/dist/components/fields/DatePicker/utils.js +1 -1
- package/dist/components/fields/FileInput/FileInput.js +1 -1
- package/dist/components/fields/FilterListBox/FilterListBox.js +1 -1
- package/dist/components/fields/FilterPicker/FilterPicker.js +1 -1
- package/dist/components/fields/Input/Input.js +1 -1
- package/dist/components/fields/ListBox/DraggableListBox.js +1 -1
- package/dist/components/fields/ListBox/ListBox.js +1 -1
- package/dist/components/fields/ListBoxPopover/ListBoxPopover.js +1 -1
- package/dist/components/fields/ListBoxPopover/listNavigation.js +1 -1
- package/dist/components/fields/ListBoxPopover/useCompositeFocus.js +1 -1
- package/dist/components/fields/NumberInput/NumberInput.js +1 -1
- package/dist/components/fields/NumberInput/StepButton.js +1 -1
- package/dist/components/fields/PasswordInput/PasswordInput.js +1 -1
- package/dist/components/fields/Picker/Picker.js +1 -1
- package/dist/components/fields/RadioGroup/Radio.js +1 -1
- package/dist/components/fields/RadioGroup/RadioGroup.js +1 -1
- package/dist/components/fields/RadioGroup/context.js +1 -1
- package/dist/components/fields/SearchComboBox/SearchComboBox.js +1 -1
- package/dist/components/fields/SearchInput/SearchInput.js +1 -1
- package/dist/components/fields/Select/Select.js +1 -1
- package/dist/components/fields/Slider/Gradation.js +1 -1
- package/dist/components/fields/Slider/HueSlider.js +1 -1
- package/dist/components/fields/Slider/RangeSlider.js +1 -1
- package/dist/components/fields/Slider/Slider.js +1 -1
- package/dist/components/fields/Slider/SliderBase.js +1 -1
- package/dist/components/fields/Slider/SliderThumb.js +1 -1
- package/dist/components/fields/Slider/SliderTrack.js +1 -1
- package/dist/components/fields/Slider/elements.js +1 -1
- package/dist/components/fields/Slider/index.js +1 -1
- package/dist/components/fields/Switch/Switch.js +1 -1
- package/dist/components/fields/TextArea/TextArea.js +1 -1
- package/dist/components/fields/TextInput/TextInput.js +1 -1
- package/dist/components/fields/TextInput/TextInputBase.js +1 -1
- package/dist/components/fields/TextInputMapper/TextInputMapper.js +1 -1
- package/dist/components/form/FieldWrapper/FieldWrapper.js +1 -1
- package/dist/components/form/FieldWrapper/extract-field-wrapper-props.js +1 -1
- package/dist/components/form/Form/Field.js +1 -1
- package/dist/components/form/Form/Form.js +1 -1
- package/dist/components/form/Form/ResetButton/ResetButton.js +1 -1
- package/dist/components/form/Form/SubmitButton/SubmitButton.js +1 -1
- package/dist/components/form/Form/SubmitError.js +1 -1
- package/dist/components/form/Form/index.js +1 -1
- package/dist/components/form/Form/use-field/use-field-props.js +1 -1
- package/dist/components/form/Form/use-field/use-field.js +1 -1
- package/dist/components/form/Form/use-form.js +1 -1
- package/dist/components/form/Form/validation.js +1 -1
- package/dist/components/form/Label.js +1 -1
- package/dist/components/form/wrapper.js +1 -1
- package/dist/components/helpers/DisplayTransition/DisplayTransition.js +1 -1
- package/dist/components/helpers/IconSwitch/IconSwitch.js +1 -1
- package/dist/components/layout/Board/Board.js +1 -1
- package/dist/components/layout/Board/BoardProvider.js +1 -1
- package/dist/components/layout/Board/BoardResponsive.js +1 -1
- package/dist/components/layout/Board/Widget.js +1 -1
- package/dist/components/layout/Board/WidgetHost.js +1 -1
- package/dist/components/layout/Board/board-context.js +1 -1
- package/dist/components/layout/Board/board-store.js +1 -1
- package/dist/components/layout/Board/grid-core/calculate.js +1 -1
- package/dist/components/layout/Board/grid-core/collision.js +1 -1
- package/dist/components/layout/Board/grid-core/compactors.js +1 -1
- package/dist/components/layout/Board/grid-core/constraints.js +1 -1
- package/dist/components/layout/Board/grid-core/layout.js +1 -1
- package/dist/components/layout/Board/grid-core/sort.js +1 -1
- package/dist/components/layout/Board/index.js +1 -1
- package/dist/components/layout/Board/responsive-utils.js +1 -1
- package/dist/components/layout/Board/use-board-layout.js +1 -1
- package/dist/components/layout/Board/use-board-registry.js +1 -1
- package/dist/components/layout/Flex.js +1 -1
- package/dist/components/layout/Flow.js +1 -1
- package/dist/components/layout/Grid.js +1 -1
- package/dist/components/layout/Panel.js +1 -1
- package/dist/components/layout/Prefix.js +1 -1
- package/dist/components/layout/ResizablePanel.js +1 -1
- package/dist/components/layout/Space.js +1 -1
- package/dist/components/layout/Suffix.js +1 -1
- package/dist/components/navigation/Tabs/DraggableTabList.js +1 -1
- package/dist/components/navigation/Tabs/TabButton.js +1 -1
- package/dist/components/navigation/Tabs/TabDropIndicator.js +1 -1
- package/dist/components/navigation/Tabs/TabPanel.js +1 -1
- package/dist/components/navigation/Tabs/TabPicker.js +1 -1
- package/dist/components/navigation/Tabs/Tabs.js +1 -1
- package/dist/components/navigation/Tabs/TabsAction.js +1 -1
- package/dist/components/navigation/Tabs/TabsContext.js +1 -1
- package/dist/components/navigation/Tabs/popover-placement.js +1 -1
- package/dist/components/navigation/Tabs/styled.js +1 -1
- package/dist/components/navigation/Tabs/types.js +1 -1
- package/dist/components/navigation/Tabs/use-tab-editing.js +1 -1
- package/dist/components/navigation/Tabs/use-tab-indicator.js +1 -1
- package/dist/components/organisms/FileTabs/FileTabs.js +1 -1
- package/dist/components/organisms/StatsCard/StatsCard.js +1 -1
- package/dist/components/other/Calendar/Calendar.js +1 -1
- package/dist/components/other/Calendar/CalendarCell.js +1 -1
- package/dist/components/other/Calendar/CalendarGrid.js +1 -1
- package/dist/components/other/Calendar/RangeCalendar.js +1 -1
- package/dist/components/other/CloudLogo/CloudLogo.js +1 -1
- package/dist/components/overlays/AlertDialog/AlertDialog.js +1 -1
- package/dist/components/overlays/AlertDialog/AlertDialogApiProvider.js +1 -1
- package/dist/components/overlays/AlertDialog/AlertDialogZone.js +1 -1
- package/dist/components/overlays/Dialog/Dialog.js +1 -1
- package/dist/components/overlays/Dialog/DialogContainer.js +1 -1
- package/dist/components/overlays/Dialog/DialogForm.js +1 -1
- package/dist/components/overlays/Dialog/DialogTrigger.js +1 -1
- package/dist/components/overlays/Dialog/context.js +1 -1
- package/dist/components/overlays/Dialog/use-dialog-container.js +1 -1
- package/dist/components/overlays/Modal/Modal.js +1 -1
- package/dist/components/overlays/Modal/OpenTransitionContext.js +1 -1
- package/dist/components/overlays/Modal/Overlay.js +1 -1
- package/dist/components/overlays/Modal/Popover.js +1 -1
- package/dist/components/overlays/Modal/Tray.js +1 -1
- package/dist/components/overlays/Modal/Underlay.js +1 -1
- package/dist/components/overlays/Notifications/Notification.js +1 -1
- package/dist/components/overlays/Notifications/NotificationAction.js +1 -1
- package/dist/components/overlays/Notifications/NotificationCard.js +1 -1
- package/dist/components/overlays/Notifications/NotificationContext.js +1 -1
- package/dist/components/overlays/Notifications/NotificationItem.js +1 -1
- package/dist/components/overlays/Notifications/OverlayContainer.js +1 -1
- package/dist/components/overlays/Notifications/OverlayProvider.js +1 -1
- package/dist/components/overlays/Notifications/PersistentNotificationsList.js +1 -1
- package/dist/components/overlays/Notifications/dismissed-storage.js +1 -1
- package/dist/components/overlays/Notifications/format-relative-time.js +1 -1
- package/dist/components/overlays/Notifications/index.js +1 -1
- package/dist/components/overlays/Notifications/use-notification-state.js +1 -1
- package/dist/components/overlays/Notifications/use-notifications.js +1 -1
- package/dist/components/overlays/Notifications/use-overlay-timers.js +1 -1
- package/dist/components/overlays/Notifications/use-persistent-notifications.js +1 -1
- package/dist/components/overlays/Notifications/use-persistent-state.js +1 -1
- package/dist/components/overlays/Notifications/use-toast-state.js +1 -1
- package/dist/components/overlays/Toast/ToastItem.js +1 -1
- package/dist/components/overlays/Toast/index.js +1 -1
- package/dist/components/overlays/Toast/useProgressToast.js +1 -1
- package/dist/components/overlays/Toast/useToast.js +1 -1
- package/dist/components/overlays/Tooltip/Tooltip.js +1 -1
- package/dist/components/overlays/Tooltip/TooltipProvider.js +1 -1
- package/dist/components/overlays/Tooltip/TooltipTrigger.js +1 -1
- package/dist/components/overlays/Tooltip/context.js +1 -1
- package/dist/components/portal/Portal.js +1 -1
- package/dist/components/portal/PortalProvider.js +1 -1
- package/dist/components/portal/usePortal.js +1 -1
- package/dist/components/shared/DraggableCollection.js +1 -1
- package/dist/components/shared/InvalidIcon.js +1 -1
- package/dist/components/shared/ValidIcon.js +1 -1
- package/dist/components/status/LoadingAnimation/LoadingAnimation.js +1 -1
- package/dist/components/status/Spin/Cube.js +1 -1
- package/dist/components/status/Spin/InternalSpinner.js +1 -1
- package/dist/components/status/Spin/Spin.js +1 -1
- package/dist/components/status/Spin/SpinsContainer.js +1 -1
- package/dist/data/item-themes.js +1 -1
- package/dist/data/themes.js +1 -1
- package/dist/i18n/I18nProvider.js +1 -1
- package/dist/i18n/createFormatter.js +1 -1
- package/dist/i18n/index.js +1 -1
- package/dist/i18n/instance.js +1 -1
- package/dist/i18n/locales/de-DE/uikit.js +1 -1
- package/dist/i18n/locales/en-US/uikit.js +1 -1
- package/dist/i18n/locales/es-ES/uikit.js +1 -1
- package/dist/i18n/locales/es-MX/uikit.js +1 -1
- package/dist/i18n/locales/fr-FR/uikit.js +1 -1
- package/dist/i18n/locales/it-IT/uikit.js +1 -1
- package/dist/i18n/locales/ja-JP/uikit.js +1 -1
- package/dist/i18n/locales/nb-NO/uikit.js +1 -1
- package/dist/i18n/locales/pt-BR/uikit.js +1 -1
- package/dist/i18n/locales/pt-PT/uikit.js +1 -1
- package/dist/i18n/locales/sv-SE/uikit.js +1 -1
- package/dist/i18n/locales/vi-VN/uikit.js +1 -1
- package/dist/i18n/locales.js +1 -1
- package/dist/i18n/useFormatter.js +1 -1
- package/dist/i18n/useI18n.js +1 -1
- package/dist/icons/AdjustmentsHorizontalIcon.js +1 -1
- package/dist/icons/AdjustmentsIcon.js +1 -1
- package/dist/icons/AiIcon.js +1 -1
- package/dist/icons/AreaChartIcon.js +1 -1
- package/dist/icons/BackwardIcon.js +1 -1
- package/dist/icons/BarChartIcon.js +1 -1
- package/dist/icons/BellFilledIcon.js +1 -1
- package/dist/icons/BellIcon.js +1 -1
- package/dist/icons/BooleanIcon.js +1 -1
- package/dist/icons/CalendarEditIcon.js +1 -1
- package/dist/icons/CalendarIcon.js +1 -1
- package/dist/icons/CaretDownIcon.js +1 -1
- package/dist/icons/CaretUpIcon.js +1 -1
- package/dist/icons/ChartAreaStackedIcon.js +1 -1
- package/dist/icons/ChartAreaStackedPercentageIcon.js +1 -1
- package/dist/icons/ChartBarGroupedHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarGroupedIcon.js +1 -1
- package/dist/icons/ChartBarHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarLineIcon.js +1 -1
- package/dist/icons/ChartBarStackedHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarStackedIcon.js +1 -1
- package/dist/icons/ChartBarStackedPercentageHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarStackedPercentageIcon.js +1 -1
- package/dist/icons/ChartBoxPlot2Icon.js +1 -1
- package/dist/icons/ChartBoxPlotIcon.js +1 -1
- package/dist/icons/ChartBubbleIcon.js +1 -1
- package/dist/icons/ChartDonut2Icon.js +1 -1
- package/dist/icons/ChartFunnelIcon.js +1 -1
- package/dist/icons/ChartHeatmapIcon.js +1 -1
- package/dist/icons/ChartKPIIcon.js +1 -1
- package/dist/icons/ChartPie2Icon.js +1 -1
- package/dist/icons/ChartScatterIcon.js +1 -1
- package/dist/icons/CheckCircleFilledIcon.js +1 -1
- package/dist/icons/CheckCircleIcon.js +1 -1
- package/dist/icons/CheckIcon.js +1 -1
- package/dist/icons/CircleFilledIcon.js +1 -1
- package/dist/icons/ClearIcon.js +1 -1
- package/dist/icons/CloseCircleFilledIcon.js +1 -1
- package/dist/icons/CloseCircleIcon.js +1 -1
- package/dist/icons/CloseIcon.js +1 -1
- package/dist/icons/CodeIcon.js +1 -1
- package/dist/icons/ColumnTotalIcon.js +1 -1
- package/dist/icons/CopyIcon.js +1 -1
- package/dist/icons/CountIcon.js +1 -1
- package/dist/icons/CubeIcon.js +1 -1
- package/dist/icons/CubePauseIcon.js +1 -1
- package/dist/icons/CubePlayIcon.js +1 -1
- package/dist/icons/CurrencyDollarIcon.js +1 -1
- package/dist/icons/DangerIcon.js +1 -1
- package/dist/icons/DashboardIcon.js +1 -1
- package/dist/icons/DatabaseIcon.js +1 -1
- package/dist/icons/DecimalDecreaseIcon.js +1 -1
- package/dist/icons/DecimalIncreaseIcon.js +1 -1
- package/dist/icons/DirectionIcon.js +1 -1
- package/dist/icons/DonutIcon.js +1 -1
- package/dist/icons/DownIcon.js +1 -1
- package/dist/icons/EditIcon.js +1 -1
- package/dist/icons/ExclamationCircleFilledIcon.js +1 -1
- package/dist/icons/ExclamationCircleIcon.js +1 -1
- package/dist/icons/ExclamationIcon.js +1 -1
- package/dist/icons/EyeIcon.js +1 -1
- package/dist/icons/EyeInvisibleIcon.js +1 -1
- package/dist/icons/FilterIcon.js +1 -1
- package/dist/icons/FolderFilledIcon.js +1 -1
- package/dist/icons/FolderIcon.js +1 -1
- package/dist/icons/FolderOpenFilledIcon.js +1 -1
- package/dist/icons/FolderOpenIcon.js +1 -1
- package/dist/icons/ForwardIcon.js +1 -1
- package/dist/icons/GripVerticalIcon.js +1 -1
- package/dist/icons/HierarchyIcon.js +1 -1
- package/dist/icons/HierarchyOpenIcon.js +1 -1
- package/dist/icons/Icon.js +1 -1
- package/dist/icons/InfoCircleIcon.js +1 -1
- package/dist/icons/InfoIcon.js +1 -1
- package/dist/icons/KeyIcon.js +1 -1
- package/dist/icons/LeftIcon.js +1 -1
- package/dist/icons/LineChartIcon.js +1 -1
- package/dist/icons/LoadingIcon.js +1 -1
- package/dist/icons/LockFilledIcon.js +1 -1
- package/dist/icons/LockIcon.js +1 -1
- package/dist/icons/MoreIcon.js +1 -1
- package/dist/icons/NotAllowedIcon.js +1 -1
- package/dist/icons/Number123Icon.js +1 -1
- package/dist/icons/NumberIcon.js +1 -1
- package/dist/icons/PauseCircleFilledIcon.js +1 -1
- package/dist/icons/PauseCircleIcon.js +1 -1
- package/dist/icons/PauseIcon.js +1 -1
- package/dist/icons/PercentageIcon.js +1 -1
- package/dist/icons/PieChartIcon.js +1 -1
- package/dist/icons/PlayCircleIcon.js +1 -1
- package/dist/icons/PlayIcon.js +1 -1
- package/dist/icons/PlusIcon.js +1 -1
- package/dist/icons/ProgressBarIcon.js +1 -1
- package/dist/icons/ReloadIcon.js +1 -1
- package/dist/icons/ReportIcon.js +1 -1
- package/dist/icons/ReturnIcon.js +1 -1
- package/dist/icons/RightIcon.js +1 -1
- package/dist/icons/RowTotalsIcon.js +1 -1
- package/dist/icons/SchemeIcon.js +1 -1
- package/dist/icons/SearchIcon.js +1 -1
- package/dist/icons/SemanticQueryIcon.js +1 -1
- package/dist/icons/SettingsIcon.js +1 -1
- package/dist/icons/ShieldFilledIcon.js +1 -1
- package/dist/icons/ShieldIcon.js +1 -1
- package/dist/icons/SlashIcon.js +1 -1
- package/dist/icons/SparklesIcon.js +1 -1
- package/dist/icons/SqlIcon.js +1 -1
- package/dist/icons/StatsIcon.js +1 -1
- package/dist/icons/StopIcon.js +1 -1
- package/dist/icons/StringIcon.js +1 -1
- package/dist/icons/SubtotalsIcon.js +1 -1
- package/dist/icons/SwitchIcon.js +1 -1
- package/dist/icons/TableIcon.js +1 -1
- package/dist/icons/ThumbsDownIcon.js +1 -1
- package/dist/icons/ThumbsUpIcon.js +1 -1
- package/dist/icons/ThunderboltCrossedIcon.js +1 -1
- package/dist/icons/ThunderboltFilledIcon.js +1 -1
- package/dist/icons/ThunderboltIcon.js +1 -1
- package/dist/icons/TimeIcon.js +1 -1
- package/dist/icons/TrashIcon.js +1 -1
- package/dist/icons/UnlockIcon.js +1 -1
- package/dist/icons/UpIcon.js +1 -1
- package/dist/icons/UserGroupIcon.js +1 -1
- package/dist/icons/UserIcon.js +1 -1
- package/dist/icons/UserLockIcon.js +1 -1
- package/dist/icons/ViewIcon.js +1 -1
- package/dist/icons/WarningFilledIcon.js +1 -1
- package/dist/icons/WarningIcon.js +1 -1
- package/dist/icons/wrap-icon.js +1 -1
- package/dist/index.d.ts +3 -4
- package/dist/index.js +4 -5
- package/dist/index.js.map +1 -1
- package/dist/provider.js +1 -1
- package/dist/providers/TrackingProvider.js +1 -1
- package/dist/providers/navigationAdapter.default.js +1 -1
- package/dist/tokens/base.js +1 -1
- package/dist/tokens/colors.d.ts +7 -2
- package/dist/tokens/colors.js +8 -16
- package/dist/tokens/colors.js.map +1 -1
- package/dist/tokens/index.d.ts +17 -5
- package/dist/tokens/index.js +13 -23
- package/dist/tokens/index.js.map +1 -1
- package/dist/tokens/layout.js +1 -1
- package/dist/tokens/palette.js +124 -161
- package/dist/tokens/palette.js.map +1 -1
- package/dist/tokens/shadows.js +1 -1
- package/dist/tokens/sizes.js +1 -1
- package/dist/tokens/spacing.js +1 -1
- package/dist/tokens/typography.d.ts +0 -1
- package/dist/tokens/typography.js +1 -29
- package/dist/tokens/typography.js.map +1 -1
- package/dist/utils/ResizeSensor.js +1 -1
- package/dist/utils/is-dev-env.js +1 -1
- package/dist/utils/modules.js +1 -1
- package/dist/utils/promise.js +1 -1
- package/dist/utils/raf.js +1 -1
- package/dist/utils/random.js +1 -1
- package/dist/utils/range.js +1 -1
- package/dist/utils/react/RenderCache.js +1 -1
- package/dist/utils/react/Slots.js +1 -1
- package/dist/utils/react/chain.js +1 -1
- package/dist/utils/react/forwardRefWithGenerics.js +1 -1
- package/dist/utils/react/index.js +1 -1
- package/dist/utils/react/interactions.js +1 -1
- package/dist/utils/react/isTextOnly.js +1 -1
- package/dist/utils/react/mapProps.js +1 -1
- package/dist/utils/react/mergeProps.js +1 -1
- package/dist/utils/react/nullableValue.js +1 -1
- package/dist/utils/react/resolveIcon.js +1 -1
- package/dist/utils/react/sharedStore.js +1 -1
- package/dist/utils/react/useCombinedRefs.js +1 -1
- package/dist/utils/react/useControlledFocusVisible.js +1 -1
- package/dist/utils/react/useEventBus.js +1 -1
- package/dist/utils/react/useId.js +1 -1
- package/dist/utils/react/useIsDarwin.js +1 -1
- package/dist/utils/react/useKeySymbols.js +1 -1
- package/dist/utils/react/useLayoutEffect.js +1 -1
- package/dist/utils/react/useLocalStorage.js +1 -1
- package/dist/utils/react/useMergeStyles.js +1 -1
- package/dist/utils/react/usePopoverSync.js +1 -1
- package/dist/utils/react/useQaProps.js +1 -1
- package/dist/utils/react/useViewportSize.js +1 -1
- package/dist/utils/react/wrapNodeIfPlain.js +1 -1
- package/dist/utils/selection.js +1 -1
- package/dist/utils/styles.js +1 -1
- package/dist/utils/tree.js +1 -1
- package/dist/utils/warnings.js +1 -1
- package/dist/version.js +3 -3
- package/docs/Typography.md +1 -1
- package/docs/Usage.md +0 -10
- package/docs/components/content/CopySnippet.md +1 -6
- package/docs/components/content/PrismCode.md +2 -3
- package/docs/glaze/api.md +414 -951
- package/docs/glaze/methodology.md +212 -512
- package/docs/glaze/migration.md +49 -127
- package/package.json +4 -4
- package/dist/tokens/lazy-styles.js +0 -33
- package/dist/tokens/lazy-styles.js.map +0 -1
- package/dist/tokens/palette.d.ts +0 -15
- package/docs/Colors.md +0 -77
- package/docs/glaze/okhst.md +0 -170
package/docs/glaze/api.md
CHANGED
|
@@ -6,17 +6,12 @@ Full reference for every public method, option, and type exported by `@tenphi/gl
|
|
|
6
6
|
|
|
7
7
|
- [Theme creation](#theme-creation)
|
|
8
8
|
- [Theme methods](#theme-methods)
|
|
9
|
-
- [DTCG](#themedtcgoptions)
|
|
10
|
-
- [DTCG Resolver-Module](#themedtcgresolveroptions)
|
|
11
|
-
- [Tailwind CSS](#themetailwindoptions)
|
|
12
|
-
- [High-contrast pairs](#high-contrast-pairs)
|
|
13
9
|
- [Color definitions](#color-definitions)
|
|
14
10
|
- [Standalone color tokens](#standalone-color-tokens)
|
|
15
11
|
- [Shadows](#shadows)
|
|
16
12
|
- [Mix colors](#mix-colors)
|
|
17
13
|
- [Palette](#palette)
|
|
18
14
|
- [Output formats](#output-formats)
|
|
19
|
-
- [Hue channel splitting](#hue-channel-splitting-splithue)
|
|
20
15
|
- [Adaptation modes](#adaptation-modes)
|
|
21
16
|
- [Light / dark scheme mapping](#light--dark-scheme-mapping)
|
|
22
17
|
- [Configuration](#configuration)
|
|
@@ -28,41 +23,25 @@ Full reference for every public method, option, and type exported by `@tenphi/gl
|
|
|
28
23
|
|
|
29
24
|
## Theme creation
|
|
30
25
|
|
|
31
|
-
| Method
|
|
32
|
-
|
|
33
|
-
| `glaze(hue, saturation?, config?)`
|
|
34
|
-
| `glaze({ hue, saturation }, config?)` | Create a theme from an options object, with optional per-theme config override.
|
|
35
|
-
| `glaze.
|
|
36
|
-
| `glaze.
|
|
37
|
-
| `glaze.
|
|
38
|
-
| `glaze.fromRgb(r, g, b)` | Create a theme from RGB values (0–255). Extracts hue and saturation. |
|
|
39
|
-
| `glaze.paletteFrom(data)` | Create a palette from a `palette.export()` snapshot (`kind: 'palette'`). |
|
|
40
|
-
| `glaze.colorFrom(data)` | Create a color token from a `token.export()` snapshot (`kind: 'color'`). |
|
|
41
|
-
| `glaze.isThemeExport(data)` | Type guard for theme authoring snapshots. |
|
|
42
|
-
| `glaze.isColorTokenExport(data)` | Type guard for color-token authoring snapshots. |
|
|
43
|
-
| `glaze.isPaletteExport(data)` | Type guard for palette authoring snapshots. |
|
|
26
|
+
| Method | Description |
|
|
27
|
+
|---|---|
|
|
28
|
+
| `glaze(hue, saturation?, config?)` | Create a theme from hue (0–360) and saturation (0–100). Optional `config` overrides the global config for this theme. |
|
|
29
|
+
| `glaze({ hue, saturation }, config?)` | Create a theme from an options object, with optional per-theme config override. |
|
|
30
|
+
| `glaze.from(data)` | Create a theme from an exported configuration (`theme.export()` snapshot). |
|
|
31
|
+
| `glaze.fromHex(hex)` | Create a theme from a hex color (`#rgb` or `#rrggbb`). Extracts hue and saturation. |
|
|
32
|
+
| `glaze.fromRgb(r, g, b)` | Create a theme from RGB values (0–255). Extracts hue and saturation. |
|
|
44
33
|
|
|
45
34
|
```ts
|
|
46
35
|
const a = glaze(280, 80);
|
|
47
36
|
const b = glaze({ hue: 280, saturation: 80 });
|
|
48
37
|
const c = glaze.fromHex('#7a4dbf');
|
|
49
38
|
const d = glaze.fromRgb(122, 77, 191);
|
|
50
|
-
const e = glaze.
|
|
39
|
+
const e = glaze.from(a.export());
|
|
51
40
|
|
|
52
41
|
// Per-theme config override:
|
|
53
|
-
const rawTheme = glaze(280, 80, {
|
|
42
|
+
const rawTheme = glaze(280, 80, { lightLightness: false, darkLightness: false });
|
|
54
43
|
```
|
|
55
44
|
|
|
56
|
-
Authoring restore triad (parallel to `.export()` on each instance):
|
|
57
|
-
|
|
58
|
-
| Export | Restore |
|
|
59
|
-
| ------ | ------- |
|
|
60
|
-
| `theme.export()` | `glaze.themeFrom()` |
|
|
61
|
-
| `token.export()` | `glaze.colorFrom()` |
|
|
62
|
-
| `palette.export()` | `glaze.paletteFrom()` |
|
|
63
|
-
|
|
64
|
-
Every snapshot includes `kind` + `version` (`GLAZE_EXPORT_VERSION`, currently `1`). Legacy snapshots without those fields still restore. Wrong `kind`, or a `version` outside `1..=GLAZE_EXPORT_VERSION`, throws.
|
|
65
|
-
|
|
66
45
|
The optional `config` parameter is a `GlazeConfigOverride` — see [Per-instance config override](#per-instance-config-override).
|
|
67
46
|
|
|
68
47
|
---
|
|
@@ -71,41 +50,38 @@ The optional `config` parameter is a `GlazeConfigOverride` — see [Per-instance
|
|
|
71
50
|
|
|
72
51
|
A `GlazeTheme` exposes:
|
|
73
52
|
|
|
74
|
-
| Method
|
|
75
|
-
|
|
76
|
-
| `theme.hue` (readonly)
|
|
77
|
-
| `theme.saturation` (readonly)
|
|
78
|
-
| `theme.colors(defs)`
|
|
79
|
-
| `theme.color(name)`
|
|
80
|
-
| `theme.color(name, def)`
|
|
81
|
-
| `theme.remove(name \| names[])` | Remove one or more color definitions.
|
|
82
|
-
| `theme.has(name)`
|
|
83
|
-
| `theme.list()`
|
|
84
|
-
| `theme.reset()`
|
|
85
|
-
| `theme.export(
|
|
86
|
-
| `theme.extend(options)`
|
|
87
|
-
| `theme.resolve()`
|
|
88
|
-
| `theme.tokens(options?)`
|
|
89
|
-
| `theme.tasty(options?)`
|
|
90
|
-
| `theme.json(options?)`
|
|
91
|
-
| `theme.css(options?)`
|
|
92
|
-
| `theme.dtcg(options?)` | Export one W3C DTCG token tree per scheme. |
|
|
93
|
-
| `theme.dtcgResolver(options?)` | Export one DTCG Resolver-Module document containing every scheme. |
|
|
94
|
-
| `theme.tailwind(options?)` | Export a Tailwind CSS v4 theme and scheme overrides. |
|
|
53
|
+
| Method | Description |
|
|
54
|
+
|---|---|
|
|
55
|
+
| `theme.hue` (readonly) | The hue seed (0–360). |
|
|
56
|
+
| `theme.saturation` (readonly) | The saturation seed (0–100). |
|
|
57
|
+
| `theme.colors(defs)` | Add/replace colors (additive merge — adds new, overwrites existing by name, doesn't remove others). |
|
|
58
|
+
| `theme.color(name)` | Get a color definition by name. |
|
|
59
|
+
| `theme.color(name, def)` | Set a single color definition. |
|
|
60
|
+
| `theme.remove(name \| names[])` | Remove one or more color definitions. |
|
|
61
|
+
| `theme.has(name)` | Check if a color is defined. |
|
|
62
|
+
| `theme.list()` | List all defined color names. |
|
|
63
|
+
| `theme.reset()` | Clear all color definitions. |
|
|
64
|
+
| `theme.export()` | Export the theme configuration as a JSON-safe object. |
|
|
65
|
+
| `theme.extend(options)` | Create a child theme inheriting all color definitions (see [`extend`](#themeextendoptions) below). |
|
|
66
|
+
| `theme.resolve()` | Resolve all colors and return a `Map<string, ResolvedColor>`. |
|
|
67
|
+
| `theme.tokens(options?)` | Export as a flat token map grouped by scheme variant. |
|
|
68
|
+
| `theme.tasty(options?)` | Export as Tasty style-to-state bindings. |
|
|
69
|
+
| `theme.json(options?)` | Export as plain JSON. |
|
|
70
|
+
| `theme.css(options?)` | Export as CSS custom property declarations. |
|
|
95
71
|
|
|
96
72
|
### `theme.colors(defs)`
|
|
97
73
|
|
|
98
74
|
```ts
|
|
99
|
-
theme.colors({ surface: {
|
|
100
|
-
theme.colors({ text: {
|
|
75
|
+
theme.colors({ surface: { lightness: 97 } });
|
|
76
|
+
theme.colors({ text: { lightness: 30 } });
|
|
101
77
|
// Both 'surface' and 'text' are now defined.
|
|
102
78
|
```
|
|
103
79
|
|
|
104
80
|
### `theme.color(name) / theme.color(name, def)`
|
|
105
81
|
|
|
106
82
|
```ts
|
|
107
|
-
theme.color('surface', {
|
|
108
|
-
const def = theme.color('surface');
|
|
83
|
+
theme.color('surface', { lightness: 97, saturation: 0.75 }); // set
|
|
84
|
+
const def = theme.color('surface'); // get
|
|
109
85
|
```
|
|
110
86
|
|
|
111
87
|
### `theme.extend(options)`
|
|
@@ -115,87 +91,73 @@ Creates a new theme inheriting all color definitions, optionally replacing the h
|
|
|
115
91
|
```ts
|
|
116
92
|
const danger = primary.extend({
|
|
117
93
|
hue: 23,
|
|
118
|
-
colors: { 'accent-fill': {
|
|
94
|
+
colors: { 'accent-fill': { lightness: 48, mode: 'fixed' } },
|
|
119
95
|
});
|
|
120
96
|
|
|
121
|
-
// Inherit parent's config override and
|
|
122
|
-
const highSat = base.extend({ config: {
|
|
97
|
+
// Inherit parent's config override and tighten the dark window further:
|
|
98
|
+
const highSat = base.extend({ config: { darkLightness: [10, 100] } });
|
|
123
99
|
```
|
|
124
100
|
|
|
125
101
|
`GlazeExtendOptions`:
|
|
126
102
|
|
|
127
|
-
| Field
|
|
128
|
-
|
|
129
|
-
| `hue`
|
|
130
|
-
| `saturation` | `number`
|
|
131
|
-
| `colors`
|
|
132
|
-
| `config`
|
|
103
|
+
| Field | Type | Description |
|
|
104
|
+
|---|---|---|
|
|
105
|
+
| `hue` | `number` | Replace the hue seed. Defaults to the parent's hue. |
|
|
106
|
+
| `saturation` | `number` | Replace the saturation seed. Defaults to the parent's saturation. |
|
|
107
|
+
| `colors` | `ColorMap` | Per-theme overrides (additive merge over the inherited map). |
|
|
108
|
+
| `config` | `GlazeConfigOverride` | Config override for the child. Shallow-merged with the parent's override — child fields win. |
|
|
133
109
|
|
|
134
110
|
Colors marked with `inherit: false` on the parent are **not** copied into the child.
|
|
135
111
|
|
|
136
|
-
### `theme.resolve()`
|
|
137
|
-
|
|
138
|
-
Resolves the dependency graph and returns a
|
|
139
|
-
`Map<string, ResolvedColor>`. Export methods call it automatically; use it
|
|
140
|
-
directly for tests, diagnostics, or a custom output pipeline.
|
|
141
|
-
|
|
142
|
-
```ts
|
|
143
|
-
const resolved = theme.resolve();
|
|
144
|
-
const surface = resolved.get('surface');
|
|
145
|
-
// surface?.light.t is canonical tone on 0–1.
|
|
146
|
-
```
|
|
147
|
-
|
|
148
112
|
### `theme.tokens(options?)`
|
|
149
113
|
|
|
150
114
|
Flat token map grouped by scheme variant.
|
|
151
115
|
|
|
152
116
|
```ts
|
|
153
|
-
theme.tokens()
|
|
154
|
-
// → { light: { surface: '
|
|
117
|
+
theme.tokens()
|
|
118
|
+
// → { light: { surface: 'okhsl(...)' }, dark: { surface: 'okhsl(...)' } }
|
|
155
119
|
```
|
|
156
120
|
|
|
157
121
|
`GlazeJsonOptions`:
|
|
158
122
|
|
|
159
|
-
| Option
|
|
160
|
-
|
|
161
|
-
| `format` | `'
|
|
162
|
-
| `modes`
|
|
123
|
+
| Option | Default | Description |
|
|
124
|
+
|---|---|---|
|
|
125
|
+
| `format` | `'okhsl'` | Output color format. One of `'okhsl' \| 'rgb' \| 'hsl' \| 'oklch'`. |
|
|
126
|
+
| `modes` | `{ dark: true, highContrast: false }` (or global config) | Which scheme variants to include. |
|
|
163
127
|
|
|
164
128
|
### `theme.tasty(options?)`
|
|
165
129
|
|
|
166
|
-
|
|
130
|
+
Tasty style-to-state bindings for the [Tasty style system](https://tasty.style/docs). Uses `#name` color token keys and state aliases (`''`, `@dark`, etc.).
|
|
167
131
|
|
|
168
132
|
```ts
|
|
169
|
-
theme.tasty()
|
|
133
|
+
theme.tasty()
|
|
170
134
|
// → {
|
|
171
|
-
// '#surface': { '': '
|
|
135
|
+
// '#surface': { '': 'okhsl(...)', '@dark': 'okhsl(...)' },
|
|
172
136
|
// ...
|
|
173
137
|
// }
|
|
174
138
|
```
|
|
175
139
|
|
|
176
140
|
`GlazeTokenOptions`:
|
|
177
141
|
|
|
178
|
-
| Option
|
|
179
|
-
|
|
180
|
-
| `format`
|
|
181
|
-
| `modes`
|
|
182
|
-
| `states.dark`
|
|
183
|
-
| `states.highContrast` | `'@
|
|
184
|
-
| `
|
|
185
|
-
| `name` | `'theme'` | Base name for the theme-level hue var (`$theme-hue` / `--theme-hue`). Palette export auto-derives this from the theme name. |
|
|
186
|
-
| `prefix` | (palette only) | See [Palette](#palette). |
|
|
142
|
+
| Option | Default | Description |
|
|
143
|
+
|---|---|---|
|
|
144
|
+
| `format` | `'okhsl'` | Output color format. |
|
|
145
|
+
| `modes` | global config | Which scheme variants to include. |
|
|
146
|
+
| `states.dark` | `'@dark'` (or global config) | State alias for dark mode tokens. |
|
|
147
|
+
| `states.highContrast` | `'@high-contrast'` (or global config) | State alias for high-contrast tokens. |
|
|
148
|
+
| `prefix` | (palette only) | See [Palette](#palette). |
|
|
187
149
|
|
|
188
|
-
When both `dark` and `highContrast` modes are enabled, dark high-contrast variants are emitted under the combined key `<dark> & <highContrast>` (e.g. `'@
|
|
150
|
+
When both `dark` and `highContrast` modes are enabled, dark high-contrast variants are emitted under the combined key `<dark> & <highContrast>` (e.g. `'@dark & @high-contrast'`).
|
|
189
151
|
|
|
190
152
|
### `theme.json(options?)`
|
|
191
153
|
|
|
192
154
|
Per-color JSON map.
|
|
193
155
|
|
|
194
156
|
```ts
|
|
195
|
-
theme.json()
|
|
157
|
+
theme.json()
|
|
196
158
|
// → {
|
|
197
|
-
// surface: { light: '
|
|
198
|
-
// text: { light: '
|
|
159
|
+
// surface: { light: 'okhsl(...)', dark: 'okhsl(...)' },
|
|
160
|
+
// text: { light: 'okhsl(...)', dark: 'okhsl(...)' },
|
|
199
161
|
// }
|
|
200
162
|
```
|
|
201
163
|
|
|
@@ -208,8 +170,8 @@ CSS custom property declaration strings, grouped by scheme variant.
|
|
|
208
170
|
```ts
|
|
209
171
|
theme.css();
|
|
210
172
|
// → {
|
|
211
|
-
// light: '--surface-color:
|
|
212
|
-
// dark: '--surface-color:
|
|
173
|
+
// light: '--surface-color: rgb(...);\n--text-color: rgb(...);',
|
|
174
|
+
// dark: '--surface-color: rgb(...);\n--text-color: rgb(...);',
|
|
213
175
|
// lightContrast: '...',
|
|
214
176
|
// darkContrast: '...',
|
|
215
177
|
// }
|
|
@@ -217,188 +179,23 @@ theme.css();
|
|
|
217
179
|
|
|
218
180
|
`GlazeCssOptions`:
|
|
219
181
|
|
|
220
|
-
| Option
|
|
221
|
-
|
|
222
|
-
| `format`
|
|
223
|
-
| `suffix`
|
|
224
|
-
| `splitHue` | `false` | Emit hue as a separate `--*-hue` custom property referenced via `var()` in `oklch` color values. Requires `format: 'oklch'` and every color to be pastel. Shadow/mix colors stay inline (blended hue; they do not follow `--hue` rotation). |
|
|
225
|
-
| `name` | `'theme'` | Base name for the theme-level hue var (`--theme-hue`). Palette export auto-derives this from the theme name. |
|
|
182
|
+
| Option | Default | Description |
|
|
183
|
+
|---|---|---|
|
|
184
|
+
| `format` | `'rgb'` | Output color format. |
|
|
185
|
+
| `suffix` | `'-color'` | Suffix appended to each CSS property name. Pass `''` for bare property names. |
|
|
226
186
|
|
|
227
187
|
`GlazeCssResult` always contains all four keys (`light`, `dark`, `lightContrast`, `darkContrast`); empty if no colors are defined for that variant.
|
|
228
188
|
|
|
229
|
-
### `theme.
|
|
230
|
-
|
|
231
|
-
W3C [Design Tokens Format Module (2025.10)](https://www.designtokens.org/) documents — the vendor-neutral JSON format consumed by Figma, Tokens Studio, Style Dictionary v4+, Terrazzo, Penpot, and every DTCG-compatible tool. Returns one spec-conformant token tree per scheme variant.
|
|
232
|
-
|
|
233
|
-
```ts
|
|
234
|
-
theme.dtcg();
|
|
235
|
-
// → {
|
|
236
|
-
// light: {
|
|
237
|
-
// surface: {
|
|
238
|
-
// $type: 'color',
|
|
239
|
-
// $value: { colorSpace: 'srgb', components: [0.96, 0.94, 0.98], hex: '#f5f0fa' },
|
|
240
|
-
// },
|
|
241
|
-
// },
|
|
242
|
-
// dark: {
|
|
243
|
-
// surface: {
|
|
244
|
-
// $type: 'color',
|
|
245
|
-
// $value: { colorSpace: 'srgb', components: [0.16, 0.14, 0.2], hex: '#292333' },
|
|
246
|
-
// },
|
|
247
|
-
// },
|
|
248
|
-
// }
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
Write each document to its own `.tokens.json` file — one file per scheme is the most tool-compatible convention (one per Style Dictionary theme / Tokens Studio set / Figma variable mode).
|
|
252
|
-
|
|
253
|
-
`GlazeDtcgOptions`:
|
|
254
|
-
|
|
255
|
-
| Option | Default | Description |
|
|
256
|
-
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
257
|
-
| `colorSpace` | `'srgb'` | Color space for `$value`. `'srgb'` emits gamma sRGB `components` (0–1) plus a `hex` hint — universally understood. `'oklch'` emits `[L, C, H]` components with no hex — Glaze-native, wide-gamut. |
|
|
258
|
-
| `modes` | global config | Which scheme variants to include. `light` is always present. |
|
|
259
|
-
|
|
260
|
-
`alpha` is included on `$value` only when the color's opacity is below 1. `$type` is always `'color'`.
|
|
261
|
-
|
|
262
|
-
### `theme.dtcgResolver(options?)`
|
|
263
|
-
|
|
264
|
-
A single W3C [DTCG Resolver-Module](https://www.designtokens.org/) document describing **every scheme variant in one file** — an alternative to `dtcg()`'s per-scheme files for tools that resolve sets + modifiers (e.g. Dispersa). The light document becomes `sets.base.sources[0]` (the default context); each other variant becomes a context override on a single `scheme` modifier.
|
|
265
|
-
|
|
266
|
-
```ts
|
|
267
|
-
theme.dtcgResolver({ modes: { highContrast: true } });
|
|
268
|
-
// → {
|
|
269
|
-
// version: '2025.10',
|
|
270
|
-
// sets: {
|
|
271
|
-
// base: {
|
|
272
|
-
// sources: [
|
|
273
|
-
// {
|
|
274
|
-
// surface: {
|
|
275
|
-
// $type: 'color',
|
|
276
|
-
// $value: { colorSpace: 'srgb', components: [0.96, 0.94, 0.98], hex: '#f5f0fa' },
|
|
277
|
-
// },
|
|
278
|
-
// },
|
|
279
|
-
// ],
|
|
280
|
-
// },
|
|
281
|
-
// },
|
|
282
|
-
// modifiers: {
|
|
283
|
-
// scheme: {
|
|
284
|
-
// default: 'light',
|
|
285
|
-
// contexts: {
|
|
286
|
-
// light: [],
|
|
287
|
-
// dark: [
|
|
288
|
-
// {
|
|
289
|
-
// surface: {
|
|
290
|
-
// $type: 'color',
|
|
291
|
-
// $value: { colorSpace: 'srgb', components: [0.16, 0.14, 0.2], hex: '#292333' },
|
|
292
|
-
// },
|
|
293
|
-
// },
|
|
294
|
-
// ],
|
|
295
|
-
// lightContrast: [ /* … */ ],
|
|
296
|
-
// darkContrast: [ /* … */ ],
|
|
297
|
-
// },
|
|
298
|
-
// },
|
|
299
|
-
// },
|
|
300
|
-
// resolutionOrder: [
|
|
301
|
-
// { $ref: '#/sets/base' },
|
|
302
|
-
// { $ref: '#/modifiers/scheme' },
|
|
303
|
-
// ],
|
|
304
|
-
// }
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
**Why one modifier with four contexts.** Glaze resolves `darkContrast` independently — it is not `dark` + `lightContrast` layered. The resolver model composes modifiers additively (last in `resolutionOrder` wins on conflict), so two independent modifiers (`scheme` × `contrast`) would produce wrong values for the dark + high-contrast permutation. One `scheme` modifier with a context per variant keeps every resolved value exact. Choose `dtcgResolver()` when you want single-file theming and feed it to a resolver tool; choose `dtcg()` for maximum per-file tool compatibility.
|
|
308
|
-
|
|
309
|
-
`GlazeDtcgResolverOptions` (extends `GlazeDtcgOptions`, so `modes` and `colorSpace` pass through):
|
|
310
|
-
|
|
311
|
-
| Option | Default | Description |
|
|
312
|
-
| -------------- | ------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
313
|
-
| `colorSpace` | `'srgb'` | Same as `dtcg()` — flows through to every source and context. |
|
|
314
|
-
| `modes` | global config | Which scheme variants to emit as contexts. `light` is always present (the default); absent variants are omitted. |
|
|
315
|
-
| `setName` | `'base'` | Name of the single set holding the default (light) token tree. |
|
|
316
|
-
| `modifierName` | `'scheme'` | Name of the modifier describing the scheme axis. |
|
|
317
|
-
| `contextNames` | identity | Override the four context names (`light` / `dark` / `lightContrast` / `darkContrast`) — e.g. `{ dark: 'night' }`. |
|
|
318
|
-
| `version` | `'2025.10'` | Resolver document version. |
|
|
319
|
-
|
|
320
|
-
### `theme.tailwind(options?)`
|
|
321
|
-
|
|
322
|
-
A Tailwind CSS v4 `@theme` block (light baseline) plus dark / high-contrast overrides under configurable selectors. Returns a single ready-to-paste CSS string. The `--color-*` namespace auto-generates `bg-*` / `text-*` / `border-*` utilities.
|
|
323
|
-
|
|
324
|
-
```css
|
|
325
|
-
@theme {
|
|
326
|
-
--color-surface: oklch(0.96 0.01 280);
|
|
327
|
-
--color-text: oklch(0.3 0.05 280);
|
|
328
|
-
}
|
|
329
|
-
.dark {
|
|
330
|
-
--color-surface: oklch(0.16 0.01 280);
|
|
331
|
-
--color-text: oklch(0.85 0.05 280);
|
|
332
|
-
}
|
|
333
|
-
.high-contrast {
|
|
334
|
-
--color-surface: oklch(0.98 0.01 280);
|
|
335
|
-
--color-text: oklch(0.1 0.05 280);
|
|
336
|
-
}
|
|
337
|
-
.dark.high-contrast {
|
|
338
|
-
--color-surface: oklch(0.05 0.01 280);
|
|
339
|
-
--color-text: oklch(0.95 0.05 280);
|
|
340
|
-
}
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
`GlazeTailwindOptions`:
|
|
344
|
-
|
|
345
|
-
| Option | Default | Description |
|
|
346
|
-
| ---------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
347
|
-
| `format` | `'oklch'` | Output color format for the values. |
|
|
348
|
-
| `namespace` | `'color-'` | CSS custom property namespace, forming `--<namespace><name>` (e.g. `--color-surface`). Named `namespace` to avoid clashing with the palette theme-prefix option. |
|
|
349
|
-
| `darkSelector` | `'.dark'` | Selector wrapping the dark overrides. Pass an at-rule like `'@media (prefers-color-scheme: dark)'` to drive dark mode from the OS preference (it nests `:root` automatically). |
|
|
350
|
-
| `highContrastSelector` | `'.high-contrast'` | Selector wrapping the light high-contrast overrides. The combined dark + high-contrast block uses `${darkSelector}${highContrastSelector}` (e.g. `.dark.high-contrast`). |
|
|
351
|
-
| `modes` | global config | Which scheme variants to include. The `@theme` block (light) is always emitted when colors exist. |
|
|
352
|
-
|
|
353
|
-
### `theme.export(override?)`
|
|
189
|
+
### `theme.export()`
|
|
354
190
|
|
|
355
191
|
```ts
|
|
356
192
|
const snapshot = theme.export();
|
|
357
|
-
// → {
|
|
358
|
-
// kind: 'theme',
|
|
359
|
-
// version: 1,
|
|
360
|
-
// hue: 280,
|
|
361
|
-
// saturation: 80,
|
|
362
|
-
// colors: { surface: { ... }, ... },
|
|
363
|
-
// config: { lightTone: {...}, darkTone: {...}, pastel: false, ... },
|
|
364
|
-
// }
|
|
365
|
-
|
|
366
|
-
const restored = glaze.themeFrom(snapshot);
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
Returns a deep-cloned, JSON-safe authoring snapshot (definitions + frozen
|
|
370
|
-
effective config — not resolved color strings). Freezes
|
|
371
|
-
`getConfig() ∪ instance local ∪ override` at call time. Restored themes pin
|
|
372
|
-
that freeze as their local override. Distinct from `theme.json()`, which
|
|
373
|
-
emits resolved color strings.
|
|
374
|
-
|
|
375
|
-
---
|
|
376
|
-
|
|
377
|
-
## High-contrast pairs
|
|
193
|
+
// → { hue: 280, saturation: 80, colors: { surface: { ... }, ... } }
|
|
378
194
|
|
|
379
|
-
|
|
380
|
-
schemes, or an explicit `[normal, highContrast]` pair:
|
|
381
|
-
|
|
382
|
-
```ts
|
|
383
|
-
type HCPair<T> = T | [T, T];
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
It is used by `tone`, `contrast`, shadow `intensity`, and mix `value`:
|
|
387
|
-
|
|
388
|
-
```ts
|
|
389
|
-
tone: '-8'; // -8 in normal and HC
|
|
390
|
-
tone: ['-8', '-16']; // -8 normal, -16 HC
|
|
391
|
-
contrast: {
|
|
392
|
-
apca: 'content';
|
|
393
|
-
} // preset with automatic HC enhancement
|
|
394
|
-
contrast: {
|
|
395
|
-
apca: ['content', 'body'];
|
|
396
|
-
} // explicit normal/HC targets
|
|
195
|
+
const restored = glaze.from(snapshot);
|
|
397
196
|
```
|
|
398
197
|
|
|
399
|
-
|
|
400
|
-
metric. An explicit HC value disables automatic APCA enhancement or WCAG preset
|
|
401
|
-
promotion for that color.
|
|
198
|
+
The export contains only the configuration — not resolved color values. Resolved values are recomputed on demand.
|
|
402
199
|
|
|
403
200
|
---
|
|
404
201
|
|
|
@@ -412,233 +209,88 @@ type ColorDef = RegularColorDef | ShadowColorDef | MixColorDef;
|
|
|
412
209
|
|
|
413
210
|
### `RegularColorDef`
|
|
414
211
|
|
|
415
|
-
| Field
|
|
416
|
-
|
|
417
|
-
| `
|
|
418
|
-
| `saturation` | `number`
|
|
419
|
-
| `hue`
|
|
420
|
-
| `base`
|
|
421
|
-
| `contrast`
|
|
422
|
-
| `mode`
|
|
423
|
-
| `
|
|
424
|
-
| `
|
|
425
|
-
| `pastel` | `boolean` | Per-color override for the hue-independent "safe" chroma limit used in OKHSL↔sRGB conversions (luminance, contrast solving, output formatting). Falls through to the per-theme / per-token `pastel` override when omitted. Default: unset. See [Per-color `pastel`](#per-color-pastel). |
|
|
426
|
-
| `role` | `RoleInput` | Semantic role against `base` (`'text'` / `'surface'` / `'border'` or an alias). Fixes APCA contrast polarity. Resolved via: explicit `role` → name inference → opposite of the base's role → `'text'`. See [Roles](#roles). |
|
|
427
|
-
| `inherit` | `boolean` | Whether this color is inherited by child themes via `extend()`. Default: `true`. Set to `false` to make the color local to the current theme. |
|
|
428
|
-
|
|
429
|
-
#### Tone values
|
|
430
|
-
|
|
431
|
-
`tone` (0–100) replaces authored OKHSL lightness with a contrast-shaped axis.
|
|
432
|
-
Equal tone differences give equal WCAG contrast for neutrals; chromatic results
|
|
433
|
-
can drift in measured luminance. See [OKHST in Glaze](okhst.md). To port old
|
|
434
|
-
`lightness` values, see [migration.md](migration.md).
|
|
435
|
-
|
|
436
|
-
| Form | Example | Meaning |
|
|
437
|
-
| ------------------- | ----------------------- | --------------------------------------------------------------------------------------------- |
|
|
438
|
-
| Number (absolute) | `tone: 45` | Absolute tone 0–100. |
|
|
439
|
-
| String (tone delta) | `tone: '-52'` | Signed difference from the base color's resolved tone (requires `base`). |
|
|
440
|
-
| Extreme | `tone: 'max'` / `'min'` | Force to the scheme's highest (`'max'` = 100) or lowest (`'min'` = 0) tone. No `base` needed. |
|
|
441
|
-
| HC pair | `tone: ['-7', '-20']` | `[normal, high-contrast]`. A single value applies to both. |
|
|
442
|
-
|
|
443
|
-
**Absolute tone** on a dependent color (`base` set) positions the color independently. In dark mode it is tone-mapped (inverted + windowed) on its own. The `contrast` solver acts as a safety net.
|
|
212
|
+
| Field | Type | Description |
|
|
213
|
+
|---|---|---|
|
|
214
|
+
| `lightness` | `HCPair<number \| RelativeValue>` | Number = absolute (0–100). String (`'+N'`/`'-N'`) = relative to base's lightness (requires `base`). Optional HC pair `[normal, hc]`. |
|
|
215
|
+
| `saturation` | `number` | Saturation factor applied to the seed saturation (0–1). Default: `1`. |
|
|
216
|
+
| `hue` | `number \| RelativeValue` | Number = absolute (0–360). String (`'+N'`/`'-N'`) = relative to the **theme seed hue** (never to a base color). |
|
|
217
|
+
| `base` | `string` | Name of another color in the same theme — makes this a *dependent* color. |
|
|
218
|
+
| `contrast` | `HCPair<MinContrast>` | WCAG contrast floor against `base`. Requires `base`. |
|
|
219
|
+
| `mode` | `'auto' \| 'fixed' \| 'static'` | Adaptation mode. Default: `'auto'`. See [Adaptation modes](#adaptation-modes). |
|
|
220
|
+
| `opacity` | `number` | Fixed alpha 0–1. Output includes alpha in the CSS value. Combining with `contrast` is not recommended (a `console.warn` is emitted). |
|
|
221
|
+
| `inherit` | `boolean` | Whether this color is inherited by child themes via `extend()`. Default: `true`. Set to `false` to make the color local to the current theme. |
|
|
444
222
|
|
|
445
|
-
|
|
446
|
-
It gives an exact contrast step for neutrals and a stable visual progression for
|
|
447
|
-
chromatic colors. In dark mode with `mode: 'auto'`, it is anchored to the
|
|
448
|
-
base's per-scheme tone. If `base + delta` falls outside `[0, 100]`, the result
|
|
449
|
-
is clamped to the boundary, or — with `autoFlip` (default on) — mirrored to the
|
|
450
|
-
other side of the base. If the mirrored target is also out of range, the original
|
|
451
|
-
delta is kept and clamped on the authored side.
|
|
223
|
+
#### Lightness values
|
|
452
224
|
|
|
453
|
-
|
|
225
|
+
| Form | Example | Meaning |
|
|
226
|
+
|---|---|---|
|
|
227
|
+
| Number (absolute) | `lightness: 45` | Absolute lightness 0–100. |
|
|
228
|
+
| String (relative) | `lightness: '-52'` | Relative to base color's lightness (requires `base`). |
|
|
229
|
+
| HC pair | `lightness: ['-7', '-20']` | `[normal, high-contrast]`. A single value applies to both. |
|
|
454
230
|
|
|
455
|
-
|
|
231
|
+
**Absolute lightness** on a dependent color (`base` set) positions the color independently. In dark mode it is dark-mapped on its own. The `contrast` solver acts as a safety net.
|
|
456
232
|
|
|
457
|
-
|
|
233
|
+
**Relative lightness** applies a signed delta to the base color's resolved lightness. In dark mode with `mode: 'auto'`, the sign flips automatically so a `'-52'` light-mode offset becomes a `+52` dark-mode offset.
|
|
458
234
|
|
|
459
|
-
`
|
|
235
|
+
A dependent color with `base` but no `lightness` inherits the base's lightness (equivalent to a delta of 0).
|
|
460
236
|
|
|
461
|
-
|
|
462
|
-
- **`contrast` direction:** when the requested tone direction can't meet the floor, `autoFlip` lets the solver try the opposite side (the same behavior as the global `autoFlip`).
|
|
463
|
-
|
|
464
|
-
`autoFlip` defaults to the global `autoFlip` (`true`). Set `autoFlip: false` on a color to clamp instead of mirror — useful when you want a relative offset to stay on the authored side of the base, or to keep an unmet contrast pinned to one direction's extreme.
|
|
465
|
-
|
|
466
|
-
#### `contrast` (floor)
|
|
467
|
-
|
|
468
|
-
```ts
|
|
469
|
-
type ContrastPreset = 'AA' | 'AAA' | 'AA-large' | 'AAA-large';
|
|
470
|
-
type ContrastSpec =
|
|
471
|
-
| number // bare WCAG ratio
|
|
472
|
-
| ContrastPreset // named WCAG preset
|
|
473
|
-
| { wcag: HCPair<number | ContrastPreset> }
|
|
474
|
-
| { apca: HCPair<number> }; // APCA Lc target
|
|
475
|
-
```
|
|
476
|
-
|
|
477
|
-
| Preset | WCAG ratio |
|
|
478
|
-
| ------------- | ---------- |
|
|
479
|
-
| `'AA-large'` | 3 |
|
|
480
|
-
| `'AA'` | 4.5 |
|
|
481
|
-
| `'AAA-large'` | 4.5 |
|
|
482
|
-
| `'AAA'` | 7 |
|
|
483
|
-
|
|
484
|
-
A bare number or preset means **WCAG**. Use `{ wcag }` / `{ apca }` to pick the metric explicitly. The `[normal, highContrast]` pair may live at the outer level (`[4.5, 7]`, `[{ wcag: 4.5 }, { wcag: 7 }]`) or inside the metric (`{ wcag: [4.5, 7] }`, `{ apca: [45, 60] }`).
|
|
237
|
+
#### `contrast` (WCAG floor)
|
|
485
238
|
|
|
486
239
|
```ts
|
|
487
|
-
|
|
488
|
-
contrast: 'AAA'; // WCAG 7
|
|
489
|
-
contrast: {
|
|
490
|
-
wcag: 6;
|
|
491
|
-
} // WCAG 6
|
|
492
|
-
contrast: {
|
|
493
|
-
wcag: [4.5, 7];
|
|
494
|
-
} // WCAG 4.5 normal / 7 high-contrast (explicit)
|
|
495
|
-
contrast: {
|
|
496
|
-
apca: 60;
|
|
497
|
-
} // APCA Lc 60 normal / 75 high-contrast (auto)
|
|
498
|
-
contrast: {
|
|
499
|
-
apca: [45, 60];
|
|
500
|
-
} // APCA Lc 45 normal / 60 high-contrast (explicit)
|
|
501
|
-
contrast: {
|
|
502
|
-
apca: 'content';
|
|
503
|
-
} // APCA preset -> Lc 60 normal / 75 high-contrast (auto)
|
|
504
|
-
contrast: {
|
|
505
|
-
apca: ['content', 'body'];
|
|
506
|
-
} // Lc 60 normal / 75 high-contrast (explicit)
|
|
240
|
+
type MinContrast = number | 'AA' | 'AAA' | 'AA-large' | 'AAA-large';
|
|
507
241
|
```
|
|
508
242
|
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
`AAA-large`
|
|
514
|
-
|
|
515
|
-
via either pair overrides and skips the promotion.
|
|
516
|
-
|
|
517
|
-
**APCA Enhanced Level (HC auto-boost):** a bare APCA scalar (no `[normal, hc]`
|
|
518
|
-
pair at either the outer `contrast` or inner `apca` level) is automatically
|
|
519
|
-
boosted by **+15 Lc** in high-contrast mode, the APCA analog of WCAG's
|
|
520
|
-
AAA-over-AA step. On by default; an explicit HC value via either pair
|
|
521
|
-
overrides it and skips the boost. The enhanced target is clamped to 106 Lc.
|
|
522
|
-
For large/bold text (where APCA caps contrast at Lc 90 to avoid glare), pass
|
|
523
|
-
an explicit HC pair to hold that ceiling.
|
|
524
|
-
|
|
525
|
-
APCA preset keywords (Bronze Simple Mode conformance levels, role-independent):
|
|
526
|
-
`'preferred'` (Lc 90), `'body'` (75), `'content'` (60, ~AA), `'large'` (45, ~3:1),
|
|
527
|
-
`'non-text'` (30), `'min'` (15, point of invisibility).
|
|
528
|
-
|
|
529
|
-
The floor is applied independently per scheme. If the preferred `tone` already
|
|
530
|
-
satisfies it, the tone is kept; otherwise the solver uses the tone-shaped scale
|
|
531
|
-
for a closed-form WCAG seed and fast search until the target is met.
|
|
243
|
+
| Preset | Ratio |
|
|
244
|
+
|---|---|
|
|
245
|
+
| `'AA-large'` | 3 |
|
|
246
|
+
| `'AA'` | 4.5 |
|
|
247
|
+
| `'AAA-large'` | 4.5 |
|
|
248
|
+
| `'AAA'` | 7 |
|
|
532
249
|
|
|
533
|
-
|
|
250
|
+
You can also pass any numeric ratio directly (e.g., `contrast: 4.5`, `contrast: 11`). The constraint is applied independently for each scheme — if the `lightness` already satisfies the floor it's kept, otherwise the solver adjusts lightness until the target is met.
|
|
534
251
|
|
|
535
|
-
|
|
252
|
+
By default, `autoFlip` lets the solver cross to the opposite side of the base color when the requested lightness direction cannot satisfy contrast. Set `glaze.configure({ autoFlip: false })` to keep strict directionality: unmet colors pin to that direction's 0 or 100 lightness extreme instead of falling back to the original requested value.
|
|
536
253
|
|
|
537
|
-
**
|
|
254
|
+
**Full lightness spectrum in HC mode:** in high-contrast variants the `lightLightness` and `darkLightness` window constraints are bypassed entirely. Colors can reach the full 0–100 range, maximizing perceivable contrast.
|
|
538
255
|
|
|
539
256
|
#### Per-color hue override
|
|
540
257
|
|
|
541
258
|
```ts
|
|
542
259
|
const theme = glaze(280, 80);
|
|
543
260
|
theme.colors({
|
|
544
|
-
surface:
|
|
545
|
-
gradientEnd: {
|
|
546
|
-
warning:
|
|
261
|
+
surface: { lightness: 97 },
|
|
262
|
+
gradientEnd: { lightness: 90, hue: '+20' }, // 280 + 20 = 300
|
|
263
|
+
warning: { lightness: 60, hue: 40 }, // absolute
|
|
547
264
|
});
|
|
548
265
|
```
|
|
549
266
|
|
|
550
267
|
Relative hue is always relative to the **theme seed hue**, not to a base color.
|
|
551
268
|
|
|
552
|
-
#### Per-color `pastel`
|
|
553
|
-
|
|
554
|
-
`pastel: true` on a single color def overrides the per-theme / per-token `pastel` override for that color only. It toggles the hue-independent "safe" chroma limit used in every OKHSL↔sRGB conversion that touches this color: luminance calculations during contrast solving, gamut clamping during sRGB blend / mix edges, and output formatting. The effective flag is carried on the resolved variant (`ResolvedColorVariant.pastel`) so formatting matches the gamut mapping applied during resolution.
|
|
555
|
-
|
|
556
|
-
```ts
|
|
557
|
-
const theme = glaze(280, 80);
|
|
558
|
-
theme.colors({
|
|
559
|
-
plain: { tone: 50, saturation: 1 },
|
|
560
|
-
soft: { tone: 50, saturation: 1, pastel: true },
|
|
561
|
-
});
|
|
562
|
-
// theme.resolve().get('soft')!.light.pastel === true
|
|
563
|
-
// theme.css().light contains different rgb() triples for `--plain` and `--soft`
|
|
564
|
-
```
|
|
565
|
-
|
|
566
|
-
Omit the field to inherit the theme/token `pastel` override (default `false`) — useful for keeping the default behavior while opting a single accent into the pastel gamut.
|
|
567
|
-
|
|
568
|
-
The flag is part of the def object, so `extend()` copies it through to child themes alongside the rest of the def. Override it again on the child to flip a single color back:
|
|
569
|
-
|
|
570
|
-
```ts
|
|
571
|
-
const parent = glaze(280, 80);
|
|
572
|
-
parent.colors({ soft: { tone: 50, saturation: 1, pastel: true } });
|
|
573
|
-
|
|
574
|
-
const child = parent.extend({
|
|
575
|
-
colors: { soft: { tone: 50, saturation: 1, pastel: false } },
|
|
576
|
-
});
|
|
577
|
-
// child.resolve().get('soft')!.light.pastel === false
|
|
578
|
-
```
|
|
579
|
-
|
|
580
|
-
> **Note:** Per-color `pastel` is also supported on `ShadowColorDef` and `MixColorDef` (see the tables above). For shadows the math itself happens in OKHSL space, so the flag mainly controls the gamut-mapped output formatting and any luminance verification for that variant.
|
|
581
|
-
>
|
|
582
|
-
> Standalone `glaze.color()` tokens accept the same `pastel` field on both the structured (`GlazeColorInput`) and value-shorthand (`GlazeColorOverrides`) forms, and it survives the `export()` / `glaze.colorFrom()` round-trip.
|
|
583
|
-
|
|
584
|
-
#### Roles
|
|
585
|
-
|
|
586
|
-
A color's `role` describes how it is used against its `base` and fixes **APCA contrast polarity** — which side is the foreground vs the background. APCA is asymmetric (`|apca(a,b)| ≠ |apca(b,a)|`), so the role picks the correct argument order; WCAG is symmetric and unaffected.
|
|
587
|
-
|
|
588
|
-
| Role | Polarity | Use | Aliases (name inference) |
|
|
589
|
-
| ----------- | -------- | ---------------------------------------------------- | ----------------------------------------------------------------- |
|
|
590
|
-
| `'text'` | fg | Text / icons / foreground content | `text`, `fg`, `foreground`, `content`, `ink`, `label`, `stroke` |
|
|
591
|
-
| `'border'` | fg | Non-text spot elements (borders, dividers, outlines) | `border`, `divider`, `outline`, `separator`, `hairline`, `rule` |
|
|
592
|
-
| `'surface'` | bg | Backgrounds / fills | `surface`, `bg`, `background`, `fill`, `canvas`, `paper`, `layer` |
|
|
593
|
-
|
|
594
|
-
Resolution chain (per color):
|
|
595
|
-
|
|
596
|
-
1. Explicit `role` (normalized from an alias) wins.
|
|
597
|
-
2. Else, when `inferRole` is enabled (default), infer from the color name — the **last** recognized token wins (`button-text` → `text`, `input-bg` → `surface`, `card-outline` → `border`).
|
|
598
|
-
3. Else, the opposite of the base's role (a `surface` base ⇒ this is `text`).
|
|
599
|
-
4. Else, `'text'` (foreground) — i.e. the base is treated as the background.
|
|
600
|
-
|
|
601
|
-
```ts
|
|
602
|
-
const theme = glaze(280, 60);
|
|
603
|
-
theme.colors({
|
|
604
|
-
surface: { tone: 90 },
|
|
605
|
-
text: { base: 'surface', contrast: { apca: 'content' } }, // inferred text
|
|
606
|
-
border: { base: 'surface', tone: '-10' }, // inferred border
|
|
607
|
-
});
|
|
608
|
-
// role fixes APCA polarity; set `pastel: true` explicitly if a border
|
|
609
|
-
// needs the hue-independent safe chroma limit.
|
|
610
|
-
```
|
|
611
|
-
|
|
612
|
-
Disable name inference with `glaze.configure({ inferRole: false })` (the base-opposite and foreground-default fallbacks still apply).
|
|
613
|
-
|
|
614
269
|
### `ShadowColorDef`
|
|
615
270
|
|
|
616
|
-
| Field
|
|
617
|
-
|
|
618
|
-
| `type`
|
|
619
|
-
| `bg`
|
|
620
|
-
| `fg`
|
|
621
|
-
| `intensity` | `HCPair<number>` | Shadow intensity, 0–100. Supports HC pairs.
|
|
622
|
-
| `tuning`
|
|
623
|
-
| `
|
|
624
|
-
| `inherit` | `boolean` | Inheritance flag, default `true`. |
|
|
271
|
+
| Field | Type | Description |
|
|
272
|
+
|---|---|---|
|
|
273
|
+
| `type` | `'shadow'` | Discriminator. |
|
|
274
|
+
| `bg` | `string` | Background color name — must reference a non-shadow color in the same theme. |
|
|
275
|
+
| `fg` | `string` | Optional foreground color name for tinting and intensity modulation. Must reference a non-shadow color. Omit for an achromatic shadow at full user-specified intensity. |
|
|
276
|
+
| `intensity` | `HCPair<number>` | Shadow intensity, 0–100. Supports HC pairs. |
|
|
277
|
+
| `tuning` | `ShadowTuning` | Per-color tuning overrides. Merged field-by-field with the global `shadowTuning`. |
|
|
278
|
+
| `inherit` | `boolean` | Inheritance flag, default `true`. |
|
|
625
279
|
|
|
626
280
|
See [Shadows](#shadows) below for the algorithm and tuning details.
|
|
627
281
|
|
|
628
282
|
### `MixColorDef`
|
|
629
283
|
|
|
630
|
-
| Field
|
|
631
|
-
|
|
632
|
-
| `type`
|
|
633
|
-
| `base`
|
|
634
|
-
| `target`
|
|
635
|
-
| `value`
|
|
636
|
-
| `blend`
|
|
637
|
-
| `space`
|
|
638
|
-
| `contrast` | `HCPair<
|
|
639
|
-
| `
|
|
640
|
-
| `role` | `RoleInput` | Semantic role of the mixed result against `base`. Same semantics as `RegularColorDef.role` (see [Roles](#roles)). |
|
|
641
|
-
| `inherit` | `boolean` | Inheritance flag, default `true`. |
|
|
284
|
+
| Field | Type | Description |
|
|
285
|
+
|---|---|---|
|
|
286
|
+
| `type` | `'mix'` | Discriminator. |
|
|
287
|
+
| `base` | `string` | "From" color name. |
|
|
288
|
+
| `target` | `string` | "To" color name. |
|
|
289
|
+
| `value` | `HCPair<number>` | Mix ratio 0–100 (0 = pure base, 100 = pure target). In `'transparent'` blend, this becomes the target's opacity. Supports HC pairs. |
|
|
290
|
+
| `blend` | `'opaque' \| 'transparent'` | Default `'opaque'`. |
|
|
291
|
+
| `space` | `'okhsl' \| 'srgb'` | Interpolation space for opaque blending. Default `'okhsl'`. Ignored for `'transparent'` (always composites in linear sRGB). |
|
|
292
|
+
| `contrast` | `HCPair<MinContrast>` | Optional WCAG floor against `base`. The solver adjusts the mix ratio (opaque) or opacity (transparent). |
|
|
293
|
+
| `inherit` | `boolean` | Inheritance flag, default `true`. |
|
|
642
294
|
|
|
643
295
|
See [Mix colors](#mix-colors) below.
|
|
644
296
|
|
|
@@ -658,149 +310,130 @@ glaze.color(color: GlazeFromInput | GlazeColorInput | GlazeColorValue, config?:
|
|
|
658
310
|
|
|
659
311
|
`glaze.color()` accepts **four input shapes**, discriminated by structure:
|
|
660
312
|
|
|
661
|
-
| Shape
|
|
662
|
-
|
|
663
|
-
| **Bare string**
|
|
664
|
-
| **Value object**
|
|
665
|
-
| **`{ from, ...overrides }`** | `{ from: '#1a1a2e', base: bg, contrast: 'AA' }` | Value + color overrides in one object.
|
|
666
|
-
| **Structured**
|
|
313
|
+
| Shape | Example | Notes |
|
|
314
|
+
|---|---|---|
|
|
315
|
+
| **Bare string** | `'#26fcb2'` | Hex or CSS color function (`rgb()`, `hsl()`, `okhsl()`, `oklch()`). |
|
|
316
|
+
| **Value object** | `{ h: 152, s: 0.95, l: 0.74 }` | OKHSL, `{ r, g, b }` (sRGB 0–255), or `{ l, c, h }` (OKLCh). |
|
|
317
|
+
| **`{ from, ...overrides }`** | `{ from: '#1a1a2e', base: bg, contrast: 'AA' }` | Value + color overrides in one object. |
|
|
318
|
+
| **Structured** | `{ hue: 152, saturation: 95, lightness: 74 }` | Full theme-style token (hue/saturation/lightness all in 0–100). |
|
|
667
319
|
|
|
668
320
|
`GlazeColorValue` (bare string or value-object forms) accepts:
|
|
669
321
|
|
|
670
|
-
| Form
|
|
671
|
-
|
|
672
|
-
| Hex
|
|
673
|
-
| `rgb()`
|
|
674
|
-
| `hsl()`
|
|
675
|
-
| `okhsl()`
|
|
676
|
-
| `
|
|
677
|
-
| `
|
|
678
|
-
| `
|
|
679
|
-
| `
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
|
686
|
-
|
|
|
687
|
-
| `
|
|
688
|
-
| `
|
|
689
|
-
| `
|
|
690
|
-
| `
|
|
691
|
-
| `
|
|
692
|
-
| `
|
|
693
|
-
| `
|
|
694
|
-
| `base` | `GlazeColorToken \| GlazeColorValue` | Optional dependency. See [Pairing colors](#pairing-colors). |
|
|
695
|
-
| `contrast` | `HCPair<ContrastSpec>` | Contrast floor against `base` (WCAG or APCA). Without `base`, anchored to the literal seed. |
|
|
696
|
-
| `pastel` | `boolean` | Per-color `pastel` override. Falls through to the per-theme / per-token `pastel` override when omitted. See [Per-color `pastel`](#per-color-pastel). |
|
|
697
|
-
| `role` | `RoleInput` | Semantic role against `base` / the seed (see [Roles](#roles)). Fixes APCA polarity. |
|
|
698
|
-
| `name` | `string` | Debug label for warnings; doesn't change output keys. Reserved names (`'value'`, `'seed'`, `'externalBase'`) are rejected. |
|
|
322
|
+
| Form | Example | Notes |
|
|
323
|
+
|---|---|---|
|
|
324
|
+
| Hex | `'#26fcb2'`, `'#26fcb2ff'`, `'#abc'` | 3, 6, or 8 digits. Alpha is dropped with a `console.warn` — use `opacity` instead. |
|
|
325
|
+
| `rgb()` | `'rgb(38 252 178)'`, `'rgb(38 252 178 / 0.8)'` | Modern space syntax. Alpha dropped with warning. |
|
|
326
|
+
| `hsl()` | `'hsl(152 97% 57%)'` | Modern space syntax. Alpha dropped with warning. |
|
|
327
|
+
| `okhsl()` | `'okhsl(152 95% 74%)'` | Glaze's own emit format. Alpha dropped with warning. |
|
|
328
|
+
| `oklch()` | `'oklch(0.85 0.18 152)'` | Glaze's own emit format. Alpha dropped with warning. |
|
|
329
|
+
| `OkhslColor` object | `{ h: 152, s: 0.95, l: 0.74 }` | Glaze's native shape (h: 0–360, s/l: 0–1). Passing 0–100 for `s`/`l` throws with a hint to use the structured form. |
|
|
330
|
+
| `RgbColor` object | `{ r: 38, g: 252, b: 178 }` | sRGB 0–255. RGB tuple `[r, g, b]` is not supported — use this object form. |
|
|
331
|
+
| `OklchColor` object | `{ l: 0.85, c: 0.18, h: 152 }` | OKLCh (L/C: 0–1, H: degrees), same semantics as `oklch()` strings. |
|
|
332
|
+
|
|
333
|
+
`GlazeColorInput` (structured form) is `{ hue, saturation, lightness, ... }`:
|
|
334
|
+
|
|
335
|
+
| Field | Type | Description |
|
|
336
|
+
|---|---|---|
|
|
337
|
+
| `hue` | `number` | 0–360. |
|
|
338
|
+
| `saturation` | `number` | 0–100. |
|
|
339
|
+
| `lightness` | `HCPair<number>` | 0–100, optional HC pair. |
|
|
340
|
+
| `saturationFactor` | `number` | Multiplier on the seed (0–1). Default: `1`. |
|
|
341
|
+
| `mode` | `AdaptationMode` | Default: `'auto'`. |
|
|
342
|
+
| `opacity` | `number` | Fixed alpha 0–1. |
|
|
343
|
+
| `base` | `GlazeColorToken \| GlazeColorValue` | Optional dependency. See [Pairing colors](#pairing-colors). |
|
|
344
|
+
| `contrast` | `HCPair<MinContrast>` | WCAG floor against `base`. Without `base`, anchored to the literal seed. |
|
|
345
|
+
| `name` | `string` | Debug label for warnings; doesn't change output keys. Reserved names (`'value'`, `'seed'`, `'externalBase'`) are rejected. |
|
|
699
346
|
|
|
700
347
|
`GlazeFromInput` (from form) is `{ from: GlazeColorValue, ...colorOverrides }`:
|
|
701
348
|
|
|
702
|
-
| Field
|
|
703
|
-
|
|
704
|
-
| `from`
|
|
705
|
-
| `hue`
|
|
706
|
-
| `saturation`
|
|
707
|
-
| `
|
|
708
|
-
| `saturationFactor` | Multiplier on the seed (0–1).
|
|
709
|
-
| `mode`
|
|
710
|
-
| `
|
|
711
|
-
| `
|
|
712
|
-
| `
|
|
713
|
-
| `
|
|
714
|
-
| `pastel` | Per-color `pastel` override. Falls through to the per-theme / per-token `pastel` override when omitted. See [Per-color `pastel`](#per-color-pastel). |
|
|
715
|
-
| `role` | Semantic role against `base` / the seed (see [Roles](#roles)). Fixes APCA polarity. |
|
|
716
|
-
| `name` | Debug label only — surfaces in warnings/errors. Does not change output keys. |
|
|
349
|
+
| Field | Notes |
|
|
350
|
+
|---|---|
|
|
351
|
+
| `from` | **Required.** The source color value — same forms as `GlazeColorValue`. |
|
|
352
|
+
| `hue` | Number (absolute 0–360) or `'+N'`/`'-N'` (relative to seed, never to `base`). |
|
|
353
|
+
| `saturation` | Override seed saturation (0–100). |
|
|
354
|
+
| `lightness` | Number (absolute 0–100) or `'+N'`/`'-N'`. Without `base`, relative anchors to the seed; with `base`, anchors to `base`'s lightness per scheme. |
|
|
355
|
+
| `saturationFactor` | Multiplier on the seed (0–1). |
|
|
356
|
+
| `mode` | `'auto'` (default) / `'fixed'` / `'static'`. |
|
|
357
|
+
| `contrast` | WCAG floor. Without `base`, anchored to the literal seed; with `base`, solved per scheme. |
|
|
358
|
+
| `base` | `GlazeColorToken` or raw `GlazeColorValue`. See [Pairing colors](#pairing-colors). |
|
|
359
|
+
| `opacity` | Fixed alpha 0–1. Combining with `contrast` is not recommended — `console.warn` is emitted. |
|
|
360
|
+
| `name` | Debug label only — surfaces in warnings/errors. Does not change output keys. |
|
|
717
361
|
|
|
718
362
|
Named CSS colors (`'red'`, `'blueviolet'`) are not supported.
|
|
719
363
|
|
|
720
364
|
### Defaults
|
|
721
365
|
|
|
722
|
-
Every input form defaults to `mode: 'auto'` so the resolved token adapts between light and dark like an ordinary theme color.
|
|
366
|
+
Every input form defaults to `mode: 'auto'` so the resolved token adapts between light and dark like an ordinary theme color. The config snapshot taken at create time differs by input form:
|
|
723
367
|
|
|
724
368
|
- **Value-shorthand** (bare strings, value objects, and `{ from, ...overrides }`):
|
|
725
|
-
- Light variant preserves the input
|
|
726
|
-
-
|
|
727
|
-
- **Structured input** (`{ hue, saturation,
|
|
728
|
-
-
|
|
729
|
-
-
|
|
369
|
+
- Light variant preserves the input lightness exactly (`lightLightness: false`).
|
|
370
|
+
- All other config fields (`darkLightness`, `darkDesaturation`, `darkCurve`, `autoFlip`) snapshot from `globalConfig` at create time.
|
|
371
|
+
- **Structured input** (`{ hue, saturation, lightness, ... }`):
|
|
372
|
+
- Both lightness windows snapshot from `globalConfig` at create time (same as a theme color).
|
|
373
|
+
- All fields are **snapshotted at color-creation time** — later `glaze.configure()` calls don't retroactively change existing tokens.
|
|
730
374
|
|
|
731
375
|
```ts
|
|
732
376
|
// Bare string — adapts automatically
|
|
733
|
-
glaze.color('#26fcb2')
|
|
377
|
+
glaze.color('#26fcb2')
|
|
734
378
|
|
|
735
379
|
// Value-object — same behavior
|
|
736
|
-
glaze.color({ h: 152, s: 0.95, l: 0.74 })
|
|
737
|
-
|
|
738
|
-
// OKHST value-object — tone axis
|
|
739
|
-
glaze.color({ h: 152, s: 0.95, t: 0.7 });
|
|
380
|
+
glaze.color({ h: 152, s: 0.95, l: 0.74 })
|
|
740
381
|
|
|
741
382
|
// From form — value + color overrides
|
|
742
|
-
glaze.color({ from: '#1a1a2e', hue: '+20', contrast: 'AA' })
|
|
383
|
+
glaze.color({ from: '#1a1a2e', hue: '+20', contrast: 'AA' })
|
|
743
384
|
|
|
744
|
-
// Structured form — explicit hue/saturation/
|
|
745
|
-
glaze.color({ hue: 152, saturation: 95,
|
|
385
|
+
// Structured form — explicit hue/saturation/lightness (0–100)
|
|
386
|
+
glaze.color({ hue: 152, saturation: 95, lightness: 74 })
|
|
746
387
|
```
|
|
747
388
|
|
|
748
389
|
### Token methods
|
|
749
390
|
|
|
750
391
|
A `GlazeColorToken` exposes:
|
|
751
392
|
|
|
752
|
-
| Method
|
|
753
|
-
|
|
754
|
-
| `token.resolve()`
|
|
755
|
-
| `token.token(options?)`
|
|
756
|
-
| `token.tasty(options?)`
|
|
757
|
-
| `token.json(options?)`
|
|
393
|
+
| Method | Description |
|
|
394
|
+
|---|---|
|
|
395
|
+
| `token.resolve()` | Resolve as a `ResolvedColor` (light/dark/lightContrast/darkContrast variants). |
|
|
396
|
+
| `token.token(options?)` | Flat token map (no color-name key). Options: `format`, `modes`, `states`. |
|
|
397
|
+
| `token.tasty(options?)` | Tasty state map (no color-name key). Same options as `token.token`. |
|
|
398
|
+
| `token.json(options?)` | JSON map (no color-name key). Options: `format`, `modes`. |
|
|
758
399
|
| `token.css({ name, format?, suffix? })` | CSS custom property declarations grouped by scheme variant. `name` is **required** and becomes the variable identifier (`'brand'` → `--brand-color`). Defaults: `format: 'rgb'`, `suffix: '-color'` (matches `theme.css`). |
|
|
759
|
-
| `token.
|
|
760
|
-
| `token.dtcgResolver({ name, ... })` | A single DTCG Resolver-Module document for this color, keyed by `name` across all scheme variants. `name` is **required**. Same options as `theme.dtcgResolver()` plus `name`. |
|
|
761
|
-
| `token.tailwind({ name, ... })` | Tailwind v4 `@theme` block + dark / high-contrast overrides for this color. `name` is **required** (forms `--color-<name>`). Same options as `theme.tailwind()` plus `name`. |
|
|
762
|
-
| `token.export(override?)` | JSON-safe snapshot — freezes effective config at call time; pass to `glaze.colorFrom(...)` to rehydrate. Optional `override` merges over the instance local (and nested `base` exports). |
|
|
400
|
+
| `token.export()` | JSON-safe snapshot — pass to `glaze.colorFrom(...)` to rehydrate. |
|
|
763
401
|
|
|
764
402
|
### Per-instance config override
|
|
765
403
|
|
|
766
|
-
The optional `config` argument (`GlazeConfigOverride`) overrides
|
|
767
|
-
resolve-relevant fields for a token or theme. A tone window can be
|
|
768
|
-
`[lo, hi]`, `{ lo, hi, eps }`, or `false` (full range). Both themes and
|
|
769
|
-
standalone tokens keep a sparse local override — omitted fields (except
|
|
770
|
-
instance-only `pastel`) fall through to the live global at resolve time.
|
|
404
|
+
The optional `config` second argument (`GlazeConfigOverride`) overrides the resolve-relevant global config fields for a single token or theme. Fields that are omitted fall through to the live global config at create time (and are snapshotted). Pass `false` for a lightness window to disable clamping entirely — equivalent to `[0, 100]`.
|
|
771
405
|
|
|
772
406
|
`GlazeConfigOverride`:
|
|
773
407
|
|
|
774
|
-
| Field
|
|
775
|
-
|
|
776
|
-
| `
|
|
777
|
-
| `
|
|
778
|
-
| `darkDesaturation` | `0.1`
|
|
779
|
-
| `
|
|
780
|
-
| `
|
|
781
|
-
| `
|
|
782
|
-
| `shadowTuning` | `undefined` | Default shadow tuning (meaningful for themes; harmless on color tokens). |
|
|
408
|
+
| Field | Default (from global) | Description |
|
|
409
|
+
|---|---|---|
|
|
410
|
+
| `lightLightness` | `[10, 100]` | Light window `[lo, hi]` or `false` (disable clamping = `[0, 100]`). |
|
|
411
|
+
| `darkLightness` | `[15, 95]` | Dark window `[lo, hi]` or `false` (disable clamping). |
|
|
412
|
+
| `darkDesaturation` | `0.1` | Saturation reduction in dark scheme (0–1). |
|
|
413
|
+
| `darkCurve` | `0.5` | Möbius beta for dark `auto`-inversion (0–1). Accepts `[normal, hc]` pair. |
|
|
414
|
+
| `autoFlip` | `true` | When solving `contrast`, allow the solver to switch lightness direction if the requested side can't meet the target. |
|
|
415
|
+
| `shadowTuning` | `undefined` | Default shadow tuning (meaningful for themes; harmless on color tokens). |
|
|
783
416
|
|
|
784
417
|
Config overrides apply to both `glaze.color()` tokens and `glaze()` themes:
|
|
785
418
|
|
|
786
419
|
```ts
|
|
787
|
-
// Standalone color — preserve raw
|
|
788
|
-
glaze.color('#26fcb2', {
|
|
420
|
+
// Standalone color — preserve raw lightness in both schemes
|
|
421
|
+
glaze.color('#26fcb2', { darkLightness: false })
|
|
789
422
|
|
|
790
423
|
// Restore the #000 → white dark flip (full dark range)
|
|
791
424
|
glaze.color('#000000', {
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
})
|
|
425
|
+
lightLightness: false,
|
|
426
|
+
darkLightness: [15, 100],
|
|
427
|
+
})
|
|
795
428
|
|
|
796
429
|
// Structured form with config override
|
|
797
|
-
glaze.color({ hue: 152, saturation: 95,
|
|
430
|
+
glaze.color({ hue: 152, saturation: 95, lightness: 74 }, { darkLightness: false })
|
|
798
431
|
|
|
799
432
|
// Theme with config override
|
|
800
|
-
const rawTheme = glaze(280, 80, {
|
|
433
|
+
const rawTheme = glaze(280, 80, { lightLightness: false })
|
|
801
434
|
```
|
|
802
435
|
|
|
803
|
-
|
|
436
|
+
The override is **snapshotted at create time** so later `glaze.configure()` calls don't change already-created tokens or themes (for non-overridden fields, the snapshot captured the global value at creation time; for themes, non-overridden fields are re-read from the live global at resolve time — see [Theme config override](#theme-config-override)).
|
|
804
437
|
|
|
805
438
|
### Theme config override
|
|
806
439
|
|
|
@@ -810,31 +443,24 @@ When a theme is created with a `GlazeConfigOverride`, the override is **merged o
|
|
|
810
443
|
- Fields you didn't override still react to later `glaze.configure()` calls.
|
|
811
444
|
|
|
812
445
|
```ts
|
|
813
|
-
const t = glaze(280, 80, {
|
|
814
|
-
t.colors({ text: {
|
|
815
|
-
// text.light
|
|
816
|
-
// global lightTone changes.
|
|
446
|
+
const t = glaze(280, 80, { lightLightness: [0, 50] });
|
|
447
|
+
t.colors({ text: { lightness: 50, saturation: 1 } });
|
|
448
|
+
// text.light.l ≈ 0.25 — always, regardless of global lightLightness changes.
|
|
817
449
|
// text.dark.s reacts to glaze.configure({ darkDesaturation }) since it's not overridden.
|
|
818
450
|
```
|
|
819
451
|
|
|
820
452
|
`extend` inherits the parent's override and shallow-merges the child's:
|
|
821
453
|
|
|
822
454
|
```ts
|
|
823
|
-
const child = t.extend({ config: {
|
|
824
|
-
// child:
|
|
455
|
+
const child = t.extend({ config: { darkLightness: false } });
|
|
456
|
+
// child: lightLightness: [0, 50] (inherited) + darkLightness: false (added)
|
|
825
457
|
```
|
|
826
458
|
|
|
827
|
-
`theme.export(
|
|
828
|
-
call time. Restoring via `glaze.themeFrom(data)` (or the compat alias
|
|
829
|
-
`glaze.from`) pins that freeze as the restored theme's local override — matching
|
|
830
|
-
standalone color-token behavior.
|
|
459
|
+
`theme.export()` includes `config`; `glaze.from(data)` restores it.
|
|
831
460
|
|
|
832
461
|
### `glaze.colorFrom(data)`
|
|
833
462
|
|
|
834
|
-
Inverse of `token.export()`. The exported snapshot includes the original input,
|
|
835
|
-
all overrides (with any `base` token recursively serialized), and the effective
|
|
836
|
-
config freeze from export time — so later `glaze.configure()` calls don't change
|
|
837
|
-
rehydrated tokens.
|
|
463
|
+
Inverse of `token.export()`. The exported snapshot includes the original input, all overrides (with any `base` token recursively serialized), and the full effective config — so later `glaze.configure()` calls don't change rehydrated tokens.
|
|
838
464
|
|
|
839
465
|
```ts
|
|
840
466
|
const text = glaze.color({ from: '#1a1a1a', contrast: 'AA' });
|
|
@@ -847,7 +473,7 @@ Both value-form and structured-form tokens round-trip.
|
|
|
847
473
|
|
|
848
474
|
### Pairing colors
|
|
849
475
|
|
|
850
|
-
Set `base` to anchor a standalone color to another standalone color or raw value. The contrast solver and relative `
|
|
476
|
+
Set `base` to anchor a standalone color to another standalone color or raw value. The WCAG contrast solver and relative `lightness` offsets switch their anchor from the literal seed to the base's resolved variant per scheme — so the same text color automatically lands at AA against its background in light, dark, and high-contrast modes.
|
|
851
477
|
|
|
852
478
|
```ts
|
|
853
479
|
const bg = glaze.color('#1a1a2e');
|
|
@@ -855,11 +481,10 @@ const bg = glaze.color('#1a1a2e');
|
|
|
855
481
|
// Text guaranteed AA against `bg` in every scheme.
|
|
856
482
|
const text = glaze.color({ from: '#ffffff', base: bg, contrast: 'AA' });
|
|
857
483
|
|
|
858
|
-
// Border 8
|
|
859
|
-
const border = glaze.color({
|
|
860
|
-
from: '#000000',
|
|
484
|
+
// Border 8 lightness units lighter than `bg` in each scheme.
|
|
485
|
+
const border = glaze.color({ from: '#000000',
|
|
861
486
|
base: bg,
|
|
862
|
-
|
|
487
|
+
lightness: '+8',
|
|
863
488
|
mode: 'fixed',
|
|
864
489
|
});
|
|
865
490
|
|
|
@@ -870,11 +495,11 @@ const text2 = glaze.color({ from: '#ffffff', base: '#1a1a2e', contrast: 'AA' });
|
|
|
870
495
|
Behavior with `base`:
|
|
871
496
|
|
|
872
497
|
- `contrast` is solved per scheme against `base`'s resolved variant (light / dark / lightContrast / darkContrast).
|
|
873
|
-
- Relative `
|
|
498
|
+
- Relative `lightness: '+N'` / `'-N'` is anchored to `base`'s lightness per scheme (matches theme behavior).
|
|
874
499
|
- Relative `hue: '+N'` / `'-N'` still anchors to the **seed** (the value passed to `glaze.color()`), not the base.
|
|
875
500
|
- `mode` works as a per-pair knob.
|
|
876
501
|
- The base token's `.resolve()` is called lazily on the first resolve of the dependent and the result is captured by reference; later mutations to the base don't apply.
|
|
877
|
-
- **Structured bases are resolved at full range for linking math**: when a value/`from` color links to a base created via the structured form, the contrast/
|
|
502
|
+
- **Structured bases are resolved at full range for linking math**: when a value/`from` color links to a base created via the structured form, the contrast/lightness anchor uses the raw input lightness (not the windowed output). This ensures the anchor matches what you intended, not what the light window remapped it to. The base's own `.resolve()` output is unaffected.
|
|
878
503
|
- When the contrast target is physically unreachable, `glaze` emits a single `console.warn` per `(name, scheme, target)` triple and returns the closest passing variant. Use the `name` override to make the warning identifiable.
|
|
879
504
|
|
|
880
505
|
Chains compose:
|
|
@@ -897,8 +522,8 @@ The `name` override appears in `console.warn` / Error messages but **does not**
|
|
|
897
522
|
|
|
898
523
|
```ts
|
|
899
524
|
theme.colors({
|
|
900
|
-
surface: {
|
|
901
|
-
text:
|
|
525
|
+
surface: { lightness: 95 },
|
|
526
|
+
text: { base: 'surface', lightness: '-52', contrast: 'AAA' },
|
|
902
527
|
|
|
903
528
|
'shadow-sm': { type: 'shadow', bg: 'surface', fg: 'text', intensity: 5 },
|
|
904
529
|
'shadow-md': { type: 'shadow', bg: 'surface', fg: 'text', intensity: 10 },
|
|
@@ -937,22 +562,20 @@ theme.colors({
|
|
|
937
562
|
|
|
938
563
|
Fine-tune behavior per-color or globally via `glaze.configure({ shadowTuning })`. Per-color `tuning` is merged field-by-field with the global one.
|
|
939
564
|
|
|
940
|
-
| Parameter
|
|
941
|
-
|
|
942
|
-
| `saturationFactor` | `0.18`
|
|
943
|
-
| `maxSaturation`
|
|
944
|
-
| `lightnessFactor`
|
|
945
|
-
| `lightnessBounds`
|
|
946
|
-
| `minGapTarget`
|
|
947
|
-
| `alphaMax`
|
|
948
|
-
| `bgHueBlend`
|
|
565
|
+
| Parameter | Default | Description |
|
|
566
|
+
|---|---|---|
|
|
567
|
+
| `saturationFactor` | `0.18` | Fraction of fg saturation kept in pigment. |
|
|
568
|
+
| `maxSaturation` | `0.25` | Upper clamp on pigment saturation. |
|
|
569
|
+
| `lightnessFactor` | `0.25` | Multiplier for bg lightness → pigment lightness. |
|
|
570
|
+
| `lightnessBounds` | `[0.05, 0.20]` | Clamp range for pigment lightness. |
|
|
571
|
+
| `minGapTarget` | `0.05` | Target minimum gap between pigment and bg lightness. |
|
|
572
|
+
| `alphaMax` | `1.0` | Asymptotic maximum alpha. |
|
|
573
|
+
| `bgHueBlend` | `0.2` | Blend weight pulling pigment hue toward bg hue. `0` = pure fg hue, `1` = pure bg hue. |
|
|
949
574
|
|
|
950
575
|
```ts
|
|
951
576
|
theme.colors({
|
|
952
577
|
'shadow-soft': {
|
|
953
|
-
type: 'shadow',
|
|
954
|
-
bg: 'surface',
|
|
955
|
-
intensity: 10,
|
|
578
|
+
type: 'shadow', bg: 'surface', intensity: 10,
|
|
956
579
|
tuning: { alphaMax: 0.3, saturationFactor: 0.1 },
|
|
957
580
|
},
|
|
958
581
|
});
|
|
@@ -980,12 +603,12 @@ const css = glaze.format(v, 'oklch');
|
|
|
980
603
|
|
|
981
604
|
`GlazeShadowInput`:
|
|
982
605
|
|
|
983
|
-
| Field
|
|
984
|
-
|
|
985
|
-
| `bg`
|
|
986
|
-
| `fg`
|
|
987
|
-
| `intensity` | `number`
|
|
988
|
-
| `tuning`
|
|
606
|
+
| Field | Type | Description |
|
|
607
|
+
|---|---|---|
|
|
608
|
+
| `bg` | `GlazeColorValue` | Background. Any `GlazeColorValue` form. Alpha components dropped with warning. |
|
|
609
|
+
| `fg` | `GlazeColorValue` | Optional foreground. Same forms as `bg`. |
|
|
610
|
+
| `intensity` | `number` | 0–100. |
|
|
611
|
+
| `tuning` | `ShadowTuning` | Optional. |
|
|
989
612
|
|
|
990
613
|
### Fixed opacity (regular colors)
|
|
991
614
|
|
|
@@ -993,7 +616,7 @@ For a simple fixed-alpha color (no shadow algorithm), use `opacity` on a regular
|
|
|
993
616
|
|
|
994
617
|
```ts
|
|
995
618
|
theme.colors({
|
|
996
|
-
overlay: {
|
|
619
|
+
overlay: { lightness: 0, opacity: 0.5 },
|
|
997
620
|
});
|
|
998
621
|
// → 'oklch(0 0 0 / 0.5)'
|
|
999
622
|
```
|
|
@@ -1008,9 +631,9 @@ Produces a solid color by interpolating between `base` and `target`:
|
|
|
1008
631
|
|
|
1009
632
|
```ts
|
|
1010
633
|
theme.colors({
|
|
1011
|
-
surface: {
|
|
1012
|
-
accent:
|
|
1013
|
-
tint:
|
|
634
|
+
surface: { lightness: 95 },
|
|
635
|
+
accent: { lightness: 30 },
|
|
636
|
+
tint: { type: 'mix', base: 'surface', target: 'accent', value: 30 },
|
|
1014
637
|
});
|
|
1015
638
|
```
|
|
1016
639
|
|
|
@@ -1024,14 +647,11 @@ Produces the target color with controlled opacity — useful for hover overlays:
|
|
|
1024
647
|
|
|
1025
648
|
```ts
|
|
1026
649
|
theme.colors({
|
|
1027
|
-
surface: {
|
|
1028
|
-
black:
|
|
650
|
+
surface: { lightness: 95 },
|
|
651
|
+
black: { lightness: 0, saturation: 0 },
|
|
1029
652
|
hover: {
|
|
1030
|
-
type: 'mix',
|
|
1031
|
-
|
|
1032
|
-
target: 'black',
|
|
1033
|
-
value: 8,
|
|
1034
|
-
blend: 'transparent',
|
|
653
|
+
type: 'mix', base: 'surface', target: 'black',
|
|
654
|
+
value: 8, blend: 'transparent',
|
|
1035
655
|
},
|
|
1036
656
|
});
|
|
1037
657
|
// hover → black with alpha = 0.08
|
|
@@ -1041,10 +661,10 @@ The output color has `h`, `s`, `l` from the target and `alpha = value / 100`.
|
|
|
1041
661
|
|
|
1042
662
|
### Blend space (opaque only)
|
|
1043
663
|
|
|
1044
|
-
| `space`
|
|
1045
|
-
|
|
1046
|
-
| `'okhsl'` (default) | Perceptually uniform OKHSL interpolation. | Design token derivation.
|
|
1047
|
-
| `'srgb'`
|
|
664
|
+
| `space` | Behavior | Best for |
|
|
665
|
+
|---|---|---|
|
|
666
|
+
| `'okhsl'` (default) | Perceptually uniform OKHSL interpolation. | Design token derivation. |
|
|
667
|
+
| `'srgb'` | Linear sRGB channel interpolation. | Matching browser compositing of CSS color-mix / overlay. |
|
|
1048
668
|
|
|
1049
669
|
Transparent blending always composites in linear sRGB (matches browser alpha compositing).
|
|
1050
670
|
|
|
@@ -1075,22 +695,10 @@ Mix colors can reference other mix colors:
|
|
|
1075
695
|
|
|
1076
696
|
```ts
|
|
1077
697
|
theme.colors({
|
|
1078
|
-
white: {
|
|
1079
|
-
black: {
|
|
1080
|
-
gray:
|
|
1081
|
-
|
|
1082
|
-
base: 'white',
|
|
1083
|
-
target: 'black',
|
|
1084
|
-
value: 50,
|
|
1085
|
-
space: 'srgb',
|
|
1086
|
-
},
|
|
1087
|
-
lightGray: {
|
|
1088
|
-
type: 'mix',
|
|
1089
|
-
base: 'white',
|
|
1090
|
-
target: 'gray',
|
|
1091
|
-
value: 50,
|
|
1092
|
-
space: 'srgb',
|
|
1093
|
-
},
|
|
698
|
+
white: { lightness: 100, saturation: 0 },
|
|
699
|
+
black: { lightness: 0, saturation: 0 },
|
|
700
|
+
gray: { type: 'mix', base: 'white', target: 'black', value: 50, space: 'srgb' },
|
|
701
|
+
lightGray: { type: 'mix', base: 'white', target: 'gray', value: 50, space: 'srgb' },
|
|
1094
702
|
});
|
|
1095
703
|
```
|
|
1096
704
|
|
|
@@ -1112,67 +720,35 @@ const palette = glaze.palette(
|
|
|
1112
720
|
|
|
1113
721
|
`GlazePaletteOptions`:
|
|
1114
722
|
|
|
1115
|
-
| Option
|
|
1116
|
-
|
|
723
|
+
| Option | Description |
|
|
724
|
+
|---|---|
|
|
1117
725
|
| `primary` | Name of the primary theme. The primary's tokens are duplicated **without** prefix in all exports, providing convenient short aliases alongside the prefixed versions. Throws if the name doesn't match any theme. |
|
|
1118
726
|
|
|
1119
727
|
A `GlazePalette` exposes:
|
|
1120
728
|
|
|
1121
|
-
| Method
|
|
1122
|
-
|
|
1123
|
-
| `palette.
|
|
1124
|
-
| `palette.
|
|
1125
|
-
| `palette.
|
|
1126
|
-
| `palette.
|
|
1127
|
-
| `palette.export(override?)` | Authoring snapshot — restorable via `glaze.paletteFrom()`. Optional override forwarded to themes. |
|
|
1128
|
-
| `palette.tokens(options?)` | Flat token map grouped by scheme variant. |
|
|
1129
|
-
| `palette.tasty(options?)` | [Tasty](https://tasty.style) style-to-state bindings. |
|
|
1130
|
-
| `palette.json(options?)` | Per-theme **resolved** color JSON (not restorable as authoring config). |
|
|
1131
|
-
| `palette.css(options?)` | CSS custom property declaration strings. |
|
|
1132
|
-
| `palette.dtcg(options?)` | Per-scheme W3C DTCG token trees. |
|
|
1133
|
-
| `palette.dtcgResolver(options?)` | One DTCG Resolver-Module document for every scheme. |
|
|
1134
|
-
| `palette.tailwind(options?)` | One Tailwind CSS v4 theme with scheme overrides. |
|
|
1135
|
-
|
|
1136
|
-
### `palette.export(override?)` / `glaze.paletteFrom()`
|
|
1137
|
-
|
|
1138
|
-
```ts
|
|
1139
|
-
const snapshot = palette.export();
|
|
1140
|
-
// → {
|
|
1141
|
-
// kind: 'palette',
|
|
1142
|
-
// version: 1,
|
|
1143
|
-
// primary: 'brand',
|
|
1144
|
-
// themes: { brand: { kind: 'theme', ... }, danger: { ... } },
|
|
1145
|
-
// }
|
|
1146
|
-
|
|
1147
|
-
const restored = glaze.paletteFrom(JSON.parse(JSON.stringify(snapshot)));
|
|
1148
|
-
const brand = restored.theme('brand')!;
|
|
1149
|
-
```
|
|
1150
|
-
|
|
1151
|
-
Optional `override` is forwarded to each nested `theme.export(override)`.
|
|
1152
|
-
Config snapshot vs resolved output: use `export()` / `paletteFrom()` to
|
|
1153
|
-
persist and restore the authoring graph (themes, color defs, relations). Use
|
|
1154
|
-
`json()` / `tokens()` / `css()` / … to emit resolved color strings for apps
|
|
1155
|
-
and design tools.
|
|
729
|
+
| Method | Description |
|
|
730
|
+
|---|---|
|
|
731
|
+
| `palette.tokens(options?)` | Flat token map grouped by scheme variant. |
|
|
732
|
+
| `palette.tasty(options?)` | Tasty style-to-state bindings. |
|
|
733
|
+
| `palette.json(options?)` | Per-theme JSON map (no prefix needed — keyed by theme name). |
|
|
734
|
+
| `palette.css(options?)` | CSS custom property declaration strings. |
|
|
1156
735
|
|
|
1157
736
|
### `GlazePaletteExportOptions`
|
|
1158
737
|
|
|
1159
738
|
Shared by `tokens`, `tasty`, and `css`:
|
|
1160
739
|
|
|
1161
|
-
| Option
|
|
1162
|
-
|
|
1163
|
-
| `prefix`
|
|
1164
|
-
| `primary` | inherits from palette creation | `string` to override, `false` to disable for this call.
|
|
740
|
+
| Option | Default | Description |
|
|
741
|
+
|---|---|---|
|
|
742
|
+
| `prefix` | `true` (= `"<themeName>-"`) | `false` disables prefixing. Or pass a custom map: `{ primary: 'brand-', danger: 'error-' }`. |
|
|
743
|
+
| `primary` | inherits from palette creation | `string` to override, `false` to disable for this call. |
|
|
1165
744
|
|
|
1166
745
|
Each export method also accepts its own format/options shape:
|
|
1167
746
|
|
|
1168
|
-
| Method
|
|
1169
|
-
|
|
1170
|
-
| `palette.tokens(options?)`
|
|
1171
|
-
| `palette.tasty(options?)`
|
|
1172
|
-
| `palette.css(options?)`
|
|
1173
|
-
| `palette.dtcg(options?)` | `colorSpace`, `modes` |
|
|
1174
|
-
| `palette.dtcgResolver(options?)` | `colorSpace`, `modes`, resolver names |
|
|
1175
|
-
| `palette.tailwind(options?)` | `format`, `modes`, selectors, `namespace` |
|
|
747
|
+
| Method | Additional options |
|
|
748
|
+
|---|---|
|
|
749
|
+
| `palette.tokens(options?)` | `format`, `modes` |
|
|
750
|
+
| `palette.tasty(options?)` | `format`, `modes`, `states` |
|
|
751
|
+
| `palette.css(options?)` | `format`, `suffix` |
|
|
1176
752
|
|
|
1177
753
|
`palette.css()` does not accept `modes`; it always returns all four CSS strings (`light`, `dark`, `lightContrast`, `darkContrast`).
|
|
1178
754
|
|
|
@@ -1183,8 +759,8 @@ By default all palette tokens are prefixed:
|
|
|
1183
759
|
```ts
|
|
1184
760
|
palette.tokens();
|
|
1185
761
|
// → {
|
|
1186
|
-
// light: { 'primary-surface': '
|
|
1187
|
-
// dark: { 'primary-surface': '
|
|
762
|
+
// light: { 'primary-surface': 'okhsl(...)', 'danger-surface': 'okhsl(...)' },
|
|
763
|
+
// dark: { 'primary-surface': 'okhsl(...)', 'danger-surface': 'okhsl(...)' },
|
|
1188
764
|
// }
|
|
1189
765
|
```
|
|
1190
766
|
|
|
@@ -1220,10 +796,10 @@ const palette = glaze.palette(
|
|
|
1220
796
|
palette.tokens();
|
|
1221
797
|
// → {
|
|
1222
798
|
// light: {
|
|
1223
|
-
// 'primary-surface': '
|
|
1224
|
-
// 'danger-surface': '
|
|
1225
|
-
// 'success-surface': '
|
|
1226
|
-
// 'surface': '
|
|
799
|
+
// 'primary-surface': 'okhsl(...)',
|
|
800
|
+
// 'danger-surface': 'okhsl(...)',
|
|
801
|
+
// 'success-surface': 'okhsl(...)',
|
|
802
|
+
// 'surface': 'okhsl(...)', // unprefixed alias
|
|
1227
803
|
// },
|
|
1228
804
|
// }
|
|
1229
805
|
```
|
|
@@ -1249,8 +825,8 @@ JSON export groups by theme name (no prefix needed):
|
|
|
1249
825
|
```ts
|
|
1250
826
|
palette.json();
|
|
1251
827
|
// → {
|
|
1252
|
-
// primary: { surface: { light: '
|
|
1253
|
-
// danger: { surface: { light: '
|
|
828
|
+
// primary: { surface: { light: 'okhsl(...)', dark: 'okhsl(...)' } },
|
|
829
|
+
// danger: { surface: { light: 'okhsl(...)', dark: 'okhsl(...)' } },
|
|
1254
830
|
// }
|
|
1255
831
|
```
|
|
1256
832
|
|
|
@@ -1269,98 +845,29 @@ const stylesheet = `
|
|
|
1269
845
|
`palette.css()` accepts the same `GlazeCssOptions` as `theme.css()` plus `GlazePaletteExportOptions`.
|
|
1270
846
|
It does not accept `modes`; all four result fields are always returned.
|
|
1271
847
|
|
|
1272
|
-
### `palette.dtcg()`
|
|
1273
|
-
|
|
1274
|
-
DTCG export for a palette. Prefix defaults to `true` and the palette-level `primary` is honored (the primary theme's tokens are duplicated without prefix as aliases).
|
|
1275
|
-
|
|
1276
|
-
```ts
|
|
1277
|
-
palette.dtcg();
|
|
1278
|
-
// → {
|
|
1279
|
-
// light: {
|
|
1280
|
-
// 'primary-surface': { $type: 'color', $value: { ... } },
|
|
1281
|
-
// 'surface': { $type: 'color', $value: { ... } }, // unprefixed alias
|
|
1282
|
-
// 'danger-surface': { $type: 'color', $value: { ... } },
|
|
1283
|
-
// },
|
|
1284
|
-
// dark: { ... },
|
|
1285
|
-
// }
|
|
1286
|
-
```
|
|
1287
|
-
|
|
1288
|
-
Accepts `GlazeDtcgOptions` plus `GlazePaletteExportOptions`.
|
|
1289
|
-
|
|
1290
|
-
### `palette.dtcgResolver()`
|
|
1291
|
-
|
|
1292
|
-
Resolver-Module export for a palette. Same as `theme.dtcgResolver()` but merges every theme (with prefix / `primary` aliasing) into the single `sets.base` source and each `scheme` context. Prefix defaults to `true`; the palette-level `primary` is honored.
|
|
1293
|
-
|
|
1294
|
-
```ts
|
|
1295
|
-
palette.dtcgResolver();
|
|
1296
|
-
// → {
|
|
1297
|
-
// version: '2025.10',
|
|
1298
|
-
// sets: { base: { sources: [ { 'primary-surface': {…}, 'surface': {…}, 'danger-surface': {…} } ] } },
|
|
1299
|
-
// modifiers: { scheme: { default: 'light', contexts: { light: [], dark: [ {…} ] } } },
|
|
1300
|
-
// resolutionOrder: [ { $ref: '#/sets/base' }, { $ref: '#/modifiers/scheme' } ],
|
|
1301
|
-
// }
|
|
1302
|
-
```
|
|
1303
|
-
|
|
1304
|
-
Accepts `GlazeDtcgResolverOptions` plus `GlazePaletteExportOptions`.
|
|
1305
|
-
|
|
1306
|
-
### `palette.tailwind()`
|
|
1307
|
-
|
|
1308
|
-
Tailwind export for a palette. All themes are merged into a single `@theme` block (plus dark / high-contrast overrides), so each color is reachable as a Tailwind utility. Prefix defaults to `true`.
|
|
1309
|
-
|
|
1310
|
-
```ts
|
|
1311
|
-
const css = palette.tailwind();
|
|
1312
|
-
// @theme {
|
|
1313
|
-
// --color-primary-surface: oklch(...);
|
|
1314
|
-
// --color-surface: oklch(...); /* unprefixed alias */
|
|
1315
|
-
// --color-danger-surface: oklch(...);
|
|
1316
|
-
// }
|
|
1317
|
-
// .dark { ... }
|
|
1318
|
-
```
|
|
1319
|
-
|
|
1320
|
-
Accepts `GlazeTailwindOptions` plus `GlazePaletteExportOptions`. The palette `prefix` option (theme prefixing) is separate from `GlazeTailwindOptions.namespace` (the `--color-*` CSS namespace).
|
|
1321
|
-
|
|
1322
848
|
---
|
|
1323
849
|
|
|
1324
850
|
## Output formats
|
|
1325
851
|
|
|
1326
852
|
Control the color format with the `format` option on any export method:
|
|
1327
853
|
|
|
1328
|
-
| Format
|
|
1329
|
-
|
|
1330
|
-
| `'
|
|
1331
|
-
| `'rgb'`
|
|
1332
|
-
| `'hsl'`
|
|
1333
|
-
| `'
|
|
1334
|
-
| `'okhst'` | `okhst(H S% T%)` | `okhst(H S% T% / A)` | OKHST tone axis. **[Tasty](https://tasty.style)-only** — same restriction as `okhsl`. |
|
|
854
|
+
| Format | Output (alpha = 1) | Output (alpha < 1) | Notes |
|
|
855
|
+
|---|---|---|---|
|
|
856
|
+
| `'okhsl'` (default for tokens/tasty/json) | `okhsl(H S% L%)` | `okhsl(H S% L% / A)` | Glaze's native format, not a CSS function. |
|
|
857
|
+
| `'rgb'` (default for css) | `rgb(R G B)` | `rgb(R G B / A)` | Rounded integers, modern space syntax. |
|
|
858
|
+
| `'hsl'` | `hsl(H S% L%)` | `hsl(H S% L% / A)` | Modern space syntax. |
|
|
859
|
+
| `'oklch'` | `oklch(L C H)` | `oklch(L C H / A)` | OKLab-based LCH. |
|
|
1335
860
|
|
|
1336
861
|
```ts
|
|
1337
|
-
theme.tokens();
|
|
1338
|
-
theme.tokens({ format: 'rgb' });
|
|
1339
|
-
theme.
|
|
1340
|
-
theme.
|
|
862
|
+
theme.tokens(); // 'okhsl(280 60% 97%)'
|
|
863
|
+
theme.tokens({ format: 'rgb' }); // 'rgb(244 240 250)'
|
|
864
|
+
theme.tokens({ format: 'hsl' }); // 'hsl(270.5 45.2% 95.8%)'
|
|
865
|
+
theme.tokens({ format: 'oklch' }); // 'oklch(0.965 0.0123 280)'
|
|
1341
866
|
```
|
|
1342
867
|
|
|
1343
868
|
All numeric output strips trailing zeros for cleaner CSS (e.g. `95` not `95.0`).
|
|
1344
869
|
|
|
1345
|
-
The `format` option works on
|
|
1346
|
-
|
|
1347
|
-
### Hue channel splitting (`splitHue`)
|
|
1348
|
-
|
|
1349
|
-
On `theme.css()`, `theme.tasty()`, `palette.css()`, `palette.tasty()`, and standalone `color.css()` with `format: 'oklch'`, set `splitHue: true` to emit hue as its own custom property so consumers can re-skin at runtime:
|
|
1350
|
-
|
|
1351
|
-
```css
|
|
1352
|
-
/* theme.css({ format: 'oklch', splitHue: true, name: 'brand' }) */
|
|
1353
|
-
--brand-hue: 240;
|
|
1354
|
-
--accent-hue: calc(var(--brand-hue) + 20);
|
|
1355
|
-
--surface-color: oklch(0.52 0.06 var(--brand-hue));
|
|
1356
|
-
--accent-color: oklch(0.62 0.03 var(--accent-hue));
|
|
1357
|
-
```
|
|
1358
|
-
|
|
1359
|
-
**Requirements:** every exported color must be pastel (`pastel: true` on the theme/token override or per-color). Pastel mode bounds chroma by the hue-independent safe chroma at each lightness, so emitted `C` stays in sRGB for any rotated hue. Non-pastel palettes throw rather than emit values that would clip under rotation.
|
|
1360
|
-
|
|
1361
|
-
**Limitations:** `oklch` only (native CSS `var()` in the hue slot). Shadow and mix colors stay inline (blended hue). Standalone `.token()` / `.tasty()` do not support `splitHue` (return shape cannot carry the `$name-hue` declaration).
|
|
1362
|
-
|
|
1363
|
-
`theme.dtcg()` / `theme.dtcgResolver()` / `palette.dtcg()` / `palette.dtcgResolver()` ignore `format` — DTCG emits structured `$value` objects, not CSS strings. Use the `colorSpace` option (`'srgb'` or `'oklch'`) to pick the color representation instead.
|
|
870
|
+
The `format` option works on every export: `theme.tokens()`, `theme.tasty()`, `theme.json()`, `theme.css()`, the same on `palette`, and on `token.token()` / `.tasty()` / `.json()` / `.css()`.
|
|
1364
871
|
|
|
1365
872
|
---
|
|
1366
873
|
|
|
@@ -1368,84 +875,87 @@ On `theme.css()`, `theme.tasty()`, `palette.css()`, `palette.tasty()`, and stand
|
|
|
1368
875
|
|
|
1369
876
|
`mode` controls how a color adapts across schemes:
|
|
1370
877
|
|
|
1371
|
-
| Mode
|
|
1372
|
-
|
|
1373
|
-
| `'auto'` (default) | Full adaptation.
|
|
1374
|
-
| `'fixed'`
|
|
1375
|
-
| `'static'`
|
|
878
|
+
| Mode | Behavior |
|
|
879
|
+
|---|---|
|
|
880
|
+
| `'auto'` (default) | Full adaptation. Light ↔ dark inversion via the Möbius curve. High-contrast boost. |
|
|
881
|
+
| `'fixed'` | Color stays recognizable. Lightness is *mapped* (not inverted) into the dark window. Use for brand buttons, CTAs, status banners. |
|
|
882
|
+
| `'static'` | No adaptation. Same value in every scheme. |
|
|
1376
883
|
|
|
1377
|
-
### How relative
|
|
884
|
+
### How relative lightness adapts
|
|
1378
885
|
|
|
1379
|
-
**`auto`** —
|
|
886
|
+
**`auto`** — relative lightness sign flips in dark scheme:
|
|
1380
887
|
|
|
1381
888
|
```
|
|
1382
|
-
Light: surface
|
|
1383
|
-
Dark: surface inverts to
|
|
1384
|
-
|
|
889
|
+
Light: surface L=97, text lightness='-52' → L=45 (dark text on light bg)
|
|
890
|
+
Dark: surface inverts to L≈20 (Möbius), sign flips → L=20+52=72
|
|
891
|
+
contrast solver may push further (light text on dark bg)
|
|
1385
892
|
```
|
|
1386
893
|
|
|
1387
|
-
**`fixed`** —
|
|
894
|
+
**`fixed`** — lightness is mapped (not inverted), relative sign preserved:
|
|
1388
895
|
|
|
1389
896
|
```
|
|
1390
|
-
Light: accent-fill
|
|
1391
|
-
Dark: accent-fill maps
|
|
897
|
+
Light: accent-fill L=52, accent-text lightness='+48' → L=100 (white on brand)
|
|
898
|
+
Dark: accent-fill maps to L≈51.6, sign preserved → L≈99.6
|
|
1392
899
|
```
|
|
1393
900
|
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
**`static`** — no adaptation, same tone in every scheme.
|
|
901
|
+
**`static`** — no adaptation, same value in every scheme.
|
|
1397
902
|
|
|
1398
903
|
---
|
|
1399
904
|
|
|
1400
905
|
## Light / dark scheme mapping
|
|
1401
906
|
|
|
1402
|
-
|
|
1403
|
-
[Scheme adaptation](okhst.md#scheme-adaptation) for the product-level model and
|
|
1404
|
-
the [canonical OKHST specification](https://github.com/tenphi/okhst) for the
|
|
1405
|
-
transfer math.
|
|
1406
|
-
|
|
1407
|
-
### Light scheme
|
|
907
|
+
### Light scheme — lightness
|
|
1408
908
|
|
|
1409
|
-
|
|
1410
|
-
The window's `lo`/`hi` are OKHSL-lightness boundaries (0–100); authored tone is
|
|
1411
|
-
positioned within the corresponding tone interval and converted to final OKHSL
|
|
1412
|
-
lightness. `static` mode and HC variants use the full range.
|
|
909
|
+
Absolute lightness values (root colors and dependent colors with absolute lightness) are mapped linearly within the configured `lightLightness` window:
|
|
1413
910
|
|
|
1414
|
-
```
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
finalL = fromTone(finalTone) // OKHSL lightness
|
|
911
|
+
```ts
|
|
912
|
+
const [lo, hi] = lightLightness; // default: [10, 100]
|
|
913
|
+
const mappedL = (lightness * (hi - lo)) / 100 + lo;
|
|
1418
914
|
```
|
|
1419
915
|
|
|
1420
|
-
|
|
916
|
+
Both `auto` and `fixed` modes use the same linear formula. `static` mode and HC variants bypass the mapping (identity: `mappedL = l`).
|
|
1421
917
|
|
|
1422
|
-
|
|
918
|
+
| Color | Raw L | Mapped L (default `[10, 100]`) |
|
|
919
|
+
|---|---|---|
|
|
920
|
+
| surface (L=97) | 97 | 97.3 |
|
|
921
|
+
| accent-fill (L=52) | 52 | 56.8 |
|
|
922
|
+
| near-black (L=0) | 0 | 10 |
|
|
1423
923
|
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
inverted
|
|
1427
|
-
|
|
924
|
+
### Dark scheme — lightness
|
|
925
|
+
|
|
926
|
+
**`auto`** — inverted with a Möbius transformation within the configured window:
|
|
927
|
+
|
|
928
|
+
```ts
|
|
929
|
+
const [lo, hi] = darkLightness; // default: [15, 95]
|
|
930
|
+
const t = (100 - lightness) / 100;
|
|
931
|
+
const invertedL = lo + (hi - lo) * t / (t + darkCurve * (1 - t));
|
|
932
|
+
// darkCurve default: 0.5
|
|
1428
933
|
```
|
|
1429
934
|
|
|
1430
|
-
The inversion
|
|
1431
|
-
exactly contrast-even for neutrals and approximate for chromatic colors. The
|
|
1432
|
-
ordinary light/dark asymmetry lives in the two windows' `(lo, hi, eps)` values
|
|
1433
|
-
(`eps` defaults to the reference `0.05`).
|
|
935
|
+
The `darkCurve` parameter (default `0.5`, range 0–1) controls how much the dark-mode inversion expands lightness deltas. Lower values produce stronger expansion; `1` gives linear (legacy) behavior. Accepts `[normal, highContrast]` pairs (e.g. `darkCurve: [0.5, 0.3]`).
|
|
1434
936
|
|
|
1435
|
-
|
|
937
|
+
Unlike a power curve, the Möbius transformation provides **proportional expansion** — small and large deltas are scaled by similar ratios, preserving the visual hierarchy of the light theme.
|
|
1436
938
|
|
|
939
|
+
**`fixed`** — mapped without inversion (not affected by `darkCurve`):
|
|
940
|
+
|
|
941
|
+
```ts
|
|
942
|
+
const mappedL = (lightness * (hi - lo)) / 100 + lo;
|
|
1437
943
|
```
|
|
1438
|
-
finalTone = remap(authorTone, darkTone)
|
|
1439
|
-
```
|
|
1440
944
|
|
|
1441
|
-
|
|
945
|
+
| Color | Light L | Auto (curve=0.5) | Auto (curve=1, linear) | Fixed (mapped) |
|
|
946
|
+
|---|---|---|---|---|
|
|
947
|
+
| surface (L=97) | 97 | 19.7 | 17.4 | 92.6 |
|
|
948
|
+
| accent-fill (L=52) | 52 | 66.9 | 53.4 | 56.6 |
|
|
949
|
+
| accent-text (L=100) | 100 | 15 | 15 | 95 |
|
|
950
|
+
|
|
951
|
+
In high-contrast variants the `darkLightness` window is bypassed — `auto` uses the Möbius curve over the full `[0, 100]` range, `fixed` uses identity.
|
|
1442
952
|
|
|
1443
953
|
### Dark scheme — saturation
|
|
1444
954
|
|
|
1445
955
|
`darkDesaturation` reduces saturation for all colors in dark scheme:
|
|
1446
956
|
|
|
1447
957
|
```ts
|
|
1448
|
-
S_dark = S_light * (1 - darkDesaturation)
|
|
958
|
+
S_dark = S_light * (1 - darkDesaturation) // default: 0.1
|
|
1449
959
|
```
|
|
1450
960
|
|
|
1451
961
|
`static` mode skips desaturation.
|
|
@@ -1456,12 +966,13 @@ S_dark = S_light * (1 - darkDesaturation); // default: 0.1
|
|
|
1456
966
|
|
|
1457
967
|
```ts
|
|
1458
968
|
glaze.configure({
|
|
1459
|
-
|
|
1460
|
-
|
|
969
|
+
lightLightness: [10, 100], // or false to disable clamping
|
|
970
|
+
darkLightness: [15, 95], // or false to disable clamping
|
|
1461
971
|
darkDesaturation: 0.1,
|
|
972
|
+
darkCurve: 0.5, // or [normal, hc] pair
|
|
1462
973
|
states: {
|
|
1463
|
-
dark: '@
|
|
1464
|
-
highContrast: '@
|
|
974
|
+
dark: '@dark',
|
|
975
|
+
highContrast: '@high-contrast',
|
|
1465
976
|
},
|
|
1466
977
|
modes: {
|
|
1467
978
|
dark: true,
|
|
@@ -1474,33 +985,28 @@ glaze.configure({
|
|
|
1474
985
|
});
|
|
1475
986
|
```
|
|
1476
987
|
|
|
1477
|
-
A `ToneWindow` is `[lo, hi]` (OKHSL-lightness boundaries, reference eps — the
|
|
1478
|
-
common form), `{ lo, hi, eps }` (advanced: explicit per-scheme render eps), or
|
|
1479
|
-
`false` for the full range `[0, 100]` at the reference eps. `false` removes the
|
|
1480
|
-
boundaries, not the tone transfer.
|
|
1481
|
-
|
|
1482
988
|
`GlazeConfig`:
|
|
1483
989
|
|
|
1484
|
-
| Field
|
|
1485
|
-
|
|
1486
|
-
| `
|
|
1487
|
-
| `
|
|
1488
|
-
| `darkDesaturation`
|
|
1489
|
-
| `
|
|
1490
|
-
| `states.
|
|
1491
|
-
| `
|
|
1492
|
-
| `modes.
|
|
1493
|
-
| `
|
|
1494
|
-
| `
|
|
1495
|
-
| `
|
|
1496
|
-
|
|
1497
|
-
| Method
|
|
1498
|
-
|
|
990
|
+
| Field | Default | Description |
|
|
991
|
+
|---|---|---|
|
|
992
|
+
| `lightLightness` | `[10, 100]` | Light scheme lightness window `[lo, hi]`, or `false` to disable clamping (equivalent to `[0, 100]`). Bypassed in HC. |
|
|
993
|
+
| `darkLightness` | `[15, 95]` | Dark scheme lightness window, or `false` to disable clamping. Bypassed in HC. |
|
|
994
|
+
| `darkDesaturation` | `0.1` | Saturation reduction in dark scheme (0–1). |
|
|
995
|
+
| `darkCurve` | `0.5` | Möbius beta for dark `auto`-inversion (0–1). Accepts `[normal, hc]` pair. |
|
|
996
|
+
| `states.dark` | `'@dark'` | State alias for dark mode tokens (Tasty export). |
|
|
997
|
+
| `states.highContrast` | `'@high-contrast'` | State alias for HC tokens. |
|
|
998
|
+
| `modes.dark` | `true` | Include dark variants in exports. |
|
|
999
|
+
| `modes.highContrast` | `false` | Include HC variants. |
|
|
1000
|
+
| `shadowTuning` | `undefined` | Default tuning for all shadow colors. Per-color tuning merges field-by-field. |
|
|
1001
|
+
| `autoFlip` | `true` | When solving `contrast`, allow the solver to switch away from the requested lightness direction if that side can't meet the target. With `false`, only the requested direction is considered; unmet contrasts pin the lightness to that direction's extreme (and emit a warning). |
|
|
1002
|
+
|
|
1003
|
+
| Method | Description |
|
|
1004
|
+
|---|---|
|
|
1499
1005
|
| `glaze.configure(config)` | Merge into the global config. Bumps a config version that invalidates theme caches. |
|
|
1500
|
-
| `glaze.getConfig()`
|
|
1501
|
-
| `glaze.resetConfig()`
|
|
1006
|
+
| `glaze.getConfig()` | Snapshot the current resolved config (shallow copy). |
|
|
1007
|
+
| `glaze.resetConfig()` | Reset to defaults (also bumps the version counter). |
|
|
1502
1008
|
|
|
1503
|
-
|
|
1009
|
+
Standalone `glaze.color()` tokens snapshot the resolve-relevant fields at create time, so later `configure()` calls don't change already-created tokens. Themes merge the live global at resolve time for fields not overridden via `GlazeConfigOverride`.
|
|
1504
1010
|
|
|
1505
1011
|
---
|
|
1506
1012
|
|
|
@@ -1530,38 +1036,30 @@ Resolution priority (highest first):
|
|
|
1530
1036
|
|
|
1531
1037
|
## Validation
|
|
1532
1038
|
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
|
1540
|
-
|
|
|
1541
|
-
|
|
|
1542
|
-
|
|
|
1543
|
-
| `
|
|
1544
|
-
|
|
|
1545
|
-
|
|
|
1546
|
-
| `
|
|
1547
|
-
|
|
|
1548
|
-
| `
|
|
1549
|
-
|
|
|
1550
|
-
| `base` references non-existent
|
|
1551
|
-
|
|
|
1552
|
-
|
|
|
1553
|
-
|
|
|
1554
|
-
|
|
|
1555
|
-
|
|
|
1556
|
-
|
|
|
1557
|
-
| `contrast` + `opacity` combined | `console.warn` |
|
|
1558
|
-
| Mix `base` references non-existent color | Validation error |
|
|
1559
|
-
| Mix `target` references non-existent color | Validation error |
|
|
1560
|
-
| Mix `base` references a shadow color | Validation error |
|
|
1561
|
-
| Mix `target` references a shadow color | Validation error |
|
|
1562
|
-
| Mix `value` outside 0–100 | Clamp silently |
|
|
1563
|
-
| Circular references involving mix colors | Validation error |
|
|
1564
|
-
| Contrast target physically unreachable | `console.warn` (deduped per `(name, scheme, target)`); closest passing variant returned |
|
|
1039
|
+
| Condition | Behavior |
|
|
1040
|
+
|---|---|
|
|
1041
|
+
| `contrast` without `base` in a **theme** color | Validation error |
|
|
1042
|
+
| Relative `lightness` without `base` in a **theme** color | Validation error |
|
|
1043
|
+
| `contrast` without `base` in `glaze.color()` | Anchors against the literal seed (no error) |
|
|
1044
|
+
| Relative `lightness` without `base` in `glaze.color()` | Anchors against the literal seed (no error) |
|
|
1045
|
+
| `lightness` resolves outside 0–100 | Clamp silently |
|
|
1046
|
+
| `saturation` outside 0–1 | Clamp silently |
|
|
1047
|
+
| Circular `base` references | Validation error |
|
|
1048
|
+
| `base` references non-existent name | Validation error |
|
|
1049
|
+
| Shadow `bg` references non-existent color | Validation error |
|
|
1050
|
+
| Shadow `fg` references non-existent color | Validation error |
|
|
1051
|
+
| Shadow `bg` references another shadow color | Validation error |
|
|
1052
|
+
| Shadow `fg` references another shadow color | Validation error |
|
|
1053
|
+
| Regular color `base` references a shadow color | Validation error |
|
|
1054
|
+
| Shadow `intensity` outside 0–100 | Clamp silently |
|
|
1055
|
+
| `contrast` + `opacity` combined | `console.warn` |
|
|
1056
|
+
| Mix `base` references non-existent color | Validation error |
|
|
1057
|
+
| Mix `target` references non-existent color | Validation error |
|
|
1058
|
+
| Mix `base` references a shadow color | Validation error |
|
|
1059
|
+
| Mix `target` references a shadow color | Validation error |
|
|
1060
|
+
| Mix `value` outside 0–100 | Clamp silently |
|
|
1061
|
+
| Circular references involving mix colors | Validation error |
|
|
1062
|
+
| Contrast target physically unreachable | `console.warn` (deduped per `(name, scheme, target)`); closest passing variant returned |
|
|
1565
1063
|
|
|
1566
1064
|
---
|
|
1567
1065
|
|
|
@@ -1587,19 +1085,19 @@ import {
|
|
|
1587
1085
|
} from '@tenphi/glaze';
|
|
1588
1086
|
```
|
|
1589
1087
|
|
|
1590
|
-
| Function
|
|
1591
|
-
|
|
1592
|
-
| `okhslToLinearSrgb(h, s, l)`
|
|
1593
|
-
| `okhslToSrgb(h, s, l)`
|
|
1594
|
-
| `okhslToOklab([h, s, l])`
|
|
1595
|
-
| `oklabToOkhsl([L, a, b])`
|
|
1596
|
-
| `srgbToOkhsl([r, g, b])`
|
|
1597
|
-
| `hslToSrgb(h, s, l)`
|
|
1598
|
-
| `parseHex(hex)`
|
|
1599
|
-
| `parseHexAlpha(hex)`
|
|
1600
|
-
| `relativeLuminanceFromLinearRgb(rgb)` | WCAG relative luminance from linear sRGB.
|
|
1601
|
-
| `contrastRatioFromLuminance(yA, yB)`
|
|
1602
|
-
| `gamutClampedLuminance(linearRgb)`
|
|
1088
|
+
| Function | Description |
|
|
1089
|
+
|---|---|
|
|
1090
|
+
| `okhslToLinearSrgb(h, s, l)` | OKHSL (h: 0–360, s/l: 0–1) → linear sRGB tuple. |
|
|
1091
|
+
| `okhslToSrgb(h, s, l)` | OKHSL → gamma-encoded sRGB tuple (0–1 per channel). |
|
|
1092
|
+
| `okhslToOklab([h, s, l])` | OKHSL → OKLab `[L, a, b]`. |
|
|
1093
|
+
| `oklabToOkhsl([L, a, b])` | OKLab → OKHSL. |
|
|
1094
|
+
| `srgbToOkhsl([r, g, b])` | Gamma sRGB (0–1) → OKHSL. |
|
|
1095
|
+
| `hslToSrgb(h, s, l)` | CSS HSL → sRGB tuple. |
|
|
1096
|
+
| `parseHex(hex)` | Parse `#rgb` / `#rrggbb` to sRGB tuple. Returns `null` on invalid input. |
|
|
1097
|
+
| `parseHexAlpha(hex)` | Parse `#rgb` / `#rrggbb` / `#rrggbbaa`; returns `[r, g, b, a?]`. |
|
|
1098
|
+
| `relativeLuminanceFromLinearRgb(rgb)` | WCAG relative luminance from linear sRGB. |
|
|
1099
|
+
| `contrastRatioFromLuminance(yA, yB)` | WCAG contrast ratio from two luminances. |
|
|
1100
|
+
| `gamutClampedLuminance(linearRgb)` | Relative luminance with channel clamping for out-of-gamut colors. |
|
|
1603
1101
|
|
|
1604
1102
|
### Format writers
|
|
1605
1103
|
|
|
@@ -1607,77 +1105,42 @@ import {
|
|
|
1607
1105
|
import { formatOkhsl, formatRgb, formatHsl, formatOklch } from '@tenphi/glaze';
|
|
1608
1106
|
|
|
1609
1107
|
formatOkhsl(280, 60, 95); // 'okhsl(280 60% 95%)'
|
|
1610
|
-
formatRgb(280, 60, 95);
|
|
1611
|
-
formatHsl(280, 60, 95);
|
|
1108
|
+
formatRgb(280, 60, 95); // 'rgb(244 240 250)'
|
|
1109
|
+
formatHsl(280, 60, 95); // 'hsl(280 60% 95%)'
|
|
1612
1110
|
formatOklch(280, 60, 95); // 'oklch(0.95 ... 280)'
|
|
1613
1111
|
```
|
|
1614
1112
|
|
|
1615
1113
|
To attach an alpha component, use `glaze.format(variant, format)` on a `ResolvedColorVariant` (which carries the `alpha` channel) instead of these raw writers.
|
|
1616
1114
|
|
|
1617
|
-
### OKHST tone utilities
|
|
1618
|
-
|
|
1619
|
-
```ts
|
|
1620
|
-
import {
|
|
1621
|
-
toTone,
|
|
1622
|
-
fromTone,
|
|
1623
|
-
toneFromY,
|
|
1624
|
-
yFromTone,
|
|
1625
|
-
okhstToOkhsl,
|
|
1626
|
-
okhslToOkhst,
|
|
1627
|
-
variantToOkhsl,
|
|
1628
|
-
REF_EPS,
|
|
1629
|
-
} from '@tenphi/glaze';
|
|
1630
|
-
```
|
|
1631
|
-
|
|
1632
|
-
| Function | Description |
|
|
1633
|
-
| ------------------------------------------- | ------------------------------------------------------------------------- |
|
|
1634
|
-
| `toTone(l, eps?)` | OKHSL lightness (0–1) → tone (0–100). Defaults to `REF_EPS`. |
|
|
1635
|
-
| `fromTone(t, eps?)` | Tone (0–100) → OKHSL lightness (0–1). Inverse of `toTone`. |
|
|
1636
|
-
| `toneFromY(y, eps?)` / `yFromTone(t, eps?)` | Same transfer in luminance space (0–1). |
|
|
1637
|
-
| `okhstToOkhsl({ h, s, t })` | OKHST → OKHSL (`{ h, s, l }`). |
|
|
1638
|
-
| `okhslToOkhst({ h, s, l })` | OKHSL → OKHST (`{ h, s, t }`). |
|
|
1639
|
-
| `variantToOkhsl(variant)` | `ResolvedColorVariant` (stores `t`) → `{ h, s, l, alpha }` for rendering. |
|
|
1640
|
-
| `REF_EPS` | Reference epsilon (`0.05`) for the canonical tone axis. |
|
|
1641
|
-
|
|
1642
|
-
`ResolvedColorVariant` stores `{ h, s, t, alpha }` (tone, not lightness). Use
|
|
1643
|
-
`variantToOkhsl(variant).l` to recover OKHSL lightness. See
|
|
1644
|
-
[OKHST in Glaze](okhst.md) for the model.
|
|
1645
|
-
|
|
1646
1115
|
### Contrast solver
|
|
1647
1116
|
|
|
1648
1117
|
```ts
|
|
1649
1118
|
import {
|
|
1650
|
-
|
|
1119
|
+
findLightnessForContrast,
|
|
1651
1120
|
findValueForMixContrast,
|
|
1652
|
-
resolveContrastForMode,
|
|
1653
1121
|
resolveMinContrast,
|
|
1654
|
-
apcaContrast,
|
|
1655
1122
|
} from '@tenphi/glaze';
|
|
1656
1123
|
```
|
|
1657
1124
|
|
|
1658
|
-
| Function
|
|
1659
|
-
|
|
1660
|
-
| `
|
|
1661
|
-
| `findValueForMixContrast(opts)`
|
|
1662
|
-
| `
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
`
|
|
1669
|
-
|
|
1670
|
-
|
|
|
1671
|
-
|
|
|
1672
|
-
| `
|
|
1673
|
-
| `
|
|
1674
|
-
| `
|
|
1675
|
-
| `
|
|
1676
|
-
| `
|
|
1677
|
-
| `
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
| `initialDirection` | higher-contrast side | Direction to search first (`'lighter'` or `'darker'`). |
|
|
1681
|
-
| `flip` | `false` | When `true`, try the opposite direction if the initial one doesn't meet the target. When `false`, only the initial direction is searched — unmet contrasts pin the result to that direction's extreme. |
|
|
1682
|
-
|
|
1683
|
-
Result: `{ tone, contrast, met, branch: 'lighter' | 'darker' | 'preferred', flipped? }`. `flipped: true` indicates the initial direction failed and the opposite direction satisfied the target.
|
|
1125
|
+
| Function | Description |
|
|
1126
|
+
|---|---|
|
|
1127
|
+
| `findLightnessForContrast(opts)` | Binary-search for the OKHSL lightness that meets a WCAG contrast floor against a base color. Returns `{ lightness, contrast, met, branch }`. |
|
|
1128
|
+
| `findValueForMixContrast(opts)` | Same, but searches for a mix `value` (0–1) that meets a contrast floor between a base and a target. |
|
|
1129
|
+
| `resolveMinContrast(value)` | Resolves a `MinContrast` (preset or number) to a numeric ratio. |
|
|
1130
|
+
|
|
1131
|
+
`findLightnessForContrast` options:
|
|
1132
|
+
|
|
1133
|
+
| Option | Default | Description |
|
|
1134
|
+
|---|---|---|
|
|
1135
|
+
| `hue` | — | Candidate hue (0–360). |
|
|
1136
|
+
| `saturation` | — | Candidate saturation (0–1). |
|
|
1137
|
+
| `preferredLightness` | — | Preferred candidate lightness (0–1). Kept if it already meets the target. |
|
|
1138
|
+
| `baseLinearRgb` | — | Base color as linear sRGB tuple. |
|
|
1139
|
+
| `contrast` | — | WCAG floor (`MinContrast`). |
|
|
1140
|
+
| `lightnessRange` | `[0, 1]` | Search bounds. |
|
|
1141
|
+
| `epsilon` | `1e-4` | Convergence threshold. |
|
|
1142
|
+
| `maxIterations` | `14` | Max binary-search iterations per branch. |
|
|
1143
|
+
| `initialDirection` | higher-contrast side | Direction to search first (`'lighter'` or `'darker'`). Theme resolution sets this from the requested lightness relative to the base color. |
|
|
1144
|
+
| `flip` | `false` | When `true`, try the opposite direction if the initial one doesn't meet the target. When `false`, only the initial direction is searched — unmet contrasts pin the result to that direction's extreme. |
|
|
1145
|
+
|
|
1146
|
+
Result: `{ lightness, contrast, met, branch: 'lighter' | 'darker' | 'preferred', flipped? }`. `flipped: true` indicates the initial direction failed and the opposite direction satisfied the target.
|