@cube-dev/ui-kit 0.0.0-canary-7f7e7f9 → 0.0.0-canary-1f0dd2c
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/README.md +4 -7
- package/dist/README.md +4 -7
- package/dist/_internal/hooks/use-chained-callback.js +1 -1
- package/dist/_internal/hooks/use-debounced-value.js +1 -1
- package/dist/_internal/hooks/use-deprecation-warning.js +1 -1
- package/dist/_internal/hooks/use-event.js +1 -1
- package/dist/_internal/hooks/use-is-first-render.js +1 -1
- package/dist/_internal/hooks/use-sync-ref.js +1 -1
- package/dist/_internal/hooks/use-timer/timer.js +1 -1
- package/dist/_internal/hooks/use-timer/use-timer.js +1 -1
- package/dist/_internal/hooks/use-warn.js +1 -1
- package/dist/components/Block.js +1 -1
- package/dist/components/CollectionItem.js +1 -1
- package/dist/components/GlobalStyles.js +1 -1
- package/dist/components/GridProvider.js +1 -1
- package/dist/components/HiddenInput.js +1 -1
- package/dist/components/Root.js +4 -5
- package/dist/components/Root.js.map +1 -1
- package/dist/components/actions/Action/Action.js +1 -1
- package/dist/components/actions/Banner/Banner.js +1 -1
- package/dist/components/actions/Button/Button.js +1 -1
- package/dist/components/actions/ButtonGroup/ButtonGroup.js +1 -1
- package/dist/components/actions/ButtonSplit/ButtonSplit.js +1 -1
- package/dist/components/actions/ButtonSplit/context.js +1 -1
- package/dist/components/actions/CommandMenu/CommandMenu.js +1 -1
- package/dist/components/actions/CommandMenu/styled.js +1 -1
- package/dist/components/actions/ItemAction/ItemAction.js +1 -1
- package/dist/components/actions/ItemActionContext.js +1 -1
- package/dist/components/actions/ItemButton/ItemButton.js +1 -1
- package/dist/components/actions/Link/Link.js +1 -1
- package/dist/components/actions/Menu/Menu.js +1 -1
- package/dist/components/actions/Menu/MenuItem.js +1 -1
- package/dist/components/actions/Menu/MenuSection.js +1 -1
- package/dist/components/actions/Menu/MenuTrigger.js +1 -1
- package/dist/components/actions/Menu/SubMenuTrigger.js +1 -1
- package/dist/components/actions/Menu/SubmenuTriggerContext.js +1 -1
- package/dist/components/actions/Menu/context.js +1 -1
- package/dist/components/actions/Menu/styled.js +1 -1
- package/dist/components/actions/index.js +1 -1
- package/dist/components/actions/use-action.js +1 -1
- package/dist/components/actions/use-anchored-menu.js +1 -1
- package/dist/components/actions/use-context-menu.js +1 -1
- package/dist/components/content/ActiveZone/ActiveZone.js +1 -1
- package/dist/components/content/Alert/Alert.js +1 -1
- package/dist/components/content/Alert/use-alert.js +1 -1
- package/dist/components/content/Avatar/Avatar.js +1 -1
- package/dist/components/content/Badge/Badge.js +1 -1
- package/dist/components/content/Card/Card.js +1 -1
- package/dist/components/content/Content.js +1 -1
- package/dist/components/content/CopyPasteBlock/CopyPasteBlock.js +1 -1
- package/dist/components/content/CopySnippet/CopySnippet.js +1 -1
- package/dist/components/content/Disclosure/Disclosure.js +1 -1
- package/dist/components/content/Divider.js +1 -1
- package/dist/components/content/Footer.js +1 -1
- package/dist/components/content/Header.js +1 -1
- package/dist/components/content/HotKeys/HotKeys.js +1 -1
- package/dist/components/content/InfoBadge/InfoBadge.js +1 -1
- package/dist/components/content/InlineInput/InlineInput.js +1 -1
- package/dist/components/content/Item/Item.js +1 -1
- package/dist/components/content/ItemBadge/ItemBadge.js +1 -1
- package/dist/components/content/ItemCard/ItemCard.js +1 -1
- package/dist/components/content/Layout/GridLayout.js +1 -1
- package/dist/components/content/Layout/Layout.js +1 -1
- package/dist/components/content/Layout/LayoutBlock.js +1 -1
- package/dist/components/content/Layout/LayoutCenter.js +1 -1
- package/dist/components/content/Layout/LayoutContainer.js +1 -1
- package/dist/components/content/Layout/LayoutContent.js +1 -1
- package/dist/components/content/Layout/LayoutContext.js +1 -1
- package/dist/components/content/Layout/LayoutFlex.js +1 -1
- package/dist/components/content/Layout/LayoutFooter.js +1 -1
- package/dist/components/content/Layout/LayoutGrid.js +1 -1
- package/dist/components/content/Layout/LayoutHeader.js +1 -1
- package/dist/components/content/Layout/LayoutPane.js +1 -1
- package/dist/components/content/Layout/LayoutPanel.js +1 -1
- package/dist/components/content/Layout/LayoutPanelHeader.js +1 -1
- package/dist/components/content/Layout/LayoutToolbar.js +1 -1
- package/dist/components/content/Layout/hooks/useTinyScrollbar.js +1 -1
- package/dist/components/content/Layout/index.js +1 -1
- package/dist/components/content/Layout/utils.js +1 -1
- package/dist/components/content/Paragraph.js +1 -1
- package/dist/components/content/Placeholder/Placeholder.js +1 -1
- package/dist/components/content/PrismCode/PrismCode.js +1 -1
- package/dist/components/content/PrismCode/prismSetup.js +1 -1
- package/dist/components/content/PrismDiffCode/PrismDiffCode.js +1 -1
- package/dist/components/content/Result/Result.js +1 -1
- package/dist/components/content/Skeleton/Skeleton.js +1 -1
- package/dist/components/content/Tag/Tag.js +1 -1
- package/dist/components/content/Text.d.ts +14 -14
- package/dist/components/content/Text.js +1 -1
- package/dist/components/content/TextItem/TextItem.js +1 -1
- package/dist/components/content/Title.js +1 -1
- package/dist/components/content/Tree/Tree.js +1 -1
- package/dist/components/content/Tree/TreeNode.js +1 -1
- package/dist/components/content/Tree/styled.js +1 -1
- package/dist/components/content/Tree/tree-index.js +1 -1
- package/dist/components/content/Tree/use-checkbox-tree.js +1 -1
- package/dist/components/content/Tree/use-load-data.js +1 -1
- package/dist/components/content/highlightText.js +1 -1
- package/dist/components/content/use-auto-tooltip.js +1 -1
- package/dist/components/data/DataTable/DataTable.js +1 -1
- package/dist/components/data/ItemTable/ItemTable.js +1 -1
- package/dist/components/data/ItemTable/ItemTableBulkBar.js +1 -1
- package/dist/components/data/ItemTable/ItemTableDragPreview.js +1 -1
- package/dist/components/data/ItemTable/ItemTableFooter.js +1 -1
- package/dist/components/data/ItemTable/ItemTableToolbar.js +1 -1
- package/dist/components/data/TableBase/ColumnResizer.js +1 -1
- package/dist/components/data/TableBase/RowCollection.js +1 -1
- package/dist/components/data/TableBase/TableHeaderCell.js +1 -1
- package/dist/components/data/TableBase/TableRow.js +1 -1
- package/dist/components/data/TableBase/TableView.js +1 -1
- package/dist/components/data/TableBase/column-menu.js +1 -1
- package/dist/components/data/TableBase/column-tint.js +1 -1
- package/dist/components/data/TableBase/row-menu.js +1 -1
- package/dist/components/data/TableBase/styled.js +1 -1
- package/dist/components/data/TableBase/table-tree.js +1 -1
- package/dist/components/data/TableBase/types.js +1 -1
- package/dist/components/data/TableBase/use-cell-selection.js +0 -0
- package/dist/components/data/TableBase/use-column-order.js +1 -1
- package/dist/components/data/TableBase/use-container-width.js +1 -1
- package/dist/components/data/TableBase/use-row-move-animation.js +1 -1
- package/dist/components/data/TableBase/use-scrollability.js +1 -1
- package/dist/components/data/TableBase/use-table-columns.js +1 -1
- package/dist/components/data/TableBase/use-table-search.js +1 -1
- package/dist/components/data/TableBase/use-table-selection.js +1 -1
- package/dist/components/data/TableBase/use-table-sort.js +1 -1
- package/dist/components/data/TableBase/use-table-sorts.js +1 -1
- package/dist/components/data/TableBase/use-table-storage.js +1 -1
- package/dist/components/data/TableBase/use-table-tree-state.js +1 -1
- package/dist/components/fields/Checkbox/Checkbox.js +1 -1
- package/dist/components/fields/Checkbox/CheckboxGroup.js +1 -1
- package/dist/components/fields/Checkbox/context.js +1 -1
- package/dist/components/fields/ColorInput/ColorInput.js +1 -1
- package/dist/components/fields/ColorPicker/ColorPicker.js +1 -1
- package/dist/components/fields/ColorSwatch/ColorSwatch.js +1 -1
- package/dist/components/fields/ColorSwatchGroup/ColorSwatchGroup.js +1 -1
- package/dist/components/fields/ComboBox/ComboBox.js +1 -1
- package/dist/components/fields/CommandTextArea/CommandTextArea.js +1 -1
- package/dist/components/fields/CommandTextArea/caretPosition.js +1 -1
- package/dist/components/fields/CommandTextArea/useCaretAnchor.js +1 -1
- package/dist/components/fields/DatePicker/DateInput.js +1 -1
- package/dist/components/fields/DatePicker/DateInputBase.js +1 -1
- package/dist/components/fields/DatePicker/DatePicker.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerButton.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerElement.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerInput.js +1 -1
- package/dist/components/fields/DatePicker/DatePickerSegment.js +1 -1
- package/dist/components/fields/DatePicker/DateRangePicker.js +1 -1
- package/dist/components/fields/DatePicker/DateRangeSeparatedPicker.js +1 -1
- package/dist/components/fields/DatePicker/MonthPicker.js +1 -1
- package/dist/components/fields/DatePicker/PeriodPicker.js +1 -1
- package/dist/components/fields/DatePicker/QuarterPicker.js +1 -1
- package/dist/components/fields/DatePicker/TimeInput.js +1 -1
- package/dist/components/fields/DatePicker/WeekPicker.js +1 -1
- package/dist/components/fields/DatePicker/YearPicker.js +1 -1
- package/dist/components/fields/DatePicker/parseDate.js +1 -1
- package/dist/components/fields/DatePicker/period.js +1 -1
- package/dist/components/fields/DatePicker/props.js +1 -1
- package/dist/components/fields/DatePicker/utils.js +1 -1
- package/dist/components/fields/FileInput/FileInput.js +1 -1
- package/dist/components/fields/FilterListBox/FilterListBox.js +1 -1
- package/dist/components/fields/FilterPicker/FilterPicker.js +1 -1
- package/dist/components/fields/Input/Input.js +1 -1
- package/dist/components/fields/ListBox/DraggableListBox.js +1 -1
- package/dist/components/fields/ListBox/ListBox.js +1 -1
- package/dist/components/fields/ListBoxPopover/ListBoxPopover.js +1 -1
- package/dist/components/fields/ListBoxPopover/listNavigation.js +1 -1
- package/dist/components/fields/ListBoxPopover/useCompositeFocus.js +1 -1
- package/dist/components/fields/NumberInput/NumberInput.js +1 -1
- package/dist/components/fields/NumberInput/StepButton.js +1 -1
- package/dist/components/fields/PasswordInput/PasswordInput.js +1 -1
- package/dist/components/fields/Picker/Picker.js +1 -1
- package/dist/components/fields/RadioGroup/Radio.js +1 -1
- package/dist/components/fields/RadioGroup/RadioGroup.js +1 -1
- package/dist/components/fields/RadioGroup/context.js +1 -1
- package/dist/components/fields/SearchComboBox/SearchComboBox.js +1 -1
- package/dist/components/fields/SearchInput/SearchInput.js +1 -1
- package/dist/components/fields/Select/Select.js +1 -1
- package/dist/components/fields/Slider/Gradation.js +1 -1
- package/dist/components/fields/Slider/HueSlider.js +1 -1
- package/dist/components/fields/Slider/RangeSlider.js +1 -1
- package/dist/components/fields/Slider/Slider.js +1 -1
- package/dist/components/fields/Slider/SliderBase.js +1 -1
- package/dist/components/fields/Slider/SliderThumb.js +1 -1
- package/dist/components/fields/Slider/SliderTrack.js +1 -1
- package/dist/components/fields/Slider/elements.js +1 -1
- package/dist/components/fields/Slider/index.js +1 -1
- package/dist/components/fields/Switch/Switch.js +1 -1
- package/dist/components/fields/TextArea/TextArea.js +1 -1
- package/dist/components/fields/TextInput/TextInput.js +1 -1
- package/dist/components/fields/TextInput/TextInputBase.js +1 -1
- package/dist/components/fields/TextInput/useAutoSizeTextArea.js +1 -1
- package/dist/components/fields/TextInputMapper/TextInputMapper.js +1 -1
- package/dist/components/fields/color/ColorPanel.js +1 -1
- package/dist/components/fields/color/channels.js +1 -1
- package/dist/components/fields/color/color.js +1 -1
- package/dist/components/fields/color/context.js +1 -1
- package/dist/components/form/FieldWrapper/FieldWrapper.js +1 -1
- package/dist/components/form/Form/Field.js +1 -1
- package/dist/components/form/Form/Form.js +1 -1
- package/dist/components/form/Form/ResetButton/ResetButton.js +1 -1
- package/dist/components/form/Form/SubmitButton/SubmitButton.js +1 -1
- package/dist/components/form/Form/SubmitError.js +1 -1
- package/dist/components/form/Form/index.js +1 -1
- package/dist/components/form/Form/use-field/use-field-props.js +1 -1
- package/dist/components/form/Form/use-field/use-field.js +1 -1
- package/dist/components/form/Form/use-form.js +1 -1
- package/dist/components/form/Form/validation.js +1 -1
- package/dist/components/form/Label.js +1 -1
- package/dist/components/form/validation/ValidationIndicator.js +1 -1
- package/dist/components/form/validation/resolve-validation-props.js +1 -1
- package/dist/components/form/validation/use-validation-props.js +1 -1
- package/dist/components/form/wrapper.js +1 -1
- package/dist/components/helpers/DisplayTransition/DisplayTransition.js +1 -1
- package/dist/components/helpers/IconSwitch/IconSwitch.js +1 -1
- package/dist/components/layout/Board/Board.js +1 -1
- package/dist/components/layout/Board/BoardProvider.js +1 -1
- package/dist/components/layout/Board/BoardResponsive.js +1 -1
- package/dist/components/layout/Board/Widget.js +1 -1
- package/dist/components/layout/Board/WidgetHost.js +1 -1
- package/dist/components/layout/Board/board-context.js +1 -1
- package/dist/components/layout/Board/board-store.js +1 -1
- package/dist/components/layout/Board/grid-core/calculate.js +1 -1
- package/dist/components/layout/Board/grid-core/collision-modes.js +1 -1
- package/dist/components/layout/Board/grid-core/collision.js +1 -1
- package/dist/components/layout/Board/grid-core/compactors.js +1 -1
- package/dist/components/layout/Board/grid-core/constraints.js +1 -1
- package/dist/components/layout/Board/grid-core/group-move.js +1 -1
- package/dist/components/layout/Board/grid-core/layout.js +1 -1
- package/dist/components/layout/Board/grid-core/sort.js +1 -1
- package/dist/components/layout/Board/index.js +1 -1
- package/dist/components/layout/Board/responsive-utils.js +1 -1
- package/dist/components/layout/Board/use-board-layout.js +1 -1
- package/dist/components/layout/Board/use-board-registry.js +1 -1
- package/dist/components/layout/Board/use-board-select-modifier-key.js +1 -1
- package/dist/components/layout/Board/use-board-selection.js +1 -1
- package/dist/components/layout/Flex.js +1 -1
- package/dist/components/layout/Flow.js +1 -1
- package/dist/components/layout/Grid.js +1 -1
- package/dist/components/layout/Panel.js +1 -1
- package/dist/components/layout/Prefix.js +1 -1
- package/dist/components/layout/ResizablePanel.js +1 -1
- package/dist/components/layout/Space.js +1 -1
- package/dist/components/layout/Suffix.js +1 -1
- package/dist/components/navigation/Pagination/Pagination.js +1 -1
- package/dist/components/navigation/Pagination/use-pagination.js +1 -1
- package/dist/components/navigation/Tabs/DraggableTabList.js +1 -1
- package/dist/components/navigation/Tabs/TabButton.js +1 -1
- package/dist/components/navigation/Tabs/TabDropIndicator.js +1 -1
- package/dist/components/navigation/Tabs/TabPanel.js +1 -1
- package/dist/components/navigation/Tabs/TabPicker.js +1 -1
- package/dist/components/navigation/Tabs/Tabs.js +1 -1
- package/dist/components/navigation/Tabs/TabsAction.js +1 -1
- package/dist/components/navigation/Tabs/TabsContext.js +1 -1
- package/dist/components/navigation/Tabs/popover-placement.js +1 -1
- package/dist/components/navigation/Tabs/styled.js +1 -1
- package/dist/components/navigation/Tabs/types.js +1 -1
- package/dist/components/navigation/Tabs/use-tab-editing.js +1 -1
- package/dist/components/navigation/Tabs/use-tab-indicator.js +1 -1
- package/dist/components/organisms/StatsCard/StatsCard.js +1 -1
- package/dist/components/other/Calendar/Calendar.js +1 -1
- package/dist/components/other/Calendar/CalendarCell.js +1 -1
- package/dist/components/other/Calendar/CalendarGrid.js +1 -1
- package/dist/components/other/Calendar/CalendarHeader.js +1 -1
- package/dist/components/other/Calendar/CalendarPanel.js +1 -1
- package/dist/components/other/Calendar/PeriodCalendar.js +1 -1
- package/dist/components/other/Calendar/PeriodGrid.js +1 -1
- package/dist/components/other/Calendar/RangeCalendar.js +1 -1
- package/dist/components/other/Calendar/styled.js +1 -1
- package/dist/components/other/CubeLogo/CubeLogo.js +1 -1
- package/dist/components/other/NoDataIcon/NoDataIcon.js +1 -1
- package/dist/components/overlays/AlertDialog/AlertDialog.js +1 -1
- package/dist/components/overlays/AlertDialog/AlertDialogApiProvider.js +1 -1
- package/dist/components/overlays/AlertDialog/AlertDialogZone.js +1 -1
- package/dist/components/overlays/Dialog/Dialog.js +1 -1
- package/dist/components/overlays/Dialog/DialogContainer.js +1 -1
- package/dist/components/overlays/Dialog/DialogForm.js +1 -1
- package/dist/components/overlays/Dialog/DialogTrigger.js +1 -1
- package/dist/components/overlays/Dialog/context.js +1 -1
- package/dist/components/overlays/Dialog/use-dialog-container.js +1 -1
- package/dist/components/overlays/Modal/Modal.js +1 -1
- package/dist/components/overlays/Modal/OpenTransitionContext.js +1 -1
- package/dist/components/overlays/Modal/Overlay.js +3 -4
- package/dist/components/overlays/Modal/Overlay.js.map +1 -1
- package/dist/components/overlays/Modal/Popover.js +1 -1
- package/dist/components/overlays/Modal/Tray.js +1 -1
- package/dist/components/overlays/Modal/Underlay.js +1 -1
- package/dist/components/overlays/Notifications/Notification.js +1 -1
- package/dist/components/overlays/Notifications/NotificationAction.js +1 -1
- package/dist/components/overlays/Notifications/NotificationCard.js +1 -1
- package/dist/components/overlays/Notifications/NotificationContext.js +1 -1
- package/dist/components/overlays/Notifications/NotificationItem.js +1 -1
- package/dist/components/overlays/Notifications/OverlayContainer.js +1 -1
- package/dist/components/overlays/Notifications/OverlayProvider.js +1 -1
- package/dist/components/overlays/Notifications/PersistentNotificationsList.js +1 -1
- package/dist/components/overlays/Notifications/dismissed-storage.js +1 -1
- package/dist/components/overlays/Notifications/format-relative-time.js +1 -1
- package/dist/components/overlays/Notifications/index.js +1 -1
- package/dist/components/overlays/Notifications/use-notification-state.js +1 -1
- package/dist/components/overlays/Notifications/use-notifications.js +1 -1
- package/dist/components/overlays/Notifications/use-overlay-timers.js +1 -1
- package/dist/components/overlays/Notifications/use-persistent-notifications.js +1 -1
- package/dist/components/overlays/Notifications/use-persistent-state.js +1 -1
- package/dist/components/overlays/Notifications/use-toast-state.js +1 -1
- package/dist/components/overlays/Toast/ToastItem.js +1 -1
- package/dist/components/overlays/Toast/index.js +1 -1
- package/dist/components/overlays/Toast/useProgressToast.js +1 -1
- package/dist/components/overlays/Toast/useToast.js +1 -1
- package/dist/components/overlays/Tooltip/Tooltip.js +1 -1
- package/dist/components/overlays/Tooltip/TooltipProvider.js +1 -1
- package/dist/components/overlays/Tooltip/TooltipTrigger.js +1 -1
- package/dist/components/overlays/Tooltip/context.js +1 -1
- package/dist/components/portal/Portal.js +5 -7
- package/dist/components/portal/Portal.js.map +1 -1
- package/dist/components/portal/PortalProvider.js +1 -1
- package/dist/components/portal/usePortal.js +1 -1
- package/dist/components/shared/DraggableCollection.js +1 -1
- package/dist/components/shared/InvalidIcon.js +1 -1
- package/dist/components/shared/ValidIcon.js +1 -1
- package/dist/components/status/LoadingAnimation/LoadingAnimation.js +1 -1
- package/dist/components/status/Spin/Cube.js +1 -1
- package/dist/components/status/Spin/InternalSpinner.js +1 -1
- package/dist/components/status/Spin/Spin.js +1 -1
- package/dist/components/status/Spin/SpinsContainer.js +1 -1
- package/dist/data/item-themes.js +1 -1
- package/dist/data/themes.js +1 -1
- package/dist/eslint-plugin/defaults.generated.js +13 -1
- package/dist/eslint-plugin/defaults.generated.js.map +1 -1
- package/dist/eslint-plugin/index.js +1 -1
- package/dist/eslint-plugin/rules/no-redundant-default-prop.js +1 -1
- package/dist/i18n/I18nProvider.js +1 -1
- package/dist/i18n/createFormatter.js +1 -1
- package/dist/i18n/index.js +1 -1
- package/dist/i18n/instance.js +1 -1
- package/dist/i18n/locales/de-DE/uikit.js +1 -1
- package/dist/i18n/locales/en-US/uikit.js +1 -1
- package/dist/i18n/locales/es-ES/uikit.js +1 -1
- package/dist/i18n/locales/es-MX/uikit.js +1 -1
- package/dist/i18n/locales/fr-FR/uikit.js +1 -1
- package/dist/i18n/locales/it-IT/uikit.js +1 -1
- package/dist/i18n/locales/ja-JP/uikit.js +1 -1
- package/dist/i18n/locales/nb-NO/uikit.js +1 -1
- package/dist/i18n/locales/pt-BR/uikit.js +1 -1
- package/dist/i18n/locales/pt-PT/uikit.js +1 -1
- package/dist/i18n/locales/sv-SE/uikit.js +1 -1
- package/dist/i18n/locales/vi-VN/uikit.js +1 -1
- package/dist/i18n/locales.js +1 -1
- package/dist/i18n/useFormatter.js +1 -1
- package/dist/i18n/useI18n.js +1 -1
- package/dist/icons/AdjustmentsHorizontalIcon.js +1 -1
- package/dist/icons/AdjustmentsIcon.js +1 -1
- package/dist/icons/AiIcon.js +1 -1
- package/dist/icons/AreaChartIcon.js +1 -1
- package/dist/icons/ArrowNarrowDownIcon.js +1 -1
- package/dist/icons/ArrowNarrowUpIcon.js +1 -1
- package/dist/icons/BackwardIcon.js +1 -1
- package/dist/icons/BarChartIcon.js +1 -1
- package/dist/icons/BellFilledIcon.js +1 -1
- package/dist/icons/BellIcon.js +1 -1
- package/dist/icons/BooleanIcon.js +1 -1
- package/dist/icons/CalendarEditIcon.js +1 -1
- package/dist/icons/CalendarIcon.js +1 -1
- package/dist/icons/CaretDownIcon.js +1 -1
- package/dist/icons/CaretUpIcon.js +1 -1
- package/dist/icons/ChartAreaStackedIcon.js +1 -1
- package/dist/icons/ChartAreaStackedPercentageIcon.js +1 -1
- package/dist/icons/ChartBarGroupedHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarGroupedIcon.js +1 -1
- package/dist/icons/ChartBarHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarLineIcon.js +1 -1
- package/dist/icons/ChartBarStackedHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarStackedIcon.js +1 -1
- package/dist/icons/ChartBarStackedPercentageHorizontalIcon.js +1 -1
- package/dist/icons/ChartBarStackedPercentageIcon.js +1 -1
- package/dist/icons/ChartBoxPlot2Icon.js +1 -1
- package/dist/icons/ChartBoxPlotIcon.js +1 -1
- package/dist/icons/ChartBubbleIcon.js +1 -1
- package/dist/icons/ChartDonut2Icon.js +1 -1
- package/dist/icons/ChartFunnelIcon.js +1 -1
- package/dist/icons/ChartHeatmapIcon.js +1 -1
- package/dist/icons/ChartKPIIcon.js +1 -1
- package/dist/icons/ChartPie2Icon.js +1 -1
- package/dist/icons/ChartScatterIcon.js +1 -1
- package/dist/icons/CheckCircleFilledIcon.js +1 -1
- package/dist/icons/CheckCircleIcon.js +1 -1
- package/dist/icons/CheckIcon.js +1 -1
- package/dist/icons/CircleFilledIcon.js +1 -1
- package/dist/icons/ClearIcon.js +1 -1
- package/dist/icons/CloseCircleFilledIcon.js +1 -1
- package/dist/icons/CloseCircleIcon.js +1 -1
- package/dist/icons/CloseIcon.js +1 -1
- package/dist/icons/CodeIcon.js +1 -1
- package/dist/icons/ColumnTotalIcon.js +1 -1
- package/dist/icons/CopyIcon.js +1 -1
- package/dist/icons/CountIcon.js +1 -1
- package/dist/icons/CubeIcon.js +1 -1
- package/dist/icons/CubePauseIcon.js +1 -1
- package/dist/icons/CubePlayIcon.js +1 -1
- package/dist/icons/CurrencyDollarIcon.js +1 -1
- package/dist/icons/DangerIcon.js +1 -1
- package/dist/icons/DashboardIcon.js +1 -1
- package/dist/icons/DatabaseIcon.js +1 -1
- package/dist/icons/DecimalDecreaseIcon.js +1 -1
- package/dist/icons/DecimalIncreaseIcon.js +1 -1
- package/dist/icons/DirectionIcon.js +1 -1
- package/dist/icons/DonutIcon.js +1 -1
- package/dist/icons/DownIcon.js +1 -1
- package/dist/icons/EditIcon.js +1 -1
- package/dist/icons/ExclamationCircleFilledIcon.js +1 -1
- package/dist/icons/ExclamationCircleIcon.js +1 -1
- package/dist/icons/ExclamationIcon.js +1 -1
- package/dist/icons/EyeIcon.js +1 -1
- package/dist/icons/EyeInvisibleIcon.js +1 -1
- package/dist/icons/FilterIcon.js +1 -1
- package/dist/icons/FolderFilledIcon.js +1 -1
- package/dist/icons/FolderIcon.js +1 -1
- package/dist/icons/FolderOpenFilledIcon.js +1 -1
- package/dist/icons/FolderOpenIcon.js +1 -1
- package/dist/icons/ForwardIcon.js +1 -1
- package/dist/icons/GripVerticalIcon.js +1 -1
- package/dist/icons/HierarchyIcon.js +1 -1
- package/dist/icons/HierarchyOpenIcon.js +1 -1
- package/dist/icons/Icon.js +1 -1
- package/dist/icons/InfoCircleIcon.js +1 -1
- package/dist/icons/InfoIcon.js +1 -1
- package/dist/icons/KeyIcon.js +1 -1
- package/dist/icons/LeftIcon.js +1 -1
- package/dist/icons/LineChartIcon.js +1 -1
- package/dist/icons/LoadingIcon.js +1 -1
- package/dist/icons/LockFilledIcon.js +1 -1
- package/dist/icons/LockIcon.js +1 -1
- package/dist/icons/MoreIcon.js +1 -1
- package/dist/icons/NotAllowedIcon.js +1 -1
- package/dist/icons/Number123Icon.js +1 -1
- package/dist/icons/NumberIcon.js +1 -1
- package/dist/icons/PauseCircleFilledIcon.js +1 -1
- package/dist/icons/PauseCircleIcon.js +1 -1
- package/dist/icons/PauseIcon.js +1 -1
- package/dist/icons/PercentageIcon.js +1 -1
- package/dist/icons/PieChartIcon.js +1 -1
- package/dist/icons/PipetteIcon.js +1 -1
- package/dist/icons/PlayCircleIcon.js +1 -1
- package/dist/icons/PlayIcon.js +1 -1
- package/dist/icons/PlusIcon.js +1 -1
- package/dist/icons/ProgressBarIcon.js +1 -1
- package/dist/icons/ReloadIcon.js +1 -1
- package/dist/icons/ReportIcon.js +1 -1
- package/dist/icons/ReturnIcon.js +1 -1
- package/dist/icons/RightIcon.js +1 -1
- package/dist/icons/RowTotalsIcon.js +1 -1
- package/dist/icons/SchemeIcon.js +1 -1
- package/dist/icons/SearchIcon.js +1 -1
- package/dist/icons/SemanticQueryIcon.js +1 -1
- package/dist/icons/SettingsIcon.js +1 -1
- package/dist/icons/ShieldFilledIcon.js +1 -1
- package/dist/icons/ShieldIcon.js +1 -1
- package/dist/icons/SlashIcon.js +1 -1
- package/dist/icons/SparklesIcon.js +1 -1
- package/dist/icons/SqlIcon.js +1 -1
- package/dist/icons/StatsIcon.js +1 -1
- package/dist/icons/StopIcon.js +1 -1
- package/dist/icons/StringIcon.js +1 -1
- package/dist/icons/SubtotalsIcon.js +1 -1
- package/dist/icons/SwitchIcon.js +1 -1
- package/dist/icons/TableIcon.js +1 -1
- package/dist/icons/ThumbsDownIcon.js +1 -1
- package/dist/icons/ThumbsUpIcon.js +1 -1
- package/dist/icons/ThunderboltCrossedIcon.js +1 -1
- package/dist/icons/ThunderboltFilledIcon.js +1 -1
- package/dist/icons/ThunderboltIcon.js +1 -1
- package/dist/icons/TimeIcon.js +1 -1
- package/dist/icons/TrashIcon.js +1 -1
- package/dist/icons/UnlockIcon.js +1 -1
- package/dist/icons/UpIcon.js +1 -1
- package/dist/icons/UserGroupIcon.js +1 -1
- package/dist/icons/UserIcon.js +1 -1
- package/dist/icons/UserLockIcon.js +1 -1
- package/dist/icons/ViewIcon.js +1 -1
- package/dist/icons/WarningFilledIcon.js +1 -1
- package/dist/icons/WarningIcon.js +1 -1
- package/dist/icons/wrap-icon.js +1 -1
- package/dist/index.js +1 -1
- package/dist/probe/canonicalize.js +1 -1
- package/dist/probe/css.js +1 -1
- package/dist/probe/index.js +1 -1
- package/dist/provider.js +1 -1
- package/dist/providers/TrackingProvider.js +1 -1
- package/dist/providers/navigationAdapter.default.js +1 -1
- package/dist/tokens/base.js +1 -1
- package/dist/tokens/color-seed.js +1 -1
- package/dist/tokens/color-theme.js +1 -1
- package/dist/tokens/colors.js +1 -1
- package/dist/tokens/index.js +1 -1
- package/dist/tokens/layout.js +1 -1
- package/dist/tokens/lazy-styles.js +1 -1
- package/dist/tokens/palette-config.js +1 -1
- package/dist/tokens/palette.js +1 -1
- package/dist/tokens/shadows.js +1 -1
- package/dist/tokens/sizes.js +1 -1
- package/dist/tokens/spacing.js +1 -1
- package/dist/tokens/typography.js +1 -1
- package/dist/utils/ResizeSensor.js +1 -1
- package/dist/utils/is-dev-env.js +1 -1
- package/dist/utils/modules.js +1 -1
- package/dist/utils/promise.js +1 -1
- package/dist/utils/raf.js +1 -1
- package/dist/utils/random.js +1 -1
- package/dist/utils/range.js +1 -1
- package/dist/utils/react/RenderCache.js +1 -1
- package/dist/utils/react/Slots.js +1 -1
- package/dist/utils/react/chain.js +1 -1
- package/dist/utils/react/disabledProps.js +1 -1
- package/dist/utils/react/forwardRefWithGenerics.js +1 -1
- package/dist/utils/react/index.js +1 -1
- package/dist/utils/react/interactions.js +1 -1
- package/dist/utils/react/isTextOnly.js +1 -1
- package/dist/utils/react/mapProps.js +1 -1
- package/dist/utils/react/mergeProps.js +1 -1
- package/dist/utils/react/nullableValue.js +1 -1
- package/dist/utils/react/resolveIcon.js +1 -1
- package/dist/utils/react/sharedStore.js +1 -1
- package/dist/utils/react/useBufferedValue.js +1 -1
- package/dist/utils/react/useCombinedRefs.js +1 -1
- package/dist/utils/react/useControlledFocusVisible.js +1 -1
- package/dist/utils/react/useEventBus.js +1 -1
- package/dist/utils/react/useId.js +1 -1
- package/dist/utils/react/useIsDarwin.js +1 -1
- package/dist/utils/react/useKeySymbols.js +1 -1
- package/dist/utils/react/useLayoutEffect.d.ts +1 -1
- package/dist/utils/react/useLayoutEffect.js +1 -1
- package/dist/utils/react/useLocalStorage.js +1 -1
- package/dist/utils/react/useMergeStyles.js +1 -1
- package/dist/utils/react/usePopoverSync.js +1 -1
- package/dist/utils/react/useQaProps.js +1 -1
- package/dist/utils/react/useViewportSize.js +1 -1
- package/dist/utils/react/wrapNodeIfPlain.js +1 -1
- package/dist/utils/selection.js +1 -1
- package/dist/utils/styles.js +1 -1
- package/dist/utils/tree.js +1 -1
- package/dist/utils/warnings.js +1 -1
- package/dist/version.js +3 -3
- package/docs/Colors.md +16 -40
- package/docs/ComplexLayout.md +8 -0
- package/docs/CreateComponent.md +15 -8
- package/docs/Introduction.md +15 -36
- package/docs/RenderCache.md +8 -6
- package/docs/Theming.md +164 -497
- package/docs/Usage.md +108 -138
- package/docs/Utilities.md +2 -2
- package/docs/components/CollectionItem.md +1 -0
- package/docs/components/actions/Banner.md +1 -0
- package/docs/components/actions/Button.md +8 -36
- package/docs/components/actions/ButtonSplit.md +2 -0
- package/docs/components/actions/CommandMenu.md +8 -8
- package/docs/components/actions/ItemButton.md +6 -20
- package/docs/components/actions/Link.md +10 -5
- package/docs/components/actions/Menu.md +24 -11
- package/docs/components/actions/MenuTrigger.md +3 -12
- package/docs/components/actions/use-anchored-menu.md +2 -2
- package/docs/components/actions/use-context-menu.md +5 -2
- package/docs/components/content/Badge.md +3 -0
- package/docs/components/content/HotKeys.md +21 -14
- package/docs/components/content/InlineInput.md +14 -14
- package/docs/components/content/Item.md +25 -17
- package/docs/components/content/ItemCard.md +1 -0
- package/docs/components/content/Layout.md +12 -1
- package/docs/components/content/PrismCode.md +13 -18
- package/docs/components/content/Tag.md +1 -1
- package/docs/components/content/TextItem.md +5 -3
- package/docs/components/content/Tree.md +69 -154
- package/docs/components/data/DataTable.md +56 -168
- package/docs/components/data/ItemTable.md +182 -485
- package/docs/components/fields/Checkbox.md +2 -0
- package/docs/components/fields/ColorInput.md +38 -79
- package/docs/components/fields/ColorPicker.md +17 -39
- package/docs/components/fields/ColorSwatch.md +11 -30
- package/docs/components/fields/ColorSwatchGroup.md +18 -42
- package/docs/components/fields/ComboBox.md +13 -1
- package/docs/components/fields/CommandTextArea.md +10 -37
- package/docs/components/fields/DatePicker.md +3 -0
- package/docs/components/fields/FileInput.md +3 -0
- package/docs/components/fields/FilterListBox.md +34 -14
- package/docs/components/fields/FilterPicker.md +33 -16
- package/docs/components/fields/HueSlider.md +5 -5
- package/docs/components/fields/ListBox.md +35 -9
- package/docs/components/fields/NumberInput.md +3 -0
- package/docs/components/fields/PasswordInput.md +3 -0
- package/docs/components/fields/PeriodPicker.md +7 -17
- package/docs/components/fields/Picker.md +54 -29
- package/docs/components/fields/RadioGroup.md +13 -5
- package/docs/components/fields/SearchComboBox.md +3 -0
- package/docs/components/fields/SearchInput.md +4 -2
- package/docs/components/fields/Select.md +23 -13
- package/docs/components/fields/Switch.md +3 -0
- package/docs/components/fields/TextInput.md +3 -0
- package/docs/components/fields/TextInputMapper.md +1 -2
- package/docs/components/form/Field.md +5 -2
- package/docs/components/form/Form.md +5 -0
- package/docs/components/form/FormInstance.md +1 -1
- package/docs/components/helpers/DisplayTransition.md +10 -6
- package/docs/components/helpers/IconSwitch.md +1 -0
- package/docs/components/layout/Board.md +50 -190
- package/docs/components/navigation/Pagination.md +36 -75
- package/docs/components/navigation/Tabs.md +3 -15
- package/docs/components/other/Calendar.md +22 -39
- package/docs/components/other/CubeLogo.md +1 -1
- package/docs/components/overlays/Dialog.md +3 -0
- package/docs/components/overlays/DialogContainer.md +2 -0
- package/docs/components/overlays/DialogForm.md +6 -2
- package/docs/components/overlays/DialogTrigger.md +4 -2
- package/docs/components/overlays/Notifications.md +7 -0
- package/docs/components/overlays/Toast.md +12 -8
- package/docs/components/overlays/Tooltip.md +6 -0
- package/docs/components/overlays/UseDialogContainer.md +16 -10
- package/docs/components/status/LoadingAnimation.md +3 -9
- package/package.json +4 -4
|
@@ -1,14 +1,8 @@
|
|
|
1
1
|
# Board
|
|
2
2
|
|
|
3
|
-
A draggable and resizable widget grid for building dashboards. Widgets are
|
|
4
|
-
declared with `Board.Widget` and positioned via a `layout` (grid units). Wrap
|
|
5
|
-
multiple boards in a `BoardProvider` (`Board.Provider`) to drag widgets between
|
|
6
|
-
them, including out of a nested board into its parent.
|
|
3
|
+
A draggable and resizable widget grid for building dashboards. Widgets are declared with `Board.Widget` and positioned via a `layout` (grid units). Wrap multiple boards in a `BoardProvider` (`Board.Provider`) to drag widgets between them, including out of a nested board into its parent.
|
|
7
4
|
|
|
8
|
-
Dragging and resizing are powered by React Aria's `useMove`, so they work with
|
|
9
|
-
mouse, touch, and keyboard (focus a widget and use the arrow keys). While a
|
|
10
|
-
widget is dragged with a pointer it renders into a fixed overlay so it is never
|
|
11
|
-
clipped by an ancestor's `overflow: hidden`.
|
|
5
|
+
Dragging and resizing are powered by React Aria's `useMove`, so they work with mouse, touch, and keyboard (focus a widget and use the arrow keys). While a widget is dragged with a pointer it renders into a fixed overlay so it is never clipped by an ancestor's `overflow: hidden`.
|
|
12
6
|
|
|
13
7
|
## When to Use
|
|
14
8
|
|
|
@@ -23,25 +17,11 @@ clipped by an ancestor's `overflow: hidden`.
|
|
|
23
17
|
|
|
24
18
|
## Concepts
|
|
25
19
|
|
|
26
|
-
- **Layout** — an array of items `{ i, x, y, w, h }` in grid units. `i` matches a
|
|
27
|
-
|
|
28
|
-
- **
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
- **Compaction** — `vertical` (default), `horizontal`, or `free`. In `free` mode a
|
|
32
|
-
widget is placed exactly where you drop it and its neighbours are never pushed
|
|
33
|
-
or swapped; without `allowOverlap` a drop onto an occupied cell is blocked, and
|
|
34
|
-
with `allowOverlap` widgets may stack for a fully free canvas.
|
|
35
|
-
- **Selection** — off by default. Pressing a widget selects it and arms a drag
|
|
36
|
-
of the selection: selecting and grabbing are one gesture, so move the pointer
|
|
37
|
-
and it drags, stay still and it was just a selection. <kbd>Shift</kbd> (or
|
|
38
|
-
<kbd>Cmd</kbd>/<kbd>Ctrl</kbd>) toggles a widget's membership. Keys are layout
|
|
39
|
-
item ids, scoped to a single board, and always reported in layout order.
|
|
40
|
-
- **Selection is focus-like** — it tracks what the user is working with, and
|
|
41
|
-
touching anything else moves it on: pressing another widget makes *that* the
|
|
42
|
-
selection, pressing a control inside a widget drops it, and so does focus
|
|
43
|
-
leaving the board. With `'multiple'`, pressing an already-selected widget
|
|
44
|
-
keeps the selection so a drag moves the whole block.
|
|
20
|
+
- **Layout** — an array of items `{ i, x, y, w, h }` in grid units. `i` matches a `Board.Widget` `id`.
|
|
21
|
+
- **Content vs. position** — `Board.Widget` declares content; the owning `Board` positions it. This decoupling is what lets a widget be transferred between boards.
|
|
22
|
+
- **Compaction** — `vertical` (default), `horizontal`, or `free`. In `free` mode a widget is placed exactly where you drop it and its neighbours are never pushed or swapped; without `allowOverlap` a drop onto an occupied cell is blocked, and with `allowOverlap` widgets may stack for a fully free canvas.
|
|
23
|
+
- **Selection** — off by default. Pressing a widget selects it and arms a drag of the selection: selecting and grabbing are one gesture, so move the pointer and it drags, stay still and it was just a selection. <kbd>Shift</kbd> (or <kbd>Cmd</kbd>/<kbd>Ctrl</kbd>) toggles a widget's membership. Keys are layout item ids, scoped to a single board, and always reported in layout order.
|
|
24
|
+
- **Selection is focus-like** — it tracks what the user is working with, and touching anything else moves it on: pressing another widget makes _that_ the selection, pressing a control inside a widget drops it, and so does focus leaving the board. With `'multiple'`, pressing an already-selected widget keeps the selection so a drag moves the whole block.
|
|
45
25
|
|
|
46
26
|
## Properties
|
|
47
27
|
|
|
@@ -61,21 +41,21 @@ clipped by an ancestor's `overflow: hidden`.
|
|
|
61
41
|
- **`compact`** `'vertical' | 'horizontal' | 'free' | null` (default: `'vertical'`) — Compaction behavior. `'vertical'`/`'horizontal'` reflow widgets to remove gaps; `'free'` places each widget exactly where dropped and never pushes its neighbours (blocked from occupied cells unless `allowOverlap`); `null` disables compaction but still resolves collisions the legacy react-grid-layout way.
|
|
62
42
|
- **`allowOverlap`** `boolean` (default: `false`) — Allow widgets to overlap (stack). In `'free'` mode this is what distinguishes stacking from blocking a drop onto an occupied cell.
|
|
63
43
|
- **`preventCollision`** `boolean` (default: `false`) — Block movement into occupied cells instead of pushing.
|
|
64
|
-
- **`collisionMode`** `'revert' | 'downscale' | 'swap'` (default: `'revert'`) — How to resolve a drop the grid would otherwise refuse. Only applies where a collision
|
|
44
|
+
- **`collisionMode`** `'revert' | 'downscale' | 'swap'` (default: `'revert'`) — How to resolve a drop the grid would otherwise refuse. Only applies where a collision _blocks_ a move — `compact="free"` (which prevents collisions) or an explicit `preventCollision` — and never under `allowOverlap`, where nothing is blocked. `'revert'` snaps the widget back. `'downscale'` shrinks it into the free space at the drop cell, growing rightward and downward, floored at its `minW`/`minH` (below that it reverts). Within one board, `'swap'` trades places with **one** widget — the one the drop covers most — which takes the cell the drag began at, each keeping as much of its own size as fits there. It never displaces more than that one widget. A drop straddling two widgets trades with one of them rather than refusing, so the swap never blinks away as you sweep across a boundary; ties go to the widget earlier in reading order. Dragging back retraces the original arrangement exactly. For a widget arriving from another board (including a nested board entering its parent), the destination board's `'swap'` mode becomes strict insertion: the requested anchor cell must be empty, the incoming widget keeps its size when possible or downscales into the available room to its right and below, and existing destination widgets are neither exchanged nor reflowed. Releasing over an occupied anchor or where `minW`/`minH` cannot fit cancels the transfer and restores both boards; it does not reuse the last valid preview or search for another slot. No mode ever _grows_ a widget. Applies to single-widget drags. Arrow keys honour it too but never resize anything — each press is a gesture of its own, so a press that shrank a widget would have nothing to restore from, and only an exchange that fits outright is allowed. A multi-widget selection still only moves where it fits outright, and a resize is still blocked by a collision.
|
|
65
45
|
- **`isDraggable`** `boolean` (default: `true`) — Enable dragging for all widgets.
|
|
66
46
|
- **`isResizable`** `boolean` (default: `true`) — Enable resizing for all widgets.
|
|
67
47
|
- **`isDroppable`** `boolean` (default: `true`) — Whether the board accepts widgets dropped from other boards.
|
|
68
48
|
- **`resizeHandles`** `ResizeHandleAxis[]` (default: `['se']`) — Which resize handles to show. Corner handles (`ne`/`nw`/`se`/`sw`) show an angle grip; edge handles (`n`/`s`/`e`/`w`) show a dotted grip. Both are revealed on hover/focus/resize. A single edge (e.g. `['e']` or `['s']`) gives a horizontally- or vertically-only resizable widget.
|
|
69
|
-
- **`resizeGripPlacement`** `'inside' | 'corner'` (default: `'inside'`) — Where the corner grips sit. `'inside'` tucks each one into the widget box; `'corner'` centres it on the widget's corner, so it lines up with a control centred on the opposite corner. Only affects corner handles — a dotted edge grip always stays inside. A corner-placed grip is drawn
|
|
49
|
+
- **`resizeGripPlacement`** `'inside' | 'corner'` (default: `'inside'`) — Where the corner grips sit. `'inside'` tucks each one into the widget box; `'corner'` centres it on the widget's corner, so it lines up with a control centred on the opposite corner. Only affects corner handles — a dotted edge grip always stays inside. A corner-placed grip is drawn _outside_ the widget (a widget clips its own content, which would otherwise cut the grip in half), so it needs the board to have at least half a grip's worth of `containerPadding` to show in full against the board's edge. Its hit-zone moves out with it and overhangs by the same half-grip, so the whole visible grip is grabbable and hovering it keeps it revealed — the trade is a ~5px band just outside each corner where a press starts a resize rather than a marquee. Can be overridden per widget.
|
|
70
50
|
- **`dragCancel`** `string` — CSS selector for elements that must not start a pointer drag (e.g. form controls inside a widget: `"input,textarea,button,a,.no-drag"`). Does not affect keyboard moves — those only run when the widget host itself is focused. Can be overridden per widget.
|
|
71
51
|
- **`dragHandle`** `string` — CSS selector for the only elements from which a pointer drag may start. Can be overridden per widget.
|
|
72
|
-
- **`showGridLines`** `boolean | 'drag' | 'any-drag'` (default: `false`) — Show grid lines behind the widgets. `true` always; `false` never; `'drag'` only while
|
|
52
|
+
- **`showGridLines`** `boolean | 'drag' | 'any-drag'` (default: `false`) — Show grid lines behind the widgets. `true` always; `false` never; `'drag'` only while _this_ board is part of the active gesture — it owns the drag (as its source, or as the board the widget is currently over) or one of its own widgets is being resized; `'any-drag'` while any drag is in flight anywhere under a shared `Board.Provider`, so every board advertises itself as somewhere the widget could land. Under one `Board.Provider`, `'drag'` keeps boards a widget cannot land in quiet, and `'any-drag'` is the opt-in for the noisier, more informative version. A nested board that does not set this inherits an enabled ancestor's setting, at the ancestor's own scope.
|
|
73
53
|
- **`isAligned`** `boolean` (default: `false`) — Align a nested board with its ancestor `Board`'s layout. Only takes effect when the board is nested inside another `Board`'s widget. When set, every cell matches the parent's cell size exactly: the board inherits the parent's column pitch (deriving its own column count from its measured width so cells stay parent-sized as the container is resized) and uses the parent's row height verbatim. It never shrinks rows to fit — pair it with an `isAutoHeight` container so the widget grows to fit its rows at that height. `cols`/`rowHeight` then act as fallbacks used only until the parent metrics resolve.
|
|
74
54
|
- **`selectionMode`** `'none' | 'single' | 'multiple'` (default: `'none'`) — Whether widgets can be selected, and how many at a time. `'multiple'` also enables the marquee and rigid group movement.
|
|
75
55
|
- **`selectedKeys`** `string[]` — Controlled selection. Keys are layout item ids (`LayoutItem.i`).
|
|
76
56
|
- **`defaultSelectedKeys`** `string[]` — Initial selection for uncontrolled usage.
|
|
77
57
|
- **`onSelectionChange`** `(keys: string[]) => void` — Called when the selection changes. Keys are deduped and returned in the board's layout order, never in click order.
|
|
78
|
-
- **`selectionCancel`** `string` (default: `BOARD_SELECTION_CANCEL`) — CSS selector marking interactive descendants. A press on one never selects and never starts a drag, so the control keeps its own click
|
|
58
|
+
- **`selectionCancel`** `string` (default: `BOARD_SELECTION_CANCEL`) — CSS selector marking interactive descendants. A press on one never selects and never starts a drag, so the control keeps its own click _and_ its native focus; it also drops the selection, since interacting with a widget's content means the user has moved on. On a selectable board this doubles as the drag guard, so form controls stay usable without also configuring `dragCancel`. The default covers native form controls, links, and the common ARIA widget roles, plus `[data-no-select]` as an escape hatch. Pass `''` to disable the guard. Can be overridden per widget.
|
|
79
59
|
- **`allowMarqueeSelection`** `boolean` (default: `selectionMode === 'multiple'`) — Draw a rubber-band selection when a drag starts on empty board space. A press on a widget selects and drags instead, so the lasso owns empty canvas only. Hold <kbd>Shift</kbd> or <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> to add to the existing selection rather than replacing it. A board sized to its content has no empty space left once the grid fills up, which makes the lasso undiscoverable — use `extraRows` to keep a band of it.
|
|
80
60
|
- **`onWidgetsDelete`** `(keys: string[]) => void` — Called when <kbd>Delete</kbd>/<kbd>Backspace</kbd> is pressed with a non-empty selection and focus is not in an editable field. **Board never mutates the layout itself** — removing the widgets is yours to do, which is what lets you make it undoable. Board only handles these keys when this handler is set.
|
|
81
61
|
- **`constraints`** `LayoutConstraint[]` — Grid/item layout constraints.
|
|
@@ -107,35 +87,19 @@ clipped by an ancestor's `overflow: hidden`.
|
|
|
107
87
|
- **`selectionCancel`** `string` — Override the board's `selectionCancel` selector for this widget.
|
|
108
88
|
- **`aria-label`** `string` — Accessible name for the widget. Falls back to `qa`, then the layout item id — both developer-facing, so set this whenever the widget is user-visible. Also what the selection announcement reads out.
|
|
109
89
|
|
|
110
|
-
A widget clips its content to its grid cell, card or not — otherwise a nested
|
|
111
|
-
board with more rows than currently fit, or a mid-drag reflow, would paint over
|
|
112
|
-
its neighbours. The cost is that a descendant's `outline` is cropped at the edge
|
|
113
|
-
(an outline is clipped by an *ancestor's* overflow, not its own), so a widget
|
|
114
|
-
whose content must paint outside — a control drawing its own active ring — sets
|
|
115
|
-
`overflow="visible"`, or draws the ring inset with a negative `outlineOffset`.
|
|
90
|
+
A widget clips its content to its grid cell, card or not — otherwise a nested board with more rows than currently fit, or a mid-drag reflow, would paint over its neighbours. The cost is that a descendant's `outline` is cropped at the edge (an outline is clipped by an _ancestor's_ overflow, not its own), so a widget whose content must paint outside — a control drawing its own active ring — sets `overflow="visible"`, or draws the ring inset with a negative `outlineOffset`.
|
|
116
91
|
|
|
117
92
|
### Board.Provider
|
|
118
93
|
|
|
119
|
-
Shares one drag context across multiple boards. A standalone `Board` provides its
|
|
120
|
-
own automatically; only use `Board.Provider` when you need cross-board dragging.
|
|
94
|
+
Shares one drag context across multiple boards. A standalone `Board` provides its own automatically; only use `Board.Provider` when you need cross-board dragging.
|
|
121
95
|
|
|
122
|
-
- **`onWidgetTransfer`** `(info: { widgetId, fromBoardId, toBoardId, item }) => void` —
|
|
123
|
-
Fired when a widget is dropped from one board into another.
|
|
96
|
+
- **`onWidgetTransfer`** `(info: { widgetId, fromBoardId, toBoardId, item }) => void` — Fired when a widget is dropped from one board into another.
|
|
124
97
|
|
|
125
|
-
Dragging a widget across a container that can unmount (for example, out of an
|
|
126
|
-
inactive `Tab`) requires controlled ownership: a widget's content is declared by
|
|
127
|
-
its `Board.Widget`, so if that declaration unmounts the content is lost. Keep
|
|
128
|
-
each board's `layout` controlled and, in response to `onWidgetTransfer`, move the
|
|
129
|
-
`Board.Widget` declaration into the destination container so the content follows
|
|
130
|
-
the widget. The [Boards inside Tabs](#boards-inside-tabs) example shows the
|
|
131
|
-
pattern.
|
|
98
|
+
Dragging a widget across a container that can unmount (for example, out of an inactive `Tab`) requires controlled ownership: a widget's content is declared by its `Board.Widget`, so if that declaration unmounts the content is lost. Keep each board's `layout` controlled and, in response to `onWidgetTransfer`, move the `Board.Widget` declaration into the destination container so the content follows the widget. The [Boards inside Tabs](#boards-inside-tabs) example shows the pattern.
|
|
132
99
|
|
|
133
100
|
### Board.Responsive
|
|
134
101
|
|
|
135
|
-
A wrapper around `Board` that selects a layout and column count based on the
|
|
136
|
-
container's measured width, mirroring react-grid-layout's `Responsive` +
|
|
137
|
-
`WidthProvider`. It accepts all `Board` props except `layout`, `defaultLayout`,
|
|
138
|
-
`cols`, `onLayoutChange`, and `width` (which it manages), plus:
|
|
102
|
+
A wrapper around `Board` that selects a layout and column count based on the container's measured width, mirroring react-grid-layout's `Responsive` + `WidthProvider`. It accepts all `Board` props except `layout`, `defaultLayout`, `cols`, `onLayoutChange`, and `width` (which it manages), plus:
|
|
139
103
|
|
|
140
104
|
- **`breakpoints`** `Record<string, number>` — Breakpoint name to minimum container width (px).
|
|
141
105
|
- **`cols`** `Record<string, number>` — Breakpoint name to column count.
|
|
@@ -147,17 +111,14 @@ container's measured width, mirroring react-grid-layout's `Responsive` +
|
|
|
147
111
|
- **`breakpoint`** `string` — Force a specific breakpoint regardless of width (e.g. for a fixed-size screenshot or PDF export).
|
|
148
112
|
- **`width`** `number` — Explicit width; disables measurement (SSR/tests/forced-size exports).
|
|
149
113
|
|
|
150
|
-
A breakpoint with no layout is synthesized from the nearest available one,
|
|
151
|
-
corrected into bounds and compacted for the target column count.
|
|
114
|
+
A breakpoint with no layout is synthesized from the nearest available one, corrected into bounds and compacted for the target column count.
|
|
152
115
|
|
|
153
116
|
### Modifiers
|
|
154
117
|
|
|
155
|
-
Every widget host exposes these as `data-*` attributes, and any style map passed
|
|
156
|
-
through `widgetProps.styles` or a per-widget `styles` resolves against them.
|
|
118
|
+
Every widget host exposes these as `data-*` attributes, and any style map passed through `widgetProps.styles` or a per-widget `styles` resolves against them.
|
|
157
119
|
|
|
158
120
|
- **`selected`** — the widget is in the board's selection.
|
|
159
|
-
- **`pre-selected`** — a live marquee covers the widget, so releasing the pointer
|
|
160
|
-
will select it. Never set at the same time as `selected`.
|
|
121
|
+
- **`pre-selected`** — a live marquee covers the widget, so releasing the pointer will select it. Never set at the same time as `selected`.
|
|
161
122
|
- **`card`** — the widget draws a card border (`isCard`).
|
|
162
123
|
- **`draggable`** — the widget can be dragged and no drag is in flight.
|
|
163
124
|
- **`drag`** — the widget is being dragged.
|
|
@@ -167,13 +128,7 @@ through `widgetProps.styles` or a per-widget `styles` resolves against them.
|
|
|
167
128
|
- **`hovered`**, **`focus-visible`** — pointer and keyboard-focus states.
|
|
168
129
|
- **`settled`** — the board has painted its widgets once, so position changes animate.
|
|
169
130
|
|
|
170
|
-
Selection is an
|
|
171
|
-
ring — because it reads as a focus-like state rather than a fill. `outline` stays
|
|
172
|
-
reserved for the real focus ring, which is what keeps the two legible together:
|
|
173
|
-
they use different tokens and the focus outline sits one border-width further
|
|
174
|
-
out. `pre-selected` draws the same edge with the ring dimmed, so committing a
|
|
175
|
-
lasso only changes the strength of something already on screen. To restyle
|
|
176
|
-
either, override the same keys:
|
|
131
|
+
Selection is an _edge_ treatment — a `#primary-border` border plus a `#primary` ring — because it reads as a focus-like state rather than a fill. `outline` stays reserved for the real focus ring, which is what keeps the two legible together: they use different tokens and the focus outline sits one border-width further out. `pre-selected` draws the same edge with the ring dimmed, so committing a lasso only changes the strength of something already on screen. To restyle either, override the same keys:
|
|
177
132
|
|
|
178
133
|
```jsx
|
|
179
134
|
<Board
|
|
@@ -204,9 +159,7 @@ Supports [Base properties](../../BaseProperties.md).
|
|
|
204
159
|
|
|
205
160
|
### Style Properties
|
|
206
161
|
|
|
207
|
-
These properties allow direct style application without using the `styles` prop.
|
|
208
|
-
Note: `margin` is repurposed as the grid gap (see Properties above) rather than a
|
|
209
|
-
CSS margin.
|
|
162
|
+
These properties allow direct style application without using the `styles` prop. Note: `margin` is repurposed as the grid gap (see Properties above) rather than a CSS margin.
|
|
210
163
|
|
|
211
164
|
- **Base:** `display`, `font`, `preset`, `hide`, `whiteSpace`, `opacity`, `transition`
|
|
212
165
|
- **Position:** `gridArea`, `order`, `gridColumn`, `gridRow`, `placeSelf`, `alignSelf`, `justifySelf`, `zIndex`, `margin`, `inset`, `position`, `scrollMargin`
|
|
@@ -221,14 +174,11 @@ CSS margin.
|
|
|
221
174
|
|
|
222
175
|
### Free positioning
|
|
223
176
|
|
|
224
|
-
A widget stays exactly where you drop it and never shuffles its neighbours.
|
|
225
|
-
Dropping onto an occupied cell is blocked, so the widget stays at its last free
|
|
226
|
-
spot.
|
|
177
|
+
A widget stays exactly where you drop it and never shuffles its neighbours. Dropping onto an occupied cell is blocked, so the widget stays at its last free spot.
|
|
227
178
|
|
|
228
179
|
### Free positioning (overlap)
|
|
229
180
|
|
|
230
|
-
Add `allowOverlap` to let widgets stack on top of each other instead of being
|
|
231
|
-
blocked from occupied cells.
|
|
181
|
+
Add `allowOverlap` to let widgets stack on top of each other instead of being blocked from occupied cells.
|
|
232
182
|
|
|
233
183
|
### Horizontal compaction
|
|
234
184
|
|
|
@@ -240,34 +190,23 @@ Bound resizing with per-widget `minW`/`maxW` (columns) and `minH`/`maxH` (rows).
|
|
|
240
190
|
|
|
241
191
|
### Grid lines
|
|
242
192
|
|
|
243
|
-
Show grid lines behind the widgets while dragging or resizing (or always). With
|
|
244
|
-
several boards under one `Board.Provider`, `'drag'` lights up only the board the
|
|
245
|
-
drag belongs to; `'any-drag'` lights up all of them.
|
|
193
|
+
Show grid lines behind the widgets while dragging or resizing (or always). With several boards under one `Board.Provider`, `'drag'` lights up only the board the drag belongs to; `'any-drag'` lights up all of them.
|
|
246
194
|
|
|
247
195
|
### Corner resize grip
|
|
248
196
|
|
|
249
|
-
Centre the resize grip on the widget's corner with `resizeGripPlacement="corner"`,
|
|
250
|
-
so it lines up with a control centred on the opposite corner.
|
|
197
|
+
Centre the resize grip on the widget's corner with `resizeGripPlacement="corner"`, so it lines up with a control centred on the opposite corner.
|
|
251
198
|
|
|
252
199
|
### Resolving a blocked drop
|
|
253
200
|
|
|
254
|
-
On a free grid a drop onto occupied cells is refused. `collisionMode` resolves it
|
|
255
|
-
instead: `'downscale'` shrinks the widget into whatever room is at the drop cell.
|
|
256
|
-
Within one board, `'swap'` trades places with the widget already there. Across
|
|
257
|
-
boards, the same mode inserts only at an empty anchor and downscales without
|
|
258
|
-
moving destination widgets; an invalid release cancels the transfer. None of
|
|
259
|
-
these paths ever grows a widget. The examples below show all three behaviors.
|
|
201
|
+
On a free grid a drop onto occupied cells is refused. `collisionMode` resolves it instead: `'downscale'` shrinks the widget into whatever room is at the drop cell. Within one board, `'swap'` trades places with the widget already there. Across boards, the same mode inserts only at an empty anchor and downscales without moving destination widgets; an invalid release cancels the transfer. None of these paths ever grows a widget. The examples below show all three behaviors.
|
|
260
202
|
|
|
261
203
|
### Card widgets
|
|
262
204
|
|
|
263
|
-
Widgets are filled (`#surface-2`) and rounded by default, but borderless. Add a
|
|
264
|
-
card border per widget with `isCard`, or for the whole board at once with
|
|
265
|
-
`widgetProps={{ isCard: true }}`. Per-widget `isCard` overrides the board default.
|
|
205
|
+
Widgets are filled (`#surface-2`) and rounded by default, but borderless. Add a card border per widget with `isCard`, or for the whole board at once with `widgetProps={{ isCard: true }}`. Per-widget `isCard` overrides the board default.
|
|
266
206
|
|
|
267
207
|
### Drag cancel
|
|
268
208
|
|
|
269
|
-
Keep interactive controls inside a widget clickable by excluding them from the
|
|
270
|
-
drag gesture with `dragCancel`.
|
|
209
|
+
Keep interactive controls inside a widget clickable by excluding them from the drag gesture with `dragCancel`.
|
|
271
210
|
|
|
272
211
|
### Responsive
|
|
273
212
|
|
|
@@ -279,63 +218,27 @@ Wrap boards in `Board.Provider` to drag widgets between them.
|
|
|
279
218
|
|
|
280
219
|
### Nested boards
|
|
281
220
|
|
|
282
|
-
A `Board` can be placed inside a `Board.Widget`, making the whole container
|
|
283
|
-
draggable while its children can be dragged out into sibling boards.
|
|
221
|
+
A `Board` can be placed inside a `Board.Widget`, making the whole container draggable while its children can be dragged out into sibling boards.
|
|
284
222
|
|
|
285
|
-
Set `isAligned` on the nested board to align it with the surrounding layout:
|
|
286
|
-
every cell matches the parent's cell size exactly. Its columns keep the parent's
|
|
287
|
-
pixel pitch (so resizing the container adds or removes columns instead of
|
|
288
|
-
stretching them) and its rows use the parent's row height verbatim.
|
|
223
|
+
Set `isAligned` on the nested board to align it with the surrounding layout: every cell matches the parent's cell size exactly. Its columns keep the parent's pixel pitch (so resizing the container adds or removes columns instead of stretching them) and its rows use the parent's row height verbatim.
|
|
289
224
|
|
|
290
|
-
Because an aligned board never shrinks its rows to fit, add `isAutoHeight` to the
|
|
291
|
-
container `Board.Widget` so it grows (only ever taller) until the inner board's
|
|
292
|
-
rows fit at the parent's row height. It also stops the container's resize handle
|
|
293
|
-
at that height, so you can't drag it shorter than the inner board needs.
|
|
225
|
+
Because an aligned board never shrinks its rows to fit, add `isAutoHeight` to the container `Board.Widget` so it grows (only ever taller) until the inner board's rows fit at the parent's row height. It also stops the container's resize handle at that height, so you can't drag it shorter than the inner board needs.
|
|
294
226
|
|
|
295
227
|
### Aligned nested boards
|
|
296
228
|
|
|
297
|
-
A nested `Board` with `isAligned` and no padding, fill, border, or radius of its
|
|
298
|
-
own — only a header above the grid — inherits the parent column pitch with zero
|
|
299
|
-
offset, so its columns line up exactly with the outer board. Grid lines are
|
|
300
|
-
shown on both boards while dragging to verify the alignment.
|
|
229
|
+
A nested `Board` with `isAligned` and no padding, fill, border, or radius of its own — only a header above the grid — inherits the parent column pitch with zero offset, so its columns line up exactly with the outer board. Grid lines are shown on both boards while dragging to verify the alignment.
|
|
301
230
|
|
|
302
231
|
### Boards inside Tabs
|
|
303
232
|
|
|
304
|
-
A `Board.Widget` can host a `Tabs` where each tab renders its own `Board`, all
|
|
305
|
-
|
|
306
|
-
into the
|
|
307
|
-
fully controlled: each board's `layout` is controlled and `onWidgetTransfer`
|
|
308
|
-
moves a widget's declaration into the destination container so its content
|
|
309
|
-
survives dragging out of (and switching away from) a tab.
|
|
310
|
-
|
|
311
|
-
When a `Tabs` sits inside a `Board`, tab switching becomes "spring-loaded"
|
|
312
|
-
automatically: while you drag a widget, hovering a tab header for a moment opens
|
|
313
|
-
that tab so you can drop into it (or move a widget between tabs). This needs no
|
|
314
|
-
setup - `Tabs` detects the active Board drag and, for its duration, keeps panels
|
|
315
|
-
mounted so the tab a widget is dragged out of (and the board owning the in-flight
|
|
316
|
-
drag) is not unmounted mid-gesture. Spring-loading works with mouse and pen;
|
|
317
|
-
touch drags capture the pointer, so they do not trigger it.
|
|
233
|
+
A `Board.Widget` can host a `Tabs` where each tab renders its own `Board`, all under a shared `Board.Provider` so widgets can be dragged between tabs and out into the surrounding board. Because an inactive tab unmounts, this example is fully controlled: each board's `layout` is controlled and `onWidgetTransfer` moves a widget's declaration into the destination container so its content survives dragging out of (and switching away from) a tab.
|
|
234
|
+
|
|
235
|
+
When a `Tabs` sits inside a `Board`, tab switching becomes "spring-loaded" automatically: while you drag a widget, hovering a tab header for a moment opens that tab so you can drop into it (or move a widget between tabs). This needs no setup - `Tabs` detects the active Board drag and, for its duration, keeps panels mounted so the tab a widget is dragged out of (and the board owning the in-flight drag) is not unmounted mid-gesture. Spring-loading works with mouse and pen; touch drags capture the pointer, so they do not trigger it.
|
|
318
236
|
|
|
319
237
|
### Selection
|
|
320
238
|
|
|
321
|
-
Press a widget to select it, <kbd>Shift</kbd>-press to add or remove one, and
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
moves it; grabbing one that *is* selected moves the whole block rigidly — keeping
|
|
325
|
-
its shape, clamping against the grid edge as a unit rather than collapsing, and
|
|
326
|
-
committing once. While the band is out, the widgets it covers show a dimmed
|
|
327
|
-
version of the selected edge (`pre-selected`), and no text can be selected under
|
|
328
|
-
it.
|
|
329
|
-
|
|
330
|
-
A group reflows like a single widget — it is compacted by the same rules, so on a
|
|
331
|
-
`vertical` board it can no more be parked in empty space than one widget can, and
|
|
332
|
-
the widgets around it close the gap in the same frame — but it does so as one
|
|
333
|
-
block. Its members keep their exact offsets for the whole drag, and the widgets
|
|
334
|
-
standing where it lands move out of its way rather than being packed between its
|
|
335
|
-
members — whether it is dragged against the compaction axis or across it. When
|
|
336
|
-
the drag ends the board compacts normally, so a group whose members could each
|
|
337
|
-
float further settles on release. Under `compact="free"` (or `null`) nothing compacts,
|
|
338
|
-
so the block stays precisely where it was dropped.
|
|
239
|
+
Press a widget to select it, <kbd>Shift</kbd>-press to add or remove one, and drag from empty board space to lasso. Because the press both selects and arms the drag, grabbing a widget you have not selected simply makes it the selection and moves it; grabbing one that _is_ selected moves the whole block rigidly — keeping its shape, clamping against the grid edge as a unit rather than collapsing, and committing once. While the band is out, the widgets it covers show a dimmed version of the selected edge (`pre-selected`), and no text can be selected under it.
|
|
240
|
+
|
|
241
|
+
A group reflows like a single widget — it is compacted by the same rules, so on a `vertical` board it can no more be parked in empty space than one widget can, and the widgets around it close the gap in the same frame — but it does so as one block. Its members keep their exact offsets for the whole drag, and the widgets standing where it lands move out of its way rather than being packed between its members — whether it is dragged against the compaction axis or across it. When the drag ends the board compacts normally, so a group whose members could each float further settles on release. Under `compact="free"` (or `null`) nothing compacts, so the block stays precisely where it was dropped.
|
|
339
242
|
|
|
340
243
|
### Interactive content keeps its clicks
|
|
341
244
|
|
|
@@ -356,73 +259,30 @@ so the block stays precisely where it was dropped.
|
|
|
356
259
|
| <kbd>Escape</kbd> | Clear the selection. |
|
|
357
260
|
| <kbd>Delete</kbd> / <kbd>Backspace</kbd> | Request deletion of the selection via `onWidgetsDelete`. |
|
|
358
261
|
|
|
359
|
-
Arrow keys and <kbd>Space</kbd> only act when the widget host **itself** is
|
|
360
|
-
focused, never when focus is inside a nested control, so an `input`,
|
|
361
|
-
`textarea`, or `button` inside a widget keeps every key it needs. Board's own
|
|
362
|
-
keys are handled on the board element rather than on `document`, and are only
|
|
363
|
-
consumed when they actually do something — an <kbd>Escape</kbd> with nothing
|
|
364
|
-
selected still reaches an ancestor Dialog, and <kbd>Backspace</kbd> stays
|
|
365
|
-
available for text editing and browser-back.
|
|
262
|
+
Arrow keys and <kbd>Space</kbd> only act when the widget host **itself** is focused, never when focus is inside a nested control, so an `input`, `textarea`, or `button` inside a widget keeps every key it needs. Board's own keys are handled on the board element rather than on `document`, and are only consumed when they actually do something — an <kbd>Escape</kbd> with nothing selected still reaches an ancestor Dialog, and <kbd>Backspace</kbd> stays available for text editing and browser-back.
|
|
366
263
|
|
|
367
|
-
Every draggable or selectable widget is its own tab stop. Roving tabindex would
|
|
368
|
-
be an improvement on a large board, but arrow keys are already claimed for
|
|
369
|
-
movement, so it needs a navigation key set of its own — see below.
|
|
264
|
+
Every draggable or selectable widget is its own tab stop. Roving tabindex would be an improvement on a large board, but arrow keys are already claimed for movement, so it needs a navigation key set of its own — see below.
|
|
370
265
|
|
|
371
266
|
### Screen Reader Support
|
|
372
267
|
|
|
373
|
-
Each widget host is a `group` with an accessible name, taken from
|
|
374
|
-
`aria-label`, then `qa`, then the layout item id — set `aria-label` on any
|
|
375
|
-
user-visible widget, since the other two are developer-facing. Draggable widgets
|
|
376
|
-
carry a localized `aria-roledescription`, and selectable ones advertise
|
|
377
|
-
`aria-keyshortcuts="Space"`.
|
|
268
|
+
Each widget host is a `group` with an accessible name, taken from `aria-label`, then `qa`, then the layout item id — set `aria-label` on any user-visible widget, since the other two are developer-facing. Draggable widgets carry a localized `aria-roledescription`, and selectable ones advertise `aria-keyshortcuts="Space"`.
|
|
378
269
|
|
|
379
|
-
Selection state is conveyed two ways: a selected widget is described as
|
|
380
|
-
"Selected" via `aria-describedby`, and every selection change is announced
|
|
381
|
-
through a polite live region owned by the board ("Revenue selected", "3 widgets
|
|
382
|
-
selected", "Selection cleared"). A marquee announces once, on release — not once
|
|
383
|
-
per pointer frame.
|
|
270
|
+
Selection state is conveyed two ways: a selected widget is described as "Selected" via `aria-describedby`, and every selection change is announced through a polite live region owned by the board ("Revenue selected", "3 widgets selected", "Selection cleared"). A marquee announces once, on release — not once per pointer frame.
|
|
384
271
|
|
|
385
272
|
### ARIA Properties
|
|
386
273
|
|
|
387
|
-
Board deliberately does **not** use a collection role. `aria-selected` is only
|
|
388
|
-
valid on `option`, `gridcell`, `row`, `treeitem` and friends, and every one of
|
|
389
|
-
those requires presentational children — but a Board widget hosts arbitrary
|
|
390
|
-
interactive content (nested boards, tabs, inputs), and a `grid`'s keyboard model
|
|
391
|
-
would fight `useMove`'s arrow keys. Rather than ship ARIA that lies about the
|
|
392
|
-
structure, selection is exposed through the name, description, and live region
|
|
393
|
-
described above. Set `aria-label` on your widgets and this reads correctly.
|
|
274
|
+
Board deliberately does **not** use a collection role. `aria-selected` is only valid on `option`, `gridcell`, `row`, `treeitem` and friends, and every one of those requires presentational children — but a Board widget hosts arbitrary interactive content (nested boards, tabs, inputs), and a `grid`'s keyboard model would fight `useMove`'s arrow keys. Rather than ship ARIA that lies about the structure, selection is exposed through the name, description, and live region described above. Set `aria-label` on your widgets and this reads correctly.
|
|
394
275
|
|
|
395
276
|
## Not yet supported
|
|
396
277
|
|
|
397
|
-
- **External drag-in from a palette** — dragging a brand-new widget from an
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
is a separate HTML5 drag-and-drop modality (pixel-to-grid mapping, a dropping
|
|
402
|
-
placeholder, and new `onDrop`/`droppingItem` props). Add widgets
|
|
403
|
-
programmatically (render a new `Board.Widget` and add its layout item), or drag
|
|
404
|
-
between boards with `Board.Provider`.
|
|
405
|
-
- **Cross-board group transfer** — a group drag never leaves its source board.
|
|
406
|
-
Cross-board transfer is single-item throughout (`WidgetTransferInfo`, the
|
|
407
|
-
carried preview, the free-slot fallback), and landing a group on a board with a
|
|
408
|
-
different column count has no obvious right answer. Degrading to a
|
|
409
|
-
single-widget transfer would silently split a selection the user made, so the
|
|
410
|
-
gesture is confined instead. Drag widgets across one at a time.
|
|
411
|
-
- **Collection ARIA semantics** — `role="grid"`/`option`, `aria-selected` and
|
|
412
|
-
`aria-multiselectable`, for the reason above.
|
|
413
|
-
- **Roving tabindex** — needs a widget-navigation key set that does not collide
|
|
414
|
-
with `useMove`'s arrow keys.
|
|
278
|
+
- **External drag-in from a palette** — dragging a brand-new widget from an element outside any board into the grid (react-grid-layout's `isDroppable`/`onDrop`/`droppingItem`) is not implemented. Board's drag engine is built entirely on React Aria's `useMove` over registered widgets; drag-in is a separate HTML5 drag-and-drop modality (pixel-to-grid mapping, a dropping placeholder, and new `onDrop`/`droppingItem` props). Add widgets programmatically (render a new `Board.Widget` and add its layout item), or drag between boards with `Board.Provider`.
|
|
279
|
+
- **Cross-board group transfer** — a group drag never leaves its source board. Cross-board transfer is single-item throughout (`WidgetTransferInfo`, the carried preview, the free-slot fallback), and landing a group on a board with a different column count has no obvious right answer. Degrading to a single-widget transfer would silently split a selection the user made, so the gesture is confined instead. Drag widgets across one at a time.
|
|
280
|
+
- **Collection ARIA semantics** — `role="grid"`/`option`, `aria-selected` and `aria-multiselectable`, for the reason above.
|
|
281
|
+
- **Roving tabindex** — needs a widget-navigation key set that does not collide with `useMove`'s arrow keys.
|
|
415
282
|
- **<kbd>Cmd/Ctrl</kbd>+<kbd>A</kbd>** — select all.
|
|
416
|
-
- **Cross-board marquee and cross-board selection** — selection is per board; a
|
|
417
|
-
|
|
418
|
-
- **Windows High Contrast Mode** — no component in the kit styles for
|
|
419
|
-
`forced-colors` yet. The selected state uses a tint, a border *and* an extra
|
|
420
|
-
ring, so it does not rely on hue alone, but a full forced-colors pass is a
|
|
421
|
-
system-wide change.
|
|
283
|
+
- **Cross-board marquee and cross-board selection** — selection is per board; a `Board.Provider` shares drag, not selection.
|
|
284
|
+
- **Windows High Contrast Mode** — no component in the kit styles for `forced-colors` yet. The selected state uses a tint, a border _and_ an extra ring, so it does not rely on hue alone, but a full forced-colors pass is a system-wide change.
|
|
422
285
|
|
|
423
286
|
## Attribution
|
|
424
287
|
|
|
425
|
-
The layout engine in `grid-core/` is a vendored, trimmed copy of
|
|
426
|
-
[react-grid-layout](https://github.com/react-grid-layout/react-grid-layout)
|
|
427
|
-
(MIT). The React layer is a UI Kit-native reimplementation on top of tasty and
|
|
428
|
-
React Aria. See `grid-core/NOTICE.md`.
|
|
288
|
+
The layout engine in `grid-core/` is a vendored, trimmed copy of [react-grid-layout](https://github.com/react-grid-layout/react-grid-layout) (MIT). The React layer is a UI Kit-native reimplementation on top of tasty and React Aria. See `grid-core/NOTICE.md`.
|
|
@@ -1,71 +1,40 @@
|
|
|
1
1
|
# Pagination
|
|
2
2
|
|
|
3
|
-
Pagination is the control for moving through a paged collection. It renders a
|
|
4
|
-
bounded run of page buttons, optional first/last jumps, an optional page-size
|
|
5
|
-
selector, and an optional item-range summary.
|
|
3
|
+
Pagination is the control for moving through a paged collection. It renders a bounded run of page buttons, optional first/last jumps, an optional page-size selector, and an optional item-range summary.
|
|
6
4
|
|
|
7
|
-
It is a pure control: it owns no data. Client-side slicing lives in the
|
|
8
|
-
companion `usePagination` hook, and `ItemTable` composes the two.
|
|
5
|
+
It is a pure control: it owns no data. Client-side slicing lives in the companion `usePagination` hook, and `ItemTable` composes the two.
|
|
9
6
|
|
|
10
7
|
## When to Use
|
|
11
8
|
|
|
12
|
-
- Paging through a list, table, or grid where the user needs to jump around
|
|
13
|
-
|
|
14
|
-
- Cursor pagination with an unknown total — supply `hasNextPage` and omit
|
|
15
|
-
`total`/`totalPages`, and the control degrades to prev/next.
|
|
9
|
+
- Paging through a list, table, or grid where the user needs to jump around rather than scroll.
|
|
10
|
+
- Cursor pagination with an unknown total — supply `hasNextPage` and omit `total`/`totalPages`, and the control degrades to prev/next.
|
|
16
11
|
- Anywhere you need a page-size selector wired to the same state.
|
|
17
12
|
|
|
18
|
-
Prefer infinite scroll when the collection is a feed the user skims, and
|
|
19
|
-
pagination when they need stable, addressable positions.
|
|
13
|
+
Prefer infinite scroll when the collection is a feed the user skims, and pagination when they need stable, addressable positions.
|
|
20
14
|
|
|
21
15
|
## Component
|
|
22
16
|
|
|
23
17
|
### Properties
|
|
24
18
|
|
|
25
|
-
- **`page`** `number` — Controlled current page, 1-based. Pair with
|
|
26
|
-
|
|
27
|
-
- **`
|
|
28
|
-
|
|
29
|
-
- **`
|
|
30
|
-
`1…totalPages` when the total is known.
|
|
31
|
-
- **`total`** `number` — Total items across all pages. Preferred over
|
|
32
|
-
`totalPages`; it also powers the range summary and the `select` type's range
|
|
33
|
-
labels.
|
|
34
|
-
- **`totalPages`** `number` — Total pages. Only needed when the item count is
|
|
35
|
-
genuinely unavailable. Wins over the value derived from `total` + `pageSize`.
|
|
19
|
+
- **`page`** `number` — Controlled current page, 1-based. Pair with `onPageChange`.
|
|
20
|
+
- **`defaultPage`** `number` (default: `1`) — Initial page for uncontrolled usage.
|
|
21
|
+
- **`onPageChange`** `(page: number) => void` — Never fires with a page outside `1…totalPages` when the total is known.
|
|
22
|
+
- **`total`** `number` — Total items across all pages. Preferred over `totalPages`; it also powers the range summary and the `select` type's range labels.
|
|
23
|
+
- **`totalPages`** `number` — Total pages. Only needed when the item count is genuinely unavailable. Wins over the value derived from `total` + `pageSize`.
|
|
36
24
|
- **`pageSize`** `number` — Controlled page size.
|
|
37
|
-
- **`defaultPageSize`** `number` (default: `50`) — Initial page size for
|
|
38
|
-
|
|
39
|
-
- **`
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
- **`
|
|
43
|
-
renders the size selector.
|
|
44
|
-
- **`type`** `'numbers' | 'select' | 'compact'` (default: `'numbers'`) — How the
|
|
45
|
-
page control is rendered. `numbers` is the default because it is the only mode
|
|
46
|
-
whose rendered element count is independent of the page count; `select`
|
|
47
|
-
materializes one entry per page, so above a safety cap the component falls
|
|
48
|
-
back to `compact` on its own.
|
|
49
|
-
- **`siblingCount`** `number` (default: `1`) — Page buttons either side of the
|
|
50
|
-
current page.
|
|
51
|
-
- **`boundaryCount`** `number` (default: `1`) — Page buttons pinned at each end.
|
|
52
|
-
Together with `siblingCount` this bounds the rendered count at
|
|
53
|
-
`boundaryCount * 2 + siblingCount * 2 + 3`.
|
|
25
|
+
- **`defaultPageSize`** `number` (default: `50`) — Initial page size for uncontrolled usage.
|
|
26
|
+
- **`onPageSizeChange`** `(pageSize: number) => void` — Changing the size also resets to page 1, because the old page index no longer refers to the same items.
|
|
27
|
+
- **`pageSizeOptions`** `number[]` — Supplying this **and** `onPageSizeChange` renders the size selector.
|
|
28
|
+
- **`type`** `'numbers' | 'select' | 'compact'` (default: `'numbers'`) — How the page control is rendered. `numbers` is the default because it is the only mode whose rendered element count is independent of the page count; `select` materializes one entry per page, so above a safety cap the component falls back to `compact` on its own.
|
|
29
|
+
- **`siblingCount`** `number` (default: `1`) — Page buttons either side of the current page.
|
|
30
|
+
- **`boundaryCount`** `number` (default: `1`) — Page buttons pinned at each end. Together with `siblingCount` this bounds the rendered count at `boundaryCount * 2 + siblingCount * 2 + 3`.
|
|
54
31
|
- **`size`** `'small' | 'medium'` (default: `'small'`) — Control size.
|
|
55
32
|
- **`isDisabled`** `boolean` — Disable every control.
|
|
56
|
-
- **`hasNextPage`** `boolean` — Keeps "next" enabled when the total is unknown.
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
- **`
|
|
60
|
-
|
|
61
|
-
- **`summary`** `boolean | ((info: CubeTablePageInfo) => ReactNode)` (default:
|
|
62
|
-
`false`) — `true` renders the localized `1–50 of 1,204`, with numbers
|
|
63
|
-
formatted for the active locale. Pass a function for full control.
|
|
64
|
-
- **`labelFormatter`** `(info: CubeTablePageInfo) => ReactNode` — Labels the
|
|
65
|
-
entries of `type="select"`. Receives the page info with `page` set to the
|
|
66
|
-
entry being labelled.
|
|
67
|
-
- **`ariaLabel`** `string` — Labels the `<nav>` landmark. Defaults to the
|
|
68
|
-
localized "Pagination".
|
|
33
|
+
- **`hasNextPage`** `boolean` — Keeps "next" enabled when the total is unknown. Ignored once `total` or `totalPages` is supplied — a known total is always authoritative.
|
|
34
|
+
- **`isCompact`** `boolean` (default: `false`) — Hide the first/last jump buttons.
|
|
35
|
+
- **`summary`** `boolean | ((info: CubeTablePageInfo) => ReactNode)` (default: `false`) — `true` renders the localized `1–50 of 1,204`, with numbers formatted for the active locale. Pass a function for full control.
|
|
36
|
+
- **`labelFormatter`** `(info: CubeTablePageInfo) => ReactNode` — Labels the entries of `type="select"`. Receives the page info with `page` set to the entry being labelled.
|
|
37
|
+
- **`ariaLabel`** `string` — Labels the `<nav>` landmark. Defaults to the localized "Pagination".
|
|
69
38
|
|
|
70
39
|
#### `CubeTablePageInfo`
|
|
71
40
|
|
|
@@ -112,9 +81,9 @@ These properties allow direct style application without using the `styles` prop:
|
|
|
112
81
|
|
|
113
82
|
### Modifiers
|
|
114
83
|
|
|
115
|
-
| Modifier | Type
|
|
116
|
-
| -------- |
|
|
117
|
-
| `size`
|
|
84
|
+
| Modifier | Type | Description |
|
|
85
|
+
| -------- | --------------------- | ------------ |
|
|
86
|
+
| `size` | `'small' \| 'medium'` | Control size |
|
|
118
87
|
|
|
119
88
|
## Examples
|
|
120
89
|
|
|
@@ -204,34 +173,26 @@ Every control is a real `<button>`, so there is nothing bespoke to learn.
|
|
|
204
173
|
|
|
205
174
|
### Screen Reader Support
|
|
206
175
|
|
|
207
|
-
- The root is a `<nav>` landmark labelled "Pagination" (override with
|
|
208
|
-
`ariaLabel`).
|
|
176
|
+
- The root is a `<nav>` landmark labelled "Pagination" (override with `ariaLabel`).
|
|
209
177
|
- The current page button carries `aria-current="page"`.
|
|
210
|
-
- Every button has an explicit `aria-label` — "Page 3", "Next page", and so on
|
|
211
|
-
— so an icon-only button is never announced as unlabelled.
|
|
178
|
+
- Every button has an explicit `aria-label` — "Page 3", "Next page", and so on — so an icon-only button is never announced as unlabelled.
|
|
212
179
|
- The `…` gap is `aria-hidden`; it conveys nothing a screen reader user needs.
|
|
213
180
|
|
|
214
181
|
### ARIA Properties
|
|
215
182
|
|
|
216
|
-
| Property
|
|
217
|
-
|
|
|
218
|
-
| `aria-label`
|
|
219
|
-
| `aria-current="page"` | The current page button
|
|
220
|
-
| `aria-hidden="true"`
|
|
183
|
+
| Property | Applied to |
|
|
184
|
+
| --------------------- | ---------------------------- |
|
|
185
|
+
| `aria-label` | The `<nav>` and every button |
|
|
186
|
+
| `aria-current="page"` | The current page button |
|
|
187
|
+
| `aria-hidden="true"` | The `…` gap |
|
|
221
188
|
|
|
222
189
|
## Best Practices
|
|
223
190
|
|
|
224
|
-
- Do: pass `total` rather than `totalPages` when you know the item count — the
|
|
225
|
-
|
|
226
|
-
- Do:
|
|
227
|
-
|
|
228
|
-
-
|
|
229
|
-
a new filter). A stale page index against a smaller result set shows an empty
|
|
230
|
-
page.
|
|
231
|
-
- Don't: render `type="select"` over a large page count. It builds one
|
|
232
|
-
collection item per page.
|
|
233
|
-
- Don't: pass both `hasNextPage` and a known total and expect the former to win
|
|
234
|
-
— it doesn't.
|
|
191
|
+
- Do: pass `total` rather than `totalPages` when you know the item count — the summary and range labels both need it.
|
|
192
|
+
- Do: use `type="numbers"` (the default) for anything that can grow. It is the only mode whose cost does not scale with the page count.
|
|
193
|
+
- Do: reset to page 1 whenever the underlying query changes (a new search term, a new filter). A stale page index against a smaller result set shows an empty page.
|
|
194
|
+
- Don't: render `type="select"` over a large page count. It builds one collection item per page.
|
|
195
|
+
- Don't: pass both `hasNextPage` and a known total and expect the former to win — it doesn't.
|
|
235
196
|
|
|
236
197
|
## Suggested Improvements
|
|
237
198
|
|
|
@@ -142,9 +142,7 @@ DOM order is always "bar then panels" — visual order is controlled internally
|
|
|
142
142
|
|
|
143
143
|
#### Vertical tabs across types
|
|
144
144
|
|
|
145
|
-
`narrow` only makes sense for a horizontal strip (it collapses horizontal
|
|
146
|
-
label padding for a denser row). When `placement` is `'left'` or `'right'`,
|
|
147
|
-
`type="narrow"` is coerced to `type="default"`.
|
|
145
|
+
`narrow` only makes sense for a horizontal strip (it collapses horizontal label padding for a denser row). When `placement` is `'left'` or `'right'`, `type="narrow"` is coerced to `type="default"`.
|
|
148
146
|
|
|
149
147
|
## Compound Components
|
|
150
148
|
|
|
@@ -744,9 +742,7 @@ Override per-tab/panel:
|
|
|
744
742
|
|
|
745
743
|
### Optimized Lazy Rendering with `renderPanel`
|
|
746
744
|
|
|
747
|
-
For tabs with expensive content, use the `renderPanel` prop for optimized lazy rendering.
|
|
748
|
-
This prevents content from being evaluated on every parent render - only the active tab's
|
|
749
|
-
content is computed, while inactive tabs use cached content.
|
|
745
|
+
For tabs with expensive content, use the `renderPanel` prop for optimized lazy rendering. This prevents content from being evaluated on every parent render - only the active tab's content is computed, while inactive tabs use cached content.
|
|
750
746
|
|
|
751
747
|
```jsx
|
|
752
748
|
<Tabs
|
|
@@ -833,15 +829,7 @@ Tabs work seamlessly inside Layout components. When placed in a `Layout` or `Lay
|
|
|
833
829
|
|
|
834
830
|
### Inside a Board (spring-loaded switching)
|
|
835
831
|
|
|
836
|
-
When `Tabs` is rendered inside a [`Board`](../layout/Board.md), tab
|
|
837
|
-
switching becomes spring-loaded automatically: while a Board widget is being
|
|
838
|
-
dragged, hovering a tab header for a moment opens that tab, so a widget can be
|
|
839
|
-
dropped into it or moved between tabs. This requires no configuration - `Tabs`
|
|
840
|
-
detects the active Board drag and, for its duration, keeps panels mounted so the
|
|
841
|
-
tab a widget is dragged out of (and the board owning the in-flight gesture) is
|
|
842
|
-
not unmounted mid-drag. Spring-loading works with mouse and pen; touch drags
|
|
843
|
-
capture the pointer and do not trigger it. Outside a `Board` this behavior is
|
|
844
|
-
inert.
|
|
832
|
+
When `Tabs` is rendered inside a [`Board`](../layout/Board.md), tab switching becomes spring-loaded automatically: while a Board widget is being dragged, hovering a tab header for a moment opens that tab, so a widget can be dropped into it or moved between tabs. This requires no configuration - `Tabs` detects the active Board drag and, for its duration, keeps panels mounted so the tab a widget is dragged out of (and the board owning the in-flight gesture) is not unmounted mid-drag. Spring-loading works with mouse and pen; touch drags capture the pointer and do not trigger it. Outside a `Board` this behavior is inert.
|
|
845
833
|
|
|
846
834
|
## Accessibility
|
|
847
835
|
|