@hussmartinez/ui 0.9.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.js +21 -1
- package/dist/index.js.map +1 -1
- package/dist/react.d.ts +493 -1
- package/dist/react.js +849 -68
- package/dist/react.js.map +1 -1
- package/dist/shared/{pair-pt-vUVwu.js → pair-MeX064R6.js} +2 -1
- package/dist/shared/pair-MeX064R6.js.map +1 -0
- package/dist/styles.css +262 -0
- package/dist/ui.d.ts +493 -1
- package/package.json +1 -1
- package/dist/shared/pair-pt-vUVwu.js.map +0 -1
package/README.md
CHANGED
|
@@ -69,6 +69,16 @@ With `styles.css` loaded, the built-in light and dark themes follow the operatin
|
|
|
69
69
|
|
|
70
70
|
`data-hm-theme` takes `light`, `dark` or `system`, and `data-hm-density` takes `comfortable` (the default) or `compact`. On touch screens, targets are 44 px in either density. A themed subtree also sets its text colour to `--hm-color-text`, in the lowest-priority layer, so your own CSS still wins. Backgrounds are left to you: paint them with `--hm-color-bg` or `--hm-color-surface`.
|
|
71
71
|
|
|
72
|
+
### Text outside components
|
|
73
|
+
|
|
74
|
+
Components set their own font and colour. Text you render yourself, such as an editor's own labels, values and status lines, takes the page's font unless you say otherwise. Put **`hm-text`** on its root, usually your editor's or application's outermost element:
|
|
75
|
+
|
|
76
|
+
```html
|
|
77
|
+
<div class="hm-text my-editor">…</div>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
It sets `font-family`, `font-size`, `font-weight`, `letter-spacing`, `line-height` and `color` from the tokens (`--hm-font-family`, `--hm-font-size-body`, `--hm-font-weight-regular`, `--hm-letter-spacing`, `--hm-line-height-body`, `--hm-color-text`), and everything inside inherits them. It's opt-in, so ui never restyles a page that didn't ask, and it's in the lowest-priority layer, so an SDK's rules in `hm.sdk` and your own CSS still win. It follows `data-hm-theme` and `data-hm-density` like everything else.
|
|
81
|
+
|
|
72
82
|
### Custom themes
|
|
73
83
|
|
|
74
84
|
`createTheme` validates a set of token values. Extend a built-in theme and change only what you need, or set every semantic token to replace the look entirely.
|
|
@@ -168,6 +178,8 @@ Every component follows one contract ([ADR 0003](https://github.com/ie-huss-mart
|
|
|
168
178
|
| `AnnouncerProvider`, `useAnnounce` | Announcements for screen readers, such as "Saved 1.3 MB": `announce(message, { politeness })`. The provider renders the live regions once, on the server too |
|
|
169
179
|
| `usePlatform` | The platform for keyboard shortcuts: `"apple"` on macOS, iOS and iPadOS, where `Mod` is ⌘, otherwise `"other"`. It's `"other"` on the server and during hydration, then Apple devices switch right after, so hydration never mismatches. Pass it to sdk-core's `createShortcutRegistry({ platform })`, and never read `navigator` during render for this |
|
|
170
180
|
| `Tooltip` | Short text about a control, shown on hover and on keyboard focus; Escape closes it (WCAG 1.4.13). While it's open, the first Escape closes only the tooltip, so an editor's own Escape action, such as cancelling a crop, runs on the second press; Escape handlers should skip events with `defaultPrevented`. `type="label"` makes it an icon-only button's name, and `description`, the default, describes the button. `shortcut` takes sdk-core's `registry.describe(toolId)[0]`, shows it in the platform's notation (⌘⇧Z or Ctrl+Shift+Z) and sets `aria-keyshortcuts`. It's in the top layer, so no stacking context hides it. Disabled triggers need `focusableWhenDisabled` |
|
|
181
|
+
| `ReorderableList` and `ReorderableListItem` | A list whose items the user selects, reorders and removes, such as layers, tracks or pages: one Tab stop for the whole list, and room for `controls` in each row, such as a visibility toggle. ↑ and ↓ move between rows and select (with Ctrl or ⌘, without selecting); ← and → move between a row's cells; Alt+↑ and Alt+↓ (Option on macOS) move the focused item through `onMove(id, toIndex)`; Delete and Backspace remove it through `onRemove(id)`. You own the order and render the result; focus stays with a moved item, and moves are announced through `AnnouncerProvider` unless `announceMoves` is `false`. **Also render buttons that move the selected item**, with `aria-keyshortcuts`, for touch and for people who don't know the keys. It's a WAI-ARIA grid ([ADR 0009](https://github.com/ie-huss-martinez/ui/blob/main/docs/adr/0009-reorderable-list.md)) |
|
|
182
|
+
| `Timeline`, `TimelineClips`, `TimelinePlayhead` and `TimelineLayer` | A timeline over whole units, such as frames or samples ([ADR 0011](https://github.com/ie-huss-martinez/ui/blob/main/docs/adr/0011-timeline.md)): a scrolling track as wide as `length` at the current `zoom`, where 1 fits it to the width and `onMaxZoomChange` says where zooming stops. `TimelineClips` is the clip track, a horizontal listbox with one Tab stop: each clip is `{ key, length, label, content }`, as wide as its length; ← and → move between clips and select; with `selectionMode="multiple"`, Shift extends, Ctrl or ⌘ moves without selecting, Space adds or removes, and Ctrl or ⌘+A selects all. Give each clip a `label` with its place and range. `TimelinePlayhead` is a slider over the units with a line at its `position`; a press on the track moves it, snapping to the clips' boundaries and `snapTargets` within 8 px unless Alt is held, and `following` keeps it in view. `TimelineLayer` holds your own drawing, such as a waveform, and `useTimelineScale()` gives it the same mapping: `toPixels`, `unitAt`, `snap` and `visibleRange`. It formats no time: pass `formatValue` and the labels. **Editing is reported, not done:** `onMove(keys, direction)` for Alt+← and Alt+→ (Option on macOS), which the track always takes so the browser never goes back; `onTrim(key, edge, delta)` for Alt+`[` and Alt+`]` (with Shift, outward) and for dragging a clip's edge, which snaps, shows the new length as it goes and reports once on release; `onTrimToPlayhead(key, edge)` for `[` and `]`. Render the result. **Also render buttons that move and trim the selected clips**, with `aria-keyshortcuts`, and **offer zoom**: a clip narrower than 24 px is a small target, and zooming is how a pointer reaches it |
|
|
171
183
|
|
|
172
184
|
```tsx
|
|
173
185
|
import { Button, DownloadIcon, IconButton, RotateLeftIcon } from "@hussmartinez/ui/react";
|
package/dist/index.d.ts
CHANGED
|
@@ -61,7 +61,7 @@ export declare type CompleteThemeTokens = ThemeTokens & {
|
|
|
61
61
|
*
|
|
62
62
|
* @public
|
|
63
63
|
*/
|
|
64
|
-
export declare type ComponentTokenName = "button-height" | "button-small-height" | "button-padding-x" | "button-gap" | "button-icon-size" | "button-radius" | "button-font-weight" | "button-bg" | "button-bg-hover" | "button-bg-active" | "button-fg" | "button-border-color" | "button-primary-bg" | "button-primary-bg-hover" | "button-primary-bg-active" | "button-primary-fg" | "button-quiet-bg-hover" | "button-quiet-bg-active" | "button-danger-bg" | "button-danger-bg-hover" | "button-danger-fg" | "button-pressed-bg" | "button-pressed-border-color" | "button-pressed-fg" | "toolbar-bg" | "toolbar-border-color" | "toolbar-radius" | "toolbar-padding" | "toolbar-gap" | "toolbar-group-gap" | "toolbar-separator-color" | "segmented-control-height" | "segmented-control-small-height" | "segmented-control-padding" | "segmented-control-gap" | "segmented-control-radius" | "segmented-control-bg" | "segmented-control-border-color" | "segmented-control-option-padding-x" | "segmented-control-option-fg" | "segmented-control-option-bg-hover" | "segmented-control-option-checked-bg" | "segmented-control-option-checked-fg" | "segmented-control-option-checked-border-color" | "dialog-bg" | "dialog-fg" | "dialog-border-color" | "dialog-radius" | "dialog-shadow" | "dialog-padding" | "dialog-gap" | "dialog-backdrop" | "dialog-title-font-size" | "dialog-small-width" | "dialog-width" | "dialog-large-width" | "spinner-size" | "spinner-thickness" | "spinner-color" | "spinner-track-color" | "spinner-duration" | "progress-height" | "progress-radius" | "progress-track-color" | "progress-fill-color" | "progress-duration" | "slider-track-size" | "slider-track-color" | "slider-radius" | "slider-thumb-size" | "slider-thumb-color" | "slider-thumb-color-hover" | "slider-thumb-color-active" | "field-gap" | "field-label-fg" | "field-label-font-weight" | "field-description-fg" | "field-error-fg" | "field-message-font-size" | "number-field-height" | "number-field-padding-x" | "number-field-radius" | "number-field-bg" | "number-field-fg" | "number-field-border-color" | "number-field-invalid-border-color" | "file-drop-zone-gap" | "file-drop-zone-padding" | "file-drop-zone-radius" | "file-drop-zone-border-color" | "file-drop-zone-dragging-border-color" | "file-drop-zone-dragging-bg" | "file-drop-zone-hint-fg" | "tooltip-bg" | "tooltip-fg" | "tooltip-radius" | "tooltip-padding" | "tooltip-font-size" | "tooltip-shadow" | "tooltip-max-width" | "tooltip-offset" | "text-field-height" | "text-field-padding-x" | "text-field-radius" | "text-field-bg" | "text-field-fg" | "text-field-placeholder-fg" | "text-field-border-color" | "text-field-invalid-border-color" | "text-area-padding-y" | "color-field-gap" | "color-field-swatch-size" | "color-field-swatch-radius" | "color-field-swatch-border-color" | "color-field-swatch-checked-border-color";
|
|
64
|
+
export declare type ComponentTokenName = "button-height" | "button-small-height" | "button-padding-x" | "button-gap" | "button-icon-size" | "button-radius" | "button-font-weight" | "button-bg" | "button-bg-hover" | "button-bg-active" | "button-fg" | "button-border-color" | "button-primary-bg" | "button-primary-bg-hover" | "button-primary-bg-active" | "button-primary-fg" | "button-quiet-bg-hover" | "button-quiet-bg-active" | "button-danger-bg" | "button-danger-bg-hover" | "button-danger-fg" | "button-pressed-bg" | "button-pressed-border-color" | "button-pressed-fg" | "toolbar-bg" | "toolbar-border-color" | "toolbar-radius" | "toolbar-padding" | "toolbar-gap" | "toolbar-group-gap" | "toolbar-separator-color" | "segmented-control-height" | "segmented-control-small-height" | "segmented-control-padding" | "segmented-control-gap" | "segmented-control-radius" | "segmented-control-bg" | "segmented-control-border-color" | "segmented-control-option-padding-x" | "segmented-control-option-fg" | "segmented-control-option-bg-hover" | "segmented-control-option-checked-bg" | "segmented-control-option-checked-fg" | "segmented-control-option-checked-border-color" | "dialog-bg" | "dialog-fg" | "dialog-border-color" | "dialog-radius" | "dialog-shadow" | "dialog-padding" | "dialog-gap" | "dialog-backdrop" | "dialog-title-font-size" | "dialog-small-width" | "dialog-width" | "dialog-large-width" | "spinner-size" | "spinner-thickness" | "spinner-color" | "spinner-track-color" | "spinner-duration" | "progress-height" | "progress-radius" | "progress-track-color" | "progress-fill-color" | "progress-duration" | "slider-track-size" | "slider-track-color" | "slider-radius" | "slider-thumb-size" | "slider-thumb-color" | "slider-thumb-color-hover" | "slider-thumb-color-active" | "field-gap" | "field-label-fg" | "field-label-font-weight" | "field-description-fg" | "field-error-fg" | "field-message-font-size" | "number-field-height" | "number-field-padding-x" | "number-field-radius" | "number-field-bg" | "number-field-fg" | "number-field-border-color" | "number-field-invalid-border-color" | "file-drop-zone-gap" | "file-drop-zone-padding" | "file-drop-zone-radius" | "file-drop-zone-border-color" | "file-drop-zone-dragging-border-color" | "file-drop-zone-dragging-bg" | "file-drop-zone-hint-fg" | "tooltip-bg" | "tooltip-fg" | "tooltip-radius" | "tooltip-padding" | "tooltip-font-size" | "tooltip-shadow" | "tooltip-max-width" | "tooltip-offset" | "text-field-height" | "text-field-padding-x" | "text-field-radius" | "text-field-bg" | "text-field-fg" | "text-field-placeholder-fg" | "text-field-border-color" | "text-field-invalid-border-color" | "text-area-padding-y" | "reorderable-list-gap" | "reorderable-list-row-height" | "reorderable-list-row-padding-x" | "reorderable-list-row-radius" | "reorderable-list-row-fg" | "reorderable-list-row-bg-hover" | "reorderable-list-row-selected-bg" | "reorderable-list-row-selected-border-color" | "timeline-track-bg" | "timeline-track-radius" | "timeline-lane-height" | "timeline-playhead-color" | "timeline-clip-bg" | "timeline-clip-fg" | "timeline-clip-border-color" | "timeline-clip-radius" | "timeline-clip-padding-x" | "timeline-clip-selected-bg" | "timeline-clip-selected-border-color" | "timeline-clip-edge-size" | "color-field-gap" | "color-field-swatch-size" | "color-field-swatch-radius" | "color-field-swatch-border-color" | "color-field-swatch-checked-border-color";
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
67
|
* Component tokens from SDKs, such as `pdf-thumb-radius`. `ui`'s own
|
|
@@ -200,7 +200,7 @@ export declare interface ExtendingThemeInput extends ThemeInputBase {
|
|
|
200
200
|
*
|
|
201
201
|
* @public
|
|
202
202
|
*/
|
|
203
|
-
export declare type IconName = "add" | "arrow" | "check" | "chevron-down" | "chevron-left" | "chevron-right" | "close" | "crop" | "delete" | "download" | "duplicate" | "ellipse" | "fade-in" | "fade-out" | "fit" | "flip-horizontal" | "flip-vertical" | "hidden" | "highlighter" | "info" | "layers" | "loop" | "menu" | "more" | "move-down" | "move-up" | "muted" | "open" | "page-add" | "page-grid" | "page-single" | "pan" | "pause" | "pen" | "play" | "rectangle" | "redact" | "redo" | "remove" | "rotate-left" | "rotate-right" | "search" | "select" | "skip-back" | "skip-forward" | "snap" | "split" | "stop" | "text" | "trim-end" | "trim-start" | "undo" | "upload" | "visible" | "volume" | "warning" | "zoom-in" | "zoom-out";
|
|
203
|
+
export declare type IconName = "add" | "arrow" | "check" | "chevron-down" | "chevron-left" | "chevron-right" | "close" | "crop" | "delete" | "download" | "duplicate" | "ellipse" | "fade-in" | "fade-out" | "fit" | "flip-horizontal" | "flip-vertical" | "hidden" | "highlighter" | "image" | "info" | "layers" | "loop" | "menu" | "more" | "move-down" | "move-up" | "muted" | "open" | "page-add" | "page-grid" | "page-single" | "pan" | "pause" | "pen" | "play" | "rectangle" | "redact" | "redo" | "remove" | "rotate-left" | "rotate-right" | "search" | "select" | "skip-back" | "skip-forward" | "snap" | "split" | "stop" | "text" | "trim-end" | "trim-start" | "undo" | "upload" | "visible" | "volume" | "warning" | "zoom-in" | "zoom-out";
|
|
204
204
|
|
|
205
205
|
/**
|
|
206
206
|
* The built-in light theme.
|
|
@@ -441,6 +441,7 @@ export declare const uiMessages: {
|
|
|
441
441
|
readonly "fileDropZone.hint": "or drop it here";
|
|
442
442
|
readonly "fileDropZone.hintMultiple": "or drop them here";
|
|
443
443
|
readonly "progress.label": "Progress";
|
|
444
|
+
readonly "reorderableList.moved": "{label} moved to position {position} of {count}";
|
|
444
445
|
readonly "spinner.label": "Loading";
|
|
445
446
|
readonly "errors.INVALID_THEME_TOKEN": "The theme setting {token} has a value that can't be used.";
|
|
446
447
|
readonly "errors.INVALID_THEME_SELECTOR": "The theme can't be applied to the selector {selector}.";
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { a as uiMessages, i as warnInDevelopment, n as cssWriterOf, o as UiError, r as registerTheme, t as isThemePair } from "./shared/pair-
|
|
1
|
+
import { a as uiMessages, i as warnInDevelopment, n as cssWriterOf, o as UiError, r as registerTheme, t as isThemePair } from "./shared/pair-MeX064R6.js";
|
|
2
2
|
// src/tokens/base.ts
|
|
3
3
|
var baseValues = {
|
|
4
4
|
"gray-50": "oklch(0.985 0.008 260)",
|
|
@@ -1130,6 +1130,26 @@ var component = {
|
|
|
1130
1130
|
"text-field-border-color": { fallback: "color-border-strong" },
|
|
1131
1131
|
"text-field-invalid-border-color": { fallback: "color-danger-text" },
|
|
1132
1132
|
"text-area-padding-y": { fallback: "inset-tight" },
|
|
1133
|
+
"reorderable-list-gap": { fallback: "gap-tight" },
|
|
1134
|
+
"reorderable-list-row-height": { fallback: "control-height" },
|
|
1135
|
+
"reorderable-list-row-padding-x": { fallback: "control-padding-x" },
|
|
1136
|
+
"reorderable-list-row-radius": { fallback: "radius-control" },
|
|
1137
|
+
"reorderable-list-row-fg": { fallback: "color-text" },
|
|
1138
|
+
"reorderable-list-row-bg-hover": { fallback: "color-control-hover" },
|
|
1139
|
+
"reorderable-list-row-selected-bg": { fallback: "color-accent-subtle" },
|
|
1140
|
+
"reorderable-list-row-selected-border-color": { fallback: "color-accent" },
|
|
1141
|
+
"timeline-track-bg": { fallback: "color-surface-sunken" },
|
|
1142
|
+
"timeline-track-radius": { fallback: "radius-control" },
|
|
1143
|
+
"timeline-lane-height": { fallback: "control-height" },
|
|
1144
|
+
"timeline-playhead-color": { fallback: "color-accent" },
|
|
1145
|
+
"timeline-clip-bg": { fallback: "color-control" },
|
|
1146
|
+
"timeline-clip-fg": { fallback: "color-text" },
|
|
1147
|
+
"timeline-clip-border-color": { fallback: "color-border-strong" },
|
|
1148
|
+
"timeline-clip-radius": { fallback: "radius-control" },
|
|
1149
|
+
"timeline-clip-padding-x": { fallback: "gap-tight" },
|
|
1150
|
+
"timeline-clip-selected-bg": { fallback: "color-accent-subtle" },
|
|
1151
|
+
"timeline-clip-selected-border-color": { fallback: "color-accent" },
|
|
1152
|
+
"timeline-clip-edge-size": { fallback: "gap-normal" },
|
|
1133
1153
|
"color-field-gap": { fallback: "gap-tight" },
|
|
1134
1154
|
"color-field-swatch-size": { fallback: "control-height-small" },
|
|
1135
1155
|
"color-field-swatch-radius": { fallback: "radius-control" },
|