@antadesign/anta 0.3.26 → 0.3.27

package/docs/components/checkbox.md

@@ -167,52 +167,27 @@ The wrapper sets `role="checkbox"` and `aria-checked` (`"true"` / `"false"` / `"
 
 Space toggles the checkbox. Follows the [WAI-ARIA checkbox pattern](https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/).
 
-### Props
+## Component props
 
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
-| `checked?` | CheckboxValue | — | Controlled checked state. When provided the checkbox is controlled — it
- renders exactly this and never self-applies; `onStateChange` is a *request*
- the consumer accepts by updating this prop. Use `defaultChecked` for an
- uncontrolled checkbox. `'indeterminate'` shows the minus glyph and takes
- visual precedence; clicking it requests `true`. |
-| `defaultChecked?` | CheckboxValue | false | Initial checked state for an uncontrolled checkbox. Read once; later
- changes are ignored and the element updates its state after interaction. |
+| `checked?` | CheckboxValue | — | Controlled checked state. When provided the checkbox is controlled — it renders exactly this and never self-applies; `onStateChange` is a *request* the consumer accepts by updating this prop. Use `defaultChecked` for an uncontrolled checkbox. `'indeterminate'` shows the minus glyph and takes visual precedence; clicking it requests `true`. |
+| `defaultChecked?` | CheckboxValue | false | Initial checked state for an uncontrolled checkbox. Read once; later changes are ignored and the element updates its state after interaction. |
 | `disabled?` | boolean | — | Disable the checkbox (no interaction, dropped from the tab order). |
-| `hint?` | ReactNode | — | Secondary text rendered under the label — explanatory copy, like
- Input's hint. Not part of the accessible name. |
-| `label?` | string | — | Visible label — the *value* of the checkbox (clicked along with the box).
- Convenience for the common single-string case; for richer content (markup,
- a link, an info icon) use `children`. When both are supplied, `label`
- renders first. Required unless `children` or `aria-label` is provided
- (a `role="checkbox"` takes its name from the author, not the markup). |
-| `name?` | string | — | Form field name. Inside a `<form>` the checkbox submits under this name,
- contributing `value` when checked — like a native checkbox. |
-| `onChange?` | (event) => void | — | Fired *after* the checked state changes — a native `change` event (the
- post-apply counterpart to `onStateChange`). Not cancelable. For a controlled
- checkbox this fires once you've updated `checked`. |
-| `onStateChange?` | (event, detail) => void | — | Fired on click / Space *before* the element applies any change. Event-first
- so `event.preventDefault()` is the synchronous veto (uncontrolled mode);
- `detail` carries `{ next, prev }`. In controlled mode the element never
- self-applies — answer by updating `checked`, reject by doing nothing. |
-| `onValueChange?` | (event, attrs) => void | — | Like `onChange`, but with a `{ checked, indeterminate, name, value }` snapshot
- as the second argument, matching `Input`'s `onValueChange`. |
-| `round?` | boolean \| number \| string | — | Round the checkbox mark to a circle (`border-radius: 999px` on the box). Pass
- a `number` (px) or a CSS length string for a rounded-square mark instead. |
+| `hint?` | ReactNode | — | Secondary text rendered under the label — explanatory copy, like Input's hint. Not part of the accessible name. |
+| `label?` | string | — | Visible label — the *value* of the checkbox (clicked along with the box). Convenience for the common single-string case; for richer content (markup, a link, an info icon) use `children`. When both are supplied, `label` renders first. Required unless `children` or `aria-label` is provided (a `role="checkbox"` takes its name from the author, not the markup). |
+| `name?` | string | — | Form field name. Inside a `<form>` the checkbox submits under this name, contributing `value` when checked — like a native checkbox. |
+| `onChange?` | (event) => void | — | Fired *after* the checked state changes — a native `change` event (the post-apply counterpart to `onStateChange`). Not cancelable. For a controlled checkbox this fires once you've updated `checked`. |
+| `onStateChange?` | (event, detail) => void | — | Fired on click / Space *before* the element applies any change. Event-first so `event.preventDefault()` is the synchronous veto (uncontrolled mode); `detail` carries `{ next, prev }`. In controlled mode the element never self-applies — answer by updating `checked`, reject by doing nothing. |
+| `onValueChange?` | (event, attrs) => void | — | Like `onChange`, but with a `{ checked, indeterminate, name, value }` snapshot as the second argument, matching `Input`'s `onValueChange`. |
+| `round?` | boolean \| number \| string | — | Round the checkbox mark to a circle (`border-radius: 999px` on the box). Pass a `number` (px) or a CSS length string for a rounded-square mark instead. |
 | `size?` | 'small' \| 'medium' \| 'large' | 'medium' | Size variant. small=14px, medium=16px, large=18px box. |
-| `tone?` | 'brand' \| 'neutral' \| 'info' \| 'success' \| 'warning' \| 'critical' \| (string & {}) | 'neutral' | Color of the **mark** in every state — the checked-box fill *and* the
- unselected box border. A named tone or any literal CSS color (`'#ff1493'`,
- `'rebeccapurple'`) for a one-off custom tone. Named tones track light/dark mode
- automatically; a custom color keeps its hue + chroma and pins lightness to the
- fill curve. Use `toneSelected` instead to tone only the checked mark and leave
- the empty box neutral. The label + hint stay neutral — recolor them in plain
- CSS via the theme-aware `--text-N-{tone}` tokens. |
-| `toneSelected?` | 'brand' \| 'neutral' \| 'info' \| 'success' \| 'warning' \| 'critical' \| (string & {}) | 'neutral' | Like `tone`, but colored onto the **checked mark only** — the empty box stays
- neutral grey until it's checked. Prefer this over `tone` when a resting tinted
- border would read as a validation state. Same value set as `tone`; if both are
- set, `tone` governs the off-state border and `toneSelected` the checked fill. |
+| `tone?` | 'brand' \| 'neutral' \| 'info' \| 'success' \| 'warning' \| 'critical' \| (string & {}) | 'neutral' | Color of the **mark** in every state — the checked-box fill *and* the unselected box border. A named tone or any literal CSS color (`'#ff1493'`, `'rebeccapurple'`) for a one-off custom tone. Named tones track light/dark mode automatically; a custom color keeps its hue + chroma and pins lightness to the fill curve. Use `toneSelected` instead to tone only the checked mark and leave the empty box neutral. The label + hint stay neutral — recolor them in plain CSS via the theme-aware `--text-N-{tone}` tokens. |
+| `toneSelected?` | 'brand' \| 'neutral' \| 'info' \| 'success' \| 'warning' \| 'critical' \| (string & {}) | 'neutral' | Like `tone`, but colored onto the **checked mark only** — the empty box stays neutral grey until it's checked. Prefer this over `tone` when a resting tinted border would read as a validation state. Same value set as `tone`; if both are set, `tone` governs the off-state border and `toneSelected` the checked fill. |
 | `value?` | string | "on" | Value submitted with the form when checked — like a native checkbox. |
 
+## Web Component
+
 Use the web component directly when you are not using React or Preact and a native control does not fit.
 
 The focusable host carries the state. Label and hint are light-DOM children.
@@ -241,6 +216,8 @@ treatments.
 </div>
 ```
 
+## Styling
+
 Reach for the props first: **`tone`** colors the mark in every state,
 **`toneSelected`** only the checked mark (any CSS color for a custom tone — it
 derives the full rest/hover/active curve in oklch), **`size`** the dimensions + type.

package/docs/components/dialog.md

@@ -203,47 +203,23 @@ On close, focus returns to whatever opened the dialog, from the native `<dialog>
 </Dialog>
 ```
 
-### Props
+## Component props
 
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
 | `children?` | ReactNode | — | The dialog body. Scrolls when it overflows the available height. |
-| `closable?` | boolean | true | Whether the top-right ✕ button is present. It's one way to close the dialog,
- alongside Esc, the backdrop, a `data-dialog-close` / footer action, and your
- own code; `false` removes the ✕ without making the dialog unclosable. |
+| `closable?` | boolean | true | Whether the top-right ✕ button is present. It's one way to close the dialog, alongside Esc, the backdrop, a `data-dialog-close` / footer action, and your own code; `false` removes the ✕ without making the dialog unclosable. |
 | `defaultOpen?` | boolean | — | Initial open state for the uncontrolled case (read once on mount). |
-| `footer?` | ReactNode | — | Footer content, usually the action buttons. Rendered in the bottom zone as
- a right-aligned row (wraps under pressure). Omit for none. |
-| `header?` | ReactNode | — | Header content: a title, or any node. Rendered in the top zone. Omit for a
- chromeless dialog with only a body. |
-| `name?` | string | — | Uncontrolled trigger name. Any element with `data-dialog-open="{name}"`
- opens this dialog, `data-dialog-close="{name}"` closes it. A convenience for
- triggers rendered elsewhere; ignored in controlled mode. |
-| `onStateChange?` | (event, detail) => void | — | Fired before the open state changes, on every user open or dismiss.
- `event` is the cancelable `statechange`: call `event.preventDefault()` to
- veto an *uncontrolled* transition. `detail.next` is the requested open
- state, `detail.prev` the current one (booleans). In controlled mode, apply
- `detail.next` to `open` to accept, or do nothing to reject. |
-| `open?` | boolean | — | Controlled open state. When provided, the consumer owns open/close: the
- dialog only follows this prop, and every user dismiss (Esc, backdrop, close
- button) *requests* a change via `onStateChange` (reject by not updating).
- Leave undefined for uncontrolled. |
-| `persistent?` | boolean | — | Turn off light-dismiss: a backdrop click and Esc no longer close the dialog.
- It stays closable through explicit controls (the ✕ when `closable`, a footer
- action, your own code); `persistent` isn't "un-closable", it stops an
- accidental click or stray Esc from dismissing. For an alert / confirm that
- should be answered deliberately. Omit for the default dismissible behavior. |
-| `position?` | 'center' \| 'left' \| 'right' \| 'top' \| 'bottom' \| 'fullscreen' | 'center' | Placement. `center` (the default) is a centered modal; `left` / `right` /
- `top` / `bottom` turn it into an edge drawer (full height for left/right,
- full width for top/bottom); `fullscreen` fills the whole viewport with no
- edge gap or corner radius. |
-| `round?` | boolean \| number \| 'top' \| 'right' \| 'bottom' \| 'left' \| (string & {}) | — | Corner radius. A side keyword — `'top'` / `'right'` / `'bottom'` / `'left'` —
- rounds only that edge's two corners (at `--dialog-radius`), which pairs with
- a drawer's exposed edge (a bottom sheet → `'top'`, a right drawer → `'left'`).
- A `number` (px) or CSS string rounds all corners at that value; the string
- may be a full `border-radius` shorthand (`'12px 12px 0 0'`). `true` rounds all
- corners at `--dialog-radius`. Omit for the position default: `center` is
- rounded, drawers and `fullscreen` are square. |
+| `footer?` | ReactNode | — | Footer content, usually the action buttons. Rendered in the bottom zone as a right-aligned row (wraps under pressure). Omit for none. |
+| `header?` | ReactNode | — | Header content: a title, or any node. Rendered in the top zone. Omit for a chromeless dialog with only a body. |
+| `name?` | string | — | Uncontrolled trigger name. Any element with `data-dialog-open="{name}"` opens this dialog, `data-dialog-close="{name}"` closes it. A convenience for triggers rendered elsewhere; ignored in controlled mode. |
+| `onStateChange?` | (event, detail) => void | — | Fired before the open state changes, on every user open or dismiss. `event` is the cancelable `statechange`: call `event.preventDefault()` to veto an *uncontrolled* transition. `detail.next` is the requested open state, `detail.prev` the current one (booleans). In controlled mode, apply `detail.next` to `open` to accept, or do nothing to reject. |
+| `open?` | boolean | — | Controlled open state. When provided, the consumer owns open/close: the dialog only follows this prop, and every user dismiss (Esc, backdrop, close button) *requests* a change via `onStateChange` (reject by not updating). Leave undefined for uncontrolled. |
+| `persistent?` | boolean | — | Turn off light-dismiss: a backdrop click and Esc no longer close the dialog. It stays closable through explicit controls (the ✕ when `closable`, a footer action, your own code); `persistent` isn't "un-closable", it stops an accidental click or stray Esc from dismissing. For an alert / confirm that should be answered deliberately. Omit for the default dismissible behavior. |
+| `position?` | 'center' \| 'left' \| 'right' \| 'top' \| 'bottom' \| 'fullscreen' | 'center' | Placement. `center` (the default) is a centered modal; `left` / `right` / `top` / `bottom` turn it into an edge drawer (full height for left/right, full width for top/bottom); `fullscreen` fills the whole viewport with no edge gap or corner radius. |
+| `round?` | boolean \| number \| 'top' \| 'right' \| 'bottom' \| 'left' \| (string & {}) | — | Corner radius. A side keyword — `'top'` / `'right'` / `'bottom'` / `'left'` — rounds only that edge's two corners (at `--dialog-radius`), which pairs with a drawer's exposed edge (a bottom sheet → `'top'`, a right drawer → `'left'`). A `number` (px) or CSS string rounds all corners at that value; the string may be a full `border-radius` shorthand (`'12px 12px 0 0'`). `true` rounds all corners at `--dialog-radius`. Omit for the position default: `center` is rounded, drawers and `fullscreen` are square. |
+
+## Web Component
 
 Use the web component directly when you are not using React or Preact and a native control does not fit.
 
@@ -262,6 +238,8 @@ raw `<a-button>`.
 </a-dialog>
 ```
 
+## Styling
+
 Reach for the props first: **`position`** (modal, drawer edge, or fullscreen),
 **`closable`** (the ✕), **`persistent`** (light-dismiss off), **`round`** (corner
 radius). For everything else, style the shadow **parts** in plain CSS.

package/docs/components/expander.md

@@ -304,50 +304,23 @@ function Accordion() {
 .accordion a-expander:not(:first-child):not(:last-child) { border-radius: 0; }
 ```
 
-### Props
+## Component props
 
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
-| `title` | ReactNode | — | Summary (header) content. A string is rendered with the `level`
- type scale; pass a node (e.g. a `<Title>`) for full control or real
- heading semantics in the document outline. |
-| `actions?` | ReactNode | — | Header actions (e.g. buttons, tags) rendered at the end of the
- header row, OUTSIDE the toggle trigger — clicking them never
- toggles, they're separately focusable, and screen readers see them
- as separate controls. |
+| `title` | ReactNode | — | Summary (header) content. A string is rendered with the `level` type scale; pass a node (e.g. a `<Title>`) for full control or real heading semantics in the document outline. |
+| `actions?` | ReactNode | — | Header actions (e.g. buttons, tags) rendered at the end of the header row, OUTSIDE the toggle trigger — clicking them never toggles, they're separately focusable, and screen readers see them as separate controls. |
 | `defaultOpen?` | boolean | — | Initial open state for the uncontrolled case. |
-| `disabled?` | boolean | — | Disables the header: not clickable or focusable, hover affordance
- off, text dimmed. The open state freezes as-is — disabling an open
- expander keeps it open. `actions` stay live; disable them
- separately if needed. |
-| `level?` | 1 \| 2 \| 3 \| 4 \| 5 \| 6 | 5 | Heading type scale applied to a string `title` (mirrors `<Title>`'s
- levels). Visual only — for outline semantics, pass a `<Title>` as
- the title. |
-| `onStateChange?` | (event, detail) => void | — | Fired before the open state changes. `event` is the cancelable
- `statechange` — call `event.preventDefault()` to veto an *uncontrolled*
- toggle (e.g. confirm before closing). `detail.next` is the requested
- open state, `detail.prev` the current one (booleans). In controlled
- mode, apply `detail.next` to `open` to accept, or do nothing to reject. |
-| `open?` | boolean | — | Controlled open state. When provided, the consumer owns open/close. Selecting
- the summary requests a change through `onStateChange`; omit `open` for
- uncontrolled use. |
-| `outdent?` | boolean | — | Outdent the chevron into the left gutter so the title and body sit
- flush with surrounding content (the docs-header layout). Only takes
- effect with `priority="tertiary"` — on the filled priorities the
- container edge has to bound the chevron, so it's a no-op there. |
-| `priority?` | 'primary' \| 'secondary' \| 'tertiary' | 'secondary' | Surface emphasis. `secondary` (the default) is a subtle fill;
- `primary` is a more pronounced card; `tertiary` is transparent (the
- bare disclosure). |
-| `round?` | boolean \| number \| string | — | Round corners sized to half the folded (header) height: a pill when folded,
- and — when expanded — the same corner radius rather than a bigger stadium.
- The element measures the header, so it tracks custom header content. Pass a
- `number` (px) or CSS length string for a *fixed* radius that overrides the
- measurement (and skips it) in both states. |
-| `tone?` | 'neutral' \| 'brand' \| 'info' \| 'success' \| 'warning' \| 'critical' \| (string & {}) | 'neutral' | Semantic tone, or any literal CSS color (`'#ff1493'`, `'rebeccapurple'`)
- for a one-off custom tone. Named tones re-point the text and (on filled
- priorities) the surface to the matching palette; a custom color keeps
- its hue while lightness/chroma are pinned. `'neutral'` (the default) is
- the same as omitting it. |
+| `disabled?` | boolean | — | Disables the header: not clickable or focusable, hover affordance off, text dimmed. The open state freezes as-is — disabling an open expander keeps it open. `actions` stay live; disable them separately if needed. |
+| `level?` | 1 \| 2 \| 3 \| 4 \| 5 \| 6 | 5 | Heading type scale applied to a string `title` (mirrors `<Title>`'s levels). Visual only — for outline semantics, pass a `<Title>` as the title. |
+| `onStateChange?` | (event, detail) => void | — | Fired before the open state changes. `event` is the cancelable `statechange` — call `event.preventDefault()` to veto an *uncontrolled* toggle (e.g. confirm before closing). `detail.next` is the requested open state, `detail.prev` the current one (booleans). In controlled mode, apply `detail.next` to `open` to accept, or do nothing to reject. |
+| `open?` | boolean | — | Controlled open state. When provided, the consumer owns open/close. Selecting the summary requests a change through `onStateChange`; omit `open` for uncontrolled use. |
+| `outdent?` | boolean | — | Outdent the chevron into the left gutter so the title and body sit flush with surrounding content (the docs-header layout). Only takes effect with `priority="tertiary"` — on the filled priorities the container edge has to bound the chevron, so it's a no-op there. |
+| `priority?` | 'primary' \| 'secondary' \| 'tertiary' | 'secondary' | Surface emphasis. `secondary` (the default) is a subtle fill; `primary` is a more pronounced card; `tertiary` is transparent (the bare disclosure). |
+| `round?` | boolean \| number \| string | — | Round corners sized to half the folded (header) height: a pill when folded, and — when expanded — the same corner radius rather than a bigger stadium. The element measures the header, so it tracks custom header content. Pass a `number` (px) or CSS length string for a *fixed* radius that overrides the measurement (and skips it) in both states. |
+| `tone?` | 'neutral' \| 'brand' \| 'info' \| 'success' \| 'warning' \| 'critical' \| (string & {}) | 'neutral' | Semantic tone, or any literal CSS color (`'#ff1493'`, `'rebeccapurple'`) for a one-off custom tone. Named tones re-point the text and (on filled priorities) the surface to the matching palette; a custom color keeps its hue while lightness/chroma are pinned. `'neutral'` (the default) is the same as omitting it. |
+
+## Web Component
 
 Use the web component directly when you are not using React or Preact and a native control does not fit.
 
@@ -379,6 +352,8 @@ use a heading inside the summary when you need heading semantics.
 </details>
 ```
 
+## Styling
+
 Reach for the props first: **`tone`** sets the color (any CSS color for a custom
 tone — it derives the surface in oklch), **`priority`** the fill, **`level`** the
 heading. Two knobs are worth keeping: **`--expander-tone-source`** (the color a

package/docs/components/icon.md

@@ -17,20 +17,122 @@ accessible loading status.
 
 ## Built-in shapes
 
-### Props
+| Shape | Search synonyms |
+| --- | --- |
+| `arrow-left-to-line` | dock, snap, align |
+| `arrow-left` | back, previous, prev |
+| `arrow-narrow-down` | download, fall, down |
+| `arrow-narrow-up-down` | sort, swap, transfer, reorder |
+| `arrow-narrow-up` | upload, rise, up |
+| `arrow-right` | forward, next |
+| `arrow-top-right` | external, open, leave |
+| `asterisk` | star, wildcard |
+| `blank` | spacer, empty, placeholder, space, none |
+| `book-open` | read, docs, documentation |
+| `braces` | code, brackets, json |
+| `bug` | defect, issue, error |
+| `calendar-days` |  |
+| `calendar` | date, schedule |
+| `case-sensitive` | aA, capitalize, case |
+| `chat` | message, comment, discuss |
+| `check` | tick, ok, done, confirm, approve |
+| `chevron-down` | arrow, expand, open, down |
+| `chevron-left` | arrow, back, previous |
+| `chevron-right` | arrow, forward, next |
+| `chevron-up` | arrow, collapse, close, up |
+| `chevrons-right` | skip, fast forward |
+| `circle-check` | success, ok, done |
+| `circle-dot` |  |
+| `circle-large` | dot, marker |
+| `circle-small-solid` |  |
+| `circle-user` | avatar, person, account, contact, profile |
+| `circle` | dot, point |
+| `click` | tap, press, touch |
+| `clock` | time |
+| `cloud-upload` | save, sync, upload, send, export |
+| `columns-3-cog` | columns, table, settings, configure, fields, visibility |
+| `copy` | duplicate, clone |
+| `corner-down-right` | branch, indent, return |
+| `cube` | box, package |
+| `dollar-sign` | currency, money, payment |
+| `dots-vertical` | more, kebab, options |
+| `download` | save, import |
+| `edit` | pencil, modify, rename |
+| `external-link` | open, link, share, outbound |
+| `eye-closed` |  |
+| `eye` |  |
+| `file-down` | download, save |
+| `file` | document, page |
+| `filter-x` | clear filter, reset filter, remove filter |
+| `filter` | sort, narrow |
+| `folder-close` | directory |
+| `folder-open` | directory, browse |
+| `folder-tree` | hierarchy, structure, tree |
+| `hat-glasses` | accessibility, vision, disguise, person |
+| `heart-handshake` | credits, thanks, agreement, deal, partnership |
+| `heart` | like, favorite, love, wishlist |
+| `history-tree` | log, past |
+| `history` | log, past |
+| `home` |  |
+| `hourglass` | progress, time, wait, loading, timer |
+| `info` | information, about, i |
+| `link` | url, href, anchor |
+| `list-collapse` | list, collapse, expand, items |
+| `maximize` | fullscreen, expand |
+| `megaphone` | announcement, broadcast |
+| `menu` | hamburger, list, more |
+| `minimize` | collapse, shrink |
+| `minus` | remove, subtract |
+| `moon` |  |
+| `more` | options, extra |
+| `move-horizontal` | resize, swap, horizontal |
+| `not-equal` | neq, different |
+| `play` | start, run, execute |
+| `plus` | add, new, create |
+| `pointer` |  |
+| `presentation` | slides, deck |
+| `refresh-ccw-dot` |  |
+| `refresh` | reload, sync, update |
+| `regex` | pattern, match |
+| `repeat` | loop, retry, rerun |
+| `rotate-ccw` |  |
+| `rss` | feed, subscribe |
+| `runs-history` | log, past |
+| `scroll-text` | log, output, console |
+| `search-check` | found, validated |
+| `search` | find, magnify, lookup |
+| `send` | submit, share, deliver |
+| `settings` |  |
+| `share` |  |
+| `sparkles` | ai, magic, generate |
+| `square-check-big` |  |
+| `square-menu` |  |
+| `sun` |  |
+| `swatch-book` | palette, color, swatch, paint, design |
+| `table-2` | table, grid, data, spreadsheet, rows, columns |
+| `tag` | label, badge, chip |
+| `text-cursor-input` |  |
+| `text-initial` | text, typography, letter, a |
+| `timer` | stopwatch, countdown, time |
+| `toggle-right` | toggle, switch, on, off, boolean |
+| `trash` | delete, remove, bin |
+| `view` | show, display, preview |
+| `warning-diamond` | error, invalid, alert, danger |
+| `warning-triangle` | alert, danger, caution |
+| `webhook` | integration, hook |
+| `workflow` | pipeline, process, flow |
+| `x` | close, cancel, dismiss, remove, no |
+
+## Component props
 
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
-| `shape` | IconShape | — | Which icon to render. The set of valid shapes comes from Anta's
- built-in icons plus any consumer-generated shapes (via the
- `IconShapes` interface module augmentation). |
-| `label?` | string | — | Accessible name for the icon. When set, the wrapper exposes
- `role="img"` and `aria-label={label}` so screen readers announce
- the icon. When omitted (the default), the icon is treated as
- decorative — `aria-hidden="true"` is applied so it doesn't add
- noise alongside neighbouring text. |
+| `shape` | IconShape | — | Which icon to render. The set of valid shapes comes from Anta's built-in icons plus any consumer-generated shapes (via the `IconShapes` interface module augmentation). |
+| `label?` | string | — | Accessible name for the icon. When set, the wrapper exposes `role="img"` and `aria-label={label}` so screen readers announce the icon. When omitted (the default), the icon is treated as decorative — `aria-hidden="true"` is applied so it doesn't add noise alongside neighbouring text. |
 | `size?` | number | 16 | Width and height in pixels. |
 
+## Web Component
+
 Use the web component directly when you are not using React or Preact and a native control does not fit.
 
 Set the accessible name on the raw element. Use `--icon-size` for a portable custom

package/docs/components/input-autocomplete.md

@@ -37,34 +37,30 @@ closes the list; clicking the field to place the caret keeps it open.
 Suggestions are bare strings or `SelectOption`s, the same option shape
 [Select](./select.md) uses: `value`, `label`, `hint`, `icon`, `tone`, `disabled`.
 
-### Props
+## Component props
 
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
-| `suggestions` | string \| SelectOption[] | — | The suggestions: bare strings or `SelectOption`s (`value` / `label` / `hint` /
- `icon` / `tone` / `disabled`). A flat list; picking one fills the field. |
+| `suggestions` | string \| SelectOption[] | — | The suggestions: bare strings or `SelectOption`s (`value` / `label` / `hint` / `icon` / `tone` / `disabled`). A flat list; picking one fills the field. |
 | `clearable?` | boolean | — | Show a clear button while the field has text. |
 | `defaultValue?` | string | — | Initial value for uncontrolled use. |
 | `disabled?` | boolean | — | Disable the field. |
-| `filter?` | boolean \| (option, query) => boolean | true | How suggestions match the text. `true` uses the built-in case-insensitive
- substring match on `value` / `label` / `hint`; a function `(option, query) =>
- boolean` uses a custom matcher; `false` shows `suggestions` unchanged for
- application-provided async or remote filtering. |
+| `filter?` | boolean \| (option, query) => boolean | true | How suggestions match the text. `true` uses the built-in case-insensitive substring match on `value` / `label` / `hint`; a function `(option, query) => boolean` uses a custom matcher; `false` shows `suggestions` unchanged for application-provided async or remote filtering. |
 | `hint?` | ReactNode | — | Hint under the field. |
 | `label?` | ReactNode | — | Field label. |
 | `leading?` | ReactNode | — | Leading adornment inside the field. |
 | `name?` | string | — | Form field name. |
 | `onSelect?` | (option) => void | — | Fires only when a suggestion is chosen, with that option. |
-| `onValueChange?` | (value) => void | — | Fires as the text changes (typing, picking a suggestion, or clearing) with
- the new field text. |
+| `onValueChange?` | (value) => void | — | Fires as the text changes (typing, picking a suggestion, or clearing) with the new field text. |
 | `placeholder?` | string | — | Placeholder text. |
 | `size?` | 'small' \| 'medium' \| 'large' | medium | Field size. |
 | `status?` | 'neutral' \| 'brand' \| 'info' \| 'success' \| 'warning' \| 'critical' | — | Validation status. |
 | `statusIcon?` | (string & {}) \| false \| IconShape | — | Status icon override, or `false` to drop it. |
 | `tone?` | string | — | Custom accent color — a named tone or any CSS color. |
 | `trailing?` | ReactNode | — | Trailing adornment inside the field. |
-| `value?` | string | — | Controlled value: the field's text, a **free** string not constrained to a
- suggestion. Leave undefined for uncontrolled. |
+| `value?` | string | — | Controlled value: the field's text, a **free** string not constrained to a suggestion. Leave undefined for uncontrolled. |
+
+## Web Component
 
 `InputAutocomplete` combines an input with a Menu. Reproducing its filtering,
 selection, focus, and popup coordination without the React or Preact wrapper is
@@ -90,6 +86,8 @@ option content, popup styling, or consistent behavior across browsers.
 </datalist>
 ```
 
+## Styling
+
 **The field** is styled through Input's props (`size`, `status`, `tone`, `round`,
 `leading` / `trailing`) and its `::part`s; set its width with `style` / `className`
 (forwarded to the field). **The suggestion popover** takes Menu's `::part(menu)`.

package/docs/components/input-date.md

@@ -52,42 +52,30 @@ field converts it (18 → 6 PM).
 <InputDate size="large" label="Large" time defaultValue="2026-06-15T09:00" />
 ```
 
+## InputDate props
+
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
 | `clearable?` | boolean | — | Show a clear button once the field has a value. |
 | `defaultValue?` | string | — | Initial value for the uncontrolled case. |
 | `disabled?` | boolean | — | Disable the field and the calendar. |
-| `hint?` | ReactNode | — | Helper text under the field. Replaced by a format hint while the entry is
- unrecognized. |
-| `hour12?` | boolean | — | Force the time cycle when `time` is on: `true` for 12-hour (AM/PM), `false`
- for 24-hour. Omit to follow the locale (`en-US` → 12-hour, most others → 24). |
-| `icon?` | false \| IconShape | calendar-days | Leading icon at the start of the field — the calendar affordance. Pass
- another shape to change it, or `false` to drop it. |
+| `hint?` | ReactNode | — | Helper text under the field. Replaced by a format hint while the entry is unrecognized. |
+| `hour12?` | boolean | — | Force the time cycle when `time` is on: `true` for 12-hour (AM/PM), `false` for 24-hour. Omit to follow the locale (`en-US` → 12-hour, most others → 24). |
+| `icon?` | false \| IconShape | calendar-days | Leading icon at the start of the field — the calendar affordance. Pass another shape to change it, or `false` to drop it. |
 | `label?` | ReactNode | — | Field label, above the control. |
-| `locale?` | string | navigator.language | BCP-47 locale driving the display format, the placeholder mask, parsing order,
- and the calendar. |
+| `locale?` | string | navigator.language | BCP-47 locale driving the display format, the placeholder mask, parsing order, and the calendar. |
 | `max?` | string | — | Latest selectable date (ISO). |
-| `min?` | string | — | Earliest selectable date (ISO). Earlier days disable, and a typed date before
- it stays uncommitted. |
+| `min?` | string | — | Earliest selectable date (ISO). Earlier days disable, and a typed date before it stays uncommitted. |
 | `name?` | string | — | Form field name — the ISO value submits under this key. |
 | `offset?` | number | 4 | Gap in pixels between the field and the calendar menu. |
-| `onValueChange?` | (value, attrs) => void | — | Fired after the value resolves (a recognized entry, a calendar pick, a time
- change, or a clear), with the new ISO value (`''` when cleared) and a
- `{ value, name }` snapshot. An unrecognized entry does not fire it. |
+| `onValueChange?` | (value, attrs) => void | — | Fired after the value resolves (a recognized entry, a calendar pick, a time change, or a clear), with the new ISO value (`''` when cleared) and a `{ value, name }` snapshot. An unrecognized entry does not fire it. |
 | `placeholder?` | string | the locale's format mask (e.g. `MM/DD/YYYY`, `MM/DD/YYYY HH:MM` with `time`) | Placeholder shown when empty. |
-| `placement?` | 'left' \| 'right' \| 'bottom' \| 'top' \| 'bottom-start' \| 'bottom-end' \| 'top-start' \| 'top-end' \| 'right-start' \| 'right-end' \| 'left-start' \| 'left-end' | bottom-start | Preferred placement of the calendar menu relative to the field. Same values as
- `Menu`; it auto-flips and clamps when space runs out. |
+| `placement?` | 'left' \| 'right' \| 'bottom' \| 'top' \| 'bottom-start' \| 'bottom-end' \| 'top-start' \| 'top-end' \| 'right-start' \| 'right-end' \| 'left-start' \| 'left-end' | bottom-start | Preferred placement of the calendar menu relative to the field. Same values as `Menu`; it auto-flips and clamps when space runs out. |
 | `round?` | boolean \| number \| string | — | Round the field corners — `true` for fully round, or a number / CSS length. |
 | `size?` | 'small' \| 'medium' \| 'large' | medium | Field size. Also sizes the calendar and the time row. |
 | `status?` | 'neutral' \| 'brand' \| 'info' \| 'success' \| 'warning' \| 'critical' | neutral | Validation/feedback tone. An unrecognized entry forces `critical` until fixed. |
-| `time?` | boolean | — | Include a time. The value becomes ISO `YYYY-MM-DDTHH:mm`, the field parses a
- trailing time after a space (`06/15/2026 14:30`, `… 2:30pm`), and the menu
- shows a time row (hours : minutes, an AM/PM toggle in 12-hour locales, then a
- Done button) under the calendar. Picking a day keeps the menu open so you can
- set the time. |
-| `value?` | string | — | Controlled value — ISO `YYYY-MM-DD` (or `YYYY-MM-DDTHH:mm` with `time`), `''`
- for empty. Pair with `onValueChange`; the field and calendar follow it and a
- pick only *requests* a change. |
+| `time?` | boolean | — | Include a time. The value becomes ISO `YYYY-MM-DDTHH:mm`, the field parses a trailing time after a space (`06/15/2026 14:30`, `… 2:30pm`), and the menu shows a time row (hours : minutes, an AM/PM toggle in 12-hour locales, then a Done button) under the calendar. Picking a day keeps the menu open so you can set the time. |
+| `value?` | string | — | Controlled value — ISO `YYYY-MM-DD` (or `YYYY-MM-DDTHH:mm` with `time`), `''` for empty. Pair with `onValueChange`; the field and calendar follow it and a pick only *requests* a change. |
 
 ## Calendar
 
@@ -336,6 +324,26 @@ Tracking the cursor, painting the grid from `buildMonth`, and re-rendering on
 `navigate` is what the React `Calendar` packages, plus the year/month jump menu,
 which uses the same `Menu` composition shown on the [Menu](./menu.md) page.
 
+## Calendar props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `aria-label?` | string | — | Accessible name for the grid (defaults to the visible month heading). |
+| `defaultValue?` | string | — | Initial selected date for the uncontrolled case (ISO `YYYY-MM-DD`). |
+| `disabled?` | boolean | — | Disable the whole calendar (not focusable or selectable). |
+| `focusSignal?` | number | — | Move keyboard focus onto the active day. Change this to a new value (e.g. increment a counter) to focus the cursor cell — `InputDate` bumps it when the calendar is opened from the field by keyboard (ArrowDown), so focus lands in the grid. The initial value never focuses; only a change does. |
+| `locale?` | string | navigator.language | BCP-47 locale tag driving first-day-of-week, weekday, and month names. |
+| `max?` | string | — | Latest selectable date (ISO `YYYY-MM-DD`) — later days render disabled. |
+| `min?` | string | — | Earliest selectable date (ISO `YYYY-MM-DD`) — earlier days render disabled. |
+| `name?` | string | — | Form field name — the selected ISO date submits under this key. |
+| `onChange?` | (event) => void | — | Fired *after* the selection changes (post-apply). Not cancelable; for a controlled calendar it fires once you've updated `value`. |
+| `onStateChange?` | (event, detail) => void | — | Fired whenever the selection changes — event-first. `detail` is `{ next, prev, reason }`: `next` / `prev` are ISO date strings (`null` = none); `reason` is `'user'` \| `'reset'` \| `'restore'`. A `'user'` pick fires *before* applying and is **cancelable** — `event.preventDefault()` vetoes it (uncontrolled), or in controlled mode answer by updating `value`. `'reset'` / `'restore'` are not cancelable. |
+| `onValueChange?` | (event, attrs) => void | — | Like `onChange`, but with a `{ value, name }` snapshot as the second argument, matching `Input`. |
+| `size?` | 'small' \| 'medium' \| 'large' | 'medium' | Size of the whole calendar — scales the day cells, the chevrons, and the weekday / month-heading type together (uses Button's `small` / `medium` / `large` scale). |
+| `value?` | string | — | Controlled selected date — ISO `YYYY-MM-DD`. When provided, the application controls selection: the grid follows this prop and a pick only *requests* a change via `onStateChange`. Leave undefined for uncontrolled. |
+
+## Web Component
+
 `InputDate` has no host element. Rebuilding its text parsing, dropdown calendar,
 localized day grid, month navigation, keyboard navigation, and focus management
 in vanilla JavaScript is significant work, even with Anta's `buildMonth` and
@@ -361,6 +369,8 @@ field treatments.
 <input data-anta type="week" name="sprint-week" value="2026-W25">
 ```
 
+## Styling
+
 The calendar is **light DOM**, so everything is plain CSS, with no shadow parts or
 hidden internals. The days and chevrons are real `<a-button>`s, so their colors,
 hover, focus ring, and selected look come from the Button styles and theme

package/docs/components/input-time.md

@@ -66,47 +66,39 @@ range is clamped to the nearest bound as you step or leave the field, and flags
 <InputTime label="Office hours" size="large" min="09:00" max="17:00" defaultValue="09:30" />
 ```
 
+## InputTime props
+
 | Prop | Type | Default | Description |
 |------|------|---------|-------------|
 | `autoFocus?` | boolean | — | Focus this field when its containing `Dialog` opens. |
-| `children?` | ReactNode | — | Extra content rendered under the field, above the hint (a no-box child like
- a `<Tooltip>` takes no space and anchors to the field). |
+| `children?` | ReactNode | — | Extra content rendered under the field, above the hint (a no-box child like a `<Tooltip>` takes no space and anchors to the field). |
 | `clearable?` | boolean | — | Show a clear button once the field has a value. |
 | `defaultValue?` | string | — | Initial value for the uncontrolled case (24-hour `"HH:mm"`). |
 | `dimActions?` | boolean | — | Dim the trailing adornments at rest; they brighten on hover / focus. |
 | `disabled?` | boolean | — | Disable the field. |
 | `hint?` | ReactNode | — | Message below the field. `status` recolors it and prefixes a glyph. |
-| `hour12?` | boolean | — | Force the clock: `true` = 12-hour (AM/PM), `false` = 24-hour. Omit to follow
- the locale. |
-| `icon?` | false \| IconShape | clock | Leading icon at the start of the field — the clock affordance. Pass another
- shape to change it, or `false` to drop it. |
-| `label?` | ReactNode | — | Field label, shown above the control and used as the segment group's
- accessible name. |
-| `locale?` | string | navigator.language | BCP-47 locale driving the clock (12h vs 24h), segment order, separator, and
- the AM/PM text. |
-| `max?` | string | — | Latest allowed time, 24-hour `"HH:mm"`. A complete value above it is clamped
- down (on step / blur) and flagged `rangeOverflow`. |
-| `min?` | string | — | Earliest allowed time, 24-hour `"HH:mm"`. A complete value below it is
- clamped up (on step / blur) and flagged `rangeUnderflow` for form validity. |
+| `hour12?` | boolean | — | Force the clock: `true` = 12-hour (AM/PM), `false` = 24-hour. Omit to follow the locale. |
+| `icon?` | false \| IconShape | clock | Leading icon at the start of the field — the clock affordance. Pass another shape to change it, or `false` to drop it. |
+| `label?` | ReactNode | — | Field label, shown above the control and used as the segment group's accessible name. |
+| `locale?` | string | navigator.language | BCP-47 locale driving the clock (12h vs 24h), segment order, separator, and the AM/PM text. |
+| `max?` | string | — | Latest allowed time, 24-hour `"HH:mm"`. A complete value above it is clamped down (on step / blur) and flagged `rangeOverflow`. |
+| `min?` | string | — | Earliest allowed time, 24-hour `"HH:mm"`. A complete value below it is clamped up (on step / blur) and flagged `rangeUnderflow` for form validity. |
 | `name?` | string | — | Form field name — the 24-hour value submits under this key. |
 | `onBlur?` | (e) => void | — | Fires when the field loses focus. |
 | `onClearInput?` | (e) => void | — | Fires after the built-in clear button has cleared the field. |
 | `onFocus?` | (e) => void | — | Fires when the field gains focus. |
-| `onValueChange?` | (event, attrs) => void | — | Fires on every edit (`input`), with the native event + an `attrs` snapshot
- (`value`, `name`, `empty`, `valid`, `validationMessage`). Also fires on
- `change` (blur) and on clear. |
+| `onValueChange?` | (event, attrs) => void | — | Fires on every edit (`input`), with the native event + an `attrs` snapshot (`value`, `name`, `empty`, `valid`, `validationMessage`). Also fires on `change` (blur) and on clear. |
 | `required?` | boolean | — | Mark the field required (drives native validity). |
 | `round?` | boolean \| number \| string | — | Fully-round the field, or a custom radius (`number` px / CSS length). |
 | `size?` | 'small' \| 'medium' \| 'large' | medium | Size variant. small=24px, medium=28px, large=32px tall. |
-| `status?` | 'neutral' \| 'brand' \| 'info' \| 'success' \| 'warning' \| 'critical' | — | Validation / feedback tone. Only `critical` marks the field invalid; the
- others are advisory. Omit (or `neutral`) for a plain field. |
-| `statusIcon?` | (string & {}) \| false \| IconShape | — | Glyph before the `hint` when `status` is set (per-status default; pass a
- shape to override, or `false` to drop it). |
-| `tone?` | string | — | Custom accent color — any literal CSS color tints the resting + hover
- border (focus ring stays `--focus-ring`); `status` overrides for validation. |
+| `status?` | 'neutral' \| 'brand' \| 'info' \| 'success' \| 'warning' \| 'critical' | — | Validation / feedback tone. Only `critical` marks the field invalid; the others are advisory. Omit (or `neutral`) for a plain field. |
+| `statusIcon?` | (string & {}) \| false \| IconShape | — | Glyph before the `hint` when `status` is set (per-status default; pass a shape to override, or `false` to drop it). |
+| `tone?` | string | — | Custom accent color — any literal CSS color tints the resting + hover border (focus ring stays `--focus-ring`); `status` overrides for validation. |
 | `trailing?` | ReactNode | — | Content pinned to the end of the field (after the clear button). |
 | `value?` | string | — | Controlled value — 24-hour `"HH:mm"`. Pair with `onValueChange`. |
 
+## Web Component
+
 Use the web component directly when you are not using React or Preact and a native control does not fit.
 
 Slots supply the field label and leading icon.