wimui 0.70.0 → 0.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/_internal/useAnnounce.cjs +1 -1
- package/dist/components/_internal/useAnnounce.d.ts +22 -0
- package/dist/components/_internal/useAnnounce.js +36 -19
- package/dist/components/ai/CodeDiffViewer/CodeDiffViewer.cjs +2 -2
- package/dist/components/ai/CodeDiffViewer/CodeDiffViewer.js +106 -105
- package/dist/components/ai/StreamingText/StreamingText.cjs +1 -1
- package/dist/components/ai/StreamingText/StreamingText.d.ts +1 -1
- package/dist/components/ai/StreamingText/StreamingText.js +37 -23
- package/dist/components/data-display/DataGrid/DataGrid.cjs +1 -1
- package/dist/components/data-display/DataGrid/DataGrid.js +41 -40
- package/dist/components/data-display/InfiniteScroll/InfiniteScroll.cjs +1 -1
- package/dist/components/data-display/InfiniteScroll/InfiniteScroll.d.ts +1 -1
- package/dist/components/data-display/InfiniteScroll/InfiniteScroll.js +37 -26
- package/dist/components/data-display/List/List.cjs +1 -1
- package/dist/components/data-display/List/List.d.ts +5 -1
- package/dist/components/data-display/List/List.js +3 -3
- package/dist/components/feedback/Spinner/Spinner.cjs +1 -1
- package/dist/components/feedback/Spinner/Spinner.js +53 -43
- package/dist/components/form/Combobox/Combobox.cjs +1 -1
- package/dist/components/form/Combobox/Combobox.js +48 -47
- package/dist/components/form/Transfer/Transfer.cjs +1 -1
- package/dist/components/form/Transfer/Transfer.js +0 -1
- package/dist/components/media/Gallery/Gallery.cjs +1 -1
- package/dist/components/media/Gallery/Gallery.js +111 -110
- package/dist/components/media/Lightbox/Lightbox.cjs +1 -1
- package/dist/components/media/Lightbox/Lightbox.d.ts +2 -1
- package/dist/components/media/Lightbox/Lightbox.js +3 -3
- package/dist/hooks/useBreakpoint.d.ts +1 -0
- package/dist/i18n/generated/data-display.cjs +1 -1
- package/dist/i18n/generated/data-display.d.ts +1 -1
- package/dist/i18n/generated/data-display.js +6 -3
- package/dist/index.cjs +1 -1
- package/dist/index.js +18 -18
- package/dist/llms/AIResponseFeedback.md +26 -0
- package/dist/llms/Accordion.md +47 -0
- package/dist/llms/Affix.md +25 -0
- package/dist/llms/AgentStatus.md +25 -0
- package/dist/llms/Alert.md +28 -0
- package/dist/llms/Anchor.md +30 -0
- package/dist/llms/AppShell.md +52 -0
- package/dist/llms/AreaChart.md +27 -0
- package/dist/llms/ArtifactsOverlay.md +27 -0
- package/dist/llms/AspectRatio.md +22 -0
- package/dist/llms/Audio.md +44 -0
- package/dist/llms/Autosave.md +23 -0
- package/dist/llms/Avatar.md +27 -0
- package/dist/llms/AvatarGroup.md +28 -0
- package/dist/llms/BackTop.md +32 -0
- package/dist/llms/Badge.md +28 -0
- package/dist/llms/Banner.md +28 -0
- package/dist/llms/BarChart.md +26 -0
- package/dist/llms/Barcode.md +26 -0
- package/dist/llms/BentoGrid.md +25 -0
- package/dist/llms/Blockquote.md +26 -0
- package/dist/llms/BottomSheet.md +26 -0
- package/dist/llms/Box.md +44 -0
- package/dist/llms/BoxPlot.md +25 -0
- package/dist/llms/Breadcrumb.md +31 -0
- package/dist/llms/Button.md +33 -0
- package/dist/llms/ButtonGroup.md +27 -0
- package/dist/llms/Calendar.md +34 -0
- package/dist/llms/CalendarHeatmap.md +33 -0
- package/dist/llms/CandlestickChart.md +25 -0
- package/dist/llms/Canvas.md +13 -0
- package/dist/llms/Card.md +41 -0
- package/dist/llms/Carousel.md +33 -0
- package/dist/llms/Cascader.md +40 -0
- package/dist/llms/Center.md +40 -0
- package/dist/llms/Charts.md +13 -0
- package/dist/llms/ChatUI.md +17 -0
- package/dist/llms/Checkbox.md +24 -0
- package/dist/llms/CheckboxGroup.md +32 -0
- package/dist/llms/Chip.md +36 -0
- package/dist/llms/Code.md +25 -0
- package/dist/llms/CodeBlock.md +27 -0
- package/dist/llms/CodeDiffViewer.md +30 -0
- package/dist/llms/ColorInput.md +48 -0
- package/dist/llms/ColorPicker.md +46 -0
- package/dist/llms/Combobox.md +37 -0
- package/dist/llms/CommandPalette.md +25 -0
- package/dist/llms/Comment.md +35 -0
- package/dist/llms/Container.md +45 -0
- package/dist/llms/ContextMenu.md +25 -0
- package/dist/llms/ContrastChecker.md +13 -0
- package/dist/llms/Controls.md +13 -0
- package/dist/llms/CopyButton.md +26 -0
- package/dist/llms/Countdown.md +31 -0
- package/dist/llms/CounterTextarea.md +32 -0
- package/dist/llms/CreditCardInput.md +42 -0
- package/dist/llms/Dashboard.md +31 -0
- package/dist/llms/DataGrid.md +43 -0
- package/dist/llms/DatePicker.md +39 -0
- package/dist/llms/DateRangePicker.md +30 -0
- package/dist/llms/DescriptionList.md +26 -0
- package/dist/llms/Dialog.md +57 -0
- package/dist/llms/Divider.md +24 -0
- package/dist/llms/Drawer.md +29 -0
- package/dist/llms/Dropdown.md +50 -0
- package/dist/llms/Dropzone.md +36 -0
- package/dist/llms/EmptyState.md +23 -0
- package/dist/llms/ErrorBoundary.md +25 -0
- package/dist/llms/FAQSection.md +24 -0
- package/dist/llms/FieldError.md +19 -0
- package/dist/llms/FieldTemplate.md +30 -0
- package/dist/llms/Fieldset.md +24 -0
- package/dist/llms/FileUpload.md +40 -0
- package/dist/llms/Flex.md +23 -0
- package/dist/llms/FloatButton.md +36 -0
- package/dist/llms/FocusTrap.md +20 -0
- package/dist/llms/Footer.md +32 -0
- package/dist/llms/FunnelChart.md +24 -0
- package/dist/llms/Gallery.md +30 -0
- package/dist/llms/GanttChart.md +29 -0
- package/dist/llms/GaugeChart.md +30 -0
- package/dist/llms/Grid.md +30 -0
- package/dist/llms/Group.md +22 -0
- package/dist/llms/HamburgerMenu.md +30 -0
- package/dist/llms/Header.md +30 -0
- package/dist/llms/Heatmap.md +25 -0
- package/dist/llms/Highlight.md +26 -0
- package/dist/llms/HoverCard.md +26 -0
- package/dist/llms/Icon.md +25 -0
- package/dist/llms/IconButton.md +30 -0
- package/dist/llms/Image.md +46 -0
- package/dist/llms/ImageCompare.md +35 -0
- package/dist/llms/ImageCropper.md +34 -0
- package/dist/llms/Indicator.md +28 -0
- package/dist/llms/InfiniteScroll.md +28 -0
- package/dist/llms/InlineEdit.md +32 -0
- package/dist/llms/Input.md +46 -0
- package/dist/llms/InputBase.md +39 -0
- package/dist/llms/InputGroup.md +23 -0
- package/dist/llms/InputMask.md +44 -0
- package/dist/llms/InteractiveArea.md +32 -0
- package/dist/llms/InteractiveGraph.md +28 -0
- package/dist/llms/JsonDiffViewer.md +24 -0
- package/dist/llms/JsonViewer.md +26 -0
- package/dist/llms/Kanban.md +25 -0
- package/dist/llms/Kbd.md +23 -0
- package/dist/llms/KeyboardShortcuts.md +25 -0
- package/dist/llms/Label.md +27 -0
- package/dist/llms/Leaderboard.md +24 -0
- package/dist/llms/Legend.md +27 -0
- package/dist/llms/Lightbox.md +47 -0
- package/dist/llms/LineChart.md +26 -0
- package/dist/llms/Link.md +28 -0
- package/dist/llms/LinkButton.md +23 -0
- package/dist/llms/List.md +35 -0
- package/dist/llms/Loader.md +23 -0
- package/dist/llms/LoadingOverlay.md +30 -0
- package/dist/llms/Markdown.md +24 -0
- package/dist/llms/MarkdownRenderer.md +24 -0
- package/dist/llms/Marquee.md +27 -0
- package/dist/llms/Masonry.md +18 -0
- package/dist/llms/Mentions.md +24 -0
- package/dist/llms/Menu.md +30 -0
- package/dist/llms/Menubar.md +50 -0
- package/dist/llms/Meta.md +13 -0
- package/dist/llms/ModelSelector.md +31 -0
- package/dist/llms/MultiSelect.md +38 -0
- package/dist/llms/Navbar.md +58 -0
- package/dist/llms/NodeGraph.md +38 -0
- package/dist/llms/Notification.md +30 -0
- package/dist/llms/NumberInput.md +23 -0
- package/dist/llms/OtpInput.md +33 -0
- package/dist/llms/OverflowList.md +31 -0
- package/dist/llms/Pagination.md +39 -0
- package/dist/llms/PasswordInput.md +39 -0
- package/dist/llms/PasswordStrength.md +34 -0
- package/dist/llms/PhoneInput.md +35 -0
- package/dist/llms/PieChart.md +23 -0
- package/dist/llms/PivotTable.md +41 -0
- package/dist/llms/PlatformIcons.md +13 -0
- package/dist/llms/Popconfirm.md +30 -0
- package/dist/llms/Popover.md +27 -0
- package/dist/llms/Portal.md +18 -0
- package/dist/llms/Presence.md +26 -0
- package/dist/llms/Progress.md +29 -0
- package/dist/llms/ProgressRing.md +27 -0
- package/dist/llms/PromptInput.md +37 -0
- package/dist/llms/PullToRefresh.md +26 -0
- package/dist/llms/QRCode.md +30 -0
- package/dist/llms/QueryBuilder.md +31 -0
- package/dist/llms/RadarChart.md +24 -0
- package/dist/llms/Radio.md +23 -0
- package/dist/llms/RadioGroup.md +32 -0
- package/dist/llms/RangeCalendar.md +26 -0
- package/dist/llms/RangeSlider.md +39 -0
- package/dist/llms/Rating.md +37 -0
- package/dist/llms/Reaction.md +26 -0
- package/dist/llms/RefTable.md +13 -0
- package/dist/llms/RelativeTime.md +24 -0
- package/dist/llms/Result.md +29 -0
- package/dist/llms/RichTextEditor.md +59 -0
- package/dist/llms/SankeyChart.md +26 -0
- package/dist/llms/ScatterChart.md +26 -0
- package/dist/llms/ScheduleView.md +35 -0
- package/dist/llms/ScrollArea.md +24 -0
- package/dist/llms/ScrollProgress.md +22 -0
- package/dist/llms/SearchInput.md +44 -0
- package/dist/llms/SegmentedControl.md +40 -0
- package/dist/llms/Select.md +44 -0
- package/dist/llms/SelectionBar.md +28 -0
- package/dist/llms/Sidebar.md +47 -0
- package/dist/llms/SignaturePad.md +36 -0
- package/dist/llms/SimpleGrid.md +24 -0
- package/dist/llms/Skeleton.md +26 -0
- package/dist/llms/Slider.md +36 -0
- package/dist/llms/SmartSearchInput.md +35 -0
- package/dist/llms/Snackbar.md +30 -0
- package/dist/llms/SortableList.md +33 -0
- package/dist/llms/SourceCitation.md +28 -0
- package/dist/llms/SourceCode.md +13 -0
- package/dist/llms/Span.md +29 -0
- package/dist/llms/Sparkline.md +27 -0
- package/dist/llms/SpeedDial.md +28 -0
- package/dist/llms/Spinner.md +26 -0
- package/dist/llms/SplitButton.md +29 -0
- package/dist/llms/Splitter.md +37 -0
- package/dist/llms/Spoiler.md +26 -0
- package/dist/llms/Stack.md +48 -0
- package/dist/llms/Stats.md +44 -0
- package/dist/llms/Stepper.md +32 -0
- package/dist/llms/StreamingText.md +24 -0
- package/dist/llms/SwipeAction.md +28 -0
- package/dist/llms/SwipeableList.md +21 -0
- package/dist/llms/Switch.md +27 -0
- package/dist/llms/SwitchGroup.md +31 -0
- package/dist/llms/T.md +13 -0
- package/dist/llms/TabBar.md +33 -0
- package/dist/llms/TabNavigation.md +30 -0
- package/dist/llms/Table.md +73 -0
- package/dist/llms/Tabs.md +40 -0
- package/dist/llms/Tag.md +30 -0
- package/dist/llms/TagInput.md +37 -0
- package/dist/llms/Terminal.md +29 -0
- package/dist/llms/Text.md +31 -0
- package/dist/llms/Textarea.md +30 -0
- package/dist/llms/ThemeToggle.md +31 -0
- package/dist/llms/ThoughtProcess.md +27 -0
- package/dist/llms/ThreadList.md +27 -0
- package/dist/llms/TimePicker.md +41 -0
- package/dist/llms/Timeline.md +24 -0
- package/dist/llms/Title.md +27 -0
- package/dist/llms/Toast.md +32 -0
- package/dist/llms/ToggleGroup.md +39 -0
- package/dist/llms/Toolbar.md +35 -0
- package/dist/llms/Tooltip.md +29 -0
- package/dist/llms/Tour.md +24 -0
- package/dist/llms/Transfer.md +35 -0
- package/dist/llms/Transition.md +34 -0
- package/dist/llms/TreeDiagram.md +33 -0
- package/dist/llms/TreeSelect.md +43 -0
- package/dist/llms/TreeView.md +50 -0
- package/dist/llms/Treemap.md +27 -0
- package/dist/llms/UsageMeter.md +31 -0
- package/dist/llms/Video.md +46 -0
- package/dist/llms/VirtualList.md +31 -0
- package/dist/llms/VisuallyHidden.md +19 -0
- package/dist/llms/VoiceVisualizer.md +30 -0
- package/dist/llms/WaterfallChart.md +25 -0
- package/dist/llms/Watermark.md +27 -0
- package/dist/llms/colorSwatch.md +13 -0
- package/dist/llms-full.txt +114 -111
- package/dist/llms.txt +4 -2
- package/dist/locales/en/data-display.json +3 -0
- package/dist/locales/ja/data-display.json +3 -0
- package/dist/locales/pt/data-display.json +3 -0
- package/dist/styles.css +1 -1
- package/dist/wimui.umd.js +5 -5
- package/package.json +10 -3
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# FieldError — wimui
|
|
2
|
+
|
|
3
|
+
> Validation messages
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { FieldError } from "wimui/form";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `content: string` (required) — Error message text
|
|
15
|
+
- `className: string` — Additional class names
|
|
16
|
+
- `id: string` — ID of the error message element
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# FieldTemplate — wimui
|
|
2
|
+
|
|
3
|
+
> Standardizes label placement, required markings, and error message display for all form-related components.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { FieldTemplate } from "wimui/form";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` = false — Whether to render as a child element.
|
|
15
|
+
- `label: React.ReactNode` — Label text of the field
|
|
16
|
+
- `error: string` — Error message
|
|
17
|
+
- `children: React.ReactNode` (required) — Main content of the field
|
|
18
|
+
- `required: boolean` — Whether to show the required indicator
|
|
19
|
+
- `layout: "vertical" | "horizontal"` = "vertical" — Layout direction of label and field @default "vertical"
|
|
20
|
+
- `labelId: string` — ID of the label element for accessibility
|
|
21
|
+
- `htmlFor: string` — ID of the element the label points to
|
|
22
|
+
- `errorId: string` — ID of the error message element
|
|
23
|
+
- `styles: { root?: string; labelWrapper?: string; label?: string; content?: string; error?: string; }` — Custom styles for internal parts
|
|
24
|
+
|
|
25
|
+
## Design tokens it reads
|
|
26
|
+
|
|
27
|
+
`--wim-height-md`, `--wim-input-min-width`, `--wim-input-width`, `--wim-spacing-2xl`, `--wim-spacing-3xs`, `--wim-spacing-md`, `--wim-spacing-xs`, `--wim-width-sm`, `--wim-width-xs`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Fieldset — wimui
|
|
2
|
+
|
|
3
|
+
> Form grouping
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Fieldset } from "wimui/form";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `children: React.ReactNode` (required) — Form elements to group
|
|
15
|
+
- `disabled: boolean` = false — Whether all contained form elements are disabled
|
|
16
|
+
- `variant: "default" | "full-width" | "plain"` = "default" — Visual variant of the fieldset. `plain` drops the frame and padding and keeps only the grouping — use it inside a `Card` or any surface that already draws a border, where a framed fieldset would put a box inside a box. The `<fieldset>` and its `<legend>` still do their job for assistive technology.
|
|
17
|
+
- `className: string` — Additional class names
|
|
18
|
+
|
|
19
|
+
## Design tokens it reads
|
|
20
|
+
|
|
21
|
+
`--wim-border-width-thin`, `--wim-color-border`, `--wim-opacity-disabled`, `--wim-radius-container`, `--wim-spacing-2xl`, `--wim-spacing-xl`
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# FileUpload — wimui
|
|
2
|
+
|
|
3
|
+
> File selection
|
|
4
|
+
|
|
5
|
+
Also known as: Upload, File Input
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { FileUpload } from "wimui/form";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `label: React.ReactNode` — Field label
|
|
17
|
+
- `buttonLabel: React.ReactNode` — Label of the file selection button
|
|
18
|
+
- `noFileLabel: React.ReactNode` — Text shown when no file is selected
|
|
19
|
+
- `accept: string` — Accepted file types (e.g. ".jpg,.png")
|
|
20
|
+
- `multiple: boolean` = false — Whether multiple files can be selected
|
|
21
|
+
- `disabled: boolean` = false — Whether the component is disabled
|
|
22
|
+
- `value: string[]` — Names of the files the field should show — typically ones that already exist on the server, from an earlier session or an earlier step. Controlled: while this is set, it is what the field displays, and picking a file only fires `onChange`. Pass the new names back to show them. Leave it undefined to let the field track its own selection.
|
|
23
|
+
- `onChange: (files: FileList | null) => void` — Callback when files are selected
|
|
24
|
+
- `className: string` — Additional class names
|
|
25
|
+
- `iconName: React.ComponentProps<typeof Icon>["name"]` — Icon name shown on the button
|
|
26
|
+
- `iconPosition: "left" | "right"` — Position of the icon relative to the button label
|
|
27
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
28
|
+
- `error: string` — Error message
|
|
29
|
+
- `required: boolean` — Whether to show the required indicator
|
|
30
|
+
- `layout: "vertical" | "horizontal"` = "vertical" — Layout direction of label and field
|
|
31
|
+
- `aria-label: string` — Accessible name for the choose-file button when no visible `label` is provided.
|
|
32
|
+
- `aria-labelledby: string` — ID of the element that labels the choose-file button when no visible `label` is provided.
|
|
33
|
+
- `aria-describedby: string` — ID of the element that describes the choose-file button. Announced together with the error message.
|
|
34
|
+
|
|
35
|
+
## Design tokens it reads
|
|
36
|
+
|
|
37
|
+
`--wim-color-text-disabled`, `--wim-color-text-tertiary`, `--wim-file-upload-font-size`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-spacing-md`, `--wim-spacing-xs`
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Flex — wimui
|
|
2
|
+
|
|
3
|
+
> Flexible layout
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Flex } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` = false — If true, the flex will be rendered as its child, merging its props onto that child.
|
|
15
|
+
- `direction: "row" | "row-reverse" | "column" | "column-reverse"` = "row" — Flex direction
|
|
16
|
+
- `align: "start" | "center" | "end" | "stretch" | "baseline"` — Align-items
|
|
17
|
+
- `justify: "start" | "center" | "end" | "between" | "around" | "evenly" | "stretch"` — Justify-content
|
|
18
|
+
- `wrap: "nowrap" | "wrap" | "wrap-reverse"` — Flex-wrap
|
|
19
|
+
- `gap: number | WimSpacing` — Gap between children
|
|
20
|
+
- `inline: boolean` = false — Display inline-flex
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# FloatButton — wimui
|
|
2
|
+
|
|
3
|
+
> Floating action buttons
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { FloatButton } from "wimui/form";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` = false — If true, the button will be rendered as its child, merging its props onto that child.
|
|
15
|
+
- `iconName: "CircleIcon" | "SquareIcon" | "LoadingIcon" | "ExternalLinkIcon" | "ArrowUpIcon" | string` = "CircleIcon" — Icon name from the library
|
|
16
|
+
- `variant: "outline" | "glass"` — 見た目の強さ。既定(未指定)は intent の塗り。 以前は `"default" | "primary" | "glass"` だったが、3 つとも実態とずれていた(T114): `primary` は variant 未指定とまったく同じ規則に落ちる重複、 `default` は**既定の見た目ではなく枠線のある outline** で名前が逆、 SCSS には誰も付けない `.default_intent` が「temporary name」のまま残っていた。
|
|
17
|
+
- `intent: "default" | "danger" | "success"` = "default" — Intent of the button (semantic meaning)
|
|
18
|
+
- `shape: "circle" | "square"` = "circle" — Shape of the button
|
|
19
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
20
|
+
- `label: React.ReactNode` — Label text for extended FAB
|
|
21
|
+
- `shrink: boolean` = false — Whether to shrink the extended FAB (hide label)
|
|
22
|
+
- `position: "bottom-right" | "bottom-left" | "bottom-center" | "top-right" | "top-left" | "inline"` = "bottom-right" — Position of the button
|
|
23
|
+
- `description: React.ReactNode` — Description for tooltip
|
|
24
|
+
- `badge: number | boolean` — Badge content (number or dot). A count of `0` (or less) hides the badge.
|
|
25
|
+
- `backTop: boolean` = false — If true, the button will scroll to the top of the page when clicked
|
|
26
|
+
- `visibilityHeight: number` = 400 — Visibility threshold for backTop (in pixels)
|
|
27
|
+
- `className: string` — Additional class names
|
|
28
|
+
- `style: React.CSSProperties` — Style attribute
|
|
29
|
+
- `aria-label: string` — Accessible name. Required when there is no string `label`: an icon-only button has no text to take a name from, and the icon name is not used as one.
|
|
30
|
+
|
|
31
|
+
## Design tokens it reads
|
|
32
|
+
|
|
33
|
+
`--wim-blur-glass`, `--wim-border-width-thick`, `--wim-border-width-thin`, `--wim-color-border`, `--wim-color-danger`, `--wim-color-glass-bg`, `--wim-color-glass-border`, `--wim-color-overlay-strong`, `--wim-color-primary`, `--wim-color-shadow-glass`, `--wim-color-success`, `--wim-color-surface`, `--wim-color-text-on-danger`, `--wim-color-text-on-overlay`, `--wim-color-text-on-primary`, `--wim-color-text-on-success`, `--wim-color-text-primary`, `--wim-color-white`, `--wim-font-size-3xs`, `--wim-font-size-lg`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-medium`, `--wim-glass-blur`, `--wim-lift-sm`, `--wim-line-height-normal`, `--wim-opacity-ghost`, `--wim-radius-component`, `--wim-radius-full`, `--wim-scale-active`, `--wim-shadow-lg`, `--wim-shadow-md`, `--wim-spacing-2xl`, `--wim-spacing-2xs`, `--wim-spacing-3xl`, `--wim-spacing-4xl`, `--wim-spacing-5xl`, `--wim-spacing-lg`, `--wim-spacing-md`, `--wim-spacing-xl`, `--wim-spacing-xs`, `--wim-tap-target-min`, `--wim-transition-base`, `--wim-transition-fast`, `--wim-z-overlay`
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FocusTrap — wimui
|
|
2
|
+
|
|
3
|
+
> Focus management
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { FocusTrap } from "wimui/overlay";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `children: React.ReactNode` (required) — Content to trap focus within.
|
|
15
|
+
- `active: boolean` = true — Whether the trap is active. @default true
|
|
16
|
+
- `initialFocus: boolean` = true — Whether to focus the first focusable element on mount.
|
|
17
|
+
- `className: string` — Additional CSS class name.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Footer — wimui
|
|
2
|
+
|
|
3
|
+
> Lower navigation
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Footer } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `bordered: boolean` — Border at the top
|
|
15
|
+
- `fluid: boolean` — Expand content to full width (disable the centered max-width container)
|
|
16
|
+
- `background: "surface" | "surface-variant" | "inverse"` = "surface" — Background color
|
|
17
|
+
|
|
18
|
+
## Footer.Bottom
|
|
19
|
+
|
|
20
|
+
(no props of its own)
|
|
21
|
+
|
|
22
|
+
## Footer.Section
|
|
23
|
+
|
|
24
|
+
- `title: string`
|
|
25
|
+
- `titleLevel: 2 | 3 | 4 | 5 | 6` — `title` を見出しとして描くときの段(T211)。渡さなければ見出しにならず `p` のまま。 既定を見出しにしてはいけない(T191 の実績)── かつて `h4` 固定だった頃、ページに `h1` / `h2` があると段が飛んで axe の `heading-order` が鳴った (`Probes/SaginomiyaPool` で実際に出た)。フッタの欄名は文書の見出しではない、 というのがそのときの判断で、ここはそれを踏襲する。 ただし「欄名を見出しとして辿らせたい」ページも実在するので、段を明示したときだけ 見出しになるようにしてある。`Alert` の `titleTag`(既定 `div`)と同じ形。段を 決めるのはページ側の構造を知っている呼び出し元の仕事。
|
|
26
|
+
|
|
27
|
+
## Design tokens it reads
|
|
28
|
+
|
|
29
|
+
`--wim-border-width-thin`, `--wim-color-border-inverse`, `--wim-color-border-secondary`, `--wim-color-surface`, `--wim-color-surface-inverse`, `--wim-color-surface-variant`, `--wim-color-text-muted-on-inverse`, `--wim-color-text-on-inverse`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-weight-bold`, `--wim-spacing-2xl`, `--wim-spacing-md`, `--wim-spacing-xl`, `--wim-spacing-xs`, `--wim-transition-base`
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FunnelChart — wimui
|
|
2
|
+
|
|
3
|
+
> Process stage abandonment chart
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { FunnelChart } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `data: ChartDataPoint[]` (required) — Data to display in the chart. Each entry represents one funnel stage.
|
|
15
|
+
- `dataKey: string` (required) — The key in the data objects that represents the value of each stage.
|
|
16
|
+
- `nameKey: string` (required) — The key in the data objects used for the stage labels.
|
|
17
|
+
- `height: number` = 300 — The height of the chart in pixels. @default 300
|
|
18
|
+
- `width: string | number` = "100%" — The width of the chart (e.g., "100%", 500). @default "100%"
|
|
19
|
+
- `title: string` — Optional title displayed above the chart.
|
|
20
|
+
- `animated: boolean` = false — If true, animates the chart on mount. @default false
|
|
21
|
+
- `aria-label: string` — Accessible name for the chart. Defaults to `title` when omitted; pass this when the chart has no visible title, or when the title is not descriptive enough on its own.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Gallery — wimui
|
|
2
|
+
|
|
3
|
+
> Displays a responsive image grid with configurable columns, aspect ratios, multi-select, and an optional lightbox.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Gallery } from "wimui/media";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `items: GalleryItem[]` (required) — Images to display in the gallery
|
|
15
|
+
- `columns: number` = 3 — Number of grid columns. Default: 3.
|
|
16
|
+
- `gap: "xs" | "sm" | "md" | "lg" | "xl"` = "md" — Gap between items. Default: "md".
|
|
17
|
+
- `aspect: "square" | "landscape" | "portrait" | "auto"` = "square" — Aspect ratio for each image. Default: "square".
|
|
18
|
+
- `selectable: boolean` = false — Enable multi-select with checkboxes. The photo click is `onItemClick`, not select.
|
|
19
|
+
- `selected: string[]` — Controlled selected IDs.
|
|
20
|
+
- `defaultSelected: string[]` = [] — Uncontrolled initial selected IDs.
|
|
21
|
+
- `onSelectionChange: (ids: string[]) => void` — Called when selection changes.
|
|
22
|
+
- `onItemClick: (item: GalleryItem, index: number) => void` — Called when the item (not the checkbox) is clicked. Fires even when `selectable`.
|
|
23
|
+
- `renderActions: (params: { selectedIds: string[]; clearSelection: () => void; }) => React.ReactNode` — Render bulk-action toolbar when items are selected.
|
|
24
|
+
|
|
25
|
+
## Design tokens it reads
|
|
26
|
+
|
|
27
|
+
`--wim-border-width-thick`, `--wim-border-width-thin`, `--wim-checkbox-size`, `--wim-color-border-secondary`, `--wim-color-focus-outline`, `--wim-color-primary`, `--wim-color-primary-subtle`, `--wim-color-surface-subtle`, `--wim-color-text-accent`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-duration-base`, `--wim-duration-fast`, `--wim-easing-entrance`, `--wim-easing-standard`, `--wim-focus-outline-width`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-medium`, `--wim-radius-component`, `--wim-spacing-2xs`, `--wim-spacing-lg`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xl`, `--wim-spacing-xs`, `--wim-tap-target-min`, `--wim-width-sm`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# GanttChart — wimui
|
|
2
|
+
|
|
3
|
+
> Project schedule and timeline visualization
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { GanttChart } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `tasks: GanttTask[]` (required) — Tasks to render as bars in the chart.
|
|
15
|
+
- `startDate: Date` — Start of the visible date range. Defaults to the earliest task start date.
|
|
16
|
+
- `endDate: Date` — End of the visible date range. Defaults to the latest task end date.
|
|
17
|
+
- `viewMode: "day" | "week" | "month"` = "day" — Granularity of the time axis. @default "day"
|
|
18
|
+
- `columnWidth: number` — Width of one time column in pixels. Defaults to a value suited to the view mode.
|
|
19
|
+
- `rowHeight: number` = 40 — Height of one task row in pixels. @default 40
|
|
20
|
+
- `onTaskClick: (task: GanttTask) => void` — Called when a task bar is clicked.
|
|
21
|
+
- `className: string` — Additional CSS class name for the container.
|
|
22
|
+
- `labels: { ariaChart?: string; ariaTaskBar?: (label: string, start: string, end: string) => string; }` — Labels for manual translation overrides.
|
|
23
|
+
|
|
24
|
+
## Design tokens it reads
|
|
25
|
+
|
|
26
|
+
`--wim-border-width-thick`, `--wim-border-width-thin`, `--wim-color-border`, `--wim-color-border-secondary`, `--wim-color-focus-outline`, `--wim-color-glass-border`, `--wim-color-overlay-medium`, `--wim-color-primary`, `--wim-color-scrollbar-thumb`, `--wim-color-scrollbar-track`, `--wim-color-surface`, `--wim-color-surface-subtle`, `--wim-color-text-on-primary`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-duration-fast`, `--wim-easing-standard`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-bold`, `--wim-radius-component`, `--wim-radius-container`, `--wim-radius-md`, `--wim-spacing-2xs`, `--wim-spacing-xl`, `--wim-width-sm`
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# GaugeChart — wimui
|
|
2
|
+
|
|
3
|
+
> KPI goal achievement chart
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { GaugeChart } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `value: number` (required) — Current value displayed by the gauge. Clamped between min and max.
|
|
15
|
+
- `min: number` = 0 — Minimum value of the gauge. @default 0
|
|
16
|
+
- `max: number` = 100 — Maximum value of the gauge. @default 100
|
|
17
|
+
- `height: number` = 200 — The height of the chart in pixels. @default 200
|
|
18
|
+
- `width: string | number` = "100%" — The width of the chart (e.g., "100%", 500). @default "100%"
|
|
19
|
+
- `title: string` — Optional title displayed above the chart.
|
|
20
|
+
- `label: string` — Text label displayed with the value inside the gauge.
|
|
21
|
+
- `color: string` — Color of the gauge arc. Defaults to the first chart color.
|
|
22
|
+
- `animated: boolean` = false — If true, animates the chart on mount. @default false
|
|
23
|
+
- `aria-label: string` — Accessible name for the chart. Defaults to `title` when omitted; pass this when the chart has no visible title, or when the title is not descriptive enough on its own.
|
|
24
|
+
|
|
25
|
+
## Design tokens it reads
|
|
26
|
+
|
|
27
|
+
`--wim-color-text-primary`, `--wim-font-size-2xl`, `--wim-font-weight-bold`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Grid — wimui
|
|
2
|
+
|
|
3
|
+
> Flexbox or CSS Grid system
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Grid } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` = false — If true, the grid will be rendered as its child, merging its props onto that child. The container-query wrapper div is preserved to maintain responsive column behaviour.
|
|
15
|
+
- `cols: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Number of columns (or a responsive object per breakpoint)
|
|
16
|
+
- `rows: number | string` — Number of rows or an explicit grid-template-rows value
|
|
17
|
+
- `gap: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Gap between cells (or a responsive object per breakpoint)
|
|
18
|
+
- `columnGap: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Gap between columns (or a responsive object per breakpoint)
|
|
19
|
+
- `rowGap: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Gap between rows (or a responsive object per breakpoint)
|
|
20
|
+
- `align: "start" | "center" | "end" | "stretch"` — Alignment of items along the block (vertical) axis
|
|
21
|
+
- `justify: "start" | "center" | "end" | "between" | "around" | "stretch"` — Justification of items along the inline (horizontal) axis
|
|
22
|
+
- `flow: "row" | "column" | "dense" | "row dense" | "column dense"` — Grid auto-flow direction
|
|
23
|
+
- `inline: boolean` = false — Whether to render as an inline grid
|
|
24
|
+
|
|
25
|
+
## Design tokens it reads
|
|
26
|
+
|
|
27
|
+
`--wim-grid-col-gap`, `--wim-grid-col-gap-lg`, `--wim-grid-col-gap-md`, `--wim-grid-col-gap-sm`, `--wim-grid-col-gap-xl`, `--wim-grid-cols`, `--wim-grid-cols-lg`, `--wim-grid-cols-md`, `--wim-grid-cols-sm`, `--wim-grid-cols-xl`, `--wim-grid-row-gap`, `--wim-grid-row-gap-lg`, `--wim-grid-row-gap-md`, `--wim-grid-row-gap-sm`, `--wim-grid-row-gap-xl`, `--wim-width-sm`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Group — wimui
|
|
2
|
+
|
|
3
|
+
> Flexible grouping
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Group } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` — If true, the group will be rendered as its child, merging its props onto that child.
|
|
15
|
+
- `align: "start" | "center" | "end" | "stretch" | "baseline"` = "center" — Vertical alignment
|
|
16
|
+
- `justify: "start" | "center" | "end" | "between" | "around" | "evenly"` = "start" — Horizontal alignment
|
|
17
|
+
- `gap: number | string` = "2xl" — Gap between elements: a spacing token name (`"md"`, `"2xl"`, …) or a raw number of pixels. Prefer the token so the gap follows the theme. @default "2xl"
|
|
18
|
+
- `wrap: "nowrap" | "wrap" | "wrap-reverse"` = "wrap" — Whether to wrap children
|
|
19
|
+
- `grow: boolean` = false — Whether items should grow to fill available space
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# HamburgerMenu — wimui
|
|
2
|
+
|
|
3
|
+
> Toggleable menu
|
|
4
|
+
|
|
5
|
+
Also known as: Sandwich Menu, Navigation Drawer Trigger, Nav Toggle, Cheeseburger Menu, Veggie Burger Menu, Pancake Menu, Bacon Menu, Hot Dog Menu, ハンバーガーメニュー, サンドイッチメニュー
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { HamburgerMenu } from "wimui/navigation";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `asChild: boolean` = false — If true, merge button props onto the child element.
|
|
17
|
+
- `open: boolean` = false — Whether the menu is open
|
|
18
|
+
- `onClick: React.MouseEventHandler<HTMLButtonElement>` — Callback function when the menu is toggled
|
|
19
|
+
- `onOpenChange: (open: boolean) => void` — Called with the next open state: the opposite of `open` when the button is pressed, and false when Escape is pressed while the menu is open. Escape also moves focus back to the button. Without this callback the button cannot close on Escape, because `open` is controlled.
|
|
20
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the hamburger menu
|
|
21
|
+
- `color: string` — Color of the bars
|
|
22
|
+
- `visibleBelow: "xs" | "sm" | "md" | "lg" | "xl"` — Show only below the given breakpoint (e.g. "md" matches Sidebar's mobile drawer range)
|
|
23
|
+
- `className: string` — Custom class name
|
|
24
|
+
|
|
25
|
+
## Design tokens it reads
|
|
26
|
+
|
|
27
|
+
`--wim-color-text-primary`, `--wim-duration-extra-fast`, `--wim-duration-fast`, `--wim-easing-entrance`, `--wim-easing-exit`, `--wim-easing-sharp`, `--wim-easing-standard`, `--wim-hamburger-color`, `--wim-scale-active-sm`, `--wim-spacing-sm`, `--wim-transition-fast`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Header — wimui
|
|
2
|
+
|
|
3
|
+
> Upper navigation
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Header } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `fixed: boolean` — Fixed position at the top
|
|
15
|
+
- `sticky: boolean` — Sticky position at the top
|
|
16
|
+
- `bordered: boolean` — Border at the bottom
|
|
17
|
+
- `glass: boolean` — Glassmorphism effect
|
|
18
|
+
- `fluid: boolean` — Expand content to full width (disable the centered max-width container)
|
|
19
|
+
- `background: "surface" | "surface-variant" | "transparent"` = "surface" — Background color
|
|
20
|
+
|
|
21
|
+
## Header.Section
|
|
22
|
+
|
|
23
|
+
- `align: "start" | "center" | "end"` = "start"
|
|
24
|
+
|
|
25
|
+
## Design tokens it reads
|
|
26
|
+
|
|
27
|
+
`--wim-border-width-thin`, `--wim-color-border-secondary`, `--wim-color-glass-bg`, `--wim-color-glass-blur`, `--wim-color-glass-border`, `--wim-color-surface`, `--wim-color-surface-variant`, `--wim-header-height`, `--wim-spacing-md`, `--wim-spacing-xl`, `--wim-transition-base`, `--wim-z-header`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Heatmap — wimui
|
|
2
|
+
|
|
3
|
+
> Graphical representation of data where individual values are contained in a matrix as colors.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Heatmap } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `data: { x: string; y: string; value: number }[]` (required) — Cells to display. Each entry maps an x/y category pair to a value.
|
|
15
|
+
- `xAxisKey: string[]` (required) — Ordered list of X axis category labels.
|
|
16
|
+
- `yAxisKey: string[]` (required) — Ordered list of Y axis category labels.
|
|
17
|
+
- `height: number` = 300 — The height of the chart in pixels. @default 300
|
|
18
|
+
- `width: string | number` = "100%" — The width of the chart (e.g., "100%", 500). @default "100%"
|
|
19
|
+
- `title: string` — Optional title displayed above the chart.
|
|
20
|
+
- `colorRange: [string, string]` = ["var(--wim-color-surface-variant)", "var(--wim-color-chart-primary)"] — Colors used for the lowest and highest values. @default ["var(--wim-color-surface-variant)", "var(--wim-color-chart-primary)"]
|
|
21
|
+
- `animated: boolean` = false — Whether to animate the cells on mount. @default false
|
|
22
|
+
- `aria-label: string` — Accessible name for the chart. Defaults to `title` when omitted; pass this when the chart has no visible title, or when the title is not descriptive enough on its own.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Highlight — wimui
|
|
2
|
+
|
|
3
|
+
> Text highlighting
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Highlight } from "wimui/typography";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `children: React.ReactNode` (required) — The full text to highlight substrings in.
|
|
15
|
+
- `highlight: string | string[]` (required) — Substring(s) to highlight.
|
|
16
|
+
- `highlightClassName: string` — Custom class name for the highlighted `<mark>` element.
|
|
17
|
+
- `highlightStyles: React.CSSProperties` — Custom styles for the highlighted `<mark>` element.
|
|
18
|
+
- `as: React.ElementType` = "span" — The HTML tag or component to use for the container. Default is "span".
|
|
19
|
+
- `asChild: boolean` = false — If true, the component will be rendered as its child.
|
|
20
|
+
|
|
21
|
+
## Design tokens it reads
|
|
22
|
+
|
|
23
|
+
`--wim-comp-decoration-highlight-color`, `--wim-radius-sm`, `--wim-spacing-3xs`
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# HoverCard — wimui
|
|
2
|
+
|
|
3
|
+
> Rich content on hover
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { HoverCard } from "wimui/overlay";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `children: ReactNode` (required) — Hover card parts (HoverCardTrigger and HoverCardContent).
|
|
15
|
+
- `className: string` — Additional CSS class name for the container.
|
|
16
|
+
- `openDelay: number` = 700 — Delay before showing the hover card in ms.
|
|
17
|
+
- `closeDelay: number` = 300 — Delay before hiding the hover card in ms.
|
|
18
|
+
- `open: boolean` — If provided, controls the open state.
|
|
19
|
+
- `onOpenChange: (open: boolean) => void` — Callback when open state changes.
|
|
20
|
+
|
|
21
|
+
## Design tokens it reads
|
|
22
|
+
|
|
23
|
+
`--wim-border-width-thin`, `--wim-color-border`, `--wim-color-surface`, `--wim-color-text-primary`, `--wim-duration-fast`, `--wim-floating-shift-x`, `--wim-font-size-sm`, `--wim-hover-card-offset`, `--wim-line-height-normal`, `--wim-overlay-max-width-sm`, `--wim-radius-overlay`, `--wim-radius-sm`, `--wim-shadow-focus`, `--wim-shadow-overlay`, `--wim-spacing-md`, `--wim-z-overlay`
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Icon — wimui
|
|
2
|
+
|
|
3
|
+
> Visual symbols
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Icon } from "wimui/media";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `name: keyof typeof ALL_ICONS` — Icon name. Requires `import "wimui/icons"` once at the app entry to register icons.
|
|
15
|
+
- `component: React.ComponentType<React.SVGProps<SVGSVGElement>>` — Icon component passed directly. Works without registration and is tree-shakable.
|
|
16
|
+
- `size: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl"` = "md" — Size of the icon
|
|
17
|
+
- `spin: boolean` — Apply the loading rotation animation
|
|
18
|
+
- `color: T | (string & {})` — Colour of the icon. Takes the semantic names — `"danger"`, `"success"`, `"warning"`, `"info"`, `"primary"`, `"secondary"`, `"tertiary"`, `"disabled"` — and, like `Text`, any design token colour name such as `"text-tertiary"`, or any CSS colour value.
|
|
19
|
+
|
|
20
|
+
## Design tokens it reads
|
|
21
|
+
|
|
22
|
+
`--wim-color-line`, `--wim-color-text-accent`, `--wim-color-text-danger`, `--wim-color-text-disabled`, `--wim-color-text-info`, `--wim-color-text-secondary`, `--wim-color-text-success`, `--wim-color-text-tertiary`, `--wim-color-text-warning`, `--wim-font-size-2xl`, `--wim-font-size-3xl`, `--wim-font-size-4xl`, `--wim-font-size-5xl`, `--wim-font-size-lg`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-size-xl`, `--wim-font-size-xs`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# IconButton — wimui
|
|
2
|
+
|
|
3
|
+
> A square button containing only an icon without a text label.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { IconButton } from "wimui/form";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `iconName: React.ComponentProps<typeof Icon>["name"]` (required) — Icon name to display
|
|
15
|
+
- `aria-label: string` (required) — Accessible label for the icon-only button
|
|
16
|
+
- `asChild: unknown` = false
|
|
17
|
+
- `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.
|
|
18
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
19
|
+
- `variant: "solid" | "outline" | "ghost"` = "outline" — Visual style variant of the button
|
|
20
|
+
- `intent: "default" | "danger" | "success"` = "default" — Design intent of the button (visual / semantic state). Unrelated to the ARIA role attribute.
|
|
21
|
+
- `icon: React.ComponentProps<typeof Icon>["name"] | React.ReactNode` — Icon name or custom icon element. An icon-only button (no children) needs `aria-label` or `aria-labelledby`: the icon name is not used as the accessible name.
|
|
22
|
+
- `loading: boolean` = false — Whether to show a loading indicator and disable interaction
|
|
23
|
+
- `justify: "start" | "center" | "end" | "between"` = "center" — Horizontal alignment of the button content
|
|
24
|
+
- `animateWidth: boolean` = false — Whether to animate the width change when label changes
|
|
25
|
+
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
26
|
+
- `styles: { root?: string; loader?: string; icon?: string; }` — Custom styles for internal parts
|
|
27
|
+
- `className: string` — Additional class names
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|