@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,776 @@
|
|
|
1
|
+
# Data Table
|
|
2
|
+
|
|
3
|
+
```tsx
|
|
4
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
5
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
6
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
7
|
+
import * as React from "react";
|
|
8
|
+
|
|
9
|
+
type DeployStatus = "Succeeded" | "Building" | "Queued" | "Failed" | "Cancelled";
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Each status in its status colour: done, running, waiting and failed. Cancelled is neither good
|
|
13
|
+
* nor bad — someone stopped it — so it stays monochrome.
|
|
14
|
+
*/
|
|
15
|
+
const statusTag = {
|
|
16
|
+
Succeeded: { tone: "success" },
|
|
17
|
+
Building: { tone: "info" },
|
|
18
|
+
Queued: { tone: "warning" },
|
|
19
|
+
Failed: { tone: "destructive" },
|
|
20
|
+
Cancelled: { variant: "muted" },
|
|
21
|
+
} as const satisfies Record<DeployStatus, Pick<React.ComponentProps<typeof Tag>, "tone" | "variant">>;
|
|
22
|
+
|
|
23
|
+
interface Deploy {
|
|
24
|
+
id: string;
|
|
25
|
+
project: string;
|
|
26
|
+
status: DeployStatus;
|
|
27
|
+
/** Seconds. */
|
|
28
|
+
duration: number;
|
|
29
|
+
/** ISO timestamp. */
|
|
30
|
+
started: string;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
const projects = ["Docs site", "Storefront", "Mobile API", "Image resizer", "Status page", "Blog"];
|
|
34
|
+
|
|
35
|
+
const statuses: DeployStatus[] = [
|
|
36
|
+
"Succeeded",
|
|
37
|
+
"Succeeded",
|
|
38
|
+
"Succeeded",
|
|
39
|
+
"Building",
|
|
40
|
+
"Succeeded",
|
|
41
|
+
"Failed",
|
|
42
|
+
"Queued",
|
|
43
|
+
"Cancelled",
|
|
44
|
+
];
|
|
45
|
+
|
|
46
|
+
const deploys: Deploy[] = Array.from({ length: 48 }, (_, i) => {
|
|
47
|
+
const day = 5 - Math.floor(i / 10);
|
|
48
|
+
const hour = 23 - ((i * 5) % 24);
|
|
49
|
+
const minute = (i * 17) % 60;
|
|
50
|
+
return {
|
|
51
|
+
id: `DEP-${String(1048 - i).padStart(4, "0")}`,
|
|
52
|
+
project: projects[(i * 7) % projects.length]!,
|
|
53
|
+
status: statuses[i % statuses.length]!,
|
|
54
|
+
duration: 4 + ((i * 37) % 290),
|
|
55
|
+
started: `2026-10-0${Math.max(day, 1)}T${String(hour).padStart(2, "0")}:${String(minute).padStart(2, "0")}:00`,
|
|
56
|
+
};
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
function formatDuration(seconds: number) {
|
|
60
|
+
const h = Math.floor(seconds / 3600);
|
|
61
|
+
const m = Math.floor((seconds % 3600) / 60);
|
|
62
|
+
const s = seconds % 60;
|
|
63
|
+
if (h) return `${h}h ${String(m).padStart(2, "0")}m`;
|
|
64
|
+
return m ? `${m}m ${String(s).padStart(2, "0")}s` : `${s}s`;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
function formatStarted(iso: string) {
|
|
68
|
+
return iso.slice(0, 16).replace("T", " ");
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
const column = createDataTableColumnHelper<Deploy>();
|
|
72
|
+
|
|
73
|
+
const columns = column.columns([
|
|
74
|
+
column.accessor("project", {
|
|
75
|
+
header: "Project",
|
|
76
|
+
cell: (info) => <span className="whitespace-nowrap text-foreground">{info.getValue()}</span>,
|
|
77
|
+
}),
|
|
78
|
+
column.accessor("status", {
|
|
79
|
+
header: "Status",
|
|
80
|
+
cell: (info) => {
|
|
81
|
+
const status = info.getValue();
|
|
82
|
+
return (
|
|
83
|
+
<Tag dot {...statusTag[status]}>
|
|
84
|
+
{status}
|
|
85
|
+
</Tag>
|
|
86
|
+
);
|
|
87
|
+
},
|
|
88
|
+
}),
|
|
89
|
+
column.accessor("duration", {
|
|
90
|
+
header: "Duration",
|
|
91
|
+
meta: { numeric: true },
|
|
92
|
+
enableGlobalFilter: false,
|
|
93
|
+
cell: (info) => formatDuration(info.getValue()),
|
|
94
|
+
}),
|
|
95
|
+
column.accessor("started", {
|
|
96
|
+
header: "Started",
|
|
97
|
+
meta: { numeric: true },
|
|
98
|
+
cell: (info) => formatStarted(info.getValue()),
|
|
99
|
+
}),
|
|
100
|
+
column.accessor("id", {
|
|
101
|
+
header: "Deploy ID",
|
|
102
|
+
meta: { numeric: true },
|
|
103
|
+
}),
|
|
104
|
+
column.display({
|
|
105
|
+
id: "actions",
|
|
106
|
+
meta: { label: "Actions", className: "w-0" },
|
|
107
|
+
enableHiding: false,
|
|
108
|
+
header: () => <span className="sr-only">Actions</span>,
|
|
109
|
+
cell: ({ row }) => (
|
|
110
|
+
<Menu>
|
|
111
|
+
<MenuTrigger
|
|
112
|
+
render={<Button variant="ghost" size="icon-sm" aria-label={`Actions for ${row.original.id}`} />}
|
|
113
|
+
>
|
|
114
|
+
<EllipsisIcon />
|
|
115
|
+
</MenuTrigger>
|
|
116
|
+
<MenuContent align="end">
|
|
117
|
+
<MenuItem>
|
|
118
|
+
<FileTextIcon />
|
|
119
|
+
View log
|
|
120
|
+
</MenuItem>
|
|
121
|
+
<MenuItem>
|
|
122
|
+
<RotateCwIcon />
|
|
123
|
+
Redeploy
|
|
124
|
+
</MenuItem>
|
|
125
|
+
<MenuSeparator />
|
|
126
|
+
<MenuItem>
|
|
127
|
+
<Undo2Icon className="rtl:-scale-x-100" />
|
|
128
|
+
Roll back to this deploy
|
|
129
|
+
</MenuItem>
|
|
130
|
+
</MenuContent>
|
|
131
|
+
</Menu>
|
|
132
|
+
),
|
|
133
|
+
}),
|
|
134
|
+
]);
|
|
135
|
+
|
|
136
|
+
export function Default() {
|
|
137
|
+
return (
|
|
138
|
+
<DataTable
|
|
139
|
+
columns={columns}
|
|
140
|
+
data={deploys}
|
|
141
|
+
getRowId={(deploy) => deploy.id}
|
|
142
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
143
|
+
initialColumnVisibility={{ id: false }}
|
|
144
|
+
searchPlaceholder="Search deploys…"
|
|
145
|
+
label="Deploys"
|
|
146
|
+
/>
|
|
147
|
+
);
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
A `Table` card with a data grid's controls: sortable mono headers, a search field, a "Columns" menu, a `Checkbox` column (Shift-click for a range) and a compact pager with a mono "1–10 of 48" count. It runs on TanStack Table v9; you write only the column definitions.
|
|
152
|
+
|
|
153
|
+
## Usage
|
|
154
|
+
|
|
155
|
+
Import from `@zonsh/ui/data-table` and add `@tanstack/react-table`, an optional dependency.
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
pnpm add @tanstack/react-table
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
```tsx
|
|
162
|
+
import { Tag } from "@zonsh/ui";
|
|
163
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
164
|
+
|
|
165
|
+
type Deploy = { id: string; project: string; status: string; duration: number };
|
|
166
|
+
|
|
167
|
+
const column = createDataTableColumnHelper<Deploy>();
|
|
168
|
+
|
|
169
|
+
const columns = column.columns([
|
|
170
|
+
column.accessor("project", { header: "Project" }),
|
|
171
|
+
column.accessor("status", { header: "Status", cell: (info) => <Tag dot>{info.getValue()}</Tag> }),
|
|
172
|
+
column.accessor("duration", { header: "Duration", meta: { numeric: true } }),
|
|
173
|
+
]);
|
|
174
|
+
|
|
175
|
+
<DataTable columns={columns} data={deploys} getRowId={(deploy) => deploy.id} label="Deploys" />;
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
The props you'll reach for: `columns`, `data`, `label` (and `getRowId` for a stable selection). Define `columns` at module scope (or in `useMemo`) and keep `data` stable; a new array each render recomputes every model.
|
|
179
|
+
|
|
180
|
+
## When to use
|
|
181
|
+
|
|
182
|
+
- Lists people search, sort, select and act on: deploys, orders, files, members.
|
|
183
|
+
- `size="sm"` on admin and dashboard screens — rows and every control drop to 30px together.
|
|
184
|
+
- Under ~10 rows with nothing to sort or search, a plain `Table`.
|
|
185
|
+
- `groupBy` when people work through rows one set at a time — failed deploys first, then queued.
|
|
186
|
+
- Thousands of rows need nothing extra (see Large).
|
|
187
|
+
- For the same data over time, pair it with a `Chart`.
|
|
188
|
+
|
|
189
|
+
## Examples
|
|
190
|
+
|
|
191
|
+
### Plain
|
|
192
|
+
|
|
193
|
+
`variant="plain"` keeps every feature and drops the card, for a grid that is part of the page. Rules run edge to edge; toolbar and pager line up with the cell text.
|
|
194
|
+
|
|
195
|
+
```tsx
|
|
196
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
197
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
198
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
199
|
+
import * as React from "react";
|
|
200
|
+
|
|
201
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, deploys, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
202
|
+
|
|
203
|
+
export function Plain() {
|
|
204
|
+
return (
|
|
205
|
+
<DataTable
|
|
206
|
+
variant="plain"
|
|
207
|
+
columns={columns}
|
|
208
|
+
data={deploys}
|
|
209
|
+
getRowId={(deploy) => deploy.id}
|
|
210
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
211
|
+
initialColumnVisibility={{ id: false }}
|
|
212
|
+
searchPlaceholder="Search deploys…"
|
|
213
|
+
label="Deploys without the card"
|
|
214
|
+
/>
|
|
215
|
+
);
|
|
216
|
+
}
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Dense
|
|
220
|
+
|
|
221
|
+
`size="sm"`: 30px rows and controls. `searchKey` searches one column; `toolbar` adds a secondary action. Short of room, "Columns" and any toolbar button marked `collapsible` fold to their icons, the last first; the label stays the accessible name.
|
|
222
|
+
|
|
223
|
+
```tsx
|
|
224
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
225
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
226
|
+
import { DownloadIcon, EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
227
|
+
import * as React from "react";
|
|
228
|
+
|
|
229
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, deploys, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
230
|
+
|
|
231
|
+
export function Dense() {
|
|
232
|
+
return (
|
|
233
|
+
<DataTable
|
|
234
|
+
size="sm"
|
|
235
|
+
columns={columns}
|
|
236
|
+
data={deploys}
|
|
237
|
+
getRowId={(deploy) => deploy.id}
|
|
238
|
+
searchKey="project"
|
|
239
|
+
searchPlaceholder="Filter projects…"
|
|
240
|
+
pageSize={20}
|
|
241
|
+
label="Deploys, dense"
|
|
242
|
+
toolbar={
|
|
243
|
+
<Button variant="secondary" size="sm" collapsible>
|
|
244
|
+
<DownloadIcon />
|
|
245
|
+
Export
|
|
246
|
+
</Button>
|
|
247
|
+
}
|
|
248
|
+
/>
|
|
249
|
+
);
|
|
250
|
+
}
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### Selection
|
|
254
|
+
|
|
255
|
+
`onRowSelectionChange` adds the checkbox column and receives the selected rows. The header checkbox selects the page; selection survives paging.
|
|
256
|
+
|
|
257
|
+
```tsx
|
|
258
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
259
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
260
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
261
|
+
import * as React from "react";
|
|
262
|
+
|
|
263
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, deploys, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
264
|
+
|
|
265
|
+
export function Selection() {
|
|
266
|
+
const [selected, setSelected] = React.useState<Deploy[]>([]);
|
|
267
|
+
return (
|
|
268
|
+
<div className="flex w-full min-w-0 flex-col gap-3">
|
|
269
|
+
<DataTable
|
|
270
|
+
columns={columns}
|
|
271
|
+
data={deploys}
|
|
272
|
+
getRowId={(deploy) => deploy.id}
|
|
273
|
+
onRowSelectionChange={setSelected}
|
|
274
|
+
columnToggle={false}
|
|
275
|
+
label="Select deploys"
|
|
276
|
+
/>
|
|
277
|
+
<p className="m-0 font-mono text-xs text-muted-foreground">
|
|
278
|
+
{selected.length ? `Selected: ${selected.map((deploy) => deploy.id).join(", ")}` : "Nothing selected"}
|
|
279
|
+
</p>
|
|
280
|
+
</div>
|
|
281
|
+
);
|
|
282
|
+
}
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Grouped
|
|
286
|
+
|
|
287
|
+
`groupBy` renders each group as a `TableGroup`: a collapsible header with the column's own cell for the value (here the status `Tag`), a mono row count and an optional `groupSummary`. Sorting and search apply inside groups. The grouping column starts hidden (the Columns menu shows it). Grouped tables show every row, so the pager becomes a count. `stickyGroupHeaders` with a height on `containerProps` keeps the current group's header in view.
|
|
288
|
+
|
|
289
|
+
```tsx
|
|
290
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
291
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
292
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
293
|
+
import * as React from "react";
|
|
294
|
+
|
|
295
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, deploys, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
296
|
+
|
|
297
|
+
export function Grouped() {
|
|
298
|
+
return (
|
|
299
|
+
<DataTable
|
|
300
|
+
columns={columns}
|
|
301
|
+
data={deploys}
|
|
302
|
+
getRowId={(deploy) => deploy.id}
|
|
303
|
+
groupBy="status"
|
|
304
|
+
groupSummary={({ rows }) =>
|
|
305
|
+
`${formatDuration(rows.reduce((sum, deploy) => sum + deploy.duration, 0))} total`
|
|
306
|
+
}
|
|
307
|
+
stickyGroupHeaders
|
|
308
|
+
containerProps={{ className: "max-h-[40rem]" }}
|
|
309
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
310
|
+
searchPlaceholder="Search deploys…"
|
|
311
|
+
label="Deploys by status"
|
|
312
|
+
/>
|
|
313
|
+
);
|
|
314
|
+
}
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
### Fit to the container
|
|
318
|
+
|
|
319
|
+
`fit` is the `Table` fit mode. With `meta.priority`, `meta.inline`, `meta.minWidth` and `meta.width`, columns step out, or move inline after the title, as the container narrows. The title is the first data column, or the one with `meta.title`. See [Table](./table.md) for how the fit is worked out.
|
|
320
|
+
|
|
321
|
+
```tsx
|
|
322
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
323
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
324
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
325
|
+
import * as React from "react";
|
|
326
|
+
|
|
327
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, deploys, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* The same deploys fitted to the container: as it narrows, the duration steps out first, then
|
|
331
|
+
* the deploy ID moves inline after the project, then the start time steps out. Status always
|
|
332
|
+
* stays.
|
|
333
|
+
*/
|
|
334
|
+
const fitColumns = column.columns([
|
|
335
|
+
column.accessor("project", { header: "Project" }),
|
|
336
|
+
column.accessor("id", {
|
|
337
|
+
header: "Deploy ID",
|
|
338
|
+
meta: { numeric: true, priority: 2, inline: true },
|
|
339
|
+
cell: (info) => <span className="text-12 text-muted-foreground">{info.getValue()}</span>,
|
|
340
|
+
}),
|
|
341
|
+
column.accessor("status", {
|
|
342
|
+
header: "Status",
|
|
343
|
+
cell: (info) => {
|
|
344
|
+
const status = info.getValue();
|
|
345
|
+
return (
|
|
346
|
+
<Tag dot {...statusTag[status]}>
|
|
347
|
+
{status}
|
|
348
|
+
</Tag>
|
|
349
|
+
);
|
|
350
|
+
},
|
|
351
|
+
}),
|
|
352
|
+
column.accessor("duration", {
|
|
353
|
+
header: "Duration",
|
|
354
|
+
meta: { numeric: true, priority: 1 },
|
|
355
|
+
enableGlobalFilter: false,
|
|
356
|
+
cell: (info) => formatDuration(info.getValue()),
|
|
357
|
+
}),
|
|
358
|
+
column.accessor("started", {
|
|
359
|
+
header: "Started",
|
|
360
|
+
meta: { numeric: true, priority: 3 },
|
|
361
|
+
cell: (info) => formatStarted(info.getValue()),
|
|
362
|
+
}),
|
|
363
|
+
]);
|
|
364
|
+
|
|
365
|
+
export function Fit() {
|
|
366
|
+
return (
|
|
367
|
+
<DataTable
|
|
368
|
+
fit
|
|
369
|
+
columns={fitColumns}
|
|
370
|
+
data={deploys}
|
|
371
|
+
getRowId={(deploy) => deploy.id}
|
|
372
|
+
onRowSelectionChange={() => {}}
|
|
373
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
374
|
+
searchPlaceholder="Search deploys…"
|
|
375
|
+
label="Deploys, fitted to the container"
|
|
376
|
+
/>
|
|
377
|
+
);
|
|
378
|
+
}
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
### Large
|
|
382
|
+
|
|
383
|
+
2,000 deploys, grouped. Only the rows in view render — on by itself when more than 100 rows could show at once; `virtualized` overrides it. Selection, sorting and search still cover every row ("Select all rows" selects all 2,000). Rows scroll with the card when it has a height, or with the page. See [Table](./table.md) for the virtual body.
|
|
384
|
+
|
|
385
|
+
From 20,000 rows, search waits a quarter second for typing to pause. From 50,000 rows (not grouped), the table sorts, searches and pages itself and TanStack builds only the rows drawn: a million rows appear and sort in about a second each, in a sixth of the memory. A grouped table that size still uses TanStack's grouped rows: seconds, and a gigabyte at a million.
|
|
386
|
+
|
|
387
|
+
```tsx
|
|
388
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
389
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
390
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
391
|
+
import * as React from "react";
|
|
392
|
+
|
|
393
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
394
|
+
|
|
395
|
+
/** 2,000 deploys, one every 17 minutes going back from 5 October, for the Large demo. */
|
|
396
|
+
const manyDeploys: Deploy[] = Array.from({ length: 2000 }, (_, i) => ({
|
|
397
|
+
id: `DEP-${String(9000 - i).padStart(4, "0")}`,
|
|
398
|
+
project: projects[(i * 7 + Math.floor(i / 11)) % projects.length]!,
|
|
399
|
+
status: statuses[(i * 3 + Math.floor(i / 7)) % statuses.length]!,
|
|
400
|
+
duration: 4 + ((i * 37) % 290),
|
|
401
|
+
started: new Date(Date.UTC(2026, 9, 5, 23, 40) - i * 17 * 60_000).toISOString().slice(0, 19),
|
|
402
|
+
}));
|
|
403
|
+
|
|
404
|
+
export function Large() {
|
|
405
|
+
return (
|
|
406
|
+
<DataTable
|
|
407
|
+
columns={columns}
|
|
408
|
+
data={manyDeploys}
|
|
409
|
+
getRowId={(deploy) => deploy.id}
|
|
410
|
+
groupBy="status"
|
|
411
|
+
onRowSelectionChange={() => {}}
|
|
412
|
+
stickyGroupHeaders
|
|
413
|
+
containerProps={{ className: "max-h-[40rem]" }}
|
|
414
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
415
|
+
searchPlaceholder="Search deploys…"
|
|
416
|
+
label="Deploys of the last month"
|
|
417
|
+
/>
|
|
418
|
+
);
|
|
419
|
+
}
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
### From a server
|
|
423
|
+
|
|
424
|
+
```tsx
|
|
425
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
426
|
+
import { DataTable, createDataTableColumnHelper, type DataTableQuery } from "@zonsh/ui/data-table";
|
|
427
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
428
|
+
import * as React from "react";
|
|
429
|
+
|
|
430
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
431
|
+
|
|
432
|
+
/*
|
|
433
|
+
* A stand-in for an API: 5,000 deploys, sorted and searched "on the server", answering after
|
|
434
|
+
* 300ms. Yours would be a fetch: `fetch(`/api/deploys?${params}`, { signal })`.
|
|
435
|
+
*/
|
|
436
|
+
const serverDeploys: Deploy[] = Array.from({ length: 5000 }, (_, i) => ({
|
|
437
|
+
id: `DEP-${String(15000 - i).padStart(5, "0")}`,
|
|
438
|
+
project: projects[(i * 7 + Math.floor(i / 13)) % projects.length]!,
|
|
439
|
+
status: statuses[(i * 5 + Math.floor(i / 3)) % statuses.length]!,
|
|
440
|
+
duration: 4 + ((i * 53) % 290),
|
|
441
|
+
started: new Date(Date.UTC(2026, 9, 5, 23, 40) - i * 9 * 60_000).toISOString().slice(0, 19),
|
|
442
|
+
}));
|
|
443
|
+
|
|
444
|
+
async function fetchDeploys({ start, end, sorting, search, signal }: DataTableQuery) {
|
|
445
|
+
await new Promise((resolve, reject) => {
|
|
446
|
+
const timer = setTimeout(resolve, 300);
|
|
447
|
+
signal.addEventListener("abort", () => {
|
|
448
|
+
clearTimeout(timer);
|
|
449
|
+
reject(signal.reason);
|
|
450
|
+
});
|
|
451
|
+
});
|
|
452
|
+
const q = search.toLowerCase();
|
|
453
|
+
const rows = q
|
|
454
|
+
? serverDeploys.filter((d) => `${d.id} ${d.project} ${d.status}`.toLowerCase().includes(q))
|
|
455
|
+
: [...serverDeploys];
|
|
456
|
+
for (const { id, desc } of [...sorting].reverse()) {
|
|
457
|
+
const key = id as keyof Deploy;
|
|
458
|
+
rows.sort((a, b) => (a[key] < b[key] ? -1 : a[key] > b[key] ? 1 : 0) * (desc ? -1 : 1));
|
|
459
|
+
}
|
|
460
|
+
return { rows: rows.slice(start, end), total: rows.length };
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
export function Server() {
|
|
464
|
+
return (
|
|
465
|
+
<DataTable
|
|
466
|
+
columns={columns}
|
|
467
|
+
fetchRows={fetchDeploys}
|
|
468
|
+
getRowId={(deploy) => deploy.id}
|
|
469
|
+
onRowSelectionChange={() => {}}
|
|
470
|
+
pageSize={10_000}
|
|
471
|
+
pageSizeOptions={[]}
|
|
472
|
+
containerProps={{ className: "max-h-[30rem]" }}
|
|
473
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
474
|
+
searchPlaceholder="Search deploys…"
|
|
475
|
+
label="Deploys from the server"
|
|
476
|
+
/>
|
|
477
|
+
);
|
|
478
|
+
}
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
Pass `fetchRows` in place of `data`. The table asks for the rows it is about to show — a page, or runs of 100 as a virtual table scrolls — with the sorting and search, and you return them with the total. Loading rows show as placeholders; a new sort or search aborts the last request (`signal`). Use `getRowId` so a selection survives a new sort. There is no "Select all" with `fetchRows`.
|
|
482
|
+
|
|
483
|
+
```tsx
|
|
484
|
+
<DataTable
|
|
485
|
+
columns={columns}
|
|
486
|
+
getRowId={(deploy) => deploy.id}
|
|
487
|
+
fetchRows={async ({ start, end, sorting, search, signal }) => {
|
|
488
|
+
const params = new URLSearchParams({ start: `${start}`, end: `${end}`, search, sort: JSON.stringify(sorting) });
|
|
489
|
+
const response = await fetch(`/api/deploys?${params}`, { signal });
|
|
490
|
+
return response.json(); // { rows, total }
|
|
491
|
+
}}
|
|
492
|
+
/>
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
### Server error
|
|
496
|
+
|
|
497
|
+
When `fetchRows` rejects, the table shows `labels.loadError` and a "Try again" (`labels.retry`) — in the body if nothing has loaded, in the footer (keeping the rows) otherwise — announced politely. Say what to do in `loadError`: "Check your connection."
|
|
498
|
+
|
|
499
|
+
```tsx
|
|
500
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
501
|
+
import { DataTable, createDataTableColumnHelper, type DataTableQuery } from "@zonsh/ui/data-table";
|
|
502
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
503
|
+
import * as React from "react";
|
|
504
|
+
|
|
505
|
+
// DeployStatus, statusTag, Deploy, projects, statuses, formatDuration, formatStarted, column, columns, serverDeploys, fetchDeploys: as in the first example on this page that uses them.
|
|
506
|
+
|
|
507
|
+
/** Waits as a request would, and stops when the table aborts it. */
|
|
508
|
+
function latency(ms: number, signal: AbortSignal) {
|
|
509
|
+
return new Promise<void>((resolve, reject) => {
|
|
510
|
+
const timer = setTimeout(resolve, ms);
|
|
511
|
+
signal.addEventListener("abort", () => {
|
|
512
|
+
clearTimeout(timer);
|
|
513
|
+
reject(signal.reason);
|
|
514
|
+
});
|
|
515
|
+
});
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* The first request fails, as one does when the network drops: the table says it couldn't load
|
|
520
|
+
* the rows and offers to try again, and the second attempt goes through.
|
|
521
|
+
*/
|
|
522
|
+
export function ServerError() {
|
|
523
|
+
const failed = React.useRef(false);
|
|
524
|
+
const fetchRows = React.useCallback(async (query: DataTableQuery) => {
|
|
525
|
+
await latency(300, query.signal);
|
|
526
|
+
if (!failed.current) {
|
|
527
|
+
failed.current = true;
|
|
528
|
+
throw new Error("The server did not answer.");
|
|
529
|
+
}
|
|
530
|
+
return fetchDeploys(query);
|
|
531
|
+
}, []);
|
|
532
|
+
return (
|
|
533
|
+
<DataTable
|
|
534
|
+
columns={columns}
|
|
535
|
+
fetchRows={fetchRows}
|
|
536
|
+
getRowId={(deploy) => deploy.id}
|
|
537
|
+
pageSize={10}
|
|
538
|
+
initialSorting={[{ id: "started", desc: true }]}
|
|
539
|
+
searchPlaceholder="Search deploys…"
|
|
540
|
+
labels={{ loadError: "Couldn't load the deploys. Check your connection." }}
|
|
541
|
+
label="Deploys from the server, after an error"
|
|
542
|
+
/>
|
|
543
|
+
);
|
|
544
|
+
}
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### Empty
|
|
548
|
+
|
|
549
|
+
One full-width row says nothing matches. Write an explanation, not "No data".
|
|
550
|
+
|
|
551
|
+
```tsx
|
|
552
|
+
import { Button, Menu, MenuContent, MenuItem, MenuSeparator, MenuTrigger, Tag } from "@zonsh/ui";
|
|
553
|
+
import { DataTable, createDataTableColumnHelper } from "@zonsh/ui/data-table";
|
|
554
|
+
import { EllipsisIcon, FileTextIcon, RotateCwIcon, Undo2Icon } from "lucide-react";
|
|
555
|
+
import * as React from "react";
|
|
556
|
+
|
|
557
|
+
// DeployStatus, statusTag, Deploy, formatDuration, formatStarted, column, columns: as in the first example on this page that uses them.
|
|
558
|
+
|
|
559
|
+
const noDeploys: Deploy[] = [];
|
|
560
|
+
|
|
561
|
+
export function Empty() {
|
|
562
|
+
return (
|
|
563
|
+
<DataTable
|
|
564
|
+
columns={columns}
|
|
565
|
+
data={noDeploys}
|
|
566
|
+
emptyMessage="No deploys yet. Deploys appear here once you push to a connected branch."
|
|
567
|
+
label="Deploys (empty)"
|
|
568
|
+
/>
|
|
569
|
+
);
|
|
570
|
+
}
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
### TanStack Table v8, or your own
|
|
574
|
+
|
|
575
|
+
`DataTable` needs `@tanstack/react-table` **^9** and doesn't run on v8. An app on v8 — as most shadcn data tables are — keeps its own logic and renders with the `Table` parts, which work with any library or none. What `DataTable` draws:
|
|
576
|
+
|
|
577
|
+
- **Selection:** a `Checkbox` column, the header one `indeterminate` while some rows are selected, and `data-selected` on the selected `TableRow` (or `aria-selected` in a `role="grid"` table). The row takes the selected fill.
|
|
578
|
+
- **Sorting:** `aria-sort` on the `TableHead`, and a small button inside it in the eyebrow's mono type, with an arrow for the direction.
|
|
579
|
+
|
|
580
|
+
```tsx
|
|
581
|
+
import { Checkbox, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from "@zonsh/ui";
|
|
582
|
+
import { flexRender, getCoreRowModel, getSortedRowModel, useReactTable, type ColumnDef, type SortingState } from "@tanstack/react-table"; // v8
|
|
583
|
+
import { ArrowDownIcon, ArrowUpIcon, ChevronsUpDownIcon } from "lucide-react";
|
|
584
|
+
|
|
585
|
+
type Task = { id: string; title: string; status: string };
|
|
586
|
+
|
|
587
|
+
const columns: ColumnDef<Task>[] = [
|
|
588
|
+
{
|
|
589
|
+
id: "select",
|
|
590
|
+
header: ({ table }) => (
|
|
591
|
+
<Checkbox
|
|
592
|
+
aria-label="Select all"
|
|
593
|
+
checked={table.getIsAllPageRowsSelected()}
|
|
594
|
+
indeterminate={table.getIsSomePageRowsSelected()}
|
|
595
|
+
onCheckedChange={(on) => table.toggleAllPageRowsSelected(on)}
|
|
596
|
+
/>
|
|
597
|
+
),
|
|
598
|
+
cell: ({ row }) => (
|
|
599
|
+
<Checkbox aria-label={`Select ${row.original.title}`} checked={row.getIsSelected()} onCheckedChange={(on) => row.toggleSelected(on)} />
|
|
600
|
+
),
|
|
601
|
+
enableSorting: false,
|
|
602
|
+
},
|
|
603
|
+
{ accessorKey: "title", header: "Title" },
|
|
604
|
+
{ accessorKey: "status", header: "Status" },
|
|
605
|
+
];
|
|
606
|
+
|
|
607
|
+
function SortButton({ label, sorted, onClick }: { label: React.ReactNode; sorted: false | "asc" | "desc"; onClick: (e: unknown) => void }) {
|
|
608
|
+
const Icon = sorted === "asc" ? ArrowUpIcon : sorted === "desc" ? ArrowDownIcon : ChevronsUpDownIcon;
|
|
609
|
+
return (
|
|
610
|
+
<button
|
|
611
|
+
type="button"
|
|
612
|
+
onClick={onClick}
|
|
613
|
+
className="-ms-2 inline-flex min-h-(--control-h-sm) cursor-pointer items-center gap-1.5 rounded-item material-row px-2 font-mono text-[12px] tracking-[0.18em] uppercase focus-ring"
|
|
614
|
+
>
|
|
615
|
+
<span className={sorted ? "text-foreground" : "text-muted-foreground"}>{label}</span>
|
|
616
|
+
<Icon aria-hidden className={sorted ? "size-3.5" : "size-3.5 opacity-60"} />
|
|
617
|
+
</button>
|
|
618
|
+
);
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
export function Tasks({ data }: { data: Task[] }) {
|
|
622
|
+
const [sorting, setSorting] = React.useState<SortingState>([]);
|
|
623
|
+
const [rowSelection, setRowSelection] = React.useState({});
|
|
624
|
+
const table = useReactTable({
|
|
625
|
+
data,
|
|
626
|
+
columns,
|
|
627
|
+
state: { sorting, rowSelection },
|
|
628
|
+
getRowId: (task) => task.id,
|
|
629
|
+
onSortingChange: setSorting,
|
|
630
|
+
onRowSelectionChange: setRowSelection,
|
|
631
|
+
getCoreRowModel: getCoreRowModel(),
|
|
632
|
+
getSortedRowModel: getSortedRowModel(),
|
|
633
|
+
});
|
|
634
|
+
|
|
635
|
+
return (
|
|
636
|
+
<Table aria-label="Tasks">
|
|
637
|
+
<TableHeader>
|
|
638
|
+
{table.getHeaderGroups().map((group) => (
|
|
639
|
+
<TableRow key={group.id}>
|
|
640
|
+
{group.headers.map((header) => {
|
|
641
|
+
const sorted = header.column.getIsSorted();
|
|
642
|
+
const label = flexRender(header.column.columnDef.header, header.getContext());
|
|
643
|
+
return (
|
|
644
|
+
<TableHead
|
|
645
|
+
key={header.id}
|
|
646
|
+
aria-sort={sorted === "asc" ? "ascending" : sorted === "desc" ? "descending" : undefined}
|
|
647
|
+
className={header.column.id === "select" ? "w-12" : undefined}
|
|
648
|
+
>
|
|
649
|
+
{header.column.getCanSort() ? (
|
|
650
|
+
<SortButton label={label} sorted={sorted} onClick={header.column.getToggleSortingHandler()!} />
|
|
651
|
+
) : (
|
|
652
|
+
label
|
|
653
|
+
)}
|
|
654
|
+
</TableHead>
|
|
655
|
+
);
|
|
656
|
+
})}
|
|
657
|
+
</TableRow>
|
|
658
|
+
))}
|
|
659
|
+
</TableHeader>
|
|
660
|
+
<TableBody>
|
|
661
|
+
{table.getRowModel().rows.map((row) => (
|
|
662
|
+
<TableRow key={row.id} data-selected={row.getIsSelected() || undefined}>
|
|
663
|
+
{row.getVisibleCells().map((cell) => (
|
|
664
|
+
<TableCell key={cell.id}>{flexRender(cell.column.columnDef.cell, cell.getContext())}</TableCell>
|
|
665
|
+
))}
|
|
666
|
+
</TableRow>
|
|
667
|
+
))}
|
|
668
|
+
</TableBody>
|
|
669
|
+
</Table>
|
|
670
|
+
);
|
|
671
|
+
}
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
For a pager, use `Pagination`; for search, an `InputGroup` with a search icon; for the columns menu, a `Menu` of `MenuCheckboxItem`s.
|
|
675
|
+
|
|
676
|
+
## Columns
|
|
677
|
+
|
|
678
|
+
Build columns with `createDataTableColumnHelper<Row>()`:
|
|
679
|
+
|
|
680
|
+
- `column.accessor("key", { header, cell, meta })` — a data column, sortable and searchable by default.
|
|
681
|
+
- `column.display({ id, header, cell })` — a column with no value, such as row actions (a `Menu` on a `ghost` `icon-sm` button). Never sorts.
|
|
682
|
+
- `column.columns([...])` — wraps the array so each column keeps its value type.
|
|
683
|
+
|
|
684
|
+
`cell` receives `{ row, getValue }`; `row.original` is your object. Per column, set `enableSorting: false`, `enableHiding: false` or `enableGlobalFilter: false`. `meta` takes:
|
|
685
|
+
|
|
686
|
+
| Key | Type | Purpose |
|
|
687
|
+
| ----------- | ------------------ | --------------------------------------------------------------------------------------------------------------- |
|
|
688
|
+
| `numeric` | `boolean` | mono, tabular, right-aligned header and cells |
|
|
689
|
+
| `label` | `string` | the name in the "Columns" menu when `header` is not a string |
|
|
690
|
+
| `className` | `string` | extra classes on the column's cells (`w-0` for an actions column; not with `fit`, whose tracks size themselves) |
|
|
691
|
+
| `align` | `"start" \| "end"` | `end` right-aligns without mono: people, dates |
|
|
692
|
+
| `priority` | `number` | with `fit`: lower steps out first; without one, never |
|
|
693
|
+
| `inline` | `boolean` | with `fit`: step out to after the title instead of hiding |
|
|
694
|
+
| `minWidth` | `number` | with `fit`: step out below this container width (rem) |
|
|
695
|
+
| `width` | `string` | the column's width; with `fit`, its grid track |
|
|
696
|
+
| `title` | `boolean` | with `fit`: the column that names each row |
|
|
697
|
+
|
|
698
|
+
`getGroupingValue` on a column groups by something other than its value (a month from a date). `DataTableColumnDef<Row>`, `DataTableRow<Row>` and `DataTableCellContext<Row, Value>` are exported for columns written without the helper. `dataTableFeatures` is the TanStack feature set the table registers.
|
|
699
|
+
|
|
700
|
+
## Props
|
|
701
|
+
|
|
702
|
+
| Prop | Type | Default |
|
|
703
|
+
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
|
|
704
|
+
| `columns` | column definitions | — |
|
|
705
|
+
| `data` | `TData[]` | — |
|
|
706
|
+
| `fetchRows` | `({ start, end, sorting, search, searchKey, signal }) => Promise<{ rows, total }>` — rows from a server, in place of `data`; not with `groupBy` | — |
|
|
707
|
+
| `getRowId` | `(row, index) => string` | the index |
|
|
708
|
+
| `searchKey` | column id to search | every column |
|
|
709
|
+
| `searchPlaceholder` | `string` | `"Search…"` |
|
|
710
|
+
| `searchable` | `boolean` | `true` |
|
|
711
|
+
| `pageSize` | `number` | `10` |
|
|
712
|
+
| `pageSizeOptions` | `number[]` — `[]` hides the select | `[10, 20, 50]` |
|
|
713
|
+
| `selectable` | `boolean` | with `onRowSelectionChange` |
|
|
714
|
+
| `onRowSelectionChange` | `(rows: TData[]) => void` | — |
|
|
715
|
+
| `columnToggle` | `boolean` | `true` |
|
|
716
|
+
| `size` | `"sm" \| "default"` — `sm`: 30px rows and controls | `"default"` |
|
|
717
|
+
| `variant` | `"card" \| "plain"` — `plain` drops the card | `"card"` |
|
|
718
|
+
| `fit` | `boolean` — fit the columns to the container | `false` |
|
|
719
|
+
| `initialSorting` | `[{ id, desc }]` | `[]` |
|
|
720
|
+
| `locale` | `string` — the order text sorts in | the Unicode collation order |
|
|
721
|
+
| `initialColumnVisibility` | `{ [id]: false }` | `{}` |
|
|
722
|
+
| `emptyMessage` | `ReactNode` | `"No results."` |
|
|
723
|
+
| `labels` | `Partial<DataTableMessages>` | English |
|
|
724
|
+
| `toolbar` | `ReactNode` — extra toolbar controls | — |
|
|
725
|
+
| `caption` | `ReactNode` — visible description | — |
|
|
726
|
+
| `label` | `string` — accessible name | — |
|
|
727
|
+
| `groupBy` | column id to group by | — |
|
|
728
|
+
| `groupSummary` | `({ value, rows }) => ReactNode` | — |
|
|
729
|
+
| `stickyGroupHeaders` | `boolean` | `false` |
|
|
730
|
+
| `containerProps` | props for the table's scrolling card | — |
|
|
731
|
+
| `virtualized` | `boolean` — render only the rows in view | above 100 rows |
|
|
732
|
+
|
|
733
|
+
Other props go to the wrapping `div`. Sorting cycles ascending → descending → off; Shift-click sorts by several columns. Text sorts in Unicode collation order, the same everywhere: accents with their base letter, lower case before upper, numbers in text by value ("item2" before "item10"); `locale="sv"` uses Swedish order instead. Dates sort by time, numbers by value, and empty cells (`null`, `undefined`, `NaN`, `""`) as one block below every value. A column's `sortFn` replaces all of that.
|
|
734
|
+
|
|
735
|
+
A virtual table can't be searched with find-in-page or printed beyond the rows in view; its own search finds every row.
|
|
736
|
+
|
|
737
|
+
`labels` (`Partial<DataTableMessages>`) renames the table's words: `search`, `columns`, `showColumns`, `selectAll`, `selectPage`, `selectRow`, `empty`, `loadError`, `retry`, `rowsPerPage`, `previous`, `next`, and the counts `selected(count, total)`, `groupCount(rows, groups)` and `range(first, last, total)`. A `LocaleProvider` sets them for every table (`messages.dataTable`), and its `locale` is the default sorting `locale`.
|
|
738
|
+
|
|
739
|
+
## Brand rules
|
|
740
|
+
|
|
741
|
+
- **Do** mark numbers, durations, dates and IDs `numeric` so they align digit for digit.
|
|
742
|
+
- **Do** show status with a `Tag` in its status colour: `success` done, `info` running, `warning` waiting, `destructive` failed. A state neither good nor bad (cancelled, skipped) stays monochrome, as `muted`.
|
|
743
|
+
- **Do** colour a signed figure by its sign: `text-success` above zero, `text-destructive` below, the ink at zero. Keep the sign in the text, so colour only repeats it.
|
|
744
|
+
- **Do** put row actions in a `Menu` behind a `ghost` icon button at the end of the row.
|
|
745
|
+
- **Do** use `variant="plain"` inside a `Card` or any other card surface, such as a `Dialog` or `Drawer`. A card table in a card doubles the edge and the shadow.
|
|
746
|
+
- **Don't** add a primary button to the toolbar unless it is the view's one primary action.
|
|
747
|
+
- **Don't** mix heights: with `size="sm"`, every control around the table is 30px too.
|
|
748
|
+
- **Don't** colour whole rows, add zebra stripes or vertical rules; colour stays on the status and the figure.
|
|
749
|
+
|
|
750
|
+
## Accessibility
|
|
751
|
+
|
|
752
|
+
- Name the table with `label` (or a visible `caption`).
|
|
753
|
+
- Sortable headers are real buttons; the header cell carries `aria-sort` while sorted.
|
|
754
|
+
- The search field has a visually hidden label taken from its placeholder.
|
|
755
|
+
- Row checkboxes are labelled "Select row", the header checkbox "Select all rows on this page"; give action buttons a label that names the row.
|
|
756
|
+
- Selection and page counts are announced politely as they change.
|
|
757
|
+
- Group headers are `<th scope="rowgroup">` cells with a real button (`aria-expanded`); while grouped, the header checkbox selects every row.
|
|
758
|
+
- A virtual table carries `aria-rowcount` and each rendered row its `aria-rowindex`, so screen readers announce the real row count and position; Tab moves on through the rows, rendering them as focus scrolls them into view.
|
|
759
|
+
|
|
760
|
+
### Keyboard
|
|
761
|
+
|
|
762
|
+
| Key | What it does |
|
|
763
|
+
| ------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
764
|
+
| Tab | Moves through the search field, Columns, the sortable headers, the checkboxes, the cells' controls and the pager |
|
|
765
|
+
| Enter / Space | Sorts by the focused header; pressed again, sorts the other way, then clears the sort |
|
|
766
|
+
| Enter / Space | Opens or closes the focused row group; on the previous or next page button, turns the page |
|
|
767
|
+
| Space | Ticks or clears the focused checkbox: one row, or on the header, every row on the page |
|
|
768
|
+
| Shift+Enter / Shift+Space | Adds the focused header to the sort, after the columns already sorted, as Shift-click does |
|
|
769
|
+
| Shift+Space | Ticks or clears the rows from the last checkbox ticked to the focused one, as Shift-click does |
|
|
770
|
+
|
|
771
|
+
Columns opens a `Menu`, with its keys. The checkboxes take Space only, as checkboxes do.
|
|
772
|
+
|
|
773
|
+
---
|
|
774
|
+
|
|
775
|
+
- Import: `import { DataTable, createDataTableColumnHelper, dataTableFeatures } from "@zonsh/ui/data-table"`
|
|
776
|
+
- Source: `packages/ui/src/components/data-table.tsx`
|