@greypan/web-ui 8.0.0 → 9.0.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.CN.md +277 -146
- package/README.md +323 -191
- package/dist/assets/glass.js +1 -1
- package/dist/assets/glass.js.map +1 -1
- package/dist/assets/menu-portal.js +1 -1
- package/dist/assets/menu-portal.js.map +1 -1
- package/dist/assets/selection-control.js +1 -1
- package/dist/assets/selection-control.js.map +1 -1
- package/dist/assets/toast-containers.js +1 -1
- package/dist/assets/toast-containers.js.map +1 -1
- package/dist/components/autocomplete/index.d.ts +3 -2
- package/dist/components/autocomplete/index.js +46 -50
- package/dist/components/autocomplete/index.js.map +1 -1
- package/dist/components/autocomplete/style.js +1 -1
- package/dist/components/autocomplete/style.js.map +1 -1
- package/dist/components/avatar/index.js.map +1 -1
- package/dist/components/avatar/style.js +1 -1
- package/dist/components/avatar/style.js.map +1 -1
- package/dist/components/back-top/style.js +1 -1
- package/dist/components/back-top/style.js.map +1 -1
- package/dist/components/badge/style.js +1 -1
- package/dist/components/badge/style.js.map +1 -1
- package/dist/components/button/index.d.ts +368 -1
- package/dist/components/button/index.js +56 -36
- package/dist/components/button/index.js.map +1 -1
- package/dist/components/button/style.js +1 -1
- package/dist/components/button/style.js.map +1 -1
- package/dist/components/button-group/index.js +0 -1
- package/dist/components/button-group/index.js.map +1 -1
- package/dist/components/button-group/style.js +1 -1
- package/dist/components/button-group/style.js.map +1 -1
- package/dist/components/checkbox/index.d.ts +3 -0
- package/dist/components/checkbox/index.js +35 -37
- package/dist/components/checkbox/index.js.map +1 -1
- package/dist/components/checkbox/style.js +1 -1
- package/dist/components/checkbox/style.js.map +1 -1
- package/dist/components/checkbox-group/index.js +8 -8
- package/dist/components/checkbox-group/style.js +1 -1
- package/dist/components/checkbox-group/style.js.map +1 -1
- package/dist/components/context-menu/index.d.ts +167 -3
- package/dist/components/context-menu/index.js +162 -91
- package/dist/components/context-menu/index.js.map +1 -1
- package/dist/components/context-menu/scrim.js +6 -0
- package/dist/components/context-menu/scrim.js.map +1 -0
- package/dist/components/context-menu/style.js +1 -1
- package/dist/components/context-menu/style.js.map +1 -1
- package/dist/components/dialog/index.d.ts +9 -0
- package/dist/components/dialog/index.js +61 -46
- package/dist/components/dialog/index.js.map +1 -1
- package/dist/components/dialog/style.js +1 -1
- package/dist/components/dialog/style.js.map +1 -1
- package/dist/components/drawer/index.d.ts +45 -0
- package/dist/components/drawer/index.js +116 -52
- package/dist/components/drawer/index.js.map +1 -1
- package/dist/components/drawer/style.js +1 -1
- package/dist/components/drawer/style.js.map +1 -1
- package/dist/components/dropdown/index.d.ts +12 -0
- package/dist/components/dropdown/index.js +13 -10
- package/dist/components/dropdown/index.js.map +1 -1
- package/dist/components/dropdown-divider/style.js +1 -1
- package/dist/components/dropdown-divider/style.js.map +1 -1
- package/dist/components/dropdown-header/style.js +1 -1
- package/dist/components/dropdown-header/style.js.map +1 -1
- package/dist/components/dropdown-item/style.js +1 -1
- package/dist/components/dropdown-item/style.js.map +1 -1
- package/dist/components/editable-text/index.d.ts +41 -0
- package/dist/components/editable-text/index.js +55 -31
- package/dist/components/editable-text/index.js.map +1 -1
- package/dist/components/empty/index.d.ts +21 -4
- package/dist/components/empty/index.js +37 -32
- package/dist/components/empty/index.js.map +1 -1
- package/dist/components/empty/style.js +1 -1
- package/dist/components/empty/style.js.map +1 -1
- package/dist/components/icon/index.js +7 -7
- package/dist/components/icon/index.js.map +1 -1
- package/dist/components/image-preview/index.js +9 -2
- package/dist/components/image-preview/index.js.map +1 -1
- package/dist/components/image-preview/style.js +1 -1
- package/dist/components/image-preview/style.js.map +1 -1
- package/dist/components/index.js +23 -23
- package/dist/components/input/index.d.ts +7 -0
- package/dist/components/input/index.js +34 -29
- package/dist/components/input/index.js.map +1 -1
- package/dist/components/input/style.js +1 -1
- package/dist/components/input/style.js.map +1 -1
- package/dist/components/input-number/index.d.ts +1 -0
- package/dist/components/input-number/index.js +28 -26
- package/dist/components/input-number/index.js.map +1 -1
- package/dist/components/input-number/style.js +1 -1
- package/dist/components/input-number/style.js.map +1 -1
- package/dist/components/layout/index.d.ts +0 -3
- package/dist/components/layout/index.js +1 -1
- package/dist/components/layout/index.js.map +1 -1
- package/dist/components/layout/style.js +1 -1
- package/dist/components/layout/style.js.map +1 -1
- package/dist/components/option/style.js +1 -1
- package/dist/components/option/style.js.map +1 -1
- package/dist/components/popover/index.js.map +1 -1
- package/dist/components/popover/style.js +1 -1
- package/dist/components/popover/style.js.map +1 -1
- package/dist/components/radio/index.d.ts +3 -0
- package/dist/components/radio/index.js +23 -19
- package/dist/components/radio/index.js.map +1 -1
- package/dist/components/radio/style.js +1 -1
- package/dist/components/radio/style.js.map +1 -1
- package/dist/components/radio-group/index.js +8 -8
- package/dist/components/radio-group/style.js +1 -1
- package/dist/components/radio-group/style.js.map +1 -1
- package/dist/components/segmented/index.d.ts +5 -0
- package/dist/components/segmented/index.js +49 -32
- package/dist/components/segmented/index.js.map +1 -1
- package/dist/components/segmented/style.js +1 -1
- package/dist/components/segmented/style.js.map +1 -1
- package/dist/components/segmented-trigger/style.js +1 -1
- package/dist/components/segmented-trigger/style.js.map +1 -1
- package/dist/components/select/index.js +0 -1
- package/dist/components/select/index.js.map +1 -1
- package/dist/components/select/style.js +1 -1
- package/dist/components/select/style.js.map +1 -1
- package/dist/components/slider/index.js +9 -9
- package/dist/components/slider/style.js +1 -1
- package/dist/components/slider/style.js.map +1 -1
- package/dist/components/spinner/style.js +1 -1
- package/dist/components/spinner/style.js.map +1 -1
- package/dist/components/svg-draw-lines/index.js.map +1 -1
- package/dist/components/switch/index.d.ts +1 -0
- package/dist/components/switch/index.js +26 -24
- package/dist/components/switch/index.js.map +1 -1
- package/dist/components/switch/style.js +1 -1
- package/dist/components/switch/style.js.map +1 -1
- package/dist/components/textarea/index.d.ts +7 -1
- package/dist/components/textarea/index.js +45 -43
- package/dist/components/textarea/index.js.map +1 -1
- package/dist/components/textarea/style.js +1 -1
- package/dist/components/textarea/style.js.map +1 -1
- package/dist/components/theme/index.d.ts +9 -0
- package/dist/components/theme/index.js +128 -85
- package/dist/components/theme/index.js.map +1 -1
- package/dist/components/theme/style.js +1 -1
- package/dist/components/theme/style.js.map +1 -1
- package/dist/components/toast/style.js +1 -1
- package/dist/components/toast/style.js.map +1 -1
- package/dist/components/toast/toast.js +8 -8
- package/dist/components/toast/toast.js.map +1 -1
- package/dist/components/tooltip/index.js.map +1 -1
- package/dist/components/tooltip/style.js +1 -1
- package/dist/components/tooltip/style.js.map +1 -1
- package/dist/icons/generated/akar-icons-check.d.ts +6 -0
- package/dist/icons/generated/akar-icons-check.js +10 -0
- package/dist/icons/generated/akar-icons-check.js.map +1 -0
- package/dist/icons/generated/akar-icons-circle-check.d.ts +6 -0
- package/dist/icons/generated/akar-icons-circle-check.js +10 -0
- package/dist/icons/generated/akar-icons-circle-check.js.map +1 -0
- package/dist/icons/generated/bi-check-lg.d.ts +6 -0
- package/dist/icons/generated/bi-check-lg.js +10 -0
- package/dist/icons/generated/bi-check-lg.js.map +1 -0
- package/dist/icons/generated/bi-check.d.ts +6 -0
- package/dist/icons/generated/bi-check.js +10 -0
- package/dist/icons/generated/bi-check.js.map +1 -0
- package/dist/icons/generated/fluent-tag-search-24-regular.d.ts +6 -0
- package/dist/icons/generated/fluent-tag-search-24-regular.js +10 -0
- package/dist/icons/generated/fluent-tag-search-24-regular.js.map +1 -0
- package/dist/icons/generated/mdi-tag-search-outline.d.ts +6 -0
- package/dist/icons/generated/mdi-tag-search-outline.js +10 -0
- package/dist/icons/generated/mdi-tag-search-outline.js.map +1 -0
- package/dist/icons/index.d.ts +6 -0
- package/dist/icons/index.js +7 -1
- package/dist/shared/element-height/index.js +47 -0
- package/dist/shared/element-height/index.js.map +1 -0
- package/dist/shared/form-association/field-id.js +9 -0
- package/dist/shared/form-association/field-id.js.map +1 -0
- package/dist/shared/form-association/index.js +9 -1
- package/dist/shared/form-association/index.js.map +1 -1
- package/dist/shared/label-emptiness/index.js +45 -0
- package/dist/shared/label-emptiness/index.js.map +1 -0
- package/dist/shared/menu-portal/menu-portal.js +11 -11
- package/dist/shared/menu-portal/menu-portal.js.map +1 -1
- package/dist/shared/menu-portal/menu-tree.js +2 -2
- package/dist/shared/menu-portal/menu-tree.js.map +1 -1
- package/dist/shared/overlay/anchored-panel.js.map +1 -1
- package/dist/shared/overlay/native-dialog-presence.js +23 -11
- package/dist/shared/overlay/native-dialog-presence.js.map +1 -1
- package/dist/shared/overlay/nested-drawer-layers.js +30 -23
- package/dist/shared/overlay/nested-drawer-layers.js.map +1 -1
- package/dist/shared/scroll-lock/scroll-lock.js +3 -3
- package/dist/shared/scroll-lock/scroll-lock.js.map +1 -1
- package/dist/shared/theme/root-sync.js +24 -18
- package/dist/shared/theme/root-sync.js.map +1 -1
- package/package.json +8 -4
package/README.md
CHANGED
|
@@ -25,6 +25,8 @@ import '@greypan/web-ui'
|
|
|
25
25
|
// import '@greypan/web-ui/components/button'
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
+
A subpath import registers only the component it names, so import every tag the page uses.
|
|
29
|
+
|
|
28
30
|
```html
|
|
29
31
|
<web-ui-button variant="primary">Click me</web-ui-button> <web-ui-icon .icon="${lucidePlus}"></web-ui-icon>
|
|
30
32
|
```
|
|
@@ -43,7 +45,7 @@ camelCase, Attributes use kebab-case, Events use kebab-case.
|
|
|
43
45
|
| Event | kebab-case | `open-change`, `sidebar-collapsed-change` |
|
|
44
46
|
|
|
45
47
|
- **Boolean attributes** follow native HTML presence semantics: absent → `false`, presence → `true`. A framework
|
|
46
|
-
binding that writes `disabled="false"` produces the string `"false"`, which is truthy
|
|
48
|
+
binding that writes `disabled="false"` produces the string `"false"`, which is truthy. **Bind dynamic booleans as
|
|
47
49
|
properties** (camelCase), not attributes, so `false` is written as a real property.
|
|
48
50
|
- **Vue**: dynamic binding must go to **Properties** with camelCase names (`:sidebarCollapsed="x"`, `:open="x"`).
|
|
49
51
|
A kebab-case binding like `:sidebar-collapsed="x"` is written as a string attribute and cannot express `false`;
|
|
@@ -52,7 +54,7 @@ camelCase, Attributes use kebab-case, Events use kebab-case.
|
|
|
52
54
|
`v-model` is supported on value-bearing controls (`web-ui-input`, `web-ui-select`, `web-ui-autocomplete`, …) and
|
|
53
55
|
compiles to the element `value` property + `input` event.
|
|
54
56
|
- **React**: React 19 writes DOM properties for custom-element props, so use camelCase props (`open={open}`,
|
|
55
|
-
`noScrollLock`, `value={value}`). Never pass complex data (objects, arrays) through attribute strings
|
|
57
|
+
`noScrollLock`, `value={value}`). Never pass complex data (objects, arrays) through attribute strings. Bind
|
|
56
58
|
them as properties. Kebab-case JSX props on a custom element are written as attributes.
|
|
57
59
|
|
|
58
60
|
### React
|
|
@@ -90,7 +92,7 @@ function App() {
|
|
|
90
92
|
|
|
91
93
|
React 19 registers Custom Element events using the suffix of the JSX `on` key unchanged. Event names are
|
|
92
94
|
case-sensitive: bind `open-change` as `onopen-change`, not `onOpenChange`. Standard `input`, `change`, `focus`,
|
|
93
|
-
and `blur` events use React's conventional `onInput`, `onChange`, `onFocus`, and `onBlur` handlers
|
|
95
|
+
and `blur` events use React's conventional `onInput`, `onChange`, `onFocus`, and `onBlur` handlers. Their
|
|
94
96
|
`currentTarget` is typed as the component instance, so `value` and `checked` are read cast-free. The `target`
|
|
95
97
|
follows React SyntheticEvent semantics (`EventTarget`) and is not narrowed. Kebab-case custom events carry their
|
|
96
98
|
`CustomEvent` detail typed. Boolean properties follow native HTML semantics: absence is `false` and presence is
|
|
@@ -126,7 +128,7 @@ useEffect(() => {
|
|
|
126
128
|
In `portal` mode the library physically moves panel content into the overlay Shadow DOM:
|
|
127
129
|
|
|
128
130
|
- React removes nodes through its recorded insertion parent, so a bare conditional child (`{condition && <el/>}`) whose node was already migrated cannot be removed while the panel is open: the commit fails and the node can reappear when the panel closes.
|
|
129
|
-
- Conditionally render inside a stable wrapper element instead
|
|
131
|
+
- Conditionally render inside a stable wrapper element instead. React records the wrapper as the insertion parent, so wrapper-local additions and removals keep working while the panel is open and across open/close cycles (example below).
|
|
130
132
|
- Bare conditional additions while the panel is open (appending to the host) keep working and migrate into the panel automatically.
|
|
131
133
|
- Keeping content mounted and toggling visibility remains a valid fallback.
|
|
132
134
|
|
|
@@ -143,12 +145,12 @@ Portal panels support live rendering for Lit child parts: `${condition ? html`<e
|
|
|
143
145
|
automatically, removals and element-to-element swaps work while the panel is open, and on close content is
|
|
144
146
|
restored to its original anchor position. lit-html child-part markers stay in the host light DOM, so
|
|
145
147
|
subsequent patches keep anchoring correctly. Boundary: reordering a `repeat()` list while a panel is open is
|
|
146
|
-
not supported
|
|
148
|
+
not supported. Lit inserts relative to host part markers while sibling items already live in the panel, the
|
|
147
149
|
same cross-container anchoring boundary as Vue's keyed `v-for`. Apply list reorders while the panel is closed.
|
|
148
150
|
|
|
149
151
|
`web-ui-dropdown` manages menu items through the shared menu portal, which reconciles from both the host and
|
|
150
152
|
the panel: child-part additions while the panel is open work, but lit cannot reach items that already live in
|
|
151
|
-
the panel, so removals and element swaps there are not supported
|
|
153
|
+
the panel, so removals and element swaps there are not supported. Apply them while the panel is closed.
|
|
152
154
|
`web-ui-context-menu` does not observe host-side insertions and is not covered by these live-rendering
|
|
153
155
|
guarantees.
|
|
154
156
|
|
|
@@ -160,7 +162,7 @@ Portal panels support live rendering: content conditionally added or removed whi
|
|
|
160
162
|
`v-if` inside `web-ui-select`, `web-ui-autocomplete`, `web-ui-popover`, `web-ui-tooltip`, `web-ui-dropdown`,
|
|
161
163
|
`web-ui-context-menu`) migrates into the open panel automatically in template order, and on close everything
|
|
162
164
|
is restored to its original anchor position so subsequent patches keep working. Boundary: splicing or
|
|
163
|
-
reordering a keyed `v-for` list while a panel is open is not supported
|
|
165
|
+
reordering a keyed `v-for` list while a panel is open is not supported. Vue's keyed children diff resolves
|
|
164
166
|
insertion anchors against sibling nodes already migrated into the panel, so its patch fails and items can be
|
|
165
167
|
lost, regardless of compilation path (compiled templates included). Apply such list updates while the panel
|
|
166
168
|
is closed, or keep to appends/removals at the list tail.
|
|
@@ -192,7 +194,7 @@ import '@greypan/web-ui/types/vue'
|
|
|
192
194
|
```
|
|
193
195
|
|
|
194
196
|
Boolean properties must be bound with the **camelCase property name**, not the kebab-case attribute. Vue writes
|
|
195
|
-
attribute bindings as strings, and boolean attributes follow presence semantics
|
|
197
|
+
attribute bindings as strings, and boolean attributes follow presence semantics, so `:sidebar-collapsed="false"`
|
|
196
198
|
produces the string `"false"`, which is truthy. Binding the camelCase name (`:sidebarCollapsed="false"`, or the
|
|
197
199
|
`.prop` modifier) makes Vue write the DOM property directly:
|
|
198
200
|
|
|
@@ -240,20 +242,20 @@ family by the nature of the interaction. Do not assume `controlled` means the sa
|
|
|
240
242
|
**User-originated events only (all `open`-style components: collapse, popover, dropdown, tooltip, dialog, drawer, back-top).**
|
|
241
243
|
`*-change` events (`open-change`, etc.) fire only for user-originated toggles; assigning the property programmatically
|
|
242
244
|
(`el.open = true`) or calling an imperative method (`show()`, `close()`, `toggle()`) never emits. Components self-manage
|
|
243
|
-
their `open` value unless you coordinate externally
|
|
245
|
+
their `open` value unless you coordinate externally. You may observe the event and write it back for your own state, but
|
|
244
246
|
the component does not require or wait for that write-back.
|
|
245
247
|
|
|
246
248
|
**Request-then-write-back (`controlled` on dialog and drawer only).**
|
|
247
249
|
With `controlled`, user close actions (Escape, backdrop, built-in close, drag-release) only _request_ `open=false`; the
|
|
248
250
|
component does not change its own state, and it stays open until the consumer writes `open=false`. This is the modal
|
|
249
|
-
confirmation semantics
|
|
251
|
+
confirmation semantics. Closing a dialog or drawer is typically an operation that needs consumer approval (unsaved form,
|
|
250
252
|
confirmation), and unlike instantaneous open/close, it is not safe for the component to self-commit. Only these two modal
|
|
251
253
|
components use this mode; the instant open/close family (collapse, popover, dropdown, tooltip) does not need it.
|
|
252
254
|
|
|
253
255
|
**Native form-model (input, textarea, input-number, select, checkbox, radio, switch, autocomplete).**
|
|
254
256
|
The control manages its own value/checked state internally; user interaction flips it immediately and then dispatches
|
|
255
257
|
native `input`/`change` events. Assigning the property programmatically (`el.checked = true`) overrides the internal
|
|
256
|
-
state. This mirrors native `<input type="checkbox"
|
|
258
|
+
state. This mirrors native `<input type="checkbox">`. There is no `controlled` prop because the value is always readable
|
|
257
259
|
and writable, and React/Vue layers provide their own controlled wrappers on top.
|
|
258
260
|
|
|
259
261
|
For interactions that need an external round-trip before the flip is durable (e.g. a switch that should only stay on
|
|
@@ -269,6 +271,8 @@ The flip-before-approval window is accepted; there is no `controlled` prop for a
|
|
|
269
271
|
|
|
270
272
|
All form controls participate in native `FormData`, constraint validation, `form.reset()` and browser form-state restoration. The control captures its reset default once, after declarative attributes have been applied on its first connection. Later runtime property updates do not redefine that default. A disabled ancestor `fieldset` disables validation and interaction without mutating the control's public `disabled` property. For checkbox/radio groups, the group is the single submission, reset and restoration owner; managed child controls do not submit or restore an independent state.
|
|
271
273
|
|
|
274
|
+
`web-ui-button` is also form-associated so its host can own an outer form and forward `submit`/`reset` activation. It contributes no value to `FormData`.
|
|
275
|
+
|
|
272
276
|
## All Components
|
|
273
277
|
|
|
274
278
|
| Category | Component |
|
|
@@ -338,7 +342,7 @@ Text input with clearable, prefix/suffix slots.
|
|
|
338
342
|
|
|
339
343
|
**Events:** `input`, `change`, `focus`, `blur`
|
|
340
344
|
|
|
341
|
-
**Methods:** `focus()`, `blur()`
|
|
345
|
+
**Methods:** `focus()`, `blur()`, `select()`, which delegate to the internal native input (the host itself is not focusable). `focus()` and `select()` are no-ops while `disabled`; `readonly` still allows focus and selection.
|
|
342
346
|
|
|
343
347
|
**Slots:** `prefix`, `default`, `suffix`
|
|
344
348
|
|
|
@@ -352,28 +356,28 @@ Text input with clearable, prefix/suffix slots.
|
|
|
352
356
|
|
|
353
357
|
Multi-line text input with auto-resize.
|
|
354
358
|
|
|
355
|
-
| Attribute | Type | Default | Description
|
|
356
|
-
| ----------------- | --------- | ------- |
|
|
357
|
-
| `value` | `string` | `''` | Textarea value
|
|
358
|
-
| `placeholder` | `string` | `''` | Placeholder text
|
|
359
|
-
| `rows` | `number` | `3` | Visible rows
|
|
360
|
-
| `name` | `string` | `''` | Form field name
|
|
361
|
-
| `disabled` | `boolean` | `false` | Disabled state
|
|
362
|
-
| `readonly` | `boolean` | `false` | Read-only state
|
|
363
|
-
| `required` | `boolean` | `false` | Required validation
|
|
364
|
-
| `clearable` | `boolean` | `false` | Show clear button
|
|
365
|
-
| `full` | `boolean` | `false` | Full width
|
|
366
|
-
| `borderless` | `boolean` | `false` | Ghost form: removes border, background, and shadow; keeps padding, height metrics, and focus ring
|
|
367
|
-
| `autosize` | `boolean` | `false` | Auto-resize height
|
|
368
|
-
| `max-height` | `number` | `0` | Autosize max height (px); `0` = unlimited
|
|
369
|
-
| `minlength` | `number` | — | Minimum length validation
|
|
370
|
-
| `maxlength` | `number` | — | Maximum length validation
|
|
371
|
-
| `aria-label` | `string` | — | Accessible label
|
|
372
|
-
| `aria-labelledby` | `string` | — | Accessible label reference
|
|
359
|
+
| Attribute | Type | Default | Description |
|
|
360
|
+
| ----------------- | --------- | ------- | ---------------------------------------------------------------------------------------------------- |
|
|
361
|
+
| `value` | `string` | `''` | Textarea value |
|
|
362
|
+
| `placeholder` | `string` | `''` | Placeholder text |
|
|
363
|
+
| `rows` | `number` | `3` | Visible rows |
|
|
364
|
+
| `name` | `string` | `''` | Form field name |
|
|
365
|
+
| `disabled` | `boolean` | `false` | Disabled state |
|
|
366
|
+
| `readonly` | `boolean` | `false` | Read-only state |
|
|
367
|
+
| `required` | `boolean` | `false` | Required validation |
|
|
368
|
+
| `clearable` | `boolean` | `false` | Show clear button |
|
|
369
|
+
| `full` | `boolean` | `false` | Full width |
|
|
370
|
+
| `borderless` | `boolean` | `false` | Ghost form: removes border, background, and shadow; keeps padding, height metrics, and focus ring |
|
|
371
|
+
| `autosize` | `boolean` | `false` | Auto-resize height; also forces `resize: none`, because the native grip fights a script-owned height |
|
|
372
|
+
| `max-height` | `number` | `0` | Autosize max height (px); `0` = unlimited |
|
|
373
|
+
| `minlength` | `number` | — | Minimum length validation |
|
|
374
|
+
| `maxlength` | `number` | — | Maximum length validation |
|
|
375
|
+
| `aria-label` | `string` | — | Accessible label |
|
|
376
|
+
| `aria-labelledby` | `string` | — | Accessible label reference |
|
|
373
377
|
|
|
374
378
|
**Events:** `input`, `change`, `focus`, `blur`
|
|
375
379
|
|
|
376
|
-
**Methods:** `focus()`, `blur()`, `select()`
|
|
380
|
+
**Methods:** `focus()`, `blur()`, `select()`, which delegate to the internal native textarea. `focus()` and `select()` are no-ops while `disabled`; `readonly` still allows focus and selection.
|
|
377
381
|
|
|
378
382
|
**Slots:** `prefix`, `suffix`
|
|
379
383
|
|
|
@@ -388,13 +392,15 @@ Multi-line text input with auto-resize.
|
|
|
388
392
|
|
|
389
393
|
Inline plain-text editor: click the text to edit in place, `Enter` and `blur` commit, `Escape` cancels. The text layer and the editing layer share one box, so entering edit mode does not move a single pixel.
|
|
390
394
|
|
|
391
|
-
| Attribute
|
|
392
|
-
|
|
|
393
|
-
| `value`
|
|
394
|
-
| `placeholder`
|
|
395
|
-
| `name`
|
|
396
|
-
| `disabled`
|
|
397
|
-
| `
|
|
395
|
+
| Attribute | Type | Default | Description |
|
|
396
|
+
| ------------------- | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
397
|
+
| `value` | `string` | `''` | Current value; the declarative value captured on first connection becomes the `form.reset()` default; later attribute or property changes do not update it |
|
|
398
|
+
| `placeholder` | `string` | `''` | Text shown while the value is empty |
|
|
399
|
+
| `name` | `string` | `''` | Form field name |
|
|
400
|
+
| `disabled` | `boolean` | `false` | Disabled state; behavior only, no visual dimming |
|
|
401
|
+
| `readonly` | `boolean` | `false` | Read-only state; focus, selection, and copying remain available, but edits cannot commit |
|
|
402
|
+
| `commit-on-unmount` | `boolean` | `false` | End an in-progress edit by committing when the element is unmounted; see below |
|
|
403
|
+
| `aria-label` | `string` | — | Accessible label |
|
|
398
404
|
|
|
399
405
|
**Events:** `input` (per keystroke), `change` (commit), `cancel` (cancel; shares its name with the native `<dialog>` `cancel`, so it neither bubbles nor crosses shadow boundaries and is dispatched on the component itself only). React has no synthetic event covering `cancel`: listen with `addEventListener('cancel', ...)`
|
|
400
406
|
|
|
@@ -402,7 +408,19 @@ Inline plain-text editor: click the text to edit in place, `Enter` and `blur` co
|
|
|
402
408
|
|
|
403
409
|
Clicking places the caret at the clicked offset; keyboard focus places it at the end of the text. `Enter` and `blur` both commit the draft and dispatch `change` exactly once; `Enter` does not insert a newline and returns focus to the host, while `blur` leaves the focus wherever the user moved it. `Escape` alone cancels: the value returns to what it was when editing started, `cancel` is dispatched with no `change`, focus returns to the host, and the key is consumed by the editing layer, so an outer overlay (drawer, menu) is not closed by the same press. The `cancel` event neither bubbles nor crosses shadow boundaries and is dispatched on the component itself only: when the component is projected inside an overlay's shadow root, such as a drawer title, it never reaches the overlay's native `cancel` close pipeline, so listen on the component itself. A value that already contains newlines still renders as several lines; only typing `Enter` no longer adds one. An empty value keeps showing the placeholder, and the editing layer always sizes itself to its own content, so an empty or whitespace-only draft still has room for the caret even where the host itself collapses (a flex item with `min-width: 0`, a table cell).
|
|
404
410
|
|
|
405
|
-
`select()` enters edit mode with the whole content selected, and re-selects it when already editing. While `disabled` it does nothing, matching `focus()`.
|
|
411
|
+
`select()` enters edit mode with the whole content selected, and re-selects it when already editing. While `disabled` it does nothing, matching `focus()`. While `readonly`, focus and selection remain available, but input is rejected and leaving edit mode does not dispatch `change`.
|
|
412
|
+
|
|
413
|
+
**Unmounting mid-edit.** What happens when an element being edited is removed from the DOM depends on the engine, and the difference is the reason this property exists:
|
|
414
|
+
|
|
415
|
+
- **Chromium** dispatches `blur` on the editing layer, so a plain `value` commit already happens today and the default `false` leaves that untouched. `blur` and the `change` it triggers are dispatched synchronously _after_ the unmount callback has run, so the commit arrives after whatever state the caller updates in response to the removal has already been applied.
|
|
416
|
+
- **WebKit (Safari, iOS)** dispatches no `blur` at all. With the default `false` nothing is committed and the draft is dropped along with the element.
|
|
417
|
+
- **Gecko (Firefox)** is **unverified**: no Firefox build would start on the machine this was measured on, so nothing is claimed here. Treat Gecko as unknown rather than as matching either column above, and enable the property if you need the unmount commit to be the thing that saves the draft.
|
|
418
|
+
|
|
419
|
+
If your code relies on a draft surviving the row being recycled, **enable `commit-on-unmount`**: on Safari and iOS it is the only thing that saves the draft, and in Chromium it moves the commit ahead of the removal-driven `blur`. In both engines the unmount then ends an open editing session by committing — the draft becomes the new value, edit mode exits, and `change` is dispatched exactly once, from the same code `Enter` and `blur` use. Measured on Chromium and WebKit; the browser test suite runs on Chromium only, so the WebKit result comes from a one-off cross-engine run rather than from CI, and Gecko was not measured at all.
|
|
420
|
+
|
|
421
|
+
Unlike `Enter` and `blur`, which a user action triggers and which therefore always count as an intent to commit, unmount carries no such intent. The commit therefore only fires when the draft really differs from the value captured when editing began, so a session that changed nothing does not produce an empty `change`. An element that is not editing at all has nothing to commit and dispatches nothing, and neither does one that is `disabled` or `readonly` — matching the `blur` path, which dispatches no commit in either state. What happens to a draft that already exists differs between the two, though: under `disabled` the draft stays on the element, while under `readonly` it is genuinely lost. `readonly` does not retract input typed earlier, and on unmount there is no `blur` left to commit it — on WebKit there is no `blur` at all. The path is reachable: enter editing while editable, type a draft, flip to `readonly`, then unmount. It is not treated as a cancel, because cancelling means restoring the value editing started from and there is no focus to return or host to hand a result to at unmount; the user simply sees their typing disappear, with neither `change` nor `cancel`.
|
|
422
|
+
|
|
423
|
+
The commit fires from the unmount callback, so `change` still travels the composed path and reaches listeners on the component or any ancestor, including ancestors that are themselves being unmounted: dispatching does not require an ancestor to still be in the document. Listeners must therefore not assume the component is still connected; hand the result to state outside the host tree explicitly (for example in a `queueMicrotask`) when it has to outlive the removal. Note that this reach is not guaranteed for an unmount React drives from its own render: such a removal never reaches React's delegated event root, so `onChange` will not fire there and the value has to be read from the element instead — the same caveat that applies to `cancel` above. Setting `display: none` on an ancestor is not a removal — the component stays connected and dispatches nothing in either engine, so end the edit explicitly in that case.
|
|
406
424
|
|
|
407
425
|
The host is an inline-level box: it sizes to its content unless a width is set, and grows with wrapped lines. Font, color, text alignment and white space are inherited from the surrounding context, so the component reads as ordinary text until it is edited.
|
|
408
426
|
|
|
@@ -457,7 +475,7 @@ Select dropdown with option items, keyboard navigation, and portal support.
|
|
|
457
475
|
|
|
458
476
|
**Events:** `input`, `change`, `open-change` (`CustomEvent<{ open: boolean }>`)
|
|
459
477
|
|
|
460
|
-
**Slots:** `default` (project `<web-ui-option>` elements), `trigger` (custom trigger content
|
|
478
|
+
**Slots:** `default` (project `<web-ui-option>` elements), `trigger` (custom trigger content, replacing the default label and chevron area)
|
|
461
479
|
|
|
462
480
|
**Methods:** none
|
|
463
481
|
|
|
@@ -501,11 +519,11 @@ Editable combobox with input filtering and single option selection.
|
|
|
501
519
|
|
|
502
520
|
**Methods:** `focus()`, `blur()`
|
|
503
521
|
|
|
504
|
-
**Slots:** `default` (project `<web-ui-option>` elements), `trigger` (custom trigger content
|
|
522
|
+
**Slots:** `default` (project `<web-ui-option>` elements), `trigger` (custom trigger content, replacing the default input)
|
|
505
523
|
|
|
506
|
-
Typing filters the option list by label (`contains` or `prefix`, or `none` to disable filtering). Selecting an option fills the input with its label and exposes the option's value via `selected-value`; `change` fires on selection commit. Supports ArrowDown/ArrowUp/Enter/Escape keyboard navigation.
|
|
524
|
+
Typing filters the option list by label (`contains` or `prefix`, or `none` to disable filtering). When no option matches, the dropdown stays closed; deleting characters so at least one option matches reopens it. Selecting an option fills the input with its label and exposes the option's value via `selected-value`; `change` fires on selection commit. Supports ArrowDown/ArrowUp/Enter/Escape keyboard navigation.
|
|
507
525
|
|
|
508
|
-
**Trigger:** the default trigger is an internal `web-ui-input`. Put any editable component in the `trigger` slot to replace it
|
|
526
|
+
**Trigger:** the default trigger is an internal `web-ui-input`. Put any editable component in the `trigger` slot to replace it. The wrapper keeps the combobox ARIA and marks itself with `data-custom-trigger`, and the dropdown stays anchored to the trigger element. Programmatic `focus()` / `blur()` delegate to the active trigger: `web-ui-input` and `web-ui-textarea` move focus to their native control, while a custom trigger without its own focus redirection is focused as the host itself.
|
|
509
527
|
|
|
510
528
|
```html
|
|
511
529
|
<web-ui-autocomplete placeholder="Describe the issue">
|
|
@@ -517,11 +535,9 @@ Typing filters the option list by label (`contains` or `prefix`, or `none` to di
|
|
|
517
535
|
|
|
518
536
|
The custom trigger exposes the same contract as the default one: a string `value` for the text, focusable, and the events the component delegates from it (`input`, `click`, `focus`, `blur`). `web-ui-input` and `web-ui-textarea` satisfy it as-is; a custom element is usable when it exposes a string `value` property. The wrapper div is not a tab stop (`tabindex="-1"`): sequential focus belongs to the trigger itself, so a custom trigger has to be focusable for keyboard users to reach the combobox.
|
|
519
537
|
|
|
520
|
-
Multiline triggers (a trigger whose editable element is a `<textarea>`) keep Enter for newlines: Enter never selects the highlighted option and never commits a custom value
|
|
521
|
-
|
|
522
|
-
When `allow-custom-value` is enabled, pressing Enter with no active option and no matching candidate commits the raw input as a custom value and closes the panel. `change` fires and `selected-value` remains empty. The component does not create an option automatically or trim the raw value. Text matching a disabled option cannot bypass the disabled state or derive as a selected option.
|
|
538
|
+
Multiline triggers (a trigger whose editable element is a `<textarea>`) keep Enter for newlines: Enter never selects the highlighted option and never commits a custom value; close the panel with Escape or blur. Selecting an option still writes its label back to the trigger. A single-line custom trigger keeps the default Enter behavior. ArrowUp/ArrowDown follow the same exception while the panel is open: they move the text caret instead of navigating options, so keyboard option navigation is unavailable in that state. Select with a pointer click. With the panel closed, ArrowDown/ArrowUp still open it.
|
|
523
539
|
|
|
524
|
-
|
|
540
|
+
When `allow-custom-value` is enabled, pressing Enter with no active option and no matching candidate commits the raw input as a custom value and keeps the dropdown closed. `change` fires and `selected-value` remains empty. The component does not create an option automatically or trim the raw value. Text matching a disabled option cannot bypass the disabled state or derive as a selected option.
|
|
525
541
|
|
|
526
542
|
**CSS Custom Properties:**
|
|
527
543
|
|
|
@@ -585,11 +601,11 @@ Individual checkbox.
|
|
|
585
601
|
|
|
586
602
|
Uses native `<label>` with `role="checkbox"` and `aria-checked`. Enter/Space keyboard toggle.
|
|
587
603
|
|
|
588
|
-
**Layout:** the host is an inline-flex box whose height is set by its content, so the inherited page line-height can no longer inflate it or shift the indicator up and down; it aligns against surrounding text with `vertical-align: middle`. The indicator measures `--wui-selection-control-size` (`18px`), and `<web-ui-radio>` shares the same box contract.
|
|
604
|
+
**Layout:** the host is an inline-flex box whose height is set by its content, so the inherited page line-height can no longer inflate it or shift the indicator up and down; it aligns against surrounding text with `vertical-align: middle`. The indicator measures `--wui-selection-control-size` (`18px`), and `<web-ui-radio>` shares the same box contract. The 10px between indicator and label belongs to the label: when the default slot renders nothing — it is empty, or it carries only a visually hidden accessible name such as an `.sr-only` span — the gap collapses and the host is exactly as wide as the indicator. Emptiness is decided from the label's rendered width rather than from the slot's assigned nodes, because a hidden name is assigned content that paints no box, and hiding the label with `display: none` would take that name out of the accessibility tree.
|
|
589
605
|
|
|
590
|
-
**Check animation:** the checkmark is
|
|
606
|
+
**Check animation:** the checkmark is a stroked check from `@/icons`, rendered by a nested `<web-ui-icon>` inside `<web-ui-svg-draw-lines>` (with `no-autoplay`, so a control that mounts already checked shows a static check). Checking draws it in from the left tip at a constant speed over `--wui-duration-trigger` (160ms by default), read from the resolved theme at the time of the toggle so the stroke lands on the same beat as the indicator's background transition; unchecking retracts the same path back to blank instead of only fading out. Neither plays inside a `motion="reduced"` theme scope, where both states switch instantly. The stroke color is `--wui-color-on-control`, passed down through `<web-ui-icon>`'s `--wui-icon-color`, because the indicator behind it is `--wui-color-accent` once checked. Two constraints follow from that arrangement: the asset has to stay stroked (`fill: none` + `stroke: currentColor`) — a solid icon animates the dash but paints nothing, so the check would just appear — and it renders at `<web-ui-icon>`'s own default 18px, since the host cannot reach the `<svg>` inside the icon's shadow root to scale it with `--wui-selection-control-size`.
|
|
591
607
|
|
|
592
|
-
**Idle states:** the unchecked indicator is filled with `--wui-color-surface-control`, the same control surface neutral buttons use, so it stays separable from `--wui-color-page` in dark mode. Hovering
|
|
608
|
+
**Idle states:** the unchecked indicator is filled with `--wui-color-surface-control`, the same control surface neutral buttons use, so it stays separable from `--wui-color-page` in dark mode. Hovering over the indicator, the gap or the slotted label inside the trigger row tints that surface with a 6% state layer over `--wui-color-surface-control`. Hover applies only on `(hover: hover) and (pointer: fine)` devices; there is no pressed state, and checked and disabled controls keep their own surface. `<web-ui-radio>` shares the same states.
|
|
593
609
|
|
|
594
610
|
#### `<web-ui-radio>`
|
|
595
611
|
|
|
@@ -607,7 +623,7 @@ Individual radio button.
|
|
|
607
623
|
|
|
608
624
|
**Slots:** `default` (label text)
|
|
609
625
|
|
|
610
|
-
**Layout:** shares the selection-control box contract with `<web-ui-checkbox
|
|
626
|
+
**Layout:** shares the selection-control box contract with `<web-ui-checkbox>`, including the rule that the indicator-label gap only exists while the label renders something. Host height comes from its content, alignment against surrounding text is `vertical-align: middle`, and the indicator measures `--wui-selection-control-size`.
|
|
611
627
|
|
|
612
628
|
#### `<web-ui-switch>`
|
|
613
629
|
|
|
@@ -630,7 +646,7 @@ Uses `role="switch"` and `aria-checked`. Pointer events for pressed visual state
|
|
|
630
646
|
|
|
631
647
|
#### `<web-ui-segmented>`
|
|
632
648
|
|
|
633
|
-
Segmented control
|
|
649
|
+
Segmented control: a single-select button group.
|
|
634
650
|
|
|
635
651
|
| Attribute | Type | Default | Description |
|
|
636
652
|
| ---------- | ------------------- | ------- | ------------------------------------ |
|
|
@@ -644,7 +660,7 @@ Segmented control — single-select button group.
|
|
|
644
660
|
|
|
645
661
|
**Slots:** `default` (project `<web-ui-segmented-trigger>` elements)
|
|
646
662
|
|
|
647
|
-
**Variants:** `inset` (default, sunken) renders an opaque `--wui-color-surface` track with a constant 1px ring and drop shadow, and a solid `--wui-color-surface-segmented` resting indicator that reads as embedded in the track. In light appearance that token equals `--wui-color-page`, so the track sits flush with the page and the recess reads from the ring and shadow alone; in dark appearance `--wui-color-surface` is the one-step-above-page elevation, so the track keeps lifting off the page. `raised` renders the classic flat `--wui-color-surface-segmented` track (no ring, no shadow) with a solid `--wui-color-surface-selected` resting indicator carrying a soft shadow that floats above the track. In both variants the pressed/dragged indicator is transparent glass
|
|
663
|
+
**Variants:** `inset` (default, sunken) renders an opaque `--wui-color-surface` track with a constant 1px ring and drop shadow, and a solid `--wui-color-surface-segmented` resting indicator that reads as embedded in the track. In light appearance that token equals `--wui-color-page`, so the track sits flush with the page and the recess reads from the ring and shadow alone; in dark appearance `--wui-color-surface` is the one-step-above-page elevation, so the track keeps lifting off the page. `raised` renders the classic flat `--wui-color-surface-segmented` track (no ring, no shadow) with a solid `--wui-color-surface-selected` resting indicator carrying a soft shadow that floats above the track. In both variants the pressed/dragged indicator is transparent glass, with backdrop blur, a ring fading in over 80ms and a 1.5x scale, easing back to the resting surface on release. Illegal values fall back to `inset`.
|
|
648
664
|
|
|
649
665
|
Form-associated: integrates with native `<form>` via `ElementInternals`.
|
|
650
666
|
|
|
@@ -652,9 +668,9 @@ Manages child trigger `checked` state based on `value`. `disabled` supplies inhe
|
|
|
652
668
|
|
|
653
669
|
Press the selected segment and drag horizontally to slide the indicator; on release it snaps to the nearest option (a fast flick switches by velocity). Touch surfaces declare `touch-action: none` and suppress `touchmove` defaulting during an active drag, so iOS Safari does not interrupt the gesture.
|
|
654
670
|
|
|
655
|
-
**Pressed state:** the track is an opaque surface (`--wui-color-surface`, page-colored in light appearance) with no backdrop filter in every state
|
|
671
|
+
**Pressed state:** the track is an opaque surface (`--wui-color-surface`, page-colored in light appearance) with no backdrop filter in every state. Its 1px ring and drop shadow never change. The indicator is the layer that turns to glass. At rest it is a solid `--wui-color-surface-segmented` surface with all glass output off. While pressed or dragging it gains backdrop blur, the glass ring fading in over 80ms, and a 1.5x scale over a fully transparent background: the indicator samples its blur entirely from inside the track, and against the previous glass track a fully transparent indicator measured only +0.5 gray levels on a uniform dark backdrop while striped backdrops showed through the sample (std 1.89 gray levels inside the indicator). The opaque track makes that sample uniform (std 0), which is what gives the pressed thumb a perceptible body. No tint and no edge-decoration suppression are needed. The background never fades in. It lands on the first pressed frame. And on release the indicator eases back to the solid gray rest surface over `--wui-duration-press`.
|
|
656
672
|
|
|
657
|
-
**Label color:** every label stays `--wui-color-text-secondary
|
|
673
|
+
**Label color:** every label stays `--wui-color-text-secondary`. Checked or not, `inset` or `raised`, at rest and while a press or drag is active. Selection is carried by the indicator alone; no label takes the accent color.
|
|
658
674
|
|
|
659
675
|
#### `<web-ui-checkbox-group>`
|
|
660
676
|
|
|
@@ -678,11 +694,11 @@ Syncs child checkbox `checked` state. `disabled` supplies inherited effective di
|
|
|
678
694
|
|
|
679
695
|
##### Tokens
|
|
680
696
|
|
|
681
|
-
| Token | Default
|
|
682
|
-
| -------------------------- |
|
|
683
|
-
| `--wui-checkbox-group-gap` | `
|
|
697
|
+
| Token | Default | Description |
|
|
698
|
+
| -------------------------- | -------------------- | ----------------------------- |
|
|
699
|
+
| `--wui-checkbox-group-gap` | `var(--wui-space-2)` | Gap between member checkboxes |
|
|
684
700
|
|
|
685
|
-
Set it on the group element itself, or on an ancestor inside the same `<web-ui-theme>` scope. The theme host declares
|
|
701
|
+
Set it on the group element itself, or on an ancestor inside the same `<web-ui-theme>` scope. The theme host declares the spacing step for its own subtree, so an override placed above a `<web-ui-theme>` element does not reach the group. Its default now resolves through `--wui-space-2`, so overriding that step on the theme host also moves the gap between members; setting this token still wins over both.
|
|
686
702
|
|
|
687
703
|
```css
|
|
688
704
|
web-ui-checkbox-group {
|
|
@@ -712,11 +728,11 @@ Radio group managing single selection.
|
|
|
712
728
|
|
|
713
729
|
##### Tokens
|
|
714
730
|
|
|
715
|
-
| Token | Default
|
|
716
|
-
| ----------------------- |
|
|
717
|
-
| `--wui-radio-group-gap` | `
|
|
731
|
+
| Token | Default | Description |
|
|
732
|
+
| ----------------------- | -------------------- | ------------------------- |
|
|
733
|
+
| `--wui-radio-group-gap` | `var(--wui-space-2)` | Gap between member radios |
|
|
718
734
|
|
|
719
|
-
Set it on the group element itself, or on an ancestor inside the same `<web-ui-theme>` scope. The theme host declares
|
|
735
|
+
Set it on the group element itself, or on an ancestor inside the same `<web-ui-theme>` scope. The theme host declares the spacing step for its own subtree, so an override placed above a `<web-ui-theme>` element does not reach the group. Its default now resolves through `--wui-space-2`, so overriding that step on the theme host also moves the gap between members; setting this token still wins over both.
|
|
720
736
|
|
|
721
737
|
```css
|
|
722
738
|
web-ui-radio-group {
|
|
@@ -747,10 +763,11 @@ Styled button with variants and loading state.
|
|
|
747
763
|
|
|
748
764
|
**Slots:** `prefix`, `default`, `suffix`
|
|
749
765
|
|
|
750
|
-
`submit` and `reset`
|
|
751
|
-
|
|
766
|
+
`submit` and `reset` forward activation through the host's form owner to its native `<form>` after the composed
|
|
767
|
+
`click` event finishes, so calling `preventDefault()` on that click cancels the action. The inner button still has no
|
|
768
|
+
form owner of its own, and `SubmitEvent.submitter` is therefore `null`. The button contributes no value to `FormData`.
|
|
752
769
|
|
|
753
|
-
Disabled and
|
|
770
|
+
Disabled, loading, and `formDisabled` states—including those caused by an ancestor `fieldset`—prevent `click` events.
|
|
754
771
|
|
|
755
772
|
When `icon` and `loading` are both set, the button renders only the spinner, and the default-slot icon is not
|
|
756
773
|
projected. The icon-mode geometry stays square by default, except for `full` or an explicit width.
|
|
@@ -779,6 +796,14 @@ Button group that manages child button layout and direction.
|
|
|
779
796
|
|
|
780
797
|
Applies the direction to the grouped button layout without changing child button attributes.
|
|
781
798
|
|
|
799
|
+
**CSS Custom Properties:**
|
|
800
|
+
|
|
801
|
+
| Property | Default | Description |
|
|
802
|
+
| ----------------------------------- | ------- | ------------------------------------------------------------------------------- |
|
|
803
|
+
| `--wui-button-group-divider-length` | `20px` | Length of the divider between adjacent buttons; its cross axis always stays 1px |
|
|
804
|
+
|
|
805
|
+
Set it on the group host. The token controls the long edge in both directions, so a horizontal group shortens the divider's height and a vertical group shortens its width.
|
|
806
|
+
|
|
782
807
|
---
|
|
783
808
|
|
|
784
809
|
### Overlay / Modal
|
|
@@ -790,6 +815,7 @@ Modal dialog using native `<dialog>` with `showModal()`.
|
|
|
790
815
|
| Attribute | Type | Default | Description |
|
|
791
816
|
| ------------------- | --------- | ------- | ------------------------------------------------------------------------------ |
|
|
792
817
|
| `open` | `boolean` | `false` | Dialog visibility |
|
|
818
|
+
| `closable` | `boolean` | `false` | Show the built-in close button |
|
|
793
819
|
| `no-scroll-lock` | `boolean` | `false` | Do not lock body scroll when open |
|
|
794
820
|
| `no-backdrop-close` | `boolean` | `false` | Do not close on backdrop click |
|
|
795
821
|
| `no-escape-close` | `boolean` | `false` | Do not close when Escape is pressed |
|
|
@@ -803,22 +829,29 @@ Modal dialog using native `<dialog>` with `showModal()`.
|
|
|
803
829
|
|
|
804
830
|
Uses native `<dialog>` with `@cancel` prevention. Escape calls `close()` unless `no-escape-close` is present. Click on backdrop closes dialog unless `no-backdrop-close` is present. With `controlled`, both only emit the close request instead.
|
|
805
831
|
|
|
832
|
+
With `closable`, a built-in close button is rendered in both content modes, and it follows the same close path as Escape and backdrop clicks (so `controlled` applies to it identically). The two modes place it differently: without a `body` slot the button sits in a `.title-row` flex line next to the title; with a `body` slot the title row does not exist, so the button is a direct child of the glass card and is absolutely positioned at its top-right corner (offset by `--wui-dialog-close-top` / `--wui-dialog-close-right`). It uses the same `ooui:close` icon as the drawer close button. Omitting `closable` renders nothing at all — no button and no extra wrapper.
|
|
833
|
+
|
|
806
834
|
> **Escape ownership:** Escape is arbitrated by a single shared owner, so one keypress closes only the **innermost** open overlay (popover, select, autocomplete, dropdown, context-menu, drawer and dialog all take part). With a select open inside a drawer, the first Escape closes the select and only the second closes the drawer. Sibling overlays that do not nest fall back to open order, closing the most recently opened one. A panel that is still playing its exit transition stays on screen and still catches the Escape, but any overlay that is still open outranks it, so one keypress still closes exactly one layer. `image-preview` takes part as well: its native `<dialog>` is registered with the same arbiter, so Escape is decided by layer order; the component's `cancel` handler only vetoes the native instant close, keeping the top layer until the exit transition finishes.
|
|
807
835
|
|
|
808
836
|
**CSS Custom Properties:**
|
|
809
837
|
|
|
810
|
-
| Property
|
|
811
|
-
|
|
|
812
|
-
| `--wui-dialog-width`
|
|
813
|
-
| `--wui-dialog-max-height`
|
|
814
|
-
| `--wui-dialog-
|
|
815
|
-
| `--wui-dialog-
|
|
816
|
-
| `--wui-dialog-
|
|
817
|
-
| `--wui-dialog-
|
|
818
|
-
| `--wui-dialog-
|
|
819
|
-
| `--wui-dialog-
|
|
820
|
-
| `--wui-dialog-
|
|
821
|
-
| `--wui-dialog-
|
|
838
|
+
| Property | Default | Description |
|
|
839
|
+
| --------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
840
|
+
| `--wui-dialog-width` | `360px` | Dialog width |
|
|
841
|
+
| `--wui-dialog-max-height` | `90vh` / `min(90vh, 90dvh)` (dvh engines) | Max height of the content area (`.desc`), not of the card. Two fallback tiers: `90vh` on the base rule, `min(90vh, 90dvh)` inside `@supports (height: 100dvh)` — an engine without `dvh` support only ever gets `90vh`. See the note below for the chrome conversion |
|
|
842
|
+
| `--wui-dialog-close-top` | `16px` | `closable` button offset from the card top (body mode) |
|
|
843
|
+
| `--wui-dialog-close-right` | `16px` | `closable` button offset from the card right edge (body mode) |
|
|
844
|
+
| `--wui-dialog-overlay-bg` | `var(--wui-color-backdrop)` | Backdrop background |
|
|
845
|
+
| `--wui-dialog-bg` | `var(--wui-color-surface-overlay)` | Glass card background, falls back to `rgb(248 248 248 / 0.92)` |
|
|
846
|
+
| `--wui-dialog-padding` | `20px 24px 24px` | Dialog surface padding |
|
|
847
|
+
| `--wui-dialog-title-gap` | `16px` | Spacing below the title |
|
|
848
|
+
| `--wui-dialog-desc-gap` | `24px` | Spacing below the body content |
|
|
849
|
+
| `--wui-dialog-desc-focus-padding` | `6px` | Focus-ring margin reserved on **all four** sides of the content area. `.desc` is a scroll container and, because one axis must be non-`visible`, a clip box as well, so a control flush against any of its four edges would have its ring clipped by the padding box; the margin covers the `5px` ring (`offset: 2` + `width: 3`) on every axis. Hosts do not need to reserve this themselves. Paired negative margins keep the chrome height unchanged, so this can be retuned to a platform's font metrics without moving the card |
|
|
850
|
+
| `--wui-dialog-footer-gap` | `10px` / `12px` (horizontal) | Spacing between footer buttons |
|
|
851
|
+
| `--wui-dialog-footer-justify` | `flex-end` (default) / `center` (horizontal) | Footer `justify-content`; override to `flex-end` for right-aligned horizontal buttons |
|
|
852
|
+
| `--wui-dialog-scale-enter` | `1.1` | Enter scale start: the panel shrinks in from `1.1` to `1`, and exit reverses it |
|
|
853
|
+
|
|
854
|
+
> **Height semantics:** the token caps the content area, not the card. The title row and the footer stay sized by their content, and anything past the cap scrolls inside `.desc`; the card itself is bounded only by a literal `100vh` / `100dvh` backstop, which catches the case where the viewport is too short to fit chrome plus the cap. A host that wants to bound the **whole card** must still measure its own chrome (card padding + title row + gaps + footer) and subtract it from the token — the three dialogs in the Interweave frontend subtract 142, 142 and 106 respectively. What no longer needs that number is making the content area scroll: before, `.desc` had neither a cap nor `overflow`, so the only element that could scroll was a host-sized inner box, and a host that wanted overflow to scroll had to compute that height itself.
|
|
822
855
|
|
|
823
856
|
#### `<web-ui-drawer>`
|
|
824
857
|
|
|
@@ -839,7 +872,7 @@ Side drawer using native `<dialog>` with closing animation. In non-headless mode
|
|
|
839
872
|
|
|
840
873
|
**Events:** `open-change` (`CustomEvent<{ open: boolean }>`). With `controlled`, Escape, backdrop, the built-in close button and drag-release only request `open=false`; the drawer remains open until the consumer writes `open=false`. Programmatic APIs (`show()`, `close()`, assigning `open`) stay direct and never emit. If native dialog closure occurs while a request is pending, the drawer restores its open top-layer state and emits the same request. With nested drawers, an inner `open-change` bubbles through the outer root (composed event); distinguish by `event.target`.
|
|
841
874
|
|
|
842
|
-
**Slots:** `header`, `default`, `footer
|
|
875
|
+
**Slots:** `header`, `default`, `footer`. With `headless`, only the `default` slot is rendered.
|
|
843
876
|
|
|
844
877
|
**Methods:** `show()`, `close()`
|
|
845
878
|
|
|
@@ -847,42 +880,57 @@ Side drawer using native `<dialog>` with closing animation. In non-headless mode
|
|
|
847
880
|
|
|
848
881
|
Closing keeps the native dialog in the top layer until the `--wui-duration-drawer-exit` transition completes (240ms by default), then calls `dialog.close()`. Escape always follows this close path; `no-backdrop-close` controls backdrop clicks only.
|
|
849
882
|
|
|
850
|
-
When `closable` is set, the built-in close button is positioned at the header's top-right corner (defaults `16px` down and `
|
|
883
|
+
When `closable` is set, the built-in close button is positioned at the header's top-right corner (defaults `16px` down and `16px` in from the edge) instead of stretching across the drawer body. The `16px` down resolves through `--wui-space-4` so it tracks the drawer's header padding; the `16px` in is the button's own offset to the panel's right edge, which is not the header's horizontal padding (`20px`), so it stays a literal.
|
|
884
|
+
|
|
885
|
+
**Drag to close:** With `draggable`, a gray capsule drag bar (4×56px by default, visually centered 10px from the inner edge) appears on the drawer's inner edge (left edge for `right`, right edge for `left`, bottom edge for `top`, top edge for `bottom`) while open:
|
|
886
|
+
|
|
887
|
+
The visual center follows half of `--wui-drawer-content-padding`, floored at half the bar thickness plus 4px: zeroing that padding to let content fill the panel edge-to-edge still leaves the capsule a visible inset, so it neither crosses the panel's inner edge nor sits flush against it.
|
|
888
|
+
|
|
889
|
+
The capsule is a visual marker only: it is `pointer-events: none` and never swallows a press. What you press is a hit surface. On `left` / `right` that is the drag zone alone. On `top` / `bottom` there are three: the drag zone, a band along the grab edge (exactly as wide as the capsule, and at least `--wui-drawer-drag-edge-size` thick), and the header (`placement=bottom`) or footer (`placement=top`) section in full. The edge band's height is the larger of the capsule's own outer edge and that token, so it covers the capsule's band by construction — pressing the capsule starts a drag and hovering it lights it up, on every placement.
|
|
890
|
+
|
|
891
|
+
The drag zone yields to the header (`placement=bottom`) or the footer (`placement=top`), so that section never pushes the capsule away from the edge — and that section takes the drag itself instead of sitting inert: a press anywhere in it starts a drag, title text included. Controls are kept clear **one by one, at the event layer**, rather than by cutting the hit surface geometrically. A press whose composed path contains an interactive element — native `button` / `input` / `select` / `textarea` / `label` / `a[href]` / `summary`, anything `contenteditable`, an interactive ARIA `role` (`button`, `checkbox`, `switch`, `tab`, `menuitem`, `option`, `slider`, …), or any explicit `tabindex` other than `-1` — reaches the control and starts no drag. A custom control that is not natively interactive has to carry one of those markers to be recognised; adding `role` or `tabindex` is the way in, and it is the right call for accessibility anyway. Geometric cutting was rejected on purpose: it would have to measure each control's position, so it breaks the moment a control moves, and it relocates the A6 defect rather than removing it. The trade is explicit. The built-in close button sits against the panel's right edge, outside the capsule's span, so it stays clickable; a control placed inside the capsule's horizontal span is still covered by the drag surface over the band's height.
|
|
851
892
|
|
|
852
|
-
|
|
893
|
+
One consequence follows from the handle occupying that span: a control placed inside it whose top edge falls within the band's height (`--wui-drawer-drag-edge-size`, `20px` by default, or the capsule's own outer edge when that is thicker) has its upper part covered by the drag surface, since the handle is drawn there and a drag has to start where the handle is. `z-index` does not lift it clear — Chromium keeps the band above slotted content — so the levers are `--wui-drawer-drag-bar-length`, which sets the capsule length and the band width together, and `--wui-drawer-drag-edge-size`, which sets the band's thickness.
|
|
853
894
|
|
|
854
895
|
- Dragging follows the pointer in real time; the backdrop fades proportionally.
|
|
855
|
-
- Backdrop click now only honors a genuine tap chain: the press must start on the backdrop itself and the press-to-release travel must stay within the tap magnitude. The click the browser generates for a press–drag–release lands on the common ancestor (`dialog`) regardless of where the press started
|
|
896
|
+
- Backdrop click now only honors a genuine tap chain: the press must start on the backdrop itself and the press-to-release travel must stay within the tap magnitude. The click the browser generates for a press–drag–release lands on the common ancestor (`dialog`) regardless of where the press started. Pressing on the panel content or on the backdrop itself and releasing over the backdrop used to close the drawer through that click. The component records the pointerdown origin and validates it on click, so such drag releases always rebound. A `detail`-0 click (keyboard / programmatic) never consumes the pointer record.
|
|
856
897
|
- Releasing with a net displacement past half the drawer size (floor of 10px), or with a fast closing flick, closes the drawer; otherwise it animates back open. The close direction is placement-aware, and each part of the decision matches Base UI's `useSwipeDismiss`:
|
|
857
898
|
- Both the displacement origin and the decision clock reset to the first `pointermove`, absorbing the gap between the press and that move; its whole travel is discarded, so a gesture needs at least two moves to accumulate displacement.
|
|
858
|
-
- The flick is judged by the **whole gesture's** average velocity
|
|
899
|
+
- The flick is judged by the **whole gesture's** average velocity. Net displacement ÷ gesture duration, divisor floored at 50ms. The flick commits when the average reaches 500px/s, not by the instantaneous velocity at release. A sliding window only describes the last short stretch of the trace, so under a whole-gesture average sweeping back towards the edge can no longer read as a flick. A zero-length duration yields zero velocity instead of a floored divisor, so an unmeasurable gesture is never read as a flick.
|
|
859
900
|
- Any release whose net displacement isn't in the close direction animates back open.
|
|
860
901
|
- The distance test also uses the net displacement, so grabbing the drawer mid-rebound and releasing without dragging further never counts as "already past half way".
|
|
861
902
|
- A withdrawal of 10px or more from the point where the close direction was confirmed cancels the flick, so dragging out into the overscroll and sweeping back never closes. Displacement that has already crossed the distance threshold clears the mark again, so a gesture that is past half way is unaffected by a small retreat. Upstream has the same guard (`cancelledSwipe`), but never reaches it on the drawer path because `DrawerViewport.onRelease` always returns a decision.
|
|
862
903
|
- Dragging in the opening direction is damped by a square root (`sign(d) · |d| ** 0.5`), matching `applyDirectionalDamping`. The damping applies to the gesture's increment, added on top of the offset the drag started from, and self-limits rather than being capped at a fixed distance.
|
|
863
|
-
- The release velocity only shapes the settle transition's duration (180–420ms); the settle itself is a single CSS transition on `transform`, handed back by JS at release
|
|
904
|
+
- The release velocity only shapes the settle transition's duration (180–420ms); the settle itself is a single CSS transition on `transform`, handed back by JS at release. No WAAPI animation is created.
|
|
864
905
|
- With `controlled`, release past the threshold only emits `open-change(false)`; the drawer holds at the closed position briefly (120ms write-back window) and animates back open if the consumer rejects or misses the write-back.
|
|
865
906
|
- Drag-to-open is not supported because the closed drawer renders nothing outside the native dialog.
|
|
866
907
|
- Under `prefers-reduced-motion`, release settles instantly, with no transition.
|
|
867
908
|
|
|
868
909
|
**CSS Custom Properties:**
|
|
869
910
|
|
|
870
|
-
| Property | Default | Description
|
|
871
|
-
| --------------------------------- | ---------------------------------- |
|
|
872
|
-
| `--wui-drawer-width` | `320px` | Drawer width
|
|
873
|
-
| `--wui-drawer-height` | `300px` | Drawer height (top/bottom)
|
|
874
|
-
| `--wui-drawer-bg` | `var(--wui-color-surface-overlay)` | Drawer body background
|
|
875
|
-
| `--wui-drawer-radius` | `var(--wui-radius-overlay, 28px)` | Floating card corner radius (non-headless)
|
|
876
|
-
| `--wui-drawer-inset` | `8px` | Floating card viewport inset (non-headless); `0` gives edge-to-edge geometry
|
|
877
|
-
| `--wui-drawer-
|
|
878
|
-
| `--wui-drawer-
|
|
879
|
-
| `--wui-drawer-drag-
|
|
880
|
-
| `--wui-drawer-drag-
|
|
881
|
-
| `--wui-drawer-
|
|
882
|
-
| `--wui-drawer-
|
|
883
|
-
| `--wui-drawer-
|
|
884
|
-
| `--wui-drawer-
|
|
885
|
-
| `--wui-drawer-
|
|
911
|
+
| Property | Default | Description |
|
|
912
|
+
| --------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
913
|
+
| `--wui-drawer-width` | `320px` | Drawer width |
|
|
914
|
+
| `--wui-drawer-height` | `300px` | Drawer height (top/bottom) |
|
|
915
|
+
| `--wui-drawer-bg` | `var(--wui-color-surface-overlay)` | Drawer body background |
|
|
916
|
+
| `--wui-drawer-radius` | `var(--wui-radius-overlay, 28px)` | Floating card corner radius (non-headless) |
|
|
917
|
+
| `--wui-drawer-inset` | `8px` | Floating card viewport inset (non-headless); `0` gives edge-to-edge geometry |
|
|
918
|
+
| `--wui-drawer-nested-peek-base` | `43.2px` | Nested-stack reveal step base `A` (`28.8px` at `width <= 640px`); total stack width grows as `A · ln(n)`, so a single layer never moves and each extra layer reveals less. `0` disables the reveal. See the note below. |
|
|
919
|
+
| `--wui-drawer-overlay-bg` | `rgb(0 0 0 / 0.12)` | Backdrop background |
|
|
920
|
+
| `--wui-drawer-drag-zone-size` | `20px` | Drag-to-close hit zone thickness on the inner edge (draggable) |
|
|
921
|
+
| `--wui-drawer-drag-zone-inset` | `var(--wui-space-1, 4px)` | Breathing gap between the drag hit zone and the header (`placement=bottom`) or footer (`placement=top`) it yields to. `0` when that section is absent |
|
|
922
|
+
| `--wui-drawer-drag-bar-thickness` | `4px` | Drag bar capsule thickness (short axis) |
|
|
923
|
+
| `--wui-drawer-drag-bar-length` | `56px` | Drag bar capsule length (along the drawer edge) |
|
|
924
|
+
| `--wui-drawer-drag-edge-size` | `20px` | Thickness of the capsule's hit band along the grab edge (`top` / `bottom` only). Floored by the capsule's own outer edge, so the capsule band is always covered; the default matches `--wui-drawer-drag-zone-size`, so the handle is never harder to hit than the strip beside it |
|
|
925
|
+
| `--wui-drawer-header-padding` | `16px 20px` | Header section padding |
|
|
926
|
+
| `--wui-drawer-close-top` | `16px` | Built-in close button offset from the top of the header |
|
|
927
|
+
| `--wui-drawer-close-right` | `16px` | Built-in close button offset from the right edge of the drawer |
|
|
928
|
+
| `--wui-drawer-content-padding` | `20px` | Content area padding; also drives drag bar visual center (half value, floored at half the bar thickness + 4px) |
|
|
929
|
+
| `--wui-drawer-footer-padding` | `16px 20px` | Footer section padding |
|
|
930
|
+
|
|
931
|
+
`--wui-drawer-nested-peek-base` needs no declaration of yours: the `43.2px` default is the `initialValue` of the property the component registers with `CSS.registerProperty` (in `components/drawer/index.ts`), and narrow viewports get a smaller `28.8px` base from the `@media (width <= 640px)` rule in `components/drawer/style.css`. Those two places are where the shipped defaults live. Setting the token on the host (or any ancestor) overrides both, at any viewport width.
|
|
932
|
+
|
|
933
|
+
With the shipped defaults, a four-layer stack of `320px` drawers reveals `29.94px` / `17.52px` / `12.43px` per step on desktop and `19.96px` / `11.68px` / `8.29px` on narrow viewports, for a total stack width of `59.89px` and `39.93px` respectively. A single layer never moves, because `ln(1)` is `0`.
|
|
886
934
|
|
|
887
935
|
#### `imagePreview()`
|
|
888
936
|
|
|
@@ -946,7 +994,7 @@ Every presentation option defaults to off: with no options passed only the image
|
|
|
946
994
|
|
|
947
995
|
Pinch-to-zoom is always on and has no option: the stage already owns pointer interaction, so there is nothing for a gesture to conflict with. The first finger still drives pan/swipe as usual and the second finger starts the pinch, which aborts any in-flight pan or swipe. A pinch does not close the preview, and the compatibility `click` that mixed input may synthesize afterwards is swallowed rather than treated as a backdrop click.
|
|
948
996
|
|
|
949
|
-
Clicking anywhere outside the image, or pressing Escape, closes the preview. The native dialog always exposes the accessible name `图片预览`. With `swipe` on and more than one image, the images live on a single carousel track: the current image and its neighbors sit side by side in slides of equal size, the stage clips the overflow, and the whole track translates with the finger. Releasing past the distance threshold (15% of the stage width, rounded) slides the next image in, as does a fast flick whose sampled velocity is at least 320px/s even below that distance; a flick covering at least 16px whose velocity (windowed sample or whole-gesture average) reaches 160px/s also commits; otherwise it bounces back. With `loop` on the wrap-around neighbor is always present beside the current image, and at the non-looping bounds the strip bounces back instead of crossing the boundary. While it applies, the swipe gesture takes over the drag entirely: at 1x only horizontal movement changes images, and vertical movement is ignored (no pan, no vertical follow). Once zoomed in, dragging always pans on both axes and never changes images. Because panning also works at 1x, `resetZoom()` is offered whenever the image is zoomed _or_ displaced
|
|
997
|
+
Clicking anywhere outside the image, or pressing Escape, closes the preview. The native dialog always exposes the accessible name `图片预览`. With `swipe` on and more than one image, the images live on a single carousel track: the current image and its neighbors sit side by side in slides of equal size, the stage clips the overflow, and the whole track translates with the finger. Releasing past the distance threshold (15% of the stage width, rounded) slides the next image in, as does a fast flick whose sampled velocity is at least 320px/s even below that distance; a flick covering at least 16px whose velocity (windowed sample or whole-gesture average) reaches 160px/s also commits; otherwise it bounces back. With `loop` on the wrap-around neighbor is always present beside the current image, and at the non-looping bounds the strip bounces back instead of crossing the boundary. While it applies, the swipe gesture takes over the drag entirely: at 1x only horizontal movement changes images, and vertical movement is ignored (no pan, no vertical follow). Once zoomed in, dragging always pans on both axes and never changes images. Because panning also works at 1x, `resetZoom()` is offered whenever the image is zoomed _or_ displaced. The reset button in the toolbar is enabled for a panned 1x image too.
|
|
950
998
|
|
|
951
999
|
A close request does not destroy the native dialog immediately: it stays in the top layer until the exit transition completes, then `dialog.close()` runs, the host is removed from the DOM, and `closed` resolves. Page scroll is locked while open unless `noScrollLock` is `true`.
|
|
952
1000
|
|
|
@@ -990,33 +1038,33 @@ In-flow expand/collapse container with animated height (or width) transition. Si
|
|
|
990
1038
|
|
|
991
1039
|
The initial `open` attribute settles instantly without playing the animation. Nested collapses are supported.
|
|
992
1040
|
|
|
993
|
-
**Trigger semantics:** interaction comes from the element you put in the default slot
|
|
1041
|
+
**Trigger semantics:** interaction comes from the element you put in the default slot. A native `<button>`, `<web-ui-button>`, or any other interactive element supplies Enter/Space activation and focus natively. The collapse writes `aria-expanded` / `aria-controls` (pointing at its content track) and `aria-disabled` onto the first assigned element in the trigger slot. Use an interactive element as the trigger: a plain `<span>` is clickable but has no keyboard/focus semantics.
|
|
994
1042
|
|
|
995
1043
|
**Closed-state semantics:** the consumer's light DOM is never moved or unmounted. Default closed state applies `hidden` to the internal content container; with `keep-mounted` the inner container is marked `inert` while staying measurable inside the collapsed track.
|
|
996
1044
|
|
|
997
|
-
**`peek` (partial reveal):** setting `peek` makes the closed state reveal the first `peek` of the content along the animation axis (`horizontal` switches it to width) instead of collapsing to zero
|
|
1045
|
+
**`peek` (partial reveal):** setting `peek` makes the closed state reveal the first `peek` of the content along the animation axis (`horizontal` switches it to width) instead of collapsing to zero. The track stays at the content height and the inner container is clamped. It implies `keep-mounted` semantics: the content stays mounted but is `inert`, so the clipped portion is not focusable or clickable. Content shorter than `peek` collapses to its own size rather than leaving blank space. Because a fixed length and an auto height cannot be interpolated by CSS, the two `peek` ↔ expanded directions are driven by explicit pixel lengths (measured once per toggle); every other animation path stays a zero-measurement grid `fr` transition.
|
|
998
1046
|
|
|
999
1047
|
```html
|
|
1000
1048
|
<web-ui-collapse peek="120px">
|
|
1001
1049
|
<button type="button">Toggle me</button>
|
|
1002
|
-
<div slot="content">Long content
|
|
1050
|
+
<div slot="content">Long content. Only the first 120px show while closed</div>
|
|
1003
1051
|
</web-ui-collapse>
|
|
1004
1052
|
```
|
|
1005
1053
|
|
|
1006
|
-
**Edge fade:** the revealed area ends in an alpha-gradient fade (right edge when `horizontal`) so the clipped portion melts into the background instead of ending in a hard line. The length is derived from `peek
|
|
1054
|
+
**Edge fade:** the revealed area ends in an alpha-gradient fade (right edge when `horizontal`) so the clipped portion melts into the background instead of ending in a hard line. The length is derived from `peek`. There is no second attribute to set. Tune it with CSS custom properties instead:
|
|
1007
1055
|
|
|
1008
1056
|
| Custom property | Default | Description |
|
|
1009
1057
|
| -------------------------------- | ------------- | --------------------------------------------------------------------- |
|
|
1010
1058
|
| `--wui-collapse-peek-edge-ratio` | `0.4` | Fade length as a fraction of `peek` |
|
|
1011
1059
|
| `--wui-collapse-peek-edge-max` | `112px` | Upper bound, so a large `peek` cannot produce an oversized fade band |
|
|
1012
1060
|
| `--wui-collapse-peek-edge` | — | Explicit fade length; wins over the derived value |
|
|
1013
|
-
| `--wui-collapse-peek-edge-color` | `transparent` | Fade-stop color (must carry alpha
|
|
1061
|
+
| `--wui-collapse-peek-edge-color` | `transparent` | Fade-stop color (must carry alpha - `mask-image` reads alpha channel) |
|
|
1014
1062
|
|
|
1015
|
-
Set the ratio to `0` to turn the fade off. The derivation is pure CSS `calc(peek * ratio)`, so a `rem`-based `peek` scales the fade with the root font size and nothing has to be measured in JS. Known limitation: a percentage `peek` does not derive to a length, so the fade silently falls back to "none"
|
|
1063
|
+
Set the ratio to `0` to turn the fade off. The derivation is pure CSS `calc(peek * ratio)`, so a `rem`-based `peek` scales the fade with the root font size and nothing has to be measured in JS. Known limitation: a percentage `peek` does not derive to a length, so the fade silently falls back to "none". Set `--wui-collapse-peek-edge` explicitly in that case.
|
|
1016
1064
|
|
|
1017
|
-
The fade is a four-stop ease-out gradient rather than a linear one: the body stays fully opaque to the start of the fade band, drops to 60% alpha within the first 30% of the band, then 26%, then reaches the edge color. A linear gradient hugs 1.0 alpha across the first 40% of the band, so the eye perceives a much shorter fade than declared
|
|
1065
|
+
The fade is a four-stop ease-out gradient rather than a linear one: the body stays fully opaque to the start of the fade band, drops to 60% alpha within the first 30% of the band, then 26%, then reaches the edge color. A linear gradient hugs 1.0 alpha across the first 40% of the band, so the eye perceives a much shorter fade than declared. Front-loading the drop makes the band visibly soft from its very start, nearly doubling the perceived length at the same size.
|
|
1018
1066
|
|
|
1019
|
-
The fade band is positioned in percentages, relative to the container's **current rendered height
|
|
1067
|
+
The fade band is positioned in percentages, relative to the container's **current rendered height**, which is what `max-height` animates. So the band tracks the cut edge frame by frame during the collapse animation without the `mask-image` string ever needing to interpolate. Its length is driven by a registered `<length>` custom property so it can fade in and out with the toggle instead of popping in once the close animation settles.
|
|
1020
1068
|
|
|
1021
1069
|
```html
|
|
1022
1070
|
<!-- 调强渐隐:比例 0.5 → 120px peek 配 60px 渐隐 -->
|
|
@@ -1089,10 +1137,12 @@ Tooltip overlay using pointer/focus triggers.
|
|
|
1089
1137
|
|
|
1090
1138
|
Right-click context menu.
|
|
1091
1139
|
|
|
1092
|
-
| Attribute
|
|
1093
|
-
|
|
|
1094
|
-
| `disabled`
|
|
1095
|
-
| `no-scroll-lock`
|
|
1140
|
+
| Attribute | Type | Default | Description |
|
|
1141
|
+
| ------------------ | --------- | ------- | ------------------------------------------------------------- |
|
|
1142
|
+
| `disabled` | `boolean` | `false` | Right-click does not open the menu; no visual dimming |
|
|
1143
|
+
| `no-scroll-lock` | `boolean` | `false` | Allow background scrolling |
|
|
1144
|
+
| `long-press` | `boolean` | `false` | Open on a touch long press (opt-in; mouse uses `contextmenu`) |
|
|
1145
|
+
| `long-press-delay` | `number` | `500` | Hold duration in ms before `long-press` opens the menu |
|
|
1096
1146
|
|
|
1097
1147
|
**Events:** `open-change` (`CustomEvent<{ open: boolean }>`)
|
|
1098
1148
|
|
|
@@ -1100,10 +1150,26 @@ Right-click context menu.
|
|
|
1100
1150
|
|
|
1101
1151
|
**Methods:** `openAt(x: number, y: number)`, `close()`
|
|
1102
1152
|
|
|
1153
|
+
**CSS Custom Properties:**
|
|
1154
|
+
|
|
1155
|
+
| Property | Default | Description |
|
|
1156
|
+
| ------------------------------------- | ---------------------------------- | -------------------------------- |
|
|
1157
|
+
| `--wui-context-menu-safe-area-bottom` | `env(safe-area-inset-bottom, 0px)` | Bottom inset a touch menu clears |
|
|
1158
|
+
|
|
1103
1159
|
Opens on `contextmenu` event. Menu items: `<web-ui-dropdown-item>`, `<web-ui-dropdown-divider>`, `<web-ui-dropdown-header>`. Supports keyboard navigation (Arrow keys, Enter, Escape) and submenu hover with `pointerenter`.
|
|
1104
1160
|
|
|
1161
|
+
While the menu is open it is modal: it renders into a transparent `<dialog>` in the browser's top layer, so nothing on the page below can be clicked or hit-tested. Clicking outside therefore dismisses the menu without also activating whatever was underneath — a row, a checkbox, a link. The scrim is deliberately invisible; it exists to absorb the hit, not to dim the page. One consequence to know about: for the ~160ms exit transition after a menu item is activated, the scrim has already left the top layer, so the page below is briefly clickable again and the menu's stacking level is that of the normal flow.
|
|
1162
|
+
|
|
1163
|
+
`long-press` is opt-in and touch-only: a pointer held for `long-press-delay` (default `500` ms, matching the platform long press) opens the menu, through the same path as a right-click. It only reacts to `pointerType === 'touch'`, and holding while moving more than 10px cancels it, so scrolling never opens a menu. Because the browser also reports that same hold as a native gesture, the `contextmenu` and `click` it emits afterwards are absorbed rather than allowed to reopen — or immediately light-dismiss — the menu the long press just opened.
|
|
1164
|
+
|
|
1165
|
+
A `long-press` menu opens downward from the press point: its top edge sits at the press `y` and it is centred horizontally on the press `x`, which is how native iOS and Android long-press menus appear. When there is not enough room below, the panel flips above the press point rather than running off the screen, and both axes are clamped into the viewport while clearing `--wui-context-menu-safe-area-bottom` so it does not sit under a home indicator. The split is by input, not by viewport width: a narrow window still anchors a mouse right-click at the cursor's top-left corner. Only the horizontal alignment differs — both paths run the same `computePosition` pass, so touch and mouse cannot drift apart.
|
|
1166
|
+
|
|
1167
|
+
`disabled` suppresses menu behaviour only: right-click and `openAt()` do not open a menu. It does not dim or otherwise restyle what you put in the default slot — the component renders no menu surface of its own to dim, and disabling the right-click menu is not the same as disabling your trigger. If a disabled state should read as disabled, render it on your own content.
|
|
1168
|
+
|
|
1105
1169
|
While the menu is open, consumer code may conditionally render, move, or remove menu items (e.g. Vue `v-if`) without re-inserting them at the host element; changes inside the portal are reconciled automatically, and framework anchors are returned to the host on close so subsequent framework patches keep working.
|
|
1106
1170
|
|
|
1171
|
+
On close, focus returns to whatever was focused when the menu opened. That is the browser's own modal-dialog behaviour rather than something the component reimplements, which is also why it only works while the menu is the top layer. Activating a menu item is the one path that hands focus back early — at the click, before the exit transition — so that an item action which moves focus elsewhere (opening an inline editor, say) ends up keeping it: the closing menu never reaches in and pulls focus back out of the new target, so nothing that commits on blur fires a spurious edit.
|
|
1172
|
+
|
|
1107
1173
|
---
|
|
1108
1174
|
|
|
1109
1175
|
### Menu
|
|
@@ -1193,24 +1259,48 @@ Badge / notification count.
|
|
|
1193
1259
|
|
|
1194
1260
|
Empty state placeholder.
|
|
1195
1261
|
|
|
1196
|
-
| Attribute | Type
|
|
1197
|
-
| ------------- |
|
|
1198
|
-
| `title` | `string`
|
|
1199
|
-
| `description` | `string`
|
|
1200
|
-
| `size` | `
|
|
1262
|
+
| Attribute | Type | Default | Description |
|
|
1263
|
+
| ------------- | -------- | ------- | -------------------------------------------------------------- |
|
|
1264
|
+
| `title` | `string` | `''` | Title text |
|
|
1265
|
+
| `description` | `string` | `''` | Description text |
|
|
1266
|
+
| `size` | `number` | `56` | Layout scale in px; invalid or non-positive values become `56` |
|
|
1267
|
+
|
|
1268
|
+
`size` is the one knob for the whole placeholder. It drives the icon container, `min-height`, padding, and the title/description font size, so a large icon no longer sits in medium-sized whitespace:
|
|
1269
|
+
|
|
1270
|
+
| `size` | Icon box | Glyph | `min-height` | Padding block/inline | Title | Description |
|
|
1271
|
+
| ------ | -------- | ------ | ------------ | -------------------- | ------ | ----------- |
|
|
1272
|
+
| `40` | `40px` | `17px` | `171px` | `23px/17px` | `14px` | `13px` |
|
|
1273
|
+
| `56` | `56px` | `24px` | `240px` | `32px/24px` | `16px` | `14px` |
|
|
1274
|
+
| `72` | `72px` | `31px` | `309px` | `41px/31px` | `16px` | `14px` |
|
|
1275
|
+
|
|
1276
|
+
The derived values are `min-height: round(size * 30 / 7)`, `padding-block: round(size * 4 / 7)`, and `padding-inline: round(size * 3 / 7)`; the default glyph is `round(size * 3 / 7)`.
|
|
1277
|
+
|
|
1278
|
+
Font size is one step rather than a scale: below `56` the title is `14px` and the description `13px`, and from `56` up they are `16px` and `14px`. A bigger placeholder gets its presence from whitespace, not from bigger text.
|
|
1279
|
+
|
|
1280
|
+
**Migrating from the `'small' \| 'medium' \| 'large'` enum:** `size` is now a number, and the removed tiers had hand-tuned metrics that these ratios only approach — `small` was `160px` tall with `20px 16px` padding, `large` was `320px` with `48px 32px`. Section margins and content width never followed the tiers.
|
|
1281
|
+
|
|
1282
|
+
| Old value | New value | Default glyph |
|
|
1283
|
+
| --------- | --------- | ------------- |
|
|
1284
|
+
| `small` | `40` | `17` |
|
|
1285
|
+
| `medium` | `56` | `24` |
|
|
1286
|
+
| `large` | `72` | `31` |
|
|
1201
1287
|
|
|
1202
1288
|
**Slots:** `default` (title, overrides `title` prop), `icon`, `description`, `action`
|
|
1203
1289
|
|
|
1204
1290
|
**CSS Custom Properties:**
|
|
1205
1291
|
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
|
1209
|
-
|
|
|
1210
|
-
| `--wui-empty-
|
|
1211
|
-
| `--wui-empty-
|
|
1212
|
-
| `--wui-empty-
|
|
1213
|
-
| `--wui-empty-
|
|
1292
|
+
Each one overrides the value `size` derives, so all eight stay authoritative — including the two font sizes. Defaults are the values at the default `size` of `56`.
|
|
1293
|
+
|
|
1294
|
+
| Property | Default | Description |
|
|
1295
|
+
| ----------------------------------- | ----------- | ------------------------------------------- |
|
|
1296
|
+
| `--wui-empty-min-height` | `240px` | Min height |
|
|
1297
|
+
| `--wui-empty-padding` | `32px 24px` | Padding |
|
|
1298
|
+
| `--wui-empty-icon-size` | `56px` | Icon container size; overrides `size` |
|
|
1299
|
+
| `--wui-empty-content-width` | `480px` | Max width of title, description, and action |
|
|
1300
|
+
| `--wui-empty-title-margin-top` | `16px` | Space between the icon and the title |
|
|
1301
|
+
| `--wui-empty-title-font-size` | `16px` | Title font size |
|
|
1302
|
+
| `--wui-empty-description-font-size` | `14px` | Description font size |
|
|
1303
|
+
| `--wui-empty-action-margin-top` | `20px` | Space above the action slot |
|
|
1214
1304
|
|
|
1215
1305
|
#### `<web-ui-icon>`
|
|
1216
1306
|
|
|
@@ -1225,6 +1315,8 @@ Icon renderer using Iconify data objects.
|
|
|
1225
1315
|
|
|
1226
1316
|
Has `aria-hidden="true"`.
|
|
1227
1317
|
|
|
1318
|
+
**Canvas:** the SVG `viewBox` is read from `icon.left`/`icon.top`/`icon.width`/`icon.height`, defaulting to `0` for the offsets and to Iconify's spec default `16` for the sizes. Generated assets always carry their canvas, so the size fallback only matters for raw `IconifyIcon` objects passed in directly.
|
|
1319
|
+
|
|
1228
1320
|
```js
|
|
1229
1321
|
import { lucideLoaderCircle } from '@greypan/web-ui/icons'
|
|
1230
1322
|
html`<web-ui-icon .icon=${lucideLoaderCircle} spin />`
|
|
@@ -1336,16 +1428,17 @@ Responsive page layout with an optional full-width banner, a collapsible desktop
|
|
|
1336
1428
|
|
|
1337
1429
|
At `640px` and below, the sidebar becomes a `web-ui-drawer` with its built-in glass body, scrollable content, and drag zone. The layout maps `sidebar-width` to `--wui-drawer-width` and `--wui-layout-sidebar-radius` to `--wui-drawer-radius`. The mobile toggle appears in the header row as a glass button. Its left inset defaults to `8px`; align it with your own header padding via `--wui-layout-mobile-toggle-inset`.
|
|
1338
1430
|
|
|
1339
|
-
`header-glow` adds a pointer-transparent decorative glow behind header-slot content and the mobile toggle. It is a Header background rather than a foreground layer, so slotted content remains above it.
|
|
1431
|
+
`header-glow` adds a pointer-transparent decorative glow behind header-slot content and the mobile toggle. It is a Header background rather than a foreground layer, so slotted content remains above it. The glow takes its colour from `--wui-color-page`, so it follows light and dark appearance on its own; override that property on `web-ui-layout`, on the theme, or anywhere above it to change it. Two pseudo-elements build it. `::before` paints the colour as a `linear-gradient` inside the header box, fading to fully transparent, and `::after` adds a real `backdrop-filter: blur(4px)` layer whose `mask` fades that blur toward zero alpha at the bottom edge. Keeping the two apart means blur strength and colour strength do not pull on each other. Both expand with a negative `margin` rather than a `transform`. Horizontal clipping is owned by `.layout-content`, so the glow never produces a horizontal scrollbar. Layout layers are ordered as Header (`10`) < Auxiliary (`20`) < Banner (`30`) < Tabbar (`40`) < Sidebar (`50`).
|
|
1340
1432
|
|
|
1341
|
-
The sidebar card surface is `--wui-color-surface-sidebar`. In light mode it
|
|
1433
|
+
The sidebar card surface is `--wui-color-surface-sidebar`. In light mode it keeps its translucent neutral layer; in dark mode it sits one notch above `--wui-color-page`, level with `--wui-color-surface`. It is a separate token because dialog, drawer and toast share `--wui-color-surface-overlay` and may use a different surface.
|
|
1342
1434
|
|
|
1343
1435
|
**CSS Custom Properties:**
|
|
1344
1436
|
|
|
1345
|
-
| Property
|
|
1346
|
-
|
|
|
1347
|
-
| `--wui-layout-sidebar-radius`
|
|
1348
|
-
| `--wui-layout-mobile-toggle-inset`
|
|
1437
|
+
| Property | Default | Description |
|
|
1438
|
+
| ----------------------------------- | ------- | ------------------------------------------------------------------------------------ |
|
|
1439
|
+
| `--wui-layout-sidebar-radius` | `24px` | Border radius of sidebar card (desktop & mobile) |
|
|
1440
|
+
| `--wui-layout-mobile-toggle-inset` | `8px` | Left inset of the mobile header toggle |
|
|
1441
|
+
| `--wui-layout-sidebar-toggle-width` | `44px` | Width of the desktop sidebar collapse toggle; floored at `--wui-control-size` (36px) |
|
|
1349
1442
|
|
|
1350
1443
|
#### `<web-ui-back-top>`
|
|
1351
1444
|
|
|
@@ -1379,7 +1472,7 @@ Role: `button`, keyboard Enter scrolls to top.
|
|
|
1379
1472
|
|
|
1380
1473
|
#### `<web-ui-svg-draw-lines>`
|
|
1381
1474
|
|
|
1382
|
-
SVG line drawing animation using `stroke-dashoffset`. Animates geometry in-place
|
|
1475
|
+
SVG line drawing animation using `stroke-dashoffset`. Animates geometry in-place. No cloning, no DOM manipulation. Two playback directions: the reveal draws geometry from nothing to fully drawn, `replay({ reverse: true })` retracts it along the same path back to nothing.
|
|
1383
1476
|
|
|
1384
1477
|
| Attribute | Type | Default | Description |
|
|
1385
1478
|
| ------------- | --------- | ---------- | ------------------------------------------------------ |
|
|
@@ -1389,13 +1482,13 @@ SVG line drawing animation using `stroke-dashoffset`. Animates geometry in-place
|
|
|
1389
1482
|
|
|
1390
1483
|
All attributes are reflected.
|
|
1391
1484
|
|
|
1392
|
-
**Auto-play:** the first time slotted content settles, one reveal plays by itself. Set `no-autoplay` to leave the geometry as authored and decide when to play
|
|
1485
|
+
**Auto-play:** the first time slotted content settles, one reveal plays by itself. Set `no-autoplay` to leave the geometry as authored and decide when to play. That is how `<web-ui-checkbox>` avoids drawing a checkmark that was already checked on mount.
|
|
1393
1486
|
|
|
1394
|
-
**Methods:** `replay(options?: { reverse?: boolean }): Promise<void
|
|
1487
|
+
**Methods:** `replay(options?: { reverse?: boolean }): Promise<void>`. Cancels running animation, re-collects geometry elements from current DOM, and starts a new animation. All targets animate in parallel with the same duration/easing. Resolves when all complete. A reverse run ends on blank and leaves that end state in the DOM: the animation itself is cancelled, while the dash values that hide the stroke stay as inline styles until the next `replay()` replaces or undoes them. A reveal run restores the authored inline styles instead. A retract always starts from the full stroke, so interrupting a reveal draws the whole path back rather than only the part that was visible. When the nearest theme scope uses `motion="reduced"`, or its `motion="system"` mode matches `prefers-reduced-motion: reduce`, no animation starts. But a previous retract's blank is still undone, so the geometry returns to as authored and visibility is left entirely to the consumer's own styles.
|
|
1395
1488
|
|
|
1396
|
-
**Reverse end state:** the blank a retract leaves behind is inline style on the geometry it animated, including nodes inside nested open shadow roots such as `<web-ui-icon>`. Copying those nodes (`cloneNode`, an `innerHTML` round-trip) carries the blank along, and detaching and re-appending one keeps the stroke hidden
|
|
1489
|
+
**Reverse end state:** the blank a retract leaves behind is inline style on the geometry it animated, including nodes inside nested open shadow roots such as `<web-ui-icon>`. Copying those nodes (`cloneNode`, an `innerHTML` round-trip) carries the blank along, and detaching and re-appending one keeps the stroke hidden. A finished retract is a DOM state rather than a live animation, so nothing is left to restore it. Call `replay()` to draw them again. Because the component reaches into nested open shadow roots, two `<web-ui-svg-draw-lines>` must not cover the same geometry: each records the inline dash values the first time it animates an element, so a blank left by the inner one becomes the outer one's idea of the consumer's own value.
|
|
1397
1490
|
|
|
1398
|
-
**Slots:** `default
|
|
1491
|
+
**Slots:** `default`. SVG content to animate. Accepts inline `<svg>` elements (light DOM) as well as components that render an SVG in an open shadow root, such as `<web-ui-icon>`. Closed shadow roots are skipped.
|
|
1399
1492
|
|
|
1400
1493
|
Finds `path`, `rect`, `circle`, `line`, `polyline`, `polygon`, `ellipse` elements by recursively traversing the light DOM and all open shadow roots. Paths ending with `Z`/`z` receive a temporary gap fix for proper closing-segment rendering. After a reveal completes or is cancelled, all in-line styles are restored.
|
|
1401
1494
|
|
|
@@ -1403,42 +1496,82 @@ Finds `path`, `rect`, `circle`, `line`, `polyline`, `polygon`, `ellipse` element
|
|
|
1403
1496
|
|
|
1404
1497
|
Theme provider defining CSS custom property tokens.
|
|
1405
1498
|
|
|
1406
|
-
| Attribute
|
|
1407
|
-
|
|
|
1408
|
-
| `appearance`
|
|
1409
|
-
| `
|
|
1499
|
+
| Attribute | Type | Default | Description |
|
|
1500
|
+
| --------------------- | --------------------------------- | ---------- | ------------------------------------------------------ |
|
|
1501
|
+
| `appearance` | `'light' \| 'dark' \| 'system'` | `'light'` | Color scheme |
|
|
1502
|
+
| `resolved-appearance` | `'light' \| 'dark'` | `'light'` | Resolved color scheme; read-only reflected host output |
|
|
1503
|
+
| `motion` | `'full' \| 'reduced' \| 'system'` | `'system'` | Motion preference for this nested theme scope |
|
|
1410
1504
|
|
|
1411
|
-
**Methods:** `getOverlayRoot()
|
|
1505
|
+
**Methods:** `getOverlayRoot()`. Returns this theme-owned overlay root
|
|
1412
1506
|
|
|
1413
1507
|
**Portal mounting contract:** Every active `<web-ui-theme>` is also the default scoped theme-owned overlay root. Portal-based components without an explicit `overlayContainer` resolve to the nearest active theme's `getOverlayRoot()`; target-less portal calls prefer the root theme's theme-owned overlay root. When no active theme provides a root, they fall back to the global fallback overlay root.
|
|
1414
1508
|
|
|
1415
1509
|
Defines foundation, color, layer, shadow, and motion tokens for its subtree. `motion="system"` follows `prefers-reduced-motion`; use `motion="reduced"` to reduce animation in a scope or `motion="full"` in a nested theme to restore normal token values. System appearance follows `prefers-color-scheme`.
|
|
1416
1510
|
|
|
1417
|
-
|
|
1511
|
+
`resolved-appearance` is a read-only derived host attribute (also exposed as the `resolvedAppearance` property): it is always `light` or `dark`, mirrors an explicit `appearance` directly, resolves `appearance="system"` from `prefers-color-scheme`, and updates live when the OS flips. A theme without `appearance` remains inactive but reports the default `light`. Because the component owns the attribute and restores external edits, consumers can bind selectors or Tailwind custom variants to `resolved-appearance` without carrying a second theme state.
|
|
1512
|
+
|
|
1513
|
+
Appearance changes are animated with the View Transitions API according to this scope's `motion`: `full` always reveals, `reduced` applies the new appearance immediately with no reveal, and `system` follows `prefers-reduced-motion`. A root theme reveals the whole page; a nested theme reveals only its own capture box. The origin is the last pointer-down position when available, otherwise the theme box or viewport center. The reveal direction follows the resolved appearance, including `appearance="system"` resolving from `prefers-color-scheme`; dark-to-light and light-to-dark directions are reversed. Unsupported browsers, reduced-motion scopes, zero durations, and another request already in the same flight fall back to applying the new appearance immediately; `appearance="system"` does not animate OS light/dark changes in this version.
|
|
1514
|
+
|
|
1515
|
+
During an active reveal, the View Transitions rendering-suppression rules force pointer hit-testing onto the document element, so CSS `pointer-events` overrides cannot keep the underlying page interactive. The theme calls `skipTransition()` only on `pointerdown` or wheel; `pointermove` and `pointerup` never end the reveal, so follow-up movement from the initiating control or ordinary pointer movement cannot interrupt it. The event that triggers the skip is still spec-defined to target the document element, but the disabled hit-test window ends there instead of running for the full reveal duration.
|
|
1418
1516
|
|
|
1419
1517
|
**Migration from the removed `transition` attribute:** drop it and express the intent with `motion` instead. A theme that carried `transition` keeps the same reveal under the default `motion="system"`; add `motion="full"` to reveal even when the system prefers reduced motion. A theme that did not carry it now reveals by default, so pass `motion="reduced"` to keep appearance changes instant.
|
|
1420
1518
|
|
|
1421
1519
|
The host uses `display: contents` and does not paint any background: the library never draws on the host page, so the embedding application keeps full control of the surface behind the themed subtree. Custom properties still inherit to slotted content reliably.
|
|
1422
1520
|
|
|
1423
|
-
**Root page color sync:** the outermost active theme also mirrors its computed `--wui-color-page` onto `document.documentElement` as an inline custom property. That closes the one place the token cannot reach on its own: custom properties stop inheriting at the document element, so a consumer rule such as `body { background: var(--wui-color-page) }` only colors the scrollable area, while the canvas behind an overscroll bounce (macOS rubber-banding) stays at the user-agent background. With the mirrored property the bounce area follows the theme too. The write happens when a theme connects and whenever its appearance changes, including `appearance="system"` following an OS light/dark flip; the value written is the theme's computed value, so an override of `--wui-color-page` on the host is mirrored as it stands. **Not live:** the component does not observe the host's own style changes, so a runtime change to that property on the host
|
|
1521
|
+
**Root page color sync:** the outermost active theme also mirrors its computed `--wui-color-page` onto `document.documentElement` as an inline custom property. That closes the one place the token cannot reach on its own: custom properties stop inheriting at the document element, so a consumer rule such as `body { background: var(--wui-color-page) }` only colors the scrollable area, while the canvas behind an overscroll bounce (macOS rubber-banding) stays at the user-agent background. With the mirrored property the bounce area follows the theme too. The write happens when a theme connects and whenever its appearance changes, including `appearance="system"` following an OS light/dark flip; the value written is the theme's computed value, so an override of `--wui-color-page` on the host is mirrored as it stands. **Not live:** the component does not observe the host's own style changes, so a runtime change to that property on the host (an inline style edit, a class toggle, a host-level media query) reaches the root only at the next write trigger, which is a connect, an `appearance` change to a different value, or an OS light/dark flip; re-assigning `appearance` to the value it already has is not a trigger, because the update is skipped when nothing changed. For a page color that has to change independently of the theme's appearance, own the variable yourself on `:root` or `body` with `!important`, which outranks this inline write, or drive the color through `appearance`. Only the outermost theme writes: nested themes keep their own scope and never touch the root value. Ownership follows connect order and passes to the next connected theme when the outermost one disconnects; when the last theme disconnects the value is deliberately kept rather than removed, so a page that swaps themes does not flash back to the user-agent background in between. The library writes exactly this one custom property on the document element and nothing else there.
|
|
1424
1522
|
|
|
1425
1523
|
**Foundation tokens:**
|
|
1426
1524
|
|
|
1427
1525
|
| Property | Default | Description |
|
|
1428
1526
|
| ------------------------- | ------- | ------------------------------------------------ |
|
|
1429
|
-
| `--wui-font-size` | `14px` | Base font size for controls |
|
|
1430
1527
|
| `--wui-input-width` | `200px` | Default width for compact form controls |
|
|
1431
1528
|
| `--wui-control-size` | `36px` | Default height and square min-width for controls |
|
|
1432
1529
|
| `--wui-overlay-min-width` | `200px` | Minimum anchored overlay width |
|
|
1433
1530
|
| `--wui-focus-ring-width` | `3px` | Focus indicator width |
|
|
1434
1531
|
|
|
1532
|
+
**Typography tokens:** font sizes are named by the role the text plays, not by scale position — `caption` for dense chrome labels, `readout` for numeric readouts, the unsuffixed base for body copy, and `title` for bounded card headings. Weights are named by weight, and line heights by how much vertical air the text needs. These are appearance-independent: they stay the same under both light and dark.
|
|
1533
|
+
|
|
1534
|
+
| Property | Default | Description |
|
|
1535
|
+
| ---------------------------- | ------- | --------------------------------------------------------------- |
|
|
1536
|
+
| `--wui-font-size-caption` | `12px` | Dense chrome labels (badge, toast timestamp, menu section head) |
|
|
1537
|
+
| `--wui-font-size-readout` | `13px` | Numeric readouts (image preview count and zoom ratio) |
|
|
1538
|
+
| `--wui-font-size` | `14px` | Base font size for body copy and controls |
|
|
1539
|
+
| `--wui-font-size-title` | `18px` | Bounded card headings (dialog, drawer) |
|
|
1540
|
+
| `--wui-font-weight-medium` | `500` | Medium weight for emphasized inline text |
|
|
1541
|
+
| `--wui-font-weight-semibold` | `600` | Semibold weight for headings |
|
|
1542
|
+
| `--wui-line-height-tight` | `1.2` | Tight leading for large headings |
|
|
1543
|
+
| `--wui-line-height-snug` | `1.4` | Snug leading for mid-size headings |
|
|
1544
|
+
| `--wui-line-height-normal` | `1.5` | Normal leading for body copy |
|
|
1545
|
+
| `--wui-line-height-relaxed` | `1.6` | Relaxed leading for long-form reading |
|
|
1546
|
+
|
|
1547
|
+
`line-height: 1` and `line-height: 0` inside components are intentionally not tokenized: the former vertically centers a single-line control label, the latter collapses a wrapper box onto its content. Neither is typographic leading, and tokenizing them would invite callers to retune them as if they were.
|
|
1548
|
+
|
|
1549
|
+
**Spacing tokens:** a six-step scale on a 4px base, stopping at 24px — the largest spacing value the component layer writes as an _effective_ static rhythm literal. (The one wider padding, `<web-ui-empty>`'s `32px 24px`, is derived in JS from `--wui-empty-size`, so it belongs to that size axis rather than to the rhythm; see the exclusions below.) These do not replace the per-component override tokens (`--wui-button-px`, `--wui-dialog-padding`, and friends) — they act as the fallback default _for_ those tokens, so each component still decides its own padding while the scale says where that value sits in the overall rhythm. Overriding a step therefore gives the embedding application a density lever across every migrated call site — a lever over rhythm, not over structure; see the exclusions below.
|
|
1550
|
+
|
|
1551
|
+
| Property | Default | Description |
|
|
1552
|
+
| --------------- | ------- | ---------------------------------- |
|
|
1553
|
+
| `--wui-space-1` | `4px` | Tight inset (badge, menu) |
|
|
1554
|
+
| `--wui-space-2` | `8px` | Control gap, group gap, inline pad |
|
|
1555
|
+
| `--wui-space-3` | `12px` | Horizontal control padding |
|
|
1556
|
+
| `--wui-space-4` | `16px` | Standard section separation |
|
|
1557
|
+
| `--wui-space-5` | `20px` | Overlay content padding |
|
|
1558
|
+
| `--wui-space-6` | `24px` | Wide overlay inset |
|
|
1559
|
+
|
|
1560
|
+
The scale deliberately omits `1px`, `2px`, `6px`, `7.5px`, `10px`, and negative values. `1px` is the structural width of hairlines and stroke rings; `2px`, `6px`, and `7.5px` are optical corrections; `10px` is a half-step coupling value off the 4px grid; negative margins cancel a flex gap or a button's padding. Each answers a different "why this number", none of them share spacing semantics, and folding them into one ruler would make overriding any one of them disturb the rest.
|
|
1561
|
+
|
|
1562
|
+
A second exclusion is by meaning rather than by value: offsets that align to the viewport edge or to the host's own content edge stay off the scale even when they land on the 4px grid — `--wui-image-preview-edge-gap`, `--wui-toast-viewport-gap`, `--wui-layout-mobile-toggle-inset`, `--wui-back-top-right` / `--wui-back-top-left` / `--wui-back-top-bottom`, `--wui-drawer-inset`, and `--wui-drawer-close-right`. Their reference frame is the screen or the host's content edge, not the rhythm between neighbours, so folding them in would make "tighten `--wui-space-2`" unexpectedly move a component away from the screen edge. `--wui-drawer-close-top` is the counter-example: it does resolve through `--wui-space-4`, because it tracks the drawer's header padding and the two must move together.
|
|
1563
|
+
|
|
1564
|
+
A third exclusion is spacing that a component derives from a **size** prop instead of writing as rhythm: `<web-ui-empty>` scales its `padding`, `min-block-size`, and glyph with `--wui-empty-size`, so its padding is `23px 17px` / `32px 24px` / `41px 31px` at the `40` / `56` / `72` steps. Four of those six values are odd, so a 4px scale cannot represent them at all. The `56` step's `32px 24px` landing on the base is a coincidence of the size choice, not a sign that the value belongs to the rhythm: `56` is the only one of the three that divides by 7, its quotient is exactly 8, and 8 is itself a multiple of 4 — no rounding happens on that step at all. A density lever that is silently inert on two of three sizes and coincidentally live on the third is worse than no lever, and the whole set moves whenever `size` does — so these stay off the scale. Reach for a literal `px` there instead.
|
|
1565
|
+
|
|
1566
|
+
Overrides must sit inside the `<web-ui-theme>` scope, since the theme host declares the steps for its own subtree. One known boundary: the overlay styles in `assets/*.css` are injected either into a theme-owned overlay root, where the scale applies, or into the document-level fallback overlay root — a plain `div` that sees no theme tokens — where overlay spacing always resolves to its literal fallback.
|
|
1567
|
+
|
|
1435
1568
|
**Selection control tokens (radio, checkbox):**
|
|
1436
1569
|
|
|
1437
|
-
| Property | Default
|
|
1438
|
-
| ------------------------------ |
|
|
1439
|
-
| `--wui-selection-control-size` | `18px`
|
|
1440
|
-
| `--wui-
|
|
1441
|
-
| `--wui-
|
|
1570
|
+
| Property | Default | Description |
|
|
1571
|
+
| ------------------------------ | -------------------- | ----------------------------------------------- |
|
|
1572
|
+
| `--wui-selection-control-size` | `18px` | Indicator (circle / box) width and height |
|
|
1573
|
+
| `--wui-checkbox-group-gap` | `var(--wui-space-2)` | Member spacing inside `<web-ui-checkbox-group>` |
|
|
1574
|
+
| `--wui-radio-group-gap` | `var(--wui-space-2)` | Member spacing inside `<web-ui-radio-group>` |
|
|
1442
1575
|
|
|
1443
1576
|
**Radius tokens:**
|
|
1444
1577
|
|
|
@@ -1452,7 +1585,6 @@ The host uses `display: contents` and does not paint any background: the library
|
|
|
1452
1585
|
|
|
1453
1586
|
| Property | Default | Description |
|
|
1454
1587
|
| ---------------------------- | ------- | ---------------------------- |
|
|
1455
|
-
| `--wui-layer-base` | `0` | Base content |
|
|
1456
1588
|
| `--wui-layer-inline-overlay` | `1` | Overlay local to a component |
|
|
1457
1589
|
| `--wui-layer-header` | `10` | Page header |
|
|
1458
1590
|
| `--wui-layer-auxiliary` | `20` | Floating utility controls |
|
|
@@ -1468,41 +1600,41 @@ The host uses `display: contents` and does not paint any background: the library
|
|
|
1468
1600
|
|
|
1469
1601
|
**Color tokens:**
|
|
1470
1602
|
|
|
1471
|
-
| Property | Light default
|
|
1472
|
-
| ---------------------------------- |
|
|
1473
|
-
| `--wui-color-page` | `#fff`
|
|
1474
|
-
| `--wui-color-surface` | `#fff`
|
|
1475
|
-
| `--wui-color-surface-raised` | `#f2f2f7`
|
|
1476
|
-
| `--wui-color-surface-control` | `#dfdfdf`
|
|
1477
|
-
| `--wui-color-surface-track` | `#e5e5ea`
|
|
1478
|
-
| `--wui-color-surface-menu` | `rgb(
|
|
1479
|
-
| `--wui-color-surface-glass` | `rgb(250 250 250 / 0.34)`
|
|
1480
|
-
| `--wui-color-surface-glass-hover` | `color-mix(... text 6%, surface-glass)`
|
|
1481
|
-
| `--wui-color-surface-glass-active` | `color-mix(... text 15%, surface-glass)`
|
|
1482
|
-
| `--wui-color-surface-overlay` | `rgb(
|
|
1483
|
-
| `--wui-color-surface-sidebar` | `rgb(
|
|
1484
|
-
| `--wui-color-surface-segmented` | `#e5e5ea`
|
|
1485
|
-
| `--wui-color-surface-selected` | `#fff`
|
|
1486
|
-
| `--wui-color-text` | `#1b1b1b`
|
|
1487
|
-
| `--wui-color-text-secondary` | `#6a6a6a`
|
|
1488
|
-
| `--wui-color-text-tertiary` | `color-mix(in srgb, var(--wui-color-text) 35%, transparent)`
|
|
1489
|
-
| `--wui-color-text-disabled` | `color-mix(in srgb, var(--wui-color-text) 32%, transparent)`
|
|
1490
|
-
| `--wui-color-state-layer-hover` | `color-mix(in srgb, var(--wui-color-text) 6%, transparent)`
|
|
1491
|
-
| `--wui-color-state-layer-active` | `color-mix(in srgb, var(--wui-color-text) 15%, transparent)`
|
|
1492
|
-
| `--wui-color-border` | `rgb(0 0 0 / 0.1)`
|
|
1493
|
-
| `--wui-color-glass-
|
|
1494
|
-
| `--wui-color-glass-
|
|
1495
|
-
| `--wui-color-glass-
|
|
1496
|
-
| `--wui-color-glass-shade`
|
|
1497
|
-
| `--wui-color-accent` | `#08f`
|
|
1498
|
-
| `--wui-color-on-accent` | `#fff`
|
|
1499
|
-
| `--wui-color-on-control` | `#fff`
|
|
1500
|
-
| `--wui-color-success` | `#16a34a`
|
|
1501
|
-
| `--wui-color-warning` | `#d97706`
|
|
1502
|
-
| `--wui-color-danger` | `#dc2626`
|
|
1503
|
-
| `--wui-color-info` | `#2563eb`
|
|
1504
|
-
| `--wui-color-backdrop` | `rgb(0 0 0 / 0.12)`
|
|
1505
|
-
| `--wui-color-focus-ring` | `
|
|
1603
|
+
| Property | Light default | Dark default | Description |
|
|
1604
|
+
| ---------------------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------- |
|
|
1605
|
+
| `--wui-color-page` | `#fff` | `#242628` | Page background |
|
|
1606
|
+
| `--wui-color-surface` | `#fff` | `#2c2c2e` | Plain surface |
|
|
1607
|
+
| `--wui-color-surface-raised` | `#f2f2f7` | `#2c2c2e` | Raised surface |
|
|
1608
|
+
| `--wui-color-surface-control` | `#dfdfdf` | `#3a3a3c` | Neutral control surface |
|
|
1609
|
+
| `--wui-color-surface-track` | `#e5e5ea` | `#444446` | Slider and switch track surface |
|
|
1610
|
+
| `--wui-color-surface-menu` | `rgb(250 250 250 / 0.76)` | `rgb(49 48 50 / 0.74)` | Menu and floating panel surface |
|
|
1611
|
+
| `--wui-color-surface-glass` | `rgb(250 250 250 / 0.34)` | `rgb(44 44 46 / 0.42)` | Liquid glass surface |
|
|
1612
|
+
| `--wui-color-surface-glass-hover` | `color-mix(... text 6%, surface-glass)` | `color-mix(... text 6%, surface-glass)` | Full glass hover background |
|
|
1613
|
+
| `--wui-color-surface-glass-active` | `color-mix(... text 15%, surface-glass)` | `color-mix(... text 15%, surface-glass)` | Full glass pressed background |
|
|
1614
|
+
| `--wui-color-surface-overlay` | `rgb(248 248 248 / 0.92)` | `rgb(32 34 34 / 0.92)` | Translucent overlay surface |
|
|
1615
|
+
| `--wui-color-surface-sidebar` | `rgb(233 233 233 / 0.82)` | `rgb(44 44 46 / 0.8)` | Sidebar panel surface |
|
|
1616
|
+
| `--wui-color-surface-segmented` | `#e5e5ea` | `#3a3a3c` | Segmented indicator surface |
|
|
1617
|
+
| `--wui-color-surface-selected` | `#fff` | `#5c5c5e` | Selected surface |
|
|
1618
|
+
| `--wui-color-text` | `#1b1b1b` | `#e9eaea` | Primary text |
|
|
1619
|
+
| `--wui-color-text-secondary` | `#6a6a6a` | `#a1a1a6` | Secondary text |
|
|
1620
|
+
| `--wui-color-text-tertiary` | `color-mix(in srgb, var(--wui-color-text) 35%, transparent)` | `color-mix(in srgb, var(--wui-color-text) 42%, transparent)` | Tertiary text and quiet icons |
|
|
1621
|
+
| `--wui-color-text-disabled` | `color-mix(in srgb, var(--wui-color-text) 32%, transparent)` | `color-mix(in srgb, var(--wui-color-text) 38%, transparent)` | Disabled foreground text |
|
|
1622
|
+
| `--wui-color-state-layer-hover` | `color-mix(in srgb, var(--wui-color-text) 6%, transparent)` | `color-mix(in srgb, var(--wui-color-text) 6%, transparent)` | Transparent hover overlay |
|
|
1623
|
+
| `--wui-color-state-layer-active` | `color-mix(in srgb, var(--wui-color-text) 15%, transparent)` | `color-mix(in srgb, var(--wui-color-text) 15%, transparent)` | Transparent pressed overlay |
|
|
1624
|
+
| `--wui-color-border` | `rgb(0 0 0 / 0.1)` | `rgb(255 255 255 / 0.14)` | Normal border and divider |
|
|
1625
|
+
| `--wui-color-glass-highlight` | `rgb(255 255 255 / 0.9)` | `rgb(255 255 255 / 0.1)` | Inset highlight on the surface |
|
|
1626
|
+
| `--wui-color-glass-ring` | `rgb(0 0 0 / 0.05)` | `rgb(255 255 255 / 0.05)` | Base tint of the 1px ring |
|
|
1627
|
+
| `--wui-color-glass-ring-sheen` | `rgb(255 255 255 / 0.5)` | `rgb(255 255 255 / 0.2)` | Corner sheen on the ring |
|
|
1628
|
+
| `--wui-color-glass-ring-shade` | `rgb(0 0 0 / 0.03)` | `rgb(0 0 0 / 0.5)` | Corner shade on the ring |
|
|
1629
|
+
| `--wui-color-accent` | `#08f` | `#0a84ff` | Accent and focused input border |
|
|
1630
|
+
| `--wui-color-on-accent` | `#fff` | `#fff` | Foreground on accent |
|
|
1631
|
+
| `--wui-color-on-control` | `#fff` | `#f2f2f7` | Foreground on control inner |
|
|
1632
|
+
| `--wui-color-success` | `#16a34a` | `#30d158` | Success |
|
|
1633
|
+
| `--wui-color-warning` | `#d97706` | `#ff9f0a` | Warning |
|
|
1634
|
+
| `--wui-color-danger` | `#dc2626` | `#ff453a` | Danger |
|
|
1635
|
+
| `--wui-color-info` | `#2563eb` | `#64d2ff` | Info |
|
|
1636
|
+
| `--wui-color-backdrop` | `rgb(0 0 0 / 0.12)` | `rgb(0 0 0 / 0.48)` | Modal backdrop |
|
|
1637
|
+
| `--wui-color-focus-ring` | `color-mix(in srgb, var(--wui-color-accent, #08f) 40%, transparent)` | `color-mix(in srgb, var(--wui-color-accent, #0a84ff) 62%, transparent)` | Focus indicator color, derived from the accent |
|
|
1506
1638
|
|
|
1507
1639
|
**Shadow tokens:**
|
|
1508
1640
|
|
|
@@ -1570,7 +1702,7 @@ Every call returns the final id of that toast, so callers never branch on create
|
|
|
1570
1702
|
| `target` | `Element` | — | Used to find nearest theme-owned overlay root |
|
|
1571
1703
|
| `container` | `HTMLElement` | — | Explicit mount container (highest priority) |
|
|
1572
1704
|
|
|
1573
|
-
**Upsert semantics
|
|
1705
|
+
**Upsert semantics**. What a second call with the same `id` does:
|
|
1574
1706
|
|
|
1575
1707
|
| Target state | Result |
|
|
1576
1708
|
| ----------------------------- | ------------------------------------------------------------------------------- |
|
|
@@ -1578,22 +1710,22 @@ Every call returns the final id of that toast, so callers never branch on create
|
|
|
1578
1710
|
| Still queued in the same tick | The queued options are patched and applied on mount; no second toast is created |
|
|
1579
1711
|
| Closed, or still exiting | A new toast is created; the one leaving finishes its exit animation on its own |
|
|
1580
1712
|
|
|
1581
|
-
`duration` restarts the countdown only when it is passed explicitly (the one exception is a hover pause: the new value is recorded without starting the timer, and the countdown runs with it once the pointer leaves); `message`, `heading` and `type` are plain properties and leave the timer alone. The `error` shortcut's 5000 ms default is applied when the toast is created, so it does not count as an explicit `duration
|
|
1713
|
+
`duration` restarts the countdown only when it is passed explicitly (the one exception is a hover pause: the new value is recorded without starting the timer, and the countdown runs with it once the pointer leaves); `message`, `heading` and `type` are plain properties and leave the timer alone. The `error` shortcut's 5000 ms default is applied when the toast is created, so it does not count as an explicit `duration`. Repeated `toast.error(msg, { id })` calls do not reset the countdown. Changing `position` moves the element to the new container and keeps the remaining time (via `moveBefore` where available, with a pause/resume fallback elsewhere); if the countdown already elapsed while the main thread was blocked, the fallback closes the toast on resume instead of leaving it open. `container` and `target` are read from the first call only. Moving a toast to a different overlay root is not supported.
|
|
1582
1714
|
|
|
1583
|
-
**Close semantics
|
|
1715
|
+
**Close semantics.** `toast.close(id)` covers every state a toast can be in, including the two before it becomes visible:
|
|
1584
1716
|
|
|
1585
1717
|
| Target state | Result |
|
|
1586
1718
|
| ---------------------------------- | --------------------------------------------------------------- |
|
|
1587
1719
|
| Visible | Plays the exit animation, then emits `toast-close` |
|
|
1588
1720
|
| Mounted, `show()` has not run yet | No exit animation to play: emits `toast-close` immediately |
|
|
1589
|
-
| Still queued in the same microtask | Dropped before it mounts
|
|
1721
|
+
| Still queued in the same microtask | Dropped before it mounts - nothing appears, no event is emitted |
|
|
1590
1722
|
| Already exiting | No-op; that toast finishes its own exit |
|
|
1591
1723
|
|
|
1592
1724
|
`toast.clear()` has the same scope: it drops queued entries and closes everything mounted.
|
|
1593
1725
|
|
|
1594
1726
|
**Events:** `toast-close` (`CustomEvent<{ id: string; reason: 'auto' | 'manual' | 'programmatic' | 'clear' }>`)
|
|
1595
1727
|
|
|
1596
|
-
Hover pauses the auto-close timer (uses `pointerenter`/`pointerleave`); leaving resumes the **remaining** time instead of restarting the full duration. If the `pointerleave` is missed while paused
|
|
1728
|
+
Hover pauses the auto-close timer (uses `pointerenter`/`pointerleave`); leaving resumes the **remaining** time instead of restarting the full duration. If the `pointerleave` is missed while paused (the pointer is dragged out of the window, or the element is moved or removed while hovered), a document-level `pointerover`/`pointerout`/`pointerleave` fallback resumes the countdown, so a hovered toast cannot stay on screen forever. Batch-mounts toasts created in the same microtask.
|
|
1597
1729
|
|
|
1598
1730
|
**CSS Custom Properties:**
|
|
1599
1731
|
|