@antadesign/anta 0.3.17 → 0.3.19

package/docs/components/expander.md

@@ -0,0 +1,529 @@
+# Expander
+
+A collapsible disclosure: a header that toggles a region of content open
+and closed. The `Expander` JSX wrapper renders an `<a-expander>`, whose
+shadow DOM is a `<button>` summary plus a collapsible region — so focus,
+keyboard activation (Enter / Space), and the
+WAI-ARIA disclosure semantics (`aria-expanded`) come from the platform
+button. The expand / collapse animation matches the disclosure sections
+used across these docs.
+
+The `title` is the always-visible header; the `children` are the
+collapsible body.
+
+## Priority
+
+`priority` sets the surface, reusing `Button`/`Text`'s vocabulary.
+`primary` is the most pronounced card; `secondary` (the default) is a
+subtle filled box; `tertiary` is transparent — just the header row and
+its chevron, for an inline disclosure.
+
+```tsx
+<Expander title="Primary" priority="primary">…</Expander>
+<Expander title="Secondary (default)">…</Expander>      {/* secondary is the default */}
+<Expander title="Tertiary" priority="tertiary">…</Expander>
+```
+
+## Round
+
+`round` sizes the corners to **half the folded header height** — so a folded
+expander reads as a pill, and an open one keeps that *same* corner radius instead
+of a bigger stadium. The header is measured (a `ResizeObserver`), so the pill
+tracks the header at any `level` or with custom header content. Open the example
+to see the corners hold their radius as the body appears.
+
+```tsx
+<Expander round title="Details" priority="primary">…</Expander>
+```
+
+## Tones
+
+Pick a semantic `tone` to tint the header text and — on the filled
+priorities (`secondary` / `primary`) — the surface too. The set matches
+`Button` / `Tag`: `neutral` (the default) plus `brand`, `info`,
+`success`, `warning`, and `critical`. Color comes from the theme tokens,
+so every tone tracks light and dark mode automatically. Every tone is
+shown below across all three priorities, so you can compare (rows are
+tones, columns are priorities):
+
+**Primary**
+
+**Secondary** (default)
+
+**Tertiary**
+
+```tsx
+// every tone × every priority — e.g. brand:
+<Expander tone="brand" priority="primary" title="Brand" />
+<Expander tone="brand" title="Brand" />                       {/* secondary — the default */}
+<Expander tone="brand" priority="tertiary" title="Brand" />
+// …repeat for neutral / info / success / warning / critical
+```
+
+`tone` also accepts **any literal CSS color** for a one-off tint — the
+hue is kept while lightness and chroma are pinned to the named-tone curve
+(and re-tuned for dark mode), the same mechanism as `Button` / `Tag`:
+
+```tsx
+// shown on the `primary` surface — the custom tone tints the fill;
+// drop to "secondary" (the default) for a subtler card, or "tertiary" for text only.
+<Expander tone="#ff1493" priority="primary" title="Magenta" />
+<Expander tone="rebeccapurple" priority="primary" title="Purple" />
+<Expander tone="#0d9488" priority="primary" title="Teal" />
+```
+
+## Outdent
+
+By default the chevron sits **inside** the header row. On a transparent
+`priority="tertiary"` expander, add `outdent` to hang the chevron in the
+left gutter so the **title and body sit flush** with the surrounding
+content — the same layout as the section headers in these docs. Under the
+hood it zeroes `--expander-gutter`: the title and body lose their inset and
+the chevron, positioned in that gutter, auto-hangs to the left. The
+transparent border stays (it keeps tertiary content aligned with the filled
+priorities), and a small internal correction cancels the border's 1px inset
+so the title and body line up exactly with the surrounding content.
+
+```tsx
+<Expander priority="tertiary" outdent title="…">…</Expander>
+```
+
+`outdent` only takes effect on `tertiary` — on the filled priorities
+(`secondary` / `primary`) the container edge has to bound the chevron, so
+it's a no-op there. Use it where the expander sits in a content column
+with room to its left (a prose measure); in a full-width / edge-to-edge
+container the chevron would overhang the edge.
+
+## Title & level
+
+`title` takes a string or any node. For a string, `level` (1–6) applies
+the matching heading **type scale** — the same scale as `<Title>` —
+without changing the document outline. Only the type scale changes: the
+title's left alignment is constant across every level (the chevron + a
+fixed 4px edge inset), so swapping `level` never shifts the header
+horizontally.
+
+```tsx
+<Expander title="Level 1" level={1}>…</Expander>
+<Expander title="Level 2" level={2}>…</Expander>
+<Expander title="Level 3" level={3}>…</Expander>
+<Expander title="Level 4" level={4}>…</Expander>
+<Expander title="Level 5 (default)">…</Expander>      {/* level 5 is the default */}
+<Expander title="Level 6" level={6}><Text size="small">…</Text></Expander>  {/* pair the smallest level with small body text */}
+```
+
+When you need real heading **semantics** — so the title lands in a
+page's table of contents (and assistive tech announces it as a heading) —
+pass a `<Title>` (or your own `<h2>`–`<h6>`) as the `title` instead of a
+string. The node owns its own type scale, so set the level on it, not on
+`<Expander>`; a slotted heading keeps its block-rhythm margins, so zero
+them in the header:
+
+```tsx
+{/* A node title owns its own scale + heading semantics: set the level on
+   the <Title>, not on <Expander>. (The preview uses element composition
+   because these docs render statically; the title-prop form is identical.) */}
+<Expander title={<Title level={2}>Title level 2 example</Title>}>…</Expander>
+<Expander title={<Title level={4}>Title level 4 example</Title>}>…</Expander>
+<Expander title={<Title level={6}>Title level 6 example</Title>}>…</Expander>
+
+{/* a slotted heading keeps its block-rhythm margins — zero them in the header */}
+<style>{`
+  a-expander a-title { margin: 0; }
+`}</style>
+```
+
+## Controls in the title
+
+A control placed **inside** the `title` — a copy button next to the
+heading text, an inline link, an inline `Input` — copies or activates
+without toggling the section. The header refuses to toggle when the click
+landed on any Anta control (`Button` / `ButtonCopy`, `Checkbox`, `Radio`,
+`Input`, `Select`, `InputDate`, `Calendar`, a `Menu` item, a `Tab`) or a
+native control (`button` / `a[href]` / `input` / `select` / `textarea` /
+`label` / editable), so a `ButtonCopy` beside the title works with no
+extra wiring:
+
+```tsx
+{/* A ButtonCopy in the title copies without toggling — no stopPropagation needed. */}
+<Expander title={<>Debug timeline <ButtonCopy copy={moment} icon="copy" size="small" priority="tertiary" /></>}>
+  …
+</Expander>
+```
+
+The decision is read from the click's composed path synchronously in the
+element, so it holds even where event handlers run off the UI thread (a
+consumer's `stopPropagation()` can arrive too late to beat the toggle) —
+the same contract as `Menu`'s close-on-outside-click.
+
+A **disabled** control is inert, so its click toggles the section like the
+title text does — the exclusion applies only to live controls. For a
+control the detection can't recognize (a non-interactive custom widget
+with its own handler), mark it `data-expander-ignore` to opt it out of the
+toggle:
+
+```tsx
+<Expander title={<>Report <MyWidget data-expander-ignore /></>}>…</Expander>
+```
+
+## Actions
+
+Pass `actions` to render extra controls — buttons, tags — at the end of
+the header row. They sit **outside** the toggle trigger, as its flex
+siblings: clicking them never toggles the expander, they're separately
+focusable, and screen readers announce them as their own controls.
+(Don't put interactive elements *inside* a custom `title` instead —
+nesting controls in a button is an accessibility anti-pattern.)
+
+```tsx
+<Expander title="Build artifacts" actions={<Button size="small" label="Download" />}>
+  …
+</Expander>
+```
+
+The header never wraps: actions keep their intrinsic size and the
+title ellipsizes first, so keep actions compact (a small button or
+two, a tag). Pass several controls as a fragment — they form a row
+with a 2px gap:
+
+```tsx
+<Expander
+  title="A very long expandable section title that shows how the actions would push content to ellipsize when space runs out"
+  actions={<><Button size="small" label="Expand" /><Button size="small" label="Share" /><Button size="small" label="Download" /></>}
+>
+  …
+</Expander>
+```
+
+Actions stay visible in the folded state — the header represents the
+section whether it's open or not (the same convention as GitHub's file
+headers). If an action only makes sense while open, drive the expander
+in controlled mode and swap the `actions` node on toggle.
+
+## Disabled
+
+`disabled` freezes the expander: the header is no longer clickable or
+focusable, the hover affordance is off, and the text dims. The open
+state stays as-is — disabling an open expander keeps it open. Header
+`actions` stay live; disable them separately if needed.
+
+```tsx
+<Expander title="Disabled, closed" disabled>…</Expander>
+<Expander title="Disabled, open" disabled defaultOpen>…</Expander>
+```
+
+## Open state
+
+Leave it uncontrolled and pass `defaultOpen` for the initial state — the
+element owns open/close from there. To drive it yourself, pass `open`
+and handle `onStateChange` (controlled): the expander then only follows
+the prop, and clicking the summary just *requests* a change — apply
+`detail.next` to your state to accept, or ignore it to reject. If you pass
+`open`, you own it.
+
+`onStateChange` is event-first: `(event, { next, prev })`, where `next`/`prev`
+are booleans (the requested / previous open state). `statechange` fires
+**before** the element applies anything and is **cancelable**, so even
+uncontrolled you can veto a toggle synchronously with `event.preventDefault()`
+(e.g. a section that confirms before closing) — no need to lift state.
+
+```tsx
+// uncontrolled
+<Expander title="Details" defaultOpen>…</Expander>
+
+// uncontrolled, with a veto
+<Expander title="Details" onStateChange={(e, { next }) => {
+  if (!next && unsaved) e.preventDefault()   // refuse to close
+}}>…</Expander>
+
+// controlled
+const [open, setOpen] = useState(false)
+<Expander title="Details" open={open} onStateChange={(e, { next }) => setOpen(next)}>…</Expander>
+```
+
+## Controlled vs Uncontrolled
+
+Open state follows Anta's shared **state contract**. Leave it *uncontrolled* and
+the expander owns open/close; pass the controlled prop and *you* own it. The two
+layers speak different idioms — the `<Expander>` wrapper takes booleans, the
+`<a-expander>` element takes a `state` string enum — and the wrapper maps between
+them:
+
+| | `<Expander>` (JSX) | `<a-expander>` (element) |
+|---|---|---|
+| **Uncontrolled** — element owns it | `defaultOpen` | `default-state="open" \| "closed"` |
+| **Controlled** — you own it | `open` + `onStateChange` | `state="open" \| "closed"` + `statechange` |
+| **Change event** | `onStateChange(event, { next, prev })` — `next` / `prev` are **booleans** | `statechange`, a `CustomEvent<{ next, prev }>` — `'open'` / `'closed'` |
+
+`statechange` is **cancelable** and fires *before* the element applies the
+change. Uncontrolled, call `event.preventDefault()` to veto a toggle (e.g.
+confirm before closing). Controlled, the element never self-applies — apply
+`detail.next` to `open` to accept, or do nothing to reject.
+
+### Accordion
+
+An accordion is the controlled pattern applied to a stack of expanders that share one
+open value: hold the open item's id in state, point each `open` at it, and on
+`onStateChange` set that id (or `null`) — so opening one folds the rest. Wrapping them
+in a `.accordion` lets you square the inner corners and overlap the borders by 1px, so
+the stack reads as one panel.
+
+```tsx
+const ITEMS = [
+  { id: 'shipping', title: 'Shipping & delivery', body: '…' },
+  { id: 'returns',  title: 'Returns',             body: '…' },
+  { id: 'warranty', title: 'Warranty',            body: '…' },
+]
+
+function Accordion() {
+  const [openId, setOpenId] = useState('shipping')  // null = all closed
+  return (
+    <div className="accordion">
+      {ITEMS.map((item) => (
+        <Expander
+          key={item.id}
+          title={item.title}
+          open={openId === item.id}
+          onStateChange={(_e, { next }) => setOpenId(next ? item.id : null)}
+        >
+          <Text>{item.body}</Text>
+        </Expander>
+      ))}
+    </div>
+  )
+}
+```
+
+```css
+.accordion { display: flex; flex-direction: column; }
+
+/* Overlap adjacent borders so they share one 1px line. */
+.accordion a-expander:not(:first-child) { margin-top: -1px; }
+
+/* Square the inner corners so the stack reads as one panel. */
+.accordion a-expander:first-child { border-bottom-left-radius: 0; border-bottom-right-radius: 0; }
+.accordion a-expander:last-child  { border-top-left-radius: 0; border-top-right-radius: 0; }
+.accordion a-expander:not(:first-child):not(:last-child) { border-radius: 0; }
+```
+
+### 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. |
+| `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:
+ the expander only follows this prop, and clicking the summary just
+ requests a change via `onStateChange` (so a toggle can be rejected by
+ not updating). Leave undefined for uncontrolled. |
+| `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. |
+
+Use this when you are not using the React or Preact wrapper and a native HTML control does not fit: construct the equivalent Anta web component from the elements below.
+
+Slots hold the title and actions. The details element contains the collapsible body.
+
+```html
+<a-expander default-state="open">
+  <a-expander-summary slot="title">Build artifacts</a-expander-summary>
+  <a-button slot="actions" role="button" tabindex="0" size="small">
+    <a-button-label>Share</a-button-label>
+  </a-button>
+  <a-expander-details>Everything without a slot attribute is the body.</a-expander-details>
+</a-expander>
+```
+
+### Native HTML details
+
+For a simple disclosure, add `data-anta` to native `<details>`. It keeps the
+browser's opening, keyboard, and accessibility behaviour while taking on the
+neutral tertiary Expander treatment. Add `priority="secondary"` or `"primary"`
+for a filled surface. `round`, `tone`, tertiary `outdent`, and `level="1"`–`"6"`
+use the matching Expander visual treatments. `level` changes visual type only;
+use a heading inside the summary when you need heading semantics.
+
+```html
+<details data-anta priority="secondary" tone="info" round level="3" open>
+  <summary>Build artifacts</summary>
+  <div>Everything inside &lt;details&gt; is the collapsible body.</div>
+</details>
+```
+
+Reach for the props first: **`tone`** sets the colour (any CSS colour 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 colour a
+custom `tone` derives from — set it to drive the palette from your own variable) and
+**`--expander-gutter`** (the shared left inset that re-insets header + body + chevron
+in lockstep; `outdent` sets it to `0`).
+
+```tsx
+<Expander tone="#e0457b" title="Custom" />
+```
+
+For everything else, `<a-expander>` exposes shadow **parts** — `::part(summary)` (the
+header button), `::part(content)` (the body), `::part(actions)` (the actions row) — and
+the light-DOM `<a-expander-summary>` / `<a-expander-details>` children, which you style
+directly. The header hover / active / focus states and the chevron all live on
+`::part(summary)`.
+
+Each example keeps its CSS in a `<style>` **inside** its own preview, targeting a demo
+class on that preview's expander (e.g. `.hide-chevron`) — so the rule you read is
+literally in the preview's DOM, next to the element it styles, never a page-wide
+stylesheet. The folded recipe under each preview is that same CSS; in your app, swap the
+demo class for your own selector.
+
+**Hide the chevron.** There's deliberately no prop for it: a region that folds needs a
+visible affordance. For a genuine one-off, the chevron is the summary's `::before`, so
+remove it — then pull `--expander-gutter` in (it drives the title *and* body inset
+together) to tighten the now-empty gutter, and drop your own marker into the title:
+
+```css
+a-expander.hide-chevron::part(summary)::before { display: none; }  /* remove the built-in chevron */
+a-expander.hide-chevron { --expander-gutter: 12px; }               /* tighten the inset (default 24px) */
+```
+
+**Swap the chevron glyph.** It's a CSS mask, so point `mask-image` at your own SVG; it
+keeps its gutter position and the open-state rotation:
+
+```css
+/* the chevron is the summary's ::before with a mask-image; swap the glyph for a
+   solid triangle — it keeps its position and the open-state rotate */
+a-expander.swap-chevron::part(summary)::before {
+  mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath d='M8 5l11 7-11 7z'/%3E%3C/svg%3E");
+}
+```
+
+**Tint the whole header** on hover / press by styling the summary part (the header
+`<button>`):
+
+```css
+a-expander.hover-tint::part(summary):hover  { background: var(--bg-3); }
+a-expander.hover-tint::part(summary):active { background: var(--bg-2); }
+```
+
+**Highlight the title on hover.** The title inherits its `color` from `::part(summary)`,
+so recolour the part on hover and the title (and the `currentColor` chevron) follow — a
+custom title node that sets its own `color` opts out. Here we also drop the tertiary
+hover underline on the light-DOM `a-expander-summary`:
+
+```css
+a-expander.title-highlight::part(summary):hover { color: #e5484d; }       /* title colour on hover */
+a-expander.title-highlight a-expander-summary { text-decoration: none; }  /* drop the hover underline */
+```
+
+**React to open / closed state** with the **`:state(open)`** custom state — your CSS can
+respond to it in controlled and uncontrolled mode alike, no JS. Two worked examples.
+
+*A custom code block* — pointed at the code-block surface tokens so it reads like the
+foldable code blocks on this site: a darker header bar over a lighter content surface, a
+`border-5` frame, and a tertiary-button copy that fades in once open.
+
+```tsx
+{/* An Expander pointed at the code-block surface tokens so it reads like the
+    foldable code blocks on this site: a darker header bar over a lighter
+    content surface, a border-5 frame, and a tertiary-button copy that fades
+    in once open. */}
+<Expander
+  title="Example.tsx"
+  actions={<Button priority="tertiary"><Icon shape="copy" /></Button>}
+  className="code-like"
+  defaultOpen
+>
+  <pre>{`import { Button } from '@antadesign/anta'
+
+export function SaveButton() {
+  return <Button priority="primary">Save</Button>
+}`}</pre>
+</Expander>
+
+<style>{`
+  a-expander.code-like {
+    background: var(--bg-pane);         /* header — a bit darker than the content */
+    border-color: var(--border-5);     /* the code-block frame outline */
+    color: var(--text-2);              /* title + code */
+
+    /* With custom corner radius don't reach for overflow:hidden (it would clip
+       the focus ring); instead give the host the radius and match it on the
+       parts: ::part(summary) the top corners, the body the bottom corners. */
+    border-radius: 0;
+  }
+  a-expander.code-like::part(summary):hover { color: var(--text-1); }  /* title brightens on hover */
+  a-expander.code-like::part(summary) { min-height: 36px; }
+  a-expander.code-like::part(actions) { gap: 6px; }        /* roomier action row */
+  a-expander.code-like a-expander-summary {
+    font-size: 14px;                       /* the title, a touch bigger */
+    letter-spacing: 0.02em;
+  }
+  a-expander.code-like::part(content) { background: var(--bg-canvas); }  /* content — lighter than the header */
+  a-expander.code-like a-expander-details {
+    padding: 12px 16px 14px;               /* roomier top padding above the code */
+    font-family: var(--monospace);
+    font-size: 13px;
+    font-weight: 440;
+    line-height: 20px;
+  }
+  a-expander.code-like a-expander-details pre { margin: 0; font: inherit; }
+  a-expander.code-like [slot="actions"] { opacity: 0; transition: opacity 150ms ease; }  /* copy appears once open */
+  a-expander.code-like:state(open) [slot="actions"] { opacity: 1; }
+`}</style>
+```
+
+*A chevron as a status indicator* — drop the built-in toggle chevron and put a
+**non-interactive** chevron in `actions` instead. The whole header still toggles; the
+indicator only reflects state, rotating via `:state(open)`. With the `<Expander>` JSX
+wrapper, pass `actions={<Icon shape="chevron-down" />}` (the preview below uses the
+equivalent element composition because these docs render statically):
+
+```tsx
+{/* renders an <a-expander> whose only header control is a non-interactive
+    chevron in the actions slot; the whole header toggles, the chevron flips */}
+<Expander actions={<Icon shape="chevron-down" />} className="indicator" defaultOpen>
+  Build log
+</Expander>
+
+{/* the JSX wrapper boxes the icon in a layout-neutral span, so target the
+    [slot="actions"] element */}
+<style>{`
+  a-expander.indicator { --expander-gutter: 12px; }                /* one var: title + body inset */
+  a-expander.indicator::part(summary)::before { display: none; }   /* drop the built-in chevron */
+  a-expander.indicator [slot="actions"] {
+    pointer-events: none;
+    margin-inline-end: 6px;                                        /* a little more right inset */
+    transition: transform 150ms ease;
+  }
+  a-expander.indicator:state(open) [slot="actions"] { transform: rotate(180deg); }  /* points down → up */
+`}</style>
+```

package/docs/components/icon.md

@@ -0,0 +1,155 @@
+# Icon
+
+Inline-block icon rendered via CSS `mask-image`. Color follows
+`currentColor`, default size is 16×16, and the only required prop is
+`shape`. The set of valid shapes is the union of Anta's built-ins plus
+any custom icons you generate yourself.
+
+`shape="loader"` is the exception: it is Anta's animated loading alias for
+string-only icon props. Use `Loader` when you need a progress value, speed, or
+accessible loading status.
+
+> In practice you'll rarely reach for `<Icon>` directly. Most Anta
+> components that need an icon expose an `icon` prop that's typed
+> against `IconShape` — autocomplete and type-checking work the same
+> way without the wrapping element. Use `<Icon>` when you need a
+> standalone icon outside of any other component.
+
+## Built-in shapes
+
+### 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. |
+| `size?` | number | 16 | Width and height in pixels. |
+
+Use this when you are not using the React or Preact wrapper and a native HTML control does not fit: construct the equivalent Anta web component from the elements below.
+
+Set the accessible name on the raw element. Use `--icon-size` for a portable custom
+size.
+
+```html
+<a-icon
+  shape="warning-triangle"
+  role="img"
+  aria-label="Warning"
+  style="--icon-size: 24px"
+></a-icon>
+```
+
+## Sizing and color
+
+Pass `size` (a number, in pixels) to control width and height
+together. Default is `16`. Color always follows `currentColor`.
+
+```tsx
+<Icon shape="chevron-down" />                                  {/* 16×16, current color */}
+<Icon shape="check" size={24} />                               {/* 24×24 */}
+<Text tone="critical"><Icon shape="warning-triangle" /></Text> {/* tinted */}
+```
+
+Internally, `size` is applied as the `--icon-size` CSS custom property
+on the rendered `<a-icon>`. The base CSS rule reads it as
+`width: var(--icon-size, 16px); height: var(--icon-size, 16px)`. That
+means consumer CSS (or a parent's variable cascade) can drive icon
+size too — useful for sizing whole regions of UI at once:
+
+```css
+.toolbar { --icon-size: 18px; }
+```
+
+> The `<Icon size>` wrapper sets `--icon-size` inline, so it works
+> everywhere. Hand-authoring the raw element's `size` *attribute*
+> (`<a-icon size="18">`) instead relies on typed `attr()` (Chrome 133+);
+> on browsers without it (iOS Safari, Firefox) the attribute is ignored
+> and the icon falls back to the 16px default. Prefer `<Icon size>` for
+> exact custom sizes.
+
+## The `blank` spacer
+
+`shape="blank"` renders nothing but still occupies a full icon box at the
+current `size`. Use it to reserve a leading-icon column so labels line up when
+only some rows carry an icon — a menu or list where a few items have a leading
+glyph and the rest shouldn't shift.
+
+```tsx
+<Icon shape="blank" />                    {/* invisible 16×16 spacer */}
+<MenuItem icon="blank" label="No icon, but aligned" />
+```
+
+Note this differs from omitting the icon: leaving `shape` (or `MenuItem`'s
+`icon`) unset renders **no element**, while `blank` renders an invisible sized
+box. A bare `<Icon>` with no shape is *not* a spacer — with no mask it paints a
+solid square.
+
+## Adding your own icons
+
+Anta ships a generator script at `dist/generate-icons.mjs`. Drop your
+SVGs in a folder, point the script at it, and it emits a CSS file plus
+a TypeScript declaration that augments Anta's `IconShapes` interface —
+your shapes become valid `<Icon shape="…" />` values automatically,
+with autocomplete.
+
+```sh
+node ./node_modules/@antadesign/anta/dist/generate-icons.mjs \
+  --input ./svgs \
+  --output ./src/icons \
+  --name my-icons
+```
+
+`--input` and `--output` are arbitrary paths in your project — pick
+whatever fits your layout. The example above writes
+`./src/icons/my-icons.css` and `./src/icons/my-icons.d.ts`. Import
+the CSS once at runtime; the `.d.ts` only needs to be in your
+TypeScript include path (the same `tsconfig.json` `include` that
+already covers your other source files), nothing else.
+
+```ts
+import './icons/my-icons.css'   // runtime: registers shape rules on <a-icon>
+```
+
+You can now use `<Icon shape="my-shape" />` with full type safety.
+
+### SVG conventions
+
+The generator strips `width=` and `height=` from the root `<svg>` so
+size is fully under the host element's CSS. For best results:
+
+- Use `viewBox="0 0 16 16"` (or any square viewBox).
+- Use `stroke="currentColor"` (or `fill="currentColor"`) — the icon is
+  recolored via CSS `background-color: currentColor` masked through the
+  SVG's alpha. Black/colored fills work too, but only the alpha
+  matters; the shape is always rendered in the current text color.
+- Single-color icons only. Multi-color SVGs collapse to one color
+  because the entire shape is masked through `currentColor`.
+
+### Conflicting shape names
+
+If a generated shape has the same name as one of Anta's built-ins
+(e.g. `chevron-down`), the generator prints a warning. At runtime, the
+CSS file imported **last** wins — so importing your generated CSS
+after `@antadesign/anta/elements` overrides the matching built-ins.
+TypeScript silently merges the duplicate keys; both names remain valid
+at the type level.
+
+### Programmatic use
+
+```ts
+import { generate } from '@antadesign/anta/generate-icons.mjs'
+
+await generate({
+  input:  './svgs',
+  output: './src/icons',
+  name:   'my-icons',
+})
+```
+
+Useful for wiring icon generation into a build script.