@zonsh/ui 0.4.1 → 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 +7 -7
- 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/ascii-field.js +2 -1
- 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 +389 -24
- 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 +64 -8
- 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 +38 -1
- package/dist/components/chart.js +27 -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 +4 -4
- 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 +37 -12
- 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 +77 -16
- package/dist/components/copy-button.d.ts +1 -1
- package/dist/components/copy-button.js +8 -6
- 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 +190 -28
- package/dist/components/illustration.js +53 -31
- package/dist/components/input-group.d.ts +6 -11
- package/dist/components/input-group.js +21 -19
- 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/layout.d.ts +2 -1
- package/dist/components/layout.js +55 -11
- package/dist/components/lightbox.d.ts +76 -9
- package/dist/components/lightbox.js +354 -48
- 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 +153 -31
- package/dist/components/message.d.ts +62 -11
- package/dist/components/message.js +51 -14
- 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 -10
- package/dist/components/number-field.d.ts +2 -9
- package/dist/components/number-field.js +90 -26
- 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 +35 -17
- 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 +8 -3
- 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 +4 -3
- package/dist/components/response.js +39 -15
- 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 +90 -31
- package/dist/components/site-header.d.ts +18 -13
- package/dist/components/site-header.js +26 -9
- package/dist/components/skeleton.d.ts +18 -8
- package/dist/components/skeleton.js +23 -8
- package/dist/components/slider.js +2 -2
- package/dist/components/sortable.d.ts +55 -4
- package/dist/components/sortable.js +187 -94
- 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 +13 -7
- package/dist/components/table.js +124 -23
- package/dist/components/tabs.js +15 -8
- 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 +50 -7
- package/dist/components/theme.js +168 -12
- package/dist/components/time-field.d.ts +6 -10
- package/dist/components/time-field.js +19 -9
- 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 +17 -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 +8 -3
- package/dist/components/toolbar.d.ts +57 -4
- package/dist/components/toolbar.js +219 -16
- package/dist/components/tooltip.d.ts +5 -3
- package/dist/components/tooltip.js +14 -6
- package/dist/components/tour.d.ts +1 -1
- package/dist/components/tour.js +70 -24
- package/dist/components/tree.js +33 -10
- 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 +182 -225
- 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 +10 -4
- package/dist/lib/glide.js +14 -5
- 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 +4 -3
- package/dist/lib/table-fit.js +92 -25
- 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 +75 -77
- 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 -193
- package/dist/styles/material.css +177 -31
- package/dist/styles/parts/ai.css +20 -14
- package/dist/styles/parts/brand.css +2 -2
- package/dist/styles/parts/controls.css +51 -38
- package/dist/styles/parts/data.css +43 -11
- package/dist/styles/parts/editor.css +372 -0
- package/dist/styles/parts/feedback.css +75 -15
- 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 +237 -25
- package/dist/styles/parts/overlays.css +110 -8
- package/dist/styles/parts/pdf.css +15 -9
- package/dist/styles/pdf.css +3 -0
- package/dist/styles/prose.css +3 -0
- package/dist/styles/tokens.css +105 -15
- 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,423 @@
|
|
|
1
|
+
# Tour
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Button, InputGroup, InputGroupAddon, InputGroupInput, Tour, type TourStep } from "@zonsh/ui";
|
|
5
|
+
import { FolderIcon, PlusIcon, SearchIcon, Share2Icon, StarIcon } from "lucide-react";
|
|
6
|
+
import * as React from "react";
|
|
7
|
+
|
|
8
|
+
/* A notes app's first screen, and a tour of the four things new people look for. */
|
|
9
|
+
export function Basic() {
|
|
10
|
+
const [open, setOpen] = React.useState(false);
|
|
11
|
+
const newNote = React.useRef<HTMLButtonElement>(null);
|
|
12
|
+
const steps: TourStep[] = [
|
|
13
|
+
{
|
|
14
|
+
title: "Welcome to your notebook",
|
|
15
|
+
body: "Four things to know before you start writing. It takes half a minute; skip it whenever you like.",
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
target: newNote,
|
|
19
|
+
title: "Start a note",
|
|
20
|
+
body: "Every note starts here. It saves as you type, so there is no save button.",
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
target: "[data-tour-basic=search]",
|
|
24
|
+
title: "Find anything",
|
|
25
|
+
body: "Search reads titles and the text of every note, attachments included.",
|
|
26
|
+
side: "bottom",
|
|
27
|
+
align: "start",
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
// Not on this page: the tour skips it, and the count leaves it out.
|
|
31
|
+
target: "[data-tour-basic=archive]",
|
|
32
|
+
title: "Archive",
|
|
33
|
+
body: "Notes you are done with.",
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
target: "[data-tour-basic=folders]",
|
|
37
|
+
title: "Folders",
|
|
38
|
+
body: "Drag a note onto a folder to file it. A note can be in one folder at a time.",
|
|
39
|
+
side: "right",
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
target: "[data-tour-basic=share]",
|
|
43
|
+
title: "Share a notebook",
|
|
44
|
+
body: "Invite people to read or edit. You can take access back at any time.",
|
|
45
|
+
side: "bottom",
|
|
46
|
+
align: "end",
|
|
47
|
+
},
|
|
48
|
+
];
|
|
49
|
+
|
|
50
|
+
return (
|
|
51
|
+
<div className="@container flex w-full max-w-3xl flex-col gap-4">
|
|
52
|
+
<div className="grid min-h-80 grid-cols-[10rem_1fr] overflow-hidden surface-container @max-xl:grid-cols-1">
|
|
53
|
+
<nav
|
|
54
|
+
aria-label="Folders"
|
|
55
|
+
data-tour-basic="folders"
|
|
56
|
+
className="flex flex-col gap-1 border-e border-border/60 p-3 @max-xl:hidden"
|
|
57
|
+
>
|
|
58
|
+
<span className="px-2 pb-1 eyebrow">Folders</span>
|
|
59
|
+
{["Recipes", "Garden", "Reading"].map((folder) => (
|
|
60
|
+
<span
|
|
61
|
+
key={folder}
|
|
62
|
+
className="flex items-center gap-2 rounded-item px-2 py-1.5 text-[13px] text-foreground-soft"
|
|
63
|
+
>
|
|
64
|
+
<FolderIcon aria-hidden className="size-4" />
|
|
65
|
+
{folder}
|
|
66
|
+
</span>
|
|
67
|
+
))}
|
|
68
|
+
</nav>
|
|
69
|
+
<div className="flex min-w-0 flex-col">
|
|
70
|
+
<div className="flex flex-wrap items-center gap-2 border-b border-border/60 p-3">
|
|
71
|
+
<Button ref={newNote} size="sm" variant="secondary">
|
|
72
|
+
<PlusIcon />
|
|
73
|
+
New note
|
|
74
|
+
</Button>
|
|
75
|
+
<InputGroup size="sm" data-tour-basic="search" className="w-auto min-w-0 flex-1 basis-40">
|
|
76
|
+
<InputGroupAddon>
|
|
77
|
+
<SearchIcon />
|
|
78
|
+
</InputGroupAddon>
|
|
79
|
+
<InputGroupInput aria-label="Search notes" placeholder="Search notes" />
|
|
80
|
+
</InputGroup>
|
|
81
|
+
<Button size="sm" variant="ghost" data-tour-basic="share">
|
|
82
|
+
<Share2Icon />
|
|
83
|
+
Share
|
|
84
|
+
</Button>
|
|
85
|
+
</div>
|
|
86
|
+
<ul className="m-0 flex list-none flex-col p-0">
|
|
87
|
+
{[
|
|
88
|
+
["Sourdough timings", "Feed at 8, mix at noon, bake the next morning."],
|
|
89
|
+
["Tomato seedlings", "Pot on when the second leaves show."],
|
|
90
|
+
["To read in November", "Three novels and the bread book."],
|
|
91
|
+
].map(([title, line]) => (
|
|
92
|
+
<li
|
|
93
|
+
key={title}
|
|
94
|
+
className="flex flex-col gap-0.5 border-b border-border/60 px-4 py-3 last:border-b-0"
|
|
95
|
+
>
|
|
96
|
+
<span className="flex items-center gap-2 text-sm font-medium text-foreground">
|
|
97
|
+
{title}
|
|
98
|
+
{title === "Sourdough timings" && (
|
|
99
|
+
<StarIcon aria-label="Starred" className="size-3.5 text-muted-foreground" />
|
|
100
|
+
)}
|
|
101
|
+
</span>
|
|
102
|
+
<span className="truncate text-[13px] text-muted-foreground">{line}</span>
|
|
103
|
+
</li>
|
|
104
|
+
))}
|
|
105
|
+
</ul>
|
|
106
|
+
</div>
|
|
107
|
+
</div>
|
|
108
|
+
<div>
|
|
109
|
+
<Button variant="secondary" onClick={() => setOpen(true)}>
|
|
110
|
+
Take the tour
|
|
111
|
+
</Button>
|
|
112
|
+
</div>
|
|
113
|
+
<Tour steps={steps} open={open} onOpenChange={setOpen} />
|
|
114
|
+
</div>
|
|
115
|
+
);
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
A short walk through a screen for newcomers. Each step is a menu-material popover anchored to what it explains, with a mono "02 / 05", a title, a sentence, and Back, Next (Done) and Skip. A step without a target sits mid-screen, for a welcome.
|
|
120
|
+
|
|
121
|
+
## Usage
|
|
122
|
+
|
|
123
|
+
```tsx
|
|
124
|
+
import { Button, Tour, type TourStep } from "@zonsh/ui";
|
|
125
|
+
|
|
126
|
+
const steps: TourStep[] = [
|
|
127
|
+
{ title: "Welcome to your notebook", body: "Four things to know before you start writing." },
|
|
128
|
+
{ target: newNoteRef, title: "Start a note", body: "It saves as you type." },
|
|
129
|
+
{ target: "[data-tour=search]", title: "Find anything", side: "bottom", align: "start" },
|
|
130
|
+
];
|
|
131
|
+
|
|
132
|
+
const [open, setOpen] = React.useState(false);
|
|
133
|
+
|
|
134
|
+
<Button onClick={() => setOpen(true)}>Take the tour</Button>
|
|
135
|
+
<Tour steps={steps} open={open} onOpenChange={setOpen} />;
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
- `steps` — what each step says and points at.
|
|
139
|
+
- `open` / `onOpenChange` — start and stop it.
|
|
140
|
+
- `spotlight` — dim the page around the target (default `true`).
|
|
141
|
+
|
|
142
|
+
Clicks on the dim do nothing; clicks in the hole reach the target. Popover and hole follow the target through scroll and resize. Between steps the popover glides, its height easing and words cross-fading, and the hole takes the new target's size and corners; an off-screen target is scrolled to first, the popover faded out until the page stops. A step whose target isn't on the page is skipped and not counted.
|
|
143
|
+
|
|
144
|
+
## When to use
|
|
145
|
+
|
|
146
|
+
- A first visit to a screen where things aren't where people expect, or do more than they show.
|
|
147
|
+
- After moving something used daily: one or two steps.
|
|
148
|
+
- Not for what a label, description or empty state should say.
|
|
149
|
+
- Three to six steps, from a findable "Take the tour" button; Skip on every step.
|
|
150
|
+
|
|
151
|
+
## Examples
|
|
152
|
+
|
|
153
|
+
### Controlled, no spotlight
|
|
154
|
+
|
|
155
|
+
`step` / `onStepChange` control the step; `onComplete` fires on Done, `onSkip` on Skip or Escape with the step.
|
|
156
|
+
|
|
157
|
+
```tsx
|
|
158
|
+
import { Button, Label, Switch, Tour, type TourStep } from "@zonsh/ui";
|
|
159
|
+
import * as React from "react";
|
|
160
|
+
|
|
161
|
+
/* Two settings explained in place, without the spotlight; the page keeps its colour. */
|
|
162
|
+
export function Controlled() {
|
|
163
|
+
const [open, setOpen] = React.useState(false);
|
|
164
|
+
const [step, setStep] = React.useState(0);
|
|
165
|
+
const [outcome, setOutcome] = React.useState("Not started");
|
|
166
|
+
const steps: TourStep[] = [
|
|
167
|
+
{
|
|
168
|
+
target: "[data-tour-settings=digest]",
|
|
169
|
+
title: "A weekly digest",
|
|
170
|
+
body: "One email on Monday morning with the changes to the pages you follow.",
|
|
171
|
+
side: "top",
|
|
172
|
+
align: "start",
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
target: "[data-tour-settings=offline]",
|
|
176
|
+
title: "Work offline",
|
|
177
|
+
body: "Keeps the last 50 pages you opened on this device, and syncs your edits when you are back online.",
|
|
178
|
+
side: "top",
|
|
179
|
+
align: "start",
|
|
180
|
+
},
|
|
181
|
+
];
|
|
182
|
+
return (
|
|
183
|
+
<div className="flex w-full max-w-md flex-col gap-5">
|
|
184
|
+
<div className="flex flex-col">
|
|
185
|
+
<div
|
|
186
|
+
data-tour-settings="digest"
|
|
187
|
+
className="flex items-center justify-between gap-4 border-b border-border/60 py-3"
|
|
188
|
+
>
|
|
189
|
+
<Label htmlFor="digest">Weekly digest</Label>
|
|
190
|
+
<Switch id="digest" defaultChecked />
|
|
191
|
+
</div>
|
|
192
|
+
<div data-tour-settings="offline" className="flex items-center justify-between gap-4 py-3">
|
|
193
|
+
<Label htmlFor="offline">Work offline</Label>
|
|
194
|
+
<Switch id="offline" />
|
|
195
|
+
</div>
|
|
196
|
+
</div>
|
|
197
|
+
<div className="flex flex-wrap items-center gap-3">
|
|
198
|
+
<Button
|
|
199
|
+
variant="secondary"
|
|
200
|
+
size="sm"
|
|
201
|
+
onClick={() => {
|
|
202
|
+
setStep(0);
|
|
203
|
+
setOpen(true);
|
|
204
|
+
}}
|
|
205
|
+
>
|
|
206
|
+
Explain these settings
|
|
207
|
+
</Button>
|
|
208
|
+
<span className="font-mono text-[12px] text-muted-foreground" aria-live="polite">
|
|
209
|
+
{outcome}
|
|
210
|
+
</span>
|
|
211
|
+
</div>
|
|
212
|
+
<Tour
|
|
213
|
+
steps={steps}
|
|
214
|
+
open={open}
|
|
215
|
+
onOpenChange={setOpen}
|
|
216
|
+
step={step}
|
|
217
|
+
onStepChange={setStep}
|
|
218
|
+
spotlight={false}
|
|
219
|
+
onComplete={() => setOutcome("Finished")}
|
|
220
|
+
onSkip={(at) => setOutcome(`Skipped at step ${at + 1}`)}
|
|
221
|
+
/>
|
|
222
|
+
</div>
|
|
223
|
+
);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
/* A pottery course's lesson page, shown round by Tippy: it waves on the welcome, leaps to each
|
|
227
|
+
stop and says it in a speech bubble, pointing at it, and hops with a check on Done. */
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### With Tippy
|
|
231
|
+
|
|
232
|
+
`TippyGuide` from `@zonsh/ui/tippy` in `guide` makes each step the mascot's speech bubble, Tippy beside the target pointing at it and leaping between steps. The bubble is still the tour's dialog — read, focused and worked the same — and Tippy is decoration. See [Tippy](tippy.md).
|
|
233
|
+
|
|
234
|
+
```tsx
|
|
235
|
+
import { Button, Progress, Tour, type TourStep } from "@zonsh/ui";
|
|
236
|
+
import { TippyGuide } from "@zonsh/ui/tippy";
|
|
237
|
+
import { CheckIcon, CirclePlayIcon, DownloadIcon, MessageCircleQuestionIcon } from "lucide-react";
|
|
238
|
+
import * as React from "react";
|
|
239
|
+
|
|
240
|
+
export function WithTippy() {
|
|
241
|
+
const [open, setOpen] = React.useState(false);
|
|
242
|
+
const steps: TourStep[] = [
|
|
243
|
+
{
|
|
244
|
+
title: "Welcome to Wheel-throwing basics",
|
|
245
|
+
body: "Four things to know about this page. It takes half a minute, and you can skip it at any stop.",
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
target: "[data-tour-course=lessons]",
|
|
249
|
+
title: "Your lessons",
|
|
250
|
+
body: "Six short lessons, in order. A tick marks the ones you have watched to the end.",
|
|
251
|
+
side: "right",
|
|
252
|
+
align: "start",
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
target: "[data-tour-course=progress]",
|
|
256
|
+
title: "How far you are",
|
|
257
|
+
body: "Counted by lessons finished, not minutes watched, so skimming ahead does not move it.",
|
|
258
|
+
side: "bottom",
|
|
259
|
+
align: "start",
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
target: "[data-tour-course=ask]",
|
|
263
|
+
title: "Ask the teacher",
|
|
264
|
+
body: "Questions go to the course's teacher, who answers within two working days.",
|
|
265
|
+
side: "top",
|
|
266
|
+
align: "end",
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
target: "[data-tour-course=notes]",
|
|
270
|
+
title: "Notes to keep",
|
|
271
|
+
body: "Each lesson's clay weights and timings, as a PDF to print and keep by the wheel.",
|
|
272
|
+
side: "top",
|
|
273
|
+
align: "end",
|
|
274
|
+
},
|
|
275
|
+
];
|
|
276
|
+
const lessons = [
|
|
277
|
+
["Wedging the clay", true],
|
|
278
|
+
["Centring", true],
|
|
279
|
+
["Opening", false],
|
|
280
|
+
["Pulling walls", false],
|
|
281
|
+
["Trimming", false],
|
|
282
|
+
["Glazing", false],
|
|
283
|
+
] as const;
|
|
284
|
+
|
|
285
|
+
return (
|
|
286
|
+
<div className="@container flex w-full max-w-3xl flex-col gap-4">
|
|
287
|
+
<div className="grid min-h-80 grid-cols-[14rem_1fr] overflow-hidden surface-container @max-xl:grid-cols-1">
|
|
288
|
+
<nav
|
|
289
|
+
aria-label="Lessons"
|
|
290
|
+
data-tour-course="lessons"
|
|
291
|
+
className="flex flex-col gap-1 border-e border-border/60 p-3 @max-xl:border-e-0 @max-xl:border-b"
|
|
292
|
+
>
|
|
293
|
+
<span className="px-2 pb-1 eyebrow">Lessons</span>
|
|
294
|
+
{lessons.map(([lesson, done], i) => (
|
|
295
|
+
<span
|
|
296
|
+
key={lesson}
|
|
297
|
+
aria-current={i === 2 ? "step" : undefined}
|
|
298
|
+
className="flex items-center gap-2 rounded-item px-2 py-1.5 text-[13px] text-foreground-soft aria-[current]:bg-control-hover aria-[current]:text-foreground"
|
|
299
|
+
>
|
|
300
|
+
<span className="w-5 font-mono text-[11px] text-foreground-soft tabular-nums">
|
|
301
|
+
{String(i + 1).padStart(2, "0")}
|
|
302
|
+
</span>
|
|
303
|
+
<span className="flex-1">{lesson}</span>
|
|
304
|
+
{done && <CheckIcon aria-label="Watched" className="size-3.5 text-muted-foreground" />}
|
|
305
|
+
</span>
|
|
306
|
+
))}
|
|
307
|
+
</nav>
|
|
308
|
+
<div className="flex min-w-0 flex-col gap-4 p-4">
|
|
309
|
+
<div className="flex flex-col gap-1">
|
|
310
|
+
<span className="eyebrow">Lesson 03</span>
|
|
311
|
+
<h3 className="m-0 font-heading text-[26px] leading-tight font-light text-foreground">Opening</h3>
|
|
312
|
+
</div>
|
|
313
|
+
<div
|
|
314
|
+
aria-hidden
|
|
315
|
+
className="flex aspect-video max-h-44 items-center justify-center rounded-card bg-control-surface text-muted-foreground"
|
|
316
|
+
>
|
|
317
|
+
<CirclePlayIcon className="size-8" />
|
|
318
|
+
</div>
|
|
319
|
+
<div data-tour-course="progress" className="max-w-72">
|
|
320
|
+
<Progress label="2 of 6 lessons" value={33} />
|
|
321
|
+
</div>
|
|
322
|
+
<div className="mt-auto flex flex-wrap items-center gap-2">
|
|
323
|
+
<Button size="sm" variant="secondary" data-tour-course="ask">
|
|
324
|
+
<MessageCircleQuestionIcon />
|
|
325
|
+
Ask the teacher
|
|
326
|
+
</Button>
|
|
327
|
+
<Button size="sm" variant="ghost" data-tour-course="notes">
|
|
328
|
+
<DownloadIcon />
|
|
329
|
+
Lesson notes
|
|
330
|
+
</Button>
|
|
331
|
+
</div>
|
|
332
|
+
</div>
|
|
333
|
+
</div>
|
|
334
|
+
<div>
|
|
335
|
+
<Button variant="secondary" onClick={() => setOpen(true)}>
|
|
336
|
+
Show me around
|
|
337
|
+
</Button>
|
|
338
|
+
</div>
|
|
339
|
+
<Tour steps={steps} open={open} onOpenChange={setOpen} guide={(g) => <TippyGuide {...g} />} />
|
|
340
|
+
</div>
|
|
341
|
+
);
|
|
342
|
+
}
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
## Guide
|
|
346
|
+
|
|
347
|
+
`guide` renders a companion in a click-through layer hidden from assistive technology, called with a `TourGuideState` while open and briefly after, to play its way out:
|
|
348
|
+
|
|
349
|
+
| Field | Type | What it is |
|
|
350
|
+
| ---------- | -------------------------------------------- | -------------------------------------------------------------- |
|
|
351
|
+
| `step` | `number` | The step shown, 0-based |
|
|
352
|
+
| `position` | `number` | Its place among the steps on the page, 0-based |
|
|
353
|
+
| `count` | `number` | How many steps are on the page |
|
|
354
|
+
| `target` | `Element \| null` | The step's target; `null` for a step in the middle |
|
|
355
|
+
| `popover` | `HTMLElement \| null` | The popover, to stand beside |
|
|
356
|
+
| `moving` | `boolean` | The popover is on its way to a new step (gliding or scrolling) |
|
|
357
|
+
| `status` | `"open" \| "complete" \| "skip" \| "closed"` | How the tour ended, once it has |
|
|
358
|
+
| `release` | `() => void` | Take the guide away now; it goes after four seconds anyway |
|
|
359
|
+
| `place` | `(placement \| null) => void` | Make the popover the guide's speech bubble (below) |
|
|
360
|
+
|
|
361
|
+
It reads the boxes itself each frame, so the Tour doesn't re-render on scroll.
|
|
362
|
+
|
|
363
|
+
### A guide that says the steps
|
|
364
|
+
|
|
365
|
+
`place({ step, anchor, side?, align?, ready })` makes the popover a speech bubble pointing at `anchor` (an element, or a box with `getBoundingClientRect()` and a `contextElement`) on `side` (`top`), with a tail for the arrow.
|
|
366
|
+
|
|
367
|
+
On a step change the bubble retracts (`moving` while scrolling) and the next waits hidden: `ready: false` places it hidden, `ready: true` shows it; under reduced motion it just appears. On open the Tour waits 100ms for a placement. `place(null)` reverts.
|
|
368
|
+
|
|
369
|
+
## Props
|
|
370
|
+
|
|
371
|
+
| Prop | Type | Default |
|
|
372
|
+
| -------------- | ---------------------------- | ------- |
|
|
373
|
+
| `steps` | `TourStep[]` | — |
|
|
374
|
+
| `open` | `boolean` | — |
|
|
375
|
+
| `defaultOpen` | `boolean` | `false` |
|
|
376
|
+
| `onOpenChange` | `(open) => void` | — |
|
|
377
|
+
| `step` | `number` — 0-based | — |
|
|
378
|
+
| `defaultStep` | `number` | `0` |
|
|
379
|
+
| `onStepChange` | `(step) => void` | — |
|
|
380
|
+
| `onComplete` | `() => void` — Done | — |
|
|
381
|
+
| `onSkip` | `(step) => void` — Skip, Esc | — |
|
|
382
|
+
| `spotlight` | `boolean` | `true` |
|
|
383
|
+
| `guide` | `(state) => ReactNode` | — |
|
|
384
|
+
| `labels` | `Partial<TourMessages>` | English |
|
|
385
|
+
| `className` | `string` — on the popover | — |
|
|
386
|
+
|
|
387
|
+
`TourStep` is `{ target?, title, body?, side?, align? }`. `target` is a selector, ref or function; omit it for mid-screen. `side` (`top`, `bottom`, `left`, `right`, `inline-start`, `inline-end`) and `align` (`start`, `center`, `end`) place the popover, which flips and shifts to stay on screen and is never wider than a phone's.
|
|
388
|
+
|
|
389
|
+
Slots: `tour-content` (with `data-step`, `data-tour-glide`, `data-tour-bubble`, `data-tour-hidden`), `tour-step`, `tour-progress`, `tour-title`, `tour-body`, `tour-footer`, `tour-next`, `tour-arrow`, `tour-tail`, `tour-spotlight` and `tour-guide`.
|
|
390
|
+
|
|
391
|
+
## Brand rules
|
|
392
|
+
|
|
393
|
+
- **Do** make each step one thing to know: what it is and why it helps.
|
|
394
|
+
- **Do** let people leave at any step, and start the tour from a button they can find again.
|
|
395
|
+
- **Don't** colour the spotlight or popover; the dim is a dialog backdrop's black.
|
|
396
|
+
- **Don't** open a tour on every visit, or over a task someone has already started.
|
|
397
|
+
|
|
398
|
+
## Accessibility
|
|
399
|
+
|
|
400
|
+
- The popover is a non-modal dialog named by the title, described by the body, and focused at every step; the count reads "Step 2 of 5".
|
|
401
|
+
- On end, focus returns to where it was.
|
|
402
|
+
- The spotlight is `aria-hidden`; the page under it stays in the accessibility tree.
|
|
403
|
+
- Under reduced motion targets scroll into view at once, and nothing glides, fades or scales: popover and hole go straight to the next target, and a guide's bubble appears there.
|
|
404
|
+
- As a guide's bubble it is the same dialog; hidden between steps, it takes no clicks.
|
|
405
|
+
- While gliding, the previous step's fading words are hidden from assistive technology.
|
|
406
|
+
- The words come from `labels` or a `LocaleProvider` (`messages.tour`).
|
|
407
|
+
|
|
408
|
+
### Keyboard
|
|
409
|
+
|
|
410
|
+
| Key | What it does |
|
|
411
|
+
| --------------- | ------------------------------------------------------------------------------------------------- |
|
|
412
|
+
| → / ← | Moves to the next or previous step (swapped right to left); on the last step, → finishes the tour |
|
|
413
|
+
| Escape | Skips the tour |
|
|
414
|
+
| Tab / Shift+Tab | Moves through Skip, Back and Next |
|
|
415
|
+
| Enter / Space | Presses the focused button |
|
|
416
|
+
|
|
417
|
+
The arrows work anywhere except with a modifier, in anything editable, or in a widget that uses them: a slider, a splitter, tabs, a radio group, a listbox, a menu, a menubar, a grid, a tree, a toolbar, a toggle group, a carousel, or a Sortable item lifted to be moved.
|
|
418
|
+
|
|
419
|
+
---
|
|
420
|
+
|
|
421
|
+
- Import: `import { Tour } from "@zonsh/ui"`
|
|
422
|
+
- Source: `packages/ui/src/components/tour.tsx`
|
|
423
|
+
- Primitive: `@base-ui/react/popover` (Base UI docs: `node_modules/@base-ui/react/docs/react/components/popover.md`)
|