@bridgebrew/ui 0.0.0-stage → 0.1.10-next.79
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/LICENSE +21 -0
- package/README.md +39 -2
- package/SOURCE.md +182 -0
- package/dist/build.js +871 -0
- package/dist/theme-css.js +896 -0
- package/dist/themes.js +69 -0
- package/dist/types/build/stylesheet.d.ts +31 -0
- package/dist/types/components/composite/command/command.d.ts +94 -0
- package/dist/types/components/composite/command/index.d.ts +2 -0
- package/dist/types/components/composite/draft-bar/draft-bar.d.ts +12 -0
- package/dist/types/components/composite/draft-bar/index.d.ts +2 -0
- package/dist/types/components/composite/image-field/image-field.d.ts +33 -0
- package/dist/types/components/composite/image-field/index.d.ts +2 -0
- package/dist/types/components/composite/list/index.d.ts +3 -0
- package/dist/types/components/composite/list/list-swipe.d.ts +28 -0
- package/dist/types/components/composite/list/list.d.ts +95 -0
- package/dist/types/components/composite/picker/index.d.ts +2 -0
- package/dist/types/components/composite/picker/picker.d.ts +44 -0
- package/dist/types/components/composite/prompt-field/index.d.ts +2 -0
- package/dist/types/components/composite/prompt-field/prompt-field.d.ts +18 -0
- package/dist/types/components/composite/properties/index.d.ts +2 -0
- package/dist/types/components/composite/properties/properties.d.ts +24 -0
- package/dist/types/components/composite/snooze-menu/index.d.ts +4 -0
- package/dist/types/components/composite/snooze-menu/presets.d.ts +36 -0
- package/dist/types/components/composite/snooze-menu/snooze-menu.d.ts +27 -0
- package/dist/types/components/composite/tag-input/index.d.ts +2 -0
- package/dist/types/components/composite/tag-input/tag-input.d.ts +22 -0
- package/dist/types/components/composite/wizard/index.d.ts +2 -0
- package/dist/types/components/composite/wizard/wizard.d.ts +53 -0
- package/dist/types/components/core/avatar/avatar.d.ts +16 -0
- package/dist/types/components/core/avatar/index.d.ts +2 -0
- package/dist/types/components/core/badge/badge.d.ts +8 -0
- package/dist/types/components/core/badge/index.d.ts +2 -0
- package/dist/types/components/core/breadcrumb/breadcrumb.d.ts +21 -0
- package/dist/types/components/core/breadcrumb/index.d.ts +2 -0
- package/dist/types/components/core/bullets/bullets.d.ts +15 -0
- package/dist/types/components/core/bullets/index.d.ts +2 -0
- package/dist/types/components/core/button/button.d.ts +14 -0
- package/dist/types/components/core/button/index.d.ts +2 -0
- package/dist/types/components/core/card/card.d.ts +16 -0
- package/dist/types/components/core/card/index.d.ts +2 -0
- package/dist/types/components/core/checkbox/checkbox.d.ts +15 -0
- package/dist/types/components/core/checkbox/index.d.ts +2 -0
- package/dist/types/components/core/cluster/cluster.d.ts +5 -0
- package/dist/types/components/core/cluster/index.d.ts +1 -0
- package/dist/types/components/core/code-block/code-block.d.ts +18 -0
- package/dist/types/components/core/code-block/index.d.ts +2 -0
- package/dist/types/components/core/collapsible/collapsible.d.ts +8 -0
- package/dist/types/components/core/collapsible/index.d.ts +1 -0
- package/dist/types/components/core/colour-picker/colour-picker.d.ts +25 -0
- package/dist/types/components/core/colour-picker/index.d.ts +4 -0
- package/dist/types/components/core/combobox/combobox.d.ts +63 -0
- package/dist/types/components/core/combobox/index.d.ts +2 -0
- package/dist/types/components/core/detail/detail.d.ts +12 -0
- package/dist/types/components/core/detail/index.d.ts +1 -0
- package/dist/types/components/core/dialog/dialog.d.ts +43 -0
- package/dist/types/components/core/dialog/drag.d.ts +4 -0
- package/dist/types/components/core/dialog/index.d.ts +2 -0
- package/dist/types/components/core/drop-zone/drop-zone.d.ts +23 -0
- package/dist/types/components/core/drop-zone/index.d.ts +2 -0
- package/dist/types/components/core/dropdown-menu/dropdown-menu.d.ts +78 -0
- package/dist/types/components/core/dropdown-menu/index.d.ts +2 -0
- package/dist/types/components/core/editable-field/editable-field.d.ts +42 -0
- package/dist/types/components/core/editable-field/index.d.ts +2 -0
- package/dist/types/components/core/empty-state/empty-state.d.ts +11 -0
- package/dist/types/components/core/empty-state/index.d.ts +2 -0
- package/dist/types/components/core/field/field.d.ts +31 -0
- package/dist/types/components/core/field/index.d.ts +2 -0
- package/dist/types/components/core/icon/icon-sets.d.ts +38 -0
- package/dist/types/components/core/icon/icon.d.ts +14 -0
- package/dist/types/components/core/icon/index.d.ts +2 -0
- package/dist/types/components/core/input/index.d.ts +4 -0
- package/dist/types/components/core/input/input.d.ts +22 -0
- package/dist/types/components/core/input/textarea.d.ts +8 -0
- package/dist/types/components/core/kbd/index.d.ts +2 -0
- package/dist/types/components/core/kbd/kbd.d.ts +7 -0
- package/dist/types/components/core/label/index.d.ts +2 -0
- package/dist/types/components/core/label/label.d.ts +13 -0
- package/dist/types/components/core/main-content/index.d.ts +2 -0
- package/dist/types/components/core/main-content/main-content.d.ts +18 -0
- package/dist/types/components/core/pane/index.d.ts +1 -0
- package/dist/types/components/core/pane/pane.d.ts +12 -0
- package/dist/types/components/core/pick-menu/index.d.ts +4 -0
- package/dist/types/components/core/pick-menu/pick-menu.d.ts +57 -0
- package/dist/types/components/core/pick-menu/tag-menu.d.ts +19 -0
- package/dist/types/components/core/popover/index.d.ts +2 -0
- package/dist/types/components/core/popover/popover.d.ts +22 -0
- package/dist/types/components/core/progress/index.d.ts +2 -0
- package/dist/types/components/core/progress/progress.d.ts +13 -0
- package/dist/types/components/core/resizable/index.d.ts +2 -0
- package/dist/types/components/core/resizable/resizable.d.ts +15 -0
- package/dist/types/components/core/resizable/use-remembered-layout.d.ts +31 -0
- package/dist/types/components/core/screen-link/index.d.ts +2 -0
- package/dist/types/components/core/screen-link/screen-link.d.ts +52 -0
- package/dist/types/components/core/scroll-area/index.d.ts +2 -0
- package/dist/types/components/core/scroll-area/scroll-area.d.ts +13 -0
- package/dist/types/components/core/scroll-area/steps.d.ts +5 -0
- package/dist/types/components/core/section/index.d.ts +2 -0
- package/dist/types/components/core/section/section.d.ts +16 -0
- package/dist/types/components/core/segment-group/index.d.ts +2 -0
- package/dist/types/components/core/segment-group/segment-group.d.ts +24 -0
- package/dist/types/components/core/select/index.d.ts +2 -0
- package/dist/types/components/core/select/select.d.ts +39 -0
- package/dist/types/components/core/skeleton/index.d.ts +2 -0
- package/dist/types/components/core/skeleton/skeleton.d.ts +13 -0
- package/dist/types/components/core/slider/index.d.ts +2 -0
- package/dist/types/components/core/slider/slider.d.ts +9 -0
- package/dist/types/components/core/sortable/index.d.ts +2 -0
- package/dist/types/components/core/sortable/sortable.d.ts +53 -0
- package/dist/types/components/core/split-view/index.d.ts +2 -0
- package/dist/types/components/core/split-view/split-view.d.ts +28 -0
- package/dist/types/components/core/status-icon/index.d.ts +2 -0
- package/dist/types/components/core/status-icon/status-icon.d.ts +13 -0
- package/dist/types/components/core/table/collapsible-rows.d.ts +7 -0
- package/dist/types/components/core/table/expand-toggle.d.ts +10 -0
- package/dist/types/components/core/table/group-header.d.ts +14 -0
- package/dist/types/components/core/table/index.d.ts +8 -0
- package/dist/types/components/core/table/table.d.ts +31 -0
- package/dist/types/components/core/tabs/index.d.ts +2 -0
- package/dist/types/components/core/tabs/tabs.d.ts +20 -0
- package/dist/types/components/core/tag-pill/index.d.ts +2 -0
- package/dist/types/components/core/tag-pill/tag-pill.d.ts +25 -0
- package/dist/types/components/core/thumbnail/index.d.ts +2 -0
- package/dist/types/components/core/thumbnail/thumbnail.d.ts +23 -0
- package/dist/types/components/core/toast/index.d.ts +2 -0
- package/dist/types/components/core/toast/toast.d.ts +88 -0
- package/dist/types/components/core/toggle/index.d.ts +2 -0
- package/dist/types/components/core/toggle/toggle.d.ts +9 -0
- package/dist/types/components/core/toggle-group/index.d.ts +2 -0
- package/dist/types/components/core/toggle-group/toggle-group.d.ts +21 -0
- package/dist/types/components/core/tooltip/index.d.ts +2 -0
- package/dist/types/components/core/tooltip/tooltip.d.ts +33 -0
- package/dist/types/components/layout/multi-pane/index.d.ts +4 -0
- package/dist/types/components/layout/multi-pane/list-detail.d.ts +17 -0
- package/dist/types/components/layout/multi-pane/multi-pane.d.ts +34 -0
- package/dist/types/components/layout/single-pane/index.d.ts +2 -0
- package/dist/types/components/layout/single-pane/single-pane.d.ts +11 -0
- package/dist/types/components/shell/app-shell/app-shell.d.ts +12 -0
- package/dist/types/components/shell/app-shell/index.d.ts +2 -0
- package/dist/types/components/shell/sidebar/index.d.ts +2 -0
- package/dist/types/components/shell/sidebar/sidebar-group.d.ts +45 -0
- package/dist/types/components/shell/sidebar/sidebar-item.d.ts +19 -0
- package/dist/types/components/shell/sidebar/sidebar-resize-handle.d.ts +17 -0
- package/dist/types/components/shell/sidebar/sidebar-tree.d.ts +42 -0
- package/dist/types/components/shell/sidebar/sidebar.d.ts +27 -0
- package/dist/types/components/template/address-book-template/address-book-template.d.ts +15 -0
- package/dist/types/components/template/address-book-template/index.d.ts +2 -0
- package/dist/types/components/template/mail-template/index.d.ts +2 -0
- package/dist/types/components/template/mail-template/mail-template.d.ts +11 -0
- package/dist/types/components/template/use-narrow.d.ts +3 -0
- package/dist/types/index.d.ts +149 -0
- package/dist/types/kit/check-rendering.d.ts +3 -0
- package/dist/types/kit/kit.d.ts +76 -0
- package/dist/types/lib/clipboard.d.ts +5 -0
- package/dist/types/lib/dates.d.ts +9 -0
- package/dist/types/lib/json.d.ts +26 -0
- package/dist/types/lib/keys.d.ts +15 -0
- package/dist/types/lib/utils.d.ts +2 -0
- package/dist/types/lib/view-scope.d.ts +22 -0
- package/dist/types/profile/profile.d.ts +34 -0
- package/dist/types/theme/appearance.d.ts +31 -0
- package/dist/types/theme/boot.d.ts +3 -0
- package/dist/types/theme/client-appearance-react.d.ts +3 -0
- package/dist/types/theme/client-appearance.d.ts +69 -0
- package/dist/types/theme/generate-tokens.d.ts +45 -0
- package/dist/types/theme/pack-themes-react.d.ts +24 -0
- package/dist/types/theme/palette.d.ts +111 -0
- package/dist/types/theme/semantic-mapping.d.ts +28 -0
- package/dist/types/theme/set-theme.d.ts +30 -0
- package/dist/types/theme/theme-colours.d.ts +14 -0
- package/dist/types/theme/theme-css.d.ts +3 -0
- package/dist/types/theme/themes.d.ts +63 -0
- package/dist/types/theme/wallpaper-sheet.d.ts +16 -0
- package/dist/types/theme/wallpaper-theme-react.d.ts +7 -0
- package/dist/types/theme/wallpaper-theme.d.ts +37 -0
- package/package.json +87 -3
- package/src/build/stylesheet.ts +128 -0
- package/src/components/composite/command/command.meta.yaml +74 -0
- package/src/components/composite/command/command.tsx +939 -0
- package/src/components/composite/command/index.ts +17 -0
- package/src/components/composite/draft-bar/draft-bar.meta.yaml +19 -0
- package/src/components/composite/draft-bar/draft-bar.tsx +57 -0
- package/src/components/composite/draft-bar/index.ts +2 -0
- package/src/components/composite/image-field/image-field.meta.yaml +69 -0
- package/src/components/composite/image-field/image-field.tsx +267 -0
- package/src/components/composite/image-field/index.ts +2 -0
- package/src/components/composite/list/index.ts +18 -0
- package/src/components/composite/list/list-swipe.tsx +163 -0
- package/src/components/composite/list/list.meta.yaml +238 -0
- package/src/components/composite/list/list.tsx +868 -0
- package/src/components/composite/picker/index.ts +2 -0
- package/src/components/composite/picker/picker.meta.yaml +103 -0
- package/src/components/composite/picker/picker.tsx +276 -0
- package/src/components/composite/prompt-field/index.ts +2 -0
- package/src/components/composite/prompt-field/prompt-field.meta.yaml +60 -0
- package/src/components/composite/prompt-field/prompt-field.tsx +81 -0
- package/src/components/composite/properties/index.ts +9 -0
- package/src/components/composite/properties/properties.meta.yaml +56 -0
- package/src/components/composite/properties/properties.tsx +132 -0
- package/src/components/composite/snooze-menu/index.ts +11 -0
- package/src/components/composite/snooze-menu/presets.ts +169 -0
- package/src/components/composite/snooze-menu/snooze-menu.meta.yaml +58 -0
- package/src/components/composite/snooze-menu/snooze-menu.tsx +146 -0
- package/src/components/composite/tag-input/index.ts +2 -0
- package/src/components/composite/tag-input/tag-input.meta.yaml +51 -0
- package/src/components/composite/tag-input/tag-input.tsx +404 -0
- package/src/components/composite/wizard/index.ts +2 -0
- package/src/components/composite/wizard/wizard.meta.yaml +73 -0
- package/src/components/composite/wizard/wizard.tsx +256 -0
- package/src/components/core/avatar/avatar.meta.yaml +71 -0
- package/src/components/core/avatar/avatar.tsx +92 -0
- package/src/components/core/avatar/index.ts +2 -0
- package/src/components/core/badge/badge.meta.yaml +34 -0
- package/src/components/core/badge/badge.tsx +23 -0
- package/src/components/core/badge/index.ts +2 -0
- package/src/components/core/breadcrumb/breadcrumb.meta.yaml +45 -0
- package/src/components/core/breadcrumb/breadcrumb.tsx +110 -0
- package/src/components/core/breadcrumb/index.ts +2 -0
- package/src/components/core/bullets/bullets.meta.yaml +37 -0
- package/src/components/core/bullets/bullets.tsx +60 -0
- package/src/components/core/bullets/index.ts +2 -0
- package/src/components/core/button/button.meta.yaml +91 -0
- package/src/components/core/button/button.tsx +93 -0
- package/src/components/core/button/index.ts +2 -0
- package/src/components/core/card/card.meta.yaml +94 -0
- package/src/components/core/card/card.tsx +54 -0
- package/src/components/core/card/index.ts +2 -0
- package/src/components/core/checkbox/checkbox.meta.yaml +59 -0
- package/src/components/core/checkbox/checkbox.tsx +106 -0
- package/src/components/core/checkbox/index.ts +2 -0
- package/src/components/core/cluster/cluster.meta.yaml +4 -0
- package/src/components/core/cluster/cluster.tsx +17 -0
- package/src/components/core/cluster/index.ts +1 -0
- package/src/components/core/code-block/code-block.meta.yaml +30 -0
- package/src/components/core/code-block/code-block.tsx +93 -0
- package/src/components/core/code-block/index.ts +2 -0
- package/src/components/core/collapsible/collapsible.meta.yaml +34 -0
- package/src/components/core/collapsible/collapsible.tsx +54 -0
- package/src/components/core/collapsible/index.ts +1 -0
- package/src/components/core/colour-picker/colour-picker.meta.yaml +52 -0
- package/src/components/core/colour-picker/colour-picker.tsx +314 -0
- package/src/components/core/colour-picker/index.ts +4 -0
- package/src/components/core/combobox/combobox.meta.yaml +75 -0
- package/src/components/core/combobox/combobox.tsx +288 -0
- package/src/components/core/combobox/index.ts +2 -0
- package/src/components/core/detail/detail.meta.yaml +13 -0
- package/src/components/core/detail/detail.tsx +73 -0
- package/src/components/core/detail/index.ts +1 -0
- package/src/components/core/dialog/dialog.meta.yaml +95 -0
- package/src/components/core/dialog/dialog.tsx +254 -0
- package/src/components/core/dialog/drag.ts +40 -0
- package/src/components/core/dialog/index.ts +25 -0
- package/src/components/core/drop-zone/drop-zone.meta.yaml +55 -0
- package/src/components/core/drop-zone/drop-zone.tsx +146 -0
- package/src/components/core/drop-zone/index.ts +2 -0
- package/src/components/core/dropdown-menu/dropdown-menu.meta.yaml +118 -0
- package/src/components/core/dropdown-menu/dropdown-menu.tsx +407 -0
- package/src/components/core/dropdown-menu/index.ts +32 -0
- package/src/components/core/editable-field/editable-field.meta.yaml +120 -0
- package/src/components/core/editable-field/editable-field.tsx +346 -0
- package/src/components/core/editable-field/index.ts +2 -0
- package/src/components/core/empty-state/empty-state.meta.yaml +21 -0
- package/src/components/core/empty-state/empty-state.tsx +42 -0
- package/src/components/core/empty-state/index.ts +2 -0
- package/src/components/core/field/field.meta.yaml +37 -0
- package/src/components/core/field/field.tsx +100 -0
- package/src/components/core/field/index.ts +9 -0
- package/src/components/core/icon/curated-names.json +107 -0
- package/src/components/core/icon/icon-sets.ts +109 -0
- package/src/components/core/icon/icon.meta.yaml +30 -0
- package/src/components/core/icon/icon.tsx +93 -0
- package/src/components/core/icon/index.ts +2 -0
- package/src/components/core/input/index.ts +4 -0
- package/src/components/core/input/input.meta.yaml +98 -0
- package/src/components/core/input/input.tsx +133 -0
- package/src/components/core/input/textarea.meta.yaml +79 -0
- package/src/components/core/input/textarea.tsx +63 -0
- package/src/components/core/kbd/index.ts +2 -0
- package/src/components/core/kbd/kbd.meta.yaml +12 -0
- package/src/components/core/kbd/kbd.tsx +29 -0
- package/src/components/core/label/index.ts +2 -0
- package/src/components/core/label/label.meta.yaml +55 -0
- package/src/components/core/label/label.tsx +72 -0
- package/src/components/core/main-content/index.ts +2 -0
- package/src/components/core/main-content/main-content.meta.yaml +23 -0
- package/src/components/core/main-content/main-content.tsx +49 -0
- package/src/components/core/pane/index.ts +1 -0
- package/src/components/core/pane/pane.meta.yaml +13 -0
- package/src/components/core/pane/pane.tsx +64 -0
- package/src/components/core/pick-menu/index.ts +4 -0
- package/src/components/core/pick-menu/pick-menu.meta.yaml +36 -0
- package/src/components/core/pick-menu/pick-menu.tsx +348 -0
- package/src/components/core/pick-menu/tag-menu.meta.yaml +7 -0
- package/src/components/core/pick-menu/tag-menu.tsx +79 -0
- package/src/components/core/popover/index.ts +2 -0
- package/src/components/core/popover/popover.meta.yaml +16 -0
- package/src/components/core/popover/popover.tsx +66 -0
- package/src/components/core/progress/index.ts +2 -0
- package/src/components/core/progress/progress.meta.yaml +47 -0
- package/src/components/core/progress/progress.tsx +56 -0
- package/src/components/core/resizable/index.ts +13 -0
- package/src/components/core/resizable/resizable.meta.yaml +110 -0
- package/src/components/core/resizable/resizable.tsx +125 -0
- package/src/components/core/resizable/use-remembered-layout.ts +261 -0
- package/src/components/core/screen-link/index.ts +2 -0
- package/src/components/core/screen-link/screen-link.meta.yaml +34 -0
- package/src/components/core/screen-link/screen-link.tsx +100 -0
- package/src/components/core/scroll-area/index.ts +2 -0
- package/src/components/core/scroll-area/scroll-area.meta.yaml +72 -0
- package/src/components/core/scroll-area/scroll-area.tsx +95 -0
- package/src/components/core/scroll-area/steps.tsx +72 -0
- package/src/components/core/section/index.ts +2 -0
- package/src/components/core/section/section.meta.yaml +72 -0
- package/src/components/core/section/section.tsx +93 -0
- package/src/components/core/segment-group/index.ts +2 -0
- package/src/components/core/segment-group/segment-group.meta.yaml +71 -0
- package/src/components/core/segment-group/segment-group.tsx +166 -0
- package/src/components/core/select/index.ts +20 -0
- package/src/components/core/select/select.meta.yaml +48 -0
- package/src/components/core/select/select.tsx +226 -0
- package/src/components/core/skeleton/index.ts +2 -0
- package/src/components/core/skeleton/skeleton.meta.yaml +50 -0
- package/src/components/core/skeleton/skeleton.tsx +71 -0
- package/src/components/core/slider/index.ts +2 -0
- package/src/components/core/slider/slider.meta.yaml +55 -0
- package/src/components/core/slider/slider.tsx +46 -0
- package/src/components/core/sortable/index.ts +16 -0
- package/src/components/core/sortable/sortable.meta.yaml +125 -0
- package/src/components/core/sortable/sortable.tsx +471 -0
- package/src/components/core/split-view/index.ts +2 -0
- package/src/components/core/split-view/split-view.meta.yaml +85 -0
- package/src/components/core/split-view/split-view.tsx +193 -0
- package/src/components/core/status-icon/index.ts +2 -0
- package/src/components/core/status-icon/status-icon.meta.yaml +64 -0
- package/src/components/core/status-icon/status-icon.tsx +94 -0
- package/src/components/core/table/collapsible-rows.tsx +30 -0
- package/src/components/core/table/expand-toggle.tsx +58 -0
- package/src/components/core/table/group-header.tsx +35 -0
- package/src/components/core/table/index.ts +26 -0
- package/src/components/core/table/table.meta.yaml +67 -0
- package/src/components/core/table/table.tsx +166 -0
- package/src/components/core/tabs/index.ts +2 -0
- package/src/components/core/tabs/tabs.meta.yaml +57 -0
- package/src/components/core/tabs/tabs.tsx +74 -0
- package/src/components/core/tag-pill/index.ts +2 -0
- package/src/components/core/tag-pill/tag-pill.meta.yaml +19 -0
- package/src/components/core/tag-pill/tag-pill.tsx +102 -0
- package/src/components/core/thumbnail/index.ts +2 -0
- package/src/components/core/thumbnail/thumbnail.meta.yaml +59 -0
- package/src/components/core/thumbnail/thumbnail.tsx +162 -0
- package/src/components/core/toast/index.ts +12 -0
- package/src/components/core/toast/toast.meta.yaml +93 -0
- package/src/components/core/toast/toast.tsx +763 -0
- package/src/components/core/toggle/index.ts +2 -0
- package/src/components/core/toggle/toggle.meta.yaml +53 -0
- package/src/components/core/toggle/toggle.tsx +44 -0
- package/src/components/core/toggle-group/index.ts +2 -0
- package/src/components/core/toggle-group/toggle-group.meta.yaml +59 -0
- package/src/components/core/toggle-group/toggle-group.tsx +68 -0
- package/src/components/core/tooltip/index.ts +7 -0
- package/src/components/core/tooltip/tooltip.meta.yaml +93 -0
- package/src/components/core/tooltip/tooltip.tsx +198 -0
- package/src/components/layout/multi-pane/index.ts +4 -0
- package/src/components/layout/multi-pane/list-detail.tsx +45 -0
- package/src/components/layout/multi-pane/multi-pane.meta.yaml +67 -0
- package/src/components/layout/multi-pane/multi-pane.tsx +158 -0
- package/src/components/layout/single-pane/index.ts +2 -0
- package/src/components/layout/single-pane/single-pane.meta.yaml +35 -0
- package/src/components/layout/single-pane/single-pane.tsx +48 -0
- package/src/components/shell/app-shell/app-shell.meta.yaml +65 -0
- package/src/components/shell/app-shell/app-shell.tsx +61 -0
- package/src/components/shell/app-shell/index.ts +2 -0
- package/src/components/shell/sidebar/index.ts +35 -0
- package/src/components/shell/sidebar/sidebar-group.tsx +254 -0
- package/src/components/shell/sidebar/sidebar-item.tsx +88 -0
- package/src/components/shell/sidebar/sidebar-resize-handle.tsx +101 -0
- package/src/components/shell/sidebar/sidebar-tree.tsx +325 -0
- package/src/components/shell/sidebar/sidebar.meta.yaml +126 -0
- package/src/components/shell/sidebar/sidebar.tsx +142 -0
- package/src/components/template/address-book-template/address-book-template.meta.yaml +22 -0
- package/src/components/template/address-book-template/address-book-template.tsx +201 -0
- package/src/components/template/address-book-template/index.ts +2 -0
- package/src/components/template/mail-template/index.ts +2 -0
- package/src/components/template/mail-template/mail-template.meta.yaml +22 -0
- package/src/components/template/mail-template/mail-template.tsx +731 -0
- package/src/components/template/use-narrow.ts +18 -0
- package/src/index.ts +505 -0
- package/src/kit/check-rendering.tsx +130 -0
- package/src/kit/kit.tsx +177 -0
- package/src/lib/clipboard.ts +27 -0
- package/src/lib/dates.ts +13 -0
- package/src/lib/json.ts +59 -0
- package/src/lib/keys.ts +54 -0
- package/src/lib/utils.ts +12 -0
- package/src/lib/view-scope.tsx +60 -0
- package/src/profile/profile.ts +238 -0
- package/src/theme/appearance.ts +198 -0
- package/src/theme/boot.ts +6 -0
- package/src/theme/client-appearance-react.ts +14 -0
- package/src/theme/client-appearance.ts +284 -0
- package/src/theme/generate-tokens.ts +658 -0
- package/src/theme/pack-themes-react.ts +107 -0
- package/src/theme/palette.ts +301 -0
- package/src/theme/semantic-mapping.ts +165 -0
- package/src/theme/set-theme.ts +162 -0
- package/src/theme/theme-colours.ts +60 -0
- package/src/theme/theme-css.ts +15 -0
- package/src/theme/themes.ts +133 -0
- package/src/theme/wallpaper-sheet.ts +58 -0
- package/src/theme/wallpaper-theme-react.ts +60 -0
- package/src/theme/wallpaper-theme.ts +231 -0
|
@@ -0,0 +1,404 @@
|
|
|
1
|
+
import * as React from "react";
|
|
2
|
+
|
|
3
|
+
import { cn } from "../../../lib/utils";
|
|
4
|
+
import { dropdownMenuItemVariants } from "../../core/dropdown-menu/dropdown-menu";
|
|
5
|
+
import { noAutofill } from "../../core/input/input";
|
|
6
|
+
import { Label } from "../../core/label/label";
|
|
7
|
+
import { FieldContext, useFieldControl } from "../../core/field/field";
|
|
8
|
+
import { SortableItem, SortableList } from "../../core/sortable/sortable";
|
|
9
|
+
import { ScrollArea } from "../../core/scroll-area";
|
|
10
|
+
import { isComposing } from "../../../lib/keys";
|
|
11
|
+
|
|
12
|
+
interface TagOption {
|
|
13
|
+
value: string;
|
|
14
|
+
label?: string;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
interface TagInputProps extends Omit<
|
|
18
|
+
React.ComponentProps<"input">,
|
|
19
|
+
"value" | "defaultValue" | "onChange" | "size"
|
|
20
|
+
> {
|
|
21
|
+
/** The tags, in order. */
|
|
22
|
+
value: string[];
|
|
23
|
+
/** Called with the next tags when one is added or removed. */
|
|
24
|
+
onChange: (value: string[]) => void;
|
|
25
|
+
/** The values the input may suggest, each with the text shown for it. */
|
|
26
|
+
options?: TagOption[] | undefined;
|
|
27
|
+
/** With `options`: only an option's value may be added; other text is refused. */
|
|
28
|
+
strict?: boolean | undefined;
|
|
29
|
+
/** Lets the chips be reordered with Alt+arrows or by dragging. */
|
|
30
|
+
sortable?: boolean | undefined;
|
|
31
|
+
/** The frame's height on one line, as Input's (h-sm, h-md, h-lg). Defaults to `default` (h-md). */
|
|
32
|
+
size?: "sm" | "default" | "lg" | undefined;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// The frame's minimum height at each size, and its text input's: one step lower, so the chips' row keeps 2px above
|
|
36
|
+
// and below inside the frame.
|
|
37
|
+
const tagInputSizes = {
|
|
38
|
+
sm: { frame: "min-h-(--height-sm)", input: "h-xs" },
|
|
39
|
+
default: { frame: "min-h-(--height-md)", input: "h-sm" },
|
|
40
|
+
lg: { frame: "min-h-(--height-lg)", input: "h-md" },
|
|
41
|
+
} as const;
|
|
42
|
+
|
|
43
|
+
// Bridge: accent-hued `Label` chips (feature variant, dot from --label-tag-dot) plus a bare input, framed like `Input
|
|
44
|
+
// variant="outline"`. Enter, a comma, or leaving the input adds the trimmed text (empty and duplicates
|
|
45
|
+
// ignored; pasted "a,b,c" adds each part); Backspace on an empty input removes the last tag. With
|
|
46
|
+
// `name`, each tag is a hidden input (the pending text is not submitted). A chip is not a text control:
|
|
47
|
+
// its × is centred on the pill (-1px bottom margin, as the dot).
|
|
48
|
+
//
|
|
49
|
+
// With `options`, the input is a combobox: while it has focus, a listbox under the frame lists the unused options
|
|
50
|
+
// whose value or label contains the typed text, by label; ArrowDown/ArrowUp choose one, Enter adds it, Escape closes
|
|
51
|
+
// the list, and an option picked by click or a chip already chosen shows its label. `strict` refuses text that is no
|
|
52
|
+
// option (Enter, comma and blur add nothing; blur clears it) and keeps a value that left the options, marked
|
|
53
|
+
// unavailable. `sortable` makes each chip a control that moves with Alt+Left/Alt+Right (or the kit's Sortable by
|
|
54
|
+
// pointer); focus follows the chip it moved.
|
|
55
|
+
function TagInput({
|
|
56
|
+
value,
|
|
57
|
+
onChange,
|
|
58
|
+
options,
|
|
59
|
+
strict = false,
|
|
60
|
+
sortable = false,
|
|
61
|
+
size = "default",
|
|
62
|
+
className,
|
|
63
|
+
disabled: disabledProp,
|
|
64
|
+
name,
|
|
65
|
+
onFocus,
|
|
66
|
+
onKeyDown,
|
|
67
|
+
onBlur,
|
|
68
|
+
...props
|
|
69
|
+
}: TagInputProps) {
|
|
70
|
+
const [text, setText] = React.useState("");
|
|
71
|
+
const [focused, setFocused] = React.useState(false);
|
|
72
|
+
const [closed, setClosed] = React.useState(false);
|
|
73
|
+
const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
|
|
74
|
+
const [focusAfterMove, setFocusAfterMove] = React.useState<number | null>(null);
|
|
75
|
+
const frame = React.useRef<HTMLDivElement>(null);
|
|
76
|
+
const listId = React.useId();
|
|
77
|
+
const disabled = disabledProp || React.useContext(FieldContext)?.disabled || undefined;
|
|
78
|
+
// A disabled field moves nothing: no focusable chip, no Alt+arrows, no dragging.
|
|
79
|
+
const canSort = sortable && !disabled;
|
|
80
|
+
|
|
81
|
+
/** Adds each trimmed, non-empty part that is not already a tag. */
|
|
82
|
+
const add = (parts: string[]) => {
|
|
83
|
+
const next = [...value];
|
|
84
|
+
for (const part of parts) {
|
|
85
|
+
const tag = part.trim();
|
|
86
|
+
if (tag && !next.includes(tag)) next.push(tag);
|
|
87
|
+
}
|
|
88
|
+
if (next.length > value.length) onChange(next);
|
|
89
|
+
};
|
|
90
|
+
|
|
91
|
+
const optionByValue = React.useMemo(
|
|
92
|
+
() => new Map((options ?? []).map((option) => [option.value, option])),
|
|
93
|
+
[options],
|
|
94
|
+
);
|
|
95
|
+
|
|
96
|
+
// Not already chosen, and matching the typed text in the value or the label, in the options' order.
|
|
97
|
+
const query = text.trim().toLowerCase();
|
|
98
|
+
const matches = React.useMemo(() => {
|
|
99
|
+
if (!options) return [];
|
|
100
|
+
const chosen = new Set(value);
|
|
101
|
+
return options.filter(
|
|
102
|
+
(option) =>
|
|
103
|
+
!chosen.has(option.value) &&
|
|
104
|
+
(query === "" ||
|
|
105
|
+
option.value.toLowerCase().includes(query) ||
|
|
106
|
+
(option.label ?? "").toLowerCase().includes(query)),
|
|
107
|
+
);
|
|
108
|
+
}, [options, value, query]);
|
|
109
|
+
|
|
110
|
+
/** The option whose value or label is exactly the typed text, if any. */
|
|
111
|
+
const resolve = (part: string) => {
|
|
112
|
+
const needle = part.trim().toLowerCase();
|
|
113
|
+
if (!needle) return undefined;
|
|
114
|
+
return (options ?? []).find(
|
|
115
|
+
(option) =>
|
|
116
|
+
option.value.toLowerCase() === needle || (option.label ?? "").toLowerCase() === needle,
|
|
117
|
+
);
|
|
118
|
+
};
|
|
119
|
+
|
|
120
|
+
/** Adds option values for exact matches; outside strict, other text stays free-form. */
|
|
121
|
+
const addParts = (parts: string[]) => {
|
|
122
|
+
if (!options) return add(parts);
|
|
123
|
+
const next: string[] = [];
|
|
124
|
+
for (const part of parts) {
|
|
125
|
+
const option = resolve(part);
|
|
126
|
+
if (option) next.push(option.value);
|
|
127
|
+
else if (!strict) next.push(part);
|
|
128
|
+
}
|
|
129
|
+
add(next);
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
const pick = (option: TagOption) => {
|
|
133
|
+
add([option.value]);
|
|
134
|
+
setText("");
|
|
135
|
+
setActiveIndex(null);
|
|
136
|
+
};
|
|
137
|
+
|
|
138
|
+
const optionId = (index: number) => `${listId}-option-${index}`;
|
|
139
|
+
const listOpen = Boolean(options) && focused && !closed && !disabled;
|
|
140
|
+
|
|
141
|
+
/** Alt+Left/Right moves a sortable chip one place; focus follows it after the controlled value changes. */
|
|
142
|
+
const move = (event: React.KeyboardEvent<HTMLElement>, index: number) => {
|
|
143
|
+
if (!event.altKey) return;
|
|
144
|
+
const to =
|
|
145
|
+
event.key === "ArrowLeft" ? index - 1 : event.key === "ArrowRight" ? index + 1 : null;
|
|
146
|
+
if (to === null || to < 0 || to >= value.length) return;
|
|
147
|
+
event.preventDefault();
|
|
148
|
+
const next = [...value];
|
|
149
|
+
const [chip] = next.splice(index, 1);
|
|
150
|
+
if (chip === undefined) return;
|
|
151
|
+
next.splice(to, 0, chip);
|
|
152
|
+
onChange(next);
|
|
153
|
+
setFocusAfterMove(to);
|
|
154
|
+
};
|
|
155
|
+
|
|
156
|
+
React.useLayoutEffect(() => {
|
|
157
|
+
if (focusAfterMove === null) return;
|
|
158
|
+
frame.current
|
|
159
|
+
?.querySelectorAll<HTMLElement>('[data-slot="tag-input-chip"]')
|
|
160
|
+
[focusAfterMove]?.focus();
|
|
161
|
+
setFocusAfterMove(null);
|
|
162
|
+
}, [focusAfterMove, value]);
|
|
163
|
+
|
|
164
|
+
const input = useFieldControl(
|
|
165
|
+
<input
|
|
166
|
+
data-slot="tag-input-input"
|
|
167
|
+
className={cn(
|
|
168
|
+
"min-w-16 flex-1 bg-transparent text-sm text-foreground outline-hidden placeholder:text-placeholder disabled:cursor-not-allowed",
|
|
169
|
+
tagInputSizes[size].input,
|
|
170
|
+
)}
|
|
171
|
+
disabled={disabled}
|
|
172
|
+
value={text}
|
|
173
|
+
role={options ? "combobox" : undefined}
|
|
174
|
+
aria-expanded={options ? listOpen : undefined}
|
|
175
|
+
aria-controls={options ? listId : undefined}
|
|
176
|
+
aria-autocomplete={options ? "list" : undefined}
|
|
177
|
+
aria-activedescendant={
|
|
178
|
+
options && activeIndex !== null && matches[activeIndex] ? optionId(activeIndex) : undefined
|
|
179
|
+
}
|
|
180
|
+
onChange={(event) => {
|
|
181
|
+
// A typed or pasted comma commits every part before the last one; the rest stays typed.
|
|
182
|
+
const parts = event.currentTarget.value.split(",");
|
|
183
|
+
const rest = parts.pop()!;
|
|
184
|
+
setClosed(false);
|
|
185
|
+
setActiveIndex(null);
|
|
186
|
+
if (parts.length > 0) addParts(parts);
|
|
187
|
+
setText(rest);
|
|
188
|
+
}}
|
|
189
|
+
onKeyDown={(event) => {
|
|
190
|
+
onKeyDown?.(event);
|
|
191
|
+
if (event.defaultPrevented || isComposing(event)) return;
|
|
192
|
+
if (options) {
|
|
193
|
+
if (event.key === "Escape" && listOpen) {
|
|
194
|
+
event.preventDefault();
|
|
195
|
+
setClosed(true);
|
|
196
|
+
setActiveIndex(null);
|
|
197
|
+
return;
|
|
198
|
+
}
|
|
199
|
+
if (event.key === "ArrowDown" || event.key === "ArrowUp") {
|
|
200
|
+
event.preventDefault();
|
|
201
|
+
setClosed(false);
|
|
202
|
+
if (matches.length === 0) return;
|
|
203
|
+
setActiveIndex((current) =>
|
|
204
|
+
event.key === "ArrowDown"
|
|
205
|
+
? current === null
|
|
206
|
+
? 0
|
|
207
|
+
: Math.min(current + 1, matches.length - 1)
|
|
208
|
+
: current === null
|
|
209
|
+
? matches.length - 1
|
|
210
|
+
: Math.max(current - 1, 0),
|
|
211
|
+
);
|
|
212
|
+
return;
|
|
213
|
+
}
|
|
214
|
+
if (event.key === "Enter") {
|
|
215
|
+
const active = activeIndex === null ? undefined : matches[activeIndex];
|
|
216
|
+
if (active) {
|
|
217
|
+
event.preventDefault();
|
|
218
|
+
pick(active);
|
|
219
|
+
return;
|
|
220
|
+
}
|
|
221
|
+
if (text !== "") {
|
|
222
|
+
const option = resolve(text);
|
|
223
|
+
if (option) {
|
|
224
|
+
event.preventDefault();
|
|
225
|
+
pick(option);
|
|
226
|
+
return;
|
|
227
|
+
}
|
|
228
|
+
// Strict refuses text that is no option; the text stays so it can be corrected.
|
|
229
|
+
if (strict) {
|
|
230
|
+
event.preventDefault();
|
|
231
|
+
return;
|
|
232
|
+
}
|
|
233
|
+
event.preventDefault();
|
|
234
|
+
add([text]);
|
|
235
|
+
setText("");
|
|
236
|
+
setActiveIndex(null);
|
|
237
|
+
return;
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
if (event.key === "Enter" && text !== "") {
|
|
242
|
+
event.preventDefault();
|
|
243
|
+
add([text]);
|
|
244
|
+
setText("");
|
|
245
|
+
} else if (event.key === "Backspace" && text === "" && value.length > 0) {
|
|
246
|
+
onChange(value.slice(0, -1));
|
|
247
|
+
}
|
|
248
|
+
}}
|
|
249
|
+
onFocus={(event) => {
|
|
250
|
+
onFocus?.(event);
|
|
251
|
+
setFocused(true);
|
|
252
|
+
setClosed(false);
|
|
253
|
+
setActiveIndex(null);
|
|
254
|
+
}}
|
|
255
|
+
onBlur={(event) => {
|
|
256
|
+
onBlur?.(event);
|
|
257
|
+
setFocused(false);
|
|
258
|
+
setActiveIndex(null);
|
|
259
|
+
if (text === "") return;
|
|
260
|
+
// Strict only takes an option, and clears what it refuses; elsewhere the text stays free-form.
|
|
261
|
+
if (strict) {
|
|
262
|
+
const option = resolve(text);
|
|
263
|
+
if (option) add([option.value]);
|
|
264
|
+
} else {
|
|
265
|
+
addParts([text]);
|
|
266
|
+
}
|
|
267
|
+
setText("");
|
|
268
|
+
}}
|
|
269
|
+
autoComplete={noAutofill}
|
|
270
|
+
{...props}
|
|
271
|
+
/>,
|
|
272
|
+
);
|
|
273
|
+
|
|
274
|
+
const chip = (tag: string, index: number) => {
|
|
275
|
+
const option = optionByValue.get(tag);
|
|
276
|
+
const shown = option?.label ?? tag;
|
|
277
|
+
const unavailable = Boolean(options && strict && !option);
|
|
278
|
+
return (
|
|
279
|
+
// By index: a controlled value may hold duplicates.
|
|
280
|
+
// The dot: the feature label's in light themes, the accent in dark ones (--label-tag-dot).
|
|
281
|
+
<span
|
|
282
|
+
key={index}
|
|
283
|
+
data-slot="tag-input-chip"
|
|
284
|
+
tabIndex={canSort ? 0 : undefined}
|
|
285
|
+
aria-roledescription={canSort ? "sortable" : undefined}
|
|
286
|
+
aria-description={canSort ? "Alt+Left or Alt+Right to move" : undefined}
|
|
287
|
+
className={cn(
|
|
288
|
+
"rounded-xs outline-none",
|
|
289
|
+
canSort && "focus-visible:ring-2 focus-visible:ring-accent",
|
|
290
|
+
)}
|
|
291
|
+
onKeyDown={canSort ? (event) => move(event, index) : undefined}
|
|
292
|
+
>
|
|
293
|
+
<Label
|
|
294
|
+
variant="feature"
|
|
295
|
+
className={cn(
|
|
296
|
+
"[&>[aria-hidden]:first-child]:bg-label-tag-dot",
|
|
297
|
+
unavailable && "opacity-60",
|
|
298
|
+
)}
|
|
299
|
+
{...(unavailable ? { "data-unavailable": "true", title: "Not available" } : {})}
|
|
300
|
+
>
|
|
301
|
+
{shown}
|
|
302
|
+
<button
|
|
303
|
+
type="button"
|
|
304
|
+
data-slot="tag-input-remove"
|
|
305
|
+
aria-label={`Remove ${shown}`}
|
|
306
|
+
disabled={disabled}
|
|
307
|
+
className="-mr-0.5 -mb-px inline-flex size-3.5 cursor-pointer items-center justify-center rounded-xs p-0 hover:bg-hover disabled:cursor-not-allowed"
|
|
308
|
+
onClick={(event) => {
|
|
309
|
+
// Keep focus in the control rather than dropping it to <body>.
|
|
310
|
+
event.currentTarget
|
|
311
|
+
.closest('[data-slot="tag-input"]')
|
|
312
|
+
?.querySelector<HTMLInputElement>('[data-slot="tag-input-input"]')
|
|
313
|
+
?.focus();
|
|
314
|
+
onChange(value.filter((_, i) => i !== index));
|
|
315
|
+
}}
|
|
316
|
+
>
|
|
317
|
+
<svg
|
|
318
|
+
aria-hidden="true"
|
|
319
|
+
className="size-3"
|
|
320
|
+
viewBox="0 0 24 24"
|
|
321
|
+
fill="none"
|
|
322
|
+
stroke="currentColor"
|
|
323
|
+
strokeWidth="2"
|
|
324
|
+
strokeLinecap="round"
|
|
325
|
+
>
|
|
326
|
+
<path d="M18 6 6 18M6 6l12 12" />
|
|
327
|
+
</svg>
|
|
328
|
+
</button>
|
|
329
|
+
</Label>
|
|
330
|
+
</span>
|
|
331
|
+
);
|
|
332
|
+
};
|
|
333
|
+
|
|
334
|
+
return (
|
|
335
|
+
<div
|
|
336
|
+
ref={frame}
|
|
337
|
+
data-slot="tag-input"
|
|
338
|
+
data-disabled={disabled}
|
|
339
|
+
data-size={size}
|
|
340
|
+
className={cn(
|
|
341
|
+
tagInputSizes[size].frame,
|
|
342
|
+
"relative flex w-full flex-wrap items-center gap-1 rounded-control border-[0.5px] border-input bg-surface px-1.5 transition-[border-color] duration-150 focus-within:border-accent has-[[aria-invalid=true]]:border-destructive data-disabled:opacity-50",
|
|
343
|
+
className,
|
|
344
|
+
)}
|
|
345
|
+
>
|
|
346
|
+
{canSort ? (
|
|
347
|
+
<SortableList
|
|
348
|
+
id={`${listId}-chips`}
|
|
349
|
+
items={value.map((_, index) => `${index}`)}
|
|
350
|
+
orientation="horizontal"
|
|
351
|
+
onReorder={(next) => {
|
|
352
|
+
const byIndex = value.map((tag, index) => [index, tag] as const);
|
|
353
|
+
const tags = new Map(byIndex);
|
|
354
|
+
onChange(next.flatMap((id) => tags.get(Number(id)) ?? []));
|
|
355
|
+
}}
|
|
356
|
+
className="contents"
|
|
357
|
+
>
|
|
358
|
+
{value.map((tag, index) => (
|
|
359
|
+
<SortableItem key={index} id={`${index}`} dragFullItem="pointer">
|
|
360
|
+
{chip(tag, index)}
|
|
361
|
+
</SortableItem>
|
|
362
|
+
))}
|
|
363
|
+
</SortableList>
|
|
364
|
+
) : (
|
|
365
|
+
value.map(chip)
|
|
366
|
+
)}
|
|
367
|
+
{input}
|
|
368
|
+
{options && listOpen && matches.length > 0 && (
|
|
369
|
+
<ScrollArea
|
|
370
|
+
className="absolute top-full left-0 z-50 mt-1 flex max-h-80 w-full flex-col rounded-dropdown border border-border bg-surface shadow-[var(--shadow-dropdown)]"
|
|
371
|
+
viewportClassName="min-h-0 flex-1"
|
|
372
|
+
>
|
|
373
|
+
<div
|
|
374
|
+
id={listId}
|
|
375
|
+
role="listbox"
|
|
376
|
+
data-slot="tag-input-listbox"
|
|
377
|
+
aria-label="Options"
|
|
378
|
+
className="p-1 outline-none"
|
|
379
|
+
>
|
|
380
|
+
{matches.map((option, index) => (
|
|
381
|
+
<div
|
|
382
|
+
key={option.value}
|
|
383
|
+
id={optionId(index)}
|
|
384
|
+
role="option"
|
|
385
|
+
aria-selected={activeIndex === index}
|
|
386
|
+
data-slot="tag-input-option"
|
|
387
|
+
className={cn(dropdownMenuItemVariants(), activeIndex === index && "bg-hover")}
|
|
388
|
+
onMouseDown={(event) => event.preventDefault()}
|
|
389
|
+
onClick={() => pick(option)}
|
|
390
|
+
>
|
|
391
|
+
{option.label ?? option.value}
|
|
392
|
+
</div>
|
|
393
|
+
))}
|
|
394
|
+
</div>
|
|
395
|
+
</ScrollArea>
|
|
396
|
+
)}
|
|
397
|
+
{name &&
|
|
398
|
+
value.map((tag, index) => <input key={index} type="hidden" name={name} value={tag} />)}
|
|
399
|
+
</div>
|
|
400
|
+
);
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
export { TagInput };
|
|
404
|
+
export type { TagInputProps, TagOption };
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
name: Wizard
|
|
2
|
+
description: "A dialog in steps: one step shown at a time, a step going on by a choice in it or by its primary button, Back along the steps taken, the primary button busy while its submit runs, a failure kept in its step. One height whatever the step (560 px): a long step scrolls in its body."
|
|
3
|
+
layer: composite
|
|
4
|
+
category: overlay
|
|
5
|
+
when_to_use:
|
|
6
|
+
- "To make something in a few steps where the first choice decides the next (a project from a source: an empty folder, an existing one, a clone)"
|
|
7
|
+
- "For a short linear flow in a dialog, with its place shown (position [n, total])"
|
|
8
|
+
when_not_to_use:
|
|
9
|
+
- "For one form — use Dialog with a DialogFooter"
|
|
10
|
+
- "For a screen of its own the user comes back to — a screen, a navigation (Back works there)"
|
|
11
|
+
- "For a confirmation — use Dialog"
|
|
12
|
+
composition_partners:
|
|
13
|
+
- Dialog (Wizard is a kit Dialog)
|
|
14
|
+
- List (a step choosing among options, each with a leading Icon and a description, calls useWizard().go)
|
|
15
|
+
- Field, Input, Checkbox (a step's form)
|
|
16
|
+
props:
|
|
17
|
+
- name: open
|
|
18
|
+
type: boolean
|
|
19
|
+
required: true
|
|
20
|
+
- name: onOpenChange
|
|
21
|
+
type: "(open: boolean) => void"
|
|
22
|
+
required: true
|
|
23
|
+
description: "Cancel, Escape, the backdrop, or a finished submit closes it (not while a submit runs)"
|
|
24
|
+
- name: initial
|
|
25
|
+
type: string
|
|
26
|
+
required: true
|
|
27
|
+
description: "The first step's id; opened again, the wizard starts there"
|
|
28
|
+
- name: "WizardStep.id"
|
|
29
|
+
type: string
|
|
30
|
+
required: true
|
|
31
|
+
- name: "WizardStep.title"
|
|
32
|
+
type: ReactNode
|
|
33
|
+
required: true
|
|
34
|
+
- name: "WizardStep.description"
|
|
35
|
+
type: ReactNode
|
|
36
|
+
required: false
|
|
37
|
+
- name: "WizardStep.position"
|
|
38
|
+
type: "[number, number]"
|
|
39
|
+
required: false
|
|
40
|
+
description: "Its place in a linear flow: 'n / total' beside the title"
|
|
41
|
+
- name: "WizardStep.submitLabel"
|
|
42
|
+
type: string
|
|
43
|
+
required: false
|
|
44
|
+
description: "The primary button's words, on the right after Cancel; none: the step goes on by a choice in it"
|
|
45
|
+
- name: "WizardStep.busyLabel"
|
|
46
|
+
type: string
|
|
47
|
+
required: false
|
|
48
|
+
description: "The primary button's words while its submit runs ('Cloning…')"
|
|
49
|
+
- name: "WizardStep.canSubmit"
|
|
50
|
+
type: boolean
|
|
51
|
+
required: false
|
|
52
|
+
default: "true"
|
|
53
|
+
- name: "WizardStep.onSubmit"
|
|
54
|
+
type: "() => Promise<string | void> | string | void"
|
|
55
|
+
required: false
|
|
56
|
+
description: "The primary button or Enter: answers the next step's id, or nothing to close. A throw keeps the step with its message (role=alert)"
|
|
57
|
+
- name: useWizard
|
|
58
|
+
type: "() => { step, go, back, canGoBack, close, busy, error, clearError, run }"
|
|
59
|
+
required: false
|
|
60
|
+
description: "Inside a step: go(id) to the next step, run(task) for a step's own long action (busy, its failure kept as error), error to offer the fix beside the message"
|
|
61
|
+
examples:
|
|
62
|
+
- title: "A choice, then a form"
|
|
63
|
+
code: |
|
|
64
|
+
<Wizard open={open} onOpenChange={setOpen} initial="source">
|
|
65
|
+
<WizardStep id="source" title="New project" description="Where does it come from?">
|
|
66
|
+
<Sources />{/* a List whose onAction calls useWizard().go(key) */}
|
|
67
|
+
</WizardStep>
|
|
68
|
+
<WizardStep id="empty" title="Empty folder" submitLabel="Create" busyLabel="Creating…"
|
|
69
|
+
canSubmit={name !== ""} onSubmit={() => create(name)}>
|
|
70
|
+
<Field><FieldLabel>Name</FieldLabel><Input value={name} onChange={…} /></Field>
|
|
71
|
+
</WizardStep>
|
|
72
|
+
</Wizard>
|
|
73
|
+
accessibility_notes: "A Dialog: the focus stays inside; each step's first field (or option) takes the focus when shown. Back is a labelled button before the title. Enter in a field submits the step (a form); a failure is a role=alert line."
|