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,22 @@
|
|
|
1
|
+
# AspectRatio — wimui
|
|
2
|
+
|
|
3
|
+
> Fixed ratio container
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { AspectRatio } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `ratio: number` = 1 — Aspect ratio (e.g. 16 / 9, 1, 4 / 3)
|
|
15
|
+
- `children: React.ReactNode` (required) — Child content
|
|
16
|
+
|
|
17
|
+
## Design tokens it reads
|
|
18
|
+
|
|
19
|
+
`--wim-aspect-ratio`
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Audio — wimui
|
|
2
|
+
|
|
3
|
+
> Audio playback
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Audio } from "wimui/media";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `src: string | string[] | AudioTrack | AudioTrack[]` — Source: a URL, list of URLs, or track object(s)
|
|
15
|
+
- `autoPlay: boolean` = false — Whether to start playing automatically
|
|
16
|
+
- `loop: boolean` = false — Whether to loop playback
|
|
17
|
+
- `muted: boolean` = false — Whether to start muted
|
|
18
|
+
- `controls: boolean` = true — Whether to show playback controls
|
|
19
|
+
- `preload: "auto" | "metadata" | "none"` — Preload behavior
|
|
20
|
+
- `radius: "none" | "sm" | "md" | "lg" | "full"` = "none" — Corner radius size
|
|
21
|
+
- `shadow: boolean` = false — Whether to show a shadow
|
|
22
|
+
- `border: boolean` = false — Whether to show a border
|
|
23
|
+
- `caption: React.ReactNode` — Caption shown below the player
|
|
24
|
+
- `customControls: boolean` = false — Whether to use the custom control bar instead of native controls
|
|
25
|
+
- `visualizer: boolean` = false — Whether to show the audio visualizer
|
|
26
|
+
- `showMetadata: boolean` = false — Whether to show track metadata (title, artist, cover art)
|
|
27
|
+
- `fadeIn: boolean | number` = false — Whether to fade in when playback starts (or the duration in seconds)
|
|
28
|
+
- `fadeOut: boolean | number` = false — Whether to fade out when playback ends (or the duration in seconds)
|
|
29
|
+
- `crossfade: boolean | number` = false — Whether to crossfade between tracks (or the duration in seconds)
|
|
30
|
+
- `playbackRate: boolean` = false — Whether to show the playback-rate control
|
|
31
|
+
- `hotkeys: boolean` = false — Whether to enable keyboard hotkeys
|
|
32
|
+
- `presets: boolean` = false — Whether to show equalizer presets
|
|
33
|
+
- `sleepTimer: boolean` = false — Whether to show the sleep timer
|
|
34
|
+
- `loading: "eager" | "lazy"` = "lazy" — Loading behavior. With "lazy", an Intersection Observer is enabled.
|
|
35
|
+
- `demoDelay: number` — Demo only: milliseconds to intentionally delay load completion
|
|
36
|
+
- `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
|
|
37
|
+
- `tracks: React.ComponentPropsWithoutRef<"track">[]` — Subtitle/caption tracks passed as <track> elements (kind, src, srcLang, label).
|
|
38
|
+
|
|
39
|
+
## Design tokens it reads
|
|
40
|
+
|
|
41
|
+
`--wim-audio-bg-end`, `--wim-audio-bg-start`, `--wim-border-width-thin`, `--wim-color-border`, `--wim-color-focus-outline`, `--wim-color-primary`, `--wim-color-primary-muted`, `--wim-color-skeleton-bg`, `--wim-color-skeleton-shine`, `--wim-color-surface-inverse`, `--wim-color-surface-void`, `--wim-color-text-accent`, `--wim-color-text-on-primary`, `--wim-color-text-secondary`, `--wim-color-white`, `--wim-duration-slow`, `--wim-duration-ultra-slow`, `--wim-easing-entrance`, `--wim-easing-standard`, `--wim-focus-outline-offset`, `--wim-focus-outline-width`, `--wim-font-size-2xs`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-bold`, `--wim-font-weight-semibold`, `--wim-height-lg`, `--wim-height-md`, `--wim-height-sm`, `--wim-line-height-snug-jp`, `--wim-line-height-tight`, `--wim-radius-component`, `--wim-radius-full`, `--wim-radius-lg`, `--wim-radius-sm`, `--wim-scale-active-sm`, `--wim-shadow-md`, `--wim-spacing-2xl`, `--wim-spacing-3xl`, `--wim-spacing-5xl`, `--wim-spacing-lg`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xl`, `--wim-spacing-xs`, `--wim-transition-base`, `--wim-transition-fast`, `--wim-width-md`
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Autosave — wimui
|
|
2
|
+
|
|
3
|
+
> Inline status indicator for automatic save state
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Autosave } from "wimui/feedback";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `status: "idle" | "saving" | "saved" | "error"` (required) — Save status
|
|
15
|
+
- `savedAt: Date` — Time of the last save
|
|
16
|
+
- `errorMessage: string` — Error message (a default message is used when omitted)
|
|
17
|
+
|
|
18
|
+
## Design tokens it reads
|
|
19
|
+
|
|
20
|
+
`--wim-color-text-danger`, `--wim-color-text-secondary`, `--wim-color-text-success`, `--wim-duration-slow`, `--wim-font-size-sm`, `--wim-spacing-xs`
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Avatar — wimui
|
|
2
|
+
|
|
3
|
+
> Profile initials/pics
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Avatar } from "wimui/data-display";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `src: string` — Image source URL
|
|
15
|
+
- `alt: string` = "" — Alternative text for the image
|
|
16
|
+
- `initials: string` — Initials shown as a fallback when no image is available
|
|
17
|
+
- `icon: React.ReactNode` — Icon shown as a fallback when no image or initials are available
|
|
18
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the avatar
|
|
19
|
+
- `shape: "circle" | "rounded"` = "circle" — Shape of the avatar
|
|
20
|
+
- `intent: "primary" | "success" | "warning" | "danger" | "info" | "neutral"` — Intent (semantic color) applied to the avatar
|
|
21
|
+
|
|
22
|
+
## Design tokens it reads
|
|
23
|
+
|
|
24
|
+
`--wim-avatar-size-lg`, `--wim-avatar-size-md`, `--wim-avatar-size-sm`, `--wim-color-danger`, `--wim-color-disabled`, `--wim-color-info`, `--wim-color-primary`, `--wim-color-success`, `--wim-color-text-on-danger`, `--wim-color-text-on-disabled`, `--wim-color-text-on-info`, `--wim-color-text-on-primary`, `--wim-color-text-on-success`, `--wim-color-text-on-warning`, `--wim-color-warning`, `--wim-font-size-lg`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-semibold`, `--wim-radius-component`, `--wim-radius-full`
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# AvatarGroup — wimui
|
|
2
|
+
|
|
3
|
+
> Stacked avatars
|
|
4
|
+
|
|
5
|
+
Also known as: Face Pile
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { AvatarGroup } from "wimui/data-display";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `children: React.ReactNode` (required) — Avatar elements to group
|
|
17
|
+
- `max: number` — Maximum number of avatars to show before collapsing into a count. Ignored with `overflow="collapse"`.
|
|
18
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size applied to the avatars
|
|
19
|
+
- `total: number` — Total number of avatars (used to compute the overflow count). Ignored with `overflow="collapse"`.
|
|
20
|
+
- `overflow: "count" | "collapse"` = "count" — How the avatars that do not fit are handled. `"count"` cuts them by `max` / `total` and shows "+N" as text; `"collapse"` shows as many as fit the width and turns "+N" into a button that lists the hidden people by name. @default "count"
|
|
21
|
+
- `className: string` — Additional class names
|
|
22
|
+
|
|
23
|
+
## Design tokens it reads
|
|
24
|
+
|
|
25
|
+
`--wim-border-width-thick`, `--wim-color-surface`, `--wim-color-text-secondary`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-semibold`, `--wim-spacing-md`, `--wim-spacing-sm`
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# BackTop — wimui
|
|
2
|
+
|
|
3
|
+
> Back to top button
|
|
4
|
+
|
|
5
|
+
Also known as: Back to Top
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { BackTop } from "wimui/navigation";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `target: () => HTMLElement | Window | Document | null` = () => window — Target container that will be scrolled
|
|
17
|
+
- `visibilityHeight: number` = 400 — Scroll height after which the button becomes visible
|
|
18
|
+
- `onClick: (e: React.MouseEvent<HTMLDivElement>) => void` — Callback when clicked
|
|
19
|
+
- `children: React.ReactNode` — Children to be rendered inside the button
|
|
20
|
+
- `className: string` — Additional class names
|
|
21
|
+
- `style: React.CSSProperties` — Style attribute
|
|
22
|
+
- `aria-label: string` — Accessible label for the button
|
|
23
|
+
- `aria-labelledby: string` — ID of the element that labels the button. Takes precedence over `aria-label`.
|
|
24
|
+
- `aria-describedby: string` — ID of the element that describes the button.
|
|
25
|
+
- `asChild: boolean` = false — Whether to render as a child element.
|
|
26
|
+
|
|
27
|
+
## Design tokens it reads
|
|
28
|
+
|
|
29
|
+
`--wim-color-primary`, `--wim-color-text-on-primary`, `--wim-font-size-xl`, `--wim-height-md`, `--wim-radius-full`, `--wim-shadow-lg`, `--wim-spacing-3xl`, `--wim-spacing-5xl`, `--wim-transition-base`, `--wim-z-overlay`
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Badge — wimui
|
|
2
|
+
|
|
3
|
+
> Indicators or counts
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Badge } from "wimui/data-display";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` — If true, the badge will be rendered as its child, merging its props onto that child.
|
|
15
|
+
- `children: React.ReactNode` — Content to display
|
|
16
|
+
- `content: React.ReactNode` — Content to display (alternative to children)
|
|
17
|
+
- `icon: React.ReactNode` — Icon
|
|
18
|
+
- `intent: "primary" | "success" | "warning" | "danger" | "info" | "neutral"` — Intent (semantic state)
|
|
19
|
+
- `variant: "solid" | "outline" | "subtle"` — Visual style variant
|
|
20
|
+
- `size: "sm" | "md" | "lg"` — Size
|
|
21
|
+
- `interactive: boolean` = false — Whether to enable the interactive state
|
|
22
|
+
|
|
23
|
+
## Design tokens it reads
|
|
24
|
+
|
|
25
|
+
`--wim-badge-dot-lg`, `--wim-badge-dot-md`, `--wim-badge-dot-sm`, `--wim-font-size-2xs`, `--wim-font-size-sm`, `--wim-font-size-xs`, `--wim-font-weight-medium`, `--wim-radius-full`, `--wim-scale-active`, `--wim-spacing-2xs`, `--wim-spacing-lg`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xs`, `--wim-transition-fast`
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Banner — wimui
|
|
2
|
+
|
|
3
|
+
> Top prominent messages
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Banner } from "wimui/feedback";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `title: React.ReactNode` — Title of the banner
|
|
15
|
+
- `description: React.ReactNode` — Description text of the banner
|
|
16
|
+
- `intent: "default" | "info" | "success" | "warning" | "danger"` = "default" — Intent (semantic state) of the banner @default "default"
|
|
17
|
+
- `icon: boolean | React.ReactNode` = true — Whether to show the icon, or a custom icon element @default true
|
|
18
|
+
- `extra: React.ReactNode` — Action element (e.g. a Button component)
|
|
19
|
+
- `onClose: () => void` — Called when the close button is clicked. Providing it shows the close button.
|
|
20
|
+
- `className: string` — Additional CSS class name
|
|
21
|
+
- `children: React.ReactNode` — Content of the banner
|
|
22
|
+
|
|
23
|
+
## Design tokens it reads
|
|
24
|
+
|
|
25
|
+
`--wim-border-width-thin`, `--wim-color-border-secondary`, `--wim-color-danger`, `--wim-color-info`, `--wim-color-success`, `--wim-color-surface`, `--wim-color-text-danger`, `--wim-color-text-info`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-color-text-success`, `--wim-color-text-warning`, `--wim-color-warning`, `--wim-comp-close-hover`, `--wim-font-size-sm`, `--wim-font-weight-semibold`, `--wim-line-height-snug-jp`, `--wim-opacity-disabled`, `--wim-opacity-ghost`, `--wim-radius-sm`, `--wim-scale-active-sm`, `--wim-shadow-focus`, `--wim-spacing-2xs`, `--wim-spacing-lg`, `--wim-spacing-md`, `--wim-transition-fast`, `--wim-width-sm`
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BarChart — wimui
|
|
2
|
+
|
|
3
|
+
> Bar charts
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { BarChart } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `data: ChartDataPoint[]` (required) — Data to display in the chart.
|
|
15
|
+
- `keys: string[]` (required) — Keys in the data objects to render as bars (series).
|
|
16
|
+
- `xAxisKey: string` (required) — The key in the data objects used for the X axis labels.
|
|
17
|
+
- `stacked: boolean` = false — If true, series are stacked on top of each other. @default false
|
|
18
|
+
- `yDomain: [ number | "auto" | "dataMin" | (string & {}), number | "auto" | "dataMax" | (string & {}), ]` = [0, "auto"] — Range of the Y axis. Pass ["auto", "auto"] when the change matters more than the distance from zero. Bars keep zero by default: their length is the value, so cutting the axis lies about the ratio between them. @default [0, "auto"]
|
|
19
|
+
- `height: number` = 300 — The height of the chart in pixels. @default 300
|
|
20
|
+
- `width: string | number` = "100%" — The width of the chart (e.g., "100%", 500). @default "100%"
|
|
21
|
+
- `title: string` — Optional title displayed above the chart.
|
|
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
|
+
---
|
|
26
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Barcode — wimui
|
|
2
|
+
|
|
3
|
+
> Draws a scannable Code 128 or EAN-13 barcode.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Barcode } from "wimui/data-display";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `value: string` (required) — Value to encode. For `ean13`, 12 digits (the check digit is calculated) or 13 digits (the check digit is verified).
|
|
15
|
+
- `format: "code128" | "ean13"` = "code128" — Symbology to encode `value` in. @default "code128"
|
|
16
|
+
- `height: number` = 64 — Height of the bars, in px. @default 64
|
|
17
|
+
- `moduleWidth: number` = 2 — Width of the narrowest bar, in px. Below 2 most phone cameras stop reading the symbol on screen. @default 2
|
|
18
|
+
- `showValue: boolean` = true — Whether the value is printed under the bars. @default true
|
|
19
|
+
- `label: string` — Accessible name. Defaults to the value, so that a screen reader can read out what a scanner would read.
|
|
20
|
+
|
|
21
|
+
## Design tokens it reads
|
|
22
|
+
|
|
23
|
+
`--wim-border-width-thin`, `--wim-color-surface`, `--wim-color-surface-void`, `--wim-color-text-danger`, `--wim-color-text-secondary`, `--wim-color-white`, `--wim-font-family-default`, `--wim-font-size-sm`, `--wim-letter-spacing-wide`, `--wim-line-height-normal`, `--wim-line-height-tight`, `--wim-radius-component`, `--wim-spacing-2xs`, `--wim-spacing-3xs`, `--wim-spacing-sm`
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# BentoGrid — wimui
|
|
2
|
+
|
|
3
|
+
> Modern card grid
|
|
4
|
+
|
|
5
|
+
Also known as: Waffle Menu, Bento Menu, Grid Menu, Candy Bar Menu, Chocolate Bar Menu, ベントーメニュー, ワッフルメニュー
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { BentoGrid } from "wimui/layout";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `children: React.ReactNode` — Grid items (typically BentoGrid.Item elements)
|
|
17
|
+
- `columns: 2 | 3 | 4` = 3 — How many columns the grid uses from container width `md` up; below that it is always a single column. Pick it from what the tiles hold — three columns is a layout decision, not a default to accept, and three equal tiles is the shape readers have learnt to skip. @default 3
|
|
18
|
+
- `rowHeight: string` — Fixed height of each grid row (`grid-auto-rows`). Any CSS length; defaults to `18rem`. Lower it when tiles hold compact content so they don't read as mostly-empty panels.
|
|
19
|
+
|
|
20
|
+
## Design tokens it reads
|
|
21
|
+
|
|
22
|
+
`--wim-bento-columns`, `--wim-bento-row-height`, `--wim-border-width-thin`, `--wim-color-border`, `--wim-color-surface`, `--wim-color-surface-subtle`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-weight-bold`, `--wim-radius-component`, `--wim-radius-container`, `--wim-shadow-md`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-transition-fast`, `--wim-width-sm`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Blockquote — wimui
|
|
2
|
+
|
|
3
|
+
> Visually separates external quotes or text to be emphasized.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Blockquote } from "wimui/typography";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `asChild: boolean` = false — If true, the blockquote will be rendered as its child, merging its props onto that child.
|
|
15
|
+
- `size: "sm" | "md" | "lg"` = "md" — Font size of the quote. @default "md"
|
|
16
|
+
- `color: T | (string & {})` — Text color. Accepts a design token color name or any CSS color value.
|
|
17
|
+
- `content: React.ReactNode` — Quoted content. Alternative to children.
|
|
18
|
+
- `cite: React.ReactNode` — Source of the quote, rendered in a `<cite>` element.
|
|
19
|
+
- `border: boolean` = true — Whether to show the left border. @default true
|
|
20
|
+
|
|
21
|
+
## Design tokens it reads
|
|
22
|
+
|
|
23
|
+
`--wim-blockquote-border-width`, `--wim-color-primary`, `--wim-color-text-accent`, `--wim-color-text-danger`, `--wim-color-text-info`, `--wim-color-text-secondary`, `--wim-color-text-success`, `--wim-color-text-warning`, `--wim-font-size-lg`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-size-small-scale`, `--wim-font-weight-normal`, `--wim-line-height-normal`, `--wim-spacing-2xl`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-transition-fast`
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BottomSheet — wimui
|
|
2
|
+
|
|
3
|
+
> Mobile bottom overlay
|
|
4
|
+
|
|
5
|
+
Also known as: Sheet, Action Sheet
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { BottomSheet } from "wimui/overlay";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `children: React.ReactNode` (required) — Bottom sheet parts (BottomSheetTrigger, BottomSheetContent, etc.).
|
|
17
|
+
- `open: boolean` — Controlled open state. Use together with onOpenChange.
|
|
18
|
+
- `defaultOpen: boolean` = false — Initial open state for uncontrolled usage. @default false
|
|
19
|
+
- `onOpenChange: (open: boolean) => void` — Called with the next state when the sheet is opened or closed.
|
|
20
|
+
|
|
21
|
+
## Design tokens it reads
|
|
22
|
+
|
|
23
|
+
`--wim-blur-2xs`, `--wim-border-width-thin`, `--wim-color-border`, `--wim-color-overlay`, `--wim-color-surface`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-duration-fast`, `--wim-easing-snap`, `--wim-font-size-sm`, `--wim-font-size-xl`, `--wim-font-weight-semibold`, `--wim-height-sm`, `--wim-line-height-snug-jp`, `--wim-overlay-max-width-md`, `--wim-radius-container`, `--wim-radius-sm`, `--wim-shadow-modal`, `--wim-spacing-lg`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xs`, `--wim-z-overlay`, `--wim-z-overlay-panel`
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
package/dist/llms/Box.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Box — wimui
|
|
2
|
+
|
|
3
|
+
> Polymorphic box
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Box } from "wimui/layout";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `as: C` — The component used for the root node. Either a string to use a HTML element or a component.
|
|
15
|
+
- `asChild: boolean` = false — If true, the box will be rendered as its child, merging its props onto that child.
|
|
16
|
+
- `p: number | WimSpacing` — Padding
|
|
17
|
+
- `pt: number | WimSpacing` — Padding top
|
|
18
|
+
- `pr: number | WimSpacing` — Padding right
|
|
19
|
+
- `pb: number | WimSpacing` — Padding bottom
|
|
20
|
+
- `pl: number | WimSpacing` — Padding left
|
|
21
|
+
- `px: number | WimSpacing` — Padding horizontal
|
|
22
|
+
- `py: number | WimSpacing` — Padding vertical
|
|
23
|
+
- `m: number | WimSpacing` — Margin
|
|
24
|
+
- `mt: number | WimSpacing` — Margin top
|
|
25
|
+
- `mr: number | WimSpacing` — Margin right
|
|
26
|
+
- `mb: number | WimSpacing` — Margin bottom
|
|
27
|
+
- `ml: number | WimSpacing` — Margin left
|
|
28
|
+
- `mx: number | WimSpacing` — Margin horizontal
|
|
29
|
+
- `my: number | WimSpacing` — Margin vertical
|
|
30
|
+
- `bg: T | (string & {})` — Background color
|
|
31
|
+
- `color: T | (string & {})` — Text color
|
|
32
|
+
- `w: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Width
|
|
33
|
+
- `h: T | { base?: T; sm?: T; md?: T; lg?: T; xl?: T; }` — Height
|
|
34
|
+
- `radius: number | WimRadius` — Border radius
|
|
35
|
+
- `shadow: T | (string & {})` — Box shadow
|
|
36
|
+
- `display: React.CSSProperties["display"]` — Display
|
|
37
|
+
- `position: React.CSSProperties["position"]` — Position
|
|
38
|
+
|
|
39
|
+
## Design tokens it reads
|
|
40
|
+
|
|
41
|
+
`--wim-box-h`, `--wim-box-h-lg`, `--wim-box-h-md`, `--wim-box-h-sm`, `--wim-box-h-xl`, `--wim-box-w`, `--wim-box-w-lg`, `--wim-box-w-md`, `--wim-box-w-sm`, `--wim-box-w-xl`
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# BoxPlot — wimui
|
|
2
|
+
|
|
3
|
+
> Five-number summary of a distribution per group
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { BoxPlot } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `data: BoxPlotItem[]` (required) — One entry per group. Each is a five-number summary, already computed.
|
|
15
|
+
- `height: number` = 300 — The height of the chart in pixels. @default 300
|
|
16
|
+
- `width: string | number` = "100%" — The width of the chart (e.g., "100%", 500). @default "100%"
|
|
17
|
+
- `title: string` — Optional title displayed above the chart.
|
|
18
|
+
- `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.
|
|
19
|
+
|
|
20
|
+
## Design tokens it reads
|
|
21
|
+
|
|
22
|
+
`--wim-color-chart-primary`, `--wim-color-text-primary`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Breadcrumb — wimui
|
|
2
|
+
|
|
3
|
+
> Location trace
|
|
4
|
+
|
|
5
|
+
Also known as: Path Bar, Path Control
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import "wimui/styles.css"; // once per app — required
|
|
11
|
+
import { Breadcrumb } from "wimui/navigation";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Props
|
|
15
|
+
|
|
16
|
+
- `items: BreadcrumbItem[]` (required) — Items to display, from the root to the current page.
|
|
17
|
+
- `separator: React.ReactNode` — Separator displayed between items. Defaults to a chevron icon.
|
|
18
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the breadcrumb. @default "md"
|
|
19
|
+
- `overflow: "wrap" | "collapse"` = "wrap" — What happens when the items do not fit on one line. `"wrap"` moves them onto more lines; `"collapse"` keeps the first item and the current page and folds the levels in between into a "…" button that lists them. @default "wrap"
|
|
20
|
+
- `moreLabel: (count: number) => string` — Accessible name of the "…" button, from the number of hidden levels. Defaults to a localized "Show hidden levels (n)".
|
|
21
|
+
- `className: string` — Additional CSS class name for the container.
|
|
22
|
+
- `ariaLabel: string` — Accessible label of the navigation landmark. Defaults to a localized "breadcrumb" label.
|
|
23
|
+
- `asChild: boolean` — If true, the breadcrumb will be rendered as its child, merging its props onto that child.
|
|
24
|
+
- `children: React.ReactNode` — The element that becomes the breadcrumb's root (in place of `nav`) when `asChild` is set. The list of items is rendered inside it. Ignored without `asChild`.
|
|
25
|
+
|
|
26
|
+
## Design tokens it reads
|
|
27
|
+
|
|
28
|
+
`--wim-color-text-primary`, `--wim-color-text-tertiary`, `--wim-font-size-lg`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-weight-bold`, `--wim-line-height-snug-jp`, `--wim-opacity-disabled`, `--wim-spacing-2xs`, `--wim-spacing-3xs`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xs`
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Button — wimui
|
|
2
|
+
|
|
3
|
+
> Action triggers
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Button } 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. Useful for using the button styles with Link components (e.g. from React Router or Next.js).
|
|
15
|
+
- `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.
|
|
16
|
+
- `size: "sm" | "md" | "lg"` = "md" — Size of the button
|
|
17
|
+
- `variant: "solid" | "outline" | "ghost"` = "outline" — Visual style variant of the button
|
|
18
|
+
- `intent: "default" | "danger" | "success"` = "default" — Design intent of the button (visual / semantic state). Unrelated to the ARIA role attribute.
|
|
19
|
+
- `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.
|
|
20
|
+
- `iconPosition: "left" | "right"` = "left" — Position of the icon relative to the label
|
|
21
|
+
- `loading: boolean` = false — Whether to show a loading indicator and disable interaction
|
|
22
|
+
- `justify: "start" | "center" | "end" | "between"` = "center" — Horizontal alignment of the button content
|
|
23
|
+
- `animateWidth: boolean` = false — Whether to animate the width change when label changes
|
|
24
|
+
- `fullWidth: boolean` = false — Whether the button should take up the full width of its container
|
|
25
|
+
- `styles: { root?: string; loader?: string; icon?: string; }` — Custom styles for internal parts
|
|
26
|
+
- `className: string` — Additional class names
|
|
27
|
+
|
|
28
|
+
## Design tokens it reads
|
|
29
|
+
|
|
30
|
+
`--wim-border-width-thick`, `--wim-button-border`, `--wim-button-h-padding`, `--wim-button-height`, `--wim-button-shadow-hover`, `--wim-button-transform`, `--wim-button-transform-active`, `--wim-button-v-padding`, `--wim-button-v-padding-base`, `--wim-color-danger`, `--wim-color-danger-border-hover`, `--wim-color-danger-surface-hover`, `--wim-color-disabled`, `--wim-color-ghost-bg-active`, `--wim-color-ghost-border-active`, `--wim-color-ghost-border-hover`, `--wim-color-primary`, `--wim-color-success`, `--wim-color-surface`, `--wim-color-surface-hover`, `--wim-color-text-danger`, `--wim-color-text-disabled`, `--wim-color-text-on-danger`, `--wim-color-text-on-disabled`, `--wim-color-text-on-primary`, `--wim-color-text-on-success`, `--wim-color-text-success`, `--wim-comp-control-default-bg`, `--wim-comp-control-default-border`, `--wim-comp-control-default-fg`, `--wim-control-padding-x-lg`, `--wim-control-padding-x-md`, `--wim-control-padding-x-sm`, `--wim-control-padding-y-lg`, `--wim-control-padding-y-md`, `--wim-control-padding-y-sm`, `--wim-duration-base`, `--wim-duration-fast`, `--wim-duration-ultra-fast`, `--wim-easing-standard`, `--wim-field-radius`, `--wim-field-radius-bl`, `--wim-field-radius-br`, `--wim-field-radius-tl`, `--wim-field-radius-tr`, `--wim-font-size-lg`, `--wim-font-size-md`, `--wim-font-size-sm`, `--wim-font-weight-medium`, `--wim-glass-gradient`, `--wim-height-lg`, `--wim-height-md`, `--wim-height-sm`, `--wim-inner-highlight`, `--wim-lift-none`, `--wim-line-height-tight`, `--wim-opacity-disabled`, `--wim-radius-component`, `--wim-scale-active`, `--wim-shadow-inset`, `--wim-shadow-md`, `--wim-shadow-sm`, `--wim-shadow-xs`, `--wim-spacing-xs`, `--wim-transition-base`
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ButtonGroup — wimui
|
|
2
|
+
|
|
3
|
+
> Group of buttons
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { ButtonGroup } from "wimui/form";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `children: React.ReactNode` (required) — Buttons to group
|
|
15
|
+
- `gap: string` = "8px" — Gap between buttons (ignored when joined)
|
|
16
|
+
- `className: string` — Additional class names
|
|
17
|
+
- `joined: boolean` = false — Whether to join the buttons into a single connected unit
|
|
18
|
+
- `variant: "solid" | "outline" | "ghost"` — Variant applied to all child buttons
|
|
19
|
+
- `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).
|
|
20
|
+
- `asChild: boolean` = false — Whether to render as a child element.
|
|
21
|
+
|
|
22
|
+
## Design tokens it reads
|
|
23
|
+
|
|
24
|
+
`--wim-border-width-thick`, `--wim-border-width-thin`, `--wim-button-transform`, `--wim-button-transform-active`, `--wim-color-overlay-soft`, `--wim-field-radius`, `--wim-field-radius-bl`, `--wim-field-radius-br`, `--wim-field-radius-tl`, `--wim-field-radius-tr`, `--wim-radius-component`, `--wim-spacing-sm`, `--wim-spacing-xl`, `--wim-spacing-xs`
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Calendar — wimui
|
|
2
|
+
|
|
3
|
+
> Calendar view
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { Calendar } from "wimui/data-display";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `defaultValue: Date` — Default selected date (uncontrolled)
|
|
15
|
+
- `value: Date` — Selected date (controlled)
|
|
16
|
+
- `minDate: Date` — Earliest selectable date
|
|
17
|
+
- `maxDate: Date` — Latest selectable date
|
|
18
|
+
- `disabledDates: Date[]` — Dates that cannot be selected
|
|
19
|
+
- `isDateDisabled: (date: Date) => boolean` — Function returning whether a given date is disabled
|
|
20
|
+
- `weekStartsOn: 0 | 1` = 0 — First day of the week (0 = Sunday, 1 = Monday)
|
|
21
|
+
- `className: string` — Additional class names
|
|
22
|
+
- `disabled: boolean` = false — Whether the calendar is disabled
|
|
23
|
+
- `onChange: (date: Date) => void` — Callback when a date is selected (single mode)
|
|
24
|
+
- `rangeMode: boolean` = false — Whether to enable range selection mode
|
|
25
|
+
- `range: { start: Date | null; end: Date | null; }` — Selected range (controlled, range mode)
|
|
26
|
+
- `defaultRange: { start: Date | null; end: Date | null; }` — Default selected range (uncontrolled, range mode)
|
|
27
|
+
- `onRangeChange: (range: CalendarRange) => void` — Callback when the range changes (range mode)
|
|
28
|
+
|
|
29
|
+
## Design tokens it reads
|
|
30
|
+
|
|
31
|
+
`--wim-border-width-thin`, `--wim-calendar-day-height`, `--wim-calendar-nav-size`, `--wim-calendar-weekday-height`, `--wim-calendar-width`, `--wim-color-line`, `--wim-color-primary`, `--wim-color-surface`, `--wim-color-surface-hover`, `--wim-color-surface-variant-alpha`, `--wim-color-text-accent`, `--wim-color-text-danger`, `--wim-color-text-disabled`, `--wim-color-text-info`, `--wim-color-text-on-primary`, `--wim-color-text-primary`, `--wim-color-text-secondary`, `--wim-color-text-tertiary`, `--wim-duration-base`, `--wim-easing-standard`, `--wim-font-family-default`, `--wim-font-size-md`, `--wim-font-size-xs`, `--wim-font-weight-bold`, `--wim-font-weight-semibold`, `--wim-height-xs`, `--wim-opacity-disabled`, `--wim-radius-component`, `--wim-radius-sm`, `--wim-spacing-3xs`, `--wim-spacing-5xl`, `--wim-spacing-md`, `--wim-spacing-xs`, `--wim-tap-target-min`, `--wim-transition-fast`
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# CalendarHeatmap — wimui
|
|
2
|
+
|
|
3
|
+
> GitHub-style activity graph for visualizing continuity
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { CalendarHeatmap } from "wimui/data-display";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `data: CalendarHeatmapData[]` = [] — Activity data array.
|
|
15
|
+
- `year: number` = new Date().getFullYear() — The year to display. @default current year
|
|
16
|
+
- `getColorLevel: (count: number) => 0 | 1 | 2 | 3 | 4` = (count) => {
|
|
17
|
+
if (count === 0) return 0;
|
|
18
|
+
if (count < 3) return 1;
|
|
19
|
+
if (count < 6) return 2;
|
|
20
|
+
if (count < 9) return 3;
|
|
21
|
+
return 4;
|
|
22
|
+
} — Function to map count to a level (0-4).
|
|
23
|
+
- `className: string` — Custom class name for the root element.
|
|
24
|
+
- `tooltipFormatter: (date: string, count: number) => React.ReactNode` — Custom tooltip formatter.
|
|
25
|
+
- `asChild: boolean` = false — Whether to render as a child component.
|
|
26
|
+
- `children: React.ReactNode` — Content to render inside.
|
|
27
|
+
|
|
28
|
+
## Design tokens it reads
|
|
29
|
+
|
|
30
|
+
`--wim-border-width-thin`, `--wim-color-border`, `--wim-color-ghost-bg`, `--wim-color-surface`, `--wim-color-text-secondary`, `--wim-comp-heatmap-level-0`, `--wim-comp-heatmap-level-1`, `--wim-comp-heatmap-level-2`, `--wim-comp-heatmap-level-3`, `--wim-comp-heatmap-level-4`, `--wim-duration-fast`, `--wim-easing-standard`, `--wim-font-size-3xs`, `--wim-radius-container`, `--wim-radius-full`, `--wim-radius-sm`, `--wim-spacing-2xs`, `--wim-spacing-md`, `--wim-spacing-sm`, `--wim-spacing-xs`
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# CandlestickChart — wimui
|
|
2
|
+
|
|
3
|
+
> Open, high, low and close per period
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import "wimui/styles.css"; // once per app — required
|
|
9
|
+
import { CandlestickChart } from "wimui/charts";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
- `data: Candle[]` (required) — One entry per period, oldest first.
|
|
15
|
+
- `height: number` = 300 — The height of the chart in pixels. @default 300
|
|
16
|
+
- `width: string | number` = "100%" — The width of the chart (e.g., "100%", 500). @default "100%"
|
|
17
|
+
- `title: string` — Optional title displayed above the chart.
|
|
18
|
+
- `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.
|
|
19
|
+
|
|
20
|
+
## Design tokens it reads
|
|
21
|
+
|
|
22
|
+
`--wim-color-chart-danger`, `--wim-color-chart-success`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
Setup, composition rules and the full catalog: `llms.txt` / `llms-full.txt` in the same package.
|