@zonsh/ui 0.5.0 → 0.6.1
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 +643 -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,813 @@
|
|
|
1
|
+
# Sidebar
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Sidebar, SidebarGroup, SidebarGroupLabel, SidebarItem } from "@zonsh/ui";
|
|
5
|
+
import * as React from "react";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* The current page for a demo: each row's link props, and a click that moves `current` to it
|
|
9
|
+
* (a real app sets `current` from its router instead).
|
|
10
|
+
*/
|
|
11
|
+
function useCurrentPage(initial: string) {
|
|
12
|
+
const [page, setPage] = React.useState(initial);
|
|
13
|
+
const link = (id: string) => ({
|
|
14
|
+
href: `#${id}`,
|
|
15
|
+
current: id === page,
|
|
16
|
+
onClick: (event: React.MouseEvent) => {
|
|
17
|
+
event.preventDefault();
|
|
18
|
+
setPage(id);
|
|
19
|
+
},
|
|
20
|
+
});
|
|
21
|
+
return { page, link };
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export function Docs() {
|
|
25
|
+
const { link } = useCurrentPage("intro");
|
|
26
|
+
return (
|
|
27
|
+
<Sidebar aria-label="Documentation" className="max-w-60">
|
|
28
|
+
<SidebarGroup>
|
|
29
|
+
<SidebarGroupLabel>Getting started</SidebarGroupLabel>
|
|
30
|
+
<SidebarItem {...link("intro")}>Introduction</SidebarItem>
|
|
31
|
+
<SidebarItem {...link("install")}>Installation</SidebarItem>
|
|
32
|
+
<SidebarItem {...link("theming")}>Theming</SidebarItem>
|
|
33
|
+
</SidebarGroup>
|
|
34
|
+
<SidebarGroup>
|
|
35
|
+
<SidebarGroupLabel>Components</SidebarGroupLabel>
|
|
36
|
+
<SidebarItem {...link("button")}>Button</SidebarItem>
|
|
37
|
+
<SidebarItem {...link("select")}>Select</SidebarItem>
|
|
38
|
+
<SidebarItem {...link("tabs")}>Tabs</SidebarItem>
|
|
39
|
+
</SidebarGroup>
|
|
40
|
+
</Sidebar>
|
|
41
|
+
);
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Eyebrow group labels and 38px `material-row` rows, raised for the current page; the raised row glides when the page changes (at once under reduced motion). Hover only brightens the label; `hover="glide"` adds a soft fill that follows the pointer. On its own `Sidebar` is a `<nav>`; inside a `SidebarProvider` it is an app shell that collapses off-canvas or to an icon rail, remembers its state, toggles with ⌘B / Ctrl+B and becomes a sheet below 768px.
|
|
46
|
+
|
|
47
|
+
## Usage
|
|
48
|
+
|
|
49
|
+
```tsx
|
|
50
|
+
import { ScrollArea, Sidebar, SidebarGroup, SidebarGroupLabel, SidebarItem } from "@zonsh/ui";
|
|
51
|
+
|
|
52
|
+
<Sidebar aria-label="Documentation">
|
|
53
|
+
<SidebarGroup>
|
|
54
|
+
<SidebarGroupLabel>Getting started</SidebarGroupLabel>
|
|
55
|
+
<SidebarItem href="/docs" current>
|
|
56
|
+
Introduction
|
|
57
|
+
</SidebarItem>
|
|
58
|
+
<SidebarItem href="/docs/install">Installation</SidebarItem>
|
|
59
|
+
</SidebarGroup>
|
|
60
|
+
</Sidebar>;
|
|
61
|
+
|
|
62
|
+
// A long sidebar: scrolls, no scrollbar, faded edges.
|
|
63
|
+
<aside className="sticky top-0 h-svh w-64">
|
|
64
|
+
<ScrollArea scrollbar={false} className="h-full" contentClassName="px-3 py-6">
|
|
65
|
+
<Sidebar aria-label="Documentation">…</Sidebar>
|
|
66
|
+
</ScrollArea>
|
|
67
|
+
</aside>;
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
- `SidebarItem.current` — the current page.
|
|
71
|
+
- `SidebarItem.render` — your router's link ([Router links](#router-links)).
|
|
72
|
+
- `SidebarProvider.collapsible` — `"offcanvas"`, `"icon"` or `"none"`.
|
|
73
|
+
|
|
74
|
+
## When to use
|
|
75
|
+
|
|
76
|
+
- Sections beside docs or settings: `Sidebar` alone. The frame of a tool: `SidebarProvider` + `Sidebar` + `SidebarInset` (`collapsible="icon"` when sections have clear icons).
|
|
77
|
+
- Not for a marketing header (`SiteHeader`) or panels in place (`Tabs`).
|
|
78
|
+
|
|
79
|
+
A sidebar scrolls with an edge fade and no scrollbar: `SidebarContent` in the shell, a `ScrollArea scrollbar={false}` on its own.
|
|
80
|
+
|
|
81
|
+
The app shell:
|
|
82
|
+
|
|
83
|
+
```tsx
|
|
84
|
+
import {
|
|
85
|
+
Sidebar,
|
|
86
|
+
SidebarContent,
|
|
87
|
+
SidebarFooter,
|
|
88
|
+
SidebarGroup,
|
|
89
|
+
SidebarGroupLabel,
|
|
90
|
+
SidebarHeader,
|
|
91
|
+
SidebarInset,
|
|
92
|
+
SidebarItem,
|
|
93
|
+
SidebarProvider,
|
|
94
|
+
SidebarRail,
|
|
95
|
+
SidebarTrigger,
|
|
96
|
+
} from "@zonsh/ui";
|
|
97
|
+
|
|
98
|
+
<SidebarProvider collapsible="icon">
|
|
99
|
+
<Sidebar aria-label="Workspace">
|
|
100
|
+
<SidebarHeader>…logo…</SidebarHeader>
|
|
101
|
+
<SidebarContent>
|
|
102
|
+
<SidebarGroup>
|
|
103
|
+
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
|
|
104
|
+
<SidebarItem href="/projects" current>
|
|
105
|
+
<FolderIcon />
|
|
106
|
+
Projects
|
|
107
|
+
</SidebarItem>
|
|
108
|
+
</SidebarGroup>
|
|
109
|
+
</SidebarContent>
|
|
110
|
+
<SidebarFooter>…</SidebarFooter>
|
|
111
|
+
<SidebarRail />
|
|
112
|
+
</Sidebar>
|
|
113
|
+
<SidebarInset>
|
|
114
|
+
<header className="flex items-center gap-3 border-b border-border/60 py-2 pr-4 pl-2">
|
|
115
|
+
<SidebarTrigger />…
|
|
116
|
+
</header>
|
|
117
|
+
…page…
|
|
118
|
+
</SidebarInset>
|
|
119
|
+
</SidebarProvider>;
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Pad the toolbar row `py-2 ps-2` so the 36px trigger sits evenly; a `Separator` after it gets equal space.
|
|
123
|
+
|
|
124
|
+
## Examples
|
|
125
|
+
|
|
126
|
+
### With icons
|
|
127
|
+
|
|
128
|
+
16px icons; a trailing `Kbd` or `Tag` takes `ml-auto`.
|
|
129
|
+
|
|
130
|
+
```tsx
|
|
131
|
+
import { KbdShortcut, Sidebar, SidebarGroup, SidebarGroupLabel, SidebarItem } from "@zonsh/ui";
|
|
132
|
+
import { FileTextIcon, LayoutGridIcon, SearchIcon, SettingsIcon, UsersIcon } from "lucide-react";
|
|
133
|
+
import * as React from "react";
|
|
134
|
+
|
|
135
|
+
// useCurrentPage: as in the first example on this page that uses them.
|
|
136
|
+
|
|
137
|
+
export function WithIcons() {
|
|
138
|
+
const { link } = useCurrentPage("overview");
|
|
139
|
+
return (
|
|
140
|
+
<Sidebar aria-label="Workspace" className="max-w-60">
|
|
141
|
+
<SidebarGroup>
|
|
142
|
+
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
|
|
143
|
+
<SidebarItem {...link("search")}>
|
|
144
|
+
<SearchIcon />
|
|
145
|
+
Search
|
|
146
|
+
<KbdShortcut keys={["/"]} className="ml-auto" />
|
|
147
|
+
</SidebarItem>
|
|
148
|
+
<SidebarItem {...link("overview")}>
|
|
149
|
+
<LayoutGridIcon />
|
|
150
|
+
Overview
|
|
151
|
+
</SidebarItem>
|
|
152
|
+
<SidebarItem {...link("documents")}>
|
|
153
|
+
<FileTextIcon />
|
|
154
|
+
Documents
|
|
155
|
+
</SidebarItem>
|
|
156
|
+
<SidebarItem {...link("team")}>
|
|
157
|
+
<UsersIcon />
|
|
158
|
+
Team
|
|
159
|
+
</SidebarItem>
|
|
160
|
+
<SidebarItem {...link("settings")}>
|
|
161
|
+
<SettingsIcon />
|
|
162
|
+
Settings
|
|
163
|
+
</SidebarItem>
|
|
164
|
+
</SidebarGroup>
|
|
165
|
+
</Sidebar>
|
|
166
|
+
);
|
|
167
|
+
}
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Nested rows
|
|
171
|
+
|
|
172
|
+
`SidebarSubmenu` opens nested rows on a hairline. `active` (a nested row is current) brightens the parent and opens it. In the icon rail, pressing it expands the sidebar. One level only; the parent is a toggle, not a page.
|
|
173
|
+
|
|
174
|
+
```tsx
|
|
175
|
+
import { Sidebar, SidebarGroup, SidebarGroupLabel, SidebarItem, SidebarSubmenu } from "@zonsh/ui";
|
|
176
|
+
import { ActivityIcon, FolderIcon, LayoutGridIcon, SettingsIcon } from "lucide-react";
|
|
177
|
+
import * as React from "react";
|
|
178
|
+
|
|
179
|
+
// useCurrentPage: as in the first example on this page that uses them.
|
|
180
|
+
|
|
181
|
+
export function Nested() {
|
|
182
|
+
const { page, link } = useCurrentPage("members");
|
|
183
|
+
const settings = ["general", "members", "billing"];
|
|
184
|
+
return (
|
|
185
|
+
<Sidebar aria-label="Workspace" className="max-w-60">
|
|
186
|
+
<SidebarGroup>
|
|
187
|
+
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
|
|
188
|
+
<SidebarItem {...link("overview")}>
|
|
189
|
+
<LayoutGridIcon />
|
|
190
|
+
Overview
|
|
191
|
+
</SidebarItem>
|
|
192
|
+
<SidebarItem {...link("projects")}>
|
|
193
|
+
<FolderIcon />
|
|
194
|
+
Projects
|
|
195
|
+
</SidebarItem>
|
|
196
|
+
<SidebarSubmenu label="Settings" icon={<SettingsIcon />} active={settings.includes(page)}>
|
|
197
|
+
<SidebarItem {...link("general")}>General</SidebarItem>
|
|
198
|
+
<SidebarItem {...link("members")}>Members</SidebarItem>
|
|
199
|
+
<SidebarItem {...link("billing")}>Billing</SidebarItem>
|
|
200
|
+
</SidebarSubmenu>
|
|
201
|
+
<SidebarSubmenu label="Reports" icon={<ActivityIcon />}>
|
|
202
|
+
<SidebarItem {...link("weekly")}>Weekly</SidebarItem>
|
|
203
|
+
<SidebarItem {...link("exports")}>Exports</SidebarItem>
|
|
204
|
+
</SidebarSubmenu>
|
|
205
|
+
</SidebarGroup>
|
|
206
|
+
</Sidebar>
|
|
207
|
+
);
|
|
208
|
+
}
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### App shell
|
|
212
|
+
|
|
213
|
+
`collapsible="icon"`: trigger and rail animate the width, the shortcut is instant. Collapsed rows are 38px squares with tooltips; labels and `SidebarMenuBadge` counts hide. The toolbar row is sticky on `surface-page`, not `bg-background` (a darker strip in dark mode).
|
|
214
|
+
|
|
215
|
+
```tsx
|
|
216
|
+
import { PageHeader, Breadcrumb, Button, KbdShortcut, useShortcutKeys, Separator, Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupLabel, SidebarHeader, SidebarInset, SidebarItem, SidebarMenuBadge, SidebarProvider, SidebarRail, SidebarSeparator, SidebarTrigger, Toolbar, ToolbarButton } from "@zonsh/ui";
|
|
217
|
+
import { Wordmark } from "@zonsh/ui/brand";
|
|
218
|
+
import { FileTextIcon, FolderIcon, InboxIcon, LayoutGridIcon, LifeBuoyIcon, PlugIcon, RocketIcon, SearchIcon, SettingsIcon, SlidersHorizontalIcon, UsersIcon } from "lucide-react";
|
|
219
|
+
import * as React from "react";
|
|
220
|
+
|
|
221
|
+
/** Your product's mark — a placeholder for "Acme". Replace it and the name with your own; never zon's Logo. */
|
|
222
|
+
function AcmeMark() {
|
|
223
|
+
return (
|
|
224
|
+
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinejoin="round">
|
|
225
|
+
<path d="M3.5 20.5 12 3.5l8.5 17z" />
|
|
226
|
+
<path d="M8 14.5h8" />
|
|
227
|
+
</svg>
|
|
228
|
+
);
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
/** How to collapse the sidebar, with the keys written for the device; touch-only, no keys. */
|
|
232
|
+
function CollapseHint() {
|
|
233
|
+
const { hasKeyboard } = useShortcutKeys();
|
|
234
|
+
return hasKeyboard ? (
|
|
235
|
+
<>
|
|
236
|
+
Press <KbdShortcut keys={["mod", "B"]} className="align-middle" /> to collapse the sidebar to its icon
|
|
237
|
+
rail; hover a square for its name. Below 768px it becomes a sheet.
|
|
238
|
+
</>
|
|
239
|
+
) : (
|
|
240
|
+
<>Below 768px the sidebar is a sheet: open it with the menu button.</>
|
|
241
|
+
);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
const workspace = [
|
|
245
|
+
{ id: "overview", label: "Overview", icon: LayoutGridIcon },
|
|
246
|
+
{ id: "inbox", label: "Inbox", icon: InboxIcon, count: 4 },
|
|
247
|
+
{ id: "projects", label: "Projects", icon: FolderIcon, count: 12 },
|
|
248
|
+
{ id: "deploys", label: "Deploys", icon: RocketIcon },
|
|
249
|
+
];
|
|
250
|
+
|
|
251
|
+
const connections = [
|
|
252
|
+
{ id: "integrations", label: "Integrations", icon: PlugIcon },
|
|
253
|
+
{ id: "documents", label: "Documents", icon: FileTextIcon },
|
|
254
|
+
{ id: "team", label: "Team", icon: UsersIcon },
|
|
255
|
+
];
|
|
256
|
+
|
|
257
|
+
/** The footer rows of the app shells: pages too, so the current row can move there. */
|
|
258
|
+
const footerPages: Record<string, string> = { help: "Help", settings: "Settings" };
|
|
259
|
+
|
|
260
|
+
export function AppShell() {
|
|
261
|
+
const [page, setPage] = React.useState("projects");
|
|
262
|
+
const all = [...workspace, ...connections];
|
|
263
|
+
const currentLabel = all.find((item) => item.id === page)?.label ?? footerPages[page] ?? "Overview";
|
|
264
|
+
|
|
265
|
+
const row = (item: (typeof all)[number] & { count?: number }) => (
|
|
266
|
+
<SidebarItem
|
|
267
|
+
key={item.id}
|
|
268
|
+
href={`#${item.id}`}
|
|
269
|
+
current={item.id === page}
|
|
270
|
+
onClick={(event) => {
|
|
271
|
+
event.preventDefault();
|
|
272
|
+
setPage(item.id);
|
|
273
|
+
}}
|
|
274
|
+
>
|
|
275
|
+
<item.icon />
|
|
276
|
+
{item.label}
|
|
277
|
+
{item.count ? <SidebarMenuBadge>{item.count}</SidebarMenuBadge> : null}
|
|
278
|
+
</SidebarItem>
|
|
279
|
+
);
|
|
280
|
+
|
|
281
|
+
return (
|
|
282
|
+
<SidebarProvider
|
|
283
|
+
collapsible="icon"
|
|
284
|
+
storageKey={null}
|
|
285
|
+
className="h-[560px] min-h-0 w-full overflow-hidden surface-container"
|
|
286
|
+
>
|
|
287
|
+
<Sidebar aria-label="Workspace">
|
|
288
|
+
<SidebarHeader>
|
|
289
|
+
<div className="flex min-h-(--control-h) items-center gap-2.5 overflow-hidden px-[7px] whitespace-nowrap">
|
|
290
|
+
<Wordmark mark={<AcmeMark />} size={24}>
|
|
291
|
+
Acme
|
|
292
|
+
</Wordmark>
|
|
293
|
+
</div>
|
|
294
|
+
</SidebarHeader>
|
|
295
|
+
<SidebarSeparator />
|
|
296
|
+
<SidebarContent>
|
|
297
|
+
<SidebarGroup>
|
|
298
|
+
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
|
|
299
|
+
{workspace.map(row)}
|
|
300
|
+
</SidebarGroup>
|
|
301
|
+
<SidebarGroup>
|
|
302
|
+
<SidebarGroupLabel>Connections</SidebarGroupLabel>
|
|
303
|
+
{connections.map(row)}
|
|
304
|
+
</SidebarGroup>
|
|
305
|
+
</SidebarContent>
|
|
306
|
+
<SidebarFooter>
|
|
307
|
+
<SidebarItem
|
|
308
|
+
href="#help"
|
|
309
|
+
current={page === "help"}
|
|
310
|
+
onClick={(event) => {
|
|
311
|
+
event.preventDefault();
|
|
312
|
+
setPage("help");
|
|
313
|
+
}}
|
|
314
|
+
>
|
|
315
|
+
<LifeBuoyIcon />
|
|
316
|
+
Help
|
|
317
|
+
</SidebarItem>
|
|
318
|
+
<SidebarItem
|
|
319
|
+
href="#settings"
|
|
320
|
+
current={page === "settings"}
|
|
321
|
+
onClick={(event) => {
|
|
322
|
+
event.preventDefault();
|
|
323
|
+
setPage("settings");
|
|
324
|
+
}}
|
|
325
|
+
>
|
|
326
|
+
<SettingsIcon />
|
|
327
|
+
Settings
|
|
328
|
+
</SidebarItem>
|
|
329
|
+
</SidebarFooter>
|
|
330
|
+
<SidebarRail />
|
|
331
|
+
</Sidebar>
|
|
332
|
+
<SidebarInset className="@container overflow-y-auto">
|
|
333
|
+
<header className="surface-page sticky top-0 z-10 flex shrink-0 items-center gap-3 border-b border-border/60 py-2 pr-4 pl-2 @xl:py-1.5">
|
|
334
|
+
<SidebarTrigger />
|
|
335
|
+
<Separator orientation="vertical" className="my-auto h-4 min-h-0 self-center" />
|
|
336
|
+
<Breadcrumb items={[{ label: "Workspace", href: "#workspace" }, { label: currentLabel }]} />
|
|
337
|
+
<Toolbar aria-label="View" className="ml-auto @max-xl:hidden">
|
|
338
|
+
<ToolbarButton aria-label="Search">
|
|
339
|
+
<SearchIcon />
|
|
340
|
+
</ToolbarButton>
|
|
341
|
+
<ToolbarButton aria-label="Filters">
|
|
342
|
+
<SlidersHorizontalIcon />
|
|
343
|
+
</ToolbarButton>
|
|
344
|
+
</Toolbar>
|
|
345
|
+
<Button size="sm" className="@max-xl:ml-auto">
|
|
346
|
+
Create project
|
|
347
|
+
</Button>
|
|
348
|
+
</header>
|
|
349
|
+
<div className="flex flex-col gap-8 px-6 py-8 @xl:px-10">
|
|
350
|
+
<PageHeader as="h2" eyebrow="Workspace" title={currentLabel} description={<CollapseHint />} />
|
|
351
|
+
<ul className="m-0 list-none p-0">
|
|
352
|
+
{["Docs site", "Mobile app", "Design tokens", "Release notes"].map((name, i) => (
|
|
353
|
+
<li
|
|
354
|
+
key={name}
|
|
355
|
+
className="grid grid-cols-[3rem_minmax(0,1fr)_auto] items-center gap-4 border-t border-border/60 py-4 last:border-b"
|
|
356
|
+
>
|
|
357
|
+
<span className="font-mono text-xs text-muted-foreground tabular-nums">
|
|
358
|
+
{String(i + 1).padStart(2, "0")}
|
|
359
|
+
</span>
|
|
360
|
+
<span className="text-15">{name}</span>
|
|
361
|
+
<span className="font-mono text-xs text-muted-foreground">Ready</span>
|
|
362
|
+
</li>
|
|
363
|
+
))}
|
|
364
|
+
</ul>
|
|
365
|
+
</div>
|
|
366
|
+
</SidebarInset>
|
|
367
|
+
</SidebarProvider>
|
|
368
|
+
);
|
|
369
|
+
}
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Off-canvas
|
|
373
|
+
|
|
374
|
+
The default: the panel slides away.
|
|
375
|
+
|
|
376
|
+
```tsx
|
|
377
|
+
import { Sidebar, SidebarContent, SidebarGroup, SidebarGroupLabel, SidebarInset, SidebarItem, SidebarProvider, SidebarTrigger } from "@zonsh/ui";
|
|
378
|
+
import * as React from "react";
|
|
379
|
+
|
|
380
|
+
// useCurrentPage: as in the first example on this page that uses them.
|
|
381
|
+
|
|
382
|
+
const settingsPages = [
|
|
383
|
+
{ id: "profile", label: "Profile" },
|
|
384
|
+
{ id: "notifications", label: "Notifications" },
|
|
385
|
+
{ id: "billing", label: "Billing" },
|
|
386
|
+
{ id: "security", label: "Security" },
|
|
387
|
+
];
|
|
388
|
+
|
|
389
|
+
export function Offcanvas() {
|
|
390
|
+
const { page, link } = useCurrentPage("profile");
|
|
391
|
+
const label = settingsPages.find((item) => item.id === page)?.label;
|
|
392
|
+
return (
|
|
393
|
+
<SidebarProvider
|
|
394
|
+
storageKey={null}
|
|
395
|
+
keyboardShortcut={false}
|
|
396
|
+
className="h-[420px] min-h-0 w-full overflow-hidden surface-container"
|
|
397
|
+
>
|
|
398
|
+
<Sidebar aria-label="Settings">
|
|
399
|
+
<SidebarContent>
|
|
400
|
+
<SidebarGroup>
|
|
401
|
+
<SidebarGroupLabel>Settings</SidebarGroupLabel>
|
|
402
|
+
{settingsPages.map((item) => (
|
|
403
|
+
<SidebarItem key={item.id} {...link(item.id)}>
|
|
404
|
+
{item.label}
|
|
405
|
+
</SidebarItem>
|
|
406
|
+
))}
|
|
407
|
+
</SidebarGroup>
|
|
408
|
+
</SidebarContent>
|
|
409
|
+
</Sidebar>
|
|
410
|
+
<SidebarInset className="@container">
|
|
411
|
+
<header className="flex items-center gap-3 border-b border-border/60 py-2 pr-4 pl-2">
|
|
412
|
+
<SidebarTrigger />
|
|
413
|
+
<span className="font-mono text-xs text-muted-foreground">Settings / {label}</span>
|
|
414
|
+
</header>
|
|
415
|
+
<div className="flex flex-col gap-3 px-6 py-8 @xl:px-10">
|
|
416
|
+
<h2 className="m-0 font-heading text-30 leading-[1.1] font-light tracking-[-0.02em]">{label}</h2>
|
|
417
|
+
<p className="m-0 max-w-[52ch] text-15 leading-relaxed text-foreground-soft">
|
|
418
|
+
The trigger slides the whole panel away and gives the page its full width.
|
|
419
|
+
</p>
|
|
420
|
+
</div>
|
|
421
|
+
</SidebarInset>
|
|
422
|
+
</SidebarProvider>
|
|
423
|
+
);
|
|
424
|
+
}
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Inset
|
|
428
|
+
|
|
429
|
+
The page becomes a raised 20px panel with an 8px margin; for workspaces, not documentation.
|
|
430
|
+
|
|
431
|
+
```tsx
|
|
432
|
+
import { Separator, Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupLabel, SidebarHeader, SidebarInset, SidebarItem, SidebarProvider, SidebarTrigger } from "@zonsh/ui";
|
|
433
|
+
import { Wordmark } from "@zonsh/ui/brand";
|
|
434
|
+
import { ActivityIcon, FileTextIcon, FolderIcon, InboxIcon, SettingsIcon } from "lucide-react";
|
|
435
|
+
import * as React from "react";
|
|
436
|
+
|
|
437
|
+
// AcmeMark, footerPages: as in the first example on this page that uses them.
|
|
438
|
+
|
|
439
|
+
export function Inset() {
|
|
440
|
+
const [page, setPage] = React.useState("inbox");
|
|
441
|
+
const rows = [
|
|
442
|
+
{ id: "inbox", label: "Inbox", icon: InboxIcon },
|
|
443
|
+
{ id: "projects", label: "Projects", icon: FolderIcon },
|
|
444
|
+
{ id: "documents", label: "Documents", icon: FileTextIcon },
|
|
445
|
+
{ id: "activity", label: "Activity", icon: ActivityIcon },
|
|
446
|
+
];
|
|
447
|
+
const current = rows.find((row) => row.id === page)?.label ?? footerPages[page] ?? "Inbox";
|
|
448
|
+
return (
|
|
449
|
+
<SidebarProvider
|
|
450
|
+
storageKey={null}
|
|
451
|
+
keyboardShortcut={false}
|
|
452
|
+
className="h-[480px] min-h-0 w-full overflow-hidden border border-field-edge"
|
|
453
|
+
>
|
|
454
|
+
<Sidebar aria-label="Workspace" variant="inset">
|
|
455
|
+
<SidebarHeader>
|
|
456
|
+
<div className="flex min-h-(--control-h) items-center gap-2.5 px-[7px]">
|
|
457
|
+
<Wordmark mark={<AcmeMark />} size={24}>
|
|
458
|
+
Acme
|
|
459
|
+
</Wordmark>
|
|
460
|
+
</div>
|
|
461
|
+
</SidebarHeader>
|
|
462
|
+
<SidebarContent>
|
|
463
|
+
<SidebarGroup>
|
|
464
|
+
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
|
|
465
|
+
{rows.map((row) => (
|
|
466
|
+
<SidebarItem
|
|
467
|
+
key={row.id}
|
|
468
|
+
href={`#${row.id}`}
|
|
469
|
+
current={row.id === page}
|
|
470
|
+
onClick={(event) => {
|
|
471
|
+
event.preventDefault();
|
|
472
|
+
setPage(row.id);
|
|
473
|
+
}}
|
|
474
|
+
>
|
|
475
|
+
<row.icon />
|
|
476
|
+
{row.label}
|
|
477
|
+
</SidebarItem>
|
|
478
|
+
))}
|
|
479
|
+
</SidebarGroup>
|
|
480
|
+
</SidebarContent>
|
|
481
|
+
<SidebarFooter>
|
|
482
|
+
<SidebarItem
|
|
483
|
+
href="#settings"
|
|
484
|
+
current={page === "settings"}
|
|
485
|
+
onClick={(event) => {
|
|
486
|
+
event.preventDefault();
|
|
487
|
+
setPage("settings");
|
|
488
|
+
}}
|
|
489
|
+
>
|
|
490
|
+
<SettingsIcon />
|
|
491
|
+
Settings
|
|
492
|
+
</SidebarItem>
|
|
493
|
+
</SidebarFooter>
|
|
494
|
+
</Sidebar>
|
|
495
|
+
<SidebarInset className="@container overflow-y-auto">
|
|
496
|
+
<header className="flex shrink-0 items-center gap-3 border-b border-border/60 py-2 pr-4 pl-2">
|
|
497
|
+
<SidebarTrigger />
|
|
498
|
+
<Separator orientation="vertical" className="my-auto h-4 min-h-0 self-center" />
|
|
499
|
+
<span className="font-mono text-xs text-muted-foreground">Workspace / {current}</span>
|
|
500
|
+
</header>
|
|
501
|
+
<div className="flex flex-col gap-3 px-6 py-8 @xl:px-10">
|
|
502
|
+
<h2 className="m-0 font-heading text-30 leading-[1.1] font-light tracking-[-0.02em]">{current}</h2>
|
|
503
|
+
<p className="m-0 max-w-[52ch] text-15 leading-relaxed text-foreground-soft">
|
|
504
|
+
The sidebar is the ground; the page is a raised panel set into it. Collapse the sidebar and the
|
|
505
|
+
panel keeps its margin on every side.
|
|
506
|
+
</p>
|
|
507
|
+
</div>
|
|
508
|
+
</SidebarInset>
|
|
509
|
+
</SidebarProvider>
|
|
510
|
+
);
|
|
511
|
+
}
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Floating
|
|
515
|
+
|
|
516
|
+
The sidebar becomes the raised panel, 8px from the edges; the page stays flat.
|
|
517
|
+
|
|
518
|
+
```tsx
|
|
519
|
+
import { Separator, Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupLabel, SidebarHeader, SidebarInset, SidebarItem, SidebarProvider, SidebarTrigger } from "@zonsh/ui";
|
|
520
|
+
import { Wordmark } from "@zonsh/ui/brand";
|
|
521
|
+
import { ActivityIcon, FileTextIcon, FolderIcon, InboxIcon, SettingsIcon } from "lucide-react";
|
|
522
|
+
import * as React from "react";
|
|
523
|
+
|
|
524
|
+
// AcmeMark, footerPages: as in the first example on this page that uses them.
|
|
525
|
+
|
|
526
|
+
export function Floating() {
|
|
527
|
+
const [page, setPage] = React.useState("projects");
|
|
528
|
+
const rows = [
|
|
529
|
+
{ id: "inbox", label: "Inbox", icon: InboxIcon },
|
|
530
|
+
{ id: "projects", label: "Projects", icon: FolderIcon },
|
|
531
|
+
{ id: "documents", label: "Documents", icon: FileTextIcon },
|
|
532
|
+
{ id: "activity", label: "Activity", icon: ActivityIcon },
|
|
533
|
+
];
|
|
534
|
+
const current = rows.find((row) => row.id === page)?.label ?? footerPages[page] ?? "Projects";
|
|
535
|
+
return (
|
|
536
|
+
<SidebarProvider
|
|
537
|
+
collapsible="icon"
|
|
538
|
+
storageKey={null}
|
|
539
|
+
keyboardShortcut={false}
|
|
540
|
+
className="h-[480px] min-h-0 w-full overflow-hidden border border-field-edge"
|
|
541
|
+
>
|
|
542
|
+
<Sidebar aria-label="Workspace" variant="floating">
|
|
543
|
+
<SidebarHeader>
|
|
544
|
+
<div className="flex min-h-(--control-h) items-center gap-2.5 overflow-hidden px-[7px] whitespace-nowrap">
|
|
545
|
+
<Wordmark mark={<AcmeMark />} size={24}>
|
|
546
|
+
Acme
|
|
547
|
+
</Wordmark>
|
|
548
|
+
</div>
|
|
549
|
+
</SidebarHeader>
|
|
550
|
+
<SidebarContent>
|
|
551
|
+
<SidebarGroup>
|
|
552
|
+
<SidebarGroupLabel>Workspace</SidebarGroupLabel>
|
|
553
|
+
{rows.map((row) => (
|
|
554
|
+
<SidebarItem
|
|
555
|
+
key={row.id}
|
|
556
|
+
href={`#${row.id}`}
|
|
557
|
+
current={row.id === page}
|
|
558
|
+
onClick={(event) => {
|
|
559
|
+
event.preventDefault();
|
|
560
|
+
setPage(row.id);
|
|
561
|
+
}}
|
|
562
|
+
>
|
|
563
|
+
<row.icon />
|
|
564
|
+
{row.label}
|
|
565
|
+
</SidebarItem>
|
|
566
|
+
))}
|
|
567
|
+
</SidebarGroup>
|
|
568
|
+
</SidebarContent>
|
|
569
|
+
<SidebarFooter>
|
|
570
|
+
<SidebarItem
|
|
571
|
+
href="#settings"
|
|
572
|
+
current={page === "settings"}
|
|
573
|
+
onClick={(event) => {
|
|
574
|
+
event.preventDefault();
|
|
575
|
+
setPage("settings");
|
|
576
|
+
}}
|
|
577
|
+
>
|
|
578
|
+
<SettingsIcon />
|
|
579
|
+
Settings
|
|
580
|
+
</SidebarItem>
|
|
581
|
+
</SidebarFooter>
|
|
582
|
+
</Sidebar>
|
|
583
|
+
<SidebarInset className="@container overflow-y-auto">
|
|
584
|
+
<header className="flex shrink-0 items-center gap-3 border-b border-border/60 py-2 pr-4 pl-2">
|
|
585
|
+
<SidebarTrigger />
|
|
586
|
+
<Separator orientation="vertical" className="my-auto h-4 min-h-0 self-center" />
|
|
587
|
+
<span className="font-mono text-xs text-muted-foreground">Workspace / {current}</span>
|
|
588
|
+
</header>
|
|
589
|
+
<div className="flex flex-col gap-3 px-6 py-8 @xl:px-10">
|
|
590
|
+
<h2 className="m-0 font-heading text-30 leading-[1.1] font-light tracking-[-0.02em]">{current}</h2>
|
|
591
|
+
<p className="m-0 max-w-[52ch] text-15 leading-relaxed text-foreground-soft">
|
|
592
|
+
The sidebar is a panel resting on the page. Collapse it to the icon rail and it keeps its margin.
|
|
593
|
+
</p>
|
|
594
|
+
</div>
|
|
595
|
+
</SidebarInset>
|
|
596
|
+
</SidebarProvider>
|
|
597
|
+
);
|
|
598
|
+
}
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
### Dense
|
|
602
|
+
|
|
603
|
+
`size="sm"`: 30px rows and controls, for tools with many sections.
|
|
604
|
+
|
|
605
|
+
```tsx
|
|
606
|
+
import { Separator, Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupLabel, SidebarHeader, SidebarInset, SidebarItem, SidebarMenuBadge, SidebarProvider, SidebarRail, SidebarTrigger } from "@zonsh/ui";
|
|
607
|
+
import { Wordmark } from "@zonsh/ui/brand";
|
|
608
|
+
import { ActivityIcon, FileTextIcon, FolderIcon, InboxIcon, LayoutGridIcon, PlugIcon, SettingsIcon, UsersIcon } from "lucide-react";
|
|
609
|
+
import * as React from "react";
|
|
610
|
+
|
|
611
|
+
// AcmeMark, footerPages: as in the first example on this page that uses them.
|
|
612
|
+
|
|
613
|
+
export function Dense() {
|
|
614
|
+
const [page, setPage] = React.useState("projects");
|
|
615
|
+
const groups = [
|
|
616
|
+
{
|
|
617
|
+
label: "Workspace",
|
|
618
|
+
rows: [
|
|
619
|
+
{ id: "inbox", label: "Inbox", icon: InboxIcon, count: 4 },
|
|
620
|
+
{ id: "projects", label: "Projects", icon: FolderIcon },
|
|
621
|
+
{ id: "documents", label: "Documents", icon: FileTextIcon },
|
|
622
|
+
{ id: "activity", label: "Activity", icon: ActivityIcon },
|
|
623
|
+
{ id: "overview", label: "Overview", icon: LayoutGridIcon },
|
|
624
|
+
],
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
label: "Connections",
|
|
628
|
+
rows: [
|
|
629
|
+
{ id: "integrations", label: "Integrations", icon: PlugIcon },
|
|
630
|
+
{ id: "team", label: "Team", icon: UsersIcon },
|
|
631
|
+
],
|
|
632
|
+
},
|
|
633
|
+
];
|
|
634
|
+
const current =
|
|
635
|
+
groups.flatMap((g) => g.rows).find((row) => row.id === page)?.label ?? footerPages[page] ?? "Projects";
|
|
636
|
+
return (
|
|
637
|
+
<SidebarProvider
|
|
638
|
+
collapsible="icon"
|
|
639
|
+
storageKey={null}
|
|
640
|
+
keyboardShortcut={false}
|
|
641
|
+
className="h-[460px] min-h-0 w-full overflow-hidden surface-container"
|
|
642
|
+
>
|
|
643
|
+
<Sidebar aria-label="Workspace" size="sm">
|
|
644
|
+
<SidebarHeader>
|
|
645
|
+
<div className="flex min-h-(--control-h) items-center gap-2 overflow-hidden px-[6px] whitespace-nowrap">
|
|
646
|
+
<Wordmark mark={<AcmeMark />} size={20}>
|
|
647
|
+
Acme
|
|
648
|
+
</Wordmark>
|
|
649
|
+
</div>
|
|
650
|
+
</SidebarHeader>
|
|
651
|
+
<SidebarContent>
|
|
652
|
+
{groups.map((group) => (
|
|
653
|
+
<SidebarGroup key={group.label}>
|
|
654
|
+
<SidebarGroupLabel>{group.label}</SidebarGroupLabel>
|
|
655
|
+
{group.rows.map((row) => (
|
|
656
|
+
<SidebarItem
|
|
657
|
+
key={row.id}
|
|
658
|
+
href={`#${row.id}`}
|
|
659
|
+
current={row.id === page}
|
|
660
|
+
onClick={(event) => {
|
|
661
|
+
event.preventDefault();
|
|
662
|
+
setPage(row.id);
|
|
663
|
+
}}
|
|
664
|
+
>
|
|
665
|
+
<row.icon />
|
|
666
|
+
{row.label}
|
|
667
|
+
{"count" in row && row.count ? <SidebarMenuBadge>{row.count}</SidebarMenuBadge> : null}
|
|
668
|
+
</SidebarItem>
|
|
669
|
+
))}
|
|
670
|
+
</SidebarGroup>
|
|
671
|
+
))}
|
|
672
|
+
</SidebarContent>
|
|
673
|
+
<SidebarFooter>
|
|
674
|
+
<SidebarItem
|
|
675
|
+
href="#settings"
|
|
676
|
+
current={page === "settings"}
|
|
677
|
+
onClick={(event) => {
|
|
678
|
+
event.preventDefault();
|
|
679
|
+
setPage("settings");
|
|
680
|
+
}}
|
|
681
|
+
>
|
|
682
|
+
<SettingsIcon />
|
|
683
|
+
Settings
|
|
684
|
+
</SidebarItem>
|
|
685
|
+
</SidebarFooter>
|
|
686
|
+
<SidebarRail />
|
|
687
|
+
</Sidebar>
|
|
688
|
+
<SidebarInset className="@container overflow-y-auto">
|
|
689
|
+
<header className="flex shrink-0 items-center gap-3 border-b border-border/60 py-1.5 pr-4 pl-1.5">
|
|
690
|
+
<SidebarTrigger size="icon-sm" />
|
|
691
|
+
<Separator orientation="vertical" className="my-auto h-4 min-h-0 self-center" />
|
|
692
|
+
<span className="font-mono text-xs text-muted-foreground">Workspace / {current}</span>
|
|
693
|
+
</header>
|
|
694
|
+
<div className="flex flex-col gap-3 px-6 py-8 @xl:px-10">
|
|
695
|
+
<h2 className="m-0 font-heading text-30 leading-[1.1] font-light tracking-[-0.02em]">{current}</h2>
|
|
696
|
+
<p className="m-0 max-w-[52ch] text-15 leading-relaxed text-foreground-soft">
|
|
697
|
+
Thirty-pixel rows and tighter groups fit more sections on screen. Collapsed, the icon rail is
|
|
698
|
+
narrower too.
|
|
699
|
+
</p>
|
|
700
|
+
</div>
|
|
701
|
+
</SidebarInset>
|
|
702
|
+
</SidebarProvider>
|
|
703
|
+
);
|
|
704
|
+
}
|
|
705
|
+
```
|
|
706
|
+
|
|
707
|
+
### Router links
|
|
708
|
+
|
|
709
|
+
A router link's own `aria-current` wins over `current`; TanStack Router marks every parent path, raising "Settings" on `/settings/profile`. Make the router exact, or pass `current`:
|
|
710
|
+
|
|
711
|
+
```tsx
|
|
712
|
+
// TanStack Router: only the exact path is current.
|
|
713
|
+
<SidebarItem render={<Link to="/settings" activeOptions={{ exact: true }} />}>Settings</SidebarItem>;
|
|
714
|
+
|
|
715
|
+
// Next.js: compare the path yourself; next/link sets no aria-current of its own.
|
|
716
|
+
const pathname = usePathname();
|
|
717
|
+
<SidebarItem render={<Link href="/settings" />} current={pathname === "/settings"}>
|
|
718
|
+
Settings
|
|
719
|
+
</SidebarItem>;
|
|
720
|
+
|
|
721
|
+
// React Router: NavLink sets aria-current too; use end, or a plain Link with current.
|
|
722
|
+
<SidebarItem render={<NavLink to="/settings" end />}>Settings</SidebarItem>;
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
Only one row is current at a time.
|
|
726
|
+
|
|
727
|
+
### A sidebar inside the app shell
|
|
728
|
+
|
|
729
|
+
A second list inside the shell (a settings page's own navigation) takes `standalone`: a plain `<nav>` that never collapses or becomes a sheet.
|
|
730
|
+
|
|
731
|
+
```tsx
|
|
732
|
+
<SidebarInset>
|
|
733
|
+
<div className="grid gap-10 md:grid-cols-[12rem_minmax(0,1fr)]">
|
|
734
|
+
<Sidebar standalone aria-label="Settings">
|
|
735
|
+
<SidebarGroup>
|
|
736
|
+
<SidebarItem href="/settings/profile" current>
|
|
737
|
+
Profile
|
|
738
|
+
</SidebarItem>
|
|
739
|
+
<SidebarItem href="/settings/account">Account</SidebarItem>
|
|
740
|
+
<SidebarItem href="/settings/notifications">Notifications</SidebarItem>
|
|
741
|
+
</SidebarGroup>
|
|
742
|
+
</Sidebar>
|
|
743
|
+
<div>…the section's form…</div>
|
|
744
|
+
</div>
|
|
745
|
+
</SidebarInset>
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
On a phone, prefer a `Select` or `Tabs` above the content.
|
|
749
|
+
|
|
750
|
+
## Props
|
|
751
|
+
|
|
752
|
+
| Prop | Type | Default |
|
|
753
|
+
| --------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------- |
|
|
754
|
+
| `SidebarItem.current` | `boolean` — sets `aria-current="page"` | `false` |
|
|
755
|
+
| `SidebarItem.render` | `ReactElement` — e.g. a router `Link` | `<a>` |
|
|
756
|
+
| `SidebarItem.tooltip` | `ReactNode \| false` — icon-rail tooltip | the row's text |
|
|
757
|
+
| `Sidebar` | `<nav>` props — give it an `aria-label` | — |
|
|
758
|
+
| `Sidebar.side` | `"left" \| "right"` — in an app shell | `"left"` |
|
|
759
|
+
| `Sidebar.variant` | `"sidebar" \| "inset" \| "floating"` — hairline, the page as a raised panel, or the sidebar as one | `"sidebar"` |
|
|
760
|
+
| `Sidebar.size` | `"default" \| "sm"` — 38px rows, or the dense 30px sidebar | `"default"` |
|
|
761
|
+
| `Sidebar.standalone` | `boolean` — inside a `SidebarProvider`, a plain `<nav>`, not the shell's panel | `false` |
|
|
762
|
+
| `SidebarSubmenu.label` | `ReactNode` — the parent row's label | — |
|
|
763
|
+
| `SidebarSubmenu.icon` | `ReactNode` — the parent row's 16px icon | — |
|
|
764
|
+
| `SidebarSubmenu.active` | `boolean` — a nested row is current: foreground label, open at first | `false` |
|
|
765
|
+
| `SidebarSubmenu.open` / `defaultOpen` | `boolean` — controlled, or open at first | `active` |
|
|
766
|
+
| `SidebarSubmenu.onOpenChange` | `(open: boolean) => void` | — |
|
|
767
|
+
| `SidebarSubmenu.tooltip` | `ReactNode` — icon-rail tooltip | the label |
|
|
768
|
+
| `Sidebar.hover` | `"text" \| "glide"` — hover only brightens the label, or adds a gliding fill | `"text"` |
|
|
769
|
+
| `SidebarProvider.collapsible` | `"offcanvas" \| "icon" \| "none"` | `"offcanvas"` |
|
|
770
|
+
| `SidebarProvider.defaultOpen` | `boolean` | `true` |
|
|
771
|
+
| `SidebarProvider.open` / `onOpenChange` | controlled desktop state | — |
|
|
772
|
+
| `SidebarProvider.storageKey` | `string \| null` — localStorage key and cookie name | `"zon-sidebar"` |
|
|
773
|
+
| `SidebarProvider.keyboardShortcut` | `string \| false` — with ⌘ on Apple devices, Ctrl elsewhere | `"b"` |
|
|
774
|
+
| `SidebarContent` | `ScrollArea` props (`contentClassName` …) | — |
|
|
775
|
+
| `SidebarTrigger` | `Button` props | ghost, icon |
|
|
776
|
+
|
|
777
|
+
`SidebarTrigger` takes any `Button` variant (`"bare"` lights only the icon). `SidebarItem` forwards anchor props. `SidebarSubmenu` is a Base UI `Collapsible` (`data-slot="sidebar-submenu"`, `data-active`, rows in `sidebar-submenu-panel`). Group, label, header and footer are `<div>`s; `SidebarInset` is a `<main>`. `useSidebar()` returns `{ state, open, setOpen, openMobile, setOpenMobile, isMobile, toggleSidebar, collapsible }`.
|
|
778
|
+
|
|
779
|
+
The shell is `min-h-svh`; embedded, give it a height (`h-[560px] min-h-0`). Widths: `--sidebar-width` (16rem at the default density, following the type: about 14.3rem dense, 17.7rem spacious), `--sidebar-width-icon`. The state is in localStorage and a cookie, so a server can pass `defaultOpen` and render the right width first; storage failures are ignored. The panel has `data-state`, `data-collapsible` and `data-side`.
|
|
780
|
+
|
|
781
|
+
On a phone, pair it with a `BottomNav` (`SidebarInset` reserves its height; "More" can call `setOpenMobile(true)`); see [BottomNav: With a sidebar](./bottom-nav.md#with-a-sidebar).
|
|
782
|
+
|
|
783
|
+
Names come from `messages.sidebar` (`toggle`, `navigation`).
|
|
784
|
+
|
|
785
|
+
## Brand rules
|
|
786
|
+
|
|
787
|
+
- **Do** mark the current page with `current`, keep rows 38px (no `h-*`), and give every row an icon for the icon rail.
|
|
788
|
+
- **Don't** use a flat fill, bold or a coloured bar for the current row, or `--control-surface` for hover.
|
|
789
|
+
- **Don't** show a scrollbar or box the panel.
|
|
790
|
+
|
|
791
|
+
## Accessibility
|
|
792
|
+
|
|
793
|
+
- An `aria-label` names the `<nav>` and the mobile sheet. Rows are real links; collapsed, they keep their text and show it as a tooltip.
|
|
794
|
+
- `SidebarTrigger` ("Toggle sidebar") reports `aria-expanded`; show its shortcut with `<KbdShortcut keys={["mod", "B"]} />`. The rail is skipped by Tab.
|
|
795
|
+
- Off-canvas, the hidden panel is `inert`. The mobile sheet traps focus and closes on a swipe, an outside click, or a chosen link row (even one routing on the client); a button row keeps it open by preventing the default. A submenu parent (`aria-expanded`) doesn't close it.
|
|
796
|
+
- A disabled row: `aria-disabled="true"`, no `href`.
|
|
797
|
+
|
|
798
|
+
### Keyboard
|
|
799
|
+
|
|
800
|
+
| Key | What it does |
|
|
801
|
+
| --------------- | --------------------------------------------------------------------------- |
|
|
802
|
+
| Tab / Shift+Tab | Moves through the rows, `SidebarTrigger` and the rows of an open submenu |
|
|
803
|
+
| Enter | Follows the focused row's link |
|
|
804
|
+
| Enter / Space | Opens or closes a submenu from its parent row, or presses `SidebarTrigger` |
|
|
805
|
+
| ⌘B / Ctrl+B | Opens or closes the sidebar, or the mobile sheet, from anywhere on the page |
|
|
806
|
+
| Escape | Closes the mobile sheet |
|
|
807
|
+
|
|
808
|
+
⌘B on Apple devices, Ctrl+B elsewhere, never both (a Mac's Ctrl+B still moves the caret back); left to a contenteditable and to earlier handlers. Change it with `keyboardShortcut`, or `false`; `collapsible="none"` has none.
|
|
809
|
+
|
|
810
|
+
---
|
|
811
|
+
|
|
812
|
+
- Import: `import { Sidebar, SidebarGroup, SidebarGroupLabel, SidebarItem, SidebarSubmenu, SidebarProvider, useSidebar, SidebarTrigger } from "@zonsh/ui"`
|
|
813
|
+
- Source: `packages/ui/src/components/sidebar.tsx`
|