@hussmartinez/ui 0.11.0 → 0.13.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 +3 -3
- package/dist/index.d.ts +1 -1
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -1
- package/dist/react.d.ts +172 -5
- package/dist/react.js +640 -107
- package/dist/react.js.map +1 -1
- package/dist/styles.css +161 -0
- package/dist/ui.d.ts +172 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -174,12 +174,12 @@ Every component follows one contract ([ADR 0003](https://github.com/ie-huss-mart
|
|
|
174
174
|
| `TextField` | Single-line text: `text`, `search`, `email`, `url`, `tel` or `password`. Native input props pass through, plus `onValueChange(value)`. In a `Field`, it takes the field's label, description and error, and shows the error with its border |
|
|
175
175
|
| `TextArea` | Multi-line text, styled like `TextField` and with its tokens. `rows` sets its height, three by default, and the user can drag it taller. Native textarea props pass through, plus `onValueChange(value)`; the value separates lines with `\n`. In a `Field`, it takes the field's label, description and error |
|
|
176
176
|
| `ColorField` | A colour: a hex input (`#rrggbb` or `#rgb`, with or without the `#`) beside a preview, and optional `swatches` to pick from, each `{ value, label }`. Controlled with `value` and `onValueChange`, or uncontrolled from `defaultValue`; the value is always lowercase `#rrggbb`. Typing commits on Enter or blur, text that isn't a colour goes back to the last value, and Escape throws the typing away. The swatches are a radio group with one Tab stop, named after the field. It doesn't use the browser's own colour picker. In a `Field`, it takes the field's label, description and error |
|
|
177
|
-
| `Slider` | A value in a range, such as volume or zoom, on the native `<input type="range">`: `value` or `defaultValue`, `onValueChange`, `min`, `max`, `step` and `largeStep`. `formatValue` gives screen readers the value as text, such as "−6 dB". Arrow keys, Page Up and Down, Home and End work the same in every browser, mirrored in right-to-left text. In a `Toolbar`, it keeps the arrow keys, so put it last |
|
|
177
|
+
| `Slider` | A value in a range, such as volume or zoom, on the native `<input type="range">`: `value` or `defaultValue`, `onValueChange`, `min`, `max`, `step` and `largeStep`. `formatValue` gives screen readers the value as text, such as "−6 dB". Arrow keys, Page Up and Down, Home and End work the same in every browser, mirrored in right-to-left text. In a `Toolbar`, it keeps the arrow keys, so put it last. `onValueCommit(value)` is called once when a gesture that changed the value ends: the pointer let go, the last key let go, however long it repeated, or focus leaving first. Use it for an undo step, and `onValueChange` for what follows the value as it moves |
|
|
178
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 |
|
|
179
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 |
|
|
180
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
|
|
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 the row whose item receives focus is selected however focus arrives, including Tab; ← 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`, `TimelineLane`, `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, and with `selectionMode="single"` the focused clip is selected however focus arrives, including Tab and `focusClip`; 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. **Several tracks are lanes:** wrap each track's layers and clips in a `TimelineLane` with an `id`, a `label` and a `header`, its controls, which the lane renders as a toolbar that stays in view as time scrolls. Lanes stack under one playhead; ↑ and ↓ on a clip go to the clip nearest in time on the next lane. **Give every lane's `TimelineClips` the same `selectedKeys`:** it's the timeline's selection, a plain choice replaces it on every lane, and adding or removing keeps the other lanes' clips. A layer written outside the lanes covers them all, and `useTimelineLanes()` tells it the lane under a pointer. Below 720 px of the timeline's width, headers sit above their lanes. A timeline without lanes works as before. **Clips can have a start:** give every clip of a track `at`, in time order and without overlap, and each is placed there, with room wherever no clip is; give it to none, and they lie back to back. The two kinds share a timeline, a lane each, and every lane's clip edges are snap targets for all of them. When clips run past `length`, pass `extent`: the track is drawn that far, the playhead still ends at `length`, and those clips carry `data-hm-past-end` for you to dim. **Moving clips:** with `onDrop`, a clip is dragged with a mouse or pen, along time and to another lane, snapping its start or end to other clips; it's reported once, on release, as `{ by, lane }`, and `canDrop` lets you refuse a place, such as an overlap. Alt+↑ and Alt+↓ (Option on macOS) move clips to the lane above or below, through `onMoveLane`. `moveHandle="title"` makes only a clip's title the handle, so a press on the rest reaches a layer beneath, such as a range selection. **Also render buttons that move clips earlier, later and between lanes:** on a touch screen, they're the way to move a clip |
|
|
183
183
|
|
|
184
184
|
```tsx
|
|
185
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" | "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";
|
|
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" | "timeline-header-max-width" | "timeline-header-bg" | "timeline-lane-border-color" | "timeline-clip-moving-shadow" | "timeline-clip-refused-border-color" | "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
|
package/dist/index.js
CHANGED
|
@@ -1150,6 +1150,11 @@ var component = {
|
|
|
1150
1150
|
"timeline-clip-selected-bg": { fallback: "color-accent-subtle" },
|
|
1151
1151
|
"timeline-clip-selected-border-color": { fallback: "color-accent" },
|
|
1152
1152
|
"timeline-clip-edge-size": { fallback: "gap-normal" },
|
|
1153
|
+
"timeline-header-max-width": { fallback: "surface-width-small" },
|
|
1154
|
+
"timeline-header-bg": { fallback: "color-surface" },
|
|
1155
|
+
"timeline-lane-border-color": { fallback: "color-border" },
|
|
1156
|
+
"timeline-clip-moving-shadow": { fallback: "shadow-raised" },
|
|
1157
|
+
"timeline-clip-refused-border-color": { fallback: "color-danger-text" },
|
|
1153
1158
|
"color-field-gap": { fallback: "gap-tight" },
|
|
1154
1159
|
"color-field-swatch-size": { fallback: "control-height-small" },
|
|
1155
1160
|
"color-field-swatch-radius": { fallback: "radius-control" },
|