wimui 0.76.1 → 0.77.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/dist/ai-core.d.ts +1 -0
- package/dist/ai.cjs +1 -1
- package/dist/ai.js +11 -10
- package/dist/components/_internal/useCloseWhenReferenceGone.cjs +2 -0
- package/dist/components/_internal/useCloseWhenReferenceGone.d.ts +9 -0
- package/dist/components/_internal/useCloseWhenReferenceGone.js +17 -0
- package/dist/components/_internal/useFloatingElement.cjs +1 -1
- package/dist/components/_internal/useFloatingElement.js +28 -25
- package/dist/components/ai/AILabel/AILabel.cjs +2 -0
- package/dist/components/ai/AILabel/AILabel.d.ts +68 -0
- package/dist/components/ai/AILabel/AILabel.js +51 -0
- package/dist/components/ai/AILabel/ai-label.module.cjs +2 -0
- package/dist/components/ai/AILabel/ai-label.module.js +15 -0
- package/dist/components/ai/MarkdownRenderer/MarkdownRenderer.cjs +1 -1
- package/dist/components/ai/MarkdownRenderer/MarkdownRenderer.js +11 -11
- package/dist/components/data-display/FAQSection/FAQSection.cjs +1 -1
- package/dist/components/data-display/FAQSection/FAQSection.js +10 -10
- package/dist/components/layout/PageHeader/PageHeader.cjs +2 -0
- package/dist/components/layout/PageHeader/PageHeader.d.ts +51 -0
- package/dist/components/layout/PageHeader/PageHeader.js +55 -0
- package/dist/components/layout/PageHeader/page-header.module.cjs +2 -0
- package/dist/components/layout/PageHeader/page-header.module.js +16 -0
- package/dist/components/overlay/Dropdown/Dropdown.cjs +1 -1
- package/dist/components/overlay/Dropdown/Dropdown.js +99 -98
- package/dist/components/overlay/Popover/Popover.cjs +1 -1
- package/dist/components/overlay/Popover/Popover.js +2 -2
- package/dist/i18n/generated/ai.cjs +2 -0
- package/dist/i18n/generated/ai.d.ts +3 -0
- package/dist/i18n/generated/ai.js +21 -0
- package/dist/i18n/generated/common.d.ts +1 -1
- package/dist/i18n/generated/components.d.ts +1 -1
- package/dist/i18n/generated/keys.d.ts +2 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +175 -173
- package/dist/layout.cjs +1 -1
- package/dist/layout.d.ts +1 -0
- package/dist/layout.js +2 -1
- package/dist/llms/AILabel.md +27 -0
- package/dist/llms/AppShell.md +2 -0
- package/dist/llms/Avatar.md +2 -0
- package/dist/llms/Badge.md +2 -0
- package/dist/llms/ButtonGroup.md +2 -0
- package/dist/llms/Card.md +2 -0
- package/dist/llms/CodeBlock.md +2 -0
- package/dist/llms/CopyButton.md +2 -0
- package/dist/llms/DataGrid.md +2 -0
- package/dist/llms/Dialog.md +1 -1
- package/dist/llms/Drawer.md +1 -1
- package/dist/llms/Fieldset.md +2 -0
- package/dist/llms/FileUpload.md +1 -1
- package/dist/llms/Indicator.md +2 -0
- package/dist/llms/InlineEdit.md +1 -1
- package/dist/llms/Input.md +2 -0
- package/dist/llms/List.md +2 -0
- package/dist/llms/OverflowList.md +1 -1
- package/dist/llms/PageHeader.md +30 -0
- package/dist/llms/Pagination.md +2 -0
- package/dist/llms/Popover.md +1 -1
- package/dist/llms/QueryBuilder.md +2 -0
- package/dist/llms/Radio.md +2 -0
- package/dist/llms/RadioGroup.md +2 -0
- package/dist/llms/Result.md +2 -0
- package/dist/llms/SegmentedControl.md +1 -1
- package/dist/llms/Spinner.md +1 -1
- package/dist/llms/SplitButton.md +2 -0
- package/dist/llms/Splitter.md +1 -1
- package/dist/llms/Stats.md +1 -1
- package/dist/llms/Stepper.md +2 -0
- package/dist/llms/Table.md +2 -0
- package/dist/llms/Text.md +2 -0
- package/dist/llms-full.txt +53 -32
- package/dist/llms.txt +34 -32
- package/dist/locales/en/common.json +2 -1
- package/dist/locales/en/components.json +3 -1
- package/dist/locales/ja/common.json +2 -1
- package/dist/locales/ja/components.json +3 -1
- package/dist/locales/pt/common.json +2 -1
- package/dist/locales/pt/components.json +3 -1
- package/dist/styles.css +1 -1
- package/dist/typography.cjs +1 -1
- package/dist/typography.js +5 -5
- package/dist/wimui.umd.css +1 -1
- package/dist/wimui.umd.js +5 -5
- package/package.json +6 -6
package/dist/llms/Dialog.md
CHANGED
package/dist/llms/Drawer.md
CHANGED
package/dist/llms/Fieldset.md
CHANGED
package/dist/llms/FileUpload.md
CHANGED
package/dist/llms/Indicator.md
CHANGED
package/dist/llms/InlineEdit.md
CHANGED
package/dist/llms/Input.md
CHANGED
package/dist/llms/List.md
CHANGED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# PageHeader — wimui
|
|
2
|
+
|
|
3
|
+
> Head of a page: breadcrumb, title (always h1), status, description, actions and tabs in a fixed order and spacing.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { PageHeader } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `title: React.ReactNode` (required) — The page title. Always rendered as the page's `h1` at one fixed size; a long title wraps instead of being cut.
|
|
15
|
+
- `breadcrumb: React.ReactNode` — Breadcrumb shown above the title (usually a `Breadcrumb`).
|
|
16
|
+
- `status: React.ReactNode` — A short status next to the title, such as a `Badge`.
|
|
17
|
+
- `description: React.ReactNode` — One or two lines under the title that say what is on the page.
|
|
18
|
+
- `actions: React.ReactNode` — Page actions, such as `Button`s. They sit to the right of the title and move to their own line under it when the header is too narrow.
|
|
19
|
+
- `tabs: React.ReactNode` — Navigation between the page's views, such as `TabNavigation`, at the bottom.
|
|
20
|
+
|
|
21
|
+
## Design tokens it reads
|
|
22
|
+
|
|
23
|
+
`--wim-color-text-secondary`, `--wim-font-size-sm`, `--wim-spacing-2xs`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xs`, `--wim-width-md`
|
|
24
|
+
|
|
25
|
+
## Parts (data-part)
|
|
26
|
+
|
|
27
|
+
Style an inner element from your own CSS written outside any `@layer` (it wins over the component layer): `[data-part="actions"]`, `[data-part="breadcrumb"]`, `[data-part="description"]`, `[data-part="status"]`, `[data-part="tabs"]`, `[data-part="title"]`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
package/dist/llms/Pagination.md
CHANGED
package/dist/llms/Popover.md
CHANGED
package/dist/llms/Radio.md
CHANGED
package/dist/llms/RadioGroup.md
CHANGED
package/dist/llms/Result.md
CHANGED
package/dist/llms/Spinner.md
CHANGED
package/dist/llms/SplitButton.md
CHANGED
package/dist/llms/Splitter.md
CHANGED
package/dist/llms/Stats.md
CHANGED
package/dist/llms/Stepper.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
> Visual sequence steps
|
|
4
4
|
|
|
5
|
+
Also known as: Progress Indicator
|
|
6
|
+
|
|
5
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.
|
|
6
8
|
|
|
7
9
|
## Import
|
package/dist/llms/Table.md
CHANGED
package/dist/llms/Text.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.77.0 — a React 19 component library: 233 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
|
|
|
@@ -622,7 +622,7 @@ export function RenameWorkspace() {
|
|
|
622
622
|
|
|
623
623
|
### layout — `import { … } from "wimui/layout"`
|
|
624
624
|
|
|
625
|
-
- **AppShell** — Basic application shell layout
|
|
625
|
+
- **AppShell** — Basic application shell layout (aka UI Shell)
|
|
626
626
|
- `header: React.ReactNode` — Header component
|
|
627
627
|
- `sidebar: React.ReactNode` — Sidebar component
|
|
628
628
|
- `footer: React.ReactNode` — Footer component
|
|
@@ -813,7 +813,7 @@ of pixels. Prefer the token so the gap follows the theme.
|
|
|
813
813
|
- `defaultMenuOpen: boolean` = false — Initial open state of the mobile menu (uncontrolled)
|
|
814
814
|
- `isMenuOpen: boolean` — Open state of the mobile menu (controlled)
|
|
815
815
|
- `onMenuOpenChange: (isOpen: boolean) => void` — Callback when the mobile menu open state changes
|
|
816
|
-
- **OverflowList** — Lays out items in one row and folds the ones that do not fit into a "+N" indicator. (aka Overflow)
|
|
816
|
+
- **OverflowList** — Lays out items in one row and folds the ones that do not fit into a "+N" indicator. (aka Overflow, Overflow Handler)
|
|
817
817
|
- `items: T[]` (required) — Items to lay out in a single row, in reading order.
|
|
818
818
|
- `renderItem: (item: T, index: number) => React.ReactNode` (required) — Renders one item. Return a single element: each top-level element is measured as one item.
|
|
819
819
|
- `renderOverflow: (hiddenItems: T[]) => React.ReactNode` (required) — Renders the overflow indicator from the items that did not fit (for example a "+N" button
|
|
@@ -837,6 +837,15 @@ elements. Without it, the row is a `div`, which a list may not contain.
|
|
|
837
837
|
- `asChild: boolean` = false — If true, the list will be rendered as its child, merging its props onto that child.
|
|
838
838
|
- `children: React.ReactNode` — The element that becomes the root (in place of `div`) when `asChild` is set. The items are
|
|
839
839
|
rendered inside it. Ignored without `asChild`.
|
|
840
|
+
- **PageHeader** — Head of a page: breadcrumb, title (always h1), status, description, actions and tabs in a fixed order and spacing.
|
|
841
|
+
- `title: React.ReactNode` (required) — The page title. Always rendered as the page's `h1` at one fixed size; a
|
|
842
|
+
long title wraps instead of being cut.
|
|
843
|
+
- `breadcrumb: React.ReactNode` — Breadcrumb shown above the title (usually a `Breadcrumb`).
|
|
844
|
+
- `status: React.ReactNode` — A short status next to the title, such as a `Badge`.
|
|
845
|
+
- `description: React.ReactNode` — One or two lines under the title that say what is on the page.
|
|
846
|
+
- `actions: React.ReactNode` — Page actions, such as `Button`s. They sit to the right of the title and
|
|
847
|
+
move to their own line under it when the header is too narrow.
|
|
848
|
+
- `tabs: React.ReactNode` — Navigation between the page's views, such as `TabNavigation`, at the bottom.
|
|
840
849
|
- **ScrollArea** — A custom scrollbar component that provides high-performance, cross-browser consistent themes while maintaining a native-like feel.
|
|
841
850
|
- `text: React.ReactNode` — Content to display (alternative to children)
|
|
842
851
|
- `children: React.ReactNode` — Content to display
|
|
@@ -881,7 +890,7 @@ number of pixels. Prefer the token so the gap follows the theme.
|
|
|
881
890
|
@default "2xl"
|
|
882
891
|
- `verticalSpacing: number | string` — Vertical spacing between rows (defaults to `spacing`)
|
|
883
892
|
- `minChildWidth: number | string` — Minimum width of each child; columns wrap automatically to fit
|
|
884
|
-
- **Splitter** — Split and resize panels (aka Resizable, Resizable Panels, Split Pane)
|
|
893
|
+
- **Splitter** — Split and resize panels (aka Resizable, Resizable Panels, Split Pane, Resizer)
|
|
885
894
|
- `orientation: "horizontal" | "vertical"` = "horizontal" — The orientation of the splitter.
|
|
886
895
|
- `children: React.ReactNode` (required) — The components to render within the splitter. Usually a combination of `Splitter.Panel` and `Splitter.Handle`.
|
|
887
896
|
- **Stack** — Vertical/Horizontal alignment
|
|
@@ -979,7 +988,7 @@ Useful for using the button styles with Link components (e.g. from React Router
|
|
|
979
988
|
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
980
989
|
- `styles: { root?: string; loader?: string; icon?: string; }` — Custom styles for internal parts
|
|
981
990
|
- `className: string` — Additional class names
|
|
982
|
-
- **ButtonGroup** — Group of buttons
|
|
991
|
+
- **ButtonGroup** — Group of buttons (aka Button Set, Action Set)
|
|
983
992
|
- `children: React.ReactNode` (required) — Buttons to group
|
|
984
993
|
- `gap: string` = "8px" — Gap between buttons (ignored when joined)
|
|
985
994
|
- `className: string` — Additional class names
|
|
@@ -1115,7 +1124,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1115
1124
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1116
1125
|
- `id: string` — Unique ID for the component
|
|
1117
1126
|
- `labels: { noResults?: React.ReactNode; }` = {} — Labels for internationalization
|
|
1118
|
-
- **CopyButton** — Copy to clipboard
|
|
1127
|
+
- **CopyButton** — Copy to clipboard (aka Copy)
|
|
1119
1128
|
- `value: string` (required) — Text copied to the clipboard
|
|
1120
1129
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
1121
1130
|
- `className: string` — Additional class names
|
|
@@ -1232,7 +1241,7 @@ them. Leave it undefined to let the area track its own selection.
|
|
|
1232
1241
|
- `content: string` (required) — Error message text
|
|
1233
1242
|
- `className: string` — Additional class names
|
|
1234
1243
|
- `id: string` — ID of the error message element
|
|
1235
|
-
- **Fieldset** — Form grouping
|
|
1244
|
+
- **Fieldset** — Form grouping (aka Form Group)
|
|
1236
1245
|
- `children: React.ReactNode` (required) — Form elements to group
|
|
1237
1246
|
- `disabled: boolean` = false — Whether all contained form elements are disabled
|
|
1238
1247
|
- `variant: "default" | "full-width" | "plain"` = "default" — Visual variant of the fieldset.
|
|
@@ -1254,7 +1263,7 @@ still do their job for assistive technology.
|
|
|
1254
1263
|
- `htmlFor: string` — ID of the element the label points to
|
|
1255
1264
|
- `errorId: string` — ID of the error message element
|
|
1256
1265
|
- `styles: { root?: string; labelWrapper?: string; label?: string; content?: string; error?: string; }` — Custom styles for internal parts
|
|
1257
|
-
- **FileUpload** — File selection (aka Upload, File Input)
|
|
1266
|
+
- **FileUpload** — File selection (aka Upload, File Input, File Uploader)
|
|
1258
1267
|
- `label: React.ReactNode` — Field label
|
|
1259
1268
|
- `buttonLabel: React.ReactNode` — Label of the file selection button
|
|
1260
1269
|
- `noFileLabel: React.ReactNode` — Text shown when no file is selected
|
|
@@ -1338,7 +1347,7 @@ resolution of the source image; without a bound a large photo produces a large d
|
|
|
1338
1347
|
@default 0.92
|
|
1339
1348
|
- `crossOrigin: "anonymous" | "use-credentials"` — CORS mode used to load the image. Needed to crop an image served from another origin;
|
|
1340
1349
|
the server must send matching CORS headers or the image will not load at all.
|
|
1341
|
-
- **InlineEdit** — A component that allows users to switch between a view-only mode and an editable mode in-place. (aka Editable Text)
|
|
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)
|
|
1342
1351
|
- `value: string` — Current text (controlled)
|
|
1343
1352
|
- `defaultValue: string` — Initial text (uncontrolled)
|
|
1344
1353
|
- `onChange: (value: string) => void` — Callback when the text changes while editing
|
|
@@ -1349,7 +1358,7 @@ the server must send matching CORS headers or the image will not load at all.
|
|
|
1349
1358
|
- `disabled: boolean` = false — Whether editing is disabled
|
|
1350
1359
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1351
1360
|
- `label: React.ReactNode` — Accessible label for the text and edit button
|
|
1352
|
-
- **Input** — Single-line input fields for text, numbers, or emails
|
|
1361
|
+
- **Input** — Single-line input fields for text, numbers, or emails (aka Text Input)
|
|
1353
1362
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1354
1363
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1355
1364
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1551,7 +1560,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1551
1560
|
- `aria-label: string` — Accessible name for the phone number input when no visible `label` is provided.
|
|
1552
1561
|
- `aria-labelledby: string` — ID of the element that labels the phone number input when no visible `label` is provided.
|
|
1553
1562
|
- `aria-describedby: string` — ID of the element that describes the phone number input. Announced together with the error message.
|
|
1554
|
-
- **QueryBuilder** — Visual builder for constructing complex search queries.
|
|
1563
|
+
- **QueryBuilder** — Visual builder for constructing complex search queries. (aka Condition Builder)
|
|
1555
1564
|
- `fields: QueryField[]` (required) — Field definitions
|
|
1556
1565
|
- `query: QueryGroup` — Current query state (controlled)
|
|
1557
1566
|
- `defaultQuery: QueryGroup` — Default query state (uncontrolled)
|
|
@@ -1563,11 +1572,11 @@ so the unit does not have to be repeated in the label.
|
|
|
1563
1572
|
- `aria-label: string` — Accessible name for the query builder region. Takes precedence over `labels.regionAriaLabel`.
|
|
1564
1573
|
- `aria-labelledby: string` — ID of the element that labels the query builder region. Takes precedence over `aria-label`.
|
|
1565
1574
|
- `aria-describedby: string` — ID of the element that describes the query builder region.
|
|
1566
|
-
- **Radio** — Single choice
|
|
1575
|
+
- **Radio** — Single choice (aka Radio Button)
|
|
1567
1576
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1568
1577
|
- `children: React.ReactNode` — Label content rendered next to the radio
|
|
1569
1578
|
- `error: boolean` = false — Whether to display as an error state (aria-invalid is not supported on the radio role, so it is applied on the RadioGroup side)
|
|
1570
|
-
- **RadioGroup** — Shared state radio buttons
|
|
1579
|
+
- **RadioGroup** — Shared state radio buttons (aka Radio Button Group)
|
|
1571
1580
|
- `options: Option[]` (required) — List of radio options
|
|
1572
1581
|
- `value: string` — Selected value (controlled)
|
|
1573
1582
|
- `defaultValue: string` — Initially selected value (uncontrolled)
|
|
@@ -1695,7 +1704,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1695
1704
|
so the unit does not have to be repeated in the label.
|
|
1696
1705
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1697
1706
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1698
|
-
- **SegmentedControl** — Button-style controls for switching between a small set of mutually exclusive options (aka Segmented Buttons, Segmented Picker)
|
|
1707
|
+
- **SegmentedControl** — Button-style controls for switching between a small set of mutually exclusive options (aka Segmented Buttons, Segmented Picker, Content Switcher)
|
|
1699
1708
|
- `options: Option[]` (required) — List of segment options
|
|
1700
1709
|
- `value: string` (required) — Selected value
|
|
1701
1710
|
- `onChange: (value: string) => void` (required) — Callback when the selected value changes
|
|
@@ -1787,7 +1796,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1787
1796
|
- `onChange: (value: string) => void` — Callback when the value changes
|
|
1788
1797
|
- `defaultValue: string` = "" — Initial value (uncontrolled)
|
|
1789
1798
|
- `maxLength: number` — Maximum number of characters
|
|
1790
|
-
- **SplitButton** — SplitButton description.
|
|
1799
|
+
- **SplitButton** — SplitButton description. (aka Combo Button)
|
|
1791
1800
|
- `children: React.ReactNode` — Text of the main action.
|
|
1792
1801
|
- `onClick: React.MouseEventHandler<HTMLButtonElement>` — Called when the main action is pressed.
|
|
1793
1802
|
- `actions: SplitButtonAction[]` (required) — Secondary actions listed behind the toggle.
|
|
@@ -1991,7 +2000,7 @@ When a function is passed, it is called as (error, errorInfo, reset) => ReactNod
|
|
|
1991
2000
|
- `onReset: () => void` — Called when the error is reset.
|
|
1992
2001
|
- `labels: { title?: string; retry?: string; showDetails?: string; hideDetails?: string; }` — Labels for manual translation overrides.
|
|
1993
2002
|
- `children: ReactNode` (required) — Content the boundary protects.
|
|
1994
|
-
- **Indicator** — Small status dots
|
|
2003
|
+
- **Indicator** — Small status dots (aka Badge Indicator)
|
|
1995
2004
|
- `children: React.ReactNode` — Element the indicator dot is attached to. If omitted, only the dot is rendered.
|
|
1996
2005
|
- `color: T | (string & {})` = "primary" — Color of the dot. Accepts a design token color name or any CSS color value.
|
|
1997
2006
|
@default "primary"
|
|
@@ -2093,7 +2102,7 @@ type therefore requires one of `label` / `aria-label` / `aria-labelledby`.
|
|
|
2093
2102
|
@default false
|
|
2094
2103
|
- `indeterminate: boolean` = false — If true, shows an indeterminate animation instead of a value.
|
|
2095
2104
|
@default false
|
|
2096
|
-
- **Result** — Task status indicator
|
|
2105
|
+
- **Result** — Task status indicator (aka Full Page Error)
|
|
2097
2106
|
- `intent: "default" | "success" | "danger" | "info" | "warning"` = "default" — Semantic intent — determines the icon and color. `default` draws no icon unless `icon` is passed.
|
|
2098
2107
|
@default "default"
|
|
2099
2108
|
- `status: "404" | "403" | "500"` — HTTP error status — adds a status-specific CSS class and shows a neutral icon.
|
|
@@ -2147,7 +2156,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2147
2156
|
- `onAction: () => void` — Called when the action button is clicked
|
|
2148
2157
|
- `onClose: () => void` — Called when the snackbar is closed
|
|
2149
2158
|
- `className: string` — Additional CSS class name
|
|
2150
|
-
- **Spinner** — A rotating icon indicating background activity or data fetching (aka Activity Indicator)
|
|
2159
|
+
- **Spinner** — A rotating icon indicating background activity or data fetching (aka Activity Indicator, Inline Loading, Loading)
|
|
2151
2160
|
- `size: "sm" | "md" | "lg" | "xl"` = "md" — Size of the spinner.
|
|
2152
2161
|
@default "md"
|
|
2153
2162
|
- `color: "currentColor" | WimColor` = "primary" — Color of the spinner. Accepts a design token color name or "currentColor".
|
|
@@ -2266,7 +2275,7 @@ Useful for using the link styles with Link components from React Router or Next.
|
|
|
2266
2275
|
- `styles: { root?: string; label?: string; inner?: string; externalIcon?: string; }` — Custom styles for internal parts
|
|
2267
2276
|
- **Menubar** — Desktop-style application menu bar with floating File / Edit / View submenus.
|
|
2268
2277
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
2269
|
-
- **Pagination** — Multi-page navigation
|
|
2278
|
+
- **Pagination** — Multi-page navigation (aka Pagination Nav)
|
|
2270
2279
|
- `total: number` (required) — Total number of items
|
|
2271
2280
|
- `pageSize: number` = 10 — Number of items per page
|
|
2272
2281
|
- `current: number` = 1 — Current page number (1-indexed)
|
|
@@ -2307,7 +2316,7 @@ near the right edge pushes the page into a horizontal scroll. Anchor a
|
|
|
2307
2316
|
- `aria-label: string` — Accessible name for the trigger button.
|
|
2308
2317
|
Lands on the inner `FloatButton`, not on the wrapper `div`.
|
|
2309
2318
|
Defaults to a translated "Open menu" / "Close menu" (en / ja / pt), following the open state.
|
|
2310
|
-
- **Stepper** — Visual sequence steps
|
|
2319
|
+
- **Stepper** — Visual sequence steps (aka Progress Indicator)
|
|
2311
2320
|
- ⚠️ 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.
|
|
2312
2321
|
- `steps: Step[]` = [] — Array of step configurations
|
|
2313
2322
|
- `current: number` = 0 — Index of the current active step (0-indexed)
|
|
@@ -2357,7 +2366,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2357
2366
|
- `children: React.ReactNode` (required) — Accordion.Item elements
|
|
2358
2367
|
- `id: string` — Unique ID for the component
|
|
2359
2368
|
- `asChild: boolean` — Whether to render as a child element.
|
|
2360
|
-
- **Avatar** — Profile initials/pics
|
|
2369
|
+
- **Avatar** — Profile initials/pics (aka User Avatar)
|
|
2361
2370
|
- `src: string` — Image source URL
|
|
2362
2371
|
- `alt: string` = "" — Alternative text for the image
|
|
2363
2372
|
- `initials: string` — Initials shown as a fallback when no image is available
|
|
@@ -2375,7 +2384,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2375
2384
|
lists the hidden people by name.
|
|
2376
2385
|
@default "count"
|
|
2377
2386
|
- `className: string` — Additional class names
|
|
2378
|
-
- **Badge** — Indicators or counts
|
|
2387
|
+
- **Badge** — Indicators or counts (aka Icon Indicator)
|
|
2379
2388
|
- `asChild: boolean` — If true, the badge will be rendered as its child, merging its props onto that child.
|
|
2380
2389
|
- `children: React.ReactNode` — Content to display
|
|
2381
2390
|
- `content: React.ReactNode` — Content to display (alternative to children)
|
|
@@ -2430,7 +2439,7 @@ starts on Saturday, or a browser without `Intl.Locale` week info, falls back to
|
|
|
2430
2439
|
- `tooltipFormatter: (date: string, count: number) => React.ReactNode` — Custom tooltip formatter.
|
|
2431
2440
|
- `asChild: boolean` = false — Whether to render as a child component.
|
|
2432
2441
|
- `children: React.ReactNode` — Content to render inside.
|
|
2433
|
-
- **Card** — Information containers
|
|
2442
|
+
- **Card** — Information containers (aka Tile)
|
|
2434
2443
|
- `asChild: boolean` = false — If true, the card will be rendered as its child, merging its props onto that child.
|
|
2435
2444
|
- `variant: "elevated" | "outline" | "flat" | "glass"` = "outline" — Visual style variant of the card
|
|
2436
2445
|
- `interactive: boolean` = false — Whether the card is clickable: shows hover and press feedback and a pointer cursor
|
|
@@ -2523,7 +2532,7 @@ target is already in the past). Not called when baseDate is set.
|
|
|
2523
2532
|
- `completedContent: React.ReactNode` — Content shown instead of the zeroed digits once the countdown ends.
|
|
2524
2533
|
- `fallback: React.ReactNode` — Content shown when the target cannot be parsed.
|
|
2525
2534
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
2526
|
-
- **DataGrid** — Advanced data table and manipulation
|
|
2535
|
+
- **DataGrid** — Advanced data table and manipulation (aka Data Table)
|
|
2527
2536
|
- `columns: DataGridColumn<T>[]` (required) — Column definitions
|
|
2528
2537
|
- `data: T[]` (required) — Row data
|
|
2529
2538
|
- `rowKey: string | ((record: T) => string)` = "id" — Row key: a field name or a function that derives the key from a record
|
|
@@ -2611,7 +2620,7 @@ Without it, pointer devices show the move button in the card's corner on hover o
|
|
|
2611
2620
|
- `unit: string` — Label for the score unit
|
|
2612
2621
|
- `size: "sm" | "md" | "lg"` = "md" — Size
|
|
2613
2622
|
- `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)
|
|
2614
|
-
- **List** — Structurally organized items in bullet points or numbered formats
|
|
2623
|
+
- **List** — Structurally organized items in bullet points or numbered formats (aka Contained List, Ordered List, Unordered List)
|
|
2615
2624
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2616
2625
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the list items
|
|
2617
2626
|
- `spacing: "tight" | "normal" | "loose"` = "normal" — Spacing between items
|
|
@@ -2778,7 +2787,7 @@ focus moves to the first focusable element after the bar (with `DataGrid`, the g
|
|
|
2778
2787
|
- `asChild: boolean` = false — If true, the component will be rendered as its child.
|
|
2779
2788
|
- `onSortEnd: (oldIndex: number, newIndex: number) => void` — Callback called when reordering is completed.
|
|
2780
2789
|
- `disabled: boolean` = false — Whether the entire list is disabled.
|
|
2781
|
-
- **Stats** — A component to highlight key performance indicators and metrics (aka Statistic, Stat)
|
|
2790
|
+
- **Stats** — A component to highlight key performance indicators and metrics (aka Statistic, Stat, Big Number)
|
|
2782
2791
|
- `variant: React.ComponentProps<typeof Card>["variant"]` = "outline" — Visual style variant of the card
|
|
2783
2792
|
- `asChild: boolean` = false — If true, the card will be rendered as its child, merging its props onto that child.
|
|
2784
2793
|
- `interactive: boolean` = false — Whether the card is clickable: shows hover and press feedback and a pointer cursor
|
|
@@ -2809,7 +2818,7 @@ or by keyboard focus on its actions, closes the others.
|
|
|
2809
2818
|
- `fullSwipe: "left" | "right" | "both"` — Sides where swiping all the way across runs the outermost action without a tap
|
|
2810
2819
|
(`leftActions[0]` / the last of `rightActions`), as in iOS Mail. Off by default so a
|
|
2811
2820
|
destructive action is never triggered by momentum; the action stays available as a button.
|
|
2812
|
-
- **Table** — Rows and columns for displaying structured data efficiently
|
|
2821
|
+
- **Table** — Rows and columns for displaying structured data efficiently (aka Structured List)
|
|
2813
2822
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2814
2823
|
- `striped: boolean` = false — Whether to show striped (zebra) rows
|
|
2815
2824
|
- `bordered: boolean` = false — Whether to show borders between cells
|
|
@@ -2906,7 +2915,7 @@ anything is measured; long text is truncated and read in full by assistive techn
|
|
|
2906
2915
|
- `className: string` — Additional CSS class name for the container.
|
|
2907
2916
|
- `disabled: boolean` = false — Disable the context menu
|
|
2908
2917
|
- `asChild: boolean` = false — If true, merge trigger props onto the child element.
|
|
2909
|
-
- **Dialog** — Focused task windows (aka Modal, Modal Dialog)
|
|
2918
|
+
- **Dialog** — Focused task windows (aka Modal, Modal Dialog, Composed Modal)
|
|
2910
2919
|
- `children: React.ReactNode` (required) — Dialog parts (Dialog.Trigger, Dialog.Content, etc.).
|
|
2911
2920
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2912
2921
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the dialog is opened or closed.
|
|
@@ -2920,7 +2929,7 @@ interrupts the user and needs a response before they can continue, such as
|
|
|
2920
2929
|
confirming a destructive action. An alert dialog does not close when the
|
|
2921
2930
|
overlay is clicked unless closeOnOverlayClick is set; Escape still closes it.
|
|
2922
2931
|
@default "dialog"
|
|
2923
|
-
- **Drawer** — Slide-out detail panels (aka Navigation Drawer, Overlay Drawer)
|
|
2932
|
+
- **Drawer** — Slide-out detail panels (aka Navigation Drawer, Overlay Drawer, Side Panel)
|
|
2924
2933
|
- `children: React.ReactNode` (required) — Drawer parts (DrawerTrigger, DrawerContent, etc.).
|
|
2925
2934
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2926
2935
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the drawer is opened or closed.
|
|
@@ -2977,7 +2986,7 @@ is marked.
|
|
|
2977
2986
|
- `children: ReactNode` (required) — The target element which the Popconfirm will be attached to
|
|
2978
2987
|
- `icon: ReactNode` — Customize the icon
|
|
2979
2988
|
- `disabled: boolean` = false — Whether to show the popconfirm
|
|
2980
|
-
- **Popover** — Contextual overlay (aka Info Label, Info Button)
|
|
2989
|
+
- **Popover** — Contextual overlay (aka Info Label, Info Button, Toggletip)
|
|
2981
2990
|
- `children: ReactNode` (required) — Popover parts (PopoverTrigger, PopoverContent, etc.).
|
|
2982
2991
|
- `className: string` — Additional CSS class name for the container.
|
|
2983
2992
|
- `defaultOpen: boolean` = false — If true, the popover component will manage its own open state.
|
|
@@ -3079,7 +3088,7 @@ Defaults to the localized `form.optional` string.
|
|
|
3079
3088
|
@default t("spoiler.show_more")
|
|
3080
3089
|
- `hideLabel: React.ReactNode` — Label of the toggle while expanded.
|
|
3081
3090
|
@default t("spoiler.show_less")
|
|
3082
|
-
- **Text** — Has appropriate line-height and spacing to ensure readability of long text.
|
|
3091
|
+
- **Text** — Has appropriate line-height and spacing to ensure readability of long text. (aka Truncated Text)
|
|
3083
3092
|
- `asChild: boolean` = false — If true, the text will be rendered as its child, merging its props onto that child.
|
|
3084
3093
|
- `size: "xs" | "sm" | "md" | "lg" | "xl"` = "md" — Font size of the text.
|
|
3085
3094
|
@default "md"
|
|
@@ -3490,6 +3499,18 @@ enough on its own.
|
|
|
3490
3499
|
- `size: "sm" | "md" | "lg"` = "md" — Size variant
|
|
3491
3500
|
- `showLabel: boolean` = true — Whether to show the text label next to the indicator
|
|
3492
3501
|
- `className: string` — Additional CSS class
|
|
3502
|
+
- **AILabel** — Marks a value or a block as produced by AI. Pressing the mark opens an explanation of what the AI did.
|
|
3503
|
+
- `children: ReactNode` (required) — What the AI did, shown when the label is pressed — for example which model
|
|
3504
|
+
produced the value, from what, and how to check or replace it.
|
|
3505
|
+
- `title: ReactNode` — Heading of the explanation. Defaults to the localized "AI-generated".
|
|
3506
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the mark. `sm` fits inside a field or a table cell; `md` sits next
|
|
3507
|
+
to a heading or in the corner of a card.
|
|
3508
|
+
@default "md"
|
|
3509
|
+
- `placement: "bottom" | "bottom-end" | "bottom-start" | "left" | "left-end" | "left-start" | "right" | "right-end" | "right-start" | "top" | "top-end" | "top-start"` = "bottom-start" — Preferred placement of the explanation.
|
|
3510
|
+
@default "bottom-start"
|
|
3511
|
+
- `defaultOpen: boolean` — Opens the explanation on the first render (uncontrolled).
|
|
3512
|
+
- `open: boolean` — Controls whether the explanation is open.
|
|
3513
|
+
- `onOpenChange: (open: boolean) => void` — Called when the explanation opens or closes.
|
|
3493
3514
|
- **AIResponseFeedback** — Thumbs-up/down feedback controls and regenerate button for AI responses.
|
|
3494
3515
|
- `feedback: ("positive" | "negative") | null` — Currently selected feedback value (controlled)
|
|
3495
3516
|
- `defaultFeedback: ("positive" | "negative") | null` = null — Default feedback value (uncontrolled)
|
|
@@ -3506,7 +3527,7 @@ enough on its own.
|
|
|
3506
3527
|
- `showFullscreenToggle: boolean` = false — Whether to show a full-screen toggle (default: false)
|
|
3507
3528
|
- `className: string` — Additional CSS class
|
|
3508
3529
|
- **ChatUI** — A comprehensive set of components for building chat interfaces with support for messages, avatars, timestamps, and interactive input.
|
|
3509
|
-
- **CodeBlock** — Syntax-highlighted code block with copy button, line numbers, and collapsible overflow.
|
|
3530
|
+
- **CodeBlock** — Syntax-highlighted code block with copy button, line numbers, and collapsible overflow. (aka Code Snippet)
|
|
3510
3531
|
- `code: string` (required) — The code string to display
|
|
3511
3532
|
- `language: string` — Programming language label shown in the header (e.g. "tsx", "bash")
|
|
3512
3533
|
- `filename: string` — Optional filename shown in the header instead of the language label
|