wimui 0.76.0 → 0.76.3
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/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/form/Combobox/Combobox.cjs +1 -1
- package/dist/components/form/Combobox/Combobox.js +1 -0
- package/dist/components/form/RangeSlider/RangeSlider.cjs +1 -1
- package/dist/components/form/RangeSlider/RangeSlider.js +113 -111
- package/dist/components/form/Slider/Slider.cjs +1 -1
- package/dist/components/form/Slider/Slider.js +77 -75
- package/dist/components/overlay/Dropdown/Dropdown.cjs +1 -1
- package/dist/components/overlay/Dropdown/Dropdown.js +99 -98
- package/dist/i18n/generated/common.d.ts +1 -1
- 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/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 +32 -32
- package/dist/llms.txt +32 -32
- package/dist/locales/en/common.json +2 -1
- package/dist/locales/ja/common.json +2 -1
- package/dist/locales/pt/common.json +2 -1
- package/dist/utilities/slider-utils.cjs +1 -1
- package/dist/utilities/slider-utils.d.ts +5 -0
- package/dist/utilities/slider-utils.js +2 -2
- package/dist/wimui.umd.js +5 -5
- package/package.json +2 -2
package/dist/llms/AppShell.md
CHANGED
package/dist/llms/Avatar.md
CHANGED
package/dist/llms/Badge.md
CHANGED
package/dist/llms/ButtonGroup.md
CHANGED
package/dist/llms/Card.md
CHANGED
package/dist/llms/CodeBlock.md
CHANGED
package/dist/llms/CopyButton.md
CHANGED
package/dist/llms/DataGrid.md
CHANGED
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
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.76.
|
|
7
|
+
**wimui** v0.76.3 — a React 19 component library: 231 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
|
|
@@ -881,7 +881,7 @@ number of pixels. Prefer the token so the gap follows the theme.
|
|
|
881
881
|
@default "2xl"
|
|
882
882
|
- `verticalSpacing: number | string` — Vertical spacing between rows (defaults to `spacing`)
|
|
883
883
|
- `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)
|
|
884
|
+
- **Splitter** — Split and resize panels (aka Resizable, Resizable Panels, Split Pane, Resizer)
|
|
885
885
|
- `orientation: "horizontal" | "vertical"` = "horizontal" — The orientation of the splitter.
|
|
886
886
|
- `children: React.ReactNode` (required) — The components to render within the splitter. Usually a combination of `Splitter.Panel` and `Splitter.Handle`.
|
|
887
887
|
- **Stack** — Vertical/Horizontal alignment
|
|
@@ -979,7 +979,7 @@ Useful for using the button styles with Link components (e.g. from React Router
|
|
|
979
979
|
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
980
980
|
- `styles: { root?: string; loader?: string; icon?: string; }` — Custom styles for internal parts
|
|
981
981
|
- `className: string` — Additional class names
|
|
982
|
-
- **ButtonGroup** — Group of buttons
|
|
982
|
+
- **ButtonGroup** — Group of buttons (aka Button Set, Action Set)
|
|
983
983
|
- `children: React.ReactNode` (required) — Buttons to group
|
|
984
984
|
- `gap: string` = "8px" — Gap between buttons (ignored when joined)
|
|
985
985
|
- `className: string` — Additional class names
|
|
@@ -1115,7 +1115,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1115
1115
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1116
1116
|
- `id: string` — Unique ID for the component
|
|
1117
1117
|
- `labels: { noResults?: React.ReactNode; }` = {} — Labels for internationalization
|
|
1118
|
-
- **CopyButton** — Copy to clipboard
|
|
1118
|
+
- **CopyButton** — Copy to clipboard (aka Copy)
|
|
1119
1119
|
- `value: string` (required) — Text copied to the clipboard
|
|
1120
1120
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
1121
1121
|
- `className: string` — Additional class names
|
|
@@ -1232,7 +1232,7 @@ them. Leave it undefined to let the area track its own selection.
|
|
|
1232
1232
|
- `content: string` (required) — Error message text
|
|
1233
1233
|
- `className: string` — Additional class names
|
|
1234
1234
|
- `id: string` — ID of the error message element
|
|
1235
|
-
- **Fieldset** — Form grouping
|
|
1235
|
+
- **Fieldset** — Form grouping (aka Form Group)
|
|
1236
1236
|
- `children: React.ReactNode` (required) — Form elements to group
|
|
1237
1237
|
- `disabled: boolean` = false — Whether all contained form elements are disabled
|
|
1238
1238
|
- `variant: "default" | "full-width" | "plain"` = "default" — Visual variant of the fieldset.
|
|
@@ -1254,7 +1254,7 @@ still do their job for assistive technology.
|
|
|
1254
1254
|
- `htmlFor: string` — ID of the element the label points to
|
|
1255
1255
|
- `errorId: string` — ID of the error message element
|
|
1256
1256
|
- `styles: { root?: string; labelWrapper?: string; label?: string; content?: string; error?: string; }` — Custom styles for internal parts
|
|
1257
|
-
- **FileUpload** — File selection (aka Upload, File Input)
|
|
1257
|
+
- **FileUpload** — File selection (aka Upload, File Input, File Uploader)
|
|
1258
1258
|
- `label: React.ReactNode` — Field label
|
|
1259
1259
|
- `buttonLabel: React.ReactNode` — Label of the file selection button
|
|
1260
1260
|
- `noFileLabel: React.ReactNode` — Text shown when no file is selected
|
|
@@ -1338,7 +1338,7 @@ resolution of the source image; without a bound a large photo produces a large d
|
|
|
1338
1338
|
@default 0.92
|
|
1339
1339
|
- `crossOrigin: "anonymous" | "use-credentials"` — CORS mode used to load the image. Needed to crop an image served from another origin;
|
|
1340
1340
|
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)
|
|
1341
|
+
- **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
1342
|
- `value: string` — Current text (controlled)
|
|
1343
1343
|
- `defaultValue: string` — Initial text (uncontrolled)
|
|
1344
1344
|
- `onChange: (value: string) => void` — Callback when the text changes while editing
|
|
@@ -1349,7 +1349,7 @@ the server must send matching CORS headers or the image will not load at all.
|
|
|
1349
1349
|
- `disabled: boolean` = false — Whether editing is disabled
|
|
1350
1350
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1351
1351
|
- `label: React.ReactNode` — Accessible label for the text and edit button
|
|
1352
|
-
- **Input** — Single-line input fields for text, numbers, or emails
|
|
1352
|
+
- **Input** — Single-line input fields for text, numbers, or emails (aka Text Input)
|
|
1353
1353
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1354
1354
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1355
1355
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1551,7 +1551,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1551
1551
|
- `aria-label: string` — Accessible name for the phone number input when no visible `label` is provided.
|
|
1552
1552
|
- `aria-labelledby: string` — ID of the element that labels the phone number input when no visible `label` is provided.
|
|
1553
1553
|
- `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.
|
|
1554
|
+
- **QueryBuilder** — Visual builder for constructing complex search queries. (aka Condition Builder)
|
|
1555
1555
|
- `fields: QueryField[]` (required) — Field definitions
|
|
1556
1556
|
- `query: QueryGroup` — Current query state (controlled)
|
|
1557
1557
|
- `defaultQuery: QueryGroup` — Default query state (uncontrolled)
|
|
@@ -1563,11 +1563,11 @@ so the unit does not have to be repeated in the label.
|
|
|
1563
1563
|
- `aria-label: string` — Accessible name for the query builder region. Takes precedence over `labels.regionAriaLabel`.
|
|
1564
1564
|
- `aria-labelledby: string` — ID of the element that labels the query builder region. Takes precedence over `aria-label`.
|
|
1565
1565
|
- `aria-describedby: string` — ID of the element that describes the query builder region.
|
|
1566
|
-
- **Radio** — Single choice
|
|
1566
|
+
- **Radio** — Single choice (aka Radio Button)
|
|
1567
1567
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1568
1568
|
- `children: React.ReactNode` — Label content rendered next to the radio
|
|
1569
1569
|
- `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
|
|
1570
|
+
- **RadioGroup** — Shared state radio buttons (aka Radio Button Group)
|
|
1571
1571
|
- `options: Option[]` (required) — List of radio options
|
|
1572
1572
|
- `value: string` — Selected value (controlled)
|
|
1573
1573
|
- `defaultValue: string` — Initially selected value (uncontrolled)
|
|
@@ -1695,7 +1695,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1695
1695
|
so the unit does not have to be repeated in the label.
|
|
1696
1696
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1697
1697
|
- `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)
|
|
1698
|
+
- **SegmentedControl** — Button-style controls for switching between a small set of mutually exclusive options (aka Segmented Buttons, Segmented Picker, Content Switcher)
|
|
1699
1699
|
- `options: Option[]` (required) — List of segment options
|
|
1700
1700
|
- `value: string` (required) — Selected value
|
|
1701
1701
|
- `onChange: (value: string) => void` (required) — Callback when the selected value changes
|
|
@@ -1787,7 +1787,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1787
1787
|
- `onChange: (value: string) => void` — Callback when the value changes
|
|
1788
1788
|
- `defaultValue: string` = "" — Initial value (uncontrolled)
|
|
1789
1789
|
- `maxLength: number` — Maximum number of characters
|
|
1790
|
-
- **SplitButton** — SplitButton description.
|
|
1790
|
+
- **SplitButton** — SplitButton description. (aka Combo Button)
|
|
1791
1791
|
- `children: React.ReactNode` — Text of the main action.
|
|
1792
1792
|
- `onClick: React.MouseEventHandler<HTMLButtonElement>` — Called when the main action is pressed.
|
|
1793
1793
|
- `actions: SplitButtonAction[]` (required) — Secondary actions listed behind the toggle.
|
|
@@ -1991,7 +1991,7 @@ When a function is passed, it is called as (error, errorInfo, reset) => ReactNod
|
|
|
1991
1991
|
- `onReset: () => void` — Called when the error is reset.
|
|
1992
1992
|
- `labels: { title?: string; retry?: string; showDetails?: string; hideDetails?: string; }` — Labels for manual translation overrides.
|
|
1993
1993
|
- `children: ReactNode` (required) — Content the boundary protects.
|
|
1994
|
-
- **Indicator** — Small status dots
|
|
1994
|
+
- **Indicator** — Small status dots (aka Badge Indicator)
|
|
1995
1995
|
- `children: React.ReactNode` — Element the indicator dot is attached to. If omitted, only the dot is rendered.
|
|
1996
1996
|
- `color: T | (string & {})` = "primary" — Color of the dot. Accepts a design token color name or any CSS color value.
|
|
1997
1997
|
@default "primary"
|
|
@@ -2093,7 +2093,7 @@ type therefore requires one of `label` / `aria-label` / `aria-labelledby`.
|
|
|
2093
2093
|
@default false
|
|
2094
2094
|
- `indeterminate: boolean` = false — If true, shows an indeterminate animation instead of a value.
|
|
2095
2095
|
@default false
|
|
2096
|
-
- **Result** — Task status indicator
|
|
2096
|
+
- **Result** — Task status indicator (aka Full Page Error)
|
|
2097
2097
|
- `intent: "default" | "success" | "danger" | "info" | "warning"` = "default" — Semantic intent — determines the icon and color. `default` draws no icon unless `icon` is passed.
|
|
2098
2098
|
@default "default"
|
|
2099
2099
|
- `status: "404" | "403" | "500"` — HTTP error status — adds a status-specific CSS class and shows a neutral icon.
|
|
@@ -2147,7 +2147,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2147
2147
|
- `onAction: () => void` — Called when the action button is clicked
|
|
2148
2148
|
- `onClose: () => void` — Called when the snackbar is closed
|
|
2149
2149
|
- `className: string` — Additional CSS class name
|
|
2150
|
-
- **Spinner** — A rotating icon indicating background activity or data fetching (aka Activity Indicator)
|
|
2150
|
+
- **Spinner** — A rotating icon indicating background activity or data fetching (aka Activity Indicator, Inline Loading, Loading)
|
|
2151
2151
|
- `size: "sm" | "md" | "lg" | "xl"` = "md" — Size of the spinner.
|
|
2152
2152
|
@default "md"
|
|
2153
2153
|
- `color: "currentColor" | WimColor` = "primary" — Color of the spinner. Accepts a design token color name or "currentColor".
|
|
@@ -2266,7 +2266,7 @@ Useful for using the link styles with Link components from React Router or Next.
|
|
|
2266
2266
|
- `styles: { root?: string; label?: string; inner?: string; externalIcon?: string; }` — Custom styles for internal parts
|
|
2267
2267
|
- **Menubar** — Desktop-style application menu bar with floating File / Edit / View submenus.
|
|
2268
2268
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
2269
|
-
- **Pagination** — Multi-page navigation
|
|
2269
|
+
- **Pagination** — Multi-page navigation (aka Pagination Nav)
|
|
2270
2270
|
- `total: number` (required) — Total number of items
|
|
2271
2271
|
- `pageSize: number` = 10 — Number of items per page
|
|
2272
2272
|
- `current: number` = 1 — Current page number (1-indexed)
|
|
@@ -2307,7 +2307,7 @@ near the right edge pushes the page into a horizontal scroll. Anchor a
|
|
|
2307
2307
|
- `aria-label: string` — Accessible name for the trigger button.
|
|
2308
2308
|
Lands on the inner `FloatButton`, not on the wrapper `div`.
|
|
2309
2309
|
Defaults to a translated "Open menu" / "Close menu" (en / ja / pt), following the open state.
|
|
2310
|
-
- **Stepper** — Visual sequence steps
|
|
2310
|
+
- **Stepper** — Visual sequence steps (aka Progress Indicator)
|
|
2311
2311
|
- ⚠️ 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
2312
|
- `steps: Step[]` = [] — Array of step configurations
|
|
2313
2313
|
- `current: number` = 0 — Index of the current active step (0-indexed)
|
|
@@ -2357,7 +2357,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2357
2357
|
- `children: React.ReactNode` (required) — Accordion.Item elements
|
|
2358
2358
|
- `id: string` — Unique ID for the component
|
|
2359
2359
|
- `asChild: boolean` — Whether to render as a child element.
|
|
2360
|
-
- **Avatar** — Profile initials/pics
|
|
2360
|
+
- **Avatar** — Profile initials/pics (aka User Avatar)
|
|
2361
2361
|
- `src: string` — Image source URL
|
|
2362
2362
|
- `alt: string` = "" — Alternative text for the image
|
|
2363
2363
|
- `initials: string` — Initials shown as a fallback when no image is available
|
|
@@ -2375,7 +2375,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2375
2375
|
lists the hidden people by name.
|
|
2376
2376
|
@default "count"
|
|
2377
2377
|
- `className: string` — Additional class names
|
|
2378
|
-
- **Badge** — Indicators or counts
|
|
2378
|
+
- **Badge** — Indicators or counts (aka Icon Indicator)
|
|
2379
2379
|
- `asChild: boolean` — If true, the badge will be rendered as its child, merging its props onto that child.
|
|
2380
2380
|
- `children: React.ReactNode` — Content to display
|
|
2381
2381
|
- `content: React.ReactNode` — Content to display (alternative to children)
|
|
@@ -2430,7 +2430,7 @@ starts on Saturday, or a browser without `Intl.Locale` week info, falls back to
|
|
|
2430
2430
|
- `tooltipFormatter: (date: string, count: number) => React.ReactNode` — Custom tooltip formatter.
|
|
2431
2431
|
- `asChild: boolean` = false — Whether to render as a child component.
|
|
2432
2432
|
- `children: React.ReactNode` — Content to render inside.
|
|
2433
|
-
- **Card** — Information containers
|
|
2433
|
+
- **Card** — Information containers (aka Tile)
|
|
2434
2434
|
- `asChild: boolean` = false — If true, the card will be rendered as its child, merging its props onto that child.
|
|
2435
2435
|
- `variant: "elevated" | "outline" | "flat" | "glass"` = "outline" — Visual style variant of the card
|
|
2436
2436
|
- `interactive: boolean` = false — Whether the card is clickable: shows hover and press feedback and a pointer cursor
|
|
@@ -2523,7 +2523,7 @@ target is already in the past). Not called when baseDate is set.
|
|
|
2523
2523
|
- `completedContent: React.ReactNode` — Content shown instead of the zeroed digits once the countdown ends.
|
|
2524
2524
|
- `fallback: React.ReactNode` — Content shown when the target cannot be parsed.
|
|
2525
2525
|
- `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
|
|
2526
|
+
- **DataGrid** — Advanced data table and manipulation (aka Data Table)
|
|
2527
2527
|
- `columns: DataGridColumn<T>[]` (required) — Column definitions
|
|
2528
2528
|
- `data: T[]` (required) — Row data
|
|
2529
2529
|
- `rowKey: string | ((record: T) => string)` = "id" — Row key: a field name or a function that derives the key from a record
|
|
@@ -2611,7 +2611,7 @@ Without it, pointer devices show the move button in the card's corner on hover o
|
|
|
2611
2611
|
- `unit: string` — Label for the score unit
|
|
2612
2612
|
- `size: "sm" | "md" | "lg"` = "md" — Size
|
|
2613
2613
|
- `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
|
|
2614
|
+
- **List** — Structurally organized items in bullet points or numbered formats (aka Contained List, Ordered List, Unordered List)
|
|
2615
2615
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2616
2616
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the list items
|
|
2617
2617
|
- `spacing: "tight" | "normal" | "loose"` = "normal" — Spacing between items
|
|
@@ -2778,7 +2778,7 @@ focus moves to the first focusable element after the bar (with `DataGrid`, the g
|
|
|
2778
2778
|
- `asChild: boolean` = false — If true, the component will be rendered as its child.
|
|
2779
2779
|
- `onSortEnd: (oldIndex: number, newIndex: number) => void` — Callback called when reordering is completed.
|
|
2780
2780
|
- `disabled: boolean` = false — Whether the entire list is disabled.
|
|
2781
|
-
- **Stats** — A component to highlight key performance indicators and metrics (aka Statistic, Stat)
|
|
2781
|
+
- **Stats** — A component to highlight key performance indicators and metrics (aka Statistic, Stat, Big Number)
|
|
2782
2782
|
- `variant: React.ComponentProps<typeof Card>["variant"]` = "outline" — Visual style variant of the card
|
|
2783
2783
|
- `asChild: boolean` = false — If true, the card will be rendered as its child, merging its props onto that child.
|
|
2784
2784
|
- `interactive: boolean` = false — Whether the card is clickable: shows hover and press feedback and a pointer cursor
|
|
@@ -2809,7 +2809,7 @@ or by keyboard focus on its actions, closes the others.
|
|
|
2809
2809
|
- `fullSwipe: "left" | "right" | "both"` — Sides where swiping all the way across runs the outermost action without a tap
|
|
2810
2810
|
(`leftActions[0]` / the last of `rightActions`), as in iOS Mail. Off by default so a
|
|
2811
2811
|
destructive action is never triggered by momentum; the action stays available as a button.
|
|
2812
|
-
- **Table** — Rows and columns for displaying structured data efficiently
|
|
2812
|
+
- **Table** — Rows and columns for displaying structured data efficiently (aka Structured List)
|
|
2813
2813
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2814
2814
|
- `striped: boolean` = false — Whether to show striped (zebra) rows
|
|
2815
2815
|
- `bordered: boolean` = false — Whether to show borders between cells
|
|
@@ -2906,7 +2906,7 @@ anything is measured; long text is truncated and read in full by assistive techn
|
|
|
2906
2906
|
- `className: string` — Additional CSS class name for the container.
|
|
2907
2907
|
- `disabled: boolean` = false — Disable the context menu
|
|
2908
2908
|
- `asChild: boolean` = false — If true, merge trigger props onto the child element.
|
|
2909
|
-
- **Dialog** — Focused task windows (aka Modal, Modal Dialog)
|
|
2909
|
+
- **Dialog** — Focused task windows (aka Modal, Modal Dialog, Composed Modal)
|
|
2910
2910
|
- `children: React.ReactNode` (required) — Dialog parts (Dialog.Trigger, Dialog.Content, etc.).
|
|
2911
2911
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2912
2912
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the dialog is opened or closed.
|
|
@@ -2920,7 +2920,7 @@ interrupts the user and needs a response before they can continue, such as
|
|
|
2920
2920
|
confirming a destructive action. An alert dialog does not close when the
|
|
2921
2921
|
overlay is clicked unless closeOnOverlayClick is set; Escape still closes it.
|
|
2922
2922
|
@default "dialog"
|
|
2923
|
-
- **Drawer** — Slide-out detail panels (aka Navigation Drawer, Overlay Drawer)
|
|
2923
|
+
- **Drawer** — Slide-out detail panels (aka Navigation Drawer, Overlay Drawer, Side Panel)
|
|
2924
2924
|
- `children: React.ReactNode` (required) — Drawer parts (DrawerTrigger, DrawerContent, etc.).
|
|
2925
2925
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2926
2926
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the drawer is opened or closed.
|
|
@@ -2977,7 +2977,7 @@ is marked.
|
|
|
2977
2977
|
- `children: ReactNode` (required) — The target element which the Popconfirm will be attached to
|
|
2978
2978
|
- `icon: ReactNode` — Customize the icon
|
|
2979
2979
|
- `disabled: boolean` = false — Whether to show the popconfirm
|
|
2980
|
-
- **Popover** — Contextual overlay (aka Info Label, Info Button)
|
|
2980
|
+
- **Popover** — Contextual overlay (aka Info Label, Info Button, Toggletip)
|
|
2981
2981
|
- `children: ReactNode` (required) — Popover parts (PopoverTrigger, PopoverContent, etc.).
|
|
2982
2982
|
- `className: string` — Additional CSS class name for the container.
|
|
2983
2983
|
- `defaultOpen: boolean` = false — If true, the popover component will manage its own open state.
|
|
@@ -3079,7 +3079,7 @@ Defaults to the localized `form.optional` string.
|
|
|
3079
3079
|
@default t("spoiler.show_more")
|
|
3080
3080
|
- `hideLabel: React.ReactNode` — Label of the toggle while expanded.
|
|
3081
3081
|
@default t("spoiler.show_less")
|
|
3082
|
-
- **Text** — Has appropriate line-height and spacing to ensure readability of long text.
|
|
3082
|
+
- **Text** — Has appropriate line-height and spacing to ensure readability of long text. (aka Truncated Text)
|
|
3083
3083
|
- `asChild: boolean` = false — If true, the text will be rendered as its child, merging its props onto that child.
|
|
3084
3084
|
- `size: "xs" | "sm" | "md" | "lg" | "xl"` = "md" — Font size of the text.
|
|
3085
3085
|
@default "md"
|
|
@@ -3506,7 +3506,7 @@ enough on its own.
|
|
|
3506
3506
|
- `showFullscreenToggle: boolean` = false — Whether to show a full-screen toggle (default: false)
|
|
3507
3507
|
- `className: string` — Additional CSS class
|
|
3508
3508
|
- **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.
|
|
3509
|
+
- **CodeBlock** — Syntax-highlighted code block with copy button, line numbers, and collapsible overflow. (aka Code Snippet)
|
|
3510
3510
|
- `code: string` (required) — The code string to display
|
|
3511
3511
|
- `language: string` — Programming language label shown in the header (e.g. "tsx", "bash")
|
|
3512
3512
|
- `filename: string` — Optional filename shown in the header instead of the language label
|