wimui 0.78.0 → 0.79.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.ja.md +2 -2
- package/README.md +2 -2
- package/dist/components/ai/InteractiveGraph/InteractiveGraph.cjs +1 -1
- package/dist/components/ai/InteractiveGraph/InteractiveGraph.js +22 -37
- package/dist/components/ai/InteractiveGraph/interactive-graph.module.cjs +1 -1
- package/dist/components/ai/InteractiveGraph/interactive-graph.module.js +1 -1
- package/dist/components/data-display/DataGrid/DataGrid.cjs +1 -1
- package/dist/components/data-display/DataGrid/DataGrid.js +136 -111
- package/dist/components/data-display/DataGrid/useDataGridKeyboard.cjs +1 -1
- package/dist/components/data-display/DataGrid/useDataGridKeyboard.js +23 -23
- package/dist/components/data-display/NodeGraph/NodeGraph.cjs +1 -1
- package/dist/components/data-display/NodeGraph/NodeGraph.js +69 -66
- package/dist/components/data-display/NodeGraph/node-graph.module.cjs +1 -1
- package/dist/components/data-display/NodeGraph/node-graph.module.js +1 -1
- package/dist/components/form/Cascader/cascader.module.cjs +1 -1
- package/dist/components/form/Cascader/cascader.module.js +7 -6
- package/dist/components/form/OtpInput/OtpInput.cjs +1 -1
- package/dist/components/form/OtpInput/OtpInput.d.ts +5 -0
- package/dist/components/form/OtpInput/OtpInput.js +48 -41
- package/dist/components/form/SignaturePad/signature-pad.module.cjs +1 -1
- package/dist/components/form/SignaturePad/signature-pad.module.js +7 -6
- package/dist/components/form/Transfer/transfer.module.cjs +1 -1
- package/dist/components/form/Transfer/transfer.module.js +7 -6
- package/dist/components/form/TreeSelect/tree-select.module.cjs +1 -1
- package/dist/components/form/TreeSelect/tree-select.module.js +7 -6
- package/dist/llms/Alert.md +3 -1
- package/dist/llms/Anchor.md +1 -1
- package/dist/llms/AvatarGroup.md +1 -1
- package/dist/llms/Breadcrumb.md +1 -1
- package/dist/llms/CodeDiffViewer.md +2 -0
- package/dist/llms/Combobox.md +1 -1
- package/dist/llms/CommandPalette.md +1 -1
- package/dist/llms/CopyButton.md +1 -1
- package/dist/llms/Countdown.md +2 -0
- package/dist/llms/DatePicker.md +4 -0
- package/dist/llms/DateRangePicker.md +4 -0
- package/dist/llms/DescriptionList.md +2 -0
- package/dist/llms/EmptyState.md +1 -1
- package/dist/llms/Group.md +2 -0
- package/dist/llms/Highlight.md +2 -0
- package/dist/llms/InlineEdit.md +1 -1
- package/dist/llms/InputGroup.md +2 -0
- package/dist/llms/JsonViewer.md +2 -0
- package/dist/llms/Kbd.md +2 -0
- package/dist/llms/KeyboardShortcuts.md +4 -0
- package/dist/llms/LinkButton.md +2 -0
- package/dist/llms/List.md +1 -1
- package/dist/llms/NumberInput.md +1 -1
- package/dist/llms/OtpInput.md +1 -0
- package/dist/llms/Presence.md +2 -0
- package/dist/llms/ProgressRing.md +2 -0
- package/dist/llms/Rating.md +1 -1
- package/dist/llms/SegmentedControl.md +1 -1
- package/dist/llms/Stepper.md +1 -1
- package/dist/llms/Switch.md +2 -0
- package/dist/llms/Table.md +1 -1
- package/dist/llms/TagInput.md +1 -1
- package/dist/llms/ThemeToggle.md +2 -0
- package/dist/llms/Title.md +2 -0
- package/dist/llms/TreeView.md +1 -1
- package/dist/llms-full.txt +49 -34
- package/dist/llms.txt +47 -34
- package/dist/reset.css +1 -1
- package/dist/styles.css +1 -1
- package/dist/wimui.umd.css +1 -1
- package/dist/wimui.umd.js +1 -1
- package/package.json +20 -17
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
> Date range selection
|
|
4
4
|
|
|
5
|
+
Also known as: Date Range Input
|
|
6
|
+
|
|
7
|
+
⚠️ Not the same as elsewhere: In Blueprint, a "DateRangePicker" is the calendar panel for choosing a range — that is `RangeCalendar` here. WIM's `DateRangePicker` is a pair of date fields, which Blueprint calls DateRangeInput.
|
|
8
|
+
|
|
5
9
|
## Import
|
|
6
10
|
|
|
7
11
|
```ts
|
package/dist/llms/EmptyState.md
CHANGED
package/dist/llms/Group.md
CHANGED
package/dist/llms/Highlight.md
CHANGED
package/dist/llms/InlineEdit.md
CHANGED
package/dist/llms/InputGroup.md
CHANGED
package/dist/llms/JsonViewer.md
CHANGED
package/dist/llms/Kbd.md
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
> Display a structured list of keyboard shortcuts
|
|
4
4
|
|
|
5
|
+
Also known as: Hotkeys
|
|
6
|
+
|
|
7
|
+
⚠️ Not the same as elsewhere: Blueprint's Hotkeys also registers the key bindings. WIM's `KeyboardShortcuts` only shows the list of shortcuts; bind the keys in your app.
|
|
8
|
+
|
|
5
9
|
## Import
|
|
6
10
|
|
|
7
11
|
```ts
|
package/dist/llms/LinkButton.md
CHANGED
package/dist/llms/List.md
CHANGED
package/dist/llms/NumberInput.md
CHANGED
package/dist/llms/OtpInput.md
CHANGED
|
@@ -24,6 +24,7 @@ import { OtpInput } from "wimui/form";
|
|
|
24
24
|
- `labels: { /** * Accessible name for one digit box. * * `position` is **1-based**: the first box is `1`, and the last is `length`. * It is meant to be read aloud ("Digit 3 of 6"), so it counts the way a person * would. Treating it as a 0-based index and adding one yields "Digit 2" for the * first box. * * @param position 1-based position of the box, from `1` to `length` * @default (position) => `Digit ${position}` */ digitAriaLabel?: (position: number) => string; }` = {} — Labels for internationalization. `digitAriaLabel(position)` names one digit box and receives a **1-based** position — the first box is `1`, not `0`.
|
|
25
25
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
26
26
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
27
|
+
- `inputMode: "numeric" | "text"` = "numeric" — Keyboard shown on touch devices. Use `"text"` for codes that contain letters. @default "numeric"
|
|
27
28
|
|
|
28
29
|
## Design tokens it reads
|
|
29
30
|
|
package/dist/llms/Presence.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
> Shows whether a person is online, away, busy, or offline.
|
|
4
4
|
|
|
5
|
+
⚠️ Not the same as elsewhere: In Ark UI and Chakra UI, "Presence" is the helper that animates an element in and out as it mounts and unmounts — that is `Transition` here. WIM's `Presence` shows whether a person is online, away, busy or offline.
|
|
6
|
+
|
|
5
7
|
## Import
|
|
6
8
|
|
|
7
9
|
```ts
|
package/dist/llms/Rating.md
CHANGED
package/dist/llms/Stepper.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Visual sequence steps
|
|
4
4
|
|
|
5
|
-
Also known as: Progress Indicator
|
|
5
|
+
Also known as: Progress Indicator, Steps
|
|
6
6
|
|
|
7
7
|
⚠️ Not the same as elsewhere: In Apple HIG and macOS, a "Stepper" is the control that increments a number — that is `NumberInput` here. WIM's `Stepper` shows progress through a sequence of steps, which is what Material calls a Stepper.
|
|
8
8
|
|
package/dist/llms/Switch.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Also known as: Toggle, Toggle Switch
|
|
6
6
|
|
|
7
|
+
⚠️ Not the same as elsewhere: In Radix, shadcn/ui and Ark UI, a "Toggle" is a button that stays pressed (`aria-pressed`) — use a one-item `ToggleGroup` here. WIM's `Switch` is the on/off control that Apple and Material call a toggle.
|
|
8
|
+
|
|
7
9
|
## Import
|
|
8
10
|
|
|
9
11
|
```ts
|
package/dist/llms/Table.md
CHANGED
package/dist/llms/TagInput.md
CHANGED
package/dist/llms/ThemeToggle.md
CHANGED
package/dist/llms/Title.md
CHANGED
package/dist/llms/TreeView.md
CHANGED
package/dist/llms-full.txt
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
## What this is
|
|
6
6
|
|
|
7
|
-
**wimui** v0.
|
|
7
|
+
**wimui** v0.79.0 — a React 19 component library: 234 documented components across 10 categories, with design tokens, dark mode, i18n (en/ja/pt-BR) and WAI-ARIA compliant a11y. Peer deps: react ^19, react-dom ^19 (plus optional peers for specific components — see package.json).
|
|
8
8
|
|
|
9
9
|
## Install & required setup
|
|
10
10
|
|
|
@@ -763,7 +763,7 @@ The container-query wrapper div is preserved to maintain responsive column behav
|
|
|
763
763
|
- `justify: "start" | "center" | "end" | "between" | "around" | "stretch"` — Justification of items along the inline (horizontal) axis
|
|
764
764
|
- `flow: "row" | "column" | "dense" | "row dense" | "column dense"` — Grid auto-flow direction
|
|
765
765
|
- `inline: boolean` = false — Whether to render as an inline grid
|
|
766
|
-
- **Group** — Flexible grouping
|
|
766
|
+
- **Group** — Flexible grouping (aka Wrap)
|
|
767
767
|
- `asChild: boolean` — If true, the group will be rendered as its child, merging its props onto that child.
|
|
768
768
|
- `align: "start" | "center" | "end" | "stretch" | "baseline"` = "center" — Vertical alignment
|
|
769
769
|
- `justify: "start" | "center" | "end" | "between" | "around" | "evenly"` = "start" — Horizontal alignment
|
|
@@ -1108,7 +1108,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1108
1108
|
so the unit does not have to be repeated in the label.
|
|
1109
1109
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1110
1110
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1111
|
-
- **Combobox** — Select with search (aka Autocomplete, Auto Complete)
|
|
1111
|
+
- **Combobox** — Select with search (aka Autocomplete, Auto Complete, Suggest)
|
|
1112
1112
|
- `options: ComboboxOption[]` = [] — List of suggestion options
|
|
1113
1113
|
- `onChange: (option: ComboboxOption) => void` — Callback when an option is selected
|
|
1114
1114
|
- `placeholder: string` — Placeholder for the input
|
|
@@ -1124,7 +1124,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1124
1124
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1125
1125
|
- `id: string` — Unique ID for the component
|
|
1126
1126
|
- `labels: { noResults?: React.ReactNode; }` = {} — Labels for internationalization
|
|
1127
|
-
- **CopyButton** — Copy to clipboard (aka Copy)
|
|
1127
|
+
- **CopyButton** — Copy to clipboard (aka Copy, Clipboard)
|
|
1128
1128
|
- `value: string` (required) — Text copied to the clipboard
|
|
1129
1129
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
1130
1130
|
- `className: string` — Additional class names
|
|
@@ -1184,7 +1184,8 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1184
1184
|
`kg`, `%` or `円`. It is announced with the field via `aria-describedby`,
|
|
1185
1185
|
so the unit does not have to be repeated in the label.
|
|
1186
1186
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1187
|
-
- **DatePicker** — Date selection
|
|
1187
|
+
- **DatePicker** — Date selection (aka Date Input)
|
|
1188
|
+
- ⚠️ Not the same as elsewhere: In Blueprint, a "DatePicker" is the calendar panel shown inline — that is `Calendar` here. WIM's `DatePicker` is a text field that opens a calendar, which Blueprint calls DateInput.
|
|
1188
1189
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1189
1190
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1190
1191
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1204,7 +1205,8 @@ so the unit does not have to be repeated in the label.
|
|
|
1204
1205
|
- `labels: { placeholder?: string; }` — Labels for manual translation
|
|
1205
1206
|
- `width: ("xs" | "sm" | "md" | "lg" | "xl") | string | number` — Fixed width of the field (width token, CSS value, or number in px)
|
|
1206
1207
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1207
|
-
- **DateRangePicker** — Date range selection
|
|
1208
|
+
- **DateRangePicker** — Date range selection (aka Date Range Input)
|
|
1209
|
+
- ⚠️ Not the same as elsewhere: In Blueprint, a "DateRangePicker" is the calendar panel for choosing a range — that is `RangeCalendar` here. WIM's `DateRangePicker` is a pair of date fields, which Blueprint calls DateRangeInput.
|
|
1208
1210
|
- `startProps: React.ComponentProps<typeof DatePicker>` — Props passed to the start-date DatePicker
|
|
1209
1211
|
- `endProps: React.ComponentProps<typeof DatePicker>` — Props passed to the end-date DatePicker
|
|
1210
1212
|
- `className: string` — Additional class names
|
|
@@ -1347,7 +1349,7 @@ resolution of the source image; without a bound a large photo produces a large d
|
|
|
1347
1349
|
@default 0.92
|
|
1348
1350
|
- `crossOrigin: "anonymous" | "use-credentials"` — CORS mode used to load the image. Needed to crop an image served from another origin;
|
|
1349
1351
|
the server must send matching CORS headers or the image will not load at all.
|
|
1350
|
-
- **InlineEdit** — A component that allows users to switch between a view-only mode and an editable mode in-place. (aka Editable Text, Edit In Place)
|
|
1352
|
+
- **InlineEdit** — A component that allows users to switch between a view-only mode and an editable mode in-place. (aka Editable Text, Edit In Place, Editable)
|
|
1351
1353
|
- `value: string` — Current text (controlled)
|
|
1352
1354
|
- `defaultValue: string` — Initial text (uncontrolled)
|
|
1353
1355
|
- `onChange: (value: string) => void` — Callback when the text changes while editing
|
|
@@ -1412,7 +1414,7 @@ make room rather than running underneath it.
|
|
|
1412
1414
|
- `onClear: () => void` — Callback when the clear button is clicked
|
|
1413
1415
|
- `clearAriaLabel: string` — Aria label for the clear button
|
|
1414
1416
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1415
|
-
- **InputGroup** — Inputs with icons/labels
|
|
1417
|
+
- **InputGroup** — Inputs with icons/labels (aka Control Group)
|
|
1416
1418
|
- `children: React.ReactNode` (required) — Inputs, buttons, and add-ons to combine into one unit
|
|
1417
1419
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1418
1420
|
- `className: string` — Additional class names
|
|
@@ -1450,7 +1452,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1450
1452
|
so the unit does not have to be repeated in the label.
|
|
1451
1453
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1452
1454
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1453
|
-
- **LinkButton** — Anchor styled as button
|
|
1455
|
+
- **LinkButton** — Anchor styled as button (aka Anchor Button)
|
|
1454
1456
|
- `iconPosition: "left" | "right"` = "left" — Position of the icon relative to the label
|
|
1455
1457
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
1456
1458
|
- `variant: "solid" | "outline" | "ghost"` = "outline" — Visual style variant of the button
|
|
@@ -1481,7 +1483,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1481
1483
|
- `aria-describedby: string` — ID of the element that describes the field
|
|
1482
1484
|
- `width: ("xs" | "sm" | "md" | "lg" | "xl") | string | number` — Fixed width of the field (width token, CSS value, or number in px)
|
|
1483
1485
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1484
|
-
- **NumberInput** — Input with step adjustments (aka Spin Button, Numeric Stepper)
|
|
1486
|
+
- **NumberInput** — Input with step adjustments (aka Spin Button, Numeric Stepper, Numeric Input)
|
|
1485
1487
|
- `mode: "number" | "text"` = "number" — 'number': uses the native type="number" (e.g. quantity steppers)
|
|
1486
1488
|
'text': uses type="text" + inputmode (e.g. card numbers or IDs where leading zeros must be kept)
|
|
1487
1489
|
- `hideSpinButton: boolean` = true — Whether to hide the spin buttons
|
|
@@ -1501,6 +1503,8 @@ so the unit does not have to be repeated in the label.
|
|
|
1501
1503
|
box and receives a **1-based** position — the first box is `1`, not `0`.
|
|
1502
1504
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1503
1505
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1506
|
+
- `inputMode: "numeric" | "text"` = "numeric" — Keyboard shown on touch devices. Use `"text"` for codes that contain letters.
|
|
1507
|
+
@default "numeric"
|
|
1504
1508
|
- **PasswordInput** — Password with toggle
|
|
1505
1509
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1506
1510
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
@@ -1612,7 +1616,7 @@ of a radio group. Use with `description` when the options need explaining.
|
|
|
1612
1616
|
- `aria-label: string` — Accessible label when no visible label is provided
|
|
1613
1617
|
- `aria-labelledby: string` — ID of the element that labels the slider
|
|
1614
1618
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1615
|
-
- **Rating** — Star rating (aka Star Rating, Rating Indicator, Rating Display)
|
|
1619
|
+
- **Rating** — Star rating (aka Star Rating, Rating Indicator, Rating Display, Rating Group)
|
|
1616
1620
|
- `value: number` — Current value (controlled)
|
|
1617
1621
|
- `defaultValue: number` = 0 — Default value (uncontrolled)
|
|
1618
1622
|
- `count: number` = 5 — Total number of stars
|
|
@@ -1704,7 +1708,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1704
1708
|
so the unit does not have to be repeated in the label.
|
|
1705
1709
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1706
1710
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1707
|
-
- **SegmentedControl** — Button-style controls for switching between a small set of mutually exclusive options (aka Segmented Buttons, Segmented Picker, Content Switcher)
|
|
1711
|
+
- **SegmentedControl** — Button-style controls for switching between a small set of mutually exclusive options (aka Segmented Buttons, Segmented Picker, Content Switcher, Segment Group)
|
|
1708
1712
|
- `options: Option[]` (required) — List of segment options
|
|
1709
1713
|
- `value: string` (required) — Selected value
|
|
1710
1714
|
- `onChange: (value: string) => void` (required) — Callback when the selected value changes
|
|
@@ -1808,6 +1812,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1808
1812
|
- `toggleLabel: string` (required) — Accessible name for the toggle half. The main half is named by its own text,
|
|
1809
1813
|
but the toggle only shows a chevron, so it needs one of its own.
|
|
1810
1814
|
- **Switch** — A binary switch for instantly toggling settings between on and off states (aka Toggle, Toggle Switch)
|
|
1815
|
+
- ⚠️ Not the same as elsewhere: In Radix, shadcn/ui and Ark UI, a "Toggle" is a button that stays pressed (`aria-pressed`) — use a one-item `ToggleGroup` here. WIM's `Switch` is the on/off control that Apple and Material call a toggle.
|
|
1811
1816
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
1812
1817
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the switch
|
|
1813
1818
|
- `className: string` — Additional class names
|
|
@@ -1825,7 +1830,7 @@ but the toggle only shows a chevron, so it needs one of its own.
|
|
|
1825
1830
|
- `error: string` — Error message
|
|
1826
1831
|
- `required: boolean` — Whether to show the required indicator
|
|
1827
1832
|
- `disabled: boolean` — Whether the whole group is disabled
|
|
1828
|
-
- **TagInput** — Input field for creating free-form tags. (aka Token Field, Chips Input)
|
|
1833
|
+
- **TagInput** — Input field for creating free-form tags. (aka Token Field, Chips Input, Tags Input)
|
|
1829
1834
|
- `value: string[]` — List of tags (controlled)
|
|
1830
1835
|
- `defaultValue: string[]` = [] — Initial list of tags (uncontrolled)
|
|
1831
1836
|
- `onChange: (tags: string[]) => void` — Callback when the tags change
|
|
@@ -1852,7 +1857,7 @@ but the toggle only shows a chevron, so it needs one of its own.
|
|
|
1852
1857
|
- `required: boolean` — Whether to show the required indicator
|
|
1853
1858
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1854
1859
|
- `width: ("xs" | "sm" | "md" | "lg" | "xl") | string | number` — Fixed width of the field (width token, CSS value, or number in px)
|
|
1855
|
-
- **ThemeToggle** — Light / dark / system theme switcher
|
|
1860
|
+
- **ThemeToggle** — Light / dark / system theme switcher (aka Animated Theme Toggler)
|
|
1856
1861
|
- `value: "light" | "dark" | "system"` — Selected mode (controlled)
|
|
1857
1862
|
- `defaultValue: "light" | "dark" | "system"` = "system" — Initially selected mode (uncontrolled)
|
|
1858
1863
|
- `onChange: (mode: ("light" | "dark" | "system")) => void` — Callback when the mode changes
|
|
@@ -1960,7 +1965,8 @@ so the unit does not have to be repeated in the label.
|
|
|
1960
1965
|
|
|
1961
1966
|
### feedback — `import { … } from "wimui/feedback"`
|
|
1962
1967
|
|
|
1963
|
-
- **Alert** — Important messages (aka Message Bar)
|
|
1968
|
+
- **Alert** — Important messages (aka Message Bar, Callout)
|
|
1969
|
+
- ⚠️ Not the same as elsewhere: In Fluent UI v8, a "Callout" is a popup anchored to an element — that is `Popover` here. WIM's `Alert` matches Blueprint's Callout: an inline message in the page flow.
|
|
1964
1970
|
- `title: React.ReactNode` — Title of the alert
|
|
1965
1971
|
- `titleTag: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "div" | "p" | "strong" | "span"` = "div" — HTML tag used for the alert title.
|
|
1966
1972
|
|
|
@@ -2083,7 +2089,7 @@ type therefore requires one of `label` / `aria-label` / `aria-labelledby`.
|
|
|
2083
2089
|
@default false
|
|
2084
2090
|
- `indeterminate: boolean` = false — If true, shows an indeterminate animation instead of a value.
|
|
2085
2091
|
@default false
|
|
2086
|
-
- **ProgressRing** — ProgressRing description.
|
|
2092
|
+
- **ProgressRing** — ProgressRing description. (aka Progress Circle, Animated Circular Progress Bar)
|
|
2087
2093
|
- `value: number` = 0 — Current value of the progress ring.
|
|
2088
2094
|
@default 0
|
|
2089
2095
|
- `max: number` = 100 — Maximum value of the progress ring.
|
|
@@ -2194,7 +2200,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2194
2200
|
- `children: React.ReactNode` (required) — Children to be rendered inside the affix
|
|
2195
2201
|
- `className: string` — Additional class names
|
|
2196
2202
|
- `style: React.CSSProperties` — Style attribute
|
|
2197
|
-
- **Anchor** — Smooth scroll links (aka Scrollspy, Table of Contents, TableOfContents)
|
|
2203
|
+
- **Anchor** — Smooth scroll links (aka Scrollspy, Table of Contents, TableOfContents, TOC)
|
|
2198
2204
|
- `items: AnchorLinkItem[]` = [] — Array of anchor link configurations
|
|
2199
2205
|
- `bounds: number` = 5 — Bounding distance (in pixels) for triggering active state
|
|
2200
2206
|
- `offset: number` = 0 — Offset (in pixels) from top when clicking to scroll
|
|
@@ -2214,7 +2220,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2214
2220
|
- `aria-labelledby: string` — ID of the element that labels the button. Takes precedence over `aria-label`.
|
|
2215
2221
|
- `aria-describedby: string` — ID of the element that describes the button.
|
|
2216
2222
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2217
|
-
- **Breadcrumb** — Location trace (aka Path Bar, Path Control)
|
|
2223
|
+
- **Breadcrumb** — Location trace (aka Path Bar, Path Control, Breadcrumbs)
|
|
2218
2224
|
- `items: BreadcrumbItem[]` (required) — Items to display, from the root to the current page.
|
|
2219
2225
|
- `separator: React.ReactNode` — Separator displayed between items. Defaults to a chevron icon.
|
|
2220
2226
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the breadcrumb.
|
|
@@ -2230,7 +2236,7 @@ into a "…" button that lists them.
|
|
|
2230
2236
|
- `asChild: boolean` — If true, the breadcrumb will be rendered as its child, merging its props onto that child.
|
|
2231
2237
|
- `children: React.ReactNode` — The element that becomes the breadcrumb's root (in place of `nav`) when
|
|
2232
2238
|
`asChild` is set. The list of items is rendered inside it. Ignored without `asChild`.
|
|
2233
|
-
- **CommandPalette** — Cmd+K search overlay (aka Command Bar, Quick Open)
|
|
2239
|
+
- **CommandPalette** — Cmd+K search overlay (aka Command Bar, Quick Open, Omnibar, Command)
|
|
2234
2240
|
- `children: ReactNode` (required) — Palette parts (CommandPaletteTrigger, CommandPaletteContent, etc.).
|
|
2235
2241
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2236
2242
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the palette is opened or closed.
|
|
@@ -2245,7 +2251,8 @@ button. Without this callback the button cannot close on Escape, because `open`
|
|
|
2245
2251
|
- `color: string` — Color of the bars
|
|
2246
2252
|
- `visibleBelow: "xs" | "sm" | "md" | "lg" | "xl"` — Show only below the given breakpoint (e.g. "md" matches Sidebar's mobile drawer range)
|
|
2247
2253
|
- `className: string` — Custom class name
|
|
2248
|
-
- **KeyboardShortcuts** — Display a structured list of keyboard shortcuts
|
|
2254
|
+
- **KeyboardShortcuts** — Display a structured list of keyboard shortcuts (aka Hotkeys)
|
|
2255
|
+
- ⚠️ Not the same as elsewhere: Blueprint's Hotkeys also registers the key bindings. WIM's `KeyboardShortcuts` only shows the list of shortcuts; bind the keys in your app.
|
|
2249
2256
|
- `shortcuts: ShortcutItem[]` (required) — List of shortcuts to display
|
|
2250
2257
|
- `title: string` — Section title
|
|
2251
2258
|
- `titleLevel: 2 | 3 | 4 | 5 | 6` — `title` を見出しとして描くときの段(T211)。渡さなければ見出しにならず `p` のまま。
|
|
@@ -2316,7 +2323,7 @@ near the right edge pushes the page into a horizontal scroll. Anchor a
|
|
|
2316
2323
|
- `aria-label: string` — Accessible name for the trigger button.
|
|
2317
2324
|
Lands on the inner `FloatButton`, not on the wrapper `div`.
|
|
2318
2325
|
Defaults to a translated "Open menu" / "Close menu" (en / ja / pt), following the open state.
|
|
2319
|
-
- **Stepper** — Visual sequence steps (aka Progress Indicator)
|
|
2326
|
+
- **Stepper** — Visual sequence steps (aka Progress Indicator, Steps)
|
|
2320
2327
|
- ⚠️ Not the same as elsewhere: In Apple HIG and macOS, a "Stepper" is the control that increments a number — that is `NumberInput` here. WIM's `Stepper` shows progress through a sequence of steps, which is what Material calls a Stepper.
|
|
2321
2328
|
- `steps: Step[]` = [] — Array of step configurations
|
|
2322
2329
|
- `current: number` = 0 — Index of the current active step (0-indexed)
|
|
@@ -2374,7 +2381,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2374
2381
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the avatar
|
|
2375
2382
|
- `shape: "circle" | "rounded"` = "circle" — Shape of the avatar
|
|
2376
2383
|
- `intent: "primary" | "success" | "warning" | "danger" | "info" | "neutral"` — Intent (semantic color) applied to the avatar
|
|
2377
|
-
- **AvatarGroup** — Stacked avatars (aka Face Pile)
|
|
2384
|
+
- **AvatarGroup** — Stacked avatars (aka Face Pile, Avatar Circles)
|
|
2378
2385
|
- `children: React.ReactNode` (required) — Avatar elements to group
|
|
2379
2386
|
- `max: number` — Maximum number of avatars to show before collapsing into a count. Ignored with `overflow="collapse"`.
|
|
2380
2387
|
- `size: "sm" | "md" | "lg"` = "md" — Size applied to the avatars
|
|
@@ -2510,7 +2517,7 @@ body rather than appearing alongside it.
|
|
|
2510
2517
|
- `onDelete: (id: string) => void` — Shows a Delete button when set.
|
|
2511
2518
|
- `actions: React.ReactNode` — Extra actions, placed after the built-in ones.
|
|
2512
2519
|
- `className: string` — Additional class names
|
|
2513
|
-
- **Countdown** — Display the remaining time until a target moment as a live ticking timer, for sale deadlines, OTP resend waits, and maintenance notices.
|
|
2520
|
+
- **Countdown** — Display the remaining time until a target moment as a live ticking timer, for sale deadlines, OTP resend waits, and maintenance notices. (aka Timer)
|
|
2514
2521
|
- `target: Date | string | number` (required) — The moment the countdown ends, as a Date object, ISO 8601 string,
|
|
2515
2522
|
or epoch milliseconds.
|
|
2516
2523
|
- `baseDate: Date | string | number` — Reference point used as "now". When set, the countdown is frozen at
|
|
@@ -2561,14 +2568,14 @@ drops secondary text below the AA contrast floor.
|
|
|
2561
2568
|
- `ariaLabel: string` — Accessibility label for the grid
|
|
2562
2569
|
- `aria-label: string` — Accessible name for the grid. Takes precedence over `ariaLabel`.
|
|
2563
2570
|
- `aria-labelledby: string` — ID of the element that labels the grid. Takes precedence over `aria-label`.
|
|
2564
|
-
- **DescriptionList** — Key-value pairs
|
|
2571
|
+
- **DescriptionList** — Key-value pairs (aka Data List)
|
|
2565
2572
|
- `children: React.ReactNode` (required) — DescriptionListItem elements
|
|
2566
2573
|
- `className: string` — Additional class names
|
|
2567
2574
|
- `layout: "horizontal" | "vertical" | "compact"` = "horizontal" — Layout of terms and descriptions
|
|
2568
2575
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the text
|
|
2569
2576
|
- `border: boolean` = false — Whether to show borders (alias of bordered)
|
|
2570
2577
|
- `bordered: boolean` = false — Whether to show borders
|
|
2571
|
-
- **EmptyState** — Missing data placeholder (aka Blank Slate, Zero State)
|
|
2578
|
+
- **EmptyState** — Missing data placeholder (aka Blank Slate, Zero State, Non-Ideal State)
|
|
2572
2579
|
- `title: React.ReactNode` (required) — Title to display.
|
|
2573
2580
|
- `description: React.ReactNode` — Description text to display.
|
|
2574
2581
|
- `icon: React.ReactNode` — Icon to display.
|
|
@@ -2601,7 +2608,7 @@ in; use `"center"` only when the empty state is the only thing in its region.
|
|
|
2601
2608
|
- `after: unknown` (required) — JSON value after the change
|
|
2602
2609
|
- `indent: number` = 2 — Indentation spaces for JSON.stringify (default: 2)
|
|
2603
2610
|
- `view: "split" | "unified"` — Display mode inherited from CodeDiffViewer
|
|
2604
|
-
- **JsonViewer** — Recursive tree viewer and editor for JSON data.
|
|
2611
|
+
- **JsonViewer** — Recursive tree viewer and editor for JSON data. (aka JSON Tree View)
|
|
2605
2612
|
- `data: unknown` (required) — The JSON data to display
|
|
2606
2613
|
- `expandDepth: number` = 1 — Initial depth to expand
|
|
2607
2614
|
- `showCopy: boolean` = true — If true, show copy button
|
|
@@ -2620,7 +2627,7 @@ Without it, pointer devices show the move button in the card's corner on hover o
|
|
|
2620
2627
|
- `unit: string` — Label for the score unit
|
|
2621
2628
|
- `size: "sm" | "md" | "lg"` = "md" — Size
|
|
2622
2629
|
- `showMedals: boolean` = false — Whether to paint the rank badges of the top three in gold, silver and bronze (off by default: the number and the order already say the rank)
|
|
2623
|
-
- **List** — Structurally organized items in bullet points or numbered formats (aka Contained List, Ordered List, Unordered List)
|
|
2630
|
+
- **List** — Structurally organized items in bullet points or numbered formats (aka Contained List, Ordered List, Unordered List, Card List)
|
|
2624
2631
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2625
2632
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the list items
|
|
2626
2633
|
- `spacing: "tight" | "normal" | "loose"` = "normal" — Spacing between items
|
|
@@ -2704,6 +2711,7 @@ with empty spacer rows. Use it for tables with hundreds of rows, together with
|
|
|
2704
2711
|
- `totalColumn: boolean` = false — Adds a grand total column at the right edge.
|
|
2705
2712
|
- `labels: { /** Heading of the grand total row / column and of each subtotal column. */ total?: string; }` — Text of the total headings, for when the built-in translations do not fit.
|
|
2706
2713
|
- **Presence** — Shows whether a person is online, away, busy, or offline.
|
|
2714
|
+
- ⚠️ Not the same as elsewhere: In Ark UI and Chakra UI, "Presence" is the helper that animates an element in and out as it mounts and unmounts — that is `Transition` here. WIM's `Presence` shows whether a person is online, away, busy or offline.
|
|
2707
2715
|
- `status: "online" | "away" | "busy" | "offline"` (required) — Availability of the person or resource.
|
|
2708
2716
|
- `label: string` — Text for the status. Defaults to the localized name of `status`.
|
|
2709
2717
|
- `showLabel: boolean` = false — Whether the label is shown next to the dot. The label is always exposed to
|
|
@@ -2829,7 +2837,7 @@ or by keyboard focus on its actions, closes the others.
|
|
|
2829
2837
|
- `fullSwipe: "left" | "right" | "both"` — Sides where swiping all the way across runs the outermost action without a tap
|
|
2830
2838
|
(`leftActions[0]` / the last of `rightActions`), as in iOS Mail. Off by default so a
|
|
2831
2839
|
destructive action is never triggered by momentum; the action stays available as a button.
|
|
2832
|
-
- **Table** — Rows and columns for displaying structured data efficiently (aka Structured List)
|
|
2840
|
+
- **Table** — Rows and columns for displaying structured data efficiently (aka Structured List, HTML Table)
|
|
2833
2841
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2834
2842
|
- `striped: boolean` = false — Whether to show striped (zebra) rows
|
|
2835
2843
|
- `bordered: boolean` = false — Whether to show borders between cells
|
|
@@ -2876,7 +2884,7 @@ this is given; without it the diagram is read-only.
|
|
|
2876
2884
|
anything is measured; long text is truncated and read in full by assistive technology.
|
|
2877
2885
|
- `nodeHeight: number` = 64 — Card height in px.
|
|
2878
2886
|
- `labels: { /** Accessible name of the collapse / expand button. */ expand?: (label: string) => string; collapse?: (label: string) => string; }` — Accessible names of the collapse / expand button, for when the built-in translations do not fit.
|
|
2879
|
-
- **TreeView** — Hierarchical data (aka Outline View, Tree, Flat Tree)
|
|
2887
|
+
- **TreeView** — Hierarchical data (aka Outline View, Tree, Flat Tree, File Tree)
|
|
2880
2888
|
- `children: React.ReactNode` — JSX-based items (children API). Use this when not using `nodes`.
|
|
2881
2889
|
- `nodes: TreeViewNode[]` — Node array for data-driven mode.
|
|
2882
2890
|
- `className: string` — Additional class names
|
|
@@ -3035,14 +3043,14 @@ is marked.
|
|
|
3035
3043
|
- `block: boolean` = false — If true, renders as a block (`<pre>`) instead of inline.
|
|
3036
3044
|
@default false
|
|
3037
3045
|
- `language: string` — Language identifier appended as a `language-<lang>` class for syntax highlighters.
|
|
3038
|
-
- **Highlight** — Text highlighting
|
|
3046
|
+
- **Highlight** — Text highlighting (aka Mark, Highlighter)
|
|
3039
3047
|
- `children: React.ReactNode` (required) — The full text to highlight substrings in.
|
|
3040
3048
|
- `highlight: string | string[]` (required) — Substring(s) to highlight.
|
|
3041
3049
|
- `highlightClassName: string` — Custom class name for the highlighted `<mark>` element.
|
|
3042
3050
|
- `highlightStyles: React.CSSProperties` — Custom styles for the highlighted `<mark>` element.
|
|
3043
3051
|
- `as: React.ElementType` = "span" — The HTML tag or component to use for the container. Default is "span".
|
|
3044
3052
|
- `asChild: boolean` = false — If true, the component will be rendered as its child.
|
|
3045
|
-
- **Kbd** — Keyboard shortcuts
|
|
3053
|
+
- **Kbd** — Keyboard shortcuts (aka Key Combo)
|
|
3046
3054
|
- `asChild: boolean` = false — If true, the Kbd will be rendered as its child, merging its props onto that child.
|
|
3047
3055
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the key cap.
|
|
3048
3056
|
@default "md"
|
|
@@ -3127,7 +3135,7 @@ used for "just stop at three lines".
|
|
|
3127
3135
|
|
|
3128
3136
|
Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
3129
3137
|
- `content: React.ReactNode` — Content of the text. Alternative to children (children take precedence only with asChild).
|
|
3130
|
-
- **Title** — Possesses visual weight (boldness/size) to indicate page structure.
|
|
3138
|
+
- **Title** — Possesses visual weight (boldness/size) to indicate page structure. (aka Heading)
|
|
3131
3139
|
- `asChild: boolean` = false — If true, the heading will be rendered as its child, merging its props onto that child.
|
|
3132
3140
|
- `tag: "h1" | "h2" | "h3" | "h4" | "h5" | "h6"` = "h1" — The semantic HTML tag to use.
|
|
3133
3141
|
- `size: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl"` = "xl" — The visual size of the title.
|
|
@@ -3548,7 +3556,7 @@ to a heading or in the corner of a card.
|
|
|
3548
3556
|
Pass a CSS value (e.g. "300px") or a number of lines (e.g. 20).
|
|
3549
3557
|
When set, an expand/collapse toggle is shown.
|
|
3550
3558
|
- `className: string` — Additional CSS class
|
|
3551
|
-
- **CodeDiffViewer** — Displays code changes as a side-by-side or unified diff, with line-level highlighting and Apply/Reject actions.
|
|
3559
|
+
- **CodeDiffViewer** — Displays code changes as a side-by-side or unified diff, with line-level highlighting and Apply/Reject actions. (aka Code Comparison)
|
|
3552
3560
|
- `before: string` (required) — Code before the change
|
|
3553
3561
|
- `after: string` (required) — Code after the change
|
|
3554
3562
|
- `language: string` — Language label shown in header
|
|
@@ -3784,9 +3792,16 @@ Exported hooks. Prefer them over hand-rolled equivalents (`matchMedia` listeners
|
|
|
3784
3792
|
These exist in other systems' vocabularies and are **decisions, not gaps**. Do not hand-roll them into a wimui screen; the alternative given is the supported way to express the same intent.
|
|
3785
3793
|
|
|
3786
3794
|
- **Parallax Scrolling** (aka Parallax, Scroll Parallax, Parallax Hero) — Backgrounds moving at a different speed from the foreground. The motion does not correspond to any change of state, which is what this system animates. If the goal is to show scroll position, show the position. Use `ScrollProgress` instead.
|
|
3787
|
-
- **Text Scramble** (aka Scramble Text, Decrypt Text, Glitch Text) — Randomising characters before settling on the real string. The reader parses the same sentence twice and gets nothing for the lost legibility. The one case where text legitimately arrives character by character is model output, which StreamingText already covers. Use `StreamingText` instead.
|
|
3795
|
+
- **Text Scramble** (aka Scramble Text, Decrypt Text, Glitch Text, Hyper Text) — Randomising characters before settling on the real string. The reader parses the same sentence twice and gets nothing for the lost legibility. The one case where text legitimately arrives character by character is model output, which StreamingText already covers. Use `StreamingText` instead.
|
|
3788
3796
|
- **Spring Animation** (aka Spring Physics, Springs, Physics-based Animation) — A physics engine (mass / stiffness / damping props solved in a rAF loop). The bounce curve itself already exists as the `--wim-easing-spring` token, which is what press and swipe-return use. Adding the engine would put physics parameters into the public contract and move motion from CSS to JS. Use `--wim-easing-spring` instead.
|
|
3789
3797
|
- **Choropleth Map** (aka Choropleth, Filled Map, Region Map, Geo Map) — A map shading regions by value. Shipping boundary data would put its size and a political stance on disputed borders into a UI library, and large regions dominate regardless of their values. Regions are compared more accurately in a sorted bar chart. Use `BarChart` instead.
|
|
3798
|
+
- **Animated Text Effects** (aka Animated Gradient Text, Animated Shiny Text, Aurora Text, Morphing Text, Sparkles Text, Spinning Text, Text Reveal, Typing Animation, Word Rotate, Line Shadow Text, Comic Text, Kinetic Text, Video Text, Text 3D Flip, Text Animate, Dia Text Reveal) — Text that shimmers, rotates, morphs or types itself out. It cannot be read while it moves, and keeps moving after it has been read. Emphasis is a matter of weight, colour and size; the one case where text legitimately arrives piece by piece is model output, which StreamingText covers. Use `Text` instead.
|
|
3799
|
+
- **Decorative Background Pattern** (aka Dot Pattern, Grid Pattern, Animated Grid Pattern, Interactive Grid Pattern, Flickering Grid, Hexagon Pattern, Striped Pattern, Retro Grid, Noise Texture, Dither Field, Light Rays, Meteors, Particles, Warp Background, Glyph Matrix, Backlight, Floating 3D Particles, Ripple) — Patterns and particles laid behind content that carry no meaning of their own. They make the background under text uneven, which costs contrast, and moving ones compete with real motion in the foreground. Separate surfaces with the surface tokens and borders instead. Use `Box` instead.
|
|
3800
|
+
- **Animated Button Effects** (aka Shimmer Button, Shiny Button, Rainbow Button, Pulsating Button, Ripple Button, Interactive Hover Button, Animated Subscribe Button, Confetti, Cool Mode) — Buttons that shimmer, pulse, ripple or burst into confetti. They only attract attention before the click, and once several buttons do it the primary action is lost. Rank actions with Button variants, and report the result through the state change and an announcement. Use `Button` instead.
|
|
3801
|
+
- **Glow and Spotlight Card** (aka Magic Card, Neon Gradient Card, Shine Border, Glare Hover, Lens, Progressive Blur, Blur Fade, Pixel Image) — Cards with glowing borders, a spotlight that follows the pointer, or content that fades in from a blur. Nothing happens for touch or keyboard users, and for pointer users it does not help tell the cards apart. Use Card variants and the heading inside the card. Use `Card` instead.
|
|
3802
|
+
- **Device Mockup** (aka iPhone Mockup, Android Mockup, Safari Mockup, Browser Frame, Device Frame) — Phone and browser frames around a screenshot. It is marketing artwork rather than an interface component, and the frames go out of date with every device generation. Show the screenshot with Image, with the frame baked into the image if one is needed. Use `Image` instead.
|
|
3803
|
+
- **Decorative Motion Graphics** (aka Globe, Icon Cloud, Orbiting Circles, Animated Beam, Dock, Scroll Based Velocity, Animated List, Dotted Map, Smooth Cursor, Pointer Effect, Hero Video Dialog) — Spinning globes, floating icon clouds, beams between logos, a magnifying dock, a custom cursor: motion that carries no information. It pulls attention away from the content and is a burden for people who reduce motion. Show relationships with NodeGraph, items with List, and a video with Video inside a Dialog. Use `List` instead.
|
|
3804
|
+
- **Social Post Embed** (aka Tweet Card, Client Tweet Card, Tweet Embed) — Embedding a post from a social network in that network's own look. Its appearance and the way it is fetched change on the provider's schedule, which a design system cannot keep up with. Quote it in a Blockquote or Card with a link to the source. Use `Card` instead.
|
|
3790
3805
|
|
|
3791
3806
|
---
|
|
3792
3807
|
**One component, matching your installed version:** the package ships `dist/llms/<Component>.md` — every prop with its type and default, its sub-components, and the design tokens it reads (e.g. `node_modules/wimui/dist/llms/Select.md`, also exported as `wimui/llms/Select.md`). The hosted copy of this file tracks main and can be ahead of the release you installed.
|