@zonsh/ui 0.5.0 → 0.6.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/CHANGELOG.md +639 -0
- package/README.md +49 -21
- package/dist/brand.d.ts +3 -0
- package/dist/brand.js +7 -0
- package/dist/components/_breadcrumb-more.d.ts +6 -0
- package/dist/components/_breadcrumb-more.js +5 -0
- package/dist/components/_drawing-svg.d.ts +11 -0
- package/dist/components/_drawing-svg.js +30 -0
- package/dist/components/_media.d.ts +159 -0
- package/dist/components/_media.js +266 -0
- package/dist/components/_overlay.d.ts +8 -5
- package/dist/components/_overlay.js +11 -6
- package/dist/components/_scheduler-calendar.d.ts +71 -0
- package/dist/components/_scheduler-calendar.js +940 -0
- package/dist/components/_scheduler-editor.d.ts +29 -0
- package/dist/components/_scheduler-editor.js +111 -0
- package/dist/components/_scheduler-menu.d.ts +16 -0
- package/dist/components/_scheduler-menu.js +18 -0
- package/dist/components/_scheduler-parts.d.ts +164 -0
- package/dist/components/_scheduler-parts.js +327 -0
- package/dist/components/_suggest-list.d.ts +142 -0
- package/dist/components/_suggest-list.js +159 -0
- package/dist/components/_toolbar-more.d.ts +24 -0
- package/dist/components/_toolbar-more.js +25 -0
- package/dist/components/accordion.d.ts +1 -1
- package/dist/components/accordion.js +6 -6
- package/dist/components/action-sheet.d.ts +88 -0
- package/dist/components/action-sheet.js +124 -0
- package/dist/components/alert-dialog.js +3 -1
- package/dist/components/alert.d.ts +11 -18
- package/dist/components/alert.js +9 -6
- package/dist/components/app-bar.d.ts +93 -0
- package/dist/components/app-bar.js +175 -0
- package/dist/components/audio-player.d.ts +134 -0
- package/dist/components/audio-player.js +618 -0
- package/dist/components/avatar.d.ts +6 -6
- package/dist/components/avatar.js +13 -11
- package/dist/components/badge.d.ts +12 -12
- package/dist/components/badge.js +7 -5
- package/dist/components/bottom-nav.d.ts +53 -11
- package/dist/components/bottom-nav.js +388 -23
- package/dist/components/breadcrumb.d.ts +11 -2
- package/dist/components/breadcrumb.js +60 -6
- package/dist/components/button-group.js +5 -1
- package/dist/components/button.d.ts +23 -6
- package/dist/components/button.js +63 -7
- package/dist/components/calendar.js +8 -6
- package/dist/components/card.d.ts +10 -8
- package/dist/components/card.js +15 -14
- package/dist/components/carousel.d.ts +2 -2
- package/dist/components/carousel.js +21 -8
- package/dist/components/chart.d.ts +27 -1
- package/dist/components/chart.js +15 -5
- package/dist/components/checkbox.js +2 -2
- package/dist/components/code-block.d.ts +9 -2
- package/dist/components/code-block.js +26 -7
- package/dist/components/collapsible.js +3 -3
- package/dist/components/color-picker.d.ts +2 -2
- package/dist/components/color-picker.js +5 -5
- package/dist/components/combobox.d.ts +26 -7
- package/dist/components/combobox.js +32 -13
- package/dist/components/command.d.ts +29 -5
- package/dist/components/command.js +35 -10
- package/dist/components/context-menu.d.ts +5 -2
- package/dist/components/context-menu.js +24 -3
- package/dist/components/conversation.d.ts +1 -1
- package/dist/components/conversation.js +67 -13
- package/dist/components/copy-button.d.ts +1 -1
- package/dist/components/copy-button.js +1 -1
- package/dist/components/data-table.d.ts +6 -6
- package/dist/components/data-table.js +41 -15
- package/dist/components/date-picker.d.ts +31 -9
- package/dist/components/date-picker.js +100 -18
- package/dist/components/dialog.d.ts +17 -10
- package/dist/components/dialog.js +20 -13
- package/dist/components/drawer.d.ts +26 -8
- package/dist/components/drawer.js +75 -16
- package/dist/components/drawing.d.ts +25 -0
- package/dist/components/drawing.js +32 -0
- package/dist/components/empty.js +2 -2
- package/dist/components/feature-list.d.ts +65 -13
- package/dist/components/feature-list.js +116 -15
- package/dist/components/field.js +2 -2
- package/dist/components/file-drop.d.ts +9 -7
- package/dist/components/file-drop.js +8 -43
- package/dist/components/filter-bar.d.ts +10 -9
- package/dist/components/filter-bar.js +42 -25
- package/dist/components/graph.d.ts +19 -3
- package/dist/components/graph.js +170 -25
- package/dist/components/illustration.js +3 -28
- package/dist/components/input-group.d.ts +5 -10
- package/dist/components/input-group.js +16 -16
- package/dist/components/input.d.ts +2 -2
- package/dist/components/input.js +3 -3
- package/dist/components/item.d.ts +9 -6
- package/dist/components/item.js +13 -8
- package/dist/components/kbd.d.ts +1 -1
- package/dist/components/kbd.js +1 -1
- package/dist/components/lightbox.d.ts +76 -9
- package/dist/components/lightbox.js +333 -45
- package/dist/components/locale.d.ts +6 -6
- package/dist/components/logo.d.ts +21 -1
- package/dist/components/logo.js +32 -2
- package/dist/components/markdown-editor.d.ts +275 -0
- package/dist/components/markdown-editor.js +831 -0
- package/dist/components/mentions.d.ts +153 -0
- package/dist/components/mentions.js +507 -0
- package/dist/components/menu.d.ts +2 -1
- package/dist/components/menu.js +5 -4
- package/dist/components/menubar.d.ts +23 -5
- package/dist/components/menubar.js +97 -22
- package/dist/components/message.d.ts +62 -11
- package/dist/components/message.js +49 -13
- package/dist/components/meter.js +1 -1
- package/dist/components/money-input.d.ts +1 -1
- package/dist/components/money-input.js +1 -1
- package/dist/components/native-select.d.ts +2 -2
- package/dist/components/native-select.js +4 -4
- package/dist/components/navigation-menu.d.ts +3 -1
- package/dist/components/navigation-menu.js +23 -12
- package/dist/components/number-field.d.ts +2 -9
- package/dist/components/number-field.js +86 -36
- package/dist/components/number-roll.d.ts +26 -0
- package/dist/components/number-roll.js +81 -0
- package/dist/components/otp-field.d.ts +1 -1
- package/dist/components/otp-field.js +24 -3
- package/dist/components/pagination.d.ts +11 -3
- package/dist/components/pagination.js +59 -13
- package/dist/components/pdf-viewer.d.ts +1 -1
- package/dist/components/pdf-viewer.js +8 -8
- package/dist/components/phone-input.d.ts +1 -1
- package/dist/components/phone-input.js +2 -2
- package/dist/components/popover.js +5 -3
- package/dist/components/preview-card.d.ts +37 -2
- package/dist/components/preview-card.js +226 -2
- package/dist/components/progress.js +1 -1
- package/dist/components/prompt-input.d.ts +1 -1
- package/dist/components/prompt-input.js +24 -14
- package/dist/components/pull-to-refresh.d.ts +50 -0
- package/dist/components/pull-to-refresh.js +189 -0
- package/dist/components/quote.d.ts +6 -1
- package/dist/components/quote.js +3 -2
- package/dist/components/radio-group.js +1 -1
- package/dist/components/rating.d.ts +4 -1
- package/dist/components/rating.js +131 -10
- package/dist/components/reasoning.d.ts +1 -1
- package/dist/components/reasoning.js +7 -3
- package/dist/components/resizable.d.ts +1 -1
- package/dist/components/resizable.js +2 -2
- package/dist/components/response.d.ts +1 -1
- package/dist/components/response.js +18 -6
- package/dist/components/scheduler.d.ts +352 -0
- package/dist/components/scheduler.js +1717 -0
- package/dist/components/scroll-area.js +1 -1
- package/dist/components/select.d.ts +17 -4
- package/dist/components/select.js +140 -9
- package/dist/components/separator.d.ts +1 -1
- package/dist/components/separator.js +3 -3
- package/dist/components/sidebar.d.ts +44 -3
- package/dist/components/sidebar.js +57 -17
- package/dist/components/site-header.d.ts +18 -13
- package/dist/components/site-header.js +23 -11
- package/dist/components/skeleton.d.ts +17 -7
- package/dist/components/skeleton.js +22 -7
- package/dist/components/slider.js +2 -2
- package/dist/components/sortable.d.ts +55 -4
- package/dist/components/sortable.js +172 -103
- package/dist/components/sources.d.ts +1 -1
- package/dist/components/sources.js +2 -2
- package/dist/components/spinner.d.ts +4 -4
- package/dist/components/spinner.js +4 -4
- package/dist/components/stat.d.ts +21 -4
- package/dist/components/stat.js +17 -8
- package/dist/components/stepper.d.ts +1 -1
- package/dist/components/stepper.js +8 -7
- package/dist/components/suggestions.d.ts +11 -3
- package/dist/components/suggestions.js +10 -4
- package/dist/components/swipe-actions.d.ts +66 -0
- package/dist/components/swipe-actions.js +292 -0
- package/dist/components/switch.js +1 -1
- package/dist/components/table.d.ts +12 -6
- package/dist/components/table.js +78 -30
- package/dist/components/tabs.js +7 -4
- package/dist/components/tag.d.ts +19 -20
- package/dist/components/tag.js +9 -5
- package/dist/components/tags-input.d.ts +2 -7
- package/dist/components/tags-input.js +11 -8
- package/dist/components/textarea.d.ts +3 -2
- package/dist/components/textarea.js +4 -3
- package/dist/components/theme.d.ts +49 -6
- package/dist/components/theme.js +147 -9
- package/dist/components/time-field.d.ts +4 -9
- package/dist/components/time-field.js +6 -6
- package/dist/components/timeline.d.ts +19 -3
- package/dist/components/timeline.js +21 -9
- package/dist/components/tippy.d.ts +17 -1
- package/dist/components/tippy.js +95 -15
- package/dist/components/toast.d.ts +2 -7
- package/dist/components/toast.js +12 -8
- package/dist/components/toggle-group.d.ts +7 -1
- package/dist/components/toggle-group.js +16 -5
- package/dist/components/toggle.d.ts +2 -2
- package/dist/components/toggle.js +3 -2
- package/dist/components/tool-call.d.ts +1 -1
- package/dist/components/tool-call.js +4 -4
- package/dist/components/toolbar.d.ts +57 -4
- package/dist/components/toolbar.js +216 -16
- package/dist/components/tooltip.d.ts +1 -1
- package/dist/components/tooltip.js +4 -2
- package/dist/components/tour.d.ts +1 -1
- package/dist/components/tour.js +36 -15
- package/dist/components/tree.js +5 -5
- package/dist/components/typography.d.ts +31 -8
- package/dist/components/typography.js +21 -10
- package/dist/components/video-player.d.ts +7 -2
- package/dist/components/video-player.js +121 -220
- package/dist/index.d.ts +99 -92
- package/dist/index.js +99 -92
- package/dist/lib/calendar.d.ts +153 -0
- package/dist/lib/calendar.js +312 -0
- package/dist/lib/cn.d.ts +3 -1
- package/dist/lib/cn.js +5 -0
- package/dist/lib/code-highlight.d.ts +14 -0
- package/dist/lib/code-highlight.js +81 -18
- package/dist/lib/drag.d.ts +39 -0
- package/dist/lib/drag.js +96 -0
- package/dist/lib/editorial-assets.js +16 -8
- package/dist/lib/figure/figures/automation.js +25 -6
- package/dist/lib/figure/figures/bar-chart.js +6 -1
- package/dist/lib/figure/figures/brackets-classic.js +4 -1
- package/dist/lib/figure/figures/city.js +12 -2
- package/dist/lib/figure/figures/conveyor.js +17 -4
- package/dist/lib/figure/figures/database.js +5 -2
- package/dist/lib/figure/figures/documents.js +11 -3
- package/dist/lib/figure/figures/inbox.js +5 -2
- package/dist/lib/figure/figures/laptop.js +3 -1
- package/dist/lib/figure/figures/pipeline.js +45 -10
- package/dist/lib/figure/figures/platform.js +62 -7
- package/dist/lib/figure/figures/server.js +21 -5
- package/dist/lib/figure/figures/spreadsheet.js +29 -5
- package/dist/lib/figure/kernel.d.ts +4 -2
- package/dist/lib/figure/kernel.js +10 -5
- package/dist/lib/figure/parts.js +6 -2
- package/dist/lib/files.d.ts +31 -0
- package/dist/lib/files.js +60 -0
- package/dist/lib/gesture.d.ts +70 -0
- package/dist/lib/gesture.js +141 -0
- package/dist/lib/glide.d.ts +5 -0
- package/dist/lib/glide.js +9 -1
- package/dist/lib/icons.d.ts +1 -0
- package/dist/lib/icons.js +6 -0
- package/dist/lib/illustration-library.js +1 -6
- package/dist/lib/markdown-edit.d.ts +112 -0
- package/dist/lib/markdown-edit.js +557 -0
- package/dist/lib/markdown-rich-editor.d.ts +188 -0
- package/dist/lib/markdown-rich-editor.js +1153 -0
- package/dist/lib/markdown-rich.d.ts +63 -0
- package/dist/lib/markdown-rich.js +534 -0
- package/dist/lib/mentions.d.ts +100 -0
- package/dist/lib/mentions.js +246 -0
- package/dist/lib/motion.d.ts +18 -0
- package/dist/lib/motion.js +43 -5
- package/dist/lib/number-roll.d.ts +89 -0
- package/dist/lib/number-roll.js +391 -0
- package/dist/lib/platform.d.ts +6 -0
- package/dist/lib/platform.js +14 -0
- package/dist/lib/portal-container.d.ts +9 -0
- package/dist/lib/portal-container.js +10 -0
- package/dist/lib/press.d.ts +5 -0
- package/dist/lib/press.js +186 -0
- package/dist/lib/scheduler.d.ts +128 -0
- package/dist/lib/scheduler.js +272 -0
- package/dist/lib/scroll-edges.d.ts +9 -0
- package/dist/lib/scroll-edges.js +50 -0
- package/dist/lib/table-fit.d.ts +1 -1
- package/dist/lib/table-fit.js +65 -8
- package/dist/lib/theme-preset.d.ts +267 -0
- package/dist/lib/theme-preset.js +1046 -0
- package/dist/lib/theme-script.d.ts +23 -3
- package/dist/lib/theme-script.js +17 -5
- package/dist/lib/tippy/sprite.d.ts +36 -4
- package/dist/lib/tippy/sprite.js +188 -15
- package/dist/lib/tone.d.ts +4 -0
- package/dist/lib/tone.js +1 -0
- package/dist/messages/de.d.ts +3 -3
- package/dist/messages/de.js +274 -3
- package/dist/skills/zon-ui/SKILL.md +279 -0
- package/dist/skills/zon-ui/references/authoring.md +265 -0
- package/dist/skills/zon-ui/references/brand.md +416 -0
- package/dist/skills/zon-ui/references/components/accordion.md +199 -0
- package/dist/skills/zon-ui/references/components/action-sheet.md +268 -0
- package/dist/skills/zon-ui/references/components/alert-dialog.md +276 -0
- package/dist/skills/zon-ui/references/components/alert.md +167 -0
- package/dist/skills/zon-ui/references/components/app-bar.md +307 -0
- package/dist/skills/zon-ui/references/components/ascii-field.md +121 -0
- package/dist/skills/zon-ui/references/components/aspect-ratio.md +112 -0
- package/dist/skills/zon-ui/references/components/audio-player.md +231 -0
- package/dist/skills/zon-ui/references/components/avatar.md +98 -0
- package/dist/skills/zon-ui/references/components/badge.md +227 -0
- package/dist/skills/zon-ui/references/components/bottom-nav.md +709 -0
- package/dist/skills/zon-ui/references/components/breadcrumb.md +143 -0
- package/dist/skills/zon-ui/references/components/button-group.md +216 -0
- package/dist/skills/zon-ui/references/components/button.md +309 -0
- package/dist/skills/zon-ui/references/components/calendar.md +296 -0
- package/dist/skills/zon-ui/references/components/card.md +158 -0
- package/dist/skills/zon-ui/references/components/carousel.md +297 -0
- package/dist/skills/zon-ui/references/components/chart.md +739 -0
- package/dist/skills/zon-ui/references/components/chat.md +417 -0
- package/dist/skills/zon-ui/references/components/checkbox.md +219 -0
- package/dist/skills/zon-ui/references/components/code-block.md +143 -0
- package/dist/skills/zon-ui/references/components/code-highlight.md +118 -0
- package/dist/skills/zon-ui/references/components/collapsible.md +146 -0
- package/dist/skills/zon-ui/references/components/color-picker.md +200 -0
- package/dist/skills/zon-ui/references/components/combobox.md +455 -0
- package/dist/skills/zon-ui/references/components/command.md +326 -0
- package/dist/skills/zon-ui/references/components/contact-form.md +562 -0
- package/dist/skills/zon-ui/references/components/context-menu.md +159 -0
- package/dist/skills/zon-ui/references/components/conversation.md +146 -0
- package/dist/skills/zon-ui/references/components/copy-button.md +162 -0
- package/dist/skills/zon-ui/references/components/crm.md +1022 -0
- package/dist/skills/zon-ui/references/components/dashboard.md +612 -0
- package/dist/skills/zon-ui/references/components/data-table.md +776 -0
- package/dist/skills/zon-ui/references/components/date-picker.md +444 -0
- package/dist/skills/zon-ui/references/components/dialog.md +335 -0
- package/dist/skills/zon-ui/references/components/direction.md +165 -0
- package/dist/skills/zon-ui/references/components/drawer.md +276 -0
- package/dist/skills/zon-ui/references/components/drawing.md +94 -0
- package/dist/skills/zon-ui/references/components/empty.md +225 -0
- package/dist/skills/zon-ui/references/components/feature-list.md +412 -0
- package/dist/skills/zon-ui/references/components/field.md +209 -0
- package/dist/skills/zon-ui/references/components/file-drop.md +234 -0
- package/dist/skills/zon-ui/references/components/filter-bar.md +485 -0
- package/dist/skills/zon-ui/references/components/form.md +970 -0
- package/dist/skills/zon-ui/references/components/graph.md +339 -0
- package/dist/skills/zon-ui/references/components/illustration.md +497 -0
- package/dist/skills/zon-ui/references/components/inbox.md +263 -0
- package/dist/skills/zon-ui/references/components/input-group.md +339 -0
- package/dist/skills/zon-ui/references/components/input.md +189 -0
- package/dist/skills/zon-ui/references/components/item.md +277 -0
- package/dist/skills/zon-ui/references/components/kanban.md +626 -0
- package/dist/skills/zon-ui/references/components/kbd.md +116 -0
- package/dist/skills/zon-ui/references/components/label.md +104 -0
- package/dist/skills/zon-ui/references/components/layout.md +291 -0
- package/dist/skills/zon-ui/references/components/lightbox.md +235 -0
- package/dist/skills/zon-ui/references/components/locale.md +279 -0
- package/dist/skills/zon-ui/references/components/logo.md +257 -0
- package/dist/skills/zon-ui/references/components/markdown-editor.md +558 -0
- package/dist/skills/zon-ui/references/components/mentions.md +512 -0
- package/dist/skills/zon-ui/references/components/menu.md +218 -0
- package/dist/skills/zon-ui/references/components/menubar.md +292 -0
- package/dist/skills/zon-ui/references/components/message.md +243 -0
- package/dist/skills/zon-ui/references/components/meter.md +105 -0
- package/dist/skills/zon-ui/references/components/money-input.md +333 -0
- package/dist/skills/zon-ui/references/components/native-select.md +197 -0
- package/dist/skills/zon-ui/references/components/navigation-menu.md +253 -0
- package/dist/skills/zon-ui/references/components/number-field.md +210 -0
- package/dist/skills/zon-ui/references/components/number-roll.md +175 -0
- package/dist/skills/zon-ui/references/components/onboarding.md +896 -0
- package/dist/skills/zon-ui/references/components/otp-field.md +166 -0
- package/dist/skills/zon-ui/references/components/pagination.md +109 -0
- package/dist/skills/zon-ui/references/components/pdf-viewer.md +177 -0
- package/dist/skills/zon-ui/references/components/phone-input.md +252 -0
- package/dist/skills/zon-ui/references/components/popover.md +176 -0
- package/dist/skills/zon-ui/references/components/preview-card.md +193 -0
- package/dist/skills/zon-ui/references/components/pricing.md +724 -0
- package/dist/skills/zon-ui/references/components/progress.md +92 -0
- package/dist/skills/zon-ui/references/components/prompt-input.md +307 -0
- package/dist/skills/zon-ui/references/components/pull-to-refresh.md +188 -0
- package/dist/skills/zon-ui/references/components/quote.md +115 -0
- package/dist/skills/zon-ui/references/components/radio-group.md +215 -0
- package/dist/skills/zon-ui/references/components/rating.md +260 -0
- package/dist/skills/zon-ui/references/components/reasoning.md +102 -0
- package/dist/skills/zon-ui/references/components/resizable.md +213 -0
- package/dist/skills/zon-ui/references/components/response.md +170 -0
- package/dist/skills/zon-ui/references/components/scheduler.md +732 -0
- package/dist/skills/zon-ui/references/components/scroll-area.md +122 -0
- package/dist/skills/zon-ui/references/components/select.md +351 -0
- package/dist/skills/zon-ui/references/components/separator.md +103 -0
- package/dist/skills/zon-ui/references/components/settings.md +793 -0
- package/dist/skills/zon-ui/references/components/shop.md +1715 -0
- package/dist/skills/zon-ui/references/components/sidebar.md +813 -0
- package/dist/skills/zon-ui/references/components/sign-in.md +1639 -0
- package/dist/skills/zon-ui/references/components/site-header.md +303 -0
- package/dist/skills/zon-ui/references/components/skeleton.md +256 -0
- package/dist/skills/zon-ui/references/components/slider.md +172 -0
- package/dist/skills/zon-ui/references/components/sortable.md +405 -0
- package/dist/skills/zon-ui/references/components/sources.md +106 -0
- package/dist/skills/zon-ui/references/components/spinner.md +222 -0
- package/dist/skills/zon-ui/references/components/stat.md +267 -0
- package/dist/skills/zon-ui/references/components/stepper.md +285 -0
- package/dist/skills/zon-ui/references/components/suggestions.md +146 -0
- package/dist/skills/zon-ui/references/components/swipe-actions.md +344 -0
- package/dist/skills/zon-ui/references/components/switch.md +160 -0
- package/dist/skills/zon-ui/references/components/table.md +999 -0
- package/dist/skills/zon-ui/references/components/tabs.md +258 -0
- package/dist/skills/zon-ui/references/components/tag.md +115 -0
- package/dist/skills/zon-ui/references/components/tags-input.md +216 -0
- package/dist/skills/zon-ui/references/components/textarea.md +95 -0
- package/dist/skills/zon-ui/references/components/theme-editor.md +3940 -0
- package/dist/skills/zon-ui/references/components/theme.md +362 -0
- package/dist/skills/zon-ui/references/components/time-field.md +222 -0
- package/dist/skills/zon-ui/references/components/timeline.md +285 -0
- package/dist/skills/zon-ui/references/components/tippy.md +243 -0
- package/dist/skills/zon-ui/references/components/toast.md +220 -0
- package/dist/skills/zon-ui/references/components/toggle-group.md +261 -0
- package/dist/skills/zon-ui/references/components/toggle.md +167 -0
- package/dist/skills/zon-ui/references/components/tool-call.md +146 -0
- package/dist/skills/zon-ui/references/components/toolbar.md +260 -0
- package/dist/skills/zon-ui/references/components/tooltip.md +172 -0
- package/dist/skills/zon-ui/references/components/tour.md +423 -0
- package/dist/skills/zon-ui/references/components/tree.md +481 -0
- package/dist/skills/zon-ui/references/components/typography.md +347 -0
- package/dist/skills/zon-ui/references/components/video-player.md +386 -0
- package/dist/skills/zon-ui/references/marketing.md +467 -0
- package/dist/skills/zon-ui/references/motion.md +455 -0
- package/dist/skills/zon-ui/references/recipes.md +1232 -0
- package/dist/skills/zon-ui/references/tokens.md +866 -0
- package/dist/sources/accordion.css +4 -0
- package/dist/sources/action-sheet.css +11 -0
- package/dist/sources/alert-dialog.css +6 -0
- package/dist/sources/alert.css +3 -0
- package/dist/sources/app-bar.css +14 -0
- package/dist/sources/ascii-field.css +3 -0
- package/dist/sources/aspect-ratio.css +3 -0
- package/dist/sources/audio-player.css +20 -0
- package/dist/sources/avatar.css +3 -0
- package/dist/sources/badge.css +3 -0
- package/dist/sources/bottom-nav.css +9 -0
- package/dist/sources/breadcrumb.css +14 -0
- package/dist/sources/button-group.css +3 -0
- package/dist/sources/button.css +9 -0
- package/dist/sources/calendar.css +13 -0
- package/dist/sources/card.css +3 -0
- package/dist/sources/carousel.css +11 -0
- package/dist/sources/chart.css +5 -0
- package/dist/sources/checkbox.css +6 -0
- package/dist/sources/code-block.css +13 -0
- package/dist/sources/collapsible.css +4 -0
- package/dist/sources/color-picker.css +13 -0
- package/dist/sources/combobox.css +13 -0
- package/dist/sources/command.css +13 -0
- package/dist/sources/context-menu.css +12 -0
- package/dist/sources/conversation.css +10 -0
- package/dist/sources/copy-button.css +10 -0
- package/dist/sources/data-table.css +27 -0
- package/dist/sources/date-picker.css +20 -0
- package/dist/sources/dialog.css +9 -0
- package/dist/sources/direction.css +2 -0
- package/dist/sources/drawer.css +9 -0
- package/dist/sources/drawing.css +5 -0
- package/dist/sources/empty.css +3 -0
- package/dist/sources/feature-list.css +4 -0
- package/dist/sources/field.css +4 -0
- package/dist/sources/file-drop.css +15 -0
- package/dist/sources/filter-bar.css +30 -0
- package/dist/sources/form.css +4 -0
- package/dist/sources/graph.css +19 -0
- package/dist/sources/illustration.css +28 -0
- package/dist/sources/input-group.css +7 -0
- package/dist/sources/input.css +3 -0
- package/dist/sources/item.css +4 -0
- package/dist/sources/kbd.css +5 -0
- package/dist/sources/label.css +3 -0
- package/dist/sources/layout.css +3 -0
- package/dist/sources/lightbox.css +33 -0
- package/dist/sources/locale.css +2 -0
- package/dist/sources/logo.css +4 -0
- package/dist/sources/markdown-editor.css +41 -0
- package/dist/sources/mentions.css +13 -0
- package/dist/sources/menu.css +11 -0
- package/dist/sources/menubar.css +14 -0
- package/dist/sources/message.css +16 -0
- package/dist/sources/meter.css +4 -0
- package/dist/sources/money-input.css +10 -0
- package/dist/sources/native-select.css +4 -0
- package/dist/sources/navigation-menu.css +8 -0
- package/dist/sources/number-field.css +8 -0
- package/dist/sources/number-roll.css +6 -0
- package/dist/sources/otp-field.css +5 -0
- package/dist/sources/pagination.css +11 -0
- package/dist/sources/pdf-viewer.css +30 -0
- package/dist/sources/phone-input.css +20 -0
- package/dist/sources/popover.css +7 -0
- package/dist/sources/preview-card.css +7 -0
- package/dist/sources/progress.css +4 -0
- package/dist/sources/prompt-input.css +15 -0
- package/dist/sources/pull-to-refresh.css +14 -0
- package/dist/sources/quote.css +3 -0
- package/dist/sources/radio-group.css +5 -0
- package/dist/sources/rating.css +6 -0
- package/dist/sources/reasoning.css +6 -0
- package/dist/sources/resizable.css +4 -0
- package/dist/sources/response.css +16 -0
- package/dist/sources/scheduler.css +44 -0
- package/dist/sources/scroll-area.css +3 -0
- package/dist/sources/select.css +12 -0
- package/dist/sources/separator.css +3 -0
- package/dist/sources/sidebar.css +19 -0
- package/dist/sources/site-header.css +15 -0
- package/dist/sources/skeleton.css +3 -0
- package/dist/sources/slider.css +6 -0
- package/dist/sources/sortable.css +12 -0
- package/dist/sources/sources.css +6 -0
- package/dist/sources/spinner.css +6 -0
- package/dist/sources/stat.css +9 -0
- package/dist/sources/stepper.css +6 -0
- package/dist/sources/suggestions.css +10 -0
- package/dist/sources/swipe-actions.css +20 -0
- package/dist/sources/switch.css +5 -0
- package/dist/sources/table.css +7 -0
- package/dist/sources/tabs.css +5 -0
- package/dist/sources/tag.css +3 -0
- package/dist/sources/tags-input.css +6 -0
- package/dist/sources/textarea.css +3 -0
- package/dist/sources/theme.css +13 -0
- package/dist/sources/time-field.css +7 -0
- package/dist/sources/timeline.css +7 -0
- package/dist/sources/tippy.css +6 -0
- package/dist/sources/toast.css +6 -0
- package/dist/sources/toggle-group.css +5 -0
- package/dist/sources/toggle.css +3 -0
- package/dist/sources/tool-call.css +16 -0
- package/dist/sources/toolbar.css +14 -0
- package/dist/sources/tooltip.css +6 -0
- package/dist/sources/tour.css +14 -0
- package/dist/sources/tree.css +6 -0
- package/dist/sources/typography.css +4 -0
- package/dist/sources/video-player.css +21 -0
- package/dist/styles/ai.css +3 -0
- package/dist/styles/brand.css +98 -0
- package/dist/styles/core.css +266 -0
- package/dist/styles/editor.css +3 -0
- package/dist/styles/expressive.css +35 -56
- package/dist/styles/fonts.css +61 -117
- package/dist/styles/graph.css +4 -0
- package/dist/styles/illustration.css +4 -0
- package/dist/styles/index.css +11 -201
- package/dist/styles/material.css +138 -12
- package/dist/styles/parts/ai.css +18 -13
- package/dist/styles/parts/brand.css +2 -2
- package/dist/styles/parts/controls.css +29 -20
- package/dist/styles/parts/data.css +13 -9
- package/dist/styles/parts/editor.css +372 -0
- package/dist/styles/parts/feedback.css +32 -2
- package/dist/styles/parts/foundations.css +12 -7
- package/dist/styles/parts/graph.css +25 -9
- package/dist/styles/parts/inputs.css +172 -9
- package/dist/styles/parts/isometric.css +6 -5
- package/dist/styles/parts/navigation.css +206 -27
- package/dist/styles/parts/overlays.css +19 -4
- package/dist/styles/parts/pdf.css +2 -2
- package/dist/styles/pdf.css +3 -0
- package/dist/styles/prose.css +3 -0
- package/dist/styles/tokens.css +89 -14
- package/dist/theme.d.ts +1 -0
- package/dist/theme.js +5 -0
- package/dist/vite.d.ts +48 -59
- package/dist/vite.js +54 -21
- package/package.json +69 -2
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# Lightbox
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Lightbox, LightboxGrid, type LightboxImage } from "@zonsh/ui";
|
|
5
|
+
|
|
6
|
+
const EDITORIAL = `${import.meta.env.BASE_URL}illustrations/editorial/`;
|
|
7
|
+
|
|
8
|
+
const step = (name: string, title: string, caption: string): LightboxImage => ({
|
|
9
|
+
src: `${EDITORIAL}${name}.webp`,
|
|
10
|
+
thumbnail: `${EDITORIAL}${name}-640.webp`,
|
|
11
|
+
alt: title,
|
|
12
|
+
caption,
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
/* The seven steps of a software project, drawn for the illustration library. */
|
|
16
|
+
const steps: LightboxImage[] = [
|
|
17
|
+
step("process-discovery", "First call", "Step 1 — a first conversation about what is needed."),
|
|
18
|
+
step("process-analysis", "Process analysis", "Step 2 — mapping how the work is done today."),
|
|
19
|
+
step("process-concept", "Solution concept", "Step 3 — a concrete plan to agree on."),
|
|
20
|
+
step("process-prototype", "Prototype", "Step 4 — a first working version to try."),
|
|
21
|
+
step("process-development", "Development", "Step 5 — building it out."),
|
|
22
|
+
step("process-testing", "Testing and deployment", "Step 6 — testing, then shipping."),
|
|
23
|
+
step("process-maintenance", "Maintenance", "Step 7 — keeping it running, and improving it."),
|
|
24
|
+
];
|
|
25
|
+
|
|
26
|
+
export function Basic() {
|
|
27
|
+
return (
|
|
28
|
+
<div className="w-full max-w-2xl">
|
|
29
|
+
{/* Black line art on a transparent ground: inverted on the viewer's black, as on a dark page. */}
|
|
30
|
+
<Lightbox items={steps} imageClassName="invert">
|
|
31
|
+
<LightboxGrid columns={4} className="[&_img]:p-[6%] dark:[&_img]:invert" />
|
|
32
|
+
</Lightbox>
|
|
33
|
+
</div>
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Images opened large, one at a time. Each thumbnail is a button that opens a full-screen viewer on black — in the light theme too, so every image sits on the same dark — with a mono "03 / 12" counter, a caption, and previous and next at the sides.
|
|
39
|
+
|
|
40
|
+
## Usage
|
|
41
|
+
|
|
42
|
+
```tsx
|
|
43
|
+
import { Lightbox, LightboxGrid } from "@zonsh/ui";
|
|
44
|
+
|
|
45
|
+
const photos = [
|
|
46
|
+
{
|
|
47
|
+
src: "/photos/kitchen.jpg",
|
|
48
|
+
thumbnail: "/photos/kitchen-640.jpg",
|
|
49
|
+
alt: "Kitchen with an oak worktop",
|
|
50
|
+
caption: "Kitchen, east window",
|
|
51
|
+
},
|
|
52
|
+
{ src: "/photos/hall.jpg", thumbnail: "/photos/hall-640.jpg", alt: "Hall with the original tiles" },
|
|
53
|
+
];
|
|
54
|
+
|
|
55
|
+
<Lightbox items={photos}>
|
|
56
|
+
<LightboxGrid columns={4} />
|
|
57
|
+
</Lightbox>;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
- `items` — `src`, a required `alt`, and a `thumbnail` and `caption` where you have them.
|
|
61
|
+
- `columns` on `LightboxGrid` — 2 to 6, fewer on a phone.
|
|
62
|
+
- `download` / `loop` — a Download button per image; wrap from last to first.
|
|
63
|
+
|
|
64
|
+
Zoom with a double click or tap (to the image's own pixels, at least 2×), the wheel, a pinch or the zoom button; drag to pan. A click on the black, Escape or the close button closes it. The large image loads when opened, its neighbours in the background.
|
|
65
|
+
|
|
66
|
+
## When to use
|
|
67
|
+
|
|
68
|
+
- Photos and figures people want larger: a listing's photos, an article's figures, screenshots on a report.
|
|
69
|
+
- `LightboxGrid` for a grid; `LightboxTrigger` around your own thumbnail — a file row, a figure in the text.
|
|
70
|
+
- Slides that move in place are a Carousel; a PDF, the PDF Viewer; a video, the Video Player.
|
|
71
|
+
|
|
72
|
+
## Examples
|
|
73
|
+
|
|
74
|
+
### Own triggers and download
|
|
75
|
+
|
|
76
|
+
`LightboxTrigger index={i}` opens the viewer from anything you draw. `download: "…"` on an image saves another file, such as the original; `false` hides its button.
|
|
77
|
+
|
|
78
|
+
```tsx
|
|
79
|
+
import { Lightbox, LightboxTrigger, type LightboxImage } from "@zonsh/ui";
|
|
80
|
+
import { FileImageIcon } from "lucide-react";
|
|
81
|
+
|
|
82
|
+
const FILES = `${import.meta.env.BASE_URL}files/`;
|
|
83
|
+
|
|
84
|
+
/* The files attached to a bug report, opened from a list. */
|
|
85
|
+
const attachments: LightboxImage[] = [
|
|
86
|
+
{
|
|
87
|
+
src: `${FILES}package-updates.png`,
|
|
88
|
+
alt: "Screenshot of the update notes: three packages have updates",
|
|
89
|
+
caption: "package-updates.png — the notes the update check wrote, 704 × 527",
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
src: `${FILES}eclipse-poster.jpg`,
|
|
93
|
+
alt: "Poster frame of the eclipse clip at totality",
|
|
94
|
+
caption: "eclipse-poster.jpg — the poster frame of the clip, 3840 × 2160",
|
|
95
|
+
},
|
|
96
|
+
];
|
|
97
|
+
|
|
98
|
+
export function Attachments() {
|
|
99
|
+
return (
|
|
100
|
+
<div className="w-full max-w-md">
|
|
101
|
+
<Lightbox items={attachments} download loop>
|
|
102
|
+
<ul className="m-0 flex list-none flex-col p-0">
|
|
103
|
+
{attachments.map((file, i) => (
|
|
104
|
+
<li key={file.src} className="border-b border-border/60 last:border-b-0">
|
|
105
|
+
<LightboxTrigger
|
|
106
|
+
index={i}
|
|
107
|
+
className="flex w-full items-center gap-3 rounded-item bg-transparent px-2 py-2 text-start text-sm text-foreground hover:bg-control-hover"
|
|
108
|
+
>
|
|
109
|
+
<img
|
|
110
|
+
src={file.src}
|
|
111
|
+
alt=""
|
|
112
|
+
className="size-10 shrink-0 rounded-checkbox border border-field-edge object-cover"
|
|
113
|
+
/>
|
|
114
|
+
<span className="min-w-0 flex-1">
|
|
115
|
+
<span className="block truncate font-medium">{file.alt}</span>
|
|
116
|
+
<span className="block truncate font-mono text-[12px] text-muted-foreground">
|
|
117
|
+
{file.src.split("/").pop()}
|
|
118
|
+
</span>
|
|
119
|
+
</span>
|
|
120
|
+
<FileImageIcon aria-hidden className="size-4 shrink-0 text-muted-foreground" />
|
|
121
|
+
</LightboxTrigger>
|
|
122
|
+
</li>
|
|
123
|
+
))}
|
|
124
|
+
</ul>
|
|
125
|
+
</Lightbox>
|
|
126
|
+
</div>
|
|
127
|
+
);
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### One figure
|
|
132
|
+
|
|
133
|
+
A single image opens without counter or arrows, to be zoomed.
|
|
134
|
+
|
|
135
|
+
```tsx
|
|
136
|
+
import { Lightbox, LightboxTrigger, type LightboxImage } from "@zonsh/ui";
|
|
137
|
+
|
|
138
|
+
// FILES: as in the first example on this page that uses them.
|
|
139
|
+
|
|
140
|
+
/* One figure in an article, opened large to read its detail. */
|
|
141
|
+
const figure: LightboxImage[] = [
|
|
142
|
+
{
|
|
143
|
+
src: `${FILES}eclipse-poster.jpg`,
|
|
144
|
+
alt: "A drawn total eclipse: the moon's disc ringed by the corona",
|
|
145
|
+
caption:
|
|
146
|
+
"Totality, drawn for the eclipse clip: the corona shows only while the moon covers the whole sun.",
|
|
147
|
+
},
|
|
148
|
+
];
|
|
149
|
+
|
|
150
|
+
export function Figure() {
|
|
151
|
+
return (
|
|
152
|
+
<figure className="m-0 flex w-full max-w-lg flex-col gap-3">
|
|
153
|
+
<Lightbox items={figure}>
|
|
154
|
+
<LightboxTrigger
|
|
155
|
+
index={0}
|
|
156
|
+
className="block overflow-hidden rounded-button border border-field-edge bg-black p-0"
|
|
157
|
+
>
|
|
158
|
+
<img src={figure[0]!.src} alt={figure[0]!.alt} className="aspect-video w-full object-cover" />
|
|
159
|
+
</LightboxTrigger>
|
|
160
|
+
</Lightbox>
|
|
161
|
+
<figcaption className="text-[13px] text-muted-foreground">
|
|
162
|
+
Fig. 2 — Totality. Select the image to see it full size; double-click or pinch to zoom.
|
|
163
|
+
</figcaption>
|
|
164
|
+
</figure>
|
|
165
|
+
);
|
|
166
|
+
}
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Props
|
|
170
|
+
|
|
171
|
+
### Lightbox
|
|
172
|
+
|
|
173
|
+
| Prop | Type | Default |
|
|
174
|
+
| ---------------- | ------------------------------------------------------------------------ | ------- |
|
|
175
|
+
| `items` | `LightboxItem[]` — images, or files of any kind | — |
|
|
176
|
+
| `index` | `number` — the item shown; with `open`, opens the viewer from code at it | — |
|
|
177
|
+
| `defaultIndex` | `number` | `0` |
|
|
178
|
+
| `onIndexChange` | `(index) => void` | — |
|
|
179
|
+
| `open` | `boolean` | — |
|
|
180
|
+
| `defaultOpen` | `boolean` | `false` |
|
|
181
|
+
| `onOpenChange` | `(open) => void` | — |
|
|
182
|
+
| `loop` | `boolean` | `false` |
|
|
183
|
+
| `download` | `boolean` | `false` |
|
|
184
|
+
| `imageClassName` | `string` — on the large image | — |
|
|
185
|
+
| `labels` | `Partial<LightboxMessages>` | English |
|
|
186
|
+
|
|
187
|
+
An image in `items` is `{ src, alt, thumbnail?, caption?, srcSet?, sizes?, download? }` (`LightboxImage`); a file adds `kind?`, `type?`, `name?`, `size?`, `poster?`, `text?` and `language?` (`LightboxItem`). `alt` is required: it names the thumbnail and the image.
|
|
188
|
+
|
|
189
|
+
A transparent image can vanish on black: `imageClassName="invert"` turns line art white, `bg-white` puts a logo on paper.
|
|
190
|
+
|
|
191
|
+
### LightboxGrid, LightboxTrigger
|
|
192
|
+
|
|
193
|
+
`LightboxGrid` takes `columns` and `<ul>` props. `LightboxTrigger` takes `index` and the props of Base UI's `Button`, `render` included.
|
|
194
|
+
|
|
195
|
+
The viewer's parts carry `data-slot`: `lightbox-content`, `lightbox-stage` (with `data-zoomed`), `lightbox-image`, `lightbox-counter`, `lightbox-caption`, `lightbox-previous`, `lightbox-next`, `lightbox-zoom`, `lightbox-download`, `lightbox-close`.
|
|
196
|
+
|
|
197
|
+
## Brand rules
|
|
198
|
+
|
|
199
|
+
- **Do** write an `alt` that says what each image shows, and a caption when there is more to say.
|
|
200
|
+
- **Do** give large images a `thumbnail`.
|
|
201
|
+
- **Do** keep the ground black in both themes.
|
|
202
|
+
- **Don't** put text in images to be read here; it cannot be searched or translated.
|
|
203
|
+
- **Don't** use it for a small image already readable on the page.
|
|
204
|
+
|
|
205
|
+
## Accessibility
|
|
206
|
+
|
|
207
|
+
- A modal Dialog named "Image viewer": focus stays inside and returns on close to the thumbnail last shown, or whatever opened it.
|
|
208
|
+
- Each thumbnail is a button named by its `alt`, with `aria-haspopup="dialog"`.
|
|
209
|
+
- A polite live region reads each change: "Image 3 of 7: Solution concept"; the visible counter is hidden.
|
|
210
|
+
- Previous and Next stay focusable at the ends (without `loop`).
|
|
211
|
+
- Under reduced motion nothing transitions; a swipe still follows the finger.
|
|
212
|
+
- Words come from `labels` or `messages.lightbox`.
|
|
213
|
+
|
|
214
|
+
### Keyboard
|
|
215
|
+
|
|
216
|
+
| Key | What it does |
|
|
217
|
+
| --------------- | ------------------------------------------------------------------------------------------ |
|
|
218
|
+
| Enter / Space | Opens the viewer on the focused thumbnail's image |
|
|
219
|
+
| ← / → | Shows the previous or next image at rest (swapped right to left) |
|
|
220
|
+
| ← → ↑ ↓ | Zoomed in: looks around the image, a sixth of the view at a time, the way the arrow points |
|
|
221
|
+
| Shift+← / → | Zoomed in: shows the previous or next image all the same |
|
|
222
|
+
| Home / End | Shows the first or last image |
|
|
223
|
+
| + / = | Zooms in |
|
|
224
|
+
| - | Zooms out |
|
|
225
|
+
| 0 | Resets the zoom |
|
|
226
|
+
| Tab / Shift+Tab | Moves through the viewer's buttons; the focus stays in the viewer |
|
|
227
|
+
| Escape | Closes the viewer and returns the focus to the thumbnail |
|
|
228
|
+
|
|
229
|
+
Keys are left alone while ⌘, Ctrl or Alt is held. Zoom keys work on images only; in a video, sound, PDF or text the keys belong to the player or reader, and only Escape still closes.
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
- Import: `import { Lightbox, LightboxGrid, LightboxTrigger } from "@zonsh/ui"`
|
|
234
|
+
- Source: `packages/ui/src/components/lightbox.tsx`
|
|
235
|
+
- Primitive: `@base-ui/react/dialog` (Base UI docs: `node_modules/@base-ui/react/docs/react/components/dialog.md`)
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
# Locale
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Button, CopyButton, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, Field, FieldLabel, LocaleProvider, NumberField, Pagination } from "@zonsh/ui";
|
|
5
|
+
import { de } from "@zonsh/ui/messages/de";
|
|
6
|
+
import * as React from "react";
|
|
7
|
+
|
|
8
|
+
function Pages() {
|
|
9
|
+
const [page, setPage] = React.useState(3);
|
|
10
|
+
return <Pagination page={page} pageCount={9} onPageChange={setPage} />;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/** A dialog whose close button is named "Schließen", and a copy button that answers "Kopiert". */
|
|
14
|
+
function Invoice() {
|
|
15
|
+
return (
|
|
16
|
+
<Dialog>
|
|
17
|
+
<DialogTrigger render={<Button variant="secondary" />}>Rechnung ansehen</DialogTrigger>
|
|
18
|
+
<DialogContent size="sm">
|
|
19
|
+
<DialogHeader>
|
|
20
|
+
<DialogTitle>Rechnung RE-2026-0417</DialogTitle>
|
|
21
|
+
<DialogDescription>
|
|
22
|
+
Fällig am 15. November. Der Link führt direkt zur Rechnung, etwa für die Buchhaltung.
|
|
23
|
+
</DialogDescription>
|
|
24
|
+
</DialogHeader>
|
|
25
|
+
<DialogFooter>
|
|
26
|
+
<DialogClose render={<Button variant="secondary" />}>Fertig</DialogClose>
|
|
27
|
+
<CopyButton value="https://example.com/rechnungen/RE-2026-0417" size="default">
|
|
28
|
+
Link kopieren
|
|
29
|
+
</CopyButton>
|
|
30
|
+
</DialogFooter>
|
|
31
|
+
</DialogContent>
|
|
32
|
+
</Dialog>
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export function German() {
|
|
37
|
+
return (
|
|
38
|
+
<LocaleProvider locale="de-DE" messages={de}>
|
|
39
|
+
<div lang="de" className="flex w-full flex-col items-center gap-6">
|
|
40
|
+
<Pages />
|
|
41
|
+
<Field className="w-full max-w-xs">
|
|
42
|
+
<FieldLabel>Betrag</FieldLabel>
|
|
43
|
+
<NumberField defaultValue={1284.5} step={0.5} format={{ style: "currency", currency: "EUR" }} />
|
|
44
|
+
</Field>
|
|
45
|
+
<Invoice />
|
|
46
|
+
</div>
|
|
47
|
+
</LocaleProvider>
|
|
48
|
+
);
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Every component's built-in text — "Previous page", "Copied", the names screen readers announce — is English by default. `LocaleProvider` replaces it for everything inside, and sets the locale for numbers, dates and times. A component's own `labels` prop still wins.
|
|
53
|
+
|
|
54
|
+
## Usage
|
|
55
|
+
|
|
56
|
+
```tsx
|
|
57
|
+
import { LocaleProvider, Toaster } from "@zonsh/ui";
|
|
58
|
+
import { de } from "@zonsh/ui/messages/de";
|
|
59
|
+
|
|
60
|
+
<LocaleProvider locale="de-DE" messages={de}>
|
|
61
|
+
<App />
|
|
62
|
+
<Toaster />
|
|
63
|
+
</LocaleProvider>;
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Set `locale` (a BCP 47 tag) and `messages` (a pack, or a partial object), and put everything that shows text inside — the `Toaster` too. To change a few words of a pack, spread it:
|
|
67
|
+
|
|
68
|
+
```tsx
|
|
69
|
+
const messages = { ...de, pagination: { ...de.pagination, nav: "Ergebnisseiten" } };
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Or give only what you translate; anything missing stays English.
|
|
73
|
+
|
|
74
|
+
```tsx
|
|
75
|
+
<LocaleProvider
|
|
76
|
+
locale="de-DE"
|
|
77
|
+
messages={{
|
|
78
|
+
pagination: {
|
|
79
|
+
nav: "Seiten",
|
|
80
|
+
previous: "Vorherige Seite",
|
|
81
|
+
next: "Nächste Seite",
|
|
82
|
+
page: (n) => `Seite ${n}`,
|
|
83
|
+
},
|
|
84
|
+
}}
|
|
85
|
+
>
|
|
86
|
+
<App />
|
|
87
|
+
</LocaleProvider>
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## When to use
|
|
91
|
+
|
|
92
|
+
- An app in another language: wrap the root once.
|
|
93
|
+
- A region in another language (a translated preview): wrap just that region; nested providers merge into the outer one.
|
|
94
|
+
- One component needing other words ("Next result"): its `labels` prop, not a provider.
|
|
95
|
+
|
|
96
|
+
## Message packs
|
|
97
|
+
|
|
98
|
+
A pack is every component's text in one language, typed as the full `LocaleMessages`. The library ships German:
|
|
99
|
+
|
|
100
|
+
| Pack | Import | Locale |
|
|
101
|
+
| ------ | -------------------------------------------- | --------- |
|
|
102
|
+
| German | `import { de } from "@zonsh/ui/messages/de"` | `"de-DE"` |
|
|
103
|
+
|
|
104
|
+
It is neutral interface German, as in macOS and Google: infinitives and nouns ("Kopieren", "Vorherige Seite"), never "Sie" or "du". Packs are plain data, importable on the server.
|
|
105
|
+
|
|
106
|
+
For another language, type your own object as `LocaleMessages`; the typecheck fails while a key is missing:
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
import type { LocaleMessages } from "@zonsh/ui";
|
|
110
|
+
|
|
111
|
+
export const nl: LocaleMessages = {
|
|
112
|
+
pagination: {
|
|
113
|
+
nav: "Paginering",
|
|
114
|
+
previous: "Vorige pagina",
|
|
115
|
+
next: "Volgende pagina",
|
|
116
|
+
page: (n) => `Pagina ${n}`,
|
|
117
|
+
},
|
|
118
|
+
// … every other namespace
|
|
119
|
+
};
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Examples
|
|
123
|
+
|
|
124
|
+
### Nested regions
|
|
125
|
+
|
|
126
|
+
An inner provider switches one region of a German page to French.
|
|
127
|
+
|
|
128
|
+
```tsx
|
|
129
|
+
import { LocaleProvider, Pagination, useLocale, type PartialLocaleMessages } from "@zonsh/ui";
|
|
130
|
+
import { de } from "@zonsh/ui/messages/de";
|
|
131
|
+
import * as React from "react";
|
|
132
|
+
|
|
133
|
+
// Pages: as in the first example on this page that uses them.
|
|
134
|
+
|
|
135
|
+
const french: PartialLocaleMessages = {
|
|
136
|
+
pagination: {
|
|
137
|
+
nav: "Pages",
|
|
138
|
+
previous: "Page précédente",
|
|
139
|
+
next: "Page suivante",
|
|
140
|
+
page: (page) => `Page ${page}`,
|
|
141
|
+
},
|
|
142
|
+
};
|
|
143
|
+
|
|
144
|
+
/** Formats with the provider's locale — the same as the components inside it. */
|
|
145
|
+
function Total() {
|
|
146
|
+
const locale = useLocale();
|
|
147
|
+
return (
|
|
148
|
+
<p className="font-mono text-[13px] text-muted-foreground tabular-nums">
|
|
149
|
+
{new Intl.NumberFormat(locale, { style: "currency", currency: "EUR" }).format(1284.5)}
|
|
150
|
+
</p>
|
|
151
|
+
);
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export function Nested() {
|
|
155
|
+
return (
|
|
156
|
+
<LocaleProvider locale="de-DE" messages={de}>
|
|
157
|
+
<div lang="de" className="flex flex-col items-center gap-6">
|
|
158
|
+
<Pages />
|
|
159
|
+
<LocaleProvider locale="fr-FR" messages={french}>
|
|
160
|
+
<div lang="fr" className="flex flex-col items-center gap-4">
|
|
161
|
+
<Pages />
|
|
162
|
+
<Total />
|
|
163
|
+
</div>
|
|
164
|
+
</LocaleProvider>
|
|
165
|
+
</div>
|
|
166
|
+
</LocaleProvider>
|
|
167
|
+
);
|
|
168
|
+
}
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## Namespaces
|
|
172
|
+
|
|
173
|
+
One entry per component (or family), in camelCase; each has an exported `…Messages` interface documenting the English defaults.
|
|
174
|
+
|
|
175
|
+
| Namespace | Interface | Used by |
|
|
176
|
+
| ---------------- | ------------------------ | --------------------------------------------------------- |
|
|
177
|
+
| `bottomNav` | `BottomNavMessages` | BottomNav, BottomNavItem |
|
|
178
|
+
| `breadcrumb` | `BreadcrumbMessages` | Breadcrumb |
|
|
179
|
+
| `carousel` | `CarouselMessages` | Carousel and its parts |
|
|
180
|
+
| `codeBlock` | `CodeBlockMessages` | CodeBlock (its confirmation comes from `copyButton`) |
|
|
181
|
+
| `colorPicker` | `ColorPickerMessages` | ColorPicker, ColorPickerPanel |
|
|
182
|
+
| `combobox` | `ComboboxMessages` | ComboboxInput, ComboboxChip |
|
|
183
|
+
| `command` | `CommandMessages` | CommandDialog, CommandInput, CommandFooter |
|
|
184
|
+
| `conversation` | `ConversationMessages` | ConversationScrollButton |
|
|
185
|
+
| `copyButton` | `CopyButtonMessages` | CopyButton |
|
|
186
|
+
| `dataTable` | `DataTableMessages` | DataTable |
|
|
187
|
+
| `datePicker` | `DatePickerMessages` | DatePicker, DateRangePicker |
|
|
188
|
+
| `dateTimePicker` | `DateTimePickerMessages` | DateTimePicker |
|
|
189
|
+
| `dialog` | `DialogMessages` | DialogContent |
|
|
190
|
+
| `drawer` | `DrawerMessages` | DrawerContent |
|
|
191
|
+
| `fileDrop` | `FileDropMessages` | FileDrop, FileDropItem |
|
|
192
|
+
| `filterBar` | `FilterBarMessages` | FilterBar |
|
|
193
|
+
| `graph` | `GraphMessages` | Graph |
|
|
194
|
+
| `inputGroup` | `InputGroupMessages` | InputGroupPasswordToggle, InputGroupClearButton |
|
|
195
|
+
| `kbd` | `KbdMessages` | KbdShortcut, MenuShortcut, FileDrop — key names off Apple |
|
|
196
|
+
| `lightbox` | `LightboxMessages` | Lightbox |
|
|
197
|
+
| `markdownEditor` | `MarkdownEditorMessages` | MarkdownEditor |
|
|
198
|
+
| `mentions` | `MentionsMessages` | Mentions |
|
|
199
|
+
| `moneyInput` | `MoneyInputMessages` | MoneyInput |
|
|
200
|
+
| `numberField` | `NumberFieldMessages` | NumberField |
|
|
201
|
+
| `otpField` | `OtpFieldMessages` | OtpField |
|
|
202
|
+
| `pagination` | `PaginationMessages` | Pagination |
|
|
203
|
+
| `pdfViewer` | `PdfViewerMessages` | PdfViewer, PdfPreview |
|
|
204
|
+
| `phoneInput` | `PhoneInputMessages` | PhoneInput |
|
|
205
|
+
| `promptInput` | `PromptInputMessages` | PromptInputTextarea, …AttachButton, …Attachment, …Submit |
|
|
206
|
+
| `rating` | `RatingMessages` | Rating |
|
|
207
|
+
| `reasoning` | `ReasoningMessages` | ReasoningTrigger |
|
|
208
|
+
| `resizable` | `ResizableMessages` | ResizableHandle |
|
|
209
|
+
| `response` | `ResponseMessages` | Response (task list boxes) |
|
|
210
|
+
| `sidebar` | `SidebarMessages` | Sidebar, SidebarTrigger, SidebarRail |
|
|
211
|
+
| `siteHeader` | `SiteHeaderMessages` | SiteHeader |
|
|
212
|
+
| `sortable` | `SortableMessages` | Sortable and its parts |
|
|
213
|
+
| `sources` | `SourcesMessages` | SourcesTrigger, Source |
|
|
214
|
+
| `spinner` | `SpinnerMessages` | Spinner |
|
|
215
|
+
| `stat` | `StatMessages` | Stat |
|
|
216
|
+
| `stepper` | `StepperMessages` | Stepper |
|
|
217
|
+
| `tagsInput` | `TagsInputMessages` | TagsInput |
|
|
218
|
+
| `theme` | `ThemeMessages` | ThemeToggle |
|
|
219
|
+
| `timeField` | `TimeFieldMessages` | TimeField |
|
|
220
|
+
| `timeline` | `TimelineMessages` | TimelineChange |
|
|
221
|
+
| `toast` | `ToastMessages` | Toaster |
|
|
222
|
+
| `toolCall` | `ToolCallMessages` | ToolCall, ToolCallInput, ToolCallOutput |
|
|
223
|
+
| `tour` | `TourMessages` | Tour |
|
|
224
|
+
| `videoPlayer` | `VideoPlayerMessages` | VideoPlayer |
|
|
225
|
+
|
|
226
|
+
The optional components' namespaces (`carousel`, `dataTable`, `datePicker`, `dateTimePicker`, `filterBar`, `graph`, `pdfViewer`, `resizable`) are typed once their entry (`@zonsh/ui/graph` and the like) is imported.
|
|
227
|
+
|
|
228
|
+
## Numbers and dates
|
|
229
|
+
|
|
230
|
+
The provider's `locale` is the default for everything that formats — NumberField, Slider, Progress and Meter values, TimeField, FilterBar chips, DataTable sorting, Chart tooltips, FileDropItem sizes — unless a component's own `locale` is set.
|
|
231
|
+
|
|
232
|
+
Calendar, DatePicker and DateRangePicker use date-fns locale objects, which the provider does not set. Pass one from `react-day-picker/locale` (it also translates the calendar's labels):
|
|
233
|
+
|
|
234
|
+
```tsx
|
|
235
|
+
import { de as calendarDe } from "react-day-picker/locale";
|
|
236
|
+
|
|
237
|
+
<LocaleProvider locale="de-DE" messages={de}>
|
|
238
|
+
<DatePicker locale={calendarDe} />
|
|
239
|
+
</LocaleProvider>;
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Keep both in one wrapper or constant so the language is set once.
|
|
243
|
+
|
|
244
|
+
## Props
|
|
245
|
+
|
|
246
|
+
| Prop | Type | Default |
|
|
247
|
+
| ---------- | ----------------- | ---------------------- |
|
|
248
|
+
| `locale` | `string` | the browser's language |
|
|
249
|
+
| `messages` | `PartialLocaleMessages` | `{}` (English) |
|
|
250
|
+
| `children` | `ReactNode` | — |
|
|
251
|
+
|
|
252
|
+
Value-dependent strings are functions (`page: (n) => …`). Each namespace merges string by string: `labels` over the provider, the provider over the English defaults, an inner provider over an outer one.
|
|
253
|
+
|
|
254
|
+
`useLocale(): string | undefined` returns the nearest provider's locale, for your own `Intl` formatting. `useMessages(key, defaults, labels?)` resolves defaults, then provider, then `labels`; use it in your own components by extending `LocaleMessages`:
|
|
255
|
+
|
|
256
|
+
```ts
|
|
257
|
+
declare module "@zonsh/ui" {
|
|
258
|
+
interface LocaleMessages {
|
|
259
|
+
invoiceList: { empty: string };
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
## Brand rules
|
|
265
|
+
|
|
266
|
+
- **Do** translate the whole message set of a component, including what only screen readers hear — a pack does.
|
|
267
|
+
- **Do** set `lang` on `<html>` (and on a region in another language) — the provider changes the text, not the document's language.
|
|
268
|
+
- **Don't** pass a new `messages` object on every render when it never changes; define it once outside the component.
|
|
269
|
+
- **Don't** mix forms of address: the pack never says "Sie" or "du", so keep your own text in the same neutral voice.
|
|
270
|
+
|
|
271
|
+
## Accessibility
|
|
272
|
+
|
|
273
|
+
- Icon button names, landmarks and live announcements come from the same messages, so a translated app is translated for screen readers too.
|
|
274
|
+
- Pair a right-to-left language with `DirectionProvider` and `dir="rtl"` — see Direction.
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
- Import: `import { LocaleProvider, useLocale, useMessages } from "@zonsh/ui"`
|
|
279
|
+
- Source: `packages/ui/src/components/locale.tsx`
|