wimui 0.78.0 → 0.80.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/_internal/HiddenFormValue.cjs +2 -0
- package/dist/components/_internal/HiddenFormValue.d.ts +36 -0
- package/dist/components/_internal/HiddenFormValue.js +25 -0
- package/dist/components/ai/AILabel/AILabel.d.ts +1 -1
- 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/ai/ModelSelector/ModelSelector.cjs +1 -1
- package/dist/components/ai/ModelSelector/ModelSelector.js +4 -4
- package/dist/components/data-display/Barcode/Barcode.cjs +1 -1
- package/dist/components/data-display/Barcode/Barcode.js +4 -4
- package/dist/components/data-display/DataGrid/DataGrid.cjs +1 -1
- package/dist/components/data-display/DataGrid/DataGrid.js +158 -129
- 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/data-display/ScheduleView/ScheduleView.cjs +1 -1
- package/dist/components/data-display/ScheduleView/ScheduleView.js +3 -3
- package/dist/components/data-display/TreeView/tree-view.module.cjs +1 -1
- package/dist/components/data-display/TreeView/tree-view.module.js +1 -1
- package/dist/components/feedback/ErrorBoundary/ErrorBoundary.cjs +1 -1
- package/dist/components/feedback/ErrorBoundary/ErrorBoundary.js +5 -5
- package/dist/components/form/Button/Button.cjs +1 -1
- package/dist/components/form/Button/Button.js +7 -7
- package/dist/components/form/Cascader/Cascader.cjs +1 -1
- package/dist/components/form/Cascader/Cascader.d.ts +5 -1
- package/dist/components/form/Cascader/Cascader.js +61 -53
- package/dist/components/form/Cascader/cascader.module.cjs +1 -1
- package/dist/components/form/Cascader/cascader.module.js +7 -6
- package/dist/components/form/Dropzone/Dropzone.cjs +1 -1
- package/dist/components/form/Dropzone/Dropzone.js +4 -4
- package/dist/components/form/Input/Input.cjs +1 -1
- package/dist/components/form/Input/Input.js +3 -3
- package/dist/components/form/LinkButton/LinkButton.d.ts +1 -1
- package/dist/components/form/MultiSelect/MultiSelect.cjs +1 -1
- package/dist/components/form/MultiSelect/MultiSelect.d.ts +5 -1
- package/dist/components/form/MultiSelect/MultiSelect.js +71 -63
- package/dist/components/form/OtpInput/OtpInput.cjs +1 -1
- package/dist/components/form/OtpInput/OtpInput.d.ts +9 -0
- package/dist/components/form/OtpInput/OtpInput.js +81 -66
- package/dist/components/form/RangeSlider/RangeSlider.cjs +1 -1
- package/dist/components/form/RangeSlider/RangeSlider.js +109 -104
- package/dist/components/form/Rating/Rating.cjs +1 -1
- package/dist/components/form/Rating/Rating.d.ts +5 -1
- package/dist/components/form/Rating/Rating.js +78 -70
- package/dist/components/form/SegmentedControl/SegmentedControl.cjs +1 -1
- package/dist/components/form/SegmentedControl/SegmentedControl.d.ts +4 -0
- package/dist/components/form/SegmentedControl/SegmentedControl.js +56 -51
- package/dist/components/form/Select/Select.cjs +1 -1
- package/dist/components/form/Select/Select.d.ts +4 -0
- package/dist/components/form/Select/Select.js +91 -84
- package/dist/components/form/Select/useSelect.cjs +1 -1
- package/dist/components/form/Select/useSelect.d.ts +1 -0
- package/dist/components/form/Select/useSelect.js +9 -6
- 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/Slider/Slider.cjs +1 -1
- package/dist/components/form/Slider/Slider.js +82 -77
- package/dist/components/form/TagInput/TagInput.cjs +1 -1
- package/dist/components/form/TagInput/TagInput.d.ts +4 -0
- package/dist/components/form/TagInput/TagInput.js +35 -27
- 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/TreeSelect.cjs +1 -1
- package/dist/components/form/TreeSelect/TreeSelect.d.ts +4 -0
- package/dist/components/form/TreeSelect/TreeSelect.js +91 -83
- package/dist/components/form/TreeSelect/tree-select.module.cjs +1 -1
- package/dist/components/form/TreeSelect/tree-select.module.js +7 -6
- package/dist/components/layout/AppShell/AppShell.cjs +1 -1
- package/dist/components/layout/AppShell/AppShell.d.ts +5 -0
- package/dist/components/layout/AppShell/AppShell.js +107 -89
- package/dist/components/layout/OverflowList/OverflowList.cjs +1 -1
- package/dist/components/layout/OverflowList/OverflowList.js +4 -4
- package/dist/components/navigation/Breadcrumb/Breadcrumb.cjs +1 -1
- package/dist/components/navigation/Breadcrumb/Breadcrumb.js +15 -15
- package/dist/components/navigation/HamburgerMenu/HamburgerMenu.cjs +1 -1
- package/dist/components/navigation/HamburgerMenu/HamburgerMenu.js +3 -3
- package/dist/components/navigation/SkipLink/SkipLink.cjs +2 -0
- package/dist/components/navigation/SkipLink/SkipLink.d.ts +39 -0
- package/dist/components/navigation/SkipLink/SkipLink.js +27 -0
- package/dist/components/navigation/SkipLink/skip-link.module.cjs +2 -0
- package/dist/components/navigation/SkipLink/skip-link.module.js +5 -0
- package/dist/components/overlay/ContextMenu/ContextMenu.cjs +1 -1
- package/dist/components/overlay/ContextMenu/ContextMenu.js +92 -77
- package/dist/i18n/generated/components.d.ts +1 -1
- package/dist/i18n/generated/navigation.cjs +1 -1
- package/dist/i18n/generated/navigation.d.ts +1 -1
- package/dist/i18n/generated/navigation.js +12 -3
- package/dist/index.cjs +1 -1
- package/dist/index.js +300 -299
- package/dist/llms/AIResponseFeedback.md +2 -0
- package/dist/llms/Accordion.md +1 -1
- package/dist/llms/Alert.md +3 -1
- package/dist/llms/Anchor.md +1 -1
- package/dist/llms/AppShell.md +2 -1
- package/dist/llms/Audio.md +2 -0
- package/dist/llms/AvatarGroup.md +1 -1
- package/dist/llms/BackTop.md +1 -1
- package/dist/llms/Badge.md +1 -1
- package/dist/llms/Breadcrumb.md +1 -1
- package/dist/llms/ButtonGroup.md +1 -1
- package/dist/llms/Cascader.md +2 -1
- package/dist/llms/Charts.md +2 -0
- package/dist/llms/ChatUI.md +2 -0
- package/dist/llms/Code.md +2 -0
- package/dist/llms/CodeBlock.md +1 -1
- package/dist/llms/CodeDiffViewer.md +2 -0
- package/dist/llms/ColorPicker.md +1 -1
- package/dist/llms/Combobox.md +1 -1
- package/dist/llms/CommandPalette.md +1 -1
- package/dist/llms/Confirm.md +2 -0
- package/dist/llms/CopyButton.md +1 -1
- package/dist/llms/Countdown.md +2 -0
- package/dist/llms/DataGrid.md +1 -1
- package/dist/llms/DatePicker.md +4 -0
- package/dist/llms/DateRangePicker.md +4 -0
- package/dist/llms/DescriptionList.md +2 -0
- package/dist/llms/Drawer.md +1 -1
- package/dist/llms/Dropdown.md +1 -1
- package/dist/llms/EmptyState.md +1 -1
- package/dist/llms/FieldError.md +2 -0
- package/dist/llms/FieldTemplate.md +1 -1
- package/dist/llms/FileUpload.md +1 -1
- package/dist/llms/FloatButton.md +2 -0
- package/dist/llms/FocusTrap.md +2 -0
- package/dist/llms/Gallery.md +2 -0
- package/dist/llms/Grid.md +2 -0
- package/dist/llms/Group.md +2 -0
- package/dist/llms/Header.md +2 -0
- package/dist/llms/Highlight.md +2 -0
- package/dist/llms/HoverCard.md +2 -0
- package/dist/llms/IconButton.md +2 -0
- package/dist/llms/Image.md +2 -0
- package/dist/llms/ImageCompare.md +2 -0
- package/dist/llms/ImageCropper.md +2 -0
- package/dist/llms/Indicator.md +1 -1
- package/dist/llms/InfiniteScroll.md +2 -0
- package/dist/llms/InlineEdit.md +1 -1
- package/dist/llms/Input.md +1 -1
- package/dist/llms/InputGroup.md +2 -0
- package/dist/llms/InputMask.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/LoadingOverlay.md +2 -0
- package/dist/llms/MarkdownRenderer.md +2 -0
- package/dist/llms/Marquee.md +1 -1
- package/dist/llms/Mentions.md +2 -0
- package/dist/llms/Menu.md +2 -0
- package/dist/llms/MultiSelect.md +2 -1
- package/dist/llms/NumberInput.md +1 -1
- package/dist/llms/OtpInput.md +3 -1
- package/dist/llms/PageHeader.md +2 -0
- package/dist/llms/Pagination.md +1 -1
- package/dist/llms/PasswordInput.md +2 -0
- package/dist/llms/Popconfirm.md +2 -0
- package/dist/llms/Popover.md +1 -1
- package/dist/llms/Presence.md +2 -0
- package/dist/llms/Progress.md +1 -1
- package/dist/llms/ProgressRing.md +2 -0
- package/dist/llms/PromptInput.md +2 -0
- package/dist/llms/RadioGroup.md +1 -1
- package/dist/llms/RangeSlider.md +2 -0
- package/dist/llms/Rating.md +2 -1
- package/dist/llms/RichTextEditor.md +2 -0
- package/dist/llms/ScrollArea.md +2 -0
- package/dist/llms/SegmentedControl.md +2 -1
- package/dist/llms/Select.md +2 -1
- package/dist/llms/SelectionBar.md +1 -1
- package/dist/llms/Sidebar.md +1 -1
- package/dist/llms/SimpleGrid.md +2 -0
- package/dist/llms/Skeleton.md +1 -1
- package/dist/llms/SkipLink.md +24 -0
- package/dist/llms/Slider.md +2 -0
- package/dist/llms/SortableList.md +2 -0
- package/dist/llms/Spinner.md +1 -1
- package/dist/llms/Splitter.md +1 -1
- package/dist/llms/Stack.md +2 -0
- package/dist/llms/Stats.md +1 -1
- package/dist/llms/Stepper.md +1 -1
- package/dist/llms/Switch.md +3 -1
- package/dist/llms/TabNavigation.md +2 -0
- package/dist/llms/Table.md +1 -1
- package/dist/llms/Tabs.md +1 -1
- package/dist/llms/Tag.md +1 -1
- package/dist/llms/TagInput.md +2 -1
- package/dist/llms/Text.md +1 -1
- package/dist/llms/Textarea.md +2 -0
- package/dist/llms/ThemeToggle.md +2 -0
- package/dist/llms/TimePicker.md +2 -0
- package/dist/llms/Title.md +2 -0
- package/dist/llms/Toast.md +1 -1
- package/dist/llms/ToggleGroup.md +2 -0
- package/dist/llms/Toolbar.md +2 -0
- package/dist/llms/Tooltip.md +1 -1
- package/dist/llms/Tour.md +3 -1
- package/dist/llms/Transfer.md +2 -0
- package/dist/llms/TreeDiagram.md +1 -1
- package/dist/llms/TreeSelect.md +1 -0
- package/dist/llms/TreeView.md +2 -2
- package/dist/llms/Treemap.md +2 -0
- package/dist/llms/Video.md +2 -0
- package/dist/llms/VirtualList.md +2 -0
- package/dist/llms-full.txt +179 -114
- package/dist/llms.txt +164 -114
- package/dist/locales/en/components.json +2 -1
- package/dist/locales/ja/components.json +2 -1
- package/dist/locales/pt/components.json +2 -1
- package/dist/navigation.cjs +1 -1
- package/dist/navigation.d.ts +1 -0
- package/dist/navigation.js +17 -16
- package/dist/reset.css +1 -1
- package/dist/styles.css +1 -1
- package/dist/wimui.umd.css +1 -1
- package/dist/wimui.umd.js +5 -5
- package/package.json +21 -18
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.80.0 — a React 19 component library: 235 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 (aka UI Shell)
|
|
625
|
+
- **AppShell** — Basic application shell layout (aka UI Shell, Page Layout, Split Page Layout)
|
|
626
626
|
- `header: React.ReactNode` — Header component
|
|
627
627
|
- `sidebar: React.ReactNode` — Sidebar component
|
|
628
628
|
- `footer: React.ReactNode` — Footer component
|
|
@@ -630,6 +630,8 @@ export function RenameWorkspace() {
|
|
|
630
630
|
- `padding: boolean` = true — Add padding to main content
|
|
631
631
|
- `centered: boolean` — Center main content horizontally
|
|
632
632
|
- `maxWidth: number | string` — Maximum width for centered content
|
|
633
|
+
- `skipLink: boolean` = true — Render a "Skip to main content" link as the first focusable element. It stays hidden until it receives focus and moves focus to the main region (WCAG 2.4.1). Set to `false` only when the page already renders its own skip link.
|
|
634
|
+
@default true
|
|
633
635
|
- **AspectRatio** — Fixed ratio container
|
|
634
636
|
- `ratio: number` = 1 — Aspect ratio (e.g. 16 / 9, 1, 4 / 3)
|
|
635
637
|
- `children: React.ReactNode` (required) — Child content
|
|
@@ -751,7 +753,7 @@ this too.
|
|
|
751
753
|
- `bordered: boolean` — Border at the top
|
|
752
754
|
- `fluid: boolean` — Expand content to full width (disable the centered max-width container)
|
|
753
755
|
- `background: "surface" | "surface-variant" | "inverse"` = "surface" — Background color
|
|
754
|
-
- **Grid** — Flexbox or CSS Grid system
|
|
756
|
+
- **Grid** — Flexbox or CSS Grid system (aka Layout Grid)
|
|
755
757
|
- `asChild: boolean` = false — If true, the grid will be rendered as its child, merging its props onto that child.
|
|
756
758
|
The container-query wrapper div is preserved to maintain responsive column behaviour.
|
|
757
759
|
- `cols: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Number of columns (or a responsive object per breakpoint)
|
|
@@ -763,7 +765,7 @@ The container-query wrapper div is preserved to maintain responsive column behav
|
|
|
763
765
|
- `justify: "start" | "center" | "end" | "between" | "around" | "stretch"` — Justification of items along the inline (horizontal) axis
|
|
764
766
|
- `flow: "row" | "column" | "dense" | "row dense" | "column dense"` — Grid auto-flow direction
|
|
765
767
|
- `inline: boolean` = false — Whether to render as an inline grid
|
|
766
|
-
- **Group** — Flexible grouping
|
|
768
|
+
- **Group** — Flexible grouping (aka Wrap, Inline Stack, Space, Inline)
|
|
767
769
|
- `asChild: boolean` — If true, the group will be rendered as its child, merging its props onto that child.
|
|
768
770
|
- `align: "start" | "center" | "end" | "stretch" | "baseline"` = "center" — Vertical alignment
|
|
769
771
|
- `justify: "start" | "center" | "end" | "between" | "around" | "evenly"` = "start" — Horizontal alignment
|
|
@@ -772,7 +774,7 @@ number of pixels. Prefer the token so the gap follows the theme.
|
|
|
772
774
|
@default "2xl"
|
|
773
775
|
- `wrap: "nowrap" | "wrap" | "wrap-reverse"` = "wrap" — Whether to wrap children
|
|
774
776
|
- `grow: boolean` = false — Whether items should grow to fill available space
|
|
775
|
-
- **Header** — Upper navigation
|
|
777
|
+
- **Header** — Upper navigation (aka Top Bar, App Bar)
|
|
776
778
|
- `fixed: boolean` — Fixed position at the top
|
|
777
779
|
- `sticky: boolean` — Sticky position at the top
|
|
778
780
|
- `bordered: boolean` — Border at the bottom
|
|
@@ -837,7 +839,7 @@ elements. Without it, the row is a `div`, which a list may not contain.
|
|
|
837
839
|
- `asChild: boolean` = false — If true, the list will be rendered as its child, merging its props onto that child.
|
|
838
840
|
- `children: React.ReactNode` — The element that becomes the root (in place of `div`) when `asChild` is set. The items are
|
|
839
841
|
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.
|
|
842
|
+
- **PageHeader** — Head of a page: breadcrumb, title (always h1), status, description, actions and tabs in a fixed order and spacing. (aka Pagehead)
|
|
841
843
|
- `title: React.ReactNode` (required) — The page title. Always rendered as the page's `h1` at one fixed size; a
|
|
842
844
|
long title wraps instead of being cut.
|
|
843
845
|
- `breadcrumb: React.ReactNode` — Breadcrumb shown above the title (usually a `Breadcrumb`).
|
|
@@ -846,12 +848,12 @@ long title wraps instead of being cut.
|
|
|
846
848
|
- `actions: React.ReactNode` — Page actions, such as `Button`s. They sit to the right of the title and
|
|
847
849
|
move to their own line under it when the header is too narrow.
|
|
848
850
|
- `tabs: React.ReactNode` — Navigation between the page's views, such as `TabNavigation`, at the bottom.
|
|
849
|
-
- **ScrollArea** — A custom scrollbar component that provides high-performance, cross-browser consistent themes while maintaining a native-like feel.
|
|
851
|
+
- **ScrollArea** — A custom scrollbar component that provides high-performance, cross-browser consistent themes while maintaining a native-like feel. (aka Scroll Panel, Scrollable Region)
|
|
850
852
|
- `text: React.ReactNode` — Content to display (alternative to children)
|
|
851
853
|
- `children: React.ReactNode` — Content to display
|
|
852
854
|
- `scrollAxis: "x" | "y" | "both"` = "y" — Axis along which scrolling is allowed
|
|
853
855
|
- `maxHeight: string` — Maximum height before scrolling (a CSS value, so units other than px are supported)
|
|
854
|
-
- **Sidebar** — A collapsible navigation or informational panel on the side of the screen (aka Source List, Inspector, Nav Drawer)
|
|
856
|
+
- **Sidebar** — A collapsible navigation or informational panel on the side of the screen (aka Source List, Inspector, Nav Drawer, Side Nav, Side Navigation)
|
|
855
857
|
- `fixed: boolean` — Fixed position
|
|
856
858
|
- `collapsed: boolean` — Collapsed state
|
|
857
859
|
- `width: number | string` = 260 — Width when expanded
|
|
@@ -883,17 +885,17 @@ the wrong place or duplicate the one you already have.
|
|
|
883
885
|
Set `responsive={false}` to keep the sidebar in flow at every width.
|
|
884
886
|
- `mobileOpen: boolean` — Mobile drawer open state. Required for the rail to be reachable below `md` — see `responsive`.
|
|
885
887
|
- `onOverlayClick: () => void` — Callback when overlay is clicked
|
|
886
|
-
- **SimpleGrid** — Responsive fixed grid
|
|
888
|
+
- **SimpleGrid** — Responsive fixed grid (aka Inline Grid)
|
|
887
889
|
- `cols: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` = 1 — Number of columns (or a responsive object per breakpoint)
|
|
888
890
|
- `spacing: number | string` = "2xl" — Spacing between cells: a spacing token name (`"md"`, `"2xl"`, …) or a raw
|
|
889
891
|
number of pixels. Prefer the token so the gap follows the theme.
|
|
890
892
|
@default "2xl"
|
|
891
893
|
- `verticalSpacing: number | string` — Vertical spacing between rows (defaults to `spacing`)
|
|
892
894
|
- `minChildWidth: number | string` — Minimum width of each child; columns wrap automatically to fit
|
|
893
|
-
- **Splitter** — Split and resize panels (aka Resizable, Resizable Panels, Split Pane, Resizer)
|
|
895
|
+
- **Splitter** — Split and resize panels (aka Resizable, Resizable Panels, Split Pane, Resizer, Resize Box)
|
|
894
896
|
- `orientation: "horizontal" | "vertical"` = "horizontal" — The orientation of the splitter.
|
|
895
897
|
- `children: React.ReactNode` (required) — The components to render within the splitter. Usually a combination of `Splitter.Panel` and `Splitter.Handle`.
|
|
896
|
-
- **Stack** — Vertical/Horizontal alignment
|
|
898
|
+
- **Stack** — Vertical/Horizontal alignment (aka Block Stack)
|
|
897
899
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
898
900
|
- `gap: number | string` = "md" — Gap between children. Can be a number (px) or a spacing token (e.g., 'sm', 'md', 'lg').
|
|
899
901
|
- `direction: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` = "column" — Stack direction
|
|
@@ -923,6 +925,7 @@ number of pixels. Prefer the token so the gap follows the theme.
|
|
|
923
925
|
- `display: React.CSSProperties["display"]` — Display
|
|
924
926
|
- `position: React.CSSProperties["position"]` — Position
|
|
925
927
|
- **Toolbar** — Action strip for IconButton, ToggleGroup, and related controls with toolbar keyboard navigation. (aka Action Bar)
|
|
928
|
+
- ⚠️ Not the same as elsewhere: In React Spectrum 2, "ActionBar" is the bar of bulk actions that appears while items are selected — that is `SelectionBar` here. WIM's `Toolbar` is a persistent row of controls.
|
|
926
929
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
927
930
|
- `size: "lg" | "md" | "sm"` = "md" — Visual density for padding and gap.
|
|
928
931
|
@default "md"
|
|
@@ -988,7 +991,7 @@ Useful for using the button styles with Link components (e.g. from React Router
|
|
|
988
991
|
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
989
992
|
- `styles: { root?: string; loader?: string; icon?: string; }` — Custom styles for internal parts
|
|
990
993
|
- `className: string` — Additional class names
|
|
991
|
-
- **ButtonGroup** — Group of buttons (aka Button Set, Action Set)
|
|
994
|
+
- **ButtonGroup** — Group of buttons (aka Button Set, Action Set, Action Button Group)
|
|
992
995
|
- `children: React.ReactNode` (required) — Buttons to group
|
|
993
996
|
- `gap: string` = "8px" — Gap between buttons (ignored when joined)
|
|
994
997
|
- `className: string` — Additional class names
|
|
@@ -996,7 +999,7 @@ Useful for using the button styles with Link components (e.g. from React Router
|
|
|
996
999
|
- `variant: "solid" | "outline" | "ghost"` — Variant applied to all child buttons
|
|
997
1000
|
- `justify: "start" | "center" | "end" | "stretch"` = "start" — Where the buttons sit on the row. `start` keeps the group as wide as its buttons, so it lines up with other content; `center` / `end` / `stretch` take the full row (`stretch` grows every button to share it).
|
|
998
1001
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
999
|
-
- **Cascader** — Hierarchical selection (aka Column View, Miller Columns)
|
|
1002
|
+
- **Cascader** — Hierarchical selection (aka Column View, Miller Columns, Cascade Select)
|
|
1000
1003
|
- `options: CascaderOption[]` = [] — Hierarchical options to select from
|
|
1001
1004
|
- `value: string[]` — Selected value path (controlled)
|
|
1002
1005
|
- `onChange: (value: string[], selectedOptions: CascaderOption[]) => void` — Callback when the selection changes
|
|
@@ -1004,6 +1007,7 @@ Useful for using the button styles with Link components (e.g. from React Router
|
|
|
1004
1007
|
- `label: React.ReactNode` — Field label
|
|
1005
1008
|
- `error: string` — Error message
|
|
1006
1009
|
- `required: boolean` — Whether to show the required indicator
|
|
1010
|
+
- `name: string` — Name submitted with a native `<form>`. Each value on the selected path is sent as its own hidden input, in order from the top level (read them with `FormData.getAll`), and a form reset restores `defaultValue` when uncontrolled.
|
|
1007
1011
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1008
1012
|
- `className: string` — Additional class names
|
|
1009
1013
|
- `disabled: boolean` = false — Whether the field is disabled
|
|
@@ -1068,7 +1072,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1068
1072
|
so the unit does not have to be repeated in the label.
|
|
1069
1073
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1070
1074
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1071
|
-
- **ColorPicker** — Color selection picker (aka Swatch Picker)
|
|
1075
|
+
- **ColorPicker** — Color selection picker (aka Swatch Picker, Color Swatch Picker)
|
|
1072
1076
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1073
1077
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1074
1078
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1108,7 +1112,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1108
1112
|
so the unit does not have to be repeated in the label.
|
|
1109
1113
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1110
1114
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1111
|
-
- **Combobox** — Select with search (aka Autocomplete, Auto Complete)
|
|
1115
|
+
- **Combobox** — Select with search (aka Autocomplete, Auto Complete, Suggest)
|
|
1112
1116
|
- `options: ComboboxOption[]` = [] — List of suggestion options
|
|
1113
1117
|
- `onChange: (option: ComboboxOption) => void` — Callback when an option is selected
|
|
1114
1118
|
- `placeholder: string` — Placeholder for the input
|
|
@@ -1124,7 +1128,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1124
1128
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1125
1129
|
- `id: string` — Unique ID for the component
|
|
1126
1130
|
- `labels: { noResults?: React.ReactNode; }` = {} — Labels for internationalization
|
|
1127
|
-
- **CopyButton** — Copy to clipboard (aka Copy)
|
|
1131
|
+
- **CopyButton** — Copy to clipboard (aka Copy, Clipboard)
|
|
1128
1132
|
- `value: string` (required) — Text copied to the clipboard
|
|
1129
1133
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
1130
1134
|
- `className: string` — Additional class names
|
|
@@ -1184,7 +1188,8 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1184
1188
|
`kg`, `%` or `円`. It is announced with the field via `aria-describedby`,
|
|
1185
1189
|
so the unit does not have to be repeated in the label.
|
|
1186
1190
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1187
|
-
- **DatePicker** — Date selection
|
|
1191
|
+
- **DatePicker** — Date selection (aka Date Input, Date Field)
|
|
1192
|
+
- ⚠️ 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
1193
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1189
1194
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1190
1195
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1204,7 +1209,8 @@ so the unit does not have to be repeated in the label.
|
|
|
1204
1209
|
- `labels: { placeholder?: string; }` — Labels for manual translation
|
|
1205
1210
|
- `width: ("xs" | "sm" | "md" | "lg" | "xl") | string | number` — Fixed width of the field (width token, CSS value, or number in px)
|
|
1206
1211
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1207
|
-
- **DateRangePicker** — Date range selection
|
|
1212
|
+
- **DateRangePicker** — Date range selection (aka Date Range Input)
|
|
1213
|
+
- ⚠️ 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
1214
|
- `startProps: React.ComponentProps<typeof DatePicker>` — Props passed to the start-date DatePicker
|
|
1209
1215
|
- `endProps: React.ComponentProps<typeof DatePicker>` — Props passed to the end-date DatePicker
|
|
1210
1216
|
- `className: string` — Additional class names
|
|
@@ -1237,7 +1243,7 @@ them. Leave it undefined to let the area track its own selection.
|
|
|
1237
1243
|
- `aria-label: string` — Accessible name for the drop area when no visible `label` is provided.
|
|
1238
1244
|
- `aria-labelledby: string` — ID of the element that labels the drop area when no visible `label` is provided.
|
|
1239
1245
|
- `aria-describedby: string` — ID of the element that describes the drop area. Announced together with the error message.
|
|
1240
|
-
- **FieldError** — Validation messages
|
|
1246
|
+
- **FieldError** — Validation messages (aka Inline Error, Error Message)
|
|
1241
1247
|
- `content: string` (required) — Error message text
|
|
1242
1248
|
- `className: string` — Additional class names
|
|
1243
1249
|
- `id: string` — ID of the error message element
|
|
@@ -1251,7 +1257,7 @@ inside a `Card` or any surface that already draws a border, where a framed
|
|
|
1251
1257
|
fieldset would put a box inside a box. The `<fieldset>` and its `<legend>`
|
|
1252
1258
|
still do their job for assistive technology.
|
|
1253
1259
|
- `className: string` — Additional class names
|
|
1254
|
-
- **FieldTemplate** — Standardizes label placement, required markings, and error message display for all form-related components. (aka Field)
|
|
1260
|
+
- **FieldTemplate** — Standardizes label placement, required markings, and error message display for all form-related components. (aka Field, Form Control)
|
|
1255
1261
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1256
1262
|
- `label: React.ReactNode` — Label text of the field
|
|
1257
1263
|
- `error: string` — Error message
|
|
@@ -1263,7 +1269,7 @@ still do their job for assistive technology.
|
|
|
1263
1269
|
- `htmlFor: string` — ID of the element the label points to
|
|
1264
1270
|
- `errorId: string` — ID of the error message element
|
|
1265
1271
|
- `styles: { root?: string; labelWrapper?: string; label?: string; content?: string; error?: string; }` — Custom styles for internal parts
|
|
1266
|
-
- **FileUpload** — File selection (aka Upload, File Input, File Uploader)
|
|
1272
|
+
- **FileUpload** — File selection (aka Upload, File Input, File Uploader, File Trigger)
|
|
1267
1273
|
- `label: React.ReactNode` — Field label
|
|
1268
1274
|
- `buttonLabel: React.ReactNode` — Label of the file selection button
|
|
1269
1275
|
- `noFileLabel: React.ReactNode` — Text shown when no file is selected
|
|
@@ -1287,7 +1293,7 @@ it undefined to let the field track its own selection.
|
|
|
1287
1293
|
- `aria-label: string` — Accessible name for the choose-file button when no visible `label` is provided.
|
|
1288
1294
|
- `aria-labelledby: string` — ID of the element that labels the choose-file button when no visible `label` is provided.
|
|
1289
1295
|
- `aria-describedby: string` — ID of the element that describes the choose-file button. Announced together with the error message.
|
|
1290
|
-
- **FloatButton** — Floating action buttons
|
|
1296
|
+
- **FloatButton** — Floating action buttons (aka FAB)
|
|
1291
1297
|
- `asChild: boolean` = false — If true, the button will be rendered as its child, merging its props onto that child.
|
|
1292
1298
|
- `iconName: "CircleIcon" | "SquareIcon" | "LoadingIcon" | "ExternalLinkIcon" | "ArrowUpIcon" | string` = "CircleIcon" — Icon name from the library
|
|
1293
1299
|
- `variant: "outline" | "glass"` — 見た目の強さ。既定(未指定)は intent の塗り。
|
|
@@ -1310,7 +1316,7 @@ SCSS には誰も付けない `.default_intent` が「temporary name」のまま
|
|
|
1310
1316
|
- `style: React.CSSProperties` — Style attribute
|
|
1311
1317
|
- `aria-label: string` — Accessible name. Required when there is no string `label`: an icon-only button has no
|
|
1312
1318
|
text to take a name from, and the icon name is not used as one.
|
|
1313
|
-
- **IconButton** — A square button containing only an icon without a text label.
|
|
1319
|
+
- **IconButton** — A square button containing only an icon without a text label. (aka Close Button)
|
|
1314
1320
|
- `iconName: React.ComponentProps<typeof Icon>["name"]` (required) — Icon name to display
|
|
1315
1321
|
- `aria-label: string` (required) — Accessible label for the icon-only button
|
|
1316
1322
|
- `backgroundColor: T | (string & {})` — Overrides the button background color with a design token. Usually the `variant` prop is enough; use this prop only as a last resort.
|
|
@@ -1324,7 +1330,7 @@ text to take a name from, and the icon name is not used as one.
|
|
|
1324
1330
|
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
1325
1331
|
- `styles: { root?: string; loader?: string; icon?: string; }` — Custom styles for internal parts
|
|
1326
1332
|
- `className: string` — Additional class names
|
|
1327
|
-
- **ImageCropper** — Front-end image cropping and rotation tool.
|
|
1333
|
+
- **ImageCropper** — Front-end image cropping and rotation tool. (aka Cropper)
|
|
1328
1334
|
- `src: string` — URL or data URL of the image to crop
|
|
1329
1335
|
- `aspectRatio: number` = 1 — Aspect ratio (width / height); 1 produces a square
|
|
1330
1336
|
- `circular: boolean` = false — Whether to display a circular crop area (for profile images)
|
|
@@ -1347,7 +1353,7 @@ resolution of the source image; without a bound a large photo produces a large d
|
|
|
1347
1353
|
@default 0.92
|
|
1348
1354
|
- `crossOrigin: "anonymous" | "use-credentials"` — CORS mode used to load the image. Needed to crop an image served from another origin;
|
|
1349
1355
|
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)
|
|
1356
|
+
- **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, Inplace)
|
|
1351
1357
|
- `value: string` — Current text (controlled)
|
|
1352
1358
|
- `defaultValue: string` — Initial text (uncontrolled)
|
|
1353
1359
|
- `onChange: (value: string) => void` — Callback when the text changes while editing
|
|
@@ -1358,7 +1364,7 @@ the server must send matching CORS headers or the image will not load at all.
|
|
|
1358
1364
|
- `disabled: boolean` = false — Whether editing is disabled
|
|
1359
1365
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1360
1366
|
- `label: React.ReactNode` — Accessible label for the text and edit button
|
|
1361
|
-
- **Input** — Single-line input fields for text, numbers, or emails (aka Text Input)
|
|
1367
|
+
- **Input** — Single-line input fields for text, numbers, or emails (aka Text Input, Text Field, Input Text)
|
|
1362
1368
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1363
1369
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1364
1370
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1412,11 +1418,11 @@ make room rather than running underneath it.
|
|
|
1412
1418
|
- `onClear: () => void` — Callback when the clear button is clicked
|
|
1413
1419
|
- `clearAriaLabel: string` — Aria label for the clear button
|
|
1414
1420
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1415
|
-
- **InputGroup** — Inputs with icons/labels
|
|
1421
|
+
- **InputGroup** — Inputs with icons/labels (aka Control Group)
|
|
1416
1422
|
- `children: React.ReactNode` (required) — Inputs, buttons, and add-ons to combine into one unit
|
|
1417
1423
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1418
1424
|
- `className: string` — Additional class names
|
|
1419
|
-
- **InputMask** — Formatted inputs
|
|
1425
|
+
- **InputMask** — Formatted inputs (aka Masked Input)
|
|
1420
1426
|
- `mask: string` (required) — Mask pattern ('9': digit, 'a': letter, '*': alphanumeric; other characters are shown as-is)
|
|
1421
1427
|
- `maskChar: string` = "_" — Placeholder character for unfilled mask positions
|
|
1422
1428
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
@@ -1450,19 +1456,19 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1450
1456
|
so the unit does not have to be repeated in the label.
|
|
1451
1457
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1452
1458
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1453
|
-
- **LinkButton** — Anchor styled as button
|
|
1459
|
+
- **LinkButton** — Anchor styled as button (aka Anchor Button)
|
|
1454
1460
|
- `iconPosition: "left" | "right"` = "left" — Position of the icon relative to the label
|
|
1455
1461
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
1456
1462
|
- `variant: "solid" | "outline" | "ghost"` = "outline" — Visual style variant of the button
|
|
1457
1463
|
- `intent: "default" | "danger" | "success"` = "default" — Design intent of the button (visual / semantic state). Unrelated to the ARIA role attribute.
|
|
1458
1464
|
- `justify: "start" | "center" | "end" | "between"` = "center" — Horizontal alignment of the button content
|
|
1459
1465
|
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
1460
|
-
- **Mentions** — @ / # suggestions
|
|
1466
|
+
- **Mentions** — @ / # suggestions (aka Mention)
|
|
1461
1467
|
- `options: MentionOption[]` (required) — Mention candidates to suggest
|
|
1462
1468
|
- `trigger: string` = "@" — Character that triggers the suggestion list
|
|
1463
1469
|
- `onSelect: (option: MentionOption) => void` — Callback when a suggestion is selected
|
|
1464
1470
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1465
|
-
- **MultiSelect** — Multiple selection (aka Tag Picker)
|
|
1471
|
+
- **MultiSelect** — Multiple selection (aka Tag Picker, Select Panel, Select Multiple)
|
|
1466
1472
|
- `options: MultiSelectOption[]` = [] — List of options
|
|
1467
1473
|
- `value: string[]` — Selected values (controlled)
|
|
1468
1474
|
- `onChange: (value: string[]) => void` — Callback when the selection changes
|
|
@@ -1470,6 +1476,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1470
1476
|
- `label: string` — Field label
|
|
1471
1477
|
- `error: string` — Error message
|
|
1472
1478
|
- `required: boolean` — Whether to show the required indicator
|
|
1479
|
+
- `name: string` — Name submitted with a native `<form>`. Each selected value is sent as its own hidden input (read them with `FormData.getAll`), and a form reset restores `defaultValue` when uncontrolled.
|
|
1473
1480
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1474
1481
|
- `className: string` — Additional class names
|
|
1475
1482
|
- `disabled: boolean` = false — Whether the field is disabled
|
|
@@ -1481,27 +1488,30 @@ so the unit does not have to be repeated in the label.
|
|
|
1481
1488
|
- `aria-describedby: string` — ID of the element that describes the field
|
|
1482
1489
|
- `width: ("xs" | "sm" | "md" | "lg" | "xl") | string | number` — Fixed width of the field (width token, CSS value, or number in px)
|
|
1483
1490
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1484
|
-
- **NumberInput** — Input with step adjustments (aka Spin Button, Numeric Stepper)
|
|
1491
|
+
- **NumberInput** — Input with step adjustments (aka Spin Button, Numeric Stepper, Numeric Input, Number Field, Input Number)
|
|
1485
1492
|
- `mode: "number" | "text"` = "number" — 'number': uses the native type="number" (e.g. quantity steppers)
|
|
1486
1493
|
'text': uses type="text" + inputmode (e.g. card numbers or IDs where leading zeros must be kept)
|
|
1487
1494
|
- `hideSpinButton: boolean` = true — Whether to hide the spin buttons
|
|
1488
1495
|
- `allowDecimal: boolean` = false — Whether to allow decimals (effective only when mode="number"). When false, both "." and "," are blocked — a browser in a locale that writes decimals with a comma takes "," as the decimal separator.
|
|
1489
1496
|
- `allowNegative: boolean` = false — Whether to allow negative numbers (effective only when mode="number")
|
|
1490
1497
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1491
|
-
- **OtpInput** — One-time password fields (aka Pin Input, Input OTP, PIN Code Input)
|
|
1498
|
+
- **OtpInput** — One-time password fields (aka Pin Input, Input OTP, PIN Code Input, One Time Password Field, OTP Field, Pin Code, Verification Code)
|
|
1492
1499
|
- `length: number` = 6 — Number of digits
|
|
1493
1500
|
- `value: string` = "" — Current value (controlled)
|
|
1494
1501
|
- `onChange: (value: string) => void` — Callback when the value changes
|
|
1495
1502
|
- `disabled: boolean` = false — Whether the input is disabled
|
|
1496
1503
|
- `error: string` — Error message
|
|
1497
1504
|
- `required: boolean` — Whether to show the required indicator
|
|
1505
|
+
- `name: string` — Name submitted with a native `<form>`. The whole code is sent as one hidden input, and a form reset clears the boxes when uncontrolled.
|
|
1498
1506
|
- `label: React.ReactNode` — Field label
|
|
1499
1507
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1500
1508
|
- `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
|
|
1501
1509
|
box and receives a **1-based** position — the first box is `1`, not `0`.
|
|
1502
1510
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1503
1511
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
1504
|
-
-
|
|
1512
|
+
- `inputMode: "numeric" | "text"` = "numeric" — Keyboard shown on touch devices. Use `"text"` for codes that contain letters.
|
|
1513
|
+
@default "numeric"
|
|
1514
|
+
- **PasswordInput** — Password with toggle (aka Password Toggle Field)
|
|
1505
1515
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1506
1516
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1507
1517
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1576,7 +1586,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1576
1586
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1577
1587
|
- `children: React.ReactNode` — Label content rendered next to the radio
|
|
1578
1588
|
- `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)
|
|
1579
|
-
- **RadioGroup** — Shared state radio buttons (aka Radio Button Group)
|
|
1589
|
+
- **RadioGroup** — Shared state radio buttons (aka Radio Button Group, Choice List)
|
|
1580
1590
|
- `options: Option[]` (required) — List of radio options
|
|
1581
1591
|
- `value: string` — Selected value (controlled)
|
|
1582
1592
|
- `defaultValue: string` — Initially selected value (uncontrolled)
|
|
@@ -1592,7 +1602,7 @@ of a radio group. Use with `description` when the options need explaining.
|
|
|
1592
1602
|
- `error: string` — Error message
|
|
1593
1603
|
- `required: boolean` — Whether to show the required indicator
|
|
1594
1604
|
- `disabled: boolean` — Whether the whole group is disabled
|
|
1595
|
-
- **RangeSlider** — Range selection
|
|
1605
|
+
- **RangeSlider** — Range selection (aka Range Selector)
|
|
1596
1606
|
- `value: [number, number]` — Current value [min, max] (controlled)
|
|
1597
1607
|
- `defaultValue: [number, number]` = [20, 80] — Default value [min, max] (uncontrolled)
|
|
1598
1608
|
- `min: number` = 0 — Minimum value
|
|
@@ -1612,7 +1622,7 @@ of a radio group. Use with `description` when the options need explaining.
|
|
|
1612
1622
|
- `aria-label: string` — Accessible label when no visible label is provided
|
|
1613
1623
|
- `aria-labelledby: string` — ID of the element that labels the slider
|
|
1614
1624
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1615
|
-
- **Rating** — Star rating (aka Star Rating, Rating Indicator, Rating Display)
|
|
1625
|
+
- **Rating** — Star rating (aka Star Rating, Rating Indicator, Rating Display, Rating Group, Rate)
|
|
1616
1626
|
- `value: number` — Current value (controlled)
|
|
1617
1627
|
- `defaultValue: number` = 0 — Default value (uncontrolled)
|
|
1618
1628
|
- `count: number` = 5 — Total number of stars
|
|
@@ -1625,10 +1635,11 @@ of a radio group. Use with `description` when the options need explaining.
|
|
|
1625
1635
|
- `label: React.ReactNode` — Accessible label
|
|
1626
1636
|
- `error: string` — Error message
|
|
1627
1637
|
- `required: boolean` — Whether to show the required indicator
|
|
1638
|
+
- `name: string` — Name submitted with a native `<form>`. The rating is sent as a hidden input, and a form reset restores `defaultValue` when uncontrolled.
|
|
1628
1639
|
- `layout: "vertical" | "horizontal"` = "vertical" — Layout direction of label and field
|
|
1629
1640
|
- `labels: { star?: (count: number) => string; readonly?: (value: number, max: number) => string; }` = {} — Labels for internationalization
|
|
1630
1641
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1631
|
-
- **RichTextEditor** — WYSIWYG rich text editor
|
|
1642
|
+
- **RichTextEditor** — WYSIWYG rich text editor (aka Editor)
|
|
1632
1643
|
- `value: string` — Content (controlled), in the format given by `format`. An empty editor is reported as "".
|
|
1633
1644
|
- `defaultValue: string` = "" — Initial content (uncontrolled), in the format given by `format`
|
|
1634
1645
|
- `onChange: (value: string) => void` — Callback when the content changes, in the format given by `format`. The content only contains what the editor's schema
|
|
@@ -1704,7 +1715,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1704
1715
|
so the unit does not have to be repeated in the label.
|
|
1705
1716
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1706
1717
|
- `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)
|
|
1718
|
+
- **SegmentedControl** — Button-style controls for switching between a small set of mutually exclusive options (aka Segmented Buttons, Segmented Picker, Content Switcher, Segment Group, Select Button)
|
|
1708
1719
|
- `options: Option[]` (required) — List of segment options
|
|
1709
1720
|
- `value: string` (required) — Selected value
|
|
1710
1721
|
- `onChange: (value: string) => void` (required) — Callback when the selected value changes
|
|
@@ -1714,6 +1725,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1714
1725
|
- `label: string` — Accessible label
|
|
1715
1726
|
- `error: string` — Error message
|
|
1716
1727
|
- `required: boolean` — Whether to show the required indicator
|
|
1728
|
+
- `name: string` — Name submitted with a native `<form>`. The selected value is sent as a hidden input. The component is controlled, so a form reset leaves the value to you.
|
|
1717
1729
|
- `layout: "vertical" | "horizontal"` = "vertical" — Layout direction of label and field
|
|
1718
1730
|
- `disabled: boolean` = false — Whether the control is disabled
|
|
1719
1731
|
- `asChild: boolean` = false — If true, merge radiogroup props onto the child element.
|
|
@@ -1723,7 +1735,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1723
1735
|
- `aria-describedby: string` — ID of the element that describes the radio group. Announced together with the error message.
|
|
1724
1736
|
- `id: string` — Unique ID for the component
|
|
1725
1737
|
- `styles: { root?: string; item?: string; slider?: string; label?: string; }` — Custom styles for internal parts
|
|
1726
|
-
- **Select** — A dropdown menu for selecting one option from a predefined list (aka Pop-Up Button, Select Menu)
|
|
1738
|
+
- **Select** — A dropdown menu for selecting one option from a predefined list (aka Pop-Up Button, Select Menu, Picker)
|
|
1727
1739
|
- `options: SelectOption[] | SelectOptionGroup[]` = [] — List of options (flat or grouped)
|
|
1728
1740
|
- `value: string` — Selected value (controlled)
|
|
1729
1741
|
- `onChange: (value: string) => void` — Callback when the selected value changes
|
|
@@ -1741,6 +1753,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1741
1753
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1742
1754
|
- `error: string` — Error message
|
|
1743
1755
|
- `required: boolean` — Whether to show the required indicator
|
|
1756
|
+
- `name: string` — Name submitted with a native `<form>`. The selected value is sent as a hidden input, and a form reset restores `defaultValue` when uncontrolled.
|
|
1744
1757
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1745
1758
|
- `noOptionsFoundLabel: string` — Label shown when no options match the search
|
|
1746
1759
|
- `width: ("xs" | "sm" | "md" | "lg" | "xl") | string | number` — Fixed width of the field (width token, CSS value, or number in px)
|
|
@@ -1763,7 +1776,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1763
1776
|
- `canvasAriaLabel: string` — Aria label for the canvas
|
|
1764
1777
|
- `aria-label: string` — Accessible name for the canvas when no visible `label` is provided. Takes precedence over `canvasAriaLabel`.
|
|
1765
1778
|
- `aria-labelledby: string` — ID of the element that labels the canvas when no visible `label` is provided.
|
|
1766
|
-
- **Slider** — An input to capture a numeric value from a specified range by dragging a knob
|
|
1779
|
+
- **Slider** — An input to capture a numeric value from a specified range by dragging a knob (aka Range, Range Input)
|
|
1767
1780
|
- `value: number` — Current value (controlled)
|
|
1768
1781
|
- `defaultValue: number` = 0 — Default value (uncontrolled)
|
|
1769
1782
|
- `min: number` = 0 — Minimum value
|
|
@@ -1807,7 +1820,8 @@ so the unit does not have to be repeated in the label.
|
|
|
1807
1820
|
- `loading: boolean` = false — Show a loading state on the main action.
|
|
1808
1821
|
- `toggleLabel: string` (required) — Accessible name for the toggle half. The main half is named by its own text,
|
|
1809
1822
|
but the toggle only shows a chevron, so it needs one of its own.
|
|
1810
|
-
- **Switch** — A binary switch for instantly toggling settings between on and off states (aka Toggle, Toggle Switch)
|
|
1823
|
+
- **Switch** — A binary switch for instantly toggling settings between on and off states (aka Toggle, Toggle Switch, Input Switch)
|
|
1824
|
+
- ⚠️ 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
1825
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
1812
1826
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the switch
|
|
1813
1827
|
- `className: string` — Additional class names
|
|
@@ -1825,7 +1839,7 @@ but the toggle only shows a chevron, so it needs one of its own.
|
|
|
1825
1839
|
- `error: string` — Error message
|
|
1826
1840
|
- `required: boolean` — Whether to show the required indicator
|
|
1827
1841
|
- `disabled: boolean` — Whether the whole group is disabled
|
|
1828
|
-
- **TagInput** — Input field for creating free-form tags. (aka Token Field, Chips Input)
|
|
1842
|
+
- **TagInput** — Input field for creating free-form tags. (aka Token Field, Chips Input, Tags Input, Text Input With Tokens, Input Tag)
|
|
1829
1843
|
- `value: string[]` — List of tags (controlled)
|
|
1830
1844
|
- `defaultValue: string[]` = [] — Initial list of tags (uncontrolled)
|
|
1831
1845
|
- `onChange: (tags: string[]) => void` — Callback when the tags change
|
|
@@ -1838,10 +1852,11 @@ but the toggle only shows a chevron, so it needs one of its own.
|
|
|
1838
1852
|
- `label: React.ReactNode` — Field label
|
|
1839
1853
|
- `error: string` — Error message
|
|
1840
1854
|
- `required: boolean` — Whether to show the required indicator
|
|
1855
|
+
- `name: string` — Name submitted with a native `<form>`. Each tag is sent as its own hidden input (read them with `FormData.getAll`), and a form reset restores `defaultValue` when uncontrolled.
|
|
1841
1856
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1842
1857
|
- `allowDelete: boolean` = true — Whether tags can be deleted
|
|
1843
1858
|
- `maxTags: number` — Maximum number of tags that can be entered
|
|
1844
|
-
- **Textarea** — Multi-line input fields for longer text entries like descriptions or comments
|
|
1859
|
+
- **Textarea** — Multi-line input fields for longer text entries like descriptions or comments (aka Input Textarea)
|
|
1845
1860
|
- `asChild: boolean` = false — If true, the textarea element will be rendered as its child, merging its props onto that child.
|
|
1846
1861
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1847
1862
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
@@ -1852,7 +1867,7 @@ but the toggle only shows a chevron, so it needs one of its own.
|
|
|
1852
1867
|
- `required: boolean` — Whether to show the required indicator
|
|
1853
1868
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1854
1869
|
- `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
|
|
1870
|
+
- **ThemeToggle** — Light / dark / system theme switcher (aka Animated Theme Toggler)
|
|
1856
1871
|
- `value: "light" | "dark" | "system"` — Selected mode (controlled)
|
|
1857
1872
|
- `defaultValue: "light" | "dark" | "system"` = "system" — Initially selected mode (uncontrolled)
|
|
1858
1873
|
- `onChange: (mode: ("light" | "dark" | "system")) => void` — Callback when the mode changes
|
|
@@ -1864,7 +1879,7 @@ but the toggle only shows a chevron, so it needs one of its own.
|
|
|
1864
1879
|
- `labels: { /** Label for the light mode */ light?: string; /** Label for the dark mode */ dark?: string; /** Label for the system (auto) mode */ system?: string; /** Accessible label / group label for the control */ toggle?: string; }` — Labels for internationalization
|
|
1865
1880
|
- `className: string` — Additional class names
|
|
1866
1881
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1867
|
-
- **TimePicker** — Time selection
|
|
1882
|
+
- **TimePicker** — Time selection (aka Time Field, Time Input)
|
|
1868
1883
|
- `intent: "default" | "danger"` = "default" — Semantic intent of the field (e.g. error state)
|
|
1869
1884
|
- `variant: "outline" | "ghost"` = "outline" — Visual style variant of the field
|
|
1870
1885
|
- `fullWidth: boolean` = false — Whether to take full width of parent
|
|
@@ -1895,7 +1910,7 @@ Use it when the field already does the same thing from the keyboard.
|
|
|
1895
1910
|
so the unit does not have to be repeated in the label.
|
|
1896
1911
|
- `styles: { root?: string; inner?: string; icon?: string; icons?: string; iconItem?: string; iconButton?: string; }` — Custom styles for internal parts
|
|
1897
1912
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
1898
|
-
- **ToggleGroup** — Toggleable buttons
|
|
1913
|
+
- **ToggleGroup** — Toggleable buttons (aka Toggle Button Group)
|
|
1899
1914
|
- `options: Option[]` (required) — List of toggle options
|
|
1900
1915
|
- `value: string | string[]` — Selected value(s) (controlled)
|
|
1901
1916
|
- `defaultValue: string | string[]` — Initially selected value(s) (uncontrolled)
|
|
@@ -1915,7 +1930,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1915
1930
|
- `aria-label: string` — Accessible label when no visible label is provided
|
|
1916
1931
|
- `aria-labelledby: string` — ID of the element that labels the group
|
|
1917
1932
|
- `aria-describedby: string` — ID of the element that describes the group, such as help text
|
|
1918
|
-
- **Transfer** — Move items between lists
|
|
1933
|
+
- **Transfer** — Move items between lists (aka Pick List)
|
|
1919
1934
|
- `dataSource: TransferItem[]` = [] — All items shown across the two lists
|
|
1920
1935
|
- `targetKeys: string[]` — Keys of the items in the target (right) list
|
|
1921
1936
|
- `onChange: ( targetKeys: string[], direction: "toLeft" | "toRight", moveKeys: string[], ) => void` — Callback when items are moved between the lists
|
|
@@ -1939,6 +1954,7 @@ so the unit does not have to be repeated in the label.
|
|
|
1939
1954
|
- `label: React.ReactNode` — Field label
|
|
1940
1955
|
- `error: string` — Error message
|
|
1941
1956
|
- `required: boolean` — Whether to show the required indicator
|
|
1957
|
+
- `name: string` — Name submitted with a native `<form>`. The selected value (each value when `multiple`) is sent as a hidden input, and a form reset clears the selection when uncontrolled.
|
|
1942
1958
|
- `layout: "vertical" | "horizontal"` — Layout direction of label and field
|
|
1943
1959
|
- `className: string` — Additional class names
|
|
1944
1960
|
- `disabled: boolean` = false — Whether the field is disabled
|
|
@@ -1960,7 +1976,8 @@ so the unit does not have to be repeated in the label.
|
|
|
1960
1976
|
|
|
1961
1977
|
### feedback — `import { … } from "wimui/feedback"`
|
|
1962
1978
|
|
|
1963
|
-
- **Alert** — Important messages (aka Message Bar)
|
|
1979
|
+
- **Alert** — Important messages (aka Message Bar, Callout, Flash, Inline Alert, Inline Message, Section Message)
|
|
1980
|
+
- ⚠️ 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
1981
|
- `title: React.ReactNode` — Title of the alert
|
|
1965
1982
|
- `titleTag: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "div" | "p" | "strong" | "span"` = "div" — HTML tag used for the alert title.
|
|
1966
1983
|
|
|
@@ -2000,7 +2017,7 @@ When a function is passed, it is called as (error, errorInfo, reset) => ReactNod
|
|
|
2000
2017
|
- `onReset: () => void` — Called when the error is reset.
|
|
2001
2018
|
- `labels: { title?: string; retry?: string; showDetails?: string; hideDetails?: string; }` — Labels for manual translation overrides.
|
|
2002
2019
|
- `children: ReactNode` (required) — Content the boundary protects.
|
|
2003
|
-
- **Indicator** — Small status dots (aka Badge Indicator)
|
|
2020
|
+
- **Indicator** — Small status dots (aka Badge Indicator, Message Indicator)
|
|
2004
2021
|
- `children: React.ReactNode` — Element the indicator dot is attached to. If omitted, only the dot is rendered.
|
|
2005
2022
|
- `color: T | (string & {})` = "primary" — Color of the dot. Accepts a design token color name or any CSS color value.
|
|
2006
2023
|
@default "primary"
|
|
@@ -2021,7 +2038,7 @@ When a function is passed, it is called as (error, errorInfo, reset) => ReactNod
|
|
|
2021
2038
|
@default "md"
|
|
2022
2039
|
- `color: "currentColor" | WimColor` = "primary" — Color of the loader. Accepts a design token color name or "currentColor".
|
|
2023
2040
|
@default "primary"
|
|
2024
|
-
- **LoadingOverlay** — Overlay with loading indicator
|
|
2041
|
+
- **LoadingOverlay** — Overlay with loading indicator (aka Block UI)
|
|
2025
2042
|
- `visible: boolean` = false — Whether the overlay is shown.
|
|
2026
2043
|
@default false
|
|
2027
2044
|
- `loaderType: "spinner" | "bars" | "dots" | "pulse"` = "spinner" — Type of the loading indicator.
|
|
@@ -2063,7 +2080,7 @@ origin while the card it was meant to cover was 1248x75.
|
|
|
2063
2080
|
- `className: string` — Additional class name
|
|
2064
2081
|
- `aria-label: string` — Accessible name for the notification.
|
|
2065
2082
|
- `aria-labelledby: string` — ID of the element that labels the notification. Takes precedence over `aria-label`.
|
|
2066
|
-
- **Progress** — Progress bar (aka Progress Bar)
|
|
2083
|
+
- **Progress** — Progress bar (aka Progress Bar, Progress Linear)
|
|
2067
2084
|
- ⚠️ Not the same as elsewhere: Material's "Progress Indicator" covers indeterminate spinners as well. WIM's `Progress` is determinate and linear only — for the indeterminate case use `Spinner`.
|
|
2068
2085
|
- `value: number` = 0 — Current value of the progress bar.
|
|
2069
2086
|
@default 0
|
|
@@ -2083,7 +2100,7 @@ type therefore requires one of `label` / `aria-label` / `aria-labelledby`.
|
|
|
2083
2100
|
@default false
|
|
2084
2101
|
- `indeterminate: boolean` = false — If true, shows an indeterminate animation instead of a value.
|
|
2085
2102
|
@default false
|
|
2086
|
-
- **ProgressRing** — ProgressRing description.
|
|
2103
|
+
- **ProgressRing** — ProgressRing description. (aka Progress Circle, Animated Circular Progress Bar, Radial Progress, Progress Circular)
|
|
2087
2104
|
- `value: number` = 0 — Current value of the progress ring.
|
|
2088
2105
|
@default 0
|
|
2089
2106
|
- `max: number` = 100 — Maximum value of the progress ring.
|
|
@@ -2127,7 +2144,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2127
2144
|
塗っているものは `Progress.intent` と構造まで同一だったので、prop 名だけが
|
|
2128
2145
|
ずれていた(T114)。
|
|
2129
2146
|
- `target: React.RefObject<HTMLElement | null>` — Element whose scroll position is tracked. Defaults to `window`.
|
|
2130
|
-
- **Skeleton** — Placeholder for content loading states. (aka Shimmer)
|
|
2147
|
+
- **Skeleton** — Placeholder for content loading states. (aka Shimmer, Skeleton Loader)
|
|
2131
2148
|
- `variant: "text" | "rect" | "circle"` = "text" — Shape of the skeleton.
|
|
2132
2149
|
- `text`: shaped like a line of text.
|
|
2133
2150
|
- `rect`: rectangle.
|
|
@@ -2156,7 +2173,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2156
2173
|
- `onAction: () => void` — Called when the action button is clicked
|
|
2157
2174
|
- `onClose: () => void` — Called when the snackbar is closed
|
|
2158
2175
|
- `className: string` — Additional CSS class name
|
|
2159
|
-
- **Spinner** — A rotating icon indicating background activity or data fetching (aka Activity Indicator, Inline Loading, Loading)
|
|
2176
|
+
- **Spinner** — A rotating icon indicating background activity or data fetching (aka Activity Indicator, Inline Loading, Loading, Progress Spinner, Spin)
|
|
2160
2177
|
- `size: "sm" | "md" | "lg" | "xl"` = "md" — Size of the spinner.
|
|
2161
2178
|
@default "md"
|
|
2162
2179
|
- `color: "currentColor" | WimColor` = "primary" — Color of the spinner. Accepts a design token color name or "currentColor".
|
|
@@ -2164,7 +2181,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2164
2181
|
- `label: string` — Text label displayed next to the spinner.
|
|
2165
2182
|
- `labelPosition: "right" | "bottom"` = "right" — Position of the label relative to the spinner.
|
|
2166
2183
|
@default "right"
|
|
2167
|
-
- **Toast** — Non-intrusive floating messages that provide feedback on system operations (aka Message, Sonner, Toaster)
|
|
2184
|
+
- **Toast** — Non-intrusive floating messages that provide feedback on system operations (aka Message, Sonner, Toaster, Flag)
|
|
2168
2185
|
- `id: string` — Identifier of the toast, passed to onClose. Used by ToastProvider to manage a stack.
|
|
2169
2186
|
- `title: string` — Title of the toast.
|
|
2170
2187
|
- `description: string` — Description text displayed below the title.
|
|
@@ -2178,7 +2195,8 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2178
2195
|
- `className: string` — Additional CSS class name.
|
|
2179
2196
|
- `aria-label: string` — Accessible name for the toast.
|
|
2180
2197
|
- `aria-labelledby: string` — ID of the element that labels the toast. Takes precedence over `aria-label`.
|
|
2181
|
-
- **Tour** — Sequential guided walkthroughs to onboard users or highlight features (aka Teaching Popover, Coach Mark)
|
|
2198
|
+
- **Tour** — Sequential guided walkthroughs to onboard users or highlight features (aka Teaching Popover, Coach Mark, User Guide, Spotlight)
|
|
2199
|
+
- ⚠️ Not the same as elsewhere: In Atlassian's design system, "Spotlight" is the onboarding tour that highlights one element at a time — that is `Tour` here. Aceternity UI's Spotlight is a decorative lighting effect, which WIM does not provide.
|
|
2182
2200
|
- `steps: TourStep[]` (required) — Steps of the tour. Each step targets an element via a CSS selector.
|
|
2183
2201
|
- `open: boolean` (required) — Whether the tour is shown.
|
|
2184
2202
|
- `onClose: () => void` (required) — Called when the tour is dismissed before completion.
|
|
@@ -2194,7 +2212,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2194
2212
|
- `children: React.ReactNode` (required) — Children to be rendered inside the affix
|
|
2195
2213
|
- `className: string` — Additional class names
|
|
2196
2214
|
- `style: React.CSSProperties` — Style attribute
|
|
2197
|
-
- **Anchor** — Smooth scroll links (aka Scrollspy, Table of Contents, TableOfContents)
|
|
2215
|
+
- **Anchor** — Smooth scroll links (aka Scrollspy, Table of Contents, TableOfContents, TOC)
|
|
2198
2216
|
- `items: AnchorLinkItem[]` = [] — Array of anchor link configurations
|
|
2199
2217
|
- `bounds: number` = 5 — Bounding distance (in pixels) for triggering active state
|
|
2200
2218
|
- `offset: number` = 0 — Offset (in pixels) from top when clicking to scroll
|
|
@@ -2203,7 +2221,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2203
2221
|
- `style: React.CSSProperties` — Style attribute
|
|
2204
2222
|
- `aria-label: string` — Accessible name. When set, the anchor is exposed as a navigation landmark with this name.
|
|
2205
2223
|
- `aria-labelledby: string` — ID of the element that labels the anchor. Takes precedence over `aria-label`.
|
|
2206
|
-
- **BackTop** — Back to top button (aka Back to Top)
|
|
2224
|
+
- **BackTop** — Back to top button (aka Back to Top, Scroll Top)
|
|
2207
2225
|
- `target: () => HTMLElement | Window | Document | null` = () => window — Target container that will be scrolled
|
|
2208
2226
|
- `visibilityHeight: number` = 400 — Scroll height after which the button becomes visible
|
|
2209
2227
|
- `onClick: (e: React.MouseEvent<HTMLDivElement>) => void` — Callback when clicked
|
|
@@ -2214,7 +2232,7 @@ follows the theme and never needs a hand-mixed colour.
|
|
|
2214
2232
|
- `aria-labelledby: string` — ID of the element that labels the button. Takes precedence over `aria-label`.
|
|
2215
2233
|
- `aria-describedby: string` — ID of the element that describes the button.
|
|
2216
2234
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2217
|
-
- **Breadcrumb** — Location trace (aka Path Bar, Path Control)
|
|
2235
|
+
- **Breadcrumb** — Location trace (aka Path Bar, Path Control, Breadcrumbs)
|
|
2218
2236
|
- `items: BreadcrumbItem[]` (required) — Items to display, from the root to the current page.
|
|
2219
2237
|
- `separator: React.ReactNode` — Separator displayed between items. Defaults to a chevron icon.
|
|
2220
2238
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the breadcrumb.
|
|
@@ -2230,7 +2248,7 @@ into a "…" button that lists them.
|
|
|
2230
2248
|
- `asChild: boolean` — If true, the breadcrumb will be rendered as its child, merging its props onto that child.
|
|
2231
2249
|
- `children: React.ReactNode` — The element that becomes the breadcrumb's root (in place of `nav`) when
|
|
2232
2250
|
`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)
|
|
2251
|
+
- **CommandPalette** — Cmd+K search overlay (aka Command Bar, Quick Open, Omnibar, Command)
|
|
2234
2252
|
- `children: ReactNode` (required) — Palette parts (CommandPaletteTrigger, CommandPaletteContent, etc.).
|
|
2235
2253
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2236
2254
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the palette is opened or closed.
|
|
@@ -2245,7 +2263,8 @@ button. Without this callback the button cannot close on Escape, because `open`
|
|
|
2245
2263
|
- `color: string` — Color of the bars
|
|
2246
2264
|
- `visibleBelow: "xs" | "sm" | "md" | "lg" | "xl"` — Show only below the given breakpoint (e.g. "md" matches Sidebar's mobile drawer range)
|
|
2247
2265
|
- `className: string` — Custom class name
|
|
2248
|
-
- **KeyboardShortcuts** — Display a structured list of keyboard shortcuts
|
|
2266
|
+
- **KeyboardShortcuts** — Display a structured list of keyboard shortcuts (aka Hotkeys)
|
|
2267
|
+
- ⚠️ 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
2268
|
- `shortcuts: ShortcutItem[]` (required) — List of shortcuts to display
|
|
2250
2269
|
- `title: string` — Section title
|
|
2251
2270
|
- `titleLevel: 2 | 3 | 4 | 5 | 6` — `title` を見出しとして描くときの段(T211)。渡さなければ見出しにならず `p` のまま。
|
|
@@ -2275,7 +2294,7 @@ Useful for using the link styles with Link components from React Router or Next.
|
|
|
2275
2294
|
- `styles: { root?: string; label?: string; inner?: string; externalIcon?: string; }` — Custom styles for internal parts
|
|
2276
2295
|
- **Menubar** — Desktop-style application menu bar with floating File / Edit / View submenus.
|
|
2277
2296
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
2278
|
-
- **Pagination** — Multi-page navigation (aka Pagination Nav)
|
|
2297
|
+
- **Pagination** — Multi-page navigation (aka Pagination Nav, Paginator)
|
|
2279
2298
|
- `total: number` (required) — Total number of items
|
|
2280
2299
|
- `pageSize: number` = 10 — Number of items per page
|
|
2281
2300
|
- `current: number` = 1 — Current page number (1-indexed)
|
|
@@ -2296,6 +2315,10 @@ Useful for URL-based pagination (e.g. wrap with a Link via PaginationPage asChil
|
|
|
2296
2315
|
- `labels: { prevPage?: string; nextPage?: string; pageAriaLabel?: (page: number) => string; itemsPerPage?: string; goTo?: string; go?: string; pageSizeAriaLabel?: string; jumpToPageAriaLabel?: string; navAriaLabel?: string; totalLabel?: string; /** Announced to screen readers when the page changes. Receives the current page and the page count. */ pageStatus?: (current: number, totalPages: number) => string; }` = {} — Labels for internationalization
|
|
2297
2316
|
- `aria-label: string` — Accessible name for the navigation landmark. Takes precedence over `labels.navAriaLabel`.
|
|
2298
2317
|
- `aria-labelledby: string` — ID of the element that labels the navigation landmark. Takes precedence over `aria-label`.
|
|
2318
|
+
- **SkipLink** — A link at the very top of the page that jumps past the header and navigation to the main content. It stays hidden until it receives keyboard focus. AppShell renders one by default. (aka Skip Nav, Skip Navigation, Skip to Content, Bypass Block)
|
|
2319
|
+
- `href: string` = "#main" — The `id` of the element to jump to, as a fragment (`#main`). Pressing the link moves keyboard focus to that element.
|
|
2320
|
+
@default "#main"
|
|
2321
|
+
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
2299
2322
|
- **SpeedDial** — Floating action button that expands sub-actions on hover or click.
|
|
2300
2323
|
- `actions: SpeedDialAction[]` (required) — Actions to display when SpeedDial is open
|
|
2301
2324
|
- `icon: keyof typeof ALL_ICONS` = "PlusIcon" — Icon name for the main button when closed
|
|
@@ -2316,7 +2339,7 @@ near the right edge pushes the page into a horizontal scroll. Anchor a
|
|
|
2316
2339
|
- `aria-label: string` — Accessible name for the trigger button.
|
|
2317
2340
|
Lands on the inner `FloatButton`, not on the wrapper `div`.
|
|
2318
2341
|
Defaults to a translated "Open menu" / "Close menu" (en / ja / pt), following the open state.
|
|
2319
|
-
- **Stepper** — Visual sequence steps (aka Progress Indicator)
|
|
2342
|
+
- **Stepper** — Visual sequence steps (aka Progress Indicator, Steps, Wizard, Progress Tracker)
|
|
2320
2343
|
- ⚠️ 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
2344
|
- `steps: Step[]` = [] — Array of step configurations
|
|
2322
2345
|
- `current: number` = 0 — Index of the current active step (0-indexed)
|
|
@@ -2342,11 +2365,11 @@ document, so the page never gains a horizontal scrollbar and overflow
|
|
|
2342
2365
|
scans stay green while the bar hangs outside its parent.
|
|
2343
2366
|
- `bordered: boolean` = true — Show top border
|
|
2344
2367
|
- `glass: boolean` = false — Glassmorphism effect
|
|
2345
|
-
- **TabNavigation** — Tab-based navigation
|
|
2368
|
+
- **TabNavigation** — Tab-based navigation (aka Tab Menu, Tab Nav, Underline Nav, Sub Nav)
|
|
2346
2369
|
- `variant: "underline" | "pill" | "contained"` = "underline" — Visual style of the tabs
|
|
2347
2370
|
- `align: "start" | "center" | "end" | "justify"` = "start" — Alignment of the tabs
|
|
2348
2371
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the tabs
|
|
2349
|
-
- **Tabs** — A container to organize related content into switchable view panels (aka Tab List)
|
|
2372
|
+
- **Tabs** — A container to organize related content into switchable view panels (aka Tab List, Tab View, Tab Group)
|
|
2350
2373
|
- `asChild: boolean` = false — If true, the tabs root will be rendered as its child, merging its props onto that child.
|
|
2351
2374
|
- `defaultValue: string` — Value of the tab selected initially, for uncontrolled usage.
|
|
2352
2375
|
- `value: string` — Controlled value of the selected tab. Use together with onChange.
|
|
@@ -2356,7 +2379,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2356
2379
|
|
|
2357
2380
|
### data-display — `import { … } from "wimui/data-display"`
|
|
2358
2381
|
|
|
2359
|
-
- **Accordion** — Collapsible panels (aka Disclosure, Disclosure Group, Expander)
|
|
2382
|
+
- **Accordion** — Collapsible panels (aka Disclosure, Disclosure Group, Expander, Collapse, Expansion Panel)
|
|
2360
2383
|
- `type: "single" | "multiple"` = "single" — Whether one or multiple items can be open at a time
|
|
2361
2384
|
- `defaultValue: string | string[]` — Initially open item value(s) (uncontrolled)
|
|
2362
2385
|
- `value: string | string[]` — Open item value(s) (controlled)
|
|
@@ -2374,7 +2397,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2374
2397
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the avatar
|
|
2375
2398
|
- `shape: "circle" | "rounded"` = "circle" — Shape of the avatar
|
|
2376
2399
|
- `intent: "primary" | "success" | "warning" | "danger" | "info" | "neutral"` — Intent (semantic color) applied to the avatar
|
|
2377
|
-
- **AvatarGroup** — Stacked avatars (aka Face Pile)
|
|
2400
|
+
- **AvatarGroup** — Stacked avatars (aka Face Pile, Avatar Circles, Avatar Stack)
|
|
2378
2401
|
- `children: React.ReactNode` (required) — Avatar elements to group
|
|
2379
2402
|
- `max: number` — Maximum number of avatars to show before collapsing into a count. Ignored with `overflow="collapse"`.
|
|
2380
2403
|
- `size: "sm" | "md" | "lg"` = "md" — Size applied to the avatars
|
|
@@ -2384,7 +2407,7 @@ scans stay green while the bar hangs outside its parent.
|
|
|
2384
2407
|
lists the hidden people by name.
|
|
2385
2408
|
@default "count"
|
|
2386
2409
|
- `className: string` — Additional class names
|
|
2387
|
-
- **Badge** — Indicators or counts (aka Icon Indicator)
|
|
2410
|
+
- **Badge** — Indicators or counts (aka Icon Indicator, State Label, Lozenge)
|
|
2388
2411
|
- `asChild: boolean` — If true, the badge will be rendered as its child, merging its props onto that child.
|
|
2389
2412
|
- `children: React.ReactNode` — Content to display
|
|
2390
2413
|
- `content: React.ReactNode` — Content to display (alternative to children)
|
|
@@ -2510,7 +2533,7 @@ body rather than appearing alongside it.
|
|
|
2510
2533
|
- `onDelete: (id: string) => void` — Shows a Delete button when set.
|
|
2511
2534
|
- `actions: React.ReactNode` — Extra actions, placed after the built-in ones.
|
|
2512
2535
|
- `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.
|
|
2536
|
+
- **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
2537
|
- `target: Date | string | number` (required) — The moment the countdown ends, as a Date object, ISO 8601 string,
|
|
2515
2538
|
or epoch milliseconds.
|
|
2516
2539
|
- `baseDate: Date | string | number` — Reference point used as "now". When set, the countdown is frozen at
|
|
@@ -2532,7 +2555,7 @@ target is already in the past). Not called when baseDate is set.
|
|
|
2532
2555
|
- `completedContent: React.ReactNode` — Content shown instead of the zeroed digits once the countdown ends.
|
|
2533
2556
|
- `fallback: React.ReactNode` — Content shown when the target cannot be parsed.
|
|
2534
2557
|
- `asChild: boolean` = false — If true, the component will be rendered as its child, merging its props onto that child.
|
|
2535
|
-
- **DataGrid** — Advanced data table and manipulation (aka Data Table)
|
|
2558
|
+
- **DataGrid** — Advanced data table and manipulation (aka Data Table, Index Table, Table View, Dynamic Table)
|
|
2536
2559
|
- `columns: DataGridColumn<T>[]` (required) — Column definitions
|
|
2537
2560
|
- `data: T[]` (required) — Row data
|
|
2538
2561
|
- `rowKey: string | ((record: T) => string)` = "id" — Row key: a field name or a function that derives the key from a record
|
|
@@ -2561,14 +2584,14 @@ drops secondary text below the AA contrast floor.
|
|
|
2561
2584
|
- `ariaLabel: string` — Accessibility label for the grid
|
|
2562
2585
|
- `aria-label: string` — Accessible name for the grid. Takes precedence over `ariaLabel`.
|
|
2563
2586
|
- `aria-labelledby: string` — ID of the element that labels the grid. Takes precedence over `aria-label`.
|
|
2564
|
-
- **DescriptionList** — Key-value pairs
|
|
2587
|
+
- **DescriptionList** — Key-value pairs (aka Data List, Labeled Value, Descriptions, Name Value List)
|
|
2565
2588
|
- `children: React.ReactNode` (required) — DescriptionListItem elements
|
|
2566
2589
|
- `className: string` — Additional class names
|
|
2567
2590
|
- `layout: "horizontal" | "vertical" | "compact"` = "horizontal" — Layout of terms and descriptions
|
|
2568
2591
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the text
|
|
2569
2592
|
- `border: boolean` = false — Whether to show borders (alias of bordered)
|
|
2570
2593
|
- `bordered: boolean` = false — Whether to show borders
|
|
2571
|
-
- **EmptyState** — Missing data placeholder (aka Blank Slate, Zero State)
|
|
2594
|
+
- **EmptyState** — Missing data placeholder (aka Blank Slate, Zero State, Non-Ideal State, Empty Search Result, Illustrated Message, Empty)
|
|
2572
2595
|
- `title: React.ReactNode` (required) — Title to display.
|
|
2573
2596
|
- `description: React.ReactNode` — Description text to display.
|
|
2574
2597
|
- `icon: React.ReactNode` — Icon to display.
|
|
@@ -2587,7 +2610,7 @@ in; use `"center"` only when the empty state is the only thing in its region.
|
|
|
2587
2610
|
- `className: string` — Additional class names.
|
|
2588
2611
|
- `aria-label: string` — Accessible name for the section. A named section is exposed as a region landmark.
|
|
2589
2612
|
- `aria-labelledby: string` — ID of the element that labels the section. Takes precedence over `aria-label`.
|
|
2590
|
-
- **InfiniteScroll** — Infinite scroll control
|
|
2613
|
+
- **InfiniteScroll** — Infinite scroll control (aka Data Scroller)
|
|
2591
2614
|
- `children: React.ReactNode` (required) — Content to display.
|
|
2592
2615
|
- `hasMore: boolean` = false — Whether there is more data to load.
|
|
2593
2616
|
- `loading: boolean` = false — Whether data is currently loading.
|
|
@@ -2601,7 +2624,7 @@ in; use `"center"` only when the empty state is the only thing in its region.
|
|
|
2601
2624
|
- `after: unknown` (required) — JSON value after the change
|
|
2602
2625
|
- `indent: number` = 2 — Indentation spaces for JSON.stringify (default: 2)
|
|
2603
2626
|
- `view: "split" | "unified"` — Display mode inherited from CodeDiffViewer
|
|
2604
|
-
- **JsonViewer** — Recursive tree viewer and editor for JSON data.
|
|
2627
|
+
- **JsonViewer** — Recursive tree viewer and editor for JSON data. (aka JSON Tree View)
|
|
2605
2628
|
- `data: unknown` (required) — The JSON data to display
|
|
2606
2629
|
- `expandDepth: number` = 1 — Initial depth to expand
|
|
2607
2630
|
- `showCopy: boolean` = true — If true, show copy button
|
|
@@ -2620,7 +2643,7 @@ Without it, pointer devices show the move button in the card's corner on hover o
|
|
|
2620
2643
|
- `unit: string` — Label for the score unit
|
|
2621
2644
|
- `size: "sm" | "md" | "lg"` = "md" — Size
|
|
2622
2645
|
- `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)
|
|
2646
|
+
- **List** — Structurally organized items in bullet points or numbered formats (aka Contained List, Ordered List, Unordered List, Card List, Resource List, List View)
|
|
2624
2647
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2625
2648
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the list items
|
|
2626
2649
|
- `spacing: "tight" | "normal" | "loose"` = "normal" — Spacing between items
|
|
@@ -2632,7 +2655,7 @@ Without it, pointer devices show the move button in the card's corner on hover o
|
|
|
2632
2655
|
- `children: string` — Markdown string to render (when passed as children).
|
|
2633
2656
|
- `gfm: boolean` = true — Whether to enable GitHub Flavored Markdown (default: true).
|
|
2634
2657
|
- `className: string` — Additional class names.
|
|
2635
|
-
- **Marquee** — Scrolling text animation (aka Ticker)
|
|
2658
|
+
- **Marquee** — Scrolling text animation (aka Ticker, Infinite Moving Cards)
|
|
2636
2659
|
- `duration: number` = 20 — Animation speed (in seconds). Defaults to `20`.
|
|
2637
2660
|
- `reverse: boolean` = false — Whether to run the animation in reverse.
|
|
2638
2661
|
- `pauseOnHover: boolean` = true — Whether to pause the animation on hover. Keyboard focus inside the marquee
|
|
@@ -2704,6 +2727,7 @@ with empty spacer rows. Use it for tables with hundreds of rows, together with
|
|
|
2704
2727
|
- `totalColumn: boolean` = false — Adds a grand total column at the right edge.
|
|
2705
2728
|
- `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
2729
|
- **Presence** — Shows whether a person is online, away, busy, or offline.
|
|
2730
|
+
- ⚠️ 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
2731
|
- `status: "online" | "away" | "busy" | "offline"` (required) — Availability of the person or resource.
|
|
2708
2732
|
- `label: string` — Text for the status. Defaults to the localized name of `status`.
|
|
2709
2733
|
- `showLabel: boolean` = false — Whether the label is shown next to the dot. The label is always exposed to
|
|
@@ -2782,7 +2806,7 @@ first day, as in `Calendar`.
|
|
|
2782
2806
|
- `unselectAuto: boolean` = true — Whether clicking elsewhere on the page will clear the current selection
|
|
2783
2807
|
- `className: string` — Additional CSS class
|
|
2784
2808
|
- `aria-label: string` — Accessible label for the schedule region
|
|
2785
|
-
- **SelectionBar** — Bar above a table that shows the number of selected rows, the actions for them and a way to clear the selection. Announces the count to screen readers. (aka Bulk Actions, Batch Actions, Table Selection Toolbar)
|
|
2809
|
+
- **SelectionBar** — Bar above a table that shows the number of selected rows, the actions for them and a way to clear the selection. Announces the count to screen readers. (aka Bulk Actions, Batch Actions, Table Selection Toolbar, Select All Actions)
|
|
2786
2810
|
- `count: number` (required) — Number of selected items. The bar shows while it is above 0. Keep the component mounted
|
|
2787
2811
|
while the count is 0 as well: it holds the status region that announces the count, and a
|
|
2788
2812
|
region that appears together with its text is not read by screen readers.
|
|
@@ -2794,11 +2818,11 @@ are placed in a `Toolbar`, so the arrow keys move between them.
|
|
|
2794
2818
|
- `returnFocusRef: React.RefObject<HTMLElement | null>` — Where focus goes when the bar closes after focus was in it — after the clear button, or
|
|
2795
2819
|
after a confirmation opened from the bar (`Popconfirm`) whose trigger is gone. Without it,
|
|
2796
2820
|
focus moves to the first focusable element after the bar (with `DataGrid`, the grid).
|
|
2797
|
-
- **SortableList** — Item rearrangement and reordering
|
|
2821
|
+
- **SortableList** — Item rearrangement and reordering (aka Order List)
|
|
2798
2822
|
- `asChild: boolean` = false — If true, the component will be rendered as its child.
|
|
2799
2823
|
- `onSortEnd: (oldIndex: number, newIndex: number) => void` — Callback called when reordering is completed.
|
|
2800
2824
|
- `disabled: boolean` = false — Whether the entire list is disabled.
|
|
2801
|
-
- **Stats** — A component to highlight key performance indicators and metrics (aka Statistic, Stat, Big Number)
|
|
2825
|
+
- **Stats** — A component to highlight key performance indicators and metrics (aka Statistic, Stat, Big Number, Metric Text)
|
|
2802
2826
|
- `variant: React.ComponentProps<typeof Card>["variant"]` = "outline" — Visual style variant of the card
|
|
2803
2827
|
- `asChild: boolean` = false — If true, the card will be rendered as its child, merging its props onto that child.
|
|
2804
2828
|
- `interactive: boolean` = false — Whether the card is clickable: shows hover and press feedback and a pointer cursor
|
|
@@ -2829,7 +2853,7 @@ or by keyboard focus on its actions, closes the others.
|
|
|
2829
2853
|
- `fullSwipe: "left" | "right" | "both"` — Sides where swiping all the way across runs the outermost action without a tap
|
|
2830
2854
|
(`leftActions[0]` / the last of `rightActions`), as in iOS Mail. Off by default so a
|
|
2831
2855
|
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)
|
|
2856
|
+
- **Table** — Rows and columns for displaying structured data efficiently (aka Structured List, HTML Table)
|
|
2833
2857
|
- `asChild: boolean` = false — Whether to render as a child element.
|
|
2834
2858
|
- `striped: boolean` = false — Whether to show striped (zebra) rows
|
|
2835
2859
|
- `bordered: boolean` = false — Whether to show borders between cells
|
|
@@ -2843,7 +2867,7 @@ destructive action is never triggered by momentum; the action stays available as
|
|
|
2843
2867
|
- `maxHeight: string | number` — Maximum height of the container (enables vertical scrolling)
|
|
2844
2868
|
- `containerClassName: string` — Additional class name for the scroll container
|
|
2845
2869
|
- `card: boolean` = false — Add outer border and border-radius to the container (DataGrid look)
|
|
2846
|
-
- **Tag** — Compact visual descriptors used for labeling or categorizing content (aka Interaction Tag)
|
|
2870
|
+
- **Tag** — Compact visual descriptors used for labeling or categorizing content (aka Interaction Tag, Topic Tag)
|
|
2847
2871
|
- `asChild: boolean` = false — If true, the tag will be rendered as its child, merging its props onto that child.
|
|
2848
2872
|
Cannot be combined with `onDelete` — the delete control is a second element, and
|
|
2849
2873
|
`asChild` requires a single React element child (T99).
|
|
@@ -2861,7 +2885,7 @@ Cannot be combined with `onDelete` — the delete control is a second element, a
|
|
|
2861
2885
|
- `align: "left" | "right" | "alternate"` = "left" — Alignment of the items relative to the line
|
|
2862
2886
|
- `className: string` — Additional class names
|
|
2863
2887
|
- `asChild: boolean` — Whether to render as a child element.
|
|
2864
|
-
- **TreeDiagram** — Lays out a tree such as an org chart from the data alone, with parents centred over their children and collapsible subtrees. (aka Org Chart, Tree Chart, Hierarchy Diagram)
|
|
2888
|
+
- **TreeDiagram** — Lays out a tree such as an org chart from the data alone, with parents centred over their children and collapsible subtrees. (aka Org Chart, Tree Chart, Hierarchy Diagram, Organization Chart)
|
|
2865
2889
|
- `nodes: TreeDiagramNode[]` (required) — The roots of the tree. Several roots are laid out side by side.
|
|
2866
2890
|
- `orientation: "vertical" | "horizontal"` = "vertical" — `vertical` grows from top to bottom (an org chart). `horizontal` grows from left to
|
|
2867
2891
|
right, which suits deep trees and narrow containers.
|
|
@@ -2876,7 +2900,7 @@ this is given; without it the diagram is read-only.
|
|
|
2876
2900
|
anything is measured; long text is truncated and read in full by assistive technology.
|
|
2877
2901
|
- `nodeHeight: number` = 64 — Card height in px.
|
|
2878
2902
|
- `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)
|
|
2903
|
+
- **TreeView** — Hierarchical data (aka Outline View, Tree, Flat Tree, File Tree, Navigation Tree)
|
|
2880
2904
|
- `children: React.ReactNode` — JSX-based items (children API). Use this when not using `nodes`.
|
|
2881
2905
|
- `nodes: TreeViewNode[]` — Node array for data-driven mode.
|
|
2882
2906
|
- `className: string` — Additional class names
|
|
@@ -2898,7 +2922,7 @@ anything is measured; long text is truncated and read in full by assistive techn
|
|
|
2898
2922
|
- `aria-label: string` — Accessible name for the tree. Takes precedence over `labels.treeAriaLabel`.
|
|
2899
2923
|
- `aria-labelledby: string` — ID of the element that labels the tree. Takes precedence over `aria-label`.
|
|
2900
2924
|
- `styles: { root?: string; item?: string; search?: string; searchInput?: string; labelContainer?: string; iconWrapper?: string; expandBtn?: string; checkbox?: string; icon?: string; }` — Custom styles for internal parts
|
|
2901
|
-
- **VirtualList** — Efficiently renders large lists by virtualizing off-screen items
|
|
2925
|
+
- **VirtualList** — Efficiently renders large lists by virtualizing off-screen items (aka Virtual Scroller, Virtualizer, Virtual Scroll)
|
|
2902
2926
|
- `items: T[]` (required) — Array of items to display
|
|
2903
2927
|
- `itemHeight: number` (required) — Height of each row (px)
|
|
2904
2928
|
- `height: number | string` (required) — Total height of the list (px)
|
|
@@ -2919,7 +2943,7 @@ anything is measured; long text is truncated and read in full by assistive techn
|
|
|
2919
2943
|
- `defaultOpen: boolean` = false — Initial open state for uncontrolled usage.
|
|
2920
2944
|
@default false
|
|
2921
2945
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the sheet is opened or closed.
|
|
2922
|
-
- **Confirm** — Opens a confirmation dialog from code with await confirm() and returns true or false.
|
|
2946
|
+
- **Confirm** — Opens a confirmation dialog from code with await confirm() and returns true or false. (aka Alert Dialog, Confirmation Dialog, Confirm Dialog)
|
|
2923
2947
|
- **ContextMenu** — Right-click menus
|
|
2924
2948
|
- `children: ReactNode` (required) — Element that opens the context menu on right-click.
|
|
2925
2949
|
- `menu: ReactNode` (required) — Menu items to display in the context menu
|
|
@@ -2940,7 +2964,7 @@ interrupts the user and needs a response before they can continue, such as
|
|
|
2940
2964
|
confirming a destructive action. An alert dialog does not close when the
|
|
2941
2965
|
overlay is clicked unless closeOnOverlayClick is set; Escape still closes it.
|
|
2942
2966
|
@default "dialog"
|
|
2943
|
-
- **Drawer** — Slide-out detail panels (aka Navigation Drawer, Overlay Drawer, Side Panel)
|
|
2967
|
+
- **Drawer** — Slide-out detail panels (aka Navigation Drawer, Overlay Drawer, Side Panel, Side Sheet)
|
|
2944
2968
|
- `children: React.ReactNode` (required) — Drawer parts (DrawerTrigger, DrawerContent, etc.).
|
|
2945
2969
|
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
2946
2970
|
- `onOpenChange: (open: boolean) => void` — Called with the next state when the drawer is opened or closed.
|
|
@@ -2952,7 +2976,7 @@ overlay is clicked unless closeOnOverlayClick is set; Escape still closes it.
|
|
|
2952
2976
|
@default true
|
|
2953
2977
|
- `slideOut: boolean` = true — Whether to animate the drawer when closing.
|
|
2954
2978
|
@default true
|
|
2955
|
-
- **Dropdown** — Overlay selection menu (aka Overflow Menu, Kebab Menu, Meatball Menu, Vertical Ellipsis, Horizontal Ellipsis, Three Dots Menu, More Menu, App Switcher, オーバーフローメニュー, ケバブメニュー, ミートボールメニュー, Menu Button)
|
|
2979
|
+
- **Dropdown** — Overlay selection menu (aka Overflow Menu, Kebab Menu, Meatball Menu, Vertical Ellipsis, Horizontal Ellipsis, Three Dots Menu, More Menu, App Switcher, オーバーフローメニュー, ケバブメニュー, ミートボールメニュー, Menu Button, Action Menu, Dropdown Menu)
|
|
2956
2980
|
- `children: ReactNode` (required) — Dropdown parts (Dropdown.Trigger and Dropdown.Menu).
|
|
2957
2981
|
- `asChild: boolean` = false — If true, the dropdown will be rendered as its child, merging its props onto that child.
|
|
2958
2982
|
- `defaultOpen: boolean` = false — Whether the menu starts open. Use it for a screenshot, a test, or a menu that should
|
|
@@ -2960,7 +2984,7 @@ already be showing. Ignored once `open` is provided.
|
|
|
2960
2984
|
- `open: boolean` — Controls the open state from the outside. Pass it together with `onOpenChange`.
|
|
2961
2985
|
- `onOpenChange: (open: boolean) => void` — Called with the next open state, both when the trigger is used and when the menu is
|
|
2962
2986
|
dismissed by an outside click or Escape.
|
|
2963
|
-
- **FocusTrap** — Focus management
|
|
2987
|
+
- **FocusTrap** — Focus management (aka Trap Focus, Focus Scope)
|
|
2964
2988
|
- `children: React.ReactNode` (required) — Content to trap focus within.
|
|
2965
2989
|
- `active: boolean` = true — Whether the trap is active.
|
|
2966
2990
|
@default true
|
|
@@ -2970,14 +2994,14 @@ destructive confirmation), or to the first focusable element when nothing
|
|
|
2970
2994
|
is marked.
|
|
2971
2995
|
@default true
|
|
2972
2996
|
- `className: string` — Additional CSS class name.
|
|
2973
|
-
- **HoverCard** — Rich content on hover
|
|
2997
|
+
- **HoverCard** — Rich content on hover (aka Preview Card, Preview Trigger)
|
|
2974
2998
|
- `children: ReactNode` (required) — Hover card parts (HoverCardTrigger and HoverCardContent).
|
|
2975
2999
|
- `className: string` — Additional CSS class name for the container.
|
|
2976
3000
|
- `openDelay: number` = 700 — Delay before showing the hover card in ms.
|
|
2977
3001
|
- `closeDelay: number` = 300 — Delay before hiding the hover card in ms.
|
|
2978
3002
|
- `open: boolean` — If provided, controls the open state.
|
|
2979
3003
|
- `onOpenChange: (open: boolean) => void` — Callback when open state changes.
|
|
2980
|
-
- **Menu** — General menus
|
|
3004
|
+
- **Menu** — General menus (aka Action List, Tiered Menu, Panel Menu, Nav List)
|
|
2981
3005
|
- ⚠️ Not the same as elsewhere: In macOS, a "Menu" is the pull-down from a menu bar. WIM's `Menu` is the list of choices itself; for one that opens from a trigger, use `Dropdown`.
|
|
2982
3006
|
- `children: ReactNode` (required) — Menu items (MenuItem, MenuItemGroup, SubMenu, MenuDivider).
|
|
2983
3007
|
- `className: string` — Additional CSS class name for the container.
|
|
@@ -2986,7 +3010,7 @@ is marked.
|
|
|
2986
3010
|
- `defaultOpenKeys: string[]` = [] — Default opened submenu keys
|
|
2987
3011
|
- `aria-label: string` — Accessible name for the menu.
|
|
2988
3012
|
- `aria-labelledby: string` — ID of the element that labels the menu. Takes precedence over `aria-label`.
|
|
2989
|
-
- **Popconfirm** — Confirmation overlay
|
|
3013
|
+
- **Popconfirm** — Confirmation overlay (aka Confirm Popup)
|
|
2990
3014
|
- `title: ReactNode` (required) — The title of the confirmation box
|
|
2991
3015
|
- `description: ReactNode` — The description of the confirmation box
|
|
2992
3016
|
- `onConfirm: () => void` — Callback when the user clicks the confirm button
|
|
@@ -2997,7 +3021,7 @@ is marked.
|
|
|
2997
3021
|
- `children: ReactNode` (required) — The target element which the Popconfirm will be attached to
|
|
2998
3022
|
- `icon: ReactNode` — Customize the icon
|
|
2999
3023
|
- `disabled: boolean` = false — Whether to show the popconfirm
|
|
3000
|
-
- **Popover** — Contextual overlay (aka Info Label, Info Button, Toggletip)
|
|
3024
|
+
- **Popover** — Contextual overlay (aka Info Label, Info Button, Toggletip, Overlay Panel, Contextual Help, Drop Button, Inline Dialog, Popup)
|
|
3001
3025
|
- `children: ReactNode` (required) — Popover parts (PopoverTrigger, PopoverContent, etc.).
|
|
3002
3026
|
- `className: string` — Additional CSS class name for the container.
|
|
3003
3027
|
- `defaultOpen: boolean` = false — If true, the popover component will manage its own open state.
|
|
@@ -3008,7 +3032,7 @@ is marked.
|
|
|
3008
3032
|
- **Portal** — Out-of-hierarchy render
|
|
3009
3033
|
- `children: React.ReactNode` (required) — The content to be rendered in the portal
|
|
3010
3034
|
- `container: HTMLElement | null` — The container where the portal will be rendered. Defaults to document.body
|
|
3011
|
-
- **Tooltip** — Information on hover (aka Help Tag)
|
|
3035
|
+
- **Tooltip** — Information on hover (aka Help Tag, Tip)
|
|
3012
3036
|
- `children: ReactNode` (required) — Tooltip parts (TooltipTrigger and TooltipContent).
|
|
3013
3037
|
- `className: string` — Additional CSS class name for the container.
|
|
3014
3038
|
- `delay: number` = 200 — Delay before showing the tooltip in ms.
|
|
@@ -3028,21 +3052,21 @@ is marked.
|
|
|
3028
3052
|
- `cite: React.ReactNode` — Source of the quote, rendered in a `<cite>` element.
|
|
3029
3053
|
- `border: boolean` = true — Whether to show the left border.
|
|
3030
3054
|
@default true
|
|
3031
|
-
- **Code** — Code snippets
|
|
3055
|
+
- **Code** — Code snippets (aka Inline Code)
|
|
3032
3056
|
- `asChild: boolean` = false — If true, the code will be rendered as its child, merging its props onto that child.
|
|
3033
3057
|
- `children: React.ReactNode` — Code to display. Ignored when `code` is set (unless asChild is true).
|
|
3034
3058
|
- `code: string` — Code string to display. Takes precedence over children.
|
|
3035
3059
|
- `block: boolean` = false — If true, renders as a block (`<pre>`) instead of inline.
|
|
3036
3060
|
@default false
|
|
3037
3061
|
- `language: string` — Language identifier appended as a `language-<lang>` class for syntax highlighters.
|
|
3038
|
-
- **Highlight** — Text highlighting
|
|
3062
|
+
- **Highlight** — Text highlighting (aka Mark, Highlighter)
|
|
3039
3063
|
- `children: React.ReactNode` (required) — The full text to highlight substrings in.
|
|
3040
3064
|
- `highlight: string | string[]` (required) — Substring(s) to highlight.
|
|
3041
3065
|
- `highlightClassName: string` — Custom class name for the highlighted `<mark>` element.
|
|
3042
3066
|
- `highlightStyles: React.CSSProperties` — Custom styles for the highlighted `<mark>` element.
|
|
3043
3067
|
- `as: React.ElementType` = "span" — The HTML tag or component to use for the container. Default is "span".
|
|
3044
3068
|
- `asChild: boolean` = false — If true, the component will be rendered as its child.
|
|
3045
|
-
- **Kbd** — Keyboard shortcuts
|
|
3069
|
+
- **Kbd** — Keyboard shortcuts (aka Key Combo, Keybinding Hint, Keyboard Key, Keyboard)
|
|
3046
3070
|
- `asChild: boolean` = false — If true, the Kbd will be rendered as its child, merging its props onto that child.
|
|
3047
3071
|
- `size: "sm" | "md" | "lg"` = "md" — Size of the key cap.
|
|
3048
3072
|
@default "md"
|
|
@@ -3099,7 +3123,7 @@ Defaults to the localized `form.optional` string.
|
|
|
3099
3123
|
@default t("spoiler.show_more")
|
|
3100
3124
|
- `hideLabel: React.ReactNode` — Label of the toggle while expanded.
|
|
3101
3125
|
@default t("spoiler.show_less")
|
|
3102
|
-
- **Text** — Has appropriate line-height and spacing to ensure readability of long text. (aka Truncated Text)
|
|
3126
|
+
- **Text** — Has appropriate line-height and spacing to ensure readability of long text. (aka Truncated Text, Truncate, Paragraph)
|
|
3103
3127
|
- `asChild: boolean` = false — If true, the text will be rendered as its child, merging its props onto that child.
|
|
3104
3128
|
- `size: "xs" | "sm" | "md" | "lg" | "xl"` = "md" — Font size of the text.
|
|
3105
3129
|
@default "md"
|
|
@@ -3127,7 +3151,7 @@ used for "just stop at three lines".
|
|
|
3127
3151
|
|
|
3128
3152
|
Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
3129
3153
|
- `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.
|
|
3154
|
+
- **Title** — Possesses visual weight (boldness/size) to indicate page structure. (aka Heading)
|
|
3131
3155
|
- `asChild: boolean` = false — If true, the heading will be rendered as its child, merging its props onto that child.
|
|
3132
3156
|
- `tag: "h1" | "h2" | "h3" | "h4" | "h5" | "h6"` = "h1" — The semantic HTML tag to use.
|
|
3133
3157
|
- `size: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl"` = "xl" — The visual size of the title.
|
|
@@ -3139,7 +3163,7 @@ Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
|
3139
3163
|
|
|
3140
3164
|
### media — `import { … } from "wimui/media"`
|
|
3141
3165
|
|
|
3142
|
-
- **Audio** — Audio playback
|
|
3166
|
+
- **Audio** — Audio playback (aka Audio Player)
|
|
3143
3167
|
- `src: string | string[] | AudioTrack | AudioTrack[]` — Source: a URL, list of URLs, or track object(s)
|
|
3144
3168
|
- `autoPlay: boolean` = false — Whether to start playing automatically
|
|
3145
3169
|
- `loop: boolean` = false — Whether to loop playback
|
|
@@ -3164,7 +3188,7 @@ Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
|
3164
3188
|
- `demoDelay: number` — Demo only: milliseconds to intentionally delay load completion
|
|
3165
3189
|
- `labels: { seek?: string; mute?: string; unmute?: string; volume?: string; play?: string; pause?: string; next?: string; prev?: string; repeatMode0?: string; // Off repeatMode1?: string; // One repeatMode2?: string; // All shuffle?: string; playbackSpeed?: string; bassBoost?: string; sleepTimer?: string; unknownTitle?: string; unknownArtist?: string; }` = {} — Labels for manual translation
|
|
3166
3190
|
- `tracks: React.ComponentPropsWithoutRef<"track">[]` — Subtitle/caption tracks passed as <track> elements (kind, src, srcLang, label).
|
|
3167
|
-
- **Gallery** — Displays a responsive image grid with configurable columns, aspect ratios, multi-select, and an optional lightbox.
|
|
3191
|
+
- **Gallery** — Displays a responsive image grid with configurable columns, aspect ratios, multi-select, and an optional lightbox. (aka Galleria)
|
|
3168
3192
|
- `items: GalleryItem[]` (required) — Images to display in the gallery
|
|
3169
3193
|
- `columns: number` = 3 — Number of grid columns. Default: 3.
|
|
3170
3194
|
- `gap: "xs" | "sm" | "md" | "lg" | "xl"` = "md" — Gap between items. Default: "md".
|
|
@@ -3184,7 +3208,7 @@ Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
|
3184
3208
|
`"warning"`, `"info"`, `"primary"`, `"secondary"`, `"tertiary"`,
|
|
3185
3209
|
`"disabled"` — and, like `Text`, any design token colour name such as
|
|
3186
3210
|
`"text-tertiary"`, or any CSS colour value.
|
|
3187
|
-
- **Image** — Image content
|
|
3211
|
+
- **Image** — Image content (aka Thumbnail)
|
|
3188
3212
|
- `src: string` (required) — Source URL of the image
|
|
3189
3213
|
- `alt: string` (required) — Alternative text for the image
|
|
3190
3214
|
- `width: string | number` — Width of the image
|
|
@@ -3211,7 +3235,7 @@ Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
|
3211
3235
|
- `demoDelay: number` — Demo only: milliseconds to intentionally delay load completion
|
|
3212
3236
|
- `priority: boolean` = false — Whether to raise loading priority (e.g. an LCP candidate; sets fetchpriority="high")
|
|
3213
3237
|
- `fallback: React.ReactNode` — Custom element shown when loading fails
|
|
3214
|
-
- **ImageCompare** — ImageCompare overlays two images and reveals them with a draggable divider — a before/after slider for comparing edits, restorations, or AI-generated results against their source.
|
|
3238
|
+
- **ImageCompare** — ImageCompare overlays two images and reveals them with a draggable divider — a before/after slider for comparing edits, restorations, or AI-generated results against their source. (aka Compare Slider)
|
|
3215
3239
|
- `before: string` (required) — Source URL of the "before" image (revealed on the leading side)
|
|
3216
3240
|
- `after: string` (required) — Source URL of the "after" image (revealed on the trailing side)
|
|
3217
3241
|
- `beforeAlt: string` = "" — Alternative text for the before image
|
|
@@ -3233,7 +3257,7 @@ Ignored when `truncate` is set (one line wins; they cannot both apply).
|
|
|
3233
3257
|
- `onOpenChange: (open: boolean) => void` — Callback when the open state changes
|
|
3234
3258
|
- `defaultOpen: boolean` = false — Initial open state for uncontrolled usage
|
|
3235
3259
|
- `defaultIndex: number` = 0 — Index of the item shown first
|
|
3236
|
-
- **Video** — A component for embedding and controlling local or remote video content
|
|
3260
|
+
- **Video** — A component for embedding and controlling local or remote video content (aka Video Player)
|
|
3237
3261
|
- `src: string` — Source URL of the video
|
|
3238
3262
|
- `width: string | number` — Width of the video. A number is px; a string is used as is. Never wider than its container. Defaults to 100%.
|
|
3239
3263
|
- `height: string | number` — Height of the video
|
|
@@ -3478,7 +3502,7 @@ enough on its own.
|
|
|
3478
3502
|
- `max: number` — Upper bound of the y-axis domain (defaults to the data maximum)
|
|
3479
3503
|
- `ariaLabel: string` — Accessible label describing the trend; when omitted the sparkline is hidden from assistive tech
|
|
3480
3504
|
- `className: string` — Additional class names
|
|
3481
|
-
- **Treemap** — Hierarchical data area-based display
|
|
3505
|
+
- **Treemap** — Hierarchical data area-based display (aka Distribution)
|
|
3482
3506
|
- `data: ChartDataPoint[]` (required) — Data to display in the treemap.
|
|
3483
3507
|
- `dataKey: string` (required) — The key in the data objects that represents the size of the rectangle.
|
|
3484
3508
|
- `aspectRatio: number` = 4 / 3 — The aspect ratio of the rectangles.
|
|
@@ -3522,7 +3546,7 @@ to a heading or in the corner of a card.
|
|
|
3522
3546
|
- `defaultOpen: boolean` — Opens the explanation on the first render (uncontrolled).
|
|
3523
3547
|
- `open: boolean` — Controls whether the explanation is open.
|
|
3524
3548
|
- `onOpenChange: (open: boolean) => void` — Called when the explanation opens or closes.
|
|
3525
|
-
- **AIResponseFeedback** — Thumbs-up/down feedback controls and regenerate button for AI responses.
|
|
3549
|
+
- **AIResponseFeedback** — Thumbs-up/down feedback controls and regenerate button for AI responses. (aka Thumbs Rating)
|
|
3526
3550
|
- `feedback: ("positive" | "negative") | null` — Currently selected feedback value (controlled)
|
|
3527
3551
|
- `defaultFeedback: ("positive" | "negative") | null` = null — Default feedback value (uncontrolled)
|
|
3528
3552
|
- `onFeedback: (value: ("positive" | "negative") | null) => void` — Called when user clicks a feedback button. Passes null when deselected.
|
|
@@ -3537,8 +3561,8 @@ to a heading or in the corner of a card.
|
|
|
3537
3561
|
- `children: React.ReactNode` (required) — Main content
|
|
3538
3562
|
- `showFullscreenToggle: boolean` = false — Whether to show a full-screen toggle (default: false)
|
|
3539
3563
|
- `className: string` — Additional CSS class
|
|
3540
|
-
- **ChatUI** — A comprehensive set of components for building chat interfaces with support for messages, avatars, timestamps, and interactive input.
|
|
3541
|
-
- **CodeBlock** — Syntax-highlighted code block with copy button, line numbers, and collapsible overflow. (aka Code Snippet)
|
|
3564
|
+
- **ChatUI** — A comprehensive set of components for building chat interfaces with support for messages, avatars, timestamps, and interactive input. (aka Chat, AI Chat Dialogue)
|
|
3565
|
+
- **CodeBlock** — Syntax-highlighted code block with copy button, line numbers, and collapsible overflow. (aka Code Snippet, Code Highlight)
|
|
3542
3566
|
- `code: string` (required) — The code string to display
|
|
3543
3567
|
- `language: string` — Programming language label shown in the header (e.g. "tsx", "bash")
|
|
3544
3568
|
- `filename: string` — Optional filename shown in the header instead of the language label
|
|
@@ -3548,7 +3572,7 @@ to a heading or in the corner of a card.
|
|
|
3548
3572
|
Pass a CSS value (e.g. "300px") or a number of lines (e.g. 20).
|
|
3549
3573
|
When set, an expand/collapse toggle is shown.
|
|
3550
3574
|
- `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.
|
|
3575
|
+
- **CodeDiffViewer** — Displays code changes as a side-by-side or unified diff, with line-level highlighting and Apply/Reject actions. (aka Code Comparison)
|
|
3552
3576
|
- `before: string` (required) — Code before the change
|
|
3553
3577
|
- `after: string` (required) — Code after the change
|
|
3554
3578
|
- `language: string` — Language label shown in header
|
|
@@ -3568,7 +3592,7 @@ When set, an expand/collapse toggle is shown.
|
|
|
3568
3592
|
- `showGrid: boolean` — Whether to show the background grid
|
|
3569
3593
|
- `showMiniMap: boolean` — Whether to show the minimap
|
|
3570
3594
|
- `showControls: boolean` — Whether to show controls
|
|
3571
|
-
- **MarkdownRenderer** — MarkdownRenderer converts a markdown string into WIM UI components. It uses react-markdown under the hood and applies WIM's typography system.
|
|
3595
|
+
- **MarkdownRenderer** — MarkdownRenderer converts a markdown string into WIM UI components. It uses react-markdown under the hood and applies WIM's typography system. (aka Markdown Render)
|
|
3572
3596
|
- `content: string` (required) — The markdown string to render
|
|
3573
3597
|
- `baseLevel: (typeof TITLE_SIZE_STEPS)[number]` = "2xl" — Visual size of markdown `h1`. `h2`–`h4` step one Title size down from this,
|
|
3574
3598
|
clamped at `xs`. Does not change the HTML heading tag — that stays as
|
|
@@ -3588,7 +3612,7 @@ written in the markdown. Default `"2xl"` keeps the historical mapping
|
|
|
3588
3612
|
- `showContext: boolean` = true — Whether to show the context-length metadata in the dropdown
|
|
3589
3613
|
- `labels: { /** Placeholder shown when nothing is selected */ placeholder?: string; /** Prefix for the context-length meta (default "Context") */ contextLabel?: string; /** Prefix for the input price meta (default "In") */ inputLabel?: string; /** Prefix for the output price meta (default "Out") */ outputLabel?: string; /** Suffix appended to prices (default "/1M") */ perTokensLabel?: string; /** Accessible label for the trigger button */ triggerAriaLabel?: string; }` — Labels for internationalization
|
|
3590
3614
|
- `className: string` — Additional class names
|
|
3591
|
-
- **PromptInput** — Interactive input optimized for AI prompt engineering with multi-line support and action triggers.
|
|
3615
|
+
- **PromptInput** — Interactive input optimized for AI prompt engineering with multi-line support and action triggers. (aka AI Chat Input)
|
|
3592
3616
|
- `value: string` — Current text value (controlled)
|
|
3593
3617
|
- `defaultValue: string` = "" — Default value (uncontrolled)
|
|
3594
3618
|
- `onChange: (value: string) => void` — Callback when value changes
|
|
@@ -3779,14 +3803,55 @@ Exported hooks. Prefer them over hand-rolled equivalents (`matchMedia` listeners
|
|
|
3779
3803
|
```
|
|
3780
3804
|
|
|
3781
3805
|
|
|
3806
|
+
## Not a component — compose it from existing ones
|
|
3807
|
+
|
|
3808
|
+
These names exist in other systems' vocabularies. wimui does not ship them as components because existing components already express them; build them from the components named here instead of hand-rolling new markup.
|
|
3809
|
+
|
|
3810
|
+
- **Radio Card** (aka Checkbox Card, Radio Card Group, Tile Group, Radio Tile, Selectable Tile, Select Box Group) — A card-shaped choice. Put a `Radio` (one choice) or `Checkbox` (several) with its label and description inside a `Card`, and group them with `RadioGroup` / `CheckboxGroup` so the keyboard and form value stay native.
|
|
3811
|
+
- **Native Select** — Use a plain `<select>` element; when it must match WIM styling and behaviour, use `Select`.
|
|
3812
|
+
- **Toggle Button** — A single press-and-stay button (`aria-pressed`): a `ToggleGroup` with `selectionMode="multiple"` and one option. For an on/off setting, use `Switch`.
|
|
3813
|
+
- **Collapsible** — A single show/hide section: an `Accordion` with one item and `collapsible`.
|
|
3814
|
+
- **Navigation Menu** (aka Mega Menu, Megamenu) — Site-level navigation with dropdown panels: a row of `Dropdown`s whose items are links, inside `Navbar` or `Header`.
|
|
3815
|
+
- **Navigation Progress** (aka NProgress, Top Loading Bar, Page Progress Bar) — A thin bar at the top of the page while a route loads: a `Progress` (use `indeterminate` when the duration is unknown) kept at the top edge with `Affix` (`offsetTop={0}`).
|
|
3816
|
+
- **Timezone Select** (aka Time Zone Picker) — A searchable list of time zones: a `Combobox` whose `options` come from `Intl.supportedValuesOf("timeZone")`.
|
|
3817
|
+
- **Swap** — Swapping one icon for another (open/close chevron, play/pause): render the two `Icon`s conditionally and animate the change with `Transition`. Keep the accessible name on the button, not the icon.
|
|
3818
|
+
- **Counter Badge** (aka Notification Badge, Counter Label) — A count such as "99+": pass the text to `Badge`'s `content`. To pin it to the corner of another element, use `Indicator`.
|
|
3819
|
+
- **Compound Button** — A button with a second line of description: put two lines of text inside `Button` (a short label first, the description in `Text` below it).
|
|
3820
|
+
- **Inline Drawer** — A side panel that pushes the content aside instead of overlaying it: a `Splitter` (resizable) or a `Flex` row whose side pane is shown with `Transition`.
|
|
3821
|
+
- **Expandable Search** — A search icon that opens into a field: an `IconButton` that reveals a `SearchInput` and moves focus into it.
|
|
3822
|
+
- **Tearsheet** — A large task surface over the page: a `Dialog` or a `Drawer` holding the task. Neither has an extra-wide preset, so set the content width with your own class.
|
|
3823
|
+
- **Notifications Panel** — A panel listing recent notifications: a `List` inside a `Popover` (from a bell `IconButton`) or a `Drawer`.
|
|
3824
|
+
- **Guide Banner** (aka Interstitial Screen) — Onboarding guidance: a dismissible `Banner` in the page, or a `Dialog` containing a `Carousel` of steps for a first-run screen. For pointing at parts of the UI, use `Tour`.
|
|
3825
|
+
- **Options Tile** — A tile that expands to reveal settings: an `Accordion` item styled with the `Card` surface.
|
|
3826
|
+
- **Add Select** — Picking items from a catalogue to add: a `Dialog` containing `Transfer` (two lists) or `MultiSelect`.
|
|
3827
|
+
- **Chat Button** (aka AI Skeleton) — AI-styled controls and loading placeholders: a regular `Button` or `Skeleton` marked with `AILabel`. WIM does not give AI content a separate visual style.
|
|
3828
|
+
- **Shape Indicator** — A status shown by shape as well as colour: an `Icon` whose shape differs per status, followed by the status text.
|
|
3829
|
+
- **Status Dot** (aka Status Light) — A coloured dot before a status label: an `Indicator` with `inline`, followed by the status text. Never rely on the colour alone. For a person's availability, use `Presence`.
|
|
3830
|
+
- **Multistep Dialog** (aka Wizard Dialog) — A dialog that walks through steps: a `Dialog` with a `Stepper` at the top and the current step's content below.
|
|
3831
|
+
- **Compound Tag** — A two-part "key: value" tag: put the key and the value as two pieces of text inside one `Tag`.
|
|
3832
|
+
- **Entity Title** — An icon, title and subtitle as one unit: `Group` with an `Icon`, a `Title` and a `Text`. For a person, use `Persona`.
|
|
3833
|
+
- **Index Filters** (aka Filter Bar, Data Filters) — A filter bar above a table: a `SearchInput` plus `Select` / `MultiSelect` controls, with the active filters shown as removable `Chip`s (`onDelete`).
|
|
3834
|
+
- **Contextual Save Bar** — A bar announcing unsaved changes with Save and Discard: a `Banner` (or content kept in view with `Affix`) holding two `Button`s.
|
|
3835
|
+
- **Data View** — Switching a collection between list and grid: a `SegmentedControl` that swaps between `List` and `SimpleGrid`.
|
|
3836
|
+
- **Callout Card** — A promotional card with an illustration and a call to action: a `Card` with an `Image` and a `Button`.
|
|
3837
|
+
- **Slider Input** — A slider with a number field beside it: a `Slider` and a `NumberInput` bound to the same value.
|
|
3838
|
+
|
|
3782
3839
|
## Not in scope — deliberately not provided
|
|
3783
3840
|
|
|
3784
3841
|
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
3842
|
|
|
3786
|
-
- **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.
|
|
3843
|
+
- **Parallax Scrolling** (aka Parallax, Scroll Parallax, Parallax Hero, Parallax Hero Images, Parallax Scroll, Hero Parallax, Sticky Scroll Reveal, Macbook Scroll, Container Scroll Animation) — 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.
|
|
3844
|
+
- **Text Scramble** (aka Scramble Text, Decrypt Text, Glitch Text, Hyper Text, Encrypted 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
3845
|
- **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
|
-
- **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.
|
|
3846
|
+
- **Choropleth Map** (aka Choropleth, Filled Map, Region Map, Geo Map, World 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.
|
|
3847
|
+
- **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, Canvas Text, Layout Text Flip, Colourful Text, Squiggly Text, Text Generate Effect, Typewriter Effect, Flip Words, Text Hover Effect, Container Text Flip, Hero Highlight, Text Reveal Card, Text Flipping Board, Text Rotate, Pointer Highlight, Container Cover) — 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.
|
|
3848
|
+
- **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, Dotted Glow Background, Background Ripple Effect, Sparkles, Background Gradient, Gradient Animation, Wavy Background, Background Boxes, Background Beams, Background Beams With Collision, Background Lines, Aurora Background, Glowing Stars, Shooting Stars, Vortex, Background Cubes Grid, Cloud Shader, Grid and Dot Backgrounds, Noise Background, Dither Shader, Webcam Pixel Grid, Matrix Trail, Lamp Effect, Scales) — 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.
|
|
3849
|
+
- **Animated Button Effects** (aka Shimmer Button, Shiny Button, Rainbow Button, Pulsating Button, Ripple Button, Interactive Hover Button, Animated Subscribe Button, Confetti, Cool Mode, Magnetic Button, Stateful Button, Pixel Prompt Button, Paper Plane Send) — 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.
|
|
3850
|
+
- **Glow and Spotlight Card** (aka Magic Card, Neon Gradient Card, Shine Border, Glare Hover, Lens, Progressive Blur, Blur Fade, Pixel Image, 3D Card Effect, Evervault Card, Card Hover Effect, Wobble Card, Card Spotlight, Focus Cards, Comet Card, Glare Card, Direction Aware Hover, Glowing Effect, Hover Border Gradient, Moving Border, Liquid Glass, Chromatic Image, Canvas Reveal Effect, SVG Mask Effect, Hover 3D, Aura) — 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.
|
|
3851
|
+
- **Device Mockup** (aka iPhone Mockup, Android Mockup, Safari Mockup, Browser Frame, Device Frame, Mockup) — 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.
|
|
3852
|
+
- **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, GitHub Globe, 3D Globe, Paper Plane Globe, Floating Dock, Following Pointer, 3D Pin, 3D Marquee, Gravity Trail, Image Particles, Image Wave, Disintegrating Gallery, ASCII Art, Pixelated Canvas, SVG Path Morphing, Google Gemini Effect, Tracing Beam, Images Badge, Direction Aware Selection, Card Stack, Draggable Card, Infinite Card Grid, Grid Zoom Image, Hover Image Links, Hover Gallery, Image Generation Loader, Notch, Fluid Notch) — 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.
|
|
3853
|
+
- **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.
|
|
3854
|
+
- **Animated Input Effects** (aka Placeholders And Vanish Input, Gooey Input, Gooey Waitlist) — Input fields whose placeholder cycles through phrases, whose text dissolves on submit, or whose outline stretches like goo. A moving placeholder changes before it can be read and is no substitute for a label. Report the result of a submission through the field's state and an announcement. Use `Input` instead.
|
|
3790
3855
|
|
|
3791
3856
|
---
|
|
3792
3857
|
**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.
|