@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,166 @@
|
|
|
1
|
+
# OTP Field
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Field, FieldDescription, FieldLabel, OtpField } from "@zonsh/ui";
|
|
5
|
+
|
|
6
|
+
export function Basic() {
|
|
7
|
+
return (
|
|
8
|
+
<Field>
|
|
9
|
+
<FieldLabel>Verification code</FieldLabel>
|
|
10
|
+
<OtpField length={6} />
|
|
11
|
+
<FieldDescription>Enter the 6-digit code we sent to your email address.</FieldDescription>
|
|
12
|
+
</Field>
|
|
13
|
+
);
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
One recessed square per character with mono digits. A focus ring glides to the slot that takes the next character; in a narrow row the slots narrow rather than overflow.
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import { Field, FieldDescription, FieldLabel, OtpField } from "@zonsh/ui";
|
|
23
|
+
|
|
24
|
+
<Field>
|
|
25
|
+
<FieldLabel>Verification code</FieldLabel>
|
|
26
|
+
<OtpField length={6} />
|
|
27
|
+
<FieldDescription>Enter the 6-digit code we sent to your email address.</FieldDescription>
|
|
28
|
+
</Field>;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The props you'll use: `length`, `onValueComplete` (verify once filled) and `groupSize`.
|
|
32
|
+
|
|
33
|
+
## When to use
|
|
34
|
+
|
|
35
|
+
- Verification, sign-in and invite codes with a fixed length.
|
|
36
|
+
- Not for passwords or free text.
|
|
37
|
+
|
|
38
|
+
## Examples
|
|
39
|
+
|
|
40
|
+
### Grouped
|
|
41
|
+
|
|
42
|
+
Use `size="lg"` when the code is the whole screen.
|
|
43
|
+
|
|
44
|
+
```tsx
|
|
45
|
+
import { Field, FieldDescription, FieldLabel, OtpField } from "@zonsh/ui";
|
|
46
|
+
|
|
47
|
+
export function Grouped() {
|
|
48
|
+
return (
|
|
49
|
+
<Field>
|
|
50
|
+
<FieldLabel>Sign-in code</FieldLabel>
|
|
51
|
+
<OtpField length={6} groupSize={3} size="lg" />
|
|
52
|
+
<FieldDescription>Paste the whole code at once if that is easier.</FieldDescription>
|
|
53
|
+
</Field>
|
|
54
|
+
);
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Alphanumeric
|
|
59
|
+
|
|
60
|
+
`validationType="alphanumeric"`; `normalizeValue` can uppercase.
|
|
61
|
+
|
|
62
|
+
```tsx
|
|
63
|
+
import { Field, FieldDescription, FieldLabel, OtpField } from "@zonsh/ui";
|
|
64
|
+
|
|
65
|
+
export function Alphanumeric() {
|
|
66
|
+
return (
|
|
67
|
+
<Field>
|
|
68
|
+
<FieldLabel>Invite code</FieldLabel>
|
|
69
|
+
<OtpField
|
|
70
|
+
length={8}
|
|
71
|
+
groupSize={4}
|
|
72
|
+
validationType="alphanumeric"
|
|
73
|
+
normalizeValue={(value) => value.toUpperCase()}
|
|
74
|
+
/>
|
|
75
|
+
<FieldDescription>Letters and numbers, as printed in your invitation email.</FieldDescription>
|
|
76
|
+
</Field>
|
|
77
|
+
);
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### States
|
|
82
|
+
|
|
83
|
+
```tsx
|
|
84
|
+
import { Field, FieldError, FieldLabel, OtpField } from "@zonsh/ui";
|
|
85
|
+
|
|
86
|
+
function Invalid() {
|
|
87
|
+
return (
|
|
88
|
+
<Field invalid>
|
|
89
|
+
<FieldLabel>Verification code</FieldLabel>
|
|
90
|
+
<OtpField length={6} defaultValue="482913" />
|
|
91
|
+
<FieldError match>That code has expired. We have sent you a new one.</FieldError>
|
|
92
|
+
</Field>
|
|
93
|
+
);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
function Disabled() {
|
|
97
|
+
return (
|
|
98
|
+
<Field disabled>
|
|
99
|
+
<FieldLabel>Verification code</FieldLabel>
|
|
100
|
+
<OtpField length={6} />
|
|
101
|
+
</Field>
|
|
102
|
+
);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/** The invalid and disabled states, one under the other. */
|
|
106
|
+
export function States() {
|
|
107
|
+
return (
|
|
108
|
+
<div className="flex w-full max-w-sm flex-col gap-8">
|
|
109
|
+
<Invalid />
|
|
110
|
+
<Disabled />
|
|
111
|
+
</div>
|
|
112
|
+
);
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Props
|
|
117
|
+
|
|
118
|
+
| Prop | Type | Default |
|
|
119
|
+
| ------------------------ | ---------------------------------------------------- | ----------- |
|
|
120
|
+
| `length` | `number` (required) | — |
|
|
121
|
+
| `size` | `"default" \| "lg"` | `"default"` |
|
|
122
|
+
| `groupSize` | `number`: chunk the generated slots | — |
|
|
123
|
+
| `validationType` | `"numeric" \| "alpha" \| "alphanumeric" \| "none"` | `"numeric"` |
|
|
124
|
+
| `value` / `defaultValue` | `string` | — |
|
|
125
|
+
| `onValueChange` | `(value: string, details) => void` | — |
|
|
126
|
+
| `onValueComplete` | `(value: string, details) => void` | — |
|
|
127
|
+
| `autoSubmit` | `boolean`: submit the form once all slots are filled | `false` |
|
|
128
|
+
| `mask` | `boolean` | `false` |
|
|
129
|
+
| `inputRef` | the first slot, for a form library to focus the code | — |
|
|
130
|
+
|
|
131
|
+
For custom layouts, pass `OtpFieldSlot` and `OtpFieldSeparator` children. Data attributes: `data-size`, `data-complete`, `data-disabled`, `data-invalid`. A form reset returns an uncontrolled field to its `defaultValue`. `labels.character(index, length)` names the generated slots; a `LocaleProvider` sets it for every OtpField (`messages.otpField`).
|
|
132
|
+
|
|
133
|
+
## Brand rules
|
|
134
|
+
|
|
135
|
+
- **Do** say where the code was sent and what to do if it does not arrive.
|
|
136
|
+
- **Do** keep the slots square, recessed and mono.
|
|
137
|
+
- **Don't** block paste, and don't split a code across separate inputs you manage yourself.
|
|
138
|
+
|
|
139
|
+
## Accessibility
|
|
140
|
+
|
|
141
|
+
- `autoComplete="one-time-code"` lets phones suggest the code from a message.
|
|
142
|
+
- The first slot takes the field label; the others are announced as "Character n of N".
|
|
143
|
+
- Focus shows the field's 2px `--control-focus` outline and border on the active slot.
|
|
144
|
+
- On a right-to-left page the code still reads left to right, at the field's start, and screen readers hear it first to last.
|
|
145
|
+
|
|
146
|
+
### Keyboard
|
|
147
|
+
|
|
148
|
+
| Key | What it does |
|
|
149
|
+
| --------------------------- | ------------------------------------------------------------------- |
|
|
150
|
+
| Typing | Fills the slot and moves to the next |
|
|
151
|
+
| ← / → | Moves to the previous or next slot |
|
|
152
|
+
| ⌘← / ⌘→ · Ctrl+← / Ctrl+→ | Moves to the first slot, or to the first empty one |
|
|
153
|
+
| Home / ↑ | Moves to the first slot |
|
|
154
|
+
| End / ↓ | Moves to the first empty slot, or the last |
|
|
155
|
+
| Backspace | Clears the slot, or the one before when it is empty, and moves back |
|
|
156
|
+
| ⌘Backspace / Ctrl+Backspace | Clears the whole code |
|
|
157
|
+
| Delete | Removes the slot's character; the ones after it move up |
|
|
158
|
+
| Tab | Leaves the field: the slots are one Tab stop |
|
|
159
|
+
|
|
160
|
+
Pasting fills every slot. ← and → keep their direction right to left.
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
- Import: `import { OtpField, OtpFieldSlot, OtpFieldSeparator } from "@zonsh/ui"`
|
|
165
|
+
- Source: `packages/ui/src/components/otp-field.tsx`
|
|
166
|
+
- Primitive: `@base-ui/react/otp-field` (Base UI docs: `node_modules/@base-ui/react/docs/react/components/otp-field.md`)
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Pagination
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Pagination } from "@zonsh/ui";
|
|
5
|
+
import * as React from "react";
|
|
6
|
+
|
|
7
|
+
export function Default() {
|
|
8
|
+
const [page, setPage] = React.useState(4);
|
|
9
|
+
return <Pagination page={page} pageCount={12} onPageChange={setPage} />;
|
|
10
|
+
}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
A long list, a page at a time. Pages are raised squares, 38px or 30px (`sm`), with mono tabular numbers; the current one carries the `--control-focus` edge, which glides on change. Gaps collapse into an ellipsis, so the width stays constant.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import { Pagination } from "@zonsh/ui";
|
|
19
|
+
|
|
20
|
+
const [page, setPage] = React.useState(1);
|
|
21
|
+
|
|
22
|
+
<Pagination page={page} pageCount={12} onPageChange={setPage} />;
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The props you'll reach for: `page`, `pageCount` and `onPageChange` (or `getHref` for links).
|
|
26
|
+
|
|
27
|
+
## When to use
|
|
28
|
+
|
|
29
|
+
- Long result lists, archives and tables where loading everything is impractical.
|
|
30
|
+
- `size="sm"` under a `dense` table or on admin screens.
|
|
31
|
+
- On a phone it narrows by itself: first the neighbours of the current page go (1 … 4 … 12), then the page numbers (`compact`).
|
|
32
|
+
- Not for short lists — under roughly 50 rows, show them all.
|
|
33
|
+
|
|
34
|
+
## Examples
|
|
35
|
+
|
|
36
|
+
### Dense
|
|
37
|
+
|
|
38
|
+
```tsx
|
|
39
|
+
import { Pagination } from "@zonsh/ui";
|
|
40
|
+
import * as React from "react";
|
|
41
|
+
|
|
42
|
+
export function Dense() {
|
|
43
|
+
const [page, setPage] = React.useState(1);
|
|
44
|
+
return <Pagination size="sm" page={page} pageCount={8} onPageChange={setPage} />;
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Compact
|
|
49
|
+
|
|
50
|
+
Previous, the position in mono and Next. A pager turns compact on its own where even its shortest row (1 … 4 … 12) would not fit on one line — a phone, a narrow card — and `compact` sets it always.
|
|
51
|
+
|
|
52
|
+
```tsx
|
|
53
|
+
import { Pagination } from "@zonsh/ui";
|
|
54
|
+
import * as React from "react";
|
|
55
|
+
|
|
56
|
+
export function Compact() {
|
|
57
|
+
const [page, setPage] = React.useState(3);
|
|
58
|
+
return <Pagination compact page={page} pageCount={12} onPageChange={setPage} />;
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### As links
|
|
63
|
+
|
|
64
|
+
With `getHref` every page is a real link — good for crawlable archives.
|
|
65
|
+
|
|
66
|
+
```tsx
|
|
67
|
+
import { Pagination } from "@zonsh/ui";
|
|
68
|
+
|
|
69
|
+
export function AsLinks() {
|
|
70
|
+
return <Pagination page={2} pageCount={5} getHref={(p) => `#page-${p}`} />;
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Props
|
|
75
|
+
|
|
76
|
+
| Prop | Type | Default |
|
|
77
|
+
| -------------- | -------------------------------------------------- | ----------- |
|
|
78
|
+
| `page` | `number` — 1-based | required |
|
|
79
|
+
| `pageCount` | `number` — a decimal rounds up; NaN, ∞ or < 0 is 0 | required |
|
|
80
|
+
| `onPageChange` | `(page: number) => void` | — |
|
|
81
|
+
| `getHref` | `(page: number) => string` — render links | — |
|
|
82
|
+
| `compact` | `boolean \| "auto"` — Previous, "3 / 12" and Next only; `"auto"` where the row would not fit | `"auto"` |
|
|
83
|
+
| `siblingCount` | `number` — pages either side of the current; none where the row would not fit on one line | `1` |
|
|
84
|
+
| `size` | `"sm" \| "default"` | `"default"` |
|
|
85
|
+
| `labels` | `{ nav?, previous?, next?, page?: (n) => string, status?: (n, count) => string }` | English |
|
|
86
|
+
|
|
87
|
+
Other `<nav>` props are forwarded.
|
|
88
|
+
|
|
89
|
+
## Brand rules
|
|
90
|
+
|
|
91
|
+
- **Do** keep numbers mono and tabular.
|
|
92
|
+
- **Do** match the surface: `sm` with dense tables, default elsewhere.
|
|
93
|
+
- **Don't** mark the current page with a primary (dark) fill; it is raised with the focus edge.
|
|
94
|
+
- **Don't** add "First" / "Last" buttons; the first and last pages are always shown.
|
|
95
|
+
|
|
96
|
+
## Accessibility
|
|
97
|
+
|
|
98
|
+
- Renders `<nav aria-label="Pagination">` with a list of buttons or links.
|
|
99
|
+
- Each page has a name ("Page 4"); the current one has `aria-current="page"`.
|
|
100
|
+
- "Previous page" / "Next page" are disabled at the ends but stay focusable, so Next onto the last page keeps focus.
|
|
101
|
+
- A `page` outside `1…pageCount` (a filter shrank the list), or fractional, shows as the nearest page; choosing a page reports it whenever it differs from `page`.
|
|
102
|
+
- The compact form's "3 / 12" is read as "Page 3 of 12" (`labels.status`).
|
|
103
|
+
- On a touch screen every page and arrow takes a 44px tap area (`touch-target`), with nothing drawn.
|
|
104
|
+
- A `pageCount` from a division (95 / 10) rounds up to 10; `NaN` (loading), infinite or negative shows only the disabled arrows.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
- Import: `import { Pagination } from "@zonsh/ui"`
|
|
109
|
+
- Source: `packages/ui/src/components/pagination.tsx`
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# PDF Viewer
|
|
2
|
+
|
|
3
|
+
A PDF reader in the zon material. [pdf.js](https://mozilla.github.io/pdf.js/) draws pages on white paper with selectable, searchable text over them. A flat toolbar holds the page field, zoom, rotation and the file's actions; on wide containers a sidebar shows numbered thumbnails and, when the PDF has bookmarks, its outline. Contents entries jump to their page, web links open in a new tab, search floats over the pages and a mono page count shows while you scroll.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
PdfViewer has its own entry, `@zonsh/ui/pdf-viewer`, and needs the optional `pdfjs-dist`:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add pdfjs-dist
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { PdfPreview, PdfViewer } from "@zonsh/ui/pdf-viewer";
|
|
15
|
+
|
|
16
|
+
<PdfViewer src="/files/contract.pdf" className="h-[40rem]" />
|
|
17
|
+
|
|
18
|
+
<PdfPreview src="/files/contract.pdf" title="Service agreement" />
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The props you'll set: `src` (a URL, or bytes as `Uint8Array` / `ArrayBuffer`, compared by identity — keep them stable; a cross-origin URL needs CORS), `fileName` and `defaultZoom`. Give the viewer a height.
|
|
22
|
+
|
|
23
|
+
pdf.js (about 1 MB with its worker) loads only when the first viewer or preview mounts and parses in a module worker, which Vite, webpack 5 and Rollup build without setup; without module workers it runs on the main thread.
|
|
24
|
+
|
|
25
|
+
## When to use
|
|
26
|
+
|
|
27
|
+
- **`PdfViewer`** to read the document in place — a contract to sign, a paper to review, a manual beside its product.
|
|
28
|
+
- **`PdfPreview`** for a document among others — an attachment, a file in a list. It shows the first page and length, and opens the reader in a dialog.
|
|
29
|
+
- A plain link when people only download the file.
|
|
30
|
+
- Not for editing, filling forms or signing: the viewer only shows documents.
|
|
31
|
+
|
|
32
|
+
## Examples
|
|
33
|
+
|
|
34
|
+
### Preview
|
|
35
|
+
|
|
36
|
+
A 20px card with the first page, drawn once in view; clicking opens the reader in a dialog, with its close button at the end of the toolbar.
|
|
37
|
+
|
|
38
|
+
```tsx
|
|
39
|
+
import { PdfPreview } from "@zonsh/ui/pdf-viewer";
|
|
40
|
+
|
|
41
|
+
const BRIEF = `${import.meta.env.BASE_URL}files/project-brief.pdf`;
|
|
42
|
+
|
|
43
|
+
export function Preview() {
|
|
44
|
+
return <PdfPreview src={BRIEF} fileName="project-brief.pdf" title="Room booking — project brief" />;
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Card, fit page
|
|
49
|
+
|
|
50
|
+
`variant="card"` gives the viewer 20px corners; `defaultZoom="fit-page"` shows whole pages and `defaultPage` opens at a given page.
|
|
51
|
+
|
|
52
|
+
```tsx
|
|
53
|
+
import { PdfViewer } from "@zonsh/ui/pdf-viewer";
|
|
54
|
+
|
|
55
|
+
// BRIEF: as in the first example on this page that uses them.
|
|
56
|
+
|
|
57
|
+
export function Card() {
|
|
58
|
+
return (
|
|
59
|
+
<PdfViewer
|
|
60
|
+
src={BRIEF}
|
|
61
|
+
fileName="project-brief.pdf"
|
|
62
|
+
variant="card"
|
|
63
|
+
defaultZoom="fit-page"
|
|
64
|
+
defaultPage={4}
|
|
65
|
+
className="h-[34rem]"
|
|
66
|
+
/>
|
|
67
|
+
);
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Compact
|
|
72
|
+
|
|
73
|
+
As the container narrows, the page and zoom steppers, file name, print and thumbnail rail step out, then the file's actions wrap to a second row. Here the rail and print are off.
|
|
74
|
+
|
|
75
|
+
```tsx
|
|
76
|
+
import { PdfViewer } from "@zonsh/ui/pdf-viewer";
|
|
77
|
+
|
|
78
|
+
// BRIEF: as in the first example on this page that uses them.
|
|
79
|
+
|
|
80
|
+
export function Compact() {
|
|
81
|
+
return (
|
|
82
|
+
<div className="w-full max-w-md">
|
|
83
|
+
<PdfViewer
|
|
84
|
+
src={BRIEF}
|
|
85
|
+
fileName="project-brief.pdf"
|
|
86
|
+
thumbnails={false}
|
|
87
|
+
print={false}
|
|
88
|
+
className="h-[30rem]"
|
|
89
|
+
/>
|
|
90
|
+
</div>
|
|
91
|
+
);
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Load error
|
|
96
|
+
|
|
97
|
+
A missing, password-protected, empty or non-PDF file ends in an empty state that says which, with a link to download it.
|
|
98
|
+
|
|
99
|
+
```tsx
|
|
100
|
+
import { PdfViewer } from "@zonsh/ui/pdf-viewer";
|
|
101
|
+
|
|
102
|
+
export function Unavailable() {
|
|
103
|
+
return <PdfViewer src={`${import.meta.env.BASE_URL}files/quarterly-report.pdf`} className="h-72" />;
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Props
|
|
108
|
+
|
|
109
|
+
### PdfViewer
|
|
110
|
+
|
|
111
|
+
| Prop | Type | Default |
|
|
112
|
+
| ---------------------------------------------- | ---------------------------------------------------------- | ------------ |
|
|
113
|
+
| `src` | `string \| URL \| Uint8Array \| ArrayBuffer` | — |
|
|
114
|
+
| `fileName` | `string` — downloads and the toolbar | from the URL |
|
|
115
|
+
| `variant` | `"region" \| "card" \| "plain"` | `"region"` |
|
|
116
|
+
| `defaultZoom` | `"auto" \| "fit-width" \| "fit-page" \| number` (1 = 100%) | `"auto"` |
|
|
117
|
+
| `defaultPage` | `number` | `1` |
|
|
118
|
+
| `onPageChange` | `(page: number) => void` | — |
|
|
119
|
+
| `thumbnails` / `defaultThumbnailsOpen` | `boolean` | `true` |
|
|
120
|
+
| `search` / `download` / `print` / `fullscreen` | `boolean` | `true` |
|
|
121
|
+
| `toolbarEnd` | `ReactNode` — extra toolbar items at the end | — |
|
|
122
|
+
|
|
123
|
+
It forwards `div` props. Without a height from `className` it takes 80% of the screen, at most 736px.
|
|
124
|
+
|
|
125
|
+
### PdfPreview
|
|
126
|
+
|
|
127
|
+
| Prop | Type | Default |
|
|
128
|
+
| ------------- | -------------------------------------------- | --------------- |
|
|
129
|
+
| `src` | `string \| URL \| Uint8Array \| ArrayBuffer` | — |
|
|
130
|
+
| `fileName` | `string` | from the URL |
|
|
131
|
+
| `title` | `ReactNode` — the name on the card | the file name |
|
|
132
|
+
| `description` | `ReactNode` — one line under it | "PDF · n pages" |
|
|
133
|
+
| `viewer` | `PdfViewerProps` for the reader that opens | — |
|
|
134
|
+
|
|
135
|
+
It forwards `button` props.
|
|
136
|
+
|
|
137
|
+
`labels` (`Partial<PdfViewerMessages>`) renames the toolbar, rail, search, error and the preview card's line, on both components; a `LocaleProvider` sets them for every viewer (`messages.pdfViewer`). Load failures are `error(reason)`, with `reason` a `PdfError`.
|
|
138
|
+
|
|
139
|
+
## Keyboard
|
|
140
|
+
|
|
141
|
+
| Keys | Does |
|
|
142
|
+
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
143
|
+
| ⌘F / Ctrl+F | Search in the document |
|
|
144
|
+
| Enter / Shift+Enter | Next / previous match (in search) |
|
|
145
|
+
| Escape | One step back: drop a page number being typed, close search, leave full screen; then a dialog around the viewer closes |
|
|
146
|
+
| ⌘+ / ⌘− · Ctrl+ / Ctrl− | Zoom in / out |
|
|
147
|
+
| ⌘0 / Ctrl+0 | Automatic zoom (fit width, at most 125%) |
|
|
148
|
+
| ⌘ / Ctrl + scroll, pinch | Zoom around the page in view |
|
|
149
|
+
| Arrow keys, Page Up / Down | Scroll the pages (once they have focus) |
|
|
150
|
+
| Tab (in the pages) | Move through the document's links |
|
|
151
|
+
|
|
152
|
+
Shortcuts work while focus is inside the viewer, so the page's own ⌘F works elsewhere. They take ⌘ on a Mac and Ctrl elsewhere, like the browser's (a Mac's Ctrl+F still moves the caret in fields); wheel and pinch zoom take either.
|
|
153
|
+
|
|
154
|
+
## Brand rules
|
|
155
|
+
|
|
156
|
+
- **Do** keep pages white in both themes. They are paper; matches and the selection are ink on that paper, never a colour.
|
|
157
|
+
- **Do** keep one viewer per view, with a real height. A reader squeezed into 300px is a preview — use `PdfPreview`.
|
|
158
|
+
- **Do** name files the way people will recognise them: `fileName` is what lands in their downloads.
|
|
159
|
+
- **Don't** put a primary button in the toolbar. Its actions belong to the file; the view's primary ("Sign contract") sits outside the viewer.
|
|
160
|
+
- **Don't** describe a placeholder document as a real one.
|
|
161
|
+
|
|
162
|
+
## Accessibility
|
|
163
|
+
|
|
164
|
+
- The toolbar is a Base UI Toolbar: one Tab stop, arrow keys between controls, a tooltip and `aria-label` on every icon button. The page field reads "Page", then "of n pages".
|
|
165
|
+
- The zoom button names the level ("Zoom, 125%") and opens a menu of radio items; picking one by pointer, Enter or Space applies it, closes the menu and returns focus to the button.
|
|
166
|
+
- The page area is a focusable region named after the file and page in view, so it scrolls from the keyboard.
|
|
167
|
+
- Document links are real links: "Go to page 4" inside it; the address and "(opens in a new tab)" for web links.
|
|
168
|
+
- The outline is a list of buttons in a `nav` named "Outline"; the section being read is `aria-current`, and nested entries collapse with a labelled toggle. The sidebar's Pages / Outline switch is a tab list.
|
|
169
|
+
- The scrolling page count is `aria-hidden`; the page field says the same.
|
|
170
|
+
- Page text is real text in the accessibility tree (pdf.js's text layer). Scanned documents without text have nothing to read; describe them next to the viewer.
|
|
171
|
+
- The search count is a polite live region ("2 / 7", "No matches").
|
|
172
|
+
- When a PDF can't open, the empty state says why in words and offers the download; the toolbar shows only the file name.
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
- Import: `import { PdfViewer, PdfPreview } from "@zonsh/ui/pdf-viewer"`
|
|
177
|
+
- Source: `packages/ui/src/components/pdf-viewer.tsx`
|