@envsemble/envui 2.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +258 -0
- package/README.md +14 -27
- package/dist/actions/Button.d.ts +25 -8
- package/dist/actions/Button.js.map +2 -2
- package/dist/actions/CommandPalette.d.ts +37 -9
- package/dist/actions/CommandPalette.js +111 -107
- package/dist/actions/CommandPalette.js.map +2 -2
- package/dist/actions/ConfirmButton.d.ts +1 -1
- package/dist/actions/ConfirmButton.js +2 -4
- package/dist/actions/ConfirmButton.js.map +2 -2
- package/dist/actions/ContextMenu.d.ts +1 -1
- package/dist/actions/ContextMenu.js +5 -6
- package/dist/actions/ContextMenu.js.map +2 -2
- package/dist/actions/CopyButton.js +2 -2
- package/dist/actions/CopyButton.js.map +2 -2
- package/dist/actions/Menubar.d.ts +12 -5
- package/dist/actions/Menubar.js +37 -29
- package/dist/actions/Menubar.js.map +3 -3
- package/dist/actions/Toolbar.d.ts +42 -2
- package/dist/actions/Toolbar.js +18 -0
- package/dist/actions/Toolbar.js.map +2 -2
- package/dist/actions/internal/ButtonBase.d.ts +3 -2
- package/dist/actions/internal/ButtonBase.js +2 -4
- package/dist/actions/internal/ButtonBase.js.map +2 -2
- package/dist/actions/internal/CommandPaletteOptions.d.ts +7 -6
- package/dist/actions/internal/CommandPaletteOptions.js +24 -15
- package/dist/actions/internal/CommandPaletteOptions.js.map +2 -2
- package/dist/actions/internal/CommandPaletteStatus.js +23 -9
- package/dist/actions/internal/CommandPaletteStatus.js.map +2 -2
- package/dist/actions/menu/Menu.d.ts +5 -4
- package/dist/actions/menu/Menu.js +3 -6
- package/dist/actions/menu/Menu.js.map +2 -2
- package/dist/actions/menu/MenuChoices.d.ts +9 -7
- package/dist/actions/menu/MenuChoices.js +34 -6
- package/dist/actions/menu/MenuChoices.js.map +2 -2
- package/dist/actions/menu/MenuItem.d.ts +37 -8
- package/dist/actions/menu/MenuItem.js +47 -12
- package/dist/actions/menu/MenuItem.js.map +2 -2
- package/dist/actions/menu/MenuSubmenu.d.ts +9 -3
- package/dist/actions/menu/MenuSubmenu.js +26 -24
- package/dist/actions/menu/MenuSubmenu.js.map +2 -2
- package/dist/actions/{internal → menu/internal}/MenuPopup.d.ts +2 -3
- package/dist/actions/{internal → menu/internal}/MenuPopup.js +7 -12
- package/dist/actions/menu/internal/MenuPopup.js.map +7 -0
- package/dist/actions/{internal → menu/internal}/menuOpenChange.d.ts +1 -1
- package/dist/actions/menu/internal/menuTriggerProps.d.ts +11 -0
- package/dist/actions/menu/internal/menuTriggerProps.js +1 -0
- package/dist/assets/readme/overview-dark.png +0 -0
- package/dist/assets/readme/overview-light.png +0 -0
- package/dist/content/Accordion.d.ts +32 -2
- package/dist/content/Accordion.js +41 -12
- package/dist/content/Accordion.js.map +2 -2
- package/dist/content/CodeBlock.d.ts +13 -4
- package/dist/content/CodeBlock.js +2 -0
- package/dist/content/CodeBlock.js.map +2 -2
- package/dist/content/CodeDiff.d.ts +34 -4
- package/dist/content/CodeDiff.js +41 -24
- package/dist/content/CodeDiff.js.map +2 -2
- package/dist/content/Composer.d.ts +19 -2
- package/dist/content/Composer.js +19 -12
- package/dist/content/Composer.js.map +2 -2
- package/dist/content/Disclosure.d.ts +13 -1
- package/dist/content/Disclosure.js +9 -3
- package/dist/content/Disclosure.js.map +2 -2
- package/dist/content/HighlightedCodeBlock.d.ts +1 -1
- package/dist/content/HighlightedCodeBlock.js +2 -0
- package/dist/content/HighlightedCodeBlock.js.map +2 -2
- package/dist/content/Kbd.d.ts +12 -5
- package/dist/content/Kbd.js +2 -2
- package/dist/content/Kbd.js.map +2 -2
- package/dist/content/Markdown.d.ts +17 -1
- package/dist/content/Markdown.js +26 -4
- package/dist/content/Markdown.js.map +2 -2
- package/dist/content/Message.d.ts +29 -33
- package/dist/content/Message.js +21 -21
- package/dist/content/Message.js.map +2 -2
- package/dist/content/countDiffLines.d.ts +1 -1
- package/dist/content/countDiffLines.js.map +1 -1
- package/dist/content/internal/CodeBlockFrame.d.ts +3 -2
- package/dist/content/internal/CodeBlockFrame.js +25 -13
- package/dist/content/internal/CodeBlockFrame.js.map +2 -2
- package/dist/content/internal/MessageListFollow.js +1 -1
- package/dist/content/internal/MessageListFollow.js.map +2 -2
- package/dist/content/internal/MessageStatusLabel.d.ts +2 -1
- package/dist/content/internal/MessageStatusLabel.js.map +2 -2
- package/dist/content/internal/codeColors.js +2 -2
- package/dist/content/internal/codeColors.js.map +2 -2
- package/dist/content/internal/useCodeContrast.js +4 -3
- package/dist/content/internal/useCodeContrast.js.map +2 -2
- package/dist/data-display/Avatar.d.ts +13 -4
- package/dist/data-display/Avatar.js +8 -4
- package/dist/data-display/Avatar.js.map +2 -2
- package/dist/data-display/AvatarButton.d.ts +20 -5
- package/dist/data-display/AvatarButton.js +17 -2
- package/dist/data-display/AvatarButton.js.map +2 -2
- package/dist/data-display/AvatarGroup.d.ts +28 -12
- package/dist/data-display/AvatarGroup.js +21 -32
- package/dist/data-display/AvatarGroup.js.map +2 -2
- package/dist/data-display/Badge.d.ts +11 -8
- package/dist/data-display/Badge.js +4 -3
- package/dist/data-display/Badge.js.map +2 -2
- package/dist/data-display/List.d.ts +21 -9
- package/dist/data-display/List.js +1 -1
- package/dist/data-display/List.js.map +2 -2
- package/dist/data-display/Meter.d.ts +7 -1
- package/dist/data-display/Meter.js +11 -5
- package/dist/data-display/Meter.js.map +2 -2
- package/dist/data-display/RelativeTime.d.ts +8 -2
- package/dist/data-display/RelativeTime.js +18 -7
- package/dist/data-display/RelativeTime.js.map +2 -2
- package/dist/data-display/Table.d.ts +26 -7
- package/dist/data-display/Table.js +70 -65
- package/dist/data-display/Table.js.map +2 -2
- package/dist/data-display/formatRelativeTime.d.ts +0 -2
- package/dist/data-display/formatRelativeTime.js +4 -28
- package/dist/data-display/formatRelativeTime.js.map +2 -2
- package/dist/data-display/internal/ListNaming.js +1 -1
- package/dist/data-display/internal/ListNaming.js.map +1 -1
- package/dist/data-display/internal/ReorderableList.d.ts +3 -2
- package/dist/data-display/internal/ReorderableList.js +11 -16
- package/dist/data-display/internal/ReorderableList.js.map +2 -2
- package/dist/data-display/internal/avatarName.d.ts +2 -0
- package/dist/data-display/internal/avatarName.js +7 -0
- package/dist/data-display/internal/avatarName.js.map +7 -0
- package/dist/data-display/internal/{ListRows.d.ts → listMarkup.d.ts} +1 -1
- package/dist/data-display/internal/{ListRows.js → listMarkup.js} +29 -15
- package/dist/data-display/internal/listMarkup.js.map +7 -0
- package/dist/data-display/internal/relativeTimeFormat.d.ts +3 -0
- package/dist/data-display/internal/relativeTimeFormat.js +12 -0
- package/dist/data-display/internal/relativeTimeFormat.js.map +7 -0
- package/dist/data-display/internal/reorderController.js +3 -3
- package/dist/data-display/internal/reorderController.js.map +2 -2
- package/dist/data-display/internal/reorderGeometry.d.ts +0 -1
- package/dist/data-display/internal/reorderGeometry.js +1 -10
- package/dist/data-display/internal/reorderGeometry.js.map +2 -2
- package/dist/data-display/internal/tableColumns.js +8 -9
- package/dist/data-display/internal/tableColumns.js.map +2 -2
- package/dist/{internal/react/useStackedReport.d.ts → data-display/internal/tableStacking.d.ts} +2 -0
- package/dist/data-display/internal/tableStacking.js +49 -0
- package/dist/data-display/internal/tableStacking.js.map +7 -0
- package/dist/data-display/internal/useReorder.js +1 -1
- package/dist/data-display/internal/useReorder.js.map +1 -1
- package/dist/diff.d.ts +1 -1
- package/dist/diff.js +1 -4
- package/dist/diff.js.map +2 -2
- package/dist/feedback/Alert.d.ts +13 -3
- package/dist/feedback/Alert.js +16 -6
- package/dist/feedback/Alert.js.map +2 -2
- package/dist/feedback/EmptyState.d.ts +12 -3
- package/dist/feedback/EmptyState.js +6 -6
- package/dist/feedback/EmptyState.js.map +2 -2
- package/dist/feedback/Halo.d.ts +27 -0
- package/dist/feedback/Halo.js +21 -0
- package/dist/feedback/Halo.js.map +7 -0
- package/dist/feedback/Progress.js +3 -2
- package/dist/feedback/Progress.js.map +2 -2
- package/dist/feedback/toast/ToastProvider.js +1 -1
- package/dist/feedback/toast/ToastProvider.js.map +1 -1
- package/dist/feedback/toast/internal/ContainedToast.d.ts +12 -0
- package/dist/feedback/toast/internal/ContainedToast.js +43 -0
- package/dist/feedback/toast/internal/ContainedToast.js.map +7 -0
- package/dist/feedback/toast/internal/{PictureNotice.d.ts → ContainedToastRoot.d.ts} +1 -1
- package/dist/feedback/toast/internal/{PictureNotice.js → ContainedToastRoot.js} +3 -3
- package/dist/feedback/toast/internal/ContainedToastRoot.js.map +7 -0
- package/dist/feedback/toast/internal/LiveToast.d.ts +10 -0
- package/dist/feedback/toast/internal/LiveToast.js +78 -0
- package/dist/feedback/toast/internal/LiveToast.js.map +7 -0
- package/dist/feedback/toast/internal/ToastBody.d.ts +2 -1
- package/dist/feedback/toast/internal/ToastBody.js +6 -2
- package/dist/feedback/toast/internal/ToastBody.js.map +2 -2
- package/dist/feedback/toast/internal/ToastButtons.d.ts +14 -0
- package/dist/feedback/toast/internal/ToastButtons.js +77 -0
- package/dist/feedback/toast/internal/ToastButtons.js.map +7 -0
- package/dist/feedback/toast/internal/ToastManagerContext.d.ts +3 -0
- package/dist/feedback/toast/internal/ToastManagerContext.js +7 -0
- package/dist/feedback/toast/internal/ToastManagerContext.js.map +7 -0
- package/dist/feedback/toast/internal/ToastRegion.js +43 -172
- package/dist/feedback/toast/internal/ToastRegion.js.map +2 -2
- package/dist/feedback/toast/internal/toastEntry.d.ts +9 -2
- package/dist/feedback/toast/internal/toastEntry.js +10 -1
- package/dist/feedback/toast/internal/toastEntry.js.map +2 -2
- package/dist/feedback/toast/internal/useToastController.d.ts +3 -3
- package/dist/feedback/toast/internal/useToastController.js +4 -2
- package/dist/feedback/toast/internal/useToastController.js.map +2 -2
- package/dist/feedback/toast/internal/useToastGlide.js +2 -1
- package/dist/feedback/toast/internal/useToastGlide.js.map +2 -2
- package/dist/feedback/toast/toastTypes.d.ts +38 -11
- package/dist/feedback/toast/useToast.d.ts +0 -2
- package/dist/feedback/toast/useToast.js +2 -3
- package/dist/feedback/toast/useToast.js.map +2 -2
- package/dist/forms/Calendar.d.ts +30 -11
- package/dist/forms/Calendar.js +19 -13
- package/dist/forms/Calendar.js.map +2 -2
- package/dist/forms/Checkbox.d.ts +7 -1
- package/dist/forms/Checkbox.js +33 -27
- package/dist/forms/Checkbox.js.map +2 -2
- package/dist/forms/Combobox.d.ts +4 -4
- package/dist/forms/Combobox.js +26 -146
- package/dist/forms/Combobox.js.map +2 -2
- package/dist/forms/DatePicker.d.ts +38 -11
- package/dist/forms/DatePicker.js +32 -52
- package/dist/forms/DatePicker.js.map +2 -2
- package/dist/forms/DropZone.d.ts +23 -4
- package/dist/forms/DropZone.js +29 -11
- package/dist/forms/DropZone.js.map +2 -2
- package/dist/forms/Field.d.ts +7 -1
- package/dist/forms/Field.js +13 -6
- package/dist/forms/Field.js.map +2 -2
- package/dist/forms/MonthPicker.d.ts +8 -1
- package/dist/forms/MonthPicker.js +22 -42
- package/dist/forms/MonthPicker.js.map +2 -2
- package/dist/forms/Radio.d.ts +15 -5
- package/dist/forms/Radio.js +20 -18
- package/dist/forms/Radio.js.map +2 -2
- package/dist/forms/SearchField.d.ts +13 -5
- package/dist/forms/SearchField.js +26 -21
- package/dist/forms/SearchField.js.map +2 -2
- package/dist/forms/SegmentedControl.d.ts +37 -8
- package/dist/forms/SegmentedControl.js +31 -25
- package/dist/forms/SegmentedControl.js.map +2 -2
- package/dist/forms/Select.d.ts +31 -6
- package/dist/forms/Select.js +43 -24
- package/dist/forms/Select.js.map +2 -2
- package/dist/forms/Slider.d.ts +12 -4
- package/dist/forms/Slider.js +32 -21
- package/dist/forms/Slider.js.map +2 -2
- package/dist/forms/Switch.d.ts +7 -1
- package/dist/forms/Switch.js +31 -25
- package/dist/forms/Switch.js.map +2 -2
- package/dist/forms/TextField.d.ts +5 -5
- package/dist/forms/TextField.js +20 -11
- package/dist/forms/TextField.js.map +2 -2
- package/dist/forms/Textarea.d.ts +1 -1
- package/dist/forms/Textarea.js +12 -2
- package/dist/forms/Textarea.js.map +2 -2
- package/dist/forms/TimePicker.d.ts +8 -1
- package/dist/forms/TimePicker.js +20 -45
- package/dist/forms/TimePicker.js.map +2 -2
- package/dist/forms/color/ColorPicker.d.ts +1 -1
- package/dist/forms/color/ColorPicker.js +29 -23
- package/dist/forms/color/ColorPicker.js.map +2 -2
- package/dist/forms/color/ColorPickerButton.d.ts +12 -2
- package/dist/forms/color/ColorPickerButton.js +37 -22
- package/dist/forms/color/ColorPickerButton.js.map +2 -2
- package/dist/forms/color/ColorSwatch.js +2 -2
- package/dist/forms/color/ColorSwatch.js.map +2 -2
- package/dist/forms/color/internal/{colorChange.js → ColorChangeContext.js} +1 -1
- package/dist/forms/color/internal/{colorChange.js.map → ColorChangeContext.js.map} +1 -1
- package/dist/forms/color/internal/ColorLocale.d.ts +0 -3
- package/dist/forms/color/internal/ColorLocale.js +2 -8
- package/dist/forms/color/internal/ColorLocale.js.map +2 -2
- package/dist/forms/color/internal/ColorValues.d.ts +1 -1
- package/dist/forms/color/internal/ColorValues.js +2 -2
- package/dist/forms/color/internal/ColorValues.js.map +2 -2
- package/dist/forms/color/internal/SwatchList.js +6 -9
- package/dist/forms/color/internal/SwatchList.js.map +2 -2
- package/dist/forms/color/internal/colorPickerValueProps.d.ts +12 -0
- package/dist/forms/color/internal/colorValue.d.ts +1 -0
- package/dist/forms/color/internal/colorValue.js +5 -0
- package/dist/forms/color/internal/colorValue.js.map +2 -2
- package/dist/forms/color/internal/useColorFollowingValue.d.ts +7 -0
- package/dist/forms/color/internal/useColorFollowingValue.js +15 -0
- package/dist/forms/color/internal/useColorFollowingValue.js.map +7 -0
- package/dist/forms/color/internal/useFormResetting.d.ts +9 -0
- package/dist/forms/color/internal/useFormResetting.js +36 -0
- package/dist/forms/color/internal/useFormResetting.js.map +7 -0
- package/dist/forms/color/internal/useSwatchFocus.d.ts +17 -0
- package/dist/forms/color/internal/useSwatchFocus.js +62 -0
- package/dist/forms/color/internal/useSwatchFocus.js.map +7 -0
- package/dist/forms/internal/ComboboxField.d.ts +30 -0
- package/dist/forms/internal/ComboboxField.js +147 -0
- package/dist/forms/internal/ComboboxField.js.map +7 -0
- package/dist/forms/internal/ComboboxPopup.d.ts +2 -2
- package/dist/forms/internal/ComboboxPopup.js +8 -16
- package/dist/forms/internal/ComboboxPopup.js.map +2 -2
- package/dist/forms/internal/MonthGrid.d.ts +1 -1
- package/dist/forms/internal/MonthGrid.js +4 -4
- package/dist/forms/internal/MonthGrid.js.map +2 -2
- package/dist/forms/internal/PickerField.d.ts +32 -27
- package/dist/forms/internal/PickerField.js +70 -52
- package/dist/forms/internal/PickerField.js.map +3 -3
- package/dist/forms/internal/PickerPopup.d.ts +2 -1
- package/dist/forms/internal/PickerPopup.js +3 -0
- package/dist/forms/internal/PickerPopup.js.map +2 -2
- package/dist/forms/internal/TimeList.d.ts +1 -1
- package/dist/forms/internal/TimeList.js +4 -4
- package/dist/forms/internal/TimeList.js.map +2 -2
- package/dist/forms/internal/TimeWheel.d.ts +3 -3
- package/dist/forms/internal/TimeWheel.js +5 -5
- package/dist/forms/internal/TimeWheel.js.map +2 -2
- package/dist/{internal/time → forms/internal}/calendarDays.d.ts +1 -0
- package/dist/{internal/time → forms/internal}/calendarDays.js +5 -1
- package/dist/forms/internal/calendarDays.js.map +7 -0
- package/dist/forms/internal/comboboxItems.d.ts +15 -4
- package/dist/forms/internal/comboboxItems.js +0 -12
- package/dist/forms/internal/comboboxItems.js.map +3 -3
- package/dist/forms/internal/pickerFocus.d.ts +4 -0
- package/dist/forms/internal/pickerFocus.js +13 -0
- package/dist/forms/internal/pickerFocus.js.map +7 -0
- package/dist/forms/internal/timeWheelRows.d.ts +4 -4
- package/dist/forms/internal/timeWheelRows.js +6 -4
- package/dist/forms/internal/timeWheelRows.js.map +2 -2
- package/dist/forms/internal/useComboboxOpen.js +2 -5
- package/dist/forms/internal/useComboboxOpen.js.map +2 -2
- package/dist/forms/internal/useComboboxOptions.js +3 -4
- package/dist/forms/internal/useComboboxOptions.js.map +2 -2
- package/dist/forms/internal/useComboboxSelection.d.ts +1 -1
- package/dist/forms/internal/usePicker.d.ts +29 -0
- package/dist/forms/internal/usePicker.js +38 -0
- package/dist/forms/internal/usePicker.js.map +7 -0
- package/dist/forms/internal/usePickerFormatter.d.ts +4 -0
- package/dist/forms/internal/usePickerFormatter.js +23 -0
- package/dist/forms/internal/usePickerFormatter.js.map +7 -0
- package/dist/forms/internal/useTimeWheelTurn.d.ts +2 -2
- package/dist/forms/internal/useTimeWheelTurn.js +7 -7
- package/dist/forms/internal/useTimeWheelTurn.js.map +2 -2
- package/dist/foundations/PortalContainer.js +1 -1
- package/dist/foundations/PortalContainer.js.map +1 -1
- package/dist/foundations/Theme.d.ts +9 -2
- package/dist/foundations/Theme.js +24 -19
- package/dist/foundations/Theme.js.map +2 -2
- package/dist/foundations/ThemeMenuRadioGroup.d.ts +13 -6
- package/dist/foundations/ThemeMenuRadioGroup.js +6 -11
- package/dist/foundations/ThemeMenuRadioGroup.js.map +2 -2
- package/dist/foundations/ThemePreferenceProvider.d.ts +48 -0
- package/dist/foundations/{ThemePreference.js → ThemePreferenceProvider.js} +48 -106
- package/dist/foundations/ThemePreferenceProvider.js.map +7 -0
- package/dist/foundations/ThemeToggle.d.ts +9 -2
- package/dist/foundations/ThemeToggle.js +3 -2
- package/dist/foundations/ThemeToggle.js.map +2 -2
- package/dist/foundations/internal/ThemePreferenceContext.d.ts +4 -4
- package/dist/foundations/internal/ThemePreferenceContext.js.map +1 -1
- package/dist/foundations/internal/storedPreference.d.ts +3 -0
- package/dist/foundations/internal/storedPreference.js +8 -0
- package/dist/foundations/internal/storedPreference.js.map +7 -0
- package/dist/foundations/messages/defaultMessages.d.ts +4 -72
- package/dist/foundations/messages/defaultMessages.js +0 -14
- package/dist/foundations/messages/defaultMessages.js.map +2 -2
- package/dist/foundations/messages/list.d.ts +13 -35
- package/dist/foundations/messages/list.js +1 -5
- package/dist/foundations/messages/list.js.map +2 -2
- package/dist/foundations/messages/message.d.ts +1 -1
- package/dist/foundations/messages/message.js +1 -1
- package/dist/foundations/messages/message.js.map +1 -1
- package/dist/foundations/messages/navigation.d.ts +4 -0
- package/dist/foundations/messages/navigation.js +2 -0
- package/dist/foundations/messages/navigation.js.map +2 -2
- package/dist/foundations/themeBootstrap.d.ts +13 -35
- package/dist/foundations/themeBootstrap.js +4 -35
- package/dist/foundations/themeBootstrap.js.map +2 -2
- package/dist/foundations/themeStorage.d.ts +20 -0
- package/dist/foundations/themeStorage.js +12 -0
- package/dist/foundations/themeStorage.js.map +7 -0
- package/dist/foundations/useContainerSize.js +13 -11
- package/dist/foundations/useContainerSize.js.map +2 -2
- package/dist/foundations/useSkeleton.d.ts +5 -0
- package/dist/foundations/useSkeleton.js +10 -0
- package/dist/foundations/useSkeleton.js.map +7 -0
- package/dist/foundations/useStoredThemePreference.d.ts +16 -0
- package/dist/foundations/useStoredThemePreference.js +63 -0
- package/dist/foundations/useStoredThemePreference.js.map +7 -0
- package/dist/foundations/windowClasses.d.ts +0 -2
- package/dist/foundations/windowClasses.js +1 -4
- package/dist/foundations/windowClasses.js.map +2 -2
- package/dist/index.d.ts +15 -20
- package/dist/index.js +16 -36
- package/dist/index.js.map +2 -2
- package/dist/internal/control/ActionElement.d.ts +3 -2
- package/dist/internal/control/ActionElement.js +8 -0
- package/dist/internal/control/ActionElement.js.map +2 -2
- package/dist/internal/dialog/ModalLayer.d.ts +9 -0
- package/dist/internal/dialog/ModalLayer.js +32 -0
- package/dist/internal/dialog/ModalLayer.js.map +7 -0
- package/dist/internal/dom/idRefs.d.ts +2 -0
- package/dist/internal/dom/idRefs.js +7 -0
- package/dist/internal/dom/idRefs.js.map +7 -0
- package/dist/internal/dom/lengths.d.ts +3 -1
- package/dist/internal/dom/lengths.js +7 -2
- package/dist/internal/dom/lengths.js.map +2 -2
- package/dist/internal/dom/observeResize.d.ts +7 -0
- package/dist/internal/dom/observeResize.js +11 -0
- package/dist/internal/dom/observeResize.js.map +7 -0
- package/dist/internal/dom/verticalScrollerOf.d.ts +5 -0
- package/dist/internal/dom/verticalScrollerOf.js +12 -0
- package/dist/internal/dom/verticalScrollerOf.js.map +7 -0
- package/dist/internal/field/FieldFrame.d.ts +2 -61
- package/dist/internal/field/FieldFrame.js +17 -8
- package/dist/internal/field/FieldFrame.js.map +2 -2
- package/dist/internal/field/{rowControl.d.ts → RowControl.d.ts} +2 -2
- package/dist/internal/field/{rowControl.js → RowControl.js} +4 -7
- package/dist/internal/field/RowControl.js.map +7 -0
- package/dist/internal/field/TextareaControl.d.ts +2 -2
- package/dist/internal/field/TextareaControl.js +5 -11
- package/dist/internal/field/TextareaControl.js.map +2 -2
- package/dist/internal/field/{TextareaResizeEdge.d.ts → TextareaResizeHandle.d.ts} +1 -1
- package/dist/internal/field/{TextareaResizeEdge.js → TextareaResizeHandle.js} +10 -11
- package/dist/internal/field/TextareaResizeHandle.js.map +7 -0
- package/dist/internal/field/fieldProps.d.ts +67 -0
- package/dist/internal/field/fieldProps.js +1 -0
- package/dist/internal/field/fieldProps.js.map +7 -0
- package/dist/internal/field/fieldSizing.d.ts +1 -0
- package/dist/internal/field/fieldSizing.js +5 -0
- package/dist/internal/field/fieldSizing.js.map +7 -0
- package/dist/internal/field/useFieldControl.d.ts +36 -0
- package/dist/internal/field/useFieldControl.js +53 -0
- package/dist/internal/field/useFieldControl.js.map +7 -0
- package/dist/internal/field/useFormReset.js +1 -1
- package/dist/internal/field/useFormReset.js.map +1 -1
- package/dist/internal/icon/DecorativeIcon.d.ts +2 -1
- package/dist/internal/icon/DecorativeIcon.js +6 -2
- package/dist/internal/icon/DecorativeIcon.js.map +2 -2
- package/dist/internal/layout/Slot.d.ts +2 -1
- package/dist/internal/layout/Slot.js +3 -1
- package/dist/internal/layout/Slot.js.map +2 -2
- package/dist/internal/popup/ListRow.d.ts +39 -0
- package/dist/internal/{list → popup}/ListRow.js +15 -7
- package/dist/internal/popup/ListRow.js.map +7 -0
- package/dist/internal/popup/PopupSurface.d.ts +1 -1
- package/dist/internal/popup/PopupSurface.js +3 -6
- package/dist/internal/popup/PopupSurface.js.map +2 -2
- package/dist/internal/popup/TooltipPopup.d.ts +3 -9
- package/dist/internal/popup/TooltipPopup.js +2 -9
- package/dist/internal/popup/TooltipPopup.js.map +2 -2
- package/dist/internal/popup/{PortalContainerContext.d.ts → containedOverlays.d.ts} +2 -14
- package/dist/internal/popup/{PortalContainerContext.js → containedOverlays.js} +7 -13
- package/dist/internal/popup/containedOverlays.js.map +7 -0
- package/dist/internal/popup/listEntries.d.ts +13 -0
- package/dist/internal/popup/listEntries.js +11 -0
- package/dist/internal/popup/listEntries.js.map +7 -0
- package/dist/internal/popup/useCutShort.d.ts +6 -0
- package/dist/internal/popup/useCutShort.js +19 -0
- package/dist/internal/popup/useCutShort.js.map +7 -0
- package/dist/internal/provider/PortalContainerContext.d.ts +14 -0
- package/dist/internal/provider/PortalContainerContext.js +11 -0
- package/dist/internal/provider/PortalContainerContext.js.map +7 -0
- package/dist/internal/provider/formatters.d.ts +17 -0
- package/dist/internal/provider/formatters.js +21 -0
- package/dist/internal/provider/formatters.js.map +7 -0
- package/dist/internal/provider/locale.d.ts +4 -4
- package/dist/internal/provider/locale.js +9 -1
- package/dist/internal/provider/locale.js.map +2 -2
- package/dist/internal/provider/useDirection.d.ts +1 -1
- package/dist/internal/provider/useDirection.js +2 -14
- package/dist/internal/provider/useDirection.js.map +2 -2
- package/dist/internal/provider/useFormatters.d.ts +1 -16
- package/dist/internal/provider/useFormatters.js +3 -26
- package/dist/internal/provider/useFormatters.js.map +2 -2
- package/dist/internal/rangeBarProps.d.ts +6 -2
- package/dist/internal/react/chainHandlers.d.ts +6 -0
- package/dist/internal/react/chainHandlers.js +12 -0
- package/dist/internal/react/chainHandlers.js.map +7 -0
- package/dist/internal/react/renderElement.js +2 -14
- package/dist/internal/react/renderElement.js.map +2 -2
- package/dist/internal/react/rendersContent.d.ts +2 -0
- package/dist/internal/react/rendersContent.js +7 -0
- package/dist/internal/react/rendersContent.js.map +7 -0
- package/dist/internal/react/setRef.d.ts +6 -1
- package/dist/internal/react/setRef.js +13 -0
- package/dist/internal/react/setRef.js.map +2 -2
- package/dist/internal/react/useControllableState.js +1 -1
- package/dist/internal/react/useControllableState.js.map +1 -1
- package/dist/internal/{useCopy.js.map → react/useCopy.js.map} +1 -1
- package/dist/internal/{useLatest.js.map → react/useLatest.js.map} +1 -1
- package/dist/internal/react/useMergedRefs.d.ts +3 -0
- package/dist/internal/react/useMergedRefs.js +10 -0
- package/dist/internal/react/useMergedRefs.js.map +7 -0
- package/dist/internal/resize/useResizableWidth.d.ts +4 -16
- package/dist/internal/resize/useResizableWidth.js +5 -17
- package/dist/internal/resize/useResizableWidth.js.map +2 -2
- package/dist/internal/sizeTokens.d.ts +13 -0
- package/dist/internal/sizeTokens.js +15 -0
- package/dist/internal/sizeTokens.js.map +7 -0
- package/dist/internal/skeleton/SkeletonContext.d.ts +2 -0
- package/dist/internal/skeleton/SkeletonContext.js +7 -0
- package/dist/internal/skeleton/SkeletonContext.js.map +7 -0
- package/dist/{foundations → internal/skeleton}/SkeletonScope.d.ts +0 -10
- package/dist/{foundations → internal/skeleton}/SkeletonScope.js +6 -11
- package/dist/internal/skeleton/SkeletonScope.js.map +7 -0
- package/dist/internal/{skeleton.d.ts → skeleton/skeleton.d.ts} +1 -3
- package/dist/internal/{skeleton.js → skeleton/skeleton.js} +1 -2
- package/dist/internal/skeleton/skeleton.js.map +7 -0
- package/dist/{foundations/internal → internal/skeleton}/skeletonText.js +5 -5
- package/dist/internal/skeleton/skeletonText.js.map +7 -0
- package/dist/internal/text/labelText.d.ts +15 -0
- package/dist/internal/text/labelText.js +34 -0
- package/dist/internal/text/labelText.js.map +7 -0
- package/dist/internal/text/useRenderedText.d.ts +3 -0
- package/dist/internal/text/useRenderedText.js +19 -0
- package/dist/internal/text/useRenderedText.js.map +7 -0
- package/dist/internal/theme/themeRoot.d.ts +27 -0
- package/dist/internal/theme/themeRoot.js +45 -0
- package/dist/internal/theme/themeRoot.js.map +7 -0
- package/dist/internal/typeahead.d.ts +9 -5
- package/dist/internal/typeahead.js +4 -1
- package/dist/internal/typeahead.js.map +2 -2
- package/dist/layout/Card.d.ts +21 -4
- package/dist/layout/Card.js +12 -6
- package/dist/layout/Card.js.map +2 -2
- package/dist/layout/Layout.d.ts +2 -2
- package/dist/layout/Layout.js.map +1 -1
- package/dist/layout/Page.d.ts +2 -2
- package/dist/layout/Page.js.map +1 -1
- package/dist/layout/PageHeader.d.ts +6 -1
- package/dist/layout/PageHeader.js +3 -1
- package/dist/layout/PageHeader.js.map +2 -2
- package/dist/layout/Panes.d.ts +10 -20
- package/dist/layout/Panes.js +5 -25
- package/dist/layout/Panes.js.map +2 -2
- package/dist/layout/ResizeHandle.d.ts +1 -0
- package/dist/layout/ResizeHandle.js +11 -21
- package/dist/layout/ResizeHandle.js.map +2 -2
- package/dist/layout/Scaffold.d.ts +14 -4
- package/dist/layout/Scaffold.js +16 -51
- package/dist/layout/Scaffold.js.map +2 -2
- package/dist/layout/Surface.d.ts +1 -1
- package/dist/layout/Surface.js +4 -1
- package/dist/layout/Surface.js.map +2 -2
- package/dist/layout/TopBar.d.ts +2 -2
- package/dist/layout/TopBar.js +4 -5
- package/dist/layout/TopBar.js.map +2 -2
- package/dist/layout/internal/LoadingBar.d.ts +3 -7
- package/dist/layout/internal/LoadingBar.js +5 -10
- package/dist/layout/internal/LoadingBar.js.map +2 -2
- package/dist/layout/internal/PageTitleFocus.d.ts +0 -9
- package/dist/layout/internal/PageTitleFocus.js +3 -24
- package/dist/layout/internal/PageTitleFocus.js.map +2 -2
- package/dist/layout/internal/StickyHeaderSize.js +3 -3
- package/dist/layout/internal/StickyHeaderSize.js.map +2 -2
- package/dist/layout/internal/{navigationForms.d.ts → scaffold/navigationForms.d.ts} +2 -2
- package/dist/layout/internal/scaffold/navigationForms.js.map +7 -0
- package/dist/layout/internal/{scaffoldFocus.js.map → scaffold/scaffoldFocus.js.map} +1 -1
- package/dist/layout/internal/{scrollKeys.js → scaffold/scrollKeys.js} +1 -1
- package/dist/layout/internal/scaffold/scrollKeys.js.map +7 -0
- package/dist/layout/internal/scaffold/useBarSizes.d.ts +6 -0
- package/dist/layout/internal/scaffold/useBarSizes.js +54 -0
- package/dist/layout/internal/scaffold/useBarSizes.js.map +7 -0
- package/dist/layout/internal/{useNavigationFocusHandoff.js → scaffold/useNavigationFocusHandoff.js} +5 -4
- package/dist/layout/internal/scaffold/useNavigationFocusHandoff.js.map +7 -0
- package/dist/layout/internal/{useScrollKeys.js → scaffold/useScrollKeys.js} +1 -1
- package/dist/layout/internal/scaffold/useScrollKeys.js.map +7 -0
- package/dist/layout/internal/scaffoldPages.d.ts +9 -0
- package/dist/layout/internal/scaffoldPages.js +27 -0
- package/dist/layout/internal/scaffoldPages.js.map +7 -0
- package/dist/markdown.d.ts +0 -1
- package/dist/markdown.js +0 -1
- package/dist/markdown.js.map +2 -2
- package/dist/messages.d.ts +1 -1
- package/dist/messages.js +1 -6
- package/dist/messages.js.map +2 -2
- package/dist/navigation/Breadcrumbs.d.ts +15 -4
- package/dist/navigation/Breadcrumbs.js +36 -27
- package/dist/navigation/Breadcrumbs.js.map +2 -2
- package/dist/navigation/DocumentTabs.d.ts +54 -12
- package/dist/navigation/DocumentTabs.js +50 -150
- package/dist/navigation/DocumentTabs.js.map +3 -3
- package/dist/navigation/NavigationBar.d.ts +10 -3
- package/dist/navigation/NavigationBar.js +75 -35
- package/dist/navigation/NavigationBar.js.map +2 -2
- package/dist/navigation/NavigationDrawer.d.ts +9 -3
- package/dist/navigation/NavigationDrawer.js +24 -217
- package/dist/navigation/NavigationDrawer.js.map +2 -2
- package/dist/navigation/NavigationRail.d.ts +10 -3
- package/dist/navigation/NavigationRail.js +20 -10
- package/dist/navigation/NavigationRail.js.map +2 -2
- package/dist/navigation/Pager.d.ts +25 -11
- package/dist/navigation/Pager.js +49 -12
- package/dist/navigation/Pager.js.map +3 -3
- package/dist/navigation/Pagination.d.ts +24 -9
- package/dist/navigation/Pagination.js +37 -11
- package/dist/navigation/Pagination.js.map +2 -2
- package/dist/navigation/TableOfContents.d.ts +18 -4
- package/dist/navigation/TableOfContents.js +41 -121
- package/dist/navigation/TableOfContents.js.map +2 -2
- package/dist/navigation/Tree.d.ts +28 -11
- package/dist/navigation/Tree.js +41 -37
- package/dist/navigation/Tree.js.map +2 -2
- package/dist/navigation/destinations.d.ts +43 -11
- package/dist/navigation/internal/DestinationItem.d.ts +5 -41
- package/dist/navigation/internal/DestinationItem.js +41 -44
- package/dist/navigation/internal/DestinationItem.js.map +2 -2
- package/dist/navigation/internal/destinationModel.d.ts +16 -0
- package/dist/navigation/internal/destinationModel.js +28 -0
- package/dist/navigation/internal/destinationModel.js.map +7 -0
- package/dist/navigation/internal/documentTabs/DocumentTab.d.ts +12 -0
- package/dist/navigation/internal/documentTabs/DocumentTab.js +122 -0
- package/dist/navigation/internal/documentTabs/DocumentTab.js.map +7 -0
- package/dist/navigation/internal/documentTabs/tabMenuContent.d.ts +21 -0
- package/dist/navigation/internal/documentTabs/tabMenuContent.js +73 -0
- package/dist/navigation/internal/documentTabs/tabMenuContent.js.map +7 -0
- package/dist/navigation/internal/documentTabs/tabStrip.d.ts +7 -0
- package/dist/navigation/internal/documentTabs/tabStrip.js +26 -0
- package/dist/navigation/internal/documentTabs/tabStrip.js.map +7 -0
- package/dist/navigation/internal/{useTabCloseFocus.js → documentTabs/useTabCloseFocus.js} +2 -2
- package/dist/navigation/internal/documentTabs/useTabCloseFocus.js.map +7 -0
- package/dist/navigation/internal/{useTabDrag.d.ts → documentTabs/useTabDrag.d.ts} +3 -3
- package/dist/navigation/internal/{useTabDrag.js → documentTabs/useTabDrag.js} +8 -8
- package/dist/navigation/internal/documentTabs/useTabDrag.js.map +7 -0
- package/dist/navigation/internal/{useTabStripScrolling.js → documentTabs/useTabStripScrolling.js} +22 -3
- package/dist/navigation/internal/documentTabs/useTabStripScrolling.js.map +7 -0
- package/dist/navigation/internal/landmarkLabel.d.ts +1 -0
- package/dist/navigation/internal/landmarkLabel.js +5 -0
- package/dist/navigation/internal/landmarkLabel.js.map +7 -0
- package/dist/navigation/internal/navigationDrawer/DrawerRows.d.ts +18 -0
- package/dist/navigation/internal/navigationDrawer/DrawerRows.js +151 -0
- package/dist/navigation/internal/navigationDrawer/DrawerRows.js.map +7 -0
- package/dist/navigation/internal/navigationDrawer/destinationSections.d.ts +13 -0
- package/dist/navigation/internal/navigationDrawer/destinationSections.js +13 -0
- package/dist/navigation/internal/navigationDrawer/destinationSections.js.map +7 -0
- package/dist/navigation/internal/navigationDrawer/useExpandedSections.d.ts +6 -0
- package/dist/navigation/internal/navigationDrawer/useExpandedSections.js +57 -0
- package/dist/navigation/internal/navigationDrawer/useExpandedSections.js.map +7 -0
- package/dist/navigation/internal/tableOfContents/contentsOutline.d.ts +26 -0
- package/dist/navigation/internal/tableOfContents/contentsOutline.js +38 -0
- package/dist/navigation/internal/tableOfContents/contentsOutline.js.map +7 -0
- package/dist/navigation/internal/{contentsWave.js → tableOfContents/contentsWave.js} +1 -1
- package/dist/navigation/internal/tableOfContents/contentsWave.js.map +7 -0
- package/dist/navigation/internal/tableOfContents/readingPosition.d.ts +25 -0
- package/dist/navigation/internal/{contentsOutline.js → tableOfContents/readingPosition.js} +2 -37
- package/dist/navigation/internal/tableOfContents/readingPosition.js.map +7 -0
- package/dist/navigation/internal/{sectionScroll.d.ts → tableOfContents/sectionScroll.d.ts} +6 -1
- package/dist/navigation/internal/{sectionScroll.js → tableOfContents/sectionScroll.js} +18 -10
- package/dist/navigation/internal/tableOfContents/sectionScroll.js.map +7 -0
- package/dist/navigation/internal/{useContentsHeadings.d.ts → tableOfContents/useContentsHeadings.d.ts} +2 -2
- package/dist/navigation/internal/{useContentsHeadings.js → tableOfContents/useContentsHeadings.js} +4 -7
- package/dist/navigation/internal/tableOfContents/useContentsHeadings.js.map +7 -0
- package/dist/navigation/internal/tableOfContents/useReadingPlace.d.ts +15 -0
- package/dist/navigation/internal/tableOfContents/useReadingPlace.js +119 -0
- package/dist/navigation/internal/tableOfContents/useReadingPlace.js.map +7 -0
- package/dist/navigation/internal/{waveDrawer.js → tableOfContents/waveDrawer.js} +5 -4
- package/dist/navigation/internal/tableOfContents/waveDrawer.js.map +7 -0
- package/dist/navigation/internal/{TreeRow.d.ts → tree/TreeRow.d.ts} +1 -1
- package/dist/navigation/internal/{TreeRow.js → tree/TreeRow.js} +9 -5
- package/dist/navigation/internal/tree/TreeRow.js.map +7 -0
- package/dist/navigation/internal/{treeModel.d.ts → tree/treeModel.d.ts} +7 -9
- package/dist/navigation/internal/{treeModel.js → tree/treeModel.js} +10 -13
- package/dist/navigation/internal/tree/treeModel.js.map +7 -0
- package/dist/navigation/internal/{useTreeTransitions.d.ts → tree/useTreeTransitions.d.ts} +1 -1
- package/dist/navigation/internal/tree/useTreeTransitions.js.map +7 -0
- package/dist/navigation/internal/{useTreeViewport.d.ts → tree/useTreeViewport.d.ts} +3 -3
- package/dist/navigation/internal/{useTreeViewport.js → tree/useTreeViewport.js} +11 -12
- package/dist/navigation/internal/tree/useTreeViewport.js.map +7 -0
- package/dist/navigation/internal/useLabelText.d.ts +6 -0
- package/dist/navigation/internal/useLabelText.js +11 -0
- package/dist/navigation/internal/useLabelText.js.map +7 -0
- package/dist/navigation/navigationBackground.d.ts +0 -2
- package/dist/navigation/navigationBackground.js +0 -6
- package/dist/navigation/navigationBackground.js.map +3 -3
- package/dist/overlays/ConfirmDialog.d.ts +6 -3
- package/dist/overlays/ConfirmDialog.js +64 -68
- package/dist/overlays/ConfirmDialog.js.map +2 -2
- package/dist/overlays/Dialog.d.ts +40 -6
- package/dist/overlays/Dialog.js +69 -41
- package/dist/overlays/Dialog.js.map +2 -2
- package/dist/overlays/HoverCard.d.ts +9 -2
- package/dist/overlays/HoverCard.js +5 -5
- package/dist/overlays/HoverCard.js.map +2 -2
- package/dist/overlays/Popover.d.ts +20 -5
- package/dist/overlays/Popover.js +8 -6
- package/dist/overlays/Popover.js.map +2 -2
- package/dist/overlays/Sheet.d.ts +16 -3
- package/dist/overlays/Sheet.js +88 -87
- package/dist/overlays/Sheet.js.map +2 -2
- package/dist/overlays/Tooltip.d.ts +7 -0
- package/dist/overlays/Tooltip.js +10 -15
- package/dist/overlays/Tooltip.js.map +2 -2
- package/dist/overlays/internal/accessibleName.js +2 -1
- package/dist/overlays/internal/accessibleName.js.map +2 -2
- package/dist/overlays/internal/dialog/DialogHeadingClose.d.ts +8 -0
- package/dist/overlays/internal/dialog/DialogHeadingClose.js +19 -0
- package/dist/overlays/internal/dialog/DialogHeadingClose.js.map +7 -0
- package/dist/overlays/internal/dialog/DialogParts.d.ts +33 -0
- package/dist/overlays/internal/dialog/DialogParts.js +64 -0
- package/dist/overlays/internal/dialog/DialogParts.js.map +7 -0
- package/dist/overlays/internal/{DialogPendingAction.d.ts → dialog/dialogPending.d.ts} +8 -0
- package/dist/overlays/internal/{DialogPendingAction.js → dialog/dialogPending.js} +13 -2
- package/dist/overlays/internal/dialog/dialogPending.js.map +7 -0
- package/dist/styles/Accordion.css +1 -1
- package/dist/styles/Alert.css +1 -1
- package/dist/styles/Avatar.css +1 -1
- package/dist/styles/Badge.css +1 -1
- package/dist/styles/Base.css +1 -1
- package/dist/styles/Breadcrumbs.css +1 -1
- package/dist/styles/Card.css +1 -1
- package/dist/styles/Checkbox.css +1 -1
- package/dist/styles/Code.css +1 -1
- package/dist/styles/Combobox.css +1 -1
- package/dist/styles/CommandPalette.css +1 -1
- package/dist/styles/Composer.css +1 -1
- package/dist/styles/CopyButton.css +1 -1
- package/dist/styles/Dialog.css +1 -1
- package/dist/styles/Disclosure.css +1 -1
- package/dist/styles/DocumentTabs.css +1 -1
- package/dist/styles/DropZone.css +1 -1
- package/dist/styles/EmptyState.css +1 -1
- package/dist/styles/Halo.css +1 -0
- package/dist/styles/List.css +1 -1
- package/dist/styles/ListRow.css +1 -1
- package/dist/styles/LoadingBar.css +1 -1
- package/dist/styles/Menu.css +1 -1
- package/dist/styles/Message.css +1 -1
- package/dist/styles/Meter.css +1 -1
- package/dist/styles/NavigationBar.css +1 -1
- package/dist/styles/NavigationDestinations.css +1 -0
- package/dist/styles/NavigationDrawer.css +1 -1
- package/dist/styles/NavigationRail.css +1 -1
- package/dist/styles/Pager.css +1 -1
- package/dist/styles/Panes.css +1 -1
- package/dist/styles/Progress.css +1 -0
- package/dist/styles/Radio.css +1 -1
- package/dist/styles/Scaffold.css +1 -1
- package/dist/styles/SegmentedControl.css +1 -1
- package/dist/styles/Select.css +1 -1
- package/dist/styles/Switch.css +1 -1
- package/dist/styles/Table.css +1 -1
- package/dist/styles/TableOfContents.css +1 -1
- package/dist/styles/Text.css +1 -1
- package/dist/styles/TextField.css +1 -1
- package/dist/styles/Toast.css +1 -1
- package/dist/styles/Toolbar.css +1 -1
- package/dist/styles/Tree.css +1 -1
- package/dist/styles.css +1 -1
- package/dist/theme-bootstrap.d.ts +1 -1
- package/dist/theme-bootstrap.js +1 -8
- package/dist/theme-bootstrap.js.map +2 -2
- package/dist/theme-storage.d.ts +2 -0
- package/dist/theme-storage.js +3 -0
- package/dist/theme-storage.js.map +7 -0
- package/dist/tokens.json +0 -13
- package/docs/components/accordion.md +13 -0
- package/docs/components/alert.md +8 -1
- package/docs/components/avatar.md +16 -4
- package/docs/components/badge.md +10 -39
- package/docs/components/box.md +3 -3
- package/docs/components/breadcrumbs.md +6 -1
- package/docs/components/button.md +14 -9
- package/docs/components/card.md +14 -5
- package/docs/components/checkbox.md +3 -1
- package/docs/components/code.md +15 -6
- package/docs/components/color-picker.md +10 -2
- package/docs/components/column.md +2 -2
- package/docs/components/combobox.md +1 -1
- package/docs/components/command-palette.md +6 -2
- package/docs/components/composer.md +19 -8
- package/docs/components/confirm-dialog.md +3 -3
- package/docs/components/date-picker.md +15 -3
- package/docs/components/description-list.md +1 -1
- package/docs/components/dialog.md +34 -8
- package/docs/components/disclosure.md +4 -0
- package/docs/components/document-tabs.md +23 -13
- package/docs/components/drop-zone.md +10 -1
- package/docs/components/empty-state.md +12 -3
- package/docs/components/field.md +2 -1
- package/docs/components/graphic.md +1 -1
- package/docs/components/grid.md +2 -2
- package/docs/components/halo.md +80 -0
- package/docs/components/hover-card.md +2 -1
- package/docs/components/kbd.md +8 -2
- package/docs/components/link.md +1 -1
- package/docs/components/list.md +13 -5
- package/docs/components/markdown.md +9 -116
- package/docs/components/menu.md +28 -12
- package/docs/components/menubar.md +4 -3
- package/docs/components/message.md +17 -13
- package/docs/components/meter.md +8 -3
- package/docs/components/month-picker.md +4 -2
- package/docs/components/navigation-drawer.md +32 -7
- package/docs/components/page.md +4 -3
- package/docs/components/pager.md +16 -6
- package/docs/components/pagination.md +3 -2
- package/docs/components/panes.md +13 -26
- package/docs/components/popover.md +3 -2
- package/docs/components/progress.md +2 -2
- package/docs/components/radio.md +13 -5
- package/docs/components/relative-time.md +2 -1
- package/docs/components/resize-handle.md +6 -4
- package/docs/components/row.md +2 -2
- package/docs/components/scaffold.md +13 -4
- package/docs/components/segmented-control.md +10 -4
- package/docs/components/select.md +10 -2
- package/docs/components/sheet.md +4 -1
- package/docs/components/slider.md +8 -2
- package/docs/components/spinner.md +1 -1
- package/docs/components/surface.md +1 -1
- package/docs/components/switch.md +2 -0
- package/docs/components/table-of-contents.md +3 -2
- package/docs/components/table.md +18 -3
- package/docs/components/text-field.md +14 -8
- package/docs/components/time-picker.md +4 -2
- package/docs/components/toast.md +2 -1
- package/docs/components/toolbar.md +31 -6
- package/docs/components/tooltip.md +1 -0
- package/docs/components/top-bar.md +1 -1
- package/docs/components/tree.md +9 -4
- package/docs/customizing.md +59 -91
- package/docs/examples/accordion/IntegrationSwitches.tsx +33 -0
- package/docs/examples/alert/BannerAction.tsx +19 -0
- package/docs/examples/avatar/BotsAndPresence.tsx +24 -0
- package/docs/examples/badge/BadgeAnatomy.tsx +1 -1
- package/docs/examples/badge/CountsInButtons.tsx +2 -2
- package/docs/examples/badge/WithContent.tsx +13 -0
- package/docs/examples/breadcrumbs/WithAvatar.tsx +20 -0
- package/docs/examples/button/ButtonAnatomy.tsx +1 -1
- package/docs/examples/button/CreateProject.tsx +1 -1
- package/docs/examples/button/FillSidebar.tsx +1 -1
- package/docs/examples/button/Icons.tsx +2 -2
- package/docs/examples/button/PictureBeforeLabel.tsx +14 -0
- package/docs/examples/card/CardAnatomy.tsx +3 -1
- package/docs/examples/card/OpenFromCard.tsx +65 -0
- package/docs/examples/code/PackageManagers.tsx +35 -0
- package/docs/examples/code/SettingsDiff.tsx +5 -9
- package/docs/examples/color-picker/TextColorInToolbar.tsx +44 -0
- package/docs/examples/colors/Status.tsx +6 -6
- package/docs/examples/command-palette/CommandPaletteAnatomy.tsx +11 -5
- package/docs/examples/command-palette/GoToDocument.tsx +17 -14
- package/docs/examples/command-palette/NarrowSidebar.tsx +1 -1
- package/docs/examples/command-palette/RunCommand.tsx +16 -12
- package/docs/examples/command-palette/SearchButton.tsx +2 -2
- package/docs/examples/command-palette/TypeToSearch.tsx +2 -2
- package/docs/examples/composer/AttachmentsAndVoice.tsx +30 -0
- package/docs/examples/confirm-dialog/FromMenu.tsx +1 -1
- package/docs/examples/date-picker/PresetsAndBusyDays.tsx +61 -0
- package/docs/examples/dialog/EditMember.tsx +28 -0
- package/docs/examples/dialog/FindPlan.tsx +1 -1
- package/docs/examples/document-tabs/DocumentTabsAnatomy.tsx +2 -2
- package/docs/examples/document-tabs/EditorTabs.tsx +57 -0
- package/docs/examples/document-tabs/OpenDocuments.tsx +2 -2
- package/docs/examples/drop-zone/FilesInsideTheZone.tsx +40 -0
- package/docs/examples/empty-state/WithIllustration.tsx +22 -0
- package/docs/examples/graphic/Colors.tsx +1 -1
- package/docs/examples/graphic/SignInWithLogo.tsx +1 -1
- package/docs/examples/halo/AroundACard.tsx +14 -0
- package/docs/examples/halo/InviteTeam.tsx +15 -0
- package/docs/examples/halo/Tones.tsx +14 -0
- package/docs/examples/icons/FollowText.tsx +3 -3
- package/docs/examples/kbd/Sequences.tsx +10 -0
- package/docs/examples/list/TitleActions.tsx +32 -0
- package/docs/examples/menu/AccountSwitcher.tsx +32 -0
- package/docs/examples/menu/Choices.tsx +1 -1
- package/docs/examples/menu/ContextMenuForRows.tsx +3 -3
- package/docs/examples/menu/Destinations.tsx +5 -5
- package/docs/examples/menu/GroupsAndSeparators.tsx +6 -6
- package/docs/examples/menu/IconsAndShortcuts.tsx +5 -5
- package/docs/examples/menu/MenuAnatomy.tsx +3 -3
- package/docs/examples/menu/Submenus.tsx +4 -4
- package/docs/examples/menubar/NotesMenubar.tsx +4 -4
- package/docs/examples/message/CommentThread.tsx +30 -0
- package/docs/examples/message/Conversation.tsx +7 -2
- package/docs/examples/meter/InlineUsage.tsx +10 -0
- package/docs/examples/navigation-drawer/ActivityBar.tsx +26 -0
- package/docs/examples/navigation-drawer/GroupActions.tsx +43 -0
- package/docs/examples/page/WithBreadcrumbs.tsx +1 -1
- package/docs/examples/page/WithHeader.tsx +1 -1
- package/docs/examples/page/WithToolbar.tsx +1 -1
- package/docs/examples/pager/LongTitles.tsx +2 -2
- package/docs/examples/pager/PagerAnatomy.tsx +2 -2
- package/docs/examples/pager/PreviousAndNext.tsx +2 -2
- package/docs/examples/pager/StepThroughAGuide.tsx +2 -2
- package/docs/examples/panes/DocumentAndDetails.tsx +53 -0
- package/docs/examples/panes/PanesAnatomy.tsx +20 -12
- package/docs/examples/panes/ResizableDetails.tsx +35 -2
- package/docs/examples/panes/StackedWhenNarrow.tsx +11 -10
- package/docs/examples/popover/DocumentDetails.tsx +1 -1
- package/docs/examples/popover/RenameInPlace.tsx +1 -1
- package/docs/examples/progress/ExportMembers.tsx +1 -1
- package/docs/examples/radio/PlanRows.tsx +35 -0
- package/docs/examples/relative-time/PastAndComing.tsx +6 -6
- package/docs/examples/relative-time/VersionLabels.tsx +5 -5
- package/docs/examples/resize-handle/DockedLogs.tsx +44 -0
- package/docs/examples/resize-handle/ResizeHandleAnatomy.tsx +22 -22
- package/docs/examples/row/SectionHeading.tsx +1 -1
- package/docs/examples/scaffold/InspectorAndStatus.tsx +63 -0
- package/docs/examples/segmented-control/IconOnlyAndBadge.tsx +31 -0
- package/docs/examples/segmented-control/SegmentedControlAnatomy.tsx +2 -2
- package/docs/examples/segmented-control/SmallToolbar.tsx +4 -4
- package/docs/examples/select/Assignee.tsx +29 -0
- package/docs/examples/select/SmallToolbar.tsx +23 -21
- package/docs/examples/sheet/FilterPanel.tsx +1 -1
- package/docs/examples/sheet/ShareChoices.tsx +1 -1
- package/docs/examples/slider/IconsAndUnits.tsx +42 -0
- package/docs/examples/spacing/Align.tsx +1 -1
- package/docs/examples/table/HeaderEndAndTotals.tsx +61 -0
- package/docs/examples/table/WorkItemsWithParts.tsx +1 -1
- package/docs/examples/table-of-contents/DocsArticle.tsx +16 -11
- package/docs/examples/text-field/ContentAffixes.tsx +32 -0
- package/docs/examples/text-field/FieldsBesideButtons.tsx +1 -1
- package/docs/examples/text-field/IconAndEndAction.tsx +1 -1
- package/docs/examples/text-field/TextFieldAnatomy.tsx +1 -1
- package/docs/examples/text-field/Variants.tsx +1 -1
- package/docs/examples/toast/ExportReady.tsx +7 -5
- package/docs/examples/toast/RetryAfterError.tsx +8 -6
- package/docs/examples/toast/ToastAnatomy.tsx +1 -1
- package/docs/examples/toast/TopCenter.tsx +1 -1
- package/docs/examples/toast/UndoArchive.tsx +10 -8
- package/docs/examples/toolbar/LabelledControls.tsx +40 -0
- package/docs/examples/tooltip/MenuTrigger.tsx +2 -2
- package/docs/examples/tree/ContextMenuActions.tsx +5 -5
- package/docs/examples/tree/FileTree.tsx +1 -1
- package/docs/examples/tree/MatchedLetters.tsx +37 -0
- package/docs/examples/tree/NarrowTree.tsx +3 -3
- package/docs/examples/tree/RowDensity.tsx +6 -6
- package/docs/examples/tree/TreeAnatomy.tsx +2 -2
- package/docs/foundations/accessibility.md +3 -3
- package/docs/foundations/colors.md +2 -3
- package/docs/foundations/icons.md +3 -3
- package/docs/foundations/responsive.md +2 -2
- package/docs/foundations/spacing.md +2 -2
- package/docs/foundations/typography.md +2 -2
- package/docs/generated/exports.json +34 -52
- package/docs/generated/parts.json +469 -484
- package/docs/generated/props.json +1053 -903
- package/docs/index.md +52 -56
- package/docs/setup.md +62 -20
- package/docs/writing.md +1 -1
- package/package.json +6 -25
- package/dist/actions/internal/MenuPopup.js.map +0 -7
- package/dist/assets/readme/gallery-dark.png +0 -0
- package/dist/assets/readme/gallery-light.png +0 -0
- package/dist/content/MarkdownEditor.d.ts +0 -35
- package/dist/content/MarkdownEditor.js +0 -236
- package/dist/content/MarkdownEditor.js.map +0 -7
- package/dist/content/internal/markdown/MarkdownPreview.d.ts +0 -9
- package/dist/content/internal/markdown/MarkdownPreview.js +0 -30
- package/dist/content/internal/markdown/MarkdownPreview.js.map +0 -7
- package/dist/content/internal/markdown/markdownFormatting.d.ts +0 -15
- package/dist/content/internal/markdown/markdownFormatting.js +0 -96
- package/dist/content/internal/markdown/markdownFormatting.js.map +0 -7
- package/dist/content/internal/markdown/markdownHistory.d.ts +0 -10
- package/dist/content/internal/markdown/markdownHistory.js +0 -54
- package/dist/content/internal/markdown/markdownHistory.js.map +0 -7
- package/dist/content/internal/markdown/useMarkdownEditing.d.ts +0 -19
- package/dist/content/internal/markdown/useMarkdownEditing.js +0 -127
- package/dist/content/internal/markdown/useMarkdownEditing.js.map +0 -7
- package/dist/content/internal/markdown/useMarkdownLink.d.ts +0 -22
- package/dist/content/internal/markdown/useMarkdownLink.js +0 -73
- package/dist/content/internal/markdown/useMarkdownLink.js.map +0 -7
- package/dist/data-display/AnimatedNumber.d.ts +0 -15
- package/dist/data-display/AnimatedNumber.js +0 -111
- package/dist/data-display/AnimatedNumber.js.map +0 -7
- package/dist/data-display/CalendarHeatmap.d.ts +0 -92
- package/dist/data-display/CalendarHeatmap.js +0 -224
- package/dist/data-display/CalendarHeatmap.js.map +0 -7
- package/dist/data-display/DiffStat.d.ts +0 -23
- package/dist/data-display/DiffStat.js +0 -42
- package/dist/data-display/DiffStat.js.map +0 -7
- package/dist/data-display/Rating.d.ts +0 -32
- package/dist/data-display/Rating.js +0 -45
- package/dist/data-display/Rating.js.map +0 -7
- package/dist/data-display/internal/ListRows.js.map +0 -7
- package/dist/data-display/internal/calendarHeatmapModel.d.ts +0 -44
- package/dist/data-display/internal/calendarHeatmapModel.js +0 -133
- package/dist/data-display/internal/calendarHeatmapModel.js.map +0 -7
- package/dist/data-display/internal/useHeatmapLabels.d.ts +0 -16
- package/dist/data-display/internal/useHeatmapLabels.js +0 -56
- package/dist/data-display/internal/useHeatmapLabels.js.map +0 -7
- package/dist/data-display/internal/useHeatmapTooltip.d.ts +0 -24
- package/dist/data-display/internal/useHeatmapTooltip.js +0 -142
- package/dist/data-display/internal/useHeatmapTooltip.js.map +0 -7
- package/dist/dev/api.d.ts +0 -64
- package/dist/dev/api.js +0 -88
- package/dist/dev/api.js.map +0 -7
- package/dist/dev/elements.d.ts +0 -7
- package/dist/dev/elements.js +0 -32
- package/dist/dev/elements.js.map +0 -7
- package/dist/dev/inner.d.ts +0 -17
- package/dist/dev/inner.js +0 -139
- package/dist/dev/inner.js.map +0 -7
- package/dist/dev/install.d.ts +0 -64
- package/dist/dev/install.js +0 -128
- package/dist/dev/install.js.map +0 -7
- package/dist/dev/measure.d.ts +0 -10
- package/dist/dev/measure.js +0 -304
- package/dist/dev/measure.js.map +0 -7
- package/dist/dev/model.d.ts +0 -136
- package/dist/dev/model.js +0 -5
- package/dist/dev/model.js.map +0 -7
- package/dist/dev/overlays.d.ts +0 -5
- package/dist/dev/overlays.js +0 -52
- package/dist/dev/overlays.js.map +0 -7
- package/dist/dev/parts.d.ts +0 -49
- package/dist/dev/parts.js +0 -89
- package/dist/dev/parts.js.map +0 -7
- package/dist/dev/queries.d.ts +0 -28
- package/dist/dev/queries.js +0 -135
- package/dist/dev/queries.js.map +0 -7
- package/dist/dev/readout.d.ts +0 -9
- package/dist/dev/readout.js +0 -275
- package/dist/dev/readout.js.map +0 -7
- package/dist/dev/skeletonShift.d.ts +0 -6
- package/dist/dev/skeletonShift.js +0 -174
- package/dist/dev/skeletonShift.js.map +0 -7
- package/dist/dev/ui/Controls.d.ts +0 -20
- package/dist/dev/ui/Controls.js +0 -53
- package/dist/dev/ui/Controls.js.map +0 -7
- package/dist/dev/ui/DevMode.d.ts +0 -14
- package/dist/dev/ui/DevMode.js +0 -222
- package/dist/dev/ui/DevMode.js.map +0 -7
- package/dist/dev/ui/Frame.d.ts +0 -14
- package/dist/dev/ui/Frame.js +0 -178
- package/dist/dev/ui/Frame.js.map +0 -7
- package/dist/dev/ui/Icons.d.ts +0 -5
- package/dist/dev/ui/Icons.js +0 -38
- package/dist/dev/ui/Icons.js.map +0 -7
- package/dist/dev/ui/Inspector.d.ts +0 -24
- package/dist/dev/ui/Inspector.js +0 -366
- package/dist/dev/ui/Inspector.js.map +0 -7
- package/dist/dev/ui/Legend.d.ts +0 -4
- package/dist/dev/ui/Legend.js +0 -50
- package/dist/dev/ui/Legend.js.map +0 -7
- package/dist/dev/ui/NodeHints.d.ts +0 -15
- package/dist/dev/ui/NodeHints.js +0 -95
- package/dist/dev/ui/NodeHints.js.map +0 -7
- package/dist/dev/ui/PerformancePanel.d.ts +0 -3
- package/dist/dev/ui/PerformancePanel.js +0 -72
- package/dist/dev/ui/PerformancePanel.js.map +0 -7
- package/dist/dev/ui/Plane.d.ts +0 -37
- package/dist/dev/ui/Plane.js +0 -154
- package/dist/dev/ui/Plane.js.map +0 -7
- package/dist/dev/ui/View3D.d.ts +0 -19
- package/dist/dev/ui/View3D.js +0 -248
- package/dist/dev/ui/View3D.js.map +0 -7
- package/dist/dev/ui/ViewToolbar.d.ts +0 -40
- package/dist/dev/ui/ViewToolbar.js +0 -352
- package/dist/dev/ui/ViewToolbar.js.map +0 -7
- package/dist/dev/ui/camera.d.ts +0 -42
- package/dist/dev/ui/camera.js +0 -157
- package/dist/dev/ui/camera.js.map +0 -7
- package/dist/dev/ui/devices.d.ts +0 -9
- package/dist/dev/ui/devices.js +0 -34
- package/dist/dev/ui/devices.js.map +0 -7
- package/dist/dev/ui/editorTheme.d.ts +0 -6
- package/dist/dev/ui/editorTheme.js +0 -30
- package/dist/dev/ui/editorTheme.js.map +0 -7
- package/dist/dev/ui/sides.d.ts +0 -20
- package/dist/dev/ui/sides.js +0 -43
- package/dist/dev/ui/sides.js.map +0 -7
- package/dist/dev/ui/stats.d.ts +0 -25
- package/dist/dev/ui/stats.js +0 -26
- package/dist/dev/ui/stats.js.map +0 -7
- package/dist/dev/ui/surfaces.d.ts +0 -4
- package/dist/dev/ui/surfaces.js +0 -249
- package/dist/dev/ui/surfaces.js.map +0 -7
- package/dist/dev/ui/useLivePage.d.ts +0 -13
- package/dist/dev/ui/useLivePage.js +0 -138
- package/dist/dev/ui/useLivePage.js.map +0 -7
- package/dist/dev/ui/usePlaneHover.d.ts +0 -9
- package/dist/dev/ui/usePlaneHover.js +0 -46
- package/dist/dev/ui/usePlaneHover.js.map +0 -7
- package/dist/dev/ui/useViewFit.d.ts +0 -16
- package/dist/dev/ui/useViewFit.js +0 -59
- package/dist/dev/ui/useViewFit.js.map +0 -7
- package/dist/dev/ui/useViewWheel.d.ts +0 -11
- package/dist/dev/ui/useViewWheel.js +0 -48
- package/dist/dev/ui/useViewWheel.js.map +0 -7
- package/dist/dev/ui/wheel.d.ts +0 -7
- package/dist/dev/ui/wheel.js +0 -98
- package/dist/dev/ui/wheel.js.map +0 -7
- package/dist/dev/units.d.ts +0 -7
- package/dist/dev/units.js +0 -22
- package/dist/dev/units.js.map +0 -7
- package/dist/dev/usedTokens.d.ts +0 -5
- package/dist/dev/usedTokens.js +0 -56
- package/dist/dev/usedTokens.js.map +0 -7
- package/dist/dev.d.ts +0 -5
- package/dist/dev.js +0 -9
- package/dist/dev.js.map +0 -7
- package/dist/feedback/toast/internal/PictureNotice.js.map +0 -7
- package/dist/forms/color/internal/useColorState.d.ts +0 -10
- package/dist/forms/color/internal/useColorState.js +0 -49
- package/dist/forms/color/internal/useColorState.js.map +0 -7
- package/dist/forms/internal/usePickerValue.d.ts +0 -13
- package/dist/forms/internal/usePickerValue.js +0 -45
- package/dist/forms/internal/usePickerValue.js.map +0 -7
- package/dist/forms/internal/useRovingFocus.d.ts +0 -47
- package/dist/forms/internal/useRovingFocus.js +0 -179
- package/dist/forms/internal/useRovingFocus.js.map +0 -7
- package/dist/forms/rich-text/RichText.d.ts +0 -7
- package/dist/forms/rich-text/RichText.js +0 -91
- package/dist/forms/rich-text/RichText.js.map +0 -7
- package/dist/forms/rich-text/RichTextEditor.d.ts +0 -9
- package/dist/forms/rich-text/RichTextEditor.js +0 -225
- package/dist/forms/rich-text/RichTextEditor.js.map +0 -7
- package/dist/forms/rich-text/extensions.d.ts +0 -10
- package/dist/forms/rich-text/extensions.js +0 -45
- package/dist/forms/rich-text/extensions.js.map +0 -7
- package/dist/forms/rich-text/internal/Listbox.d.ts +0 -10
- package/dist/forms/rich-text/internal/Listbox.js +0 -48
- package/dist/forms/rich-text/internal/Listbox.js.map +0 -7
- package/dist/forms/rich-text/internal/Reference.d.ts +0 -13
- package/dist/forms/rich-text/internal/Reference.js +0 -79
- package/dist/forms/rich-text/internal/Reference.js.map +0 -7
- package/dist/forms/rich-text/internal/commands.d.ts +0 -6
- package/dist/forms/rich-text/internal/commands.js +0 -74
- package/dist/forms/rich-text/internal/commands.js.map +0 -7
- package/dist/forms/rich-text/internal/readOnlyCheckbox.d.ts +0 -6
- package/dist/forms/rich-text/internal/readOnlyCheckbox.js +0 -9
- package/dist/forms/rich-text/internal/readOnlyCheckbox.js.map +0 -7
- package/dist/forms/rich-text/internal/referenceAttributes.d.ts +0 -3
- package/dist/forms/rich-text/internal/referenceAttributes.js +0 -23
- package/dist/forms/rich-text/internal/referenceAttributes.js.map +0 -7
- package/dist/forms/rich-text/internal/referenceExtension.d.ts +0 -2
- package/dist/forms/rich-text/internal/referenceExtension.js +0 -103
- package/dist/forms/rich-text/internal/referenceExtension.js.map +0 -7
- package/dist/forms/rich-text/internal/suggestions.d.ts +0 -16
- package/dist/forms/rich-text/internal/suggestions.js +0 -185
- package/dist/forms/rich-text/internal/suggestions.js.map +0 -7
- package/dist/forms/rich-text/internal/taskItem.d.ts +0 -1
- package/dist/forms/rich-text/internal/taskItem.js +0 -43
- package/dist/forms/rich-text/internal/taskItem.js.map +0 -7
- package/dist/forms/rich-text/internal/useDocumentAttributes.d.ts +0 -13
- package/dist/forms/rich-text/internal/useDocumentAttributes.js +0 -42
- package/dist/forms/rich-text/internal/useDocumentAttributes.js.map +0 -7
- package/dist/forms/rich-text/internal/useLinksAndUploads.d.ts +0 -19
- package/dist/forms/rich-text/internal/useLinksAndUploads.js +0 -141
- package/dist/forms/rich-text/internal/useLinksAndUploads.js.map +0 -7
- package/dist/forms/rich-text/internal/useRichTextDocument.d.ts +0 -26
- package/dist/forms/rich-text/internal/useRichTextDocument.js +0 -101
- package/dist/forms/rich-text/internal/useRichTextDocument.js.map +0 -7
- package/dist/forms/rich-text/internal/useRichTextExtensions.d.ts +0 -13
- package/dist/forms/rich-text/internal/useRichTextExtensions.js +0 -85
- package/dist/forms/rich-text/internal/useRichTextExtensions.js.map +0 -7
- package/dist/forms/rich-text/types.d.ts +0 -190
- package/dist/forms/rich-text/types.js +0 -1
- package/dist/foundations/SkeletonScope.js.map +0 -7
- package/dist/foundations/ThemePreference.d.ts +0 -35
- package/dist/foundations/ThemePreference.js.map +0 -7
- package/dist/foundations/internal/skeletonText.js.map +0 -7
- package/dist/foundations/messages/calendarHeatmap.d.ts +0 -10
- package/dist/foundations/messages/calendarHeatmap.js +0 -10
- package/dist/foundations/messages/calendarHeatmap.js.map +0 -7
- package/dist/foundations/messages/diffStat.d.ts +0 -16
- package/dist/foundations/messages/diffStat.js +0 -17
- package/dist/foundations/messages/diffStat.js.map +0 -7
- package/dist/foundations/messages/editor.d.ts +0 -35
- package/dist/foundations/messages/editor.js +0 -34
- package/dist/foundations/messages/editor.js.map +0 -7
- package/dist/foundations/messages/linkDialog.d.ts +0 -20
- package/dist/foundations/messages/linkDialog.js +0 -20
- package/dist/foundations/messages/linkDialog.js.map +0 -7
- package/dist/foundations/messages/markdownEditor.d.ts +0 -26
- package/dist/foundations/messages/markdownEditor.js +0 -26
- package/dist/foundations/messages/markdownEditor.js.map +0 -7
- package/dist/foundations/messages/rating.d.ts +0 -11
- package/dist/foundations/messages/rating.js +0 -8
- package/dist/foundations/messages/rating.js.map +0 -7
- package/dist/foundations/messages/richText.d.ts +0 -34
- package/dist/foundations/messages/richText.js +0 -34
- package/dist/foundations/messages/richText.js.map +0 -7
- package/dist/internal/dialog/DialogParts.d.ts +0 -46
- package/dist/internal/dialog/DialogParts.js +0 -66
- package/dist/internal/dialog/DialogParts.js.map +0 -7
- package/dist/internal/dom/paints.d.ts +0 -5
- package/dist/internal/dom/paints.js +0 -17
- package/dist/internal/dom/paints.js.map +0 -7
- package/dist/internal/dom/useStripWheel.d.ts +0 -6
- package/dist/internal/dom/useStripWheel.js +0 -26
- package/dist/internal/dom/useStripWheel.js.map +0 -7
- package/dist/internal/editor/EditorStatus.d.ts +0 -8
- package/dist/internal/editor/EditorStatus.js +0 -11
- package/dist/internal/editor/EditorStatus.js.map +0 -7
- package/dist/internal/editor/EditorToolbar.d.ts +0 -28
- package/dist/internal/editor/EditorToolbar.js +0 -89
- package/dist/internal/editor/EditorToolbar.js.map +0 -7
- package/dist/internal/editor/LinkDialog.d.ts +0 -20
- package/dist/internal/editor/LinkDialog.js +0 -78
- package/dist/internal/editor/LinkDialog.js.map +0 -7
- package/dist/internal/editor/editorCommands.d.ts +0 -20
- package/dist/internal/editor/editorCommands.js +0 -45
- package/dist/internal/editor/editorCommands.js.map +0 -7
- package/dist/internal/field/TextareaResizeEdge.js.map +0 -7
- package/dist/internal/field/rowControl.js.map +0 -7
- package/dist/internal/field/useFieldMetadata.d.ts +0 -16
- package/dist/internal/field/useFieldMetadata.js +0 -24
- package/dist/internal/field/useFieldMetadata.js.map +0 -7
- package/dist/internal/list/ListRow.d.ts +0 -33
- package/dist/internal/list/ListRow.js.map +0 -7
- package/dist/internal/popup/PortalContainerContext.js.map +0 -7
- package/dist/internal/react/useStackedReport.js +0 -28
- package/dist/internal/react/useStackedReport.js.map +0 -7
- package/dist/internal/skeleton.js.map +0 -7
- package/dist/internal/time/calendarDays.js.map +0 -7
- package/dist/layout/internal/navigationForms.js.map +0 -7
- package/dist/layout/internal/scrollKeys.js.map +0 -7
- package/dist/layout/internal/useNavigationFocusHandoff.js.map +0 -7
- package/dist/layout/internal/useScrollKeys.js.map +0 -7
- package/dist/layout/panesSize.d.ts +0 -13
- package/dist/layout/panesSize.js +0 -39
- package/dist/layout/panesSize.js.map +0 -7
- package/dist/navigation/internal/TreeRow.js.map +0 -7
- package/dist/navigation/internal/contentsOutline.d.ts +0 -60
- package/dist/navigation/internal/contentsOutline.js.map +0 -7
- package/dist/navigation/internal/contentsWave.js.map +0 -7
- package/dist/navigation/internal/sectionScroll.js.map +0 -7
- package/dist/navigation/internal/tabStrip.d.ts +0 -6
- package/dist/navigation/internal/tabStrip.js +0 -24
- package/dist/navigation/internal/tabStrip.js.map +0 -7
- package/dist/navigation/internal/treeModel.js.map +0 -7
- package/dist/navigation/internal/useContentsHeadings.js.map +0 -7
- package/dist/navigation/internal/useTabCloseFocus.js.map +0 -7
- package/dist/navigation/internal/useTabDrag.js.map +0 -7
- package/dist/navigation/internal/useTabStripScrolling.js.map +0 -7
- package/dist/navigation/internal/useTreeTransitions.js.map +0 -7
- package/dist/navigation/internal/useTreeViewport.js.map +0 -7
- package/dist/navigation/internal/waveDrawer.js.map +0 -7
- package/dist/overlays/internal/DialogPendingAction.js.map +0 -7
- package/dist/rich-text.d.ts +0 -5
- package/dist/rich-text.js +0 -9
- package/dist/rich-text.js.map +0 -7
- package/dist/styles/CalendarHeatmap.css +0 -1
- package/dist/styles/Editor.css +0 -1
- package/dist/styles/Listbox.css +0 -1
- package/dist/styles/MarkdownEditor.css +0 -1
- package/dist/styles/Rating.css +0 -1
- package/dist/styles/RichText.css +0 -1
- package/docs/components/animated-number.md +0 -72
- package/docs/components/calendar-heatmap.md +0 -140
- package/docs/components/rating.md +0 -84
- package/docs/components/rich-text.md +0 -224
- package/docs/dev-mode.md +0 -59
- package/docs/examples/animated-number/AnimatedNumberAnatomy.tsx +0 -9
- package/docs/examples/animated-number/CustomFormat.tsx +0 -28
- package/docs/examples/animated-number/ShowResults.tsx +0 -38
- package/docs/examples/badge/ChangeSize.tsx +0 -21
- package/docs/examples/calendar-heatmap/ApplicationStrings.tsx +0 -23
- package/docs/examples/calendar-heatmap/ColorByRank.tsx +0 -26
- package/docs/examples/calendar-heatmap/CustomTooltip.tsx +0 -26
- package/docs/examples/calendar-heatmap/Deployments.tsx +0 -22
- package/docs/examples/calendar-heatmap/HeatmapAnatomy.tsx +0 -10
- package/docs/examples/calendar-heatmap/ScrollingWeeks.tsx +0 -10
- package/docs/examples/markdown/LinkPicker.tsx +0 -65
- package/docs/examples/markdown/MarkdownEditorAnatomy.tsx +0 -13
- package/docs/examples/markdown/WriteNote.tsx +0 -21
- package/docs/examples/panes/ListAndDetail.tsx +0 -55
- package/docs/examples/rating/RatingAnatomy.tsx +0 -5
- package/docs/examples/rating/ReviewScore.tsx +0 -13
- package/docs/examples/rating/Scales.tsx +0 -11
- package/docs/examples/resize-handle/ProjectSidebar.tsx +0 -40
- package/docs/examples/rich-text/MeetingNotes.tsx +0 -14
- package/docs/examples/rich-text/References.tsx +0 -47
- package/docs/examples/rich-text/RichTextAnatomy.tsx +0 -18
- package/docs/examples/rich-text/SavedContent.tsx +0 -33
- package/docs/examples/rich-text/SlashCommands.tsx +0 -24
- package/docs/examples/rich-text/UploadsAndLinks.tsx +0 -36
- /package/dist/actions/{internal → menu/internal}/menuOpenChange.js +0 -0
- /package/dist/actions/{internal → menu/internal}/menuOpenChange.js.map +0 -0
- /package/dist/{forms/rich-text/types.js.map → actions/menu/internal/menuTriggerProps.js.map} +0 -0
- /package/dist/forms/color/internal/{colorChange.d.ts → ColorChangeContext.d.ts} +0 -0
- /package/dist/internal/{useCopy.d.ts → react/useCopy.d.ts} +0 -0
- /package/dist/internal/{useCopy.js → react/useCopy.js} +0 -0
- /package/dist/internal/{useLatest.d.ts → react/useLatest.d.ts} +0 -0
- /package/dist/internal/{useLatest.js → react/useLatest.js} +0 -0
- /package/dist/{foundations/internal → internal/skeleton}/skeletonText.d.ts +0 -0
- /package/dist/layout/internal/{navigationForms.js → scaffold/navigationForms.js} +0 -0
- /package/dist/layout/internal/{scaffoldFocus.d.ts → scaffold/scaffoldFocus.d.ts} +0 -0
- /package/dist/layout/internal/{scaffoldFocus.js → scaffold/scaffoldFocus.js} +0 -0
- /package/dist/layout/internal/{scrollKeys.d.ts → scaffold/scrollKeys.d.ts} +0 -0
- /package/dist/layout/internal/{useNavigationFocusHandoff.d.ts → scaffold/useNavigationFocusHandoff.d.ts} +0 -0
- /package/dist/layout/internal/{useScrollKeys.d.ts → scaffold/useScrollKeys.d.ts} +0 -0
- /package/dist/navigation/internal/{useTabCloseFocus.d.ts → documentTabs/useTabCloseFocus.d.ts} +0 -0
- /package/dist/navigation/internal/{useTabStripScrolling.d.ts → documentTabs/useTabStripScrolling.d.ts} +0 -0
- /package/dist/navigation/internal/{contentsWave.d.ts → tableOfContents/contentsWave.d.ts} +0 -0
- /package/dist/navigation/internal/{waveDrawer.d.ts → tableOfContents/waveDrawer.d.ts} +0 -0
- /package/dist/navigation/internal/{useTreeTransitions.js → tree/useTreeTransitions.js} +0 -0
- /package/dist/styles/{TextareaResizeEdge.css → TextareaResizeHandle.css} +0 -0
|
@@ -48,6 +48,26 @@
|
|
|
48
48
|
"type": "(open: boolean) => void",
|
|
49
49
|
"required": false,
|
|
50
50
|
"description": "Receives whether this item is open, each time it opens or closes."
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "end",
|
|
54
|
+
"type": "ReactNode",
|
|
55
|
+
"required": false,
|
|
56
|
+
"description": "Content at the end of the item's heading row, beside its button and outside it, such as a Switch, a Badge with a Menu, or a Delete IconButton, placed as given."
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "indicator",
|
|
60
|
+
"type": "ReactNode",
|
|
61
|
+
"required": false,
|
|
62
|
+
"default": "the Root's indicator",
|
|
63
|
+
"description": "What shows in this item's button whether it is open, in place of the Root's indicator, such as a chevron the application turns while the button has data-panel-open; null for none."
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "indicatorPlacement",
|
|
67
|
+
"type": "'start' | 'end'",
|
|
68
|
+
"required": false,
|
|
69
|
+
"default": "the Root's indicatorPlacement",
|
|
70
|
+
"description": "Where this item's indicator sits in its button: before the title, or after it at the button's end."
|
|
51
71
|
}
|
|
52
72
|
],
|
|
53
73
|
"native": [
|
|
@@ -101,6 +121,19 @@
|
|
|
101
121
|
"default": "3",
|
|
102
122
|
"description": "The level of each item's heading, for the page's outline; they look the same at every level."
|
|
103
123
|
},
|
|
124
|
+
{
|
|
125
|
+
"name": "indicator",
|
|
126
|
+
"type": "ReactNode",
|
|
127
|
+
"required": false,
|
|
128
|
+
"description": "What shows in every item's button whether the item is open, in place of the plus that becomes a minus, such as a chevron the application turns while the button has data-panel-open; null for none. It is hidden from assistive technology, which hears the button's expanded state. An item's own indicator replaces it."
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "indicatorPlacement",
|
|
132
|
+
"type": "'start' | 'end'",
|
|
133
|
+
"required": false,
|
|
134
|
+
"default": "'start'",
|
|
135
|
+
"description": "Where every item's indicator sits in its button: before the title, or after it at the button's end. An item's own indicatorPlacement replaces it."
|
|
136
|
+
},
|
|
104
137
|
{
|
|
105
138
|
"name": "disabled",
|
|
106
139
|
"type": "boolean",
|
|
@@ -144,9 +177,9 @@
|
|
|
144
177
|
},
|
|
145
178
|
{
|
|
146
179
|
"name": "title",
|
|
147
|
-
"type": "
|
|
180
|
+
"type": "ReactNode",
|
|
148
181
|
"required": false,
|
|
149
|
-
"description": "A short heading for the message, such as \"Sync paused\", above the message."
|
|
182
|
+
"description": "A short heading for the message, such as \"Sync paused\", above the message: text, or content such as a branch name in Code or a link."
|
|
150
183
|
},
|
|
151
184
|
{
|
|
152
185
|
"name": "children",
|
|
@@ -166,6 +199,13 @@
|
|
|
166
199
|
"required": false,
|
|
167
200
|
"description": "Actions below the message, such as a Button or a Link, in a row that wraps."
|
|
168
201
|
},
|
|
202
|
+
{
|
|
203
|
+
"name": "actionsPlacement",
|
|
204
|
+
"type": "'below' | 'end'",
|
|
205
|
+
"required": false,
|
|
206
|
+
"default": "'below'",
|
|
207
|
+
"description": "Where the actions go: below the message, or at the end of the alert's row, before the dismiss button, as in a one-line banner such as \"Sync paused. Resume\". At the end, they move below the message where the alert is too narrow for both."
|
|
208
|
+
},
|
|
169
209
|
{
|
|
170
210
|
"name": "onDismiss",
|
|
171
211
|
"type": "() => void",
|
|
@@ -201,32 +241,6 @@
|
|
|
201
241
|
"@envsemble/envui"
|
|
202
242
|
]
|
|
203
243
|
},
|
|
204
|
-
"AnimatedNumber": {
|
|
205
|
-
"kind": "component",
|
|
206
|
-
"source": "packages/ui/src/data-display/AnimatedNumber.tsx",
|
|
207
|
-
"description": "A number within text that rolls to its new value when it changes: up when it grows and down when it shrinks, so a count updated by other controls is noticed. The text is always the current value.",
|
|
208
|
-
"props": [
|
|
209
|
-
{
|
|
210
|
-
"name": "value",
|
|
211
|
-
"type": "number",
|
|
212
|
-
"required": true,
|
|
213
|
-
"description": "The number to show; when it changes, the new value rolls in, up as it grows, down as it shrinks."
|
|
214
|
-
},
|
|
215
|
-
{
|
|
216
|
-
"name": "formatValue",
|
|
217
|
-
"type": "(value: number) => string",
|
|
218
|
-
"required": false,
|
|
219
|
-
"default": "the number format of EnvUIProvider's locale, or else the browser's",
|
|
220
|
-
"description": "Writes the value as text, such as a currency."
|
|
221
|
-
}
|
|
222
|
-
],
|
|
223
|
-
"native": [
|
|
224
|
-
"span"
|
|
225
|
-
],
|
|
226
|
-
"entries": [
|
|
227
|
-
"@envsemble/envui"
|
|
228
|
-
]
|
|
229
|
-
},
|
|
230
244
|
"Avatar": {
|
|
231
245
|
"kind": "component",
|
|
232
246
|
"source": "packages/ui/src/data-display/Avatar.tsx",
|
|
@@ -246,10 +260,10 @@
|
|
|
246
260
|
},
|
|
247
261
|
{
|
|
248
262
|
"name": "fallback",
|
|
249
|
-
"type": "'person' | 'initials'",
|
|
263
|
+
"type": "'person' | 'initials' | ReactElement",
|
|
250
264
|
"required": false,
|
|
251
265
|
"default": "'initials'",
|
|
252
|
-
"description": "Shown without a picture: the initials of `name`, so people tell avatars apart, or the default person picture, which an empty `name` shows too."
|
|
266
|
+
"description": "Shown without a picture: the initials of `name`, so people tell avatars apart, or the default person picture, which an empty `name` shows too. An element is placed as given on the hue's fill, in its deep shade as `currentColor`, such as an icon or a Graphic for a bot, an agent, a team or a service account."
|
|
253
267
|
},
|
|
254
268
|
{
|
|
255
269
|
"name": "hue",
|
|
@@ -277,6 +291,12 @@
|
|
|
277
291
|
"required": false,
|
|
278
292
|
"default": "false",
|
|
279
293
|
"description": "Shows the avatar as chosen, such as in a list of people to pick from: a ring around it and a small check at its bottom end, so the choice never rests on color alone. It is a look only: the control around the avatar, such as a checkbox or an option, says it is chosen."
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": "badge",
|
|
297
|
+
"type": "ReactNode",
|
|
298
|
+
"required": false,
|
|
299
|
+
"description": "A small mark at the avatar's bottom end, placed as given, such as a presence dot, an unread marker or an organization's mark; at its top end while the avatar is selected, whose check takes the bottom end. It is hidden from assistive technology with the avatar, so say what it shows in the text beside it."
|
|
280
300
|
}
|
|
281
301
|
],
|
|
282
302
|
"native": [
|
|
@@ -295,13 +315,13 @@
|
|
|
295
315
|
"name": "name",
|
|
296
316
|
"type": "string",
|
|
297
317
|
"required": true,
|
|
298
|
-
"description": "The person's name: shown in the tooltip, and the accessible name unless aria-label is set."
|
|
318
|
+
"description": "The person's name: shown in the tooltip, and the accessible name unless aria-label is set, followed by a badge's text, such as Alex Morgan, online."
|
|
299
319
|
},
|
|
300
320
|
{
|
|
301
321
|
"name": "description",
|
|
302
|
-
"type": "
|
|
322
|
+
"type": "ReactNode",
|
|
303
323
|
"required": false,
|
|
304
|
-
"description": "A second tooltip line, such as the e-mail address of the signed-in account."
|
|
324
|
+
"description": "A second tooltip line, such as the e-mail address of the signed-in account, or content such as an organization's name with its plan's Badge."
|
|
305
325
|
},
|
|
306
326
|
{
|
|
307
327
|
"name": "src",
|
|
@@ -315,6 +335,24 @@
|
|
|
315
335
|
"required": false,
|
|
316
336
|
"description": "Shown without a picture: the initials of `name`, by default, or the default person picture."
|
|
317
337
|
},
|
|
338
|
+
{
|
|
339
|
+
"name": "hue",
|
|
340
|
+
"type": "AvatarProps['hue']",
|
|
341
|
+
"required": false,
|
|
342
|
+
"description": "The fill behind the initials or the person picture, as for Avatar; the name chooses one by default."
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"name": "selected",
|
|
346
|
+
"type": "boolean",
|
|
347
|
+
"required": false,
|
|
348
|
+
"description": "Shows the avatar as chosen, as for Avatar: a ring and a check. A look only."
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "badge",
|
|
352
|
+
"type": "ReactNode",
|
|
353
|
+
"required": false,
|
|
354
|
+
"description": "A small mark at the avatar's bottom end, as for Avatar, such as a presence dot. Text, such as online, also follows the name in the button's accessible name, as it shows on the button."
|
|
355
|
+
},
|
|
318
356
|
{
|
|
319
357
|
"name": "size",
|
|
320
358
|
"type": "'sm' | 'md' | 'lg'",
|
|
@@ -386,6 +424,12 @@
|
|
|
386
424
|
"required": false,
|
|
387
425
|
"default": "'{count} people: {names}'",
|
|
388
426
|
"description": "The group's name from the number of people and their names, which end with formatMore's text for people counted in total but not listed, such as \"3 people: Alex Morgan, Sam Lee, 1 more\". It overrides EnvUIProvider's `messages.avatarGroup.label` for this group; aria-label replaces it."
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"name": "renderOverflowTooltip",
|
|
430
|
+
"type": "(hidden: readonly AvatarGroupPerson[], unlisted: number) => ReactNode",
|
|
431
|
+
"required": false,
|
|
432
|
+
"description": "The overflow chip's tooltip, from the people it hides and how many more total counts but people doesn't list, such as a list of them with their avatars. Their names, one a line, and formatMore's text by default. The chip's accessible name stays their names."
|
|
389
433
|
}
|
|
390
434
|
],
|
|
391
435
|
"native": [
|
|
@@ -401,16 +445,16 @@
|
|
|
401
445
|
"description": "A small pill label for a state, such as In progress, Blocked or Archived, or for neutral metadata, such as a plan or a count of seats; with count, a compact count, such as 12 unread.",
|
|
402
446
|
"props": [
|
|
403
447
|
{
|
|
404
|
-
"name": "
|
|
448
|
+
"name": "start",
|
|
405
449
|
"type": "ReactNode",
|
|
406
450
|
"required": false,
|
|
407
|
-
"description": "
|
|
451
|
+
"description": "Content before the label, such as an icon, a small Avatar or a color swatch: an envUI icon takes the badge's icon size and other content keeps its own. Assistive technology reads it unless it hides itself, as an icon without a label does. A done badge leads with a check mark unless it is given another start, or `null` for none."
|
|
408
452
|
},
|
|
409
453
|
{
|
|
410
454
|
"name": "children",
|
|
411
|
-
"type": "
|
|
455
|
+
"type": "ReactNode",
|
|
412
456
|
"required": false,
|
|
413
|
-
"description": "The label: a state, a name or a category in a word or two, as text. It stays on one line and ends with an ellipsis where the badge is wider than its container."
|
|
457
|
+
"description": "The label: a state, a name or a category in a word or two, such as text with a bold value or a RelativeTime in it. It stays on one line and ends with an ellipsis where the badge is wider than its container."
|
|
414
458
|
},
|
|
415
459
|
{
|
|
416
460
|
"name": "count",
|
|
@@ -467,7 +511,7 @@
|
|
|
467
511
|
"name": "name",
|
|
468
512
|
"type": "string",
|
|
469
513
|
"required": false,
|
|
470
|
-
"description": "A name for this node, such as \"filters\" or \"summary\",
|
|
514
|
+
"description": "A name for this node, such as \"filters\" or \"summary\", for the application's styles and tests to find it by; it renders as `data-env-name`. A component's part class names its node instead."
|
|
471
515
|
},
|
|
472
516
|
{
|
|
473
517
|
"name": "container",
|
|
@@ -568,22 +612,16 @@
|
|
|
568
612
|
"description": "Fill the width of the container, such as the actions of a narrow form stacked in a column."
|
|
569
613
|
},
|
|
570
614
|
{
|
|
571
|
-
"name": "
|
|
572
|
-
"type": "ReactNode",
|
|
573
|
-
"required": false,
|
|
574
|
-
"description": "A decorative icon before the label, such as IconAdd."
|
|
575
|
-
},
|
|
576
|
-
{
|
|
577
|
-
"name": "endIcon",
|
|
615
|
+
"name": "start",
|
|
578
616
|
"type": "ReactNode",
|
|
579
617
|
"required": false,
|
|
580
|
-
"description": "
|
|
618
|
+
"description": "Content before the label, such as IconAdd, or a small Avatar of the person a button assigns: an envUI icon takes the button's icon size and other content keeps its own. It is hidden from assistive technology, since the label names the button."
|
|
581
619
|
},
|
|
582
620
|
{
|
|
583
621
|
"name": "end",
|
|
584
622
|
"type": "ReactNode",
|
|
585
623
|
"required": false,
|
|
586
|
-
"description": "
|
|
624
|
+
"description": "Content after the label, at the far end of a full-width button, such as IconChevronRight for a next step, or a shortcut's Kbd, with aria-hidden on its keys and aria-keyshortcuts on the button: an envUI icon takes the button's icon size and other content keeps its own."
|
|
587
625
|
},
|
|
588
626
|
{
|
|
589
627
|
"name": "pending",
|
|
@@ -603,6 +641,12 @@
|
|
|
603
641
|
"type": "string",
|
|
604
642
|
"required": false,
|
|
605
643
|
"description": "The destination: the element is a native link, through the LinkProvider's link component."
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "render",
|
|
647
|
+
"type": "ReactElement",
|
|
648
|
+
"required": false,
|
|
649
|
+
"description": "Another element to render the button as, such as a label for a file input, or a router's own link in one place: the button's class, look, state attributes, content and handlers merge into its props. It takes no type or disabled attribute; disabled reports aria-disabled and blocks presses."
|
|
606
650
|
}
|
|
607
651
|
],
|
|
608
652
|
"native": [
|
|
@@ -643,7 +687,7 @@
|
|
|
643
687
|
"Calendar": {
|
|
644
688
|
"kind": "component",
|
|
645
689
|
"source": "packages/ui/src/forms/Calendar.tsx",
|
|
646
|
-
"description": "A month of days to choose one from, following the WAI-ARIA date picker grid: the arrow keys move by day and week, Page Up and Page Down by month (with Shift, by year), Home and End to the week's ends, and Enter or Space chooses the day. Named with aria-label or aria-labelledby, it is a group around the month's grid.",
|
|
690
|
+
"description": "A month of days to choose one from, following the WAI-ARIA date picker grid: the arrow keys move by day and week, Page Up and Page Down by month (with Shift, by year), Home and End to the week's ends, and Enter or Space chooses the day. Named with aria-label or aria-labelledby, or by the List.Item whose control it is, it is a group around the month's grid.",
|
|
647
691
|
"props": [
|
|
648
692
|
{
|
|
649
693
|
"name": "value",
|
|
@@ -676,6 +720,19 @@
|
|
|
676
720
|
"required": false,
|
|
677
721
|
"description": "The latest day that can be chosen, as YYYY-MM-DD; later days are unavailable."
|
|
678
722
|
},
|
|
723
|
+
{
|
|
724
|
+
"name": "isDateUnavailable",
|
|
725
|
+
"type": "(day: string) => boolean",
|
|
726
|
+
"required": false,
|
|
727
|
+
"description": "Whether a day, as YYYY-MM-DD, can't be chosen, such as a weekend, a holiday or a booked day; it shows dimmed and reports aria-disabled, as days outside min and max do, and the keyboard still moves onto it."
|
|
728
|
+
},
|
|
729
|
+
{
|
|
730
|
+
"name": "renderDay",
|
|
731
|
+
"type": "(day: string, state: CalendarDayState) => ReactNode",
|
|
732
|
+
"required": false,
|
|
733
|
+
"default": "the day's number",
|
|
734
|
+
"description": "The content of a day's mark in place of its number, such as the number with a dot under it for a day with events, or a price; it receives the day as YYYY-MM-DD and its state. The cell keeps its role, its name, the full date, and its keyboard handling."
|
|
735
|
+
},
|
|
679
736
|
{
|
|
680
737
|
"name": "weekStart",
|
|
681
738
|
"type": "0 | 1 | 2 | 3 | 4 | 5 | 6",
|
|
@@ -711,132 +768,6 @@
|
|
|
711
768
|
"@envsemble/envui"
|
|
712
769
|
]
|
|
713
770
|
},
|
|
714
|
-
"CalendarHeatmap": {
|
|
715
|
-
"kind": "component",
|
|
716
|
-
"source": "packages/ui/src/data-display/CalendarHeatmap.tsx",
|
|
717
|
-
"description": "A calendar of daily values with weeks as columns and weekdays as rows, colored in steps of a tone. Each day names its date and value, shows them in a tooltip on hover and focus, and the grid is one tab stop that the arrow keys move through.",
|
|
718
|
-
"props": [
|
|
719
|
-
{
|
|
720
|
-
"name": "data",
|
|
721
|
-
"type": "readonly CalendarHeatmapDay[]",
|
|
722
|
-
"required": true,
|
|
723
|
-
"description": "Values by day; days without an entry count as 0."
|
|
724
|
-
},
|
|
725
|
-
{
|
|
726
|
-
"name": "startDate",
|
|
727
|
-
"type": "string",
|
|
728
|
-
"required": false,
|
|
729
|
-
"description": "The first day shown, as YYYY-MM-DD; the earliest day in data by default."
|
|
730
|
-
},
|
|
731
|
-
{
|
|
732
|
-
"name": "endDate",
|
|
733
|
-
"type": "string",
|
|
734
|
-
"required": false,
|
|
735
|
-
"description": "The last day shown, as YYYY-MM-DD; the latest day in data by default."
|
|
736
|
-
},
|
|
737
|
-
{
|
|
738
|
-
"name": "levels",
|
|
739
|
-
"type": "number",
|
|
740
|
-
"required": false,
|
|
741
|
-
"default": "5",
|
|
742
|
-
"description": "Color steps including the empty step, 2 to 10; 5 by default."
|
|
743
|
-
},
|
|
744
|
-
{
|
|
745
|
-
"name": "maxValue",
|
|
746
|
-
"type": "number",
|
|
747
|
-
"required": false,
|
|
748
|
-
"description": "The value that takes the strongest color; the largest value shown by default."
|
|
749
|
-
},
|
|
750
|
-
{
|
|
751
|
-
"name": "thresholds",
|
|
752
|
-
"type": "readonly number[]",
|
|
753
|
-
"required": false,
|
|
754
|
-
"description": "The lowest value of each color step above the empty one, in ascending order, such as quantiles of the data to color by rank. Up to nine; they replace levels and maxValue. A day below the first threshold shows as empty, and a first threshold of 0 or less colors days of 0 too."
|
|
755
|
-
},
|
|
756
|
-
{
|
|
757
|
-
"name": "weekStart",
|
|
758
|
-
"type": "0 | 1 | 2 | 3 | 4 | 5 | 6",
|
|
759
|
-
"required": false,
|
|
760
|
-
"default": "the locale's, or Monday where the browser cannot tell",
|
|
761
|
-
"description": "The first day of each week column, from 0 for Sunday to 6 for Saturday, as on Calendar."
|
|
762
|
-
},
|
|
763
|
-
{
|
|
764
|
-
"name": "tone",
|
|
765
|
-
"type": "'neutral' | 'primary' | 'accent' | 'success' | 'warning' | 'danger' | 'done'",
|
|
766
|
-
"required": false,
|
|
767
|
-
"default": "'primary'",
|
|
768
|
-
"description": "The tone the colors are mixed from: primary by default."
|
|
769
|
-
},
|
|
770
|
-
{
|
|
771
|
-
"name": "formatValue",
|
|
772
|
-
"type": "(value: number) => string",
|
|
773
|
-
"required": false,
|
|
774
|
-
"default": "the number format of EnvUIProvider's locale, or else the browser's",
|
|
775
|
-
"description": "Text for a value."
|
|
776
|
-
},
|
|
777
|
-
{
|
|
778
|
-
"name": "formatDate",
|
|
779
|
-
"type": "(date: string) => string",
|
|
780
|
-
"required": false,
|
|
781
|
-
"default": "the weekday, day, month and year in the locale, such as Tue 14 Oct 2025",
|
|
782
|
-
"description": "Text for a day's date, in its accessible name and the default tooltip."
|
|
783
|
-
},
|
|
784
|
-
{
|
|
785
|
-
"name": "renderTooltip",
|
|
786
|
-
"type": "(day: CalendarHeatmapCell) => ReactNode",
|
|
787
|
-
"required": false,
|
|
788
|
-
"description": "Tooltip content for a day; the date and value by default."
|
|
789
|
-
},
|
|
790
|
-
{
|
|
791
|
-
"name": "monthLabels",
|
|
792
|
-
"type": "readonly string[]",
|
|
793
|
-
"required": false,
|
|
794
|
-
"default": "the locale's short month names, from Intl",
|
|
795
|
-
"description": "Twelve month names above the weeks, from January."
|
|
796
|
-
},
|
|
797
|
-
{
|
|
798
|
-
"name": "weekdayLabels",
|
|
799
|
-
"type": "readonly string[]",
|
|
800
|
-
"required": false,
|
|
801
|
-
"default": "the locale's short weekday names, from Intl",
|
|
802
|
-
"description": "Seven weekday names beside the rows, from Sunday."
|
|
803
|
-
},
|
|
804
|
-
{
|
|
805
|
-
"name": "lessLabel",
|
|
806
|
-
"type": "string",
|
|
807
|
-
"required": false,
|
|
808
|
-
"default": "'Less'",
|
|
809
|
-
"description": "Legend text before the lightest color. It overrides EnvUIProvider's `messages.calendarHeatmap.less`."
|
|
810
|
-
},
|
|
811
|
-
{
|
|
812
|
-
"name": "moreLabel",
|
|
813
|
-
"type": "string",
|
|
814
|
-
"required": false,
|
|
815
|
-
"default": "'More'",
|
|
816
|
-
"description": "Legend text after the strongest color. It overrides EnvUIProvider's `messages.calendarHeatmap.more`."
|
|
817
|
-
},
|
|
818
|
-
{
|
|
819
|
-
"name": "aria-label",
|
|
820
|
-
"type": "string",
|
|
821
|
-
"required": false,
|
|
822
|
-
"requiredWhen": "`aria-labelledby` is not set",
|
|
823
|
-
"description": "Names the grid of days, such as \"Deployments in the last year\"; this or aria-labelledby."
|
|
824
|
-
},
|
|
825
|
-
{
|
|
826
|
-
"name": "aria-labelledby",
|
|
827
|
-
"type": "string",
|
|
828
|
-
"required": false,
|
|
829
|
-
"requiredWhen": "`aria-label` is not set",
|
|
830
|
-
"description": "The id of visible text that names the grid of days, such as a heading; this or aria-label."
|
|
831
|
-
}
|
|
832
|
-
],
|
|
833
|
-
"native": [
|
|
834
|
-
"div"
|
|
835
|
-
],
|
|
836
|
-
"entries": [
|
|
837
|
-
"@envsemble/envui"
|
|
838
|
-
]
|
|
839
|
-
},
|
|
840
771
|
"Card": {
|
|
841
772
|
"kind": "component",
|
|
842
773
|
"source": "packages/ui/src/layout/Card.tsx",
|
|
@@ -894,6 +825,12 @@
|
|
|
894
825
|
"required": false,
|
|
895
826
|
"description": "A short fact at the end of the title row, such as when the card was updated."
|
|
896
827
|
},
|
|
828
|
+
{
|
|
829
|
+
"name": "headerEnd",
|
|
830
|
+
"type": "ReactNode",
|
|
831
|
+
"required": false,
|
|
832
|
+
"description": "Content at the end of the title row, after the meta, such as an overflow Menu or an Edit Button, placed as given."
|
|
833
|
+
},
|
|
897
834
|
{
|
|
898
835
|
"name": "description",
|
|
899
836
|
"type": "ReactNode",
|
|
@@ -904,7 +841,14 @@
|
|
|
904
841
|
"name": "actions",
|
|
905
842
|
"type": "ReactNode",
|
|
906
843
|
"required": false,
|
|
907
|
-
"description": "The card's controls, such as Buttons, in a strip along the bottom of the card, at its end and wrapping onto more lines where they don't fit."
|
|
844
|
+
"description": "The card's controls, such as Buttons, in a strip along the bottom of the card, at its end and wrapping onto more lines where they don't fit. For controls beside the title, use headerEnd."
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "interactive",
|
|
848
|
+
"type": "boolean",
|
|
849
|
+
"required": false,
|
|
850
|
+
"default": "false",
|
|
851
|
+
"description": "The card opens something through a link or button inside, such as its title: it reacts to hover, keyboard focus on that target and presses. Mark the link or button `data-row-target` to stretch it over the card; the other links, buttons and fields in the card, such as an author's link in the description or a Menu in headerEnd, stay clickable above it."
|
|
908
852
|
},
|
|
909
853
|
{
|
|
910
854
|
"name": "render",
|
|
@@ -977,6 +921,13 @@
|
|
|
977
921
|
"required": false,
|
|
978
922
|
"description": "A short, muted line under the label, such as what the option changes. It is part of the checkbox's label, so it is read with its name."
|
|
979
923
|
},
|
|
924
|
+
{
|
|
925
|
+
"name": "labelPlacement",
|
|
926
|
+
"type": "'end' | 'start'",
|
|
927
|
+
"required": false,
|
|
928
|
+
"default": "'end'",
|
|
929
|
+
"description": "Where the label sits beside the box: end, after it, or start, before it, such as in an inline row whose label leads; the native label still names the checkbox."
|
|
930
|
+
},
|
|
980
931
|
{
|
|
981
932
|
"name": "checked",
|
|
982
933
|
"type": "boolean | 'mixed'",
|
|
@@ -1029,9 +980,15 @@
|
|
|
1029
980
|
},
|
|
1030
981
|
{
|
|
1031
982
|
"name": "label",
|
|
1032
|
-
"type": "
|
|
983
|
+
"type": "ReactNode",
|
|
1033
984
|
"required": false,
|
|
1034
|
-
"description": "Names the block in its heading and for assistive technology, such as a file name."
|
|
985
|
+
"description": "Names the block in its heading and for assistive technology, such as a file name, or content such as a file-type icon and a path link. Without one, the code takes the generic name of its language, such as Plain text code or TypeScript code, from messages.codeBlock.label."
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"name": "headerEnd",
|
|
989
|
+
"type": "ReactNode",
|
|
990
|
+
"required": false,
|
|
991
|
+
"description": "Content at the end of the heading, before the copy button, such as Open in editor, Run, or a switch between npm, pnpm and yarn, placed as given."
|
|
1035
992
|
},
|
|
1036
993
|
{
|
|
1037
994
|
"name": "copyable",
|
|
@@ -1100,10 +1057,35 @@
|
|
|
1100
1057
|
},
|
|
1101
1058
|
{
|
|
1102
1059
|
"name": "layout",
|
|
1103
|
-
"type": "'auto' | 'unified'",
|
|
1060
|
+
"type": "'auto' | 'split' | 'unified'",
|
|
1104
1061
|
"required": false,
|
|
1105
1062
|
"default": "'auto'",
|
|
1106
|
-
"description": "auto (default) sets old and new side by side from 56 rem of width; unified keeps one column."
|
|
1063
|
+
"description": "auto (default) sets old and new side by side from 56 rem of width; split always sets them side by side, such as for a split and unified toggle; unified keeps one column."
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "headerEnd",
|
|
1067
|
+
"type": "ReactNode",
|
|
1068
|
+
"required": false,
|
|
1069
|
+
"description": "Content at the end of the file header, such as View file, Accept or Revert, or a status Badge."
|
|
1070
|
+
},
|
|
1071
|
+
{
|
|
1072
|
+
"name": "annotations",
|
|
1073
|
+
"type": "readonly CodeDiffAnnotation[]",
|
|
1074
|
+
"required": false,
|
|
1075
|
+
"description": "Notes attached to lines, such as review comments, which renderAnnotation draws under them."
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
"name": "renderAnnotation",
|
|
1079
|
+
"type": "(annotation: CodeDiffAnnotation) => ReactNode",
|
|
1080
|
+
"required": false,
|
|
1081
|
+
"description": "Draws one of annotations under its line."
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
"name": "headingLevel",
|
|
1085
|
+
"type": "1 | 2 | 3 | 4 | 5 | 6",
|
|
1086
|
+
"required": false,
|
|
1087
|
+
"default": "3",
|
|
1088
|
+
"description": "The level of the heading of what shows when the diff fails to load, for the page's outline."
|
|
1107
1089
|
}
|
|
1108
1090
|
],
|
|
1109
1091
|
"native": [
|
|
@@ -1202,6 +1184,20 @@
|
|
|
1202
1184
|
"required": false,
|
|
1203
1185
|
"description": "Preset colors to choose from, under the fields: CSS color strings, React Aria's Colors, or `{ color, label }` with a name, such as the colors of a brand."
|
|
1204
1186
|
},
|
|
1187
|
+
{
|
|
1188
|
+
"name": "swatchesFirst",
|
|
1189
|
+
"type": "boolean",
|
|
1190
|
+
"required": false,
|
|
1191
|
+
"default": "false",
|
|
1192
|
+
"description": "Show the swatches first, above the area and the fields, for a picker where presets are the usual choice, such as a tag's color."
|
|
1193
|
+
},
|
|
1194
|
+
{
|
|
1195
|
+
"name": "fields",
|
|
1196
|
+
"type": "boolean",
|
|
1197
|
+
"required": false,
|
|
1198
|
+
"default": "true",
|
|
1199
|
+
"description": "Whether to show the row of value fields, with the format select, the eyedropper and the copy button; without it, the area, the sliders and the swatches choose the color."
|
|
1200
|
+
},
|
|
1205
1201
|
{
|
|
1206
1202
|
"name": "name",
|
|
1207
1203
|
"type": "string",
|
|
@@ -1280,6 +1276,13 @@
|
|
|
1280
1276
|
"required": false,
|
|
1281
1277
|
"description": "Receives the requested state, and why, as Popover's onOpenChange does: such as to close the picker once a swatch is chosen."
|
|
1282
1278
|
},
|
|
1279
|
+
{
|
|
1280
|
+
"name": "trigger",
|
|
1281
|
+
"type": "ReactElement | ((color: { value: string }) => ReactElement)",
|
|
1282
|
+
"required": false,
|
|
1283
|
+
"default": "a button with a swatch and the value",
|
|
1284
|
+
"description": "The element that opens the picker in place of the swatch button, such as a text color button of a toolbar, an A over a bar of the color: an element, or a function that receives the color's value and returns one. It takes the native props given here, the opening behavior and, unless it has its own, the name after the label and the color; style it, and show the color, yourself."
|
|
1285
|
+
},
|
|
1283
1286
|
{
|
|
1284
1287
|
"name": "label",
|
|
1285
1288
|
"type": "string",
|
|
@@ -1345,6 +1348,20 @@
|
|
|
1345
1348
|
"required": false,
|
|
1346
1349
|
"description": "Preset colors to choose from, under the fields: CSS color strings, React Aria's Colors, or `{ color, label }` with a name, such as the colors of a brand."
|
|
1347
1350
|
},
|
|
1351
|
+
{
|
|
1352
|
+
"name": "swatchesFirst",
|
|
1353
|
+
"type": "boolean",
|
|
1354
|
+
"required": false,
|
|
1355
|
+
"default": "false",
|
|
1356
|
+
"description": "Show the swatches first, above the area and the fields, for a picker where presets are the usual choice, such as a tag's color."
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"name": "fields",
|
|
1360
|
+
"type": "boolean",
|
|
1361
|
+
"required": false,
|
|
1362
|
+
"default": "true",
|
|
1363
|
+
"description": "Whether to show the row of value fields, with the format select, the eyedropper and the copy button; without it, the area, the sliders and the swatches choose the color."
|
|
1364
|
+
},
|
|
1348
1365
|
{
|
|
1349
1366
|
"name": "name",
|
|
1350
1367
|
"type": "string",
|
|
@@ -1458,7 +1475,7 @@
|
|
|
1458
1475
|
"name": "name",
|
|
1459
1476
|
"type": "string",
|
|
1460
1477
|
"required": false,
|
|
1461
|
-
"description": "A name for this node, such as \"filters\" or \"summary\",
|
|
1478
|
+
"description": "A name for this node, such as \"filters\" or \"summary\", for the application's styles and tests to find it by; it renders as `data-env-name`. A component's part class names its node instead."
|
|
1462
1479
|
},
|
|
1463
1480
|
{
|
|
1464
1481
|
"name": "container",
|
|
@@ -1688,13 +1705,13 @@
|
|
|
1688
1705
|
},
|
|
1689
1706
|
{
|
|
1690
1707
|
"name": "items",
|
|
1691
|
-
"type": "readonly CommandPaletteItem[]",
|
|
1708
|
+
"type": "readonly CommandPaletteItem[] | readonly CommandPaletteGroup[]",
|
|
1692
1709
|
"required": true,
|
|
1693
|
-
"description": "Filtered and ranked by the application, in display order."
|
|
1710
|
+
"description": "Filtered and ranked by the application, in display order; or groups of items, each under a heading."
|
|
1694
1711
|
},
|
|
1695
1712
|
{
|
|
1696
1713
|
"name": "suggestedItems",
|
|
1697
|
-
"type": "readonly CommandPaletteItem[]",
|
|
1714
|
+
"type": "readonly CommandPaletteItem[] | readonly CommandPaletteGroup[]",
|
|
1698
1715
|
"required": false,
|
|
1699
1716
|
"description": "Shown in place of items while the search field is empty, such as recent documents or suggested pages under a group heading; options like any other."
|
|
1700
1717
|
},
|
|
@@ -1762,6 +1779,18 @@
|
|
|
1762
1779
|
"type": "ReactNode",
|
|
1763
1780
|
"required": false,
|
|
1764
1781
|
"description": "Other content below the list, after the hints."
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
"name": "searchStart",
|
|
1785
|
+
"type": "ReactNode",
|
|
1786
|
+
"required": false,
|
|
1787
|
+
"description": "Content before the search field in its row, such as a scope chip, In: Projects."
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
"name": "searchEnd",
|
|
1791
|
+
"type": "ReactNode",
|
|
1792
|
+
"required": false,
|
|
1793
|
+
"description": "Content after the search field in its row, before the close button, such as a mode switch."
|
|
1765
1794
|
}
|
|
1766
1795
|
],
|
|
1767
1796
|
"native": [
|
|
@@ -1774,7 +1803,7 @@
|
|
|
1774
1803
|
"Composer": {
|
|
1775
1804
|
"kind": "component",
|
|
1776
1805
|
"source": "packages/ui/src/content/Composer.tsx",
|
|
1777
|
-
"description": "The message field of a conversation: a multiline field on a raised surface that grows with its text up to maxRows, with a send button at the end that becomes a stop button while running. Enter submits, Shift+Enter starts a new line and an input method's composition never submits. Without onSend, Enter and the send button submit the field's form.",
|
|
1806
|
+
"description": "The message field of a conversation: a multiline field on a raised surface that grows with its text up to maxRows, with a send button at the end that becomes a stop button while running. Enter submits, or with sendKey mod-enter Ctrl+Enter or ⌘+Enter; Shift+Enter starts a new line and an input method's composition never submits. Without onSend, Enter and the send button submit the field's form.",
|
|
1778
1807
|
"props": [
|
|
1779
1808
|
{
|
|
1780
1809
|
"name": "value",
|
|
@@ -1856,23 +1885,42 @@
|
|
|
1856
1885
|
"description": "Content at the start of the action row, such as an attach button or the name of a model."
|
|
1857
1886
|
},
|
|
1858
1887
|
{
|
|
1859
|
-
"name": "
|
|
1888
|
+
"name": "end",
|
|
1860
1889
|
"type": "ReactNode",
|
|
1861
1890
|
"required": false,
|
|
1862
|
-
"description": "
|
|
1891
|
+
"description": "Content in the action row just before the send button, such as a voice button, a model picker or a token count; the field then takes a row of its own above the action row."
|
|
1863
1892
|
},
|
|
1864
1893
|
{
|
|
1865
|
-
"name": "
|
|
1866
|
-
"type": "
|
|
1894
|
+
"name": "header",
|
|
1895
|
+
"type": "ReactNode",
|
|
1867
1896
|
"required": false,
|
|
1868
|
-
"
|
|
1869
|
-
"description": "Names the field, which has no visible label, such as \"Message\"; this or aria-labelledby."
|
|
1897
|
+
"description": "Content inside the composer above the field, such as attachment chips, a quoted reply or context pills, placed as given."
|
|
1870
1898
|
},
|
|
1871
1899
|
{
|
|
1872
|
-
"name": "
|
|
1873
|
-
"type": "
|
|
1900
|
+
"name": "sendKey",
|
|
1901
|
+
"type": "'enter' | 'mod-enter'",
|
|
1874
1902
|
"required": false,
|
|
1875
|
-
"
|
|
1903
|
+
"default": "'enter'",
|
|
1904
|
+
"description": "The key that sends: enter, where Shift+Enter starts a new line, or mod-enter, Ctrl+Enter or ⌘+Enter, where Enter starts a new line, for prompts that mostly take several lines."
|
|
1905
|
+
},
|
|
1906
|
+
{
|
|
1907
|
+
"name": "description",
|
|
1908
|
+
"type": "ReactNode",
|
|
1909
|
+
"required": false,
|
|
1910
|
+
"description": "Supporting text below the composer, such as a note on attachments; it describes the field."
|
|
1911
|
+
},
|
|
1912
|
+
{
|
|
1913
|
+
"name": "aria-label",
|
|
1914
|
+
"type": "string",
|
|
1915
|
+
"required": false,
|
|
1916
|
+
"requiredWhen": "`aria-labelledby` is not set",
|
|
1917
|
+
"description": "Names the field, which has no visible label, such as \"Message\"; this or aria-labelledby."
|
|
1918
|
+
},
|
|
1919
|
+
{
|
|
1920
|
+
"name": "aria-labelledby",
|
|
1921
|
+
"type": "string",
|
|
1922
|
+
"required": false,
|
|
1923
|
+
"requiredWhen": "`aria-label` is not set",
|
|
1876
1924
|
"description": "The id of visible text that names the field; this or aria-label."
|
|
1877
1925
|
}
|
|
1878
1926
|
],
|
|
@@ -1888,11 +1936,17 @@
|
|
|
1888
1936
|
"source": "packages/ui/src/actions/ConfirmButton.tsx",
|
|
1889
1937
|
"description": "A button for an action that takes effect at once and cannot be undone. The first press arms it and names the consequence in place; a second press runs it. It disarms after a few seconds, when focus leaves and on Escape.",
|
|
1890
1938
|
"props": [
|
|
1939
|
+
{
|
|
1940
|
+
"name": "start",
|
|
1941
|
+
"type": "ReactNode",
|
|
1942
|
+
"required": false,
|
|
1943
|
+
"description": "Content before the label, such as IconAdd, or a small Avatar of the person a button assigns: an envUI icon takes the button's icon size and other content keeps its own. It is hidden from assistive technology, since the label names the button."
|
|
1944
|
+
},
|
|
1891
1945
|
{
|
|
1892
1946
|
"name": "end",
|
|
1893
1947
|
"type": "ReactNode",
|
|
1894
1948
|
"required": false,
|
|
1895
|
-
"description": "
|
|
1949
|
+
"description": "Content after the label, at the far end of a full-width button, such as IconChevronRight for a next step, or a shortcut's Kbd, with aria-hidden on its keys and aria-keyshortcuts on the button: an envUI icon takes the button's icon size and other content keeps its own."
|
|
1896
1950
|
},
|
|
1897
1951
|
{
|
|
1898
1952
|
"name": "size",
|
|
@@ -1921,18 +1975,6 @@
|
|
|
1921
1975
|
"default": "false",
|
|
1922
1976
|
"description": "Fill the width of the container, such as the actions of a narrow form stacked in a column."
|
|
1923
1977
|
},
|
|
1924
|
-
{
|
|
1925
|
-
"name": "startIcon",
|
|
1926
|
-
"type": "ReactNode",
|
|
1927
|
-
"required": false,
|
|
1928
|
-
"description": "A decorative icon before the label, such as IconAdd."
|
|
1929
|
-
},
|
|
1930
|
-
{
|
|
1931
|
-
"name": "endIcon",
|
|
1932
|
-
"type": "ReactNode",
|
|
1933
|
-
"required": false,
|
|
1934
|
-
"description": "A decorative icon after the label, such as a ChevronRight for a next step."
|
|
1935
|
-
},
|
|
1936
1978
|
{
|
|
1937
1979
|
"name": "aria-label",
|
|
1938
1980
|
"type": "string",
|
|
@@ -2037,13 +2079,13 @@
|
|
|
2037
2079
|
},
|
|
2038
2080
|
{
|
|
2039
2081
|
"name": "confirmLabel",
|
|
2040
|
-
"type": "
|
|
2082
|
+
"type": "ReactNode",
|
|
2041
2083
|
"required": true,
|
|
2042
|
-
"description": "The confirm button's label: a verb that names the consequence, such as Delete project."
|
|
2084
|
+
"description": "The confirm button's label: a verb that names the consequence, such as Delete project. Like a Button's content, it can hold more, such as a Kbd of its shortcut."
|
|
2043
2085
|
},
|
|
2044
2086
|
{
|
|
2045
2087
|
"name": "cancelLabel",
|
|
2046
|
-
"type": "
|
|
2088
|
+
"type": "ReactNode",
|
|
2047
2089
|
"required": false,
|
|
2048
2090
|
"default": "'Cancel', or EnvUIProvider's messages.confirmDialog.cancel",
|
|
2049
2091
|
"description": "The cancel button's label."
|
|
@@ -2316,6 +2358,18 @@
|
|
|
2316
2358
|
"required": false,
|
|
2317
2359
|
"description": "The latest value, as YYYY-MM-DD or YYYY-MM-DDTHH:mm; later days are unavailable."
|
|
2318
2360
|
},
|
|
2361
|
+
{
|
|
2362
|
+
"name": "isDateUnavailable",
|
|
2363
|
+
"type": "CalendarProps['isDateUnavailable']",
|
|
2364
|
+
"required": false,
|
|
2365
|
+
"description": "As Calendar's: whether a day, as YYYY-MM-DD, can't be chosen, such as a booked day."
|
|
2366
|
+
},
|
|
2367
|
+
{
|
|
2368
|
+
"name": "renderDay",
|
|
2369
|
+
"type": "CalendarProps['renderDay']",
|
|
2370
|
+
"required": false,
|
|
2371
|
+
"description": "As Calendar's: the content of a day's mark in the calendar in place of its number."
|
|
2372
|
+
},
|
|
2319
2373
|
{
|
|
2320
2374
|
"name": "placeholderTime",
|
|
2321
2375
|
"type": "string",
|
|
@@ -2403,7 +2457,7 @@
|
|
|
2403
2457
|
},
|
|
2404
2458
|
{
|
|
2405
2459
|
"name": "onOpenChange",
|
|
2406
|
-
"type": "(open: boolean, details:
|
|
2460
|
+
"type": "(open: boolean, details: DatePickerOpenChangeDetails) => void",
|
|
2407
2461
|
"required": false,
|
|
2408
2462
|
"description": "Called with the new state, and why, when the calendar opens or closes."
|
|
2409
2463
|
},
|
|
@@ -2449,6 +2503,18 @@
|
|
|
2449
2503
|
"default": "'Next month', or EnvUIProvider's messages.calendar.nextMonth",
|
|
2450
2504
|
"description": "Accessible name of the calendar's next month button."
|
|
2451
2505
|
},
|
|
2506
|
+
{
|
|
2507
|
+
"name": "popupHeader",
|
|
2508
|
+
"type": "ReactNode",
|
|
2509
|
+
"required": false,
|
|
2510
|
+
"description": "Content at the top of the popup, above the calendar, such as presets: buttons for Tomorrow or Next Monday that set the value, from a field the application controls."
|
|
2511
|
+
},
|
|
2512
|
+
{
|
|
2513
|
+
"name": "popupFooter",
|
|
2514
|
+
"type": "ReactNode",
|
|
2515
|
+
"required": false,
|
|
2516
|
+
"description": "Content in the popup's footer, after its shortcut to the current date or time and before Clear, such as a note of the time zone or another action."
|
|
2517
|
+
},
|
|
2452
2518
|
{
|
|
2453
2519
|
"name": "label",
|
|
2454
2520
|
"type": "ReactNode",
|
|
@@ -2592,8 +2658,8 @@
|
|
|
2592
2658
|
{
|
|
2593
2659
|
"name": "title",
|
|
2594
2660
|
"type": "ReactNode",
|
|
2595
|
-
"required":
|
|
2596
|
-
"description": "The dialog's heading and accessible name, such as “Delete project?”."
|
|
2661
|
+
"required": false,
|
|
2662
|
+
"description": "The dialog's heading and accessible name, such as “Delete project?”. Without one, such as for an image viewer or a search dialog its field names, name the dialog with aria-label or aria-labelledby."
|
|
2597
2663
|
},
|
|
2598
2664
|
{
|
|
2599
2665
|
"name": "description",
|
|
@@ -2611,14 +2677,46 @@
|
|
|
2611
2677
|
"name": "actions",
|
|
2612
2678
|
"type": "ReactNode",
|
|
2613
2679
|
"required": false,
|
|
2614
|
-
"description": "The dialog's own actions, after the built-in close button, with the primary action last. They close the dialog only where they are DialogClose or set open to false. While the dialog is pending, the last one shows it, where it is a Button that sets no pending of its own."
|
|
2680
|
+
"description": "The dialog's own actions, after the built-in close button, with the primary action last. They close the dialog only where they are DialogClose or set open to false. While the dialog is pending, the last one shows it, where it is a Button that sets no pending of its own; another component reads it with useDialogPending."
|
|
2681
|
+
},
|
|
2682
|
+
{
|
|
2683
|
+
"name": "actionsStart",
|
|
2684
|
+
"type": "ReactNode",
|
|
2685
|
+
"required": false,
|
|
2686
|
+
"description": "Content at the start of the actions' row, which takes the room the actions leave, such as a destructive Delete, a Learn more link or a Don't show again checkbox."
|
|
2687
|
+
},
|
|
2688
|
+
{
|
|
2689
|
+
"name": "closeButton",
|
|
2690
|
+
"type": "boolean",
|
|
2691
|
+
"required": false,
|
|
2692
|
+
"default": "true",
|
|
2693
|
+
"description": "Whether the dialog shows its built-in close button, as on a Sheet. Leave it out only where the dialog places its own DialogClose."
|
|
2694
|
+
},
|
|
2695
|
+
{
|
|
2696
|
+
"name": "closeButtonPlacement",
|
|
2697
|
+
"type": "'actions' | 'heading'",
|
|
2698
|
+
"required": false,
|
|
2699
|
+
"default": "'actions'",
|
|
2700
|
+
"description": "Where the built-in close button is: actions, a secondary button that starts the actions; heading, an IconButton with a cross at the end of the heading, as on a Sheet."
|
|
2615
2701
|
},
|
|
2616
2702
|
{
|
|
2617
2703
|
"name": "closeLabel",
|
|
2618
2704
|
"type": "string",
|
|
2619
2705
|
"required": false,
|
|
2620
2706
|
"default": "'Close', or EnvUIProvider's messages.dialog.close",
|
|
2621
|
-
"description": "The label of the built-in close button
|
|
2707
|
+
"description": "The label of the built-in close button, such as Cancel, or its name in the heading."
|
|
2708
|
+
},
|
|
2709
|
+
{
|
|
2710
|
+
"name": "headerStart",
|
|
2711
|
+
"type": "ReactNode",
|
|
2712
|
+
"required": false,
|
|
2713
|
+
"description": "Content before the title in the heading's row, such as a back button."
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "headerEnd",
|
|
2717
|
+
"type": "ReactNode",
|
|
2718
|
+
"required": false,
|
|
2719
|
+
"description": "Content at the end of the heading's row, before a close button there, such as a Menu of more actions or an Open full page button."
|
|
2622
2720
|
},
|
|
2623
2721
|
{
|
|
2624
2722
|
"name": "placement",
|
|
@@ -2722,22 +2820,16 @@
|
|
|
2722
2820
|
"description": "Fill the width of the container, such as the actions of a narrow form stacked in a column."
|
|
2723
2821
|
},
|
|
2724
2822
|
{
|
|
2725
|
-
"name": "
|
|
2726
|
-
"type": "ReactNode",
|
|
2727
|
-
"required": false,
|
|
2728
|
-
"description": "A decorative icon before the label, such as IconAdd."
|
|
2729
|
-
},
|
|
2730
|
-
{
|
|
2731
|
-
"name": "endIcon",
|
|
2823
|
+
"name": "start",
|
|
2732
2824
|
"type": "ReactNode",
|
|
2733
2825
|
"required": false,
|
|
2734
|
-
"description": "
|
|
2826
|
+
"description": "Content before the label, such as IconAdd, or a small Avatar of the person a button assigns: an envUI icon takes the button's icon size and other content keeps its own. It is hidden from assistive technology, since the label names the button."
|
|
2735
2827
|
},
|
|
2736
2828
|
{
|
|
2737
2829
|
"name": "end",
|
|
2738
2830
|
"type": "ReactNode",
|
|
2739
2831
|
"required": false,
|
|
2740
|
-
"description": "
|
|
2832
|
+
"description": "Content after the label, at the far end of a full-width button, such as IconChevronRight for a next step, or a shortcut's Kbd, with aria-hidden on its keys and aria-keyshortcuts on the button: an envUI icon takes the button's icon size and other content keeps its own."
|
|
2741
2833
|
},
|
|
2742
2834
|
{
|
|
2743
2835
|
"name": "pending",
|
|
@@ -2745,42 +2837,16 @@
|
|
|
2745
2837
|
"required": false,
|
|
2746
2838
|
"default": "false",
|
|
2747
2839
|
"description": "Its work is running: a spinner turns over it, it keeps its width and name, and presses do nothing."
|
|
2748
|
-
}
|
|
2749
|
-
],
|
|
2750
|
-
"native": [
|
|
2751
|
-
"button"
|
|
2752
|
-
],
|
|
2753
|
-
"entries": [
|
|
2754
|
-
"@envsemble/envui"
|
|
2755
|
-
]
|
|
2756
|
-
},
|
|
2757
|
-
"DiffStat": {
|
|
2758
|
-
"kind": "component",
|
|
2759
|
-
"source": "packages/ui/src/data-display/DiffStat.tsx",
|
|
2760
|
-
"description": "The size of a change as one compact pill, such as +12 −3: additions in the success tone and deletions in the danger tone, on a counter badge's quiet fill.",
|
|
2761
|
-
"props": [
|
|
2762
|
-
{
|
|
2763
|
-
"name": "additions",
|
|
2764
|
-
"type": "number",
|
|
2765
|
-
"required": true,
|
|
2766
|
-
"description": "Lines or items added, shown as +12 in the success tone, in the locale's digits; left out where it is 0 and deletions aren't."
|
|
2767
|
-
},
|
|
2768
|
-
{
|
|
2769
|
-
"name": "deletions",
|
|
2770
|
-
"type": "number",
|
|
2771
|
-
"required": true,
|
|
2772
|
-
"description": "Lines or items removed, shown as −3 in the danger tone, in the locale's digits; left out where it is 0 and additions aren't."
|
|
2773
2840
|
},
|
|
2774
2841
|
{
|
|
2775
|
-
"name": "
|
|
2776
|
-
"type": "
|
|
2842
|
+
"name": "render",
|
|
2843
|
+
"type": "ReactElement",
|
|
2777
2844
|
"required": false,
|
|
2778
|
-
"
|
|
2779
|
-
"description": "Full meaning for assistive technology. It overrides EnvUIProvider's `messages.diffStat.label`."
|
|
2845
|
+
"description": "Another element to render the button as, such as a label for a file input, or a router's own link in one place: the button's class, look, state attributes, content and handlers merge into its props. It takes no type or disabled attribute; disabled reports aria-disabled and blocks presses."
|
|
2780
2846
|
}
|
|
2781
2847
|
],
|
|
2782
2848
|
"native": [
|
|
2783
|
-
"
|
|
2849
|
+
"button"
|
|
2784
2850
|
],
|
|
2785
2851
|
"entries": [
|
|
2786
2852
|
"@envsemble/envui"
|
|
@@ -2821,6 +2887,20 @@
|
|
|
2821
2887
|
"type": "(open: boolean) => void",
|
|
2822
2888
|
"required": false,
|
|
2823
2889
|
"description": "Receives whether the details show, each time the disclosure opens or closes."
|
|
2890
|
+
},
|
|
2891
|
+
{
|
|
2892
|
+
"name": "indicatorPlacement",
|
|
2893
|
+
"type": "'start' | 'end'",
|
|
2894
|
+
"required": false,
|
|
2895
|
+
"default": "'start'",
|
|
2896
|
+
"description": "Where the chevron sits in the summary: before its words, or after them, as in a Show more link."
|
|
2897
|
+
},
|
|
2898
|
+
{
|
|
2899
|
+
"name": "panelLayout",
|
|
2900
|
+
"type": "'stack' | 'flow'",
|
|
2901
|
+
"required": false,
|
|
2902
|
+
"default": "'stack'",
|
|
2903
|
+
"description": "stack lays the details out one under another, a small gap apart; flow places them as given, so they keep their own spacing and flow, such as inline text."
|
|
2824
2904
|
}
|
|
2825
2905
|
],
|
|
2826
2906
|
"native": [
|
|
@@ -2861,19 +2941,19 @@
|
|
|
2861
2941
|
},
|
|
2862
2942
|
{
|
|
2863
2943
|
"name": "onClose",
|
|
2864
|
-
"type": "(
|
|
2944
|
+
"type": "(value: string) => void",
|
|
2865
2945
|
"required": true,
|
|
2866
2946
|
"description": "Called from a tab's close button, a middle click, Delete or Backspace on the focused tab, and Close in the tab's context menu."
|
|
2867
2947
|
},
|
|
2868
2948
|
{
|
|
2869
2949
|
"name": "onPin",
|
|
2870
|
-
"type": "(
|
|
2950
|
+
"type": "(value: string) => void",
|
|
2871
2951
|
"required": false,
|
|
2872
2952
|
"description": "Called when a tab is double-clicked, typically to keep a preview tab open."
|
|
2873
2953
|
},
|
|
2874
2954
|
{
|
|
2875
2955
|
"name": "onReorder",
|
|
2876
|
-
"type": "(
|
|
2956
|
+
"type": "(values: string[]) => void",
|
|
2877
2957
|
"required": false,
|
|
2878
2958
|
"description": "Called with every tab's value in the new order when a tab is dragged to another place with a mouse or pen, or moved with Move left or Move right in its context menu, which also reach the keyboard and touch. Without it, the tabs keep their order."
|
|
2879
2959
|
},
|
|
@@ -2900,7 +2980,7 @@
|
|
|
2900
2980
|
"type": "(label: string) => string",
|
|
2901
2981
|
"required": false,
|
|
2902
2982
|
"default": "'Close {label}', or EnvUIProvider's messages.documentTabs.close",
|
|
2903
|
-
"description": "The name of the context menu's item that closes a tab, and the tooltip of its close button."
|
|
2983
|
+
"description": "The name of the context menu's item that closes a tab, and the tooltip of its close button, from the tab's text value."
|
|
2904
2984
|
},
|
|
2905
2985
|
{
|
|
2906
2986
|
"name": "onCloseAll",
|
|
@@ -2921,6 +3001,12 @@
|
|
|
2921
3001
|
"required": false,
|
|
2922
3002
|
"default": "'Tab actions', or EnvUIProvider's messages.documentTabs.contextMenu",
|
|
2923
3003
|
"description": "Accessible name of the context menu."
|
|
3004
|
+
},
|
|
3005
|
+
{
|
|
3006
|
+
"name": "contextMenu",
|
|
3007
|
+
"type": "(tab: DocumentTabsItem | null) => ReactNode",
|
|
3008
|
+
"required": false,
|
|
3009
|
+
"description": "The application's own items for the context menu of the tab people open it on, or of the strip around the tabs when the tab is null, such as Close others or Copy path. They come after the built-in items, past a separator."
|
|
2924
3010
|
}
|
|
2925
3011
|
],
|
|
2926
3012
|
"native": [
|
|
@@ -2939,7 +3025,7 @@
|
|
|
2939
3025
|
"name": "label",
|
|
2940
3026
|
"type": "ReactNode",
|
|
2941
3027
|
"required": true,
|
|
2942
|
-
"description": "What to drop or choose, such as \"Drop a logo here, or browse\". With the description, it names the zone, as its visible text does."
|
|
3028
|
+
"description": "What to drop or choose, such as \"Drop a logo here, or browse\". With the description, it names the zone, as its visible text does; without the target, only assistive technology reads it."
|
|
2943
3029
|
},
|
|
2944
3030
|
{
|
|
2945
3031
|
"name": "description",
|
|
@@ -2953,6 +3039,12 @@
|
|
|
2953
3039
|
"required": false,
|
|
2954
3040
|
"description": "Replaces the upload icon."
|
|
2955
3041
|
},
|
|
3042
|
+
{
|
|
3043
|
+
"name": "children",
|
|
3044
|
+
"type": "ReactNode",
|
|
3045
|
+
"required": false,
|
|
3046
|
+
"description": "Content inside the zone, under its target, such as the chosen files with their previews and Remove buttons, or a Browse button that opens the file picker through inputRef. Files dropped on it are taken too; it can hold controls, since it is beside the target button, not inside it."
|
|
3047
|
+
},
|
|
2956
3048
|
{
|
|
2957
3049
|
"name": "accept",
|
|
2958
3050
|
"type": "string",
|
|
@@ -3029,6 +3121,19 @@
|
|
|
3029
3121
|
"type": "Ref<HTMLInputElement>",
|
|
3030
3122
|
"required": false,
|
|
3031
3123
|
"description": "The native file input that opens the file picker, for example from a Replace button; ref reaches the zone itself."
|
|
3124
|
+
},
|
|
3125
|
+
{
|
|
3126
|
+
"name": "target",
|
|
3127
|
+
"type": "boolean",
|
|
3128
|
+
"required": false,
|
|
3129
|
+
"default": "true",
|
|
3130
|
+
"description": "Show the target: the button with the icon, the label and the description that opens the file picker. Without it, the zone is a group the label names, for content that has its own Browse button, which opens the picker through inputRef, such as a table the files land in."
|
|
3131
|
+
},
|
|
3132
|
+
{
|
|
3133
|
+
"name": "render",
|
|
3134
|
+
"type": "ReactElement",
|
|
3135
|
+
"required": false,
|
|
3136
|
+
"description": "Another element to render the zone as, such as the application's own panel or table region, which then takes dropped files: the zone's class, its state attributes, such as data-drag-over, and its handlers merge into its props."
|
|
3032
3137
|
}
|
|
3033
3138
|
],
|
|
3034
3139
|
"native": [
|
|
@@ -3041,13 +3146,19 @@
|
|
|
3041
3146
|
"EmptyState": {
|
|
3042
3147
|
"kind": "component",
|
|
3043
3148
|
"source": "packages/ui/src/feedback/EmptyState.tsx",
|
|
3044
|
-
"description": "What a region shows when it has nothing to show: an optional icon, a title, an optional description and optional actions, centred in the region it fills, and compact where that region is narrow.",
|
|
3149
|
+
"description": "What a region shows when it has nothing to show: an optional illustration or icon, a title, an optional description and optional actions, centred in the region it fills, and compact where that region is narrow.",
|
|
3045
3150
|
"props": [
|
|
3046
3151
|
{
|
|
3047
3152
|
"name": "icon",
|
|
3048
3153
|
"type": "ReactNode",
|
|
3049
3154
|
"required": false,
|
|
3050
|
-
"description": "A decorative icon above the title, such as the icon of what the region would list."
|
|
3155
|
+
"description": "A decorative icon above the title, such as the icon of what the region would list, at the icon size of the region's width."
|
|
3156
|
+
},
|
|
3157
|
+
{
|
|
3158
|
+
"name": "illustration",
|
|
3159
|
+
"type": "ReactNode",
|
|
3160
|
+
"required": false,
|
|
3161
|
+
"description": "A decorative illustration above the title, such as an SVG drawing or an image, at its own size and no wider than the region, in place of the icon where both are given. It is hidden from assistive technology."
|
|
3051
3162
|
},
|
|
3052
3163
|
{
|
|
3053
3164
|
"name": "title",
|
|
@@ -3248,6 +3359,13 @@
|
|
|
3248
3359
|
"type": "ReactNode",
|
|
3249
3360
|
"required": false,
|
|
3250
3361
|
"description": "How to correct the value. Without children, the browser's validation message shows."
|
|
3362
|
+
},
|
|
3363
|
+
{
|
|
3364
|
+
"name": "icon",
|
|
3365
|
+
"type": "ReactNode",
|
|
3366
|
+
"required": false,
|
|
3367
|
+
"default": "the error icon",
|
|
3368
|
+
"description": "The icon before the message, decorative, so hide an icon of your own from assistive technology, or null for none, such as for a compact error beside a control."
|
|
3251
3369
|
}
|
|
3252
3370
|
],
|
|
3253
3371
|
"native": [
|
|
@@ -3495,7 +3613,7 @@
|
|
|
3495
3613
|
"name": "name",
|
|
3496
3614
|
"type": "string",
|
|
3497
3615
|
"required": false,
|
|
3498
|
-
"description": "A name for this node, such as \"filters\" or \"summary\",
|
|
3616
|
+
"description": "A name for this node, such as \"filters\" or \"summary\", for the application's styles and tests to find it by; it renders as `data-env-name`. A component's part class names its node instead."
|
|
3499
3617
|
},
|
|
3500
3618
|
{
|
|
3501
3619
|
"name": "container",
|
|
@@ -3517,6 +3635,32 @@
|
|
|
3517
3635
|
"@envsemble/envui"
|
|
3518
3636
|
]
|
|
3519
3637
|
},
|
|
3638
|
+
"Halo": {
|
|
3639
|
+
"kind": "component",
|
|
3640
|
+
"source": "packages/ui/src/feedback/Halo.tsx",
|
|
3641
|
+
"description": "A soft halo that breathes around what it holds, to point at the one control or region to look at next, such as the first step of a tour. The halo stays outside the content and takes no room, and is hidden from assistive technology; it holds still with a reduced-motion preference.",
|
|
3642
|
+
"props": [
|
|
3643
|
+
{
|
|
3644
|
+
"name": "tone",
|
|
3645
|
+
"type": "'accent' | 'primary'",
|
|
3646
|
+
"required": false,
|
|
3647
|
+
"default": "'accent'",
|
|
3648
|
+
"description": "The halo's color: accent, the purple that stands out, or primary, the blue of what is current. --env-halo-indicator gives it any other color, such as a brand's."
|
|
3649
|
+
},
|
|
3650
|
+
{
|
|
3651
|
+
"name": "render",
|
|
3652
|
+
"type": "ReactElement",
|
|
3653
|
+
"required": false,
|
|
3654
|
+
"description": "The element to render, a span that keeps an inline child, such as a Button, in its line; or render={<div />} around a block, such as a Card, so it keeps its width. Without children it is the box the ring surrounds, which the application places itself, such as with position absolute over a region it measured."
|
|
3655
|
+
}
|
|
3656
|
+
],
|
|
3657
|
+
"native": [
|
|
3658
|
+
"span"
|
|
3659
|
+
],
|
|
3660
|
+
"entries": [
|
|
3661
|
+
"@envsemble/envui"
|
|
3662
|
+
]
|
|
3663
|
+
},
|
|
3520
3664
|
"HighlightedCodeBlock": {
|
|
3521
3665
|
"kind": "component",
|
|
3522
3666
|
"source": "packages/ui/src/content/HighlightedCodeBlock.tsx",
|
|
@@ -3536,9 +3680,15 @@
|
|
|
3536
3680
|
},
|
|
3537
3681
|
{
|
|
3538
3682
|
"name": "label",
|
|
3539
|
-
"type": "
|
|
3683
|
+
"type": "ReactNode",
|
|
3684
|
+
"required": false,
|
|
3685
|
+
"description": "Names the block in its heading and for assistive technology, such as a file name, or content such as a file-type icon and a path link. Without one, the code takes the generic name of its language, such as Plain text code or TypeScript code, from messages.codeBlock.label."
|
|
3686
|
+
},
|
|
3687
|
+
{
|
|
3688
|
+
"name": "headerEnd",
|
|
3689
|
+
"type": "ReactNode",
|
|
3540
3690
|
"required": false,
|
|
3541
|
-
"description": "
|
|
3691
|
+
"description": "Content at the end of the heading, before the copy button, such as Open in editor, Run, or a switch between npm, pnpm and yarn, placed as given."
|
|
3542
3692
|
},
|
|
3543
3693
|
{
|
|
3544
3694
|
"name": "copyable",
|
|
@@ -3573,6 +3723,13 @@
|
|
|
3573
3723
|
"required": true,
|
|
3574
3724
|
"description": "The element that opens the card on hover and keyboard focus; it receives the ref. Text, such as a span or Text that holds text, takes a quiet dotted underline, env-hover-detail; give it tabIndex={0}, so keyboard focus reaches it, which envUI reports while developing. A link or another control keeps its own look."
|
|
3575
3725
|
},
|
|
3726
|
+
{
|
|
3727
|
+
"name": "underline",
|
|
3728
|
+
"type": "boolean",
|
|
3729
|
+
"required": false,
|
|
3730
|
+
"default": "true",
|
|
3731
|
+
"description": "Whether a text trigger takes the quiet dotted underline, env-hover-detail, that says it shows more on hover or focus. False leaves its class alone, for text styled its own way, such as"
|
|
3732
|
+
},
|
|
3576
3733
|
{
|
|
3577
3734
|
"name": "children",
|
|
3578
3735
|
"type": "ReactNode",
|
|
@@ -3739,6 +3896,12 @@
|
|
|
3739
3896
|
"type": "'sm' | 'md' | 'lg'",
|
|
3740
3897
|
"required": false,
|
|
3741
3898
|
"description": "As Button's: the height, and the width, of the square button."
|
|
3899
|
+
},
|
|
3900
|
+
{
|
|
3901
|
+
"name": "render",
|
|
3902
|
+
"type": "ReactElement",
|
|
3903
|
+
"required": false,
|
|
3904
|
+
"description": "As Button's: another element to render the button as, such as a label for a file input shaped like an icon button. Its class, look, state attributes, icon and handlers merge into that element's props; disabled reports aria-disabled and blocks presses."
|
|
3742
3905
|
}
|
|
3743
3906
|
],
|
|
3744
3907
|
"native": [
|
|
@@ -3756,9 +3919,16 @@
|
|
|
3756
3919
|
"props": [
|
|
3757
3920
|
{
|
|
3758
3921
|
"name": "keys",
|
|
3759
|
-
"type": "readonly
|
|
3922
|
+
"type": "readonly ReactNode[]",
|
|
3923
|
+
"required": false,
|
|
3924
|
+
"description": "Keys pressed together, such as ['Ctrl', 'P']: one key cap each, joined by the separator, inside an outer `<kbd>`. A key can be any content, such as an icon for an arrow or Return. Without it, the children are one key."
|
|
3925
|
+
},
|
|
3926
|
+
{
|
|
3927
|
+
"name": "separator",
|
|
3928
|
+
"type": "ReactNode",
|
|
3760
3929
|
"required": false,
|
|
3761
|
-
"
|
|
3930
|
+
"default": "'+'",
|
|
3931
|
+
"description": "What joins the keys: a +, null for none, as in ⌘⇧P, or a word for keys pressed one after another, such as then in G then I."
|
|
3762
3932
|
}
|
|
3763
3933
|
],
|
|
3764
3934
|
"native": [
|
|
@@ -3868,14 +4038,14 @@
|
|
|
3868
4038
|
"name": "control",
|
|
3869
4039
|
"type": "ReactNode",
|
|
3870
4040
|
"required": false,
|
|
3871
|
-
"description": "The
|
|
4041
|
+
"description": "The control of the setting the row is about, at the row's end: a Switch, a Checkbox, a Radio or a field, such as a Select or a SegmentedControl, given no label of its own. The row's label names it and the row's description describes it, so it isn't labelled twice."
|
|
3872
4042
|
},
|
|
3873
4043
|
{
|
|
3874
4044
|
"name": "interactive",
|
|
3875
4045
|
"type": "boolean",
|
|
3876
4046
|
"required": false,
|
|
3877
4047
|
"default": "false",
|
|
3878
|
-
"description": "The row opens something through a link or button inside: it reacts to hover, keyboard focus inside it and presses. Mark that link or button `data-row-target` to stretch it over the row."
|
|
4048
|
+
"description": "The row opens something through a link or button inside: it reacts to hover, keyboard focus inside it and presses. Mark that link or button `data-row-target` to stretch it over the row; the other links, buttons and fields in the row, such as an author's link in the description, stay clickable above it."
|
|
3879
4049
|
},
|
|
3880
4050
|
{
|
|
3881
4051
|
"name": "current",
|
|
@@ -3936,6 +4106,12 @@
|
|
|
3936
4106
|
"required": false,
|
|
3937
4107
|
"description": "A sentence under the title, in muted text, such as what the group's settings change. It describes the list."
|
|
3938
4108
|
},
|
|
4109
|
+
{
|
|
4110
|
+
"name": "headerEnd",
|
|
4111
|
+
"type": "ReactNode",
|
|
4112
|
+
"required": false,
|
|
4113
|
+
"description": "Content at the end of the title's line, outside the heading, such as an Add Button, a Manage link or a count, placed as given; it wraps below the title when it doesn't fit beside it."
|
|
4114
|
+
},
|
|
3939
4115
|
{
|
|
3940
4116
|
"name": "density",
|
|
3941
4117
|
"type": "'xs' | 'sm' | 'md' | 'lg'",
|
|
@@ -3947,7 +4123,14 @@
|
|
|
3947
4123
|
"name": "onReorder",
|
|
3948
4124
|
"type": "(from: number, to: number) => void",
|
|
3949
4125
|
"required": false,
|
|
3950
|
-
"description": "Makes the rows reorderable: each row gets a drag handle at its start, moved by dragging it, by pressing it or by keyboard, and the list calls this with the row's index and the index it is dropped at. The application moves the item in its own state; nothing moves until it does. The rows are the list's children, directly or in arrays and fragments: List.Item elements, or elements of a row component that passes the props it doesn't use on to its List.Item, such as `function SlideRow({ slide, ...props }) { return <List.Item {...props} label={slide} />; }`."
|
|
4126
|
+
"description": "Makes the rows reorderable: each row gets a drag handle, at its start unless handlePlacement puts it at its end, moved by dragging it, by pressing it or by keyboard, and the list calls this with the row's index and the index it is dropped at. The application moves the item in its own state; nothing moves until it does. The rows are the list's children, directly or in arrays and fragments: List.Item elements, or elements of a row component that passes the props it doesn't use on to its List.Item, such as `function SlideRow({ slide, ...props }) { return <List.Item {...props} label={slide} />; }`."
|
|
4127
|
+
},
|
|
4128
|
+
{
|
|
4129
|
+
"name": "handlePlacement",
|
|
4130
|
+
"type": "'start' | 'end'",
|
|
4131
|
+
"required": false,
|
|
4132
|
+
"default": "'start'",
|
|
4133
|
+
"description": "Where each row's drag handle sits in a list with onReorder: at the row's start, before its start content, or at its end, after its end content and its control."
|
|
3951
4134
|
},
|
|
3952
4135
|
{
|
|
3953
4136
|
"name": "skeleton",
|
|
@@ -3988,6 +4171,13 @@
|
|
|
3988
4171
|
"required": false,
|
|
3989
4172
|
"description": "Receives safe hrefs and native anchor props. Retain a real anchor destination."
|
|
3990
4173
|
},
|
|
4174
|
+
{
|
|
4175
|
+
"name": "allowLinkSchemes",
|
|
4176
|
+
"type": "readonly string[]",
|
|
4177
|
+
"required": false,
|
|
4178
|
+
"default": "[]",
|
|
4179
|
+
"description": "Schemes a link may take beside the safe ones, such as `['vscode']` for links that open the editor, or the application's own. A link keeps a relative destination or an http, https, mailto, irc, ircs or xmpp one either way; one with another scheme renders as plain text. javascript, data and vbscript are refused even when listed, since a link with one runs code or opens content the application didn't write."
|
|
4180
|
+
},
|
|
3991
4181
|
{
|
|
3992
4182
|
"name": "codeCopyable",
|
|
3993
4183
|
"type": "boolean",
|
|
@@ -4012,6 +4202,13 @@
|
|
|
4012
4202
|
"type": "Options['rehypePlugins']",
|
|
4013
4203
|
"required": false,
|
|
4014
4204
|
"description": "rehype plugins, such as heading ids; envUI adds none of its own."
|
|
4205
|
+
},
|
|
4206
|
+
{
|
|
4207
|
+
"name": "allowHtml",
|
|
4208
|
+
"type": "boolean",
|
|
4209
|
+
"required": false,
|
|
4210
|
+
"default": "false",
|
|
4211
|
+
"description": "Keeps raw HTML in the Markdown, such as details, sub, sup or an img with a width, for trusted content such as the application's own docs or a README. Only rehype-raw in rehypePlugins renders it, so give a sanitizer with it, such as rehype-sanitize. Without it, raw HTML is dropped, apart from kbd around plain text."
|
|
4015
4212
|
}
|
|
4016
4213
|
],
|
|
4017
4214
|
"native": [
|
|
@@ -4021,195 +4218,87 @@
|
|
|
4021
4218
|
"@envsemble/envui/markdown"
|
|
4022
4219
|
]
|
|
4023
4220
|
},
|
|
4024
|
-
"
|
|
4221
|
+
"Menu": {
|
|
4222
|
+
"kind": "namespace",
|
|
4223
|
+
"source": "packages/ui/src/actions/menu/Menu.tsx",
|
|
4224
|
+
"description": "",
|
|
4225
|
+
"parts": [
|
|
4226
|
+
"Menu.Root",
|
|
4227
|
+
"Menu.Header",
|
|
4228
|
+
"Menu.Item",
|
|
4229
|
+
"Menu.Separator",
|
|
4230
|
+
"Menu.Submenu",
|
|
4231
|
+
"Menu.Group",
|
|
4232
|
+
"Menu.RadioGroup",
|
|
4233
|
+
"Menu.RadioItem",
|
|
4234
|
+
"Menu.CheckboxItem"
|
|
4235
|
+
],
|
|
4236
|
+
"entries": [
|
|
4237
|
+
"@envsemble/envui"
|
|
4238
|
+
]
|
|
4239
|
+
},
|
|
4240
|
+
"Menu.CheckboxItem": {
|
|
4025
4241
|
"kind": "component",
|
|
4026
|
-
"source": "packages/ui/src/
|
|
4027
|
-
"description": "
|
|
4242
|
+
"source": "packages/ui/src/actions/menu/Menu.tsx",
|
|
4243
|
+
"description": "An independent on/off option; a check mark shows while it is on.",
|
|
4028
4244
|
"props": [
|
|
4029
4245
|
{
|
|
4030
|
-
"name": "
|
|
4031
|
-
"type": "
|
|
4032
|
-
"required": false,
|
|
4033
|
-
"description": "The native text area of the source, so that a form library can register it and focus it."
|
|
4034
|
-
},
|
|
4035
|
-
{
|
|
4036
|
-
"name": "value",
|
|
4037
|
-
"type": "string",
|
|
4246
|
+
"name": "checked",
|
|
4247
|
+
"type": "boolean",
|
|
4038
4248
|
"required": false,
|
|
4039
|
-
"description": "
|
|
4249
|
+
"description": "Whether the option is on, for an item the application controls; a check mark shows while it is."
|
|
4040
4250
|
},
|
|
4041
4251
|
{
|
|
4042
|
-
"name": "
|
|
4043
|
-
"type": "
|
|
4252
|
+
"name": "defaultChecked",
|
|
4253
|
+
"type": "boolean",
|
|
4044
4254
|
"required": false,
|
|
4045
|
-
"default": "
|
|
4046
|
-
"description": "
|
|
4255
|
+
"default": "false",
|
|
4256
|
+
"description": "Whether an uncontrolled item starts on."
|
|
4047
4257
|
},
|
|
4048
4258
|
{
|
|
4049
|
-
"name": "
|
|
4050
|
-
"type": "(
|
|
4259
|
+
"name": "onCheckedChange",
|
|
4260
|
+
"type": "(checked: boolean) => void",
|
|
4051
4261
|
"required": false,
|
|
4052
|
-
"description": "
|
|
4262
|
+
"description": "Called with the new state when the item is toggled."
|
|
4053
4263
|
},
|
|
4054
4264
|
{
|
|
4055
|
-
"name": "
|
|
4056
|
-
"type": "
|
|
4265
|
+
"name": "disabled",
|
|
4266
|
+
"type": "boolean",
|
|
4057
4267
|
"required": false,
|
|
4058
|
-
"default": "
|
|
4059
|
-
"description": "
|
|
4268
|
+
"default": "false",
|
|
4269
|
+
"description": "The item stays in place, dimmed, but cannot be toggled."
|
|
4060
4270
|
},
|
|
4061
4271
|
{
|
|
4062
|
-
"name": "
|
|
4272
|
+
"name": "closeOnClick",
|
|
4063
4273
|
"type": "boolean",
|
|
4064
4274
|
"required": false,
|
|
4065
|
-
"default": "
|
|
4066
|
-
"description": "
|
|
4275
|
+
"default": "false",
|
|
4276
|
+
"description": "Close the menu after toggling; off by default, so several options can change."
|
|
4067
4277
|
},
|
|
4068
4278
|
{
|
|
4069
|
-
"name": "
|
|
4070
|
-
"type": "
|
|
4279
|
+
"name": "className",
|
|
4280
|
+
"type": "string",
|
|
4071
4281
|
"required": false,
|
|
4072
|
-
"description": "
|
|
4282
|
+
"description": "Class of the item's row."
|
|
4073
4283
|
},
|
|
4074
4284
|
{
|
|
4075
|
-
"name": "
|
|
4076
|
-
"type": "(request: MarkdownLinkRequest) => MarkdownLink | null | Promise<MarkdownLink | null>",
|
|
4077
|
-
"required": false,
|
|
4078
|
-
"description": "Optional application picker. Return null to cancel; otherwise return an ordinary link."
|
|
4079
|
-
},
|
|
4080
|
-
{
|
|
4081
|
-
"name": "label",
|
|
4082
|
-
"type": "ReactNode",
|
|
4083
|
-
"required": false,
|
|
4084
|
-
"description": "The field's visible name, above the field, such as Project name; it also names the control for assistive technology."
|
|
4085
|
-
},
|
|
4086
|
-
{
|
|
4087
|
-
"name": "style",
|
|
4088
|
-
"type": "CSSProperties",
|
|
4089
|
-
"required": false,
|
|
4090
|
-
"description": "Styles of the field's root element, such as its width in a row."
|
|
4091
|
-
},
|
|
4092
|
-
{
|
|
4093
|
-
"name": "className",
|
|
4094
|
-
"type": "string",
|
|
4095
|
-
"required": false,
|
|
4096
|
-
"description": "The field's class, on its root element, beside env-field, env-text-field and env-textarea."
|
|
4097
|
-
},
|
|
4098
|
-
{
|
|
4099
|
-
"name": "description",
|
|
4285
|
+
"name": "start",
|
|
4100
4286
|
"type": "ReactNode",
|
|
4101
4287
|
"required": false,
|
|
4102
|
-
"description": "
|
|
4103
|
-
},
|
|
4104
|
-
{
|
|
4105
|
-
"name": "rows",
|
|
4106
|
-
"type": "number",
|
|
4107
|
-
"required": false,
|
|
4108
|
-
"default": "8",
|
|
4109
|
-
"description": "The lines the field shows: with fixed sizing, its height in rows, which resizes down to them or to 7.5 rem, whichever is less; with content sizing, the lines it starts at and shrinks back to. Without rows, both start at 7.5 rem."
|
|
4110
|
-
},
|
|
4111
|
-
{
|
|
4112
|
-
"name": "variant",
|
|
4113
|
-
"type": "'outline' | 'ghost'",
|
|
4114
|
-
"required": false,
|
|
4115
|
-
"default": "'outline'",
|
|
4116
|
-
"description": "The field's look, as TextField's: outline or ghost."
|
|
4288
|
+
"description": "Content before the label, such as the Settings icon or an Avatar in an account switcher: an envUI icon takes the icon size and other content keeps its own, and the labels of the menu's rows still line up. It is hidden from assistive technology, since the label names the item."
|
|
4117
4289
|
},
|
|
4118
4290
|
{
|
|
4119
|
-
"name": "
|
|
4291
|
+
"name": "children",
|
|
4120
4292
|
"type": "ReactNode",
|
|
4121
|
-
"required":
|
|
4122
|
-
"description": "
|
|
4123
|
-
},
|
|
4124
|
-
{
|
|
4125
|
-
"name": "sizing",
|
|
4126
|
-
"type": "'fixed' | 'content'",
|
|
4127
|
-
"required": false,
|
|
4128
|
-
"default": "'fixed'",
|
|
4129
|
-
"description": "How the height follows the text: fixed keeps its height, scrolls and resizes from the bottom edge, by dragging it or with the arrow keys; content grows and shrinks with the text."
|
|
4130
|
-
}
|
|
4131
|
-
],
|
|
4132
|
-
"native": [
|
|
4133
|
-
"textarea"
|
|
4134
|
-
],
|
|
4135
|
-
"entries": [
|
|
4136
|
-
"@envsemble/envui/markdown"
|
|
4137
|
-
]
|
|
4138
|
-
},
|
|
4139
|
-
"Menu": {
|
|
4140
|
-
"kind": "namespace",
|
|
4141
|
-
"source": "packages/ui/src/actions/menu/Menu.tsx",
|
|
4142
|
-
"description": "",
|
|
4143
|
-
"parts": [
|
|
4144
|
-
"Menu.Root",
|
|
4145
|
-
"Menu.Header",
|
|
4146
|
-
"Menu.Item",
|
|
4147
|
-
"Menu.Separator",
|
|
4148
|
-
"Menu.Submenu",
|
|
4149
|
-
"Menu.Group",
|
|
4150
|
-
"Menu.RadioGroup",
|
|
4151
|
-
"Menu.RadioItem",
|
|
4152
|
-
"Menu.CheckboxItem"
|
|
4153
|
-
],
|
|
4154
|
-
"entries": [
|
|
4155
|
-
"@envsemble/envui"
|
|
4156
|
-
]
|
|
4157
|
-
},
|
|
4158
|
-
"Menu.CheckboxItem": {
|
|
4159
|
-
"kind": "component",
|
|
4160
|
-
"source": "packages/ui/src/actions/menu/Menu.tsx",
|
|
4161
|
-
"description": "An independent on/off option; a check mark shows while it is on.",
|
|
4162
|
-
"props": [
|
|
4163
|
-
{
|
|
4164
|
-
"name": "checked",
|
|
4165
|
-
"type": "boolean",
|
|
4166
|
-
"required": false,
|
|
4167
|
-
"description": "Whether the option is on, for an item the application controls; a check mark shows while it is."
|
|
4168
|
-
},
|
|
4169
|
-
{
|
|
4170
|
-
"name": "defaultChecked",
|
|
4171
|
-
"type": "boolean",
|
|
4172
|
-
"required": false,
|
|
4173
|
-
"default": "false",
|
|
4174
|
-
"description": "Whether an uncontrolled item starts on."
|
|
4175
|
-
},
|
|
4176
|
-
{
|
|
4177
|
-
"name": "onCheckedChange",
|
|
4178
|
-
"type": "(checked: boolean) => void",
|
|
4179
|
-
"required": false,
|
|
4180
|
-
"description": "Called with the new state when the item is toggled."
|
|
4181
|
-
},
|
|
4182
|
-
{
|
|
4183
|
-
"name": "disabled",
|
|
4184
|
-
"type": "boolean",
|
|
4185
|
-
"required": false,
|
|
4186
|
-
"default": "false",
|
|
4187
|
-
"description": "The item stays in place, dimmed, but cannot be toggled."
|
|
4188
|
-
},
|
|
4189
|
-
{
|
|
4190
|
-
"name": "closeOnClick",
|
|
4191
|
-
"type": "boolean",
|
|
4192
|
-
"required": false,
|
|
4193
|
-
"default": "false",
|
|
4194
|
-
"description": "Close the menu after toggling; off by default, so several options can change."
|
|
4293
|
+
"required": true,
|
|
4294
|
+
"description": "The item's label, which names it."
|
|
4195
4295
|
},
|
|
4196
4296
|
{
|
|
4197
|
-
"name": "
|
|
4297
|
+
"name": "textValue",
|
|
4198
4298
|
"type": "string",
|
|
4199
4299
|
"required": false,
|
|
4200
|
-
"
|
|
4201
|
-
|
|
4202
|
-
{
|
|
4203
|
-
"name": "icon",
|
|
4204
|
-
"type": "ReactNode",
|
|
4205
|
-
"required": false,
|
|
4206
|
-
"description": "A decorative icon before the label, such as Settings."
|
|
4207
|
-
},
|
|
4208
|
-
{
|
|
4209
|
-
"name": "children",
|
|
4210
|
-
"type": "ReactNode",
|
|
4211
|
-
"required": true,
|
|
4212
|
-
"description": "The item's label, which names it."
|
|
4300
|
+
"default": "children, when it is a string",
|
|
4301
|
+
"description": "The label as plain text, which typing a letter in the open menu matches, where children isn't a string, such as a label with a Badge or emphasis inside."
|
|
4213
4302
|
},
|
|
4214
4303
|
{
|
|
4215
4304
|
"name": "description",
|
|
@@ -4228,9 +4317,17 @@
|
|
|
4228
4317
|
"type": "ReactNode",
|
|
4229
4318
|
"required": false,
|
|
4230
4319
|
"description": "End content, such as a Badge or a count; it is part of the item's name."
|
|
4320
|
+
},
|
|
4321
|
+
{
|
|
4322
|
+
"name": "ref",
|
|
4323
|
+
"type": "Ref<HTMLElement>",
|
|
4324
|
+
"required": false,
|
|
4325
|
+
"description": "The item's row element."
|
|
4231
4326
|
}
|
|
4232
4327
|
],
|
|
4233
|
-
"native": [
|
|
4328
|
+
"native": [
|
|
4329
|
+
"element"
|
|
4330
|
+
],
|
|
4234
4331
|
"entries": [
|
|
4235
4332
|
"@envsemble/envui"
|
|
4236
4333
|
]
|
|
@@ -4317,10 +4414,10 @@
|
|
|
4317
4414
|
"description": "Class of the item's row."
|
|
4318
4415
|
},
|
|
4319
4416
|
{
|
|
4320
|
-
"name": "
|
|
4417
|
+
"name": "start",
|
|
4321
4418
|
"type": "ReactNode",
|
|
4322
4419
|
"required": false,
|
|
4323
|
-
"description": "
|
|
4420
|
+
"description": "Content before the label, such as the Settings icon or an Avatar in an account switcher: an envUI icon takes the icon size and other content keeps its own, and the labels of the menu's rows still line up. It is hidden from assistive technology, since the label names the item."
|
|
4324
4421
|
},
|
|
4325
4422
|
{
|
|
4326
4423
|
"name": "children",
|
|
@@ -4328,6 +4425,13 @@
|
|
|
4328
4425
|
"required": true,
|
|
4329
4426
|
"description": "The item's label, which names it."
|
|
4330
4427
|
},
|
|
4428
|
+
{
|
|
4429
|
+
"name": "textValue",
|
|
4430
|
+
"type": "string",
|
|
4431
|
+
"required": false,
|
|
4432
|
+
"default": "children, when it is a string",
|
|
4433
|
+
"description": "The label as plain text, which typing a letter in the open menu matches, where children isn't a string, such as a label with a Badge or emphasis inside."
|
|
4434
|
+
},
|
|
4331
4435
|
{
|
|
4332
4436
|
"name": "description",
|
|
4333
4437
|
"type": "ReactNode",
|
|
@@ -4346,6 +4450,18 @@
|
|
|
4346
4450
|
"required": false,
|
|
4347
4451
|
"description": "End content, such as a Badge or a count; it is part of the item's name."
|
|
4348
4452
|
},
|
|
4453
|
+
{
|
|
4454
|
+
"name": "ref",
|
|
4455
|
+
"type": "Ref<HTMLElement>",
|
|
4456
|
+
"required": false,
|
|
4457
|
+
"description": "The item's row element."
|
|
4458
|
+
},
|
|
4459
|
+
{
|
|
4460
|
+
"name": "rel",
|
|
4461
|
+
"type": "string",
|
|
4462
|
+
"required": false,
|
|
4463
|
+
"description": "The destination's relationship to the page, such as noopener, as on a native link."
|
|
4464
|
+
},
|
|
4349
4465
|
{
|
|
4350
4466
|
"name": "href",
|
|
4351
4467
|
"type": "string",
|
|
@@ -4365,10 +4481,11 @@
|
|
|
4365
4481
|
"description": "Where the destination opens, such as _blank, as on a native link."
|
|
4366
4482
|
},
|
|
4367
4483
|
{
|
|
4368
|
-
"name": "
|
|
4369
|
-
"type": "
|
|
4484
|
+
"name": "closeOnClick",
|
|
4485
|
+
"type": "boolean",
|
|
4370
4486
|
"required": false,
|
|
4371
|
-
"
|
|
4487
|
+
"default": "true",
|
|
4488
|
+
"description": "Close the menu once the action runs; false keeps it open, for an action people repeat, such as Zoom in."
|
|
4372
4489
|
}
|
|
4373
4490
|
],
|
|
4374
4491
|
"native": [
|
|
@@ -4450,7 +4567,7 @@
|
|
|
4450
4567
|
"name": "closeOnClick",
|
|
4451
4568
|
"type": "boolean",
|
|
4452
4569
|
"required": false,
|
|
4453
|
-
"default": "true",
|
|
4570
|
+
"default": "true, or the closeOnClick of the ThemeMenuRadioGroup around it",
|
|
4454
4571
|
"description": "Close the menu after choosing."
|
|
4455
4572
|
},
|
|
4456
4573
|
{
|
|
@@ -4465,6 +4582,12 @@
|
|
|
4465
4582
|
"required": true,
|
|
4466
4583
|
"description": "The item's label, which names it."
|
|
4467
4584
|
},
|
|
4585
|
+
{
|
|
4586
|
+
"name": "start",
|
|
4587
|
+
"type": "ReactNode",
|
|
4588
|
+
"required": false,
|
|
4589
|
+
"description": "Content before the label, such as the Settings icon or an Avatar in an account switcher: an envUI icon takes the icon size and other content keeps its own, and the labels of the menu's rows still line up. It is hidden from assistive technology, since the label names the item."
|
|
4590
|
+
},
|
|
4468
4591
|
{
|
|
4469
4592
|
"name": "end",
|
|
4470
4593
|
"type": "ReactNode",
|
|
@@ -4472,19 +4595,28 @@
|
|
|
4472
4595
|
"description": "End content, such as a Badge or a count; it is part of the item's name."
|
|
4473
4596
|
},
|
|
4474
4597
|
{
|
|
4475
|
-
"name": "
|
|
4476
|
-
"type": "
|
|
4598
|
+
"name": "textValue",
|
|
4599
|
+
"type": "string",
|
|
4477
4600
|
"required": false,
|
|
4478
|
-
"
|
|
4601
|
+
"default": "children, when it is a string",
|
|
4602
|
+
"description": "The label as plain text, which typing a letter in the open menu matches, where children isn't a string, such as a label with a Badge or emphasis inside."
|
|
4479
4603
|
},
|
|
4480
4604
|
{
|
|
4481
4605
|
"name": "description",
|
|
4482
4606
|
"type": "ReactNode",
|
|
4483
4607
|
"required": false,
|
|
4484
4608
|
"description": "A second, muted line; announced as the item's description."
|
|
4609
|
+
},
|
|
4610
|
+
{
|
|
4611
|
+
"name": "ref",
|
|
4612
|
+
"type": "Ref<HTMLElement>",
|
|
4613
|
+
"required": false,
|
|
4614
|
+
"description": "The item's row element."
|
|
4485
4615
|
}
|
|
4486
4616
|
],
|
|
4487
|
-
"native": [
|
|
4617
|
+
"native": [
|
|
4618
|
+
"element"
|
|
4619
|
+
],
|
|
4488
4620
|
"entries": [
|
|
4489
4621
|
"@envsemble/envui"
|
|
4490
4622
|
]
|
|
@@ -4647,10 +4779,29 @@
|
|
|
4647
4779
|
"description": "The submenu popup's inline style."
|
|
4648
4780
|
},
|
|
4649
4781
|
{
|
|
4650
|
-
"name": "
|
|
4782
|
+
"name": "triggerProps",
|
|
4783
|
+
"type": "TriggerProps",
|
|
4784
|
+
"required": false,
|
|
4785
|
+
"description": "Attributes of the row that opens the submenu, such as a className, a style, a ref or a data attribute; the submenu's own className, style and ref are its popup's."
|
|
4786
|
+
},
|
|
4787
|
+
{
|
|
4788
|
+
"name": "start",
|
|
4789
|
+
"type": "ReactNode",
|
|
4790
|
+
"required": false,
|
|
4791
|
+
"description": "Content before the label, such as the Settings icon or an Avatar in an account switcher: an envUI icon takes the icon size and other content keeps its own, and the labels of the menu's rows still line up. It is hidden from assistive technology, since the label names the item."
|
|
4792
|
+
},
|
|
4793
|
+
{
|
|
4794
|
+
"name": "end",
|
|
4651
4795
|
"type": "ReactNode",
|
|
4652
4796
|
"required": false,
|
|
4653
|
-
"description": "
|
|
4797
|
+
"description": "End content, such as a Badge or a count; it is part of the item's name."
|
|
4798
|
+
},
|
|
4799
|
+
{
|
|
4800
|
+
"name": "textValue",
|
|
4801
|
+
"type": "string",
|
|
4802
|
+
"required": false,
|
|
4803
|
+
"default": "children, when it is a string",
|
|
4804
|
+
"description": "The label as plain text, which typing a letter in the open menu matches, where children isn't a string, such as a label with a Badge or emphasis inside."
|
|
4654
4805
|
},
|
|
4655
4806
|
{
|
|
4656
4807
|
"name": "description",
|
|
@@ -4687,13 +4838,19 @@
|
|
|
4687
4838
|
"name": "label",
|
|
4688
4839
|
"type": "ReactNode",
|
|
4689
4840
|
"required": true,
|
|
4690
|
-
"description": "The trigger's text, such as File."
|
|
4841
|
+
"description": "The trigger's text, such as File, or content such as an icon beside the text."
|
|
4691
4842
|
},
|
|
4692
4843
|
{
|
|
4693
4844
|
"name": "accessKey",
|
|
4694
4845
|
"type": "string",
|
|
4695
4846
|
"required": false,
|
|
4696
|
-
"description": "A letter of the label, such as F for File. With Menubar.Root's accessKeys, holding Alt underlines it and Alt with the letter opens the menu."
|
|
4847
|
+
"description": "A letter of the label, such as F for File. With Menubar.Root's accessKeys, holding Alt underlines it, in the label's text also beside an icon or inside an element such as a span, and Alt with the letter opens the menu."
|
|
4848
|
+
},
|
|
4849
|
+
{
|
|
4850
|
+
"name": "triggerProps",
|
|
4851
|
+
"type": "TriggerProps",
|
|
4852
|
+
"required": false,
|
|
4853
|
+
"description": "Attributes of the trigger button, such as a className, a style, a ref or a data attribute; the menu's own className, style and ref are its popup's."
|
|
4697
4854
|
},
|
|
4698
4855
|
{
|
|
4699
4856
|
"name": "children",
|
|
@@ -4729,7 +4886,7 @@
|
|
|
4729
4886
|
},
|
|
4730
4887
|
{
|
|
4731
4888
|
"name": "onOpenChange",
|
|
4732
|
-
"type": "(open: boolean, details:
|
|
4889
|
+
"type": "(open: boolean, details: OpenChangeDetails) => void",
|
|
4733
4890
|
"required": false,
|
|
4734
4891
|
"description": "Called when the menu opens or closes, with the element that had focus before the menubar took it."
|
|
4735
4892
|
},
|
|
@@ -4811,9 +4968,15 @@
|
|
|
4811
4968
|
},
|
|
4812
4969
|
{
|
|
4813
4970
|
"name": "author",
|
|
4814
|
-
"type": "
|
|
4971
|
+
"type": "ReactNode",
|
|
4972
|
+
"required": false,
|
|
4973
|
+
"description": "Who wrote the message, such as a name, shown above it at weight 500, or content such as a link to their profile with a Bot or Owner Badge. Leave it out where the conversation makes it clear, such as on your own messages in a conversation with one person."
|
|
4974
|
+
},
|
|
4975
|
+
{
|
|
4976
|
+
"name": "start",
|
|
4977
|
+
"type": "ReactNode",
|
|
4815
4978
|
"required": false,
|
|
4816
|
-
"description": "
|
|
4979
|
+
"description": "Content beside the message, at its inline start, placed as given, such as the author's Avatar or an assistant's mark, in a column of its own beside the header and the content."
|
|
4817
4980
|
},
|
|
4818
4981
|
{
|
|
4819
4982
|
"name": "meta",
|
|
@@ -4829,22 +4992,22 @@
|
|
|
4829
4992
|
},
|
|
4830
4993
|
{
|
|
4831
4994
|
"name": "status",
|
|
4832
|
-
"type": "'sending' | 'failed'",
|
|
4995
|
+
"type": "'sending' | 'failed' | 'working'",
|
|
4833
4996
|
"required": false,
|
|
4834
|
-
"description": "A message on its way, sending, with a spinner and Sending;
|
|
4997
|
+
"description": "A message on its way, sending, with a spinner and Sending; one that could not be sent, failed, with an error icon and Not sent in the danger tone and, on your own message, a red outline around the bubble; or a reply still being written, working, with a spinner and Working, such as an agent's while it runs, last in a MessageList with aria-busy. Without it the message is sent."
|
|
4835
4998
|
},
|
|
4836
4999
|
{
|
|
4837
5000
|
"name": "statusLabel",
|
|
4838
|
-
"type": "
|
|
5001
|
+
"type": "ReactNode",
|
|
4839
5002
|
"required": false,
|
|
4840
|
-
"default": "'Sending'
|
|
4841
|
-
"description": "The
|
|
5003
|
+
"default": "'Sending', 'Not sent' or 'Working'",
|
|
5004
|
+
"description": "The content beside the status icon, such as \"Could not deliver\", a sentence with a Try again link or the step a reply is on, Running tests…. It overrides EnvUIProvider's `messages.message.sending`, `.failed` and `.working`."
|
|
4842
5005
|
},
|
|
4843
5006
|
{
|
|
4844
5007
|
"name": "children",
|
|
4845
5008
|
"type": "ReactNode",
|
|
4846
|
-
"required":
|
|
4847
|
-
"description": "The message. Plain text keeps its line breaks; formatted content, such as Markdown, fills the width of a message from someone else."
|
|
5009
|
+
"required": false,
|
|
5010
|
+
"description": "The message. Plain text keeps its line breaks; formatted content, such as Markdown, fills the width of a message from someone else. A working message shows the reply streamed so far, or only its status while it is empty."
|
|
4848
5011
|
},
|
|
4849
5012
|
{
|
|
4850
5013
|
"name": "skeleton",
|
|
@@ -4864,28 +5027,8 @@
|
|
|
4864
5027
|
"MessageList": {
|
|
4865
5028
|
"kind": "component",
|
|
4866
5029
|
"source": "packages/ui/src/content/Message.tsx",
|
|
4867
|
-
"description": "The messages of a conversation in order, as a log: assistive technology politely announces messages added anywhere in it and text that changes.
|
|
5030
|
+
"description": "The messages of a conversation in order, as a log: assistive technology politely announces messages added anywhere in it and text that changes. While a reply is on its way or streams in, set aria-busy, so assistive technology waits for it to finish instead of announcing every step, and show it as a Message with status working, last. Set follow where the list scrolls by itself. Name it with aria-label or aria-labelledby.",
|
|
4868
5031
|
"props": [
|
|
4869
|
-
{
|
|
4870
|
-
"name": "busy",
|
|
4871
|
-
"type": "boolean",
|
|
4872
|
-
"required": false,
|
|
4873
|
-
"default": "false",
|
|
4874
|
-
"description": "A reply is on its way or streaming in: after the last message, where the reply will show, a row with the busy author, a quiet spinner and Working in the muted color; and the log reports aria-busy, so assistive technology can wait for the reply to finish instead of announcing every step."
|
|
4875
|
-
},
|
|
4876
|
-
{
|
|
4877
|
-
"name": "busyAuthor",
|
|
4878
|
-
"type": "string",
|
|
4879
|
-
"required": false,
|
|
4880
|
-
"description": "Who the reply on its way comes from, such as Agent, named on the busy row as a message's author."
|
|
4881
|
-
},
|
|
4882
|
-
{
|
|
4883
|
-
"name": "busyLabel",
|
|
4884
|
-
"type": "string",
|
|
4885
|
-
"required": false,
|
|
4886
|
-
"default": "'Working'",
|
|
4887
|
-
"description": "The text beside the busy spinner, such as \"Thinking\". It overrides EnvUIProvider's `messages.message.working`."
|
|
4888
|
-
},
|
|
4889
5032
|
{
|
|
4890
5033
|
"name": "follow",
|
|
4891
5034
|
"type": "boolean",
|
|
@@ -4919,11 +5062,18 @@
|
|
|
4919
5062
|
"required": true,
|
|
4920
5063
|
"description": "The measurement, between min and max. A value outside the range shows, and is reported, as the nearest end."
|
|
4921
5064
|
},
|
|
5065
|
+
{
|
|
5066
|
+
"name": "layout",
|
|
5067
|
+
"type": "'stacked' | 'inline'",
|
|
5068
|
+
"required": false,
|
|
5069
|
+
"default": "'stacked'",
|
|
5070
|
+
"description": "stacked puts the label and the value on a row above the bar; inline puts the label, the bar and the value on one line, as in a table's usage column or a list row."
|
|
5071
|
+
},
|
|
4922
5072
|
{
|
|
4923
5073
|
"name": "label",
|
|
4924
5074
|
"type": "ReactNode",
|
|
4925
|
-
"required":
|
|
4926
|
-
"description": "What the bar shows, such as Seats assigned; it
|
|
5075
|
+
"required": false,
|
|
5076
|
+
"description": "What the bar shows, such as Seats assigned; it shows with the bar and names it. Leave it out for a bare bar named with aria-label or aria-labelledby, such as by the name beside it in a row; without a label or valueText the bar has no row above it."
|
|
4927
5077
|
},
|
|
4928
5078
|
{
|
|
4929
5079
|
"name": "min",
|
|
@@ -4964,6 +5114,12 @@
|
|
|
4964
5114
|
"source": "packages/ui/src/forms/MonthPicker.tsx",
|
|
4965
5115
|
"description": "A field for a month of a year that shows the value in the reader's locale and opens a year of months to choose it from, with keyboard access like Calendar's.",
|
|
4966
5116
|
"props": [
|
|
5117
|
+
{
|
|
5118
|
+
"name": "onOpenChange",
|
|
5119
|
+
"type": "(open: boolean, details: MonthPickerOpenChangeDetails) => void",
|
|
5120
|
+
"required": false,
|
|
5121
|
+
"description": "Called with the new state, and why, when the popup opens or closes."
|
|
5122
|
+
},
|
|
4967
5123
|
{
|
|
4968
5124
|
"name": "value",
|
|
4969
5125
|
"type": "string | null",
|
|
@@ -5100,10 +5256,16 @@
|
|
|
5100
5256
|
"description": "Whether an uncontrolled popup starts open; closed by default."
|
|
5101
5257
|
},
|
|
5102
5258
|
{
|
|
5103
|
-
"name": "
|
|
5104
|
-
"type": "
|
|
5259
|
+
"name": "popupHeader",
|
|
5260
|
+
"type": "ReactNode",
|
|
5105
5261
|
"required": false,
|
|
5106
|
-
"description": "
|
|
5262
|
+
"description": "Content at the top of the popup, above the calendar or the list, such as presets: buttons for Tomorrow or Next Monday that set the value, from a field the application controls."
|
|
5263
|
+
},
|
|
5264
|
+
{
|
|
5265
|
+
"name": "popupFooter",
|
|
5266
|
+
"type": "ReactNode",
|
|
5267
|
+
"required": false,
|
|
5268
|
+
"description": "Content in the popup's footer, after its shortcut to the current date or time and before Clear, such as a note of the time zone or another action."
|
|
5107
5269
|
},
|
|
5108
5270
|
{
|
|
5109
5271
|
"name": "label",
|
|
@@ -5162,6 +5324,13 @@
|
|
|
5162
5324
|
"default": "'default'",
|
|
5163
5325
|
"description": "The bar's background, named as Surface's and Card's: default, the default surface color, the app frame's own fill that stands apart from the page; page, the page's background, the same as the content beside it, from which a Scaffold sets it apart with a hairline. On a surface, such as a Sheet, both take the surface's color."
|
|
5164
5326
|
},
|
|
5327
|
+
{
|
|
5328
|
+
"name": "visibleLabel",
|
|
5329
|
+
"type": "boolean",
|
|
5330
|
+
"required": false,
|
|
5331
|
+
"default": "true",
|
|
5332
|
+
"description": "Whether the destinations' labels show under their icons. False shows the icons only, for an icon-only bar such as a code editor's activity bar: each label still names its destination and shows in a tooltip on hover and keyboard focus."
|
|
5333
|
+
},
|
|
5165
5334
|
{
|
|
5166
5335
|
"name": "aria-label",
|
|
5167
5336
|
"type": "string",
|
|
@@ -5226,6 +5395,12 @@
|
|
|
5226
5395
|
"required": false,
|
|
5227
5396
|
"description": "Content below the destinations, at the bottom of the drawer, such as the account's menu."
|
|
5228
5397
|
},
|
|
5398
|
+
{
|
|
5399
|
+
"name": "groupEnd",
|
|
5400
|
+
"type": "(group: string) => ReactNode",
|
|
5401
|
+
"required": false,
|
|
5402
|
+
"description": "Content after a group's heading, outside it, such as an IconButton that adds a project to Projects, a Menu of the group's actions or a count. It keeps its size, and the heading gives way to it."
|
|
5403
|
+
},
|
|
5229
5404
|
{
|
|
5230
5405
|
"name": "headingLevel",
|
|
5231
5406
|
"type": "Exclude<HeadingLevel, 1>",
|
|
@@ -5340,9 +5515,16 @@
|
|
|
5340
5515
|
"description": "The rail's background, named as Surface's and Card's: default, the default surface color, the app frame's own fill that stands apart from the page; page, the page's background, the same as the content beside it, from which a Scaffold sets it apart with a hairline. On a surface, such as a Sheet, both take the surface's color."
|
|
5341
5516
|
},
|
|
5342
5517
|
{
|
|
5343
|
-
"name": "
|
|
5344
|
-
"type": "
|
|
5345
|
-
"required": false,
|
|
5518
|
+
"name": "visibleLabel",
|
|
5519
|
+
"type": "boolean",
|
|
5520
|
+
"required": false,
|
|
5521
|
+
"default": "true",
|
|
5522
|
+
"description": "Whether the destinations' labels show under their icons. False shows the icons only, for an icon-only rail such as a code editor's activity bar: each label still names its destination and shows in a tooltip on hover and keyboard focus."
|
|
5523
|
+
},
|
|
5524
|
+
{
|
|
5525
|
+
"name": "aria-label",
|
|
5526
|
+
"type": "string",
|
|
5527
|
+
"required": false,
|
|
5346
5528
|
"default": "messages.navigation.label, Main",
|
|
5347
5529
|
"description": "Names the navigation landmark, such as Main or Project; give each landmark of a page its own."
|
|
5348
5530
|
},
|
|
@@ -5390,7 +5572,7 @@
|
|
|
5390
5572
|
"name": "name",
|
|
5391
5573
|
"type": "string",
|
|
5392
5574
|
"required": false,
|
|
5393
|
-
"description": "A name for this node, such as \"settings\",
|
|
5575
|
+
"description": "A name for this node, such as \"settings\", for the application's styles and tests to find it by; it renders as `data-env-name`."
|
|
5394
5576
|
},
|
|
5395
5577
|
{
|
|
5396
5578
|
"name": "render",
|
|
@@ -5486,6 +5668,12 @@
|
|
|
5486
5668
|
"required": false,
|
|
5487
5669
|
"default": "true",
|
|
5488
5670
|
"description": "In a Scaffold, moves focus to the title of a level 1 header when the page changes: as a new page's header mounts after the Scaffold first showed, not as a title changes. People using a screen reader then hear the new page, and the next Tab starts from it. Focus moved there shows no ring, and focus in a field or an open overlay stays where it is. False leaves focus to the application."
|
|
5671
|
+
},
|
|
5672
|
+
{
|
|
5673
|
+
"name": "children",
|
|
5674
|
+
"type": "ReactNode",
|
|
5675
|
+
"required": false,
|
|
5676
|
+
"description": "More rows under the toolbar, placed as given, such as a progress strip or an inline Alert. They stay in the header, so they stick with it."
|
|
5489
5677
|
}
|
|
5490
5678
|
],
|
|
5491
5679
|
"native": [
|
|
@@ -5511,7 +5699,7 @@
|
|
|
5511
5699
|
"Pager.Next": {
|
|
5512
5700
|
"kind": "component",
|
|
5513
5701
|
"source": "packages/ui/src/navigation/Pager.tsx",
|
|
5514
|
-
"description": "The destination after this one: a native link with rel=\"next\", its title under the label Up next (EnvUIProvider's messages.pager.next), and
|
|
5702
|
+
"description": "The destination after this one: a native link with rel=\"next\", its title under the label Up next (EnvUIProvider's messages.pager.next), and optional content after them, its end. It also stands alone, outside Pager.Root.",
|
|
5515
5703
|
"props": [
|
|
5516
5704
|
{
|
|
5517
5705
|
"name": "href",
|
|
@@ -5525,18 +5713,25 @@
|
|
|
5525
5713
|
"required": true,
|
|
5526
5714
|
"description": "The destination's title, such as the name of the next page. It shows below the direction label, wraps between words, and names the link after the label."
|
|
5527
5715
|
},
|
|
5528
|
-
{
|
|
5529
|
-
"name": "icon",
|
|
5530
|
-
"type": "ReactNode",
|
|
5531
|
-
"required": false,
|
|
5532
|
-
"description": "A decorative icon, such as ArrowBack, before the previous destination's text, or such as ArrowForward, after the next one's; none by default."
|
|
5533
|
-
},
|
|
5534
5716
|
{
|
|
5535
5717
|
"name": "rel",
|
|
5536
5718
|
"type": "string",
|
|
5537
5719
|
"required": false,
|
|
5538
5720
|
"default": "'prev' on Pager.Previous, 'next' on Pager.Next",
|
|
5539
5721
|
"description": "The link's relation to this page."
|
|
5722
|
+
},
|
|
5723
|
+
{
|
|
5724
|
+
"name": "label",
|
|
5725
|
+
"type": "ReactNode",
|
|
5726
|
+
"required": false,
|
|
5727
|
+
"default": "'Previous' or 'Up next', or EnvUIProvider's messages.pager.previous or next",
|
|
5728
|
+
"description": "The direction label above the title, such as Previous chapter or Back to setup, for this link alone; null leaves it out."
|
|
5729
|
+
},
|
|
5730
|
+
{
|
|
5731
|
+
"name": "end",
|
|
5732
|
+
"type": "ReactNode",
|
|
5733
|
+
"required": false,
|
|
5734
|
+
"description": "Content after the text, such as IconArrowForward: an envUI icon takes the pager's icon size and other content keeps its own. It is hidden from assistive technology; none by default."
|
|
5540
5735
|
}
|
|
5541
5736
|
],
|
|
5542
5737
|
"native": [
|
|
@@ -5549,7 +5744,7 @@
|
|
|
5549
5744
|
"Pager.Previous": {
|
|
5550
5745
|
"kind": "component",
|
|
5551
5746
|
"source": "packages/ui/src/navigation/Pager.tsx",
|
|
5552
|
-
"description": "The destination before this one: a native link with rel=\"prev\", its title under the label Previous (EnvUIProvider's messages.pager.previous), and
|
|
5747
|
+
"description": "The destination before this one: a native link with rel=\"prev\", its title under the label Previous (EnvUIProvider's messages.pager.previous), and optional content before them, its start. It also stands alone, outside Pager.Root.",
|
|
5553
5748
|
"props": [
|
|
5554
5749
|
{
|
|
5555
5750
|
"name": "href",
|
|
@@ -5563,18 +5758,25 @@
|
|
|
5563
5758
|
"required": true,
|
|
5564
5759
|
"description": "The destination's title, such as the name of the next page. It shows below the direction label, wraps between words, and names the link after the label."
|
|
5565
5760
|
},
|
|
5566
|
-
{
|
|
5567
|
-
"name": "icon",
|
|
5568
|
-
"type": "ReactNode",
|
|
5569
|
-
"required": false,
|
|
5570
|
-
"description": "A decorative icon, such as ArrowBack, before the previous destination's text, or such as ArrowForward, after the next one's; none by default."
|
|
5571
|
-
},
|
|
5572
5761
|
{
|
|
5573
5762
|
"name": "rel",
|
|
5574
5763
|
"type": "string",
|
|
5575
5764
|
"required": false,
|
|
5576
5765
|
"default": "'prev' on Pager.Previous, 'next' on Pager.Next",
|
|
5577
5766
|
"description": "The link's relation to this page."
|
|
5767
|
+
},
|
|
5768
|
+
{
|
|
5769
|
+
"name": "label",
|
|
5770
|
+
"type": "ReactNode",
|
|
5771
|
+
"required": false,
|
|
5772
|
+
"default": "'Previous' or 'Up next', or EnvUIProvider's messages.pager.previous or next",
|
|
5773
|
+
"description": "The direction label above the title, such as Previous chapter or Back to setup, for this link alone; null leaves it out."
|
|
5774
|
+
},
|
|
5775
|
+
{
|
|
5776
|
+
"name": "start",
|
|
5777
|
+
"type": "ReactNode",
|
|
5778
|
+
"required": false,
|
|
5779
|
+
"description": "Content before the text, such as IconArrowBack: an envUI icon takes the pager's icon size and other content keeps its own. It is hidden from assistive technology; none by default."
|
|
5578
5780
|
}
|
|
5579
5781
|
],
|
|
5580
5782
|
"native": [
|
|
@@ -5587,7 +5789,7 @@
|
|
|
5587
5789
|
"Pager.Root": {
|
|
5588
5790
|
"kind": "component",
|
|
5589
5791
|
"source": "packages/ui/src/navigation/Pager.tsx",
|
|
5590
|
-
"description": "A centered pair of previous and next destinations in a navigation landmark, its Pager.Previous and Pager.Next children; either one can be left out, and without any it renders nothing.",
|
|
5792
|
+
"description": "A centered pair of previous and next destinations in a navigation landmark, its Pager.Previous and Pager.Next children; either one can be left out, and without any it renders nothing. Where the two don't fit side by side, they stack as rows of the pager's width, the previous first.",
|
|
5591
5793
|
"props": [
|
|
5592
5794
|
{
|
|
5593
5795
|
"name": "children",
|
|
@@ -5640,12 +5842,6 @@
|
|
|
5640
5842
|
"default": "true",
|
|
5641
5843
|
"description": "Whether a later page exists, for a list without total, such as from a cursor's has more."
|
|
5642
5844
|
},
|
|
5643
|
-
{
|
|
5644
|
-
"name": "onPageChange",
|
|
5645
|
-
"type": "(page: number) => void",
|
|
5646
|
-
"required": true,
|
|
5647
|
-
"description": "Receives the page before or after the current one when its button is pressed. The application loads that page and passes it back as page."
|
|
5648
|
-
},
|
|
5649
5845
|
{
|
|
5650
5846
|
"name": "pending",
|
|
5651
5847
|
"type": "boolean",
|
|
@@ -5661,11 +5857,11 @@
|
|
|
5661
5857
|
"description": "Render nothing while every item fits on one page, so neither button has anywhere to go."
|
|
5662
5858
|
},
|
|
5663
5859
|
{
|
|
5664
|
-
"name": "
|
|
5860
|
+
"name": "renderRange",
|
|
5665
5861
|
"type": "(range: PaginationRange) => ReactNode",
|
|
5666
5862
|
"required": false,
|
|
5667
5863
|
"default": "1–60 of 245, or 61–120 without total, with numbers in the locale",
|
|
5668
|
-
"description": "
|
|
5864
|
+
"description": "Draws the range from the first and last item shown, the total, the page and the page count, for one pager; EnvUIProvider's messages.pagination.range writes it for every pager."
|
|
5669
5865
|
},
|
|
5670
5866
|
{
|
|
5671
5867
|
"name": "previousLabel",
|
|
@@ -5700,6 +5896,20 @@
|
|
|
5700
5896
|
"required": false,
|
|
5701
5897
|
"default": "'Pagination', or EnvUIProvider's messages.pagination.label",
|
|
5702
5898
|
"description": "The navigation landmark's name, such as Report pages, where a page has more than one."
|
|
5899
|
+
},
|
|
5900
|
+
{
|
|
5901
|
+
"name": "onPageChange",
|
|
5902
|
+
"type": "(page: number) => void",
|
|
5903
|
+
"required": false,
|
|
5904
|
+
"requiredWhen": "`pageHref` is not set",
|
|
5905
|
+
"description": "Receives the page before or after the current one when its button is pressed. The application loads that page and passes it back as page. Give it, or pageHref, or both."
|
|
5906
|
+
},
|
|
5907
|
+
{
|
|
5908
|
+
"name": "pageHref",
|
|
5909
|
+
"type": "(page: number) => string",
|
|
5910
|
+
"required": false,
|
|
5911
|
+
"requiredWhen": "`onPageChange` is not set",
|
|
5912
|
+
"description": "The address of a page, such as `?page=3`, for a list whose pages have their own URLs: the previous and next controls are then links, through the LinkProvider's link component, which open in a new tab, are crawlable and work before hydration. A control with no page to go to reports aria-disabled and has no destination."
|
|
5703
5913
|
}
|
|
5704
5914
|
],
|
|
5705
5915
|
"native": [
|
|
@@ -5783,7 +5993,7 @@
|
|
|
5783
5993
|
"Panes.Root": {
|
|
5784
5994
|
"kind": "component",
|
|
5785
5995
|
"source": "packages/ui/src/layout/Panes.tsx",
|
|
5786
|
-
"description": "A region split into two panes side by side, such as a list and its detail: one pane has a width of its own, which a Panes.ResizeHandle between them resizes, and the other takes the rest. Each pane's content scrolls on its own under its header when Panes has a height. With `stackBelow` the panes stack in a narrow region. Panes fill their region with square corners; an application rounds them with its own class, and the panes follow, since the root clips them.",
|
|
5996
|
+
"description": "A region split into two panes side by side, such as a list and its detail: one pane has a width of its own, which a Panes.ResizeHandle between them resizes, and the other takes the rest. Each pane's content scrolls on its own under its header when Panes has a height. With `stackBelow` the panes stack in a narrow region. A pane the application renders alone, such as the list while no item is open, fills the region and the handle hides. Panes fill their region with square corners; an application rounds them with its own class, and the panes follow, since the root clips them.",
|
|
5787
5997
|
"props": [
|
|
5788
5998
|
{
|
|
5789
5999
|
"name": "sized",
|
|
@@ -5809,7 +6019,7 @@
|
|
|
5809
6019
|
"type": "number",
|
|
5810
6020
|
"required": false,
|
|
5811
6021
|
"default": "22.5",
|
|
5812
|
-
"description": "The sized pane's width in rem until people choose one with Panes.ResizeHandle,
|
|
6022
|
+
"description": "The sized pane's width in rem until people choose one with Panes.ResizeHandle, and the width a double click on the handle returns it to. To keep the width people choose, store what onWidthChange receives and pass it back here."
|
|
5813
6023
|
},
|
|
5814
6024
|
{
|
|
5815
6025
|
"name": "onWidthChange",
|
|
@@ -5831,23 +6041,11 @@
|
|
|
5831
6041
|
"default": "40",
|
|
5832
6042
|
"description": "The sized pane's largest width, in rem. It never leaves the other pane less than 16 rem."
|
|
5833
6043
|
},
|
|
5834
|
-
{
|
|
5835
|
-
"name": "persist",
|
|
5836
|
-
"type": "string",
|
|
5837
|
-
"required": false,
|
|
5838
|
-
"description": "Keeps the width people choose in a cookie of this name, for Panes the application doesn't control; a double click on the handle forgets it and returns to `defaultWidth`. Read it on the server with `readPanesWidth(cookieHeader, key)` and pass it as `persistedWidth`, so the server's markup has it and nothing moves as the page hydrates. Without that, the kept width applies after the first render."
|
|
5839
|
-
},
|
|
5840
|
-
{
|
|
5841
|
-
"name": "persistedWidth",
|
|
5842
|
-
"type": "number",
|
|
5843
|
-
"required": false,
|
|
5844
|
-
"description": "The width kept under `persist`, in rem, as the server read it from the request's cookies with `readPanesWidth`: the first render uses it, on the server and in the browser alike."
|
|
5845
|
-
},
|
|
5846
6044
|
{
|
|
5847
6045
|
"name": "name",
|
|
5848
6046
|
"type": "string",
|
|
5849
6047
|
"required": false,
|
|
5850
|
-
"description": "A name for this node, such as \"inbox\",
|
|
6048
|
+
"description": "A name for this node, such as \"inbox\", for the application's styles and tests to find it by; it renders as `data-env-name`."
|
|
5851
6049
|
},
|
|
5852
6050
|
{
|
|
5853
6051
|
"name": "children",
|
|
@@ -5871,8 +6069,15 @@
|
|
|
5871
6069
|
{
|
|
5872
6070
|
"name": "trigger",
|
|
5873
6071
|
"type": "ReactElement",
|
|
5874
|
-
"required":
|
|
5875
|
-
"description": "The control that opens and closes the popover, such as a Button or an IconButton. It must take a ref and props: it receives the press handler, aria-haspopup and aria-expanded."
|
|
6072
|
+
"required": false,
|
|
6073
|
+
"description": "The control that opens and closes the popover, such as a Button or an IconButton. It must take a ref and props: it receives the press handler, aria-haspopup and aria-expanded. Leave it out for a popover the application opens with open, beside its anchor."
|
|
6074
|
+
},
|
|
6075
|
+
{
|
|
6076
|
+
"name": "anchor",
|
|
6077
|
+
"type": "PopoverAnchor",
|
|
6078
|
+
"required": false,
|
|
6079
|
+
"default": "the trigger",
|
|
6080
|
+
"description": "What the popover opens beside where that isn't its trigger, such as a table cell, a word in the text or a range of selected text: an element, its ref, or a virtual element with a getBoundingClientRect."
|
|
5876
6081
|
},
|
|
5877
6082
|
{
|
|
5878
6083
|
"name": "title",
|
|
@@ -5997,8 +6202,8 @@
|
|
|
5997
6202
|
{
|
|
5998
6203
|
"name": "label",
|
|
5999
6204
|
"type": "ReactNode",
|
|
6000
|
-
"required":
|
|
6001
|
-
"description": "What the bar shows, such as Seats assigned; it
|
|
6205
|
+
"required": false,
|
|
6206
|
+
"description": "What the bar shows, such as Seats assigned; it shows with the bar and names it. Leave it out for a bare bar named with aria-label or aria-labelledby, such as by the name beside it in a row; without a label or valueText the bar has no row above it."
|
|
6002
6207
|
},
|
|
6003
6208
|
{
|
|
6004
6209
|
"name": "min",
|
|
@@ -6066,14 +6271,21 @@
|
|
|
6066
6271
|
{
|
|
6067
6272
|
"name": "label",
|
|
6068
6273
|
"type": "ReactNode",
|
|
6069
|
-
"required":
|
|
6070
|
-
"description": "The option's visible name, such as Private; pressing it chooses the option."
|
|
6274
|
+
"required": false,
|
|
6275
|
+
"description": "The option's visible name, such as Private; pressing it chooses the option. Without it, a List.Item whose control it is names it, such as a plan's row with its price and features, or name it with aria-label or aria-labelledby, such as a radio in a table's cell."
|
|
6071
6276
|
},
|
|
6072
6277
|
{
|
|
6073
6278
|
"name": "description",
|
|
6074
6279
|
"type": "ReactNode",
|
|
6075
6280
|
"required": false,
|
|
6076
6281
|
"description": "A short, muted line under the label that helps people choose, such as Only the people you invite. It is part of the option's label, so it is read with its name."
|
|
6282
|
+
},
|
|
6283
|
+
{
|
|
6284
|
+
"name": "labelPlacement",
|
|
6285
|
+
"type": "'end' | 'start'",
|
|
6286
|
+
"required": false,
|
|
6287
|
+
"default": "'end'",
|
|
6288
|
+
"description": "Where the label sits beside the radio: end, after it, or start, before it, such as in an inline row whose label leads; the native label still names the radio."
|
|
6077
6289
|
}
|
|
6078
6290
|
],
|
|
6079
6291
|
"native": [
|
|
@@ -6098,7 +6310,7 @@
|
|
|
6098
6310
|
"name": "label",
|
|
6099
6311
|
"type": "ReactNode",
|
|
6100
6312
|
"required": false,
|
|
6101
|
-
"description": "The group's visible name, such as Visibility, as the fieldset's legend above the options. It names the group for assistive technology. Without it, name it with aria-label or aria-labelledby."
|
|
6313
|
+
"description": "The group's visible name, such as Visibility, as the fieldset's legend above the options. It names the group for assistive technology. Without it, a List.Item whose control it is names it, or name it with aria-label or aria-labelledby."
|
|
6102
6314
|
},
|
|
6103
6315
|
{
|
|
6104
6316
|
"name": "value",
|
|
@@ -6165,46 +6377,6 @@
|
|
|
6165
6377
|
"@envsemble/envui"
|
|
6166
6378
|
]
|
|
6167
6379
|
},
|
|
6168
|
-
"Rating": {
|
|
6169
|
-
"kind": "component",
|
|
6170
|
-
"source": "packages/ui/src/data-display/Rating.tsx",
|
|
6171
|
-
"description": "A read-only rating, such as a review score: stars filled to the value in half steps in their own gold, with an optional number before them, named once for assistive technology as an image, such as \"4.5 out of 5 stars\". It shows a rating; it does not ask for one.",
|
|
6172
|
-
"props": [
|
|
6173
|
-
{
|
|
6174
|
-
"name": "value",
|
|
6175
|
-
"type": "number",
|
|
6176
|
-
"required": true,
|
|
6177
|
-
"description": "The rating, from 0 to max, such as 4.5. It shows rounded to the nearest half star, kept within 0 and max; a value that is not a number, such as NaN, shows no stars filled."
|
|
6178
|
-
},
|
|
6179
|
-
{
|
|
6180
|
-
"name": "max",
|
|
6181
|
-
"type": "number",
|
|
6182
|
-
"required": false,
|
|
6183
|
-
"default": "5",
|
|
6184
|
-
"description": "How many stars the scale has, as a whole number, such as 10. A fraction rounds to the nearest whole star; a value below 1 or not a number shows 5 stars."
|
|
6185
|
-
},
|
|
6186
|
-
{
|
|
6187
|
-
"name": "showValue",
|
|
6188
|
-
"type": "boolean",
|
|
6189
|
-
"required": false,
|
|
6190
|
-
"default": "false",
|
|
6191
|
-
"description": "Shows the rating as a number before the stars, such as 4.5, in tabular digits and the locale's number format, such as 4,5 in German. The number is the rounded value the stars show, and it is hidden from assistive technology, since the stars' name already says it."
|
|
6192
|
-
},
|
|
6193
|
-
{
|
|
6194
|
-
"name": "formatLabel",
|
|
6195
|
-
"type": "(value: number, max: number) => string",
|
|
6196
|
-
"required": false,
|
|
6197
|
-
"default": "'{value} out of {max} stars'",
|
|
6198
|
-
"description": "Writes the accessible name of the stars from the shown value, rounded to a half star, and the number of stars. It overrides EnvUIProvider's `messages.rating.label`, which receives both as text in the locale's number format."
|
|
6199
|
-
}
|
|
6200
|
-
],
|
|
6201
|
-
"native": [
|
|
6202
|
-
"span"
|
|
6203
|
-
],
|
|
6204
|
-
"entries": [
|
|
6205
|
-
"@envsemble/envui"
|
|
6206
|
-
]
|
|
6207
|
-
},
|
|
6208
6380
|
"RelativeTime": {
|
|
6209
6381
|
"kind": "component",
|
|
6210
6382
|
"source": "packages/ui/src/data-display/RelativeTime.tsx",
|
|
@@ -6229,6 +6401,12 @@
|
|
|
6229
6401
|
"default": "true",
|
|
6230
6402
|
"description": "Show the date and time in a tooltip on hover, such as \"Oct 14, 2026, 9:41 AM\", in the reader's time zone and the locale. Turn it off where the exact moment shows nearby. Inside an application's own Tooltip, that one describes the time instead."
|
|
6231
6403
|
},
|
|
6404
|
+
{
|
|
6405
|
+
"name": "renderTooltip",
|
|
6406
|
+
"type": "(date: Date) => ReactNode",
|
|
6407
|
+
"required": false,
|
|
6408
|
+
"description": "The tooltip's content from the moment, such as the time with its time zone, in UTC, or \"Edited by Alex Morgan at 9:41\"; the date and time in the locale by default."
|
|
6409
|
+
},
|
|
6232
6410
|
{
|
|
6233
6411
|
"name": "locale",
|
|
6234
6412
|
"type": "string | readonly string[]",
|
|
@@ -6266,318 +6444,100 @@
|
|
|
6266
6444
|
{
|
|
6267
6445
|
"name": "axis",
|
|
6268
6446
|
"type": "'inline' | 'block'",
|
|
6269
|
-
"required": true,
|
|
6270
|
-
"description": "The axis the handle moves along: inline, across a row of panes, such as a sidebar's edge, or block, up and down, such as a docked panel's top edge."
|
|
6271
|
-
},
|
|
6272
|
-
{
|
|
6273
|
-
"name": "value",
|
|
6274
|
-
"type": "number",
|
|
6275
|
-
"required": true,
|
|
6276
|
-
"description": "The size the handle controls, in `unit`."
|
|
6277
|
-
},
|
|
6278
|
-
{
|
|
6279
|
-
"name": "min",
|
|
6280
|
-
"type": "number",
|
|
6281
|
-
"required": true,
|
|
6282
|
-
"description": "The smallest size."
|
|
6283
|
-
},
|
|
6284
|
-
{
|
|
6285
|
-
"name": "max",
|
|
6286
|
-
"type": "number",
|
|
6287
|
-
"required": true,
|
|
6288
|
-
"description": "The largest size."
|
|
6289
|
-
},
|
|
6290
|
-
{
|
|
6291
|
-
"name": "room",
|
|
6292
|
-
"type": "(handle: HTMLElement) => number",
|
|
6293
|
-
"required": false,
|
|
6294
|
-
"description": "The largest size the room allows, in `unit`, read from the handle as a drag starts or a key moves it: where it is under `max`, the drag starts at it and goes no further."
|
|
6295
|
-
},
|
|
6296
|
-
{
|
|
6297
|
-
"name": "step",
|
|
6298
|
-
"type": "number",
|
|
6299
|
-
"required": false,
|
|
6300
|
-
"description": "How far an arrow key moves it; 10 by default."
|
|
6301
|
-
},
|
|
6302
|
-
{
|
|
6303
|
-
"name": "largeStep",
|
|
6304
|
-
"type": "number",
|
|
6305
|
-
"required": false,
|
|
6306
|
-
"description": "How far Page Up and Page Down, and an arrow key with Shift, move it; ten steps by default."
|
|
6307
|
-
},
|
|
6308
|
-
{
|
|
6309
|
-
"name": "unit",
|
|
6310
|
-
"type": "'px' | '%' | 'rem'",
|
|
6311
|
-
"required": false,
|
|
6312
|
-
"description": "The size's unit: px, % of `percentOf`, or rem, of the root's font size."
|
|
6313
|
-
},
|
|
6314
|
-
{
|
|
6315
|
-
"name": "percentOf",
|
|
6316
|
-
"type": "(handle: HTMLElement) => HTMLElement | null",
|
|
6317
|
-
"required": false,
|
|
6318
|
-
"description": "The element a size in % is a share of, such as a column's table: the handle's parent element by default."
|
|
6319
|
-
},
|
|
6320
|
-
{
|
|
6321
|
-
"name": "reverse",
|
|
6322
|
-
"type": "boolean",
|
|
6323
|
-
"required": false,
|
|
6324
|
-
"description": "Whether the size grows toward the start of the axis: a panel docked at the bottom grows up as its top edge moves up, and a pane at the inline end grows as its start edge moves toward the start. The text direction is applied on top, so the inline start is the right in RTL."
|
|
6325
|
-
},
|
|
6326
|
-
{
|
|
6327
|
-
"name": "onChange",
|
|
6328
|
-
"type": "(value: number, details: ResizeDetails) => void",
|
|
6329
|
-
"required": true,
|
|
6330
|
-
"description": "Receives each new size, clamped to min and max: while dragging with committed false, and once more with committed true as the drag ends or a key moves it. A cancelled drag ends at the size it began with."
|
|
6331
|
-
},
|
|
6332
|
-
{
|
|
6333
|
-
"name": "valueText",
|
|
6334
|
-
"type": "(value: number) => string",
|
|
6335
|
-
"required": false,
|
|
6336
|
-
"description": "The size as words, such as 240 pixels or Narrow, for assistive technology."
|
|
6337
|
-
},
|
|
6338
|
-
{
|
|
6339
|
-
"name": "disabled",
|
|
6340
|
-
"type": "boolean",
|
|
6341
|
-
"required": false,
|
|
6342
|
-
"description": "Leaves the size as it is and takes the handle out of the tab order; a drag in progress ends without a change, as when the handle goes while it is dragged."
|
|
6343
|
-
},
|
|
6344
|
-
{
|
|
6345
|
-
"name": "label",
|
|
6346
|
-
"type": "string",
|
|
6347
|
-
"required": true,
|
|
6348
|
-
"description": "The handle's name, which says what it resizes, such as Resize the project list."
|
|
6349
|
-
},
|
|
6350
|
-
{
|
|
6351
|
-
"name": "grip",
|
|
6352
|
-
"type": "boolean",
|
|
6353
|
-
"required": false,
|
|
6354
|
-
"default": "true",
|
|
6355
|
-
"description": "Shows a grip of three dots at the handle's middle. false leaves the handle invisible until the pointer is over it, it has keyboard focus or it is dragged."
|
|
6356
|
-
}
|
|
6357
|
-
],
|
|
6358
|
-
"native": [
|
|
6359
|
-
"div"
|
|
6360
|
-
],
|
|
6361
|
-
"entries": [
|
|
6362
|
-
"@envsemble/envui"
|
|
6363
|
-
]
|
|
6364
|
-
},
|
|
6365
|
-
"RichText": {
|
|
6366
|
-
"kind": "component",
|
|
6367
|
-
"source": "packages/ui/src/forms/rich-text/RichText.tsx",
|
|
6368
|
-
"description": "Saved rich text, read-only: Markdown rendered with the editor's own schema and parser, so it shows what RichTextEditor wrote, references included, with envUI's links, code and checkboxes. It renders on the server too.",
|
|
6369
|
-
"props": [
|
|
6370
|
-
{
|
|
6371
|
-
"name": "children",
|
|
6372
|
-
"type": "string",
|
|
6373
|
-
"required": true,
|
|
6374
|
-
"description": "The Markdown to show, such as what RichTextEditor saved."
|
|
6375
|
-
},
|
|
6376
|
-
{
|
|
6377
|
-
"name": "extensions",
|
|
6378
|
-
"type": "AnyExtension[]",
|
|
6379
|
-
"required": false,
|
|
6380
|
-
"default": "[]",
|
|
6381
|
-
"description": "Tiptap extensions added to the shared schema, such as a custom mark. They must parse and write Markdown, and the array must stay the same between renders, such as at module scope; a new array starts a new editing session. Pass the same extensions to RichText."
|
|
6382
|
-
},
|
|
6383
|
-
{
|
|
6384
|
-
"name": "renderReference",
|
|
6385
|
-
"type": "(reference: RichTextReference, context: { readOnly: boolean; selected: boolean }) => ReactNode",
|
|
6386
|
-
"required": false,
|
|
6387
|
-
"default": "the trigger and the label, such as #Launch",
|
|
6388
|
-
"description": "Renders a reference's content, such as an avatar beside the name; it receives whether the document is read-only and whether the reference is selected."
|
|
6389
|
-
},
|
|
6390
|
-
{
|
|
6391
|
-
"name": "onReferenceClick",
|
|
6392
|
-
"type": "(reference: RichTextReference, event: MouseEvent<HTMLElement>) => void",
|
|
6393
|
-
"required": false,
|
|
6394
|
-
"description": "Called when people activate a reference, with the reference and the event, such as to open the record. A reference with an href is a link, which the editor never follows while it is editable; without an href, this makes the reference a button."
|
|
6395
|
-
},
|
|
6396
|
-
{
|
|
6397
|
-
"name": "onLinkClick",
|
|
6398
|
-
"type": "(href: string, event: RichTextLinkEvent) => void",
|
|
6399
|
-
"required": false,
|
|
6400
|
-
"description": "Called when people activate a link in the document, with its href and the event: a native MouseEvent in the editor, a React mouse event in RichText. The editor never follows links while editable; call preventDefault to keep RichText or a read-only editor from following it."
|
|
6401
|
-
}
|
|
6402
|
-
],
|
|
6403
|
-
"native": [
|
|
6404
|
-
"div"
|
|
6405
|
-
],
|
|
6406
|
-
"entries": [
|
|
6407
|
-
"@envsemble/envui/rich-text"
|
|
6408
|
-
]
|
|
6409
|
-
},
|
|
6410
|
-
"RichTextEditor": {
|
|
6411
|
-
"kind": "component",
|
|
6412
|
-
"source": "packages/ui/src/forms/rich-text/RichTextEditor.tsx",
|
|
6413
|
-
"description": "A labelled editor for formatted text that people edit as it looks, built on Tiptap, with a formatting toolbar, references typed with a trigger such as",
|
|
6414
|
-
"props": [
|
|
6415
|
-
{
|
|
6416
|
-
"name": "editorRef",
|
|
6417
|
-
"type": "Ref<RichTextEditorHandle>",
|
|
6418
|
-
"required": false,
|
|
6419
|
-
"description": "Gives the Tiptap editor, as editorRef.current.editor, for commands."
|
|
6420
|
-
},
|
|
6421
|
-
{
|
|
6422
|
-
"name": "value",
|
|
6423
|
-
"type": "string",
|
|
6424
|
-
"required": false,
|
|
6425
|
-
"description": "The Markdown of a controlled editor; update it from onValueChange. A new value from outside, such as another draft, replaces the document and keeps the caret where it can."
|
|
6426
|
-
},
|
|
6427
|
-
{
|
|
6428
|
-
"name": "defaultValue",
|
|
6429
|
-
"type": "string",
|
|
6430
|
-
"required": false,
|
|
6431
|
-
"default": "''",
|
|
6432
|
-
"description": "The Markdown an uncontrolled editor starts with, and returns to when its form resets."
|
|
6433
|
-
},
|
|
6434
|
-
{
|
|
6435
|
-
"name": "onValueChange",
|
|
6436
|
-
"type": "(markdown: string) => void",
|
|
6437
|
-
"required": false,
|
|
6438
|
-
"description": "Receives the document as Markdown after every edit, normalized by the editor's schema, so it can differ from the Markdown it was given, such as * for _ around italics."
|
|
6439
|
-
},
|
|
6440
|
-
{
|
|
6441
|
-
"name": "name",
|
|
6442
|
-
"type": "string",
|
|
6443
|
-
"required": false,
|
|
6444
|
-
"description": "Submits the Markdown with a native form under this name, through a hidden input."
|
|
6445
|
-
},
|
|
6446
|
-
{
|
|
6447
|
-
"name": "form",
|
|
6448
|
-
"type": "string",
|
|
6449
|
-
"required": false,
|
|
6450
|
-
"description": "The ID of the form the hidden input belongs to, where the editor sits outside it."
|
|
6451
|
-
},
|
|
6452
|
-
{
|
|
6453
|
-
"name": "placeholder",
|
|
6454
|
-
"type": "string",
|
|
6455
|
-
"required": false,
|
|
6456
|
-
"description": "Text shown in an empty document, such as what to write."
|
|
6457
|
-
},
|
|
6458
|
-
{
|
|
6459
|
-
"name": "disabled",
|
|
6460
|
-
"type": "boolean",
|
|
6461
|
-
"required": false,
|
|
6462
|
-
"default": "false",
|
|
6463
|
-
"description": "Makes the editor unavailable: it cannot be edited or focused, the toolbar is disabled, its value is left out of form submission and it takes the shared disabled opacity."
|
|
6464
|
-
},
|
|
6465
|
-
{
|
|
6466
|
-
"name": "readOnly",
|
|
6467
|
-
"type": "boolean",
|
|
6468
|
-
"required": false,
|
|
6469
|
-
"default": "false",
|
|
6470
|
-
"description": "Shows the document without editing it: the toolbar is disabled and the document cannot be focused, but its links and references can, and the form still submits its value."
|
|
6471
|
-
},
|
|
6472
|
-
{
|
|
6473
|
-
"name": "toolbar",
|
|
6474
|
-
"type": "readonly RichTextCommand[] | false",
|
|
6475
|
-
"required": false,
|
|
6476
|
-
"default": "every command, from heading to table",
|
|
6477
|
-
"description": "The toolbar's commands, in order, or false for no toolbar; Undo and Redo, and Attach files with onUpload, follow them."
|
|
6447
|
+
"required": true,
|
|
6448
|
+
"description": "The axis the handle moves along: inline, across a row of panes, such as a sidebar's edge, or block, up and down, such as a docked panel's top edge."
|
|
6478
6449
|
},
|
|
6479
6450
|
{
|
|
6480
|
-
"name": "
|
|
6481
|
-
"type": "
|
|
6482
|
-
"required":
|
|
6483
|
-
"
|
|
6484
|
-
"description": "Kinds of references people insert by typing a trigger, such as @ for people and # for topics, each with its own lookup. Triggers must be unique, and the array must stay the same between renders, such as at module scope."
|
|
6451
|
+
"name": "value",
|
|
6452
|
+
"type": "number",
|
|
6453
|
+
"required": true,
|
|
6454
|
+
"description": "The size the handle controls, in `unit`."
|
|
6485
6455
|
},
|
|
6486
6456
|
{
|
|
6487
|
-
"name": "
|
|
6488
|
-
"type": "
|
|
6489
|
-
"required":
|
|
6490
|
-
"
|
|
6491
|
-
"description": "Typing / opens a menu of block commands: true offers heading, the lists, quote, code block and table; an array adds the application's commands after them. A / reference source can't be used beside it."
|
|
6457
|
+
"name": "min",
|
|
6458
|
+
"type": "number",
|
|
6459
|
+
"required": true,
|
|
6460
|
+
"description": "The smallest size."
|
|
6492
6461
|
},
|
|
6493
6462
|
{
|
|
6494
|
-
"name": "
|
|
6495
|
-
"type": "
|
|
6496
|
-
"required":
|
|
6497
|
-
"description": "
|
|
6463
|
+
"name": "max",
|
|
6464
|
+
"type": "number",
|
|
6465
|
+
"required": true,
|
|
6466
|
+
"description": "The largest size."
|
|
6498
6467
|
},
|
|
6499
6468
|
{
|
|
6500
|
-
"name": "
|
|
6501
|
-
"type": "(
|
|
6469
|
+
"name": "room",
|
|
6470
|
+
"type": "(handle: HTMLElement) => number",
|
|
6502
6471
|
"required": false,
|
|
6503
|
-
"description": "
|
|
6472
|
+
"description": "The largest size the room allows, in `unit`, read from the handle as a drag starts or a key moves it: where it is under `max`, the drag starts at it and goes no further."
|
|
6504
6473
|
},
|
|
6505
6474
|
{
|
|
6506
|
-
"name": "
|
|
6507
|
-
"type": "
|
|
6475
|
+
"name": "step",
|
|
6476
|
+
"type": "number",
|
|
6508
6477
|
"required": false,
|
|
6509
|
-
"description": "
|
|
6478
|
+
"description": "How far an arrow key moves it; 10 by default."
|
|
6510
6479
|
},
|
|
6511
6480
|
{
|
|
6512
|
-
"name": "
|
|
6513
|
-
"type": "
|
|
6481
|
+
"name": "largeStep",
|
|
6482
|
+
"type": "number",
|
|
6514
6483
|
"required": false,
|
|
6515
|
-
"
|
|
6516
|
-
"description": "Lets people choose several files at once with Attach files."
|
|
6484
|
+
"description": "How far Page Up and Page Down, and an arrow key with Shift, move it; ten steps by default."
|
|
6517
6485
|
},
|
|
6518
6486
|
{
|
|
6519
|
-
"name": "
|
|
6520
|
-
"type": "'
|
|
6487
|
+
"name": "unit",
|
|
6488
|
+
"type": "'px' | '%' | 'rem'",
|
|
6521
6489
|
"required": false,
|
|
6522
|
-
"
|
|
6523
|
-
"description": "The document's look, as a text area's: outline, in a bordered box on what it sits on; or ghost, only its text at rest, with a soft fill under the pointer and while it has focus. The document is always tall, with its label above it."
|
|
6490
|
+
"description": "The size's unit: px, % of `percentOf`, or rem, of the root's font size."
|
|
6524
6491
|
},
|
|
6525
6492
|
{
|
|
6526
|
-
"name": "
|
|
6527
|
-
"type": "
|
|
6493
|
+
"name": "percentOf",
|
|
6494
|
+
"type": "(handle: HTMLElement) => HTMLElement | null",
|
|
6528
6495
|
"required": false,
|
|
6529
|
-
"description": "
|
|
6496
|
+
"description": "The element a size in % is a share of, such as a column's table: the handle's parent element by default."
|
|
6530
6497
|
},
|
|
6531
6498
|
{
|
|
6532
|
-
"name": "
|
|
6533
|
-
"type": "
|
|
6499
|
+
"name": "reverse",
|
|
6500
|
+
"type": "boolean",
|
|
6534
6501
|
"required": false,
|
|
6535
|
-
"
|
|
6536
|
-
"description": "Tiptap extensions added to the shared schema, such as a custom mark. They must parse and write Markdown, and the array must stay the same between renders, such as at module scope; a new array starts a new editing session. Pass the same extensions to RichText."
|
|
6502
|
+
"description": "Whether the size grows toward the start of the axis: a panel docked at the bottom grows up as its top edge moves up, and a pane at the inline end grows as its start edge moves toward the start. The text direction is applied on top, so the inline start is the right in RTL."
|
|
6537
6503
|
},
|
|
6538
6504
|
{
|
|
6539
|
-
"name": "
|
|
6540
|
-
"type": "(
|
|
6541
|
-
"required":
|
|
6542
|
-
"
|
|
6543
|
-
"description": "Renders a reference's content, such as an avatar beside the name; it receives whether the document is read-only and whether the reference is selected."
|
|
6505
|
+
"name": "onChange",
|
|
6506
|
+
"type": "(value: number, details: ResizeDetails) => void",
|
|
6507
|
+
"required": true,
|
|
6508
|
+
"description": "Receives each new size, clamped to min and max: while dragging with committed false, and once more with committed true as the drag ends or a key moves it. A cancelled drag ends at the size it began with."
|
|
6544
6509
|
},
|
|
6545
6510
|
{
|
|
6546
|
-
"name": "
|
|
6547
|
-
"type": "(
|
|
6511
|
+
"name": "valueText",
|
|
6512
|
+
"type": "(value: number) => string",
|
|
6548
6513
|
"required": false,
|
|
6549
|
-
"description": "
|
|
6514
|
+
"description": "The size as words, such as 240 pixels or Narrow, for assistive technology."
|
|
6550
6515
|
},
|
|
6551
6516
|
{
|
|
6552
|
-
"name": "
|
|
6553
|
-
"type": "
|
|
6517
|
+
"name": "disabled",
|
|
6518
|
+
"type": "boolean",
|
|
6554
6519
|
"required": false,
|
|
6555
|
-
"description": "
|
|
6520
|
+
"description": "Leaves the size as it is and takes the handle out of the tab order; a drag in progress ends without a change, as when the handle goes while it is dragged."
|
|
6556
6521
|
},
|
|
6557
6522
|
{
|
|
6558
6523
|
"name": "label",
|
|
6559
|
-
"type": "
|
|
6560
|
-
"required":
|
|
6561
|
-
"description": "The
|
|
6562
|
-
},
|
|
6563
|
-
{
|
|
6564
|
-
"name": "description",
|
|
6565
|
-
"type": "ReactNode",
|
|
6566
|
-
"required": false,
|
|
6567
|
-
"description": "Lasting guidance under the field, such as a format or a limit, linked to the control as its description."
|
|
6524
|
+
"type": "string",
|
|
6525
|
+
"required": true,
|
|
6526
|
+
"description": "The handle's name, which says what it resizes, such as Resize the project list."
|
|
6568
6527
|
},
|
|
6569
6528
|
{
|
|
6570
|
-
"name": "
|
|
6571
|
-
"type": "
|
|
6529
|
+
"name": "grip",
|
|
6530
|
+
"type": "boolean",
|
|
6572
6531
|
"required": false,
|
|
6573
|
-
"
|
|
6532
|
+
"default": "true",
|
|
6533
|
+
"description": "Shows a grip of three dots at the handle's middle. false leaves the handle invisible until the pointer is over it, it has keyboard focus or it is dragged."
|
|
6574
6534
|
}
|
|
6575
6535
|
],
|
|
6576
6536
|
"native": [
|
|
6577
6537
|
"div"
|
|
6578
6538
|
],
|
|
6579
6539
|
"entries": [
|
|
6580
|
-
"@envsemble/envui
|
|
6540
|
+
"@envsemble/envui"
|
|
6581
6541
|
]
|
|
6582
6542
|
},
|
|
6583
6543
|
"Row": {
|
|
@@ -6628,7 +6588,7 @@
|
|
|
6628
6588
|
"name": "name",
|
|
6629
6589
|
"type": "string",
|
|
6630
6590
|
"required": false,
|
|
6631
|
-
"description": "A name for this node, such as \"filters\" or \"summary\",
|
|
6591
|
+
"description": "A name for this node, such as \"filters\" or \"summary\", for the application's styles and tests to find it by; it renders as `data-env-name`. A component's part class names its node instead."
|
|
6632
6592
|
},
|
|
6633
6593
|
{
|
|
6634
6594
|
"name": "container",
|
|
@@ -6653,7 +6613,7 @@
|
|
|
6653
6613
|
"Scaffold": {
|
|
6654
6614
|
"kind": "component",
|
|
6655
6615
|
"source": "packages/ui/src/layout/Scaffold.tsx",
|
|
6656
|
-
"description": "The invisible structure of an application's screen: a top bar region, a navigation region and the body. It never paints. It shows one navigation form at a time by its own width: a NavigationBar at the bottom of a compact window, a NavigationRail at the start of a medium one and a NavigationDrawer at the start from expanded. The document scrolls by default, with the top bar, the bar and the rail or the drawer kept in view; `scroll=\"body\"` scrolls the body alone. Skip links to the body and the navigation come first.",
|
|
6616
|
+
"description": "The invisible structure of an application's screen: a top bar region, a navigation region and the body, with an optional aside region and bottom bar. It never paints. It shows one navigation form at a time by its own width: a NavigationBar at the bottom of a compact window, a NavigationRail at the start of a medium one and a NavigationDrawer at the start from expanded. The document scrolls by default, with the top bar, the bar and the rail or the drawer kept in view; `scroll=\"body\"` scrolls the body alone. Skip links to the body and the navigation come first.",
|
|
6657
6617
|
"props": [
|
|
6658
6618
|
{
|
|
6659
6619
|
"name": "topBar",
|
|
@@ -6661,6 +6621,18 @@
|
|
|
6661
6621
|
"required": false,
|
|
6662
6622
|
"description": "The top bar region, above the body: usually a TopBar."
|
|
6663
6623
|
},
|
|
6624
|
+
{
|
|
6625
|
+
"name": "aside",
|
|
6626
|
+
"type": "ReactNode",
|
|
6627
|
+
"required": false,
|
|
6628
|
+
"description": "A region at the end edge, beside the body and under the top bar, such as an inspector, at the width of its content and scrolling on its own. It stays in view as the rail does."
|
|
6629
|
+
},
|
|
6630
|
+
{
|
|
6631
|
+
"name": "bottomBar",
|
|
6632
|
+
"type": "ReactNode",
|
|
6633
|
+
"required": false,
|
|
6634
|
+
"description": "A bar along the bottom of the body and the aside region, such as a status bar, above a NavigationBar. It stays in view as the top bar does, and focus scrolls clear of it."
|
|
6635
|
+
},
|
|
6664
6636
|
{
|
|
6665
6637
|
"name": "navigation",
|
|
6666
6638
|
"type": "ScaffoldNavigation",
|
|
@@ -6726,7 +6698,7 @@
|
|
|
6726
6698
|
"name": "name",
|
|
6727
6699
|
"type": "string",
|
|
6728
6700
|
"required": false,
|
|
6729
|
-
"description": "A name for this node, such as \"app\",
|
|
6701
|
+
"description": "A name for this node, such as \"app\", for the application's styles and tests to find it by; it renders as `data-env-name`."
|
|
6730
6702
|
},
|
|
6731
6703
|
{
|
|
6732
6704
|
"name": "children",
|
|
@@ -6749,9 +6721,15 @@
|
|
|
6749
6721
|
"props": [
|
|
6750
6722
|
{
|
|
6751
6723
|
"name": "label",
|
|
6752
|
-
"type": "
|
|
6724
|
+
"type": "ReactNode",
|
|
6753
6725
|
"required": true,
|
|
6754
|
-
"description": "The field's accessible name, such as Search members. It shows above the field only with showLabel; otherwise a placeholder gives the visible guidance."
|
|
6726
|
+
"description": "The field's accessible name, such as Search members: text, or any content, such as an icon beside the text. It shows above the field only with showLabel; otherwise a placeholder gives the visible guidance."
|
|
6727
|
+
},
|
|
6728
|
+
{
|
|
6729
|
+
"name": "endAction",
|
|
6730
|
+
"type": "ReactNode",
|
|
6731
|
+
"required": false,
|
|
6732
|
+
"description": "A control at the end of the field, after the clear button, such as an IconButton that opens filters, or a quiet hint such as a shortcut's Kbd; name a control with aria-label. A button that sets no variant takes ghost here."
|
|
6755
6733
|
},
|
|
6756
6734
|
{
|
|
6757
6735
|
"name": "showLabel",
|
|
@@ -6813,9 +6791,9 @@
|
|
|
6813
6791
|
},
|
|
6814
6792
|
{
|
|
6815
6793
|
"name": "prefix",
|
|
6816
|
-
"type": "
|
|
6794
|
+
"type": "ReactNode",
|
|
6817
6795
|
"required": false,
|
|
6818
|
-
"description": "Short, non-interactive
|
|
6796
|
+
"description": "Short, non-interactive content before the value: text, such as the start of an address, or any content, such as a currency's flag beside its code, or a small Avatar, at its own size. It is cut short with an ellipsis where it is long, is not part of the value, and its text is read after the label."
|
|
6819
6797
|
},
|
|
6820
6798
|
{
|
|
6821
6799
|
"name": "description",
|
|
@@ -6850,9 +6828,9 @@
|
|
|
6850
6828
|
},
|
|
6851
6829
|
{
|
|
6852
6830
|
"name": "suffix",
|
|
6853
|
-
"type": "
|
|
6831
|
+
"type": "ReactNode",
|
|
6854
6832
|
"required": false,
|
|
6855
|
-
"description": "Short, non-interactive
|
|
6833
|
+
"description": "Short, non-interactive content after the value: text, such as a unit, or any content, such as an icon beside the unit. It is cut short with an ellipsis where it is long, is not part of the value, and its text is read after the label."
|
|
6856
6834
|
}
|
|
6857
6835
|
],
|
|
6858
6836
|
"native": [
|
|
@@ -6895,8 +6873,8 @@
|
|
|
6895
6873
|
{
|
|
6896
6874
|
"name": "aria-label",
|
|
6897
6875
|
"type": "string",
|
|
6898
|
-
"required":
|
|
6899
|
-
"description": "The group's accessible name, such as Work items; the control has no visible label."
|
|
6876
|
+
"required": false,
|
|
6877
|
+
"description": "The group's accessible name, such as Work items; the control has no visible label. Without it, a List.Item whose control it is names it, or name it with aria-labelledby."
|
|
6900
6878
|
},
|
|
6901
6879
|
{
|
|
6902
6880
|
"name": "size",
|
|
@@ -6951,9 +6929,9 @@
|
|
|
6951
6929
|
},
|
|
6952
6930
|
{
|
|
6953
6931
|
"name": "items",
|
|
6954
|
-
"type": "readonly SelectItem[]",
|
|
6932
|
+
"type": "readonly SelectItem[] | readonly SelectGroup[]",
|
|
6955
6933
|
"required": true,
|
|
6956
|
-
"description": "The options of the list, in order, each with a value, a label, an optional description and whether it is disabled."
|
|
6934
|
+
"description": "The options of the list, in order, each with a value, a label, an optional description, start and end content and whether it is disabled; or groups of options under headings."
|
|
6957
6935
|
},
|
|
6958
6936
|
{
|
|
6959
6937
|
"name": "value",
|
|
@@ -7128,7 +7106,25 @@
|
|
|
7128
7106
|
"name": "actions",
|
|
7129
7107
|
"type": "ReactNode",
|
|
7130
7108
|
"required": false,
|
|
7131
|
-
"description": "Actions at the end of the content, such as Apply, with the primary action last. While the sheet is pending, the last one shows it, where it is a Button that sets no pending of its own."
|
|
7109
|
+
"description": "Actions at the end of the content, such as Apply, with the primary action last. While the sheet is pending, the last one shows it, where it is a Button that sets no pending of its own; another component reads it with useDialogPending."
|
|
7110
|
+
},
|
|
7111
|
+
{
|
|
7112
|
+
"name": "actionsStart",
|
|
7113
|
+
"type": "ReactNode",
|
|
7114
|
+
"required": false,
|
|
7115
|
+
"description": "Content at the start of the actions' row, which takes the room the actions leave, such as a Reset button or a Learn more link."
|
|
7116
|
+
},
|
|
7117
|
+
{
|
|
7118
|
+
"name": "headerStart",
|
|
7119
|
+
"type": "ReactNode",
|
|
7120
|
+
"required": false,
|
|
7121
|
+
"description": "Content before the title in the heading's row, such as a back button."
|
|
7122
|
+
},
|
|
7123
|
+
{
|
|
7124
|
+
"name": "headerEnd",
|
|
7125
|
+
"type": "ReactNode",
|
|
7126
|
+
"required": false,
|
|
7127
|
+
"description": "Content at the end of the heading's row, before the close button, such as a Menu of more actions or an Open full page button."
|
|
7132
7128
|
},
|
|
7133
7129
|
{
|
|
7134
7130
|
"name": "closeButton",
|
|
@@ -7247,9 +7243,9 @@
|
|
|
7247
7243
|
"props": [
|
|
7248
7244
|
{
|
|
7249
7245
|
"name": "label",
|
|
7250
|
-
"type": "
|
|
7251
|
-
"required":
|
|
7252
|
-
"description": "The value's name, inside the slider at its start, such as Opacity. It names the slider, and ends in an ellipsis where the slider is too narrow for it."
|
|
7246
|
+
"type": "ReactNode",
|
|
7247
|
+
"required": false,
|
|
7248
|
+
"description": "The value's name, inside the slider at its start, such as Opacity: text, or any content, such as a volume icon beside the text. It names the slider, and ends in an ellipsis where the slider is too narrow for it. Without it, a List.Item whose control it is names the slider, or name it with aria-label or aria-labelledby."
|
|
7253
7249
|
},
|
|
7254
7250
|
{
|
|
7255
7251
|
"name": "description",
|
|
@@ -7322,6 +7318,12 @@
|
|
|
7322
7318
|
"required": false,
|
|
7323
7319
|
"description": "The value as people read it at the slider's end and assistive technology announces it, such as (value) => `${value}%`. Without it, the number shows in the locale."
|
|
7324
7320
|
},
|
|
7321
|
+
{
|
|
7322
|
+
"name": "renderValue",
|
|
7323
|
+
"type": "(value: number) => ReactNode",
|
|
7324
|
+
"required": false,
|
|
7325
|
+
"description": "What the slider's end shows for the value in place of formatValue's text, such as the number with its unit styled apart, or a swatch; formatValue, or the number in the locale, stays what assistive technology announces."
|
|
7326
|
+
},
|
|
7325
7327
|
{
|
|
7326
7328
|
"name": "locale",
|
|
7327
7329
|
"type": "string",
|
|
@@ -7482,6 +7484,13 @@
|
|
|
7482
7484
|
"required": false,
|
|
7483
7485
|
"description": "A short, muted line under the label, such as what the option changes. It is part of the switch's label, so it is read with its name."
|
|
7484
7486
|
},
|
|
7487
|
+
{
|
|
7488
|
+
"name": "labelPlacement",
|
|
7489
|
+
"type": "'end' | 'start'",
|
|
7490
|
+
"required": false,
|
|
7491
|
+
"default": "'end'",
|
|
7492
|
+
"description": "Where the label sits beside the track: end, after it, or start, before it, as in an inline Dark mode switch whose label leads; the native label still names the switch."
|
|
7493
|
+
},
|
|
7485
7494
|
{
|
|
7486
7495
|
"name": "checked",
|
|
7487
7496
|
"type": "boolean",
|
|
@@ -7517,6 +7526,7 @@
|
|
|
7517
7526
|
"Table.Root",
|
|
7518
7527
|
"Table.Head",
|
|
7519
7528
|
"Table.Body",
|
|
7529
|
+
"Table.Foot",
|
|
7520
7530
|
"Table.Row",
|
|
7521
7531
|
"Table.HeaderCell",
|
|
7522
7532
|
"Table.Cell"
|
|
@@ -7577,6 +7587,18 @@
|
|
|
7577
7587
|
"@envsemble/envui"
|
|
7578
7588
|
]
|
|
7579
7589
|
},
|
|
7590
|
+
"Table.Foot": {
|
|
7591
|
+
"kind": "component",
|
|
7592
|
+
"source": "packages/ui/src/data-display/Table.tsx",
|
|
7593
|
+
"description": "The summary rows of a table, a native tfoot, such as its totals, on the header's shaded band under the rows.",
|
|
7594
|
+
"props": [],
|
|
7595
|
+
"native": [
|
|
7596
|
+
"tfoot"
|
|
7597
|
+
],
|
|
7598
|
+
"entries": [
|
|
7599
|
+
"@envsemble/envui"
|
|
7600
|
+
]
|
|
7601
|
+
},
|
|
7580
7602
|
"Table.Head": {
|
|
7581
7603
|
"kind": "component",
|
|
7582
7604
|
"source": "packages/ui/src/data-display/Table.tsx",
|
|
@@ -7621,6 +7643,12 @@
|
|
|
7621
7643
|
"default": "'Resize {header}', from EnvUIProvider's messages.table.resize",
|
|
7622
7644
|
"description": "Accessible name of the column's resize handle, \"Resize\" followed by the header's name."
|
|
7623
7645
|
},
|
|
7646
|
+
{
|
|
7647
|
+
"name": "end",
|
|
7648
|
+
"type": "ReactNode",
|
|
7649
|
+
"required": false,
|
|
7650
|
+
"description": "Content at the end of the header, beside its sort button and outside it, such as a column menu, a filter IconButton, a help Tooltip's trigger or a select-all Checkbox, placed as given. The header's name stays its label."
|
|
7651
|
+
},
|
|
7624
7652
|
{
|
|
7625
7653
|
"name": "align",
|
|
7626
7654
|
"type": "'start' | 'end'",
|
|
@@ -7679,7 +7707,7 @@
|
|
|
7679
7707
|
"type": "boolean",
|
|
7680
7708
|
"required": false,
|
|
7681
7709
|
"default": "false",
|
|
7682
|
-
"description": "The header row stays at the top of the region while the rows scroll beneath it. The region then scrolls vertically too, so give it a height through
|
|
7710
|
+
"description": "The header row stays at the top of the region while the rows scroll beneath it. The region then scrolls vertically too, so give it a height through regionProps or the surrounding layout."
|
|
7683
7711
|
},
|
|
7684
7712
|
{
|
|
7685
7713
|
"name": "plain",
|
|
@@ -7689,10 +7717,10 @@
|
|
|
7689
7717
|
"description": "Drops the frame, the raised surface and the header's shaded band: a hairline under the header and between the rows, the table lying on the surface around it."
|
|
7690
7718
|
},
|
|
7691
7719
|
{
|
|
7692
|
-
"name": "
|
|
7693
|
-
"type": "
|
|
7720
|
+
"name": "regionProps",
|
|
7721
|
+
"type": "Omit<ComponentPropsWithRef<'div'>, 'children' | 'role'>",
|
|
7694
7722
|
"required": false,
|
|
7695
|
-
"description": "
|
|
7723
|
+
"description": "Props of the scroll region around the table, such as a class or a style that limits its height, a ref for scrolling to a row or virtualising, data attributes or listeners. Its class joins the region's; the region's role, name, tab stop and layout stay the table's."
|
|
7696
7724
|
},
|
|
7697
7725
|
{
|
|
7698
7726
|
"name": "narrowLayout",
|
|
@@ -7818,6 +7846,12 @@
|
|
|
7818
7846
|
"required": false,
|
|
7819
7847
|
"description": "Leaves out the headings it returns false for, without `items`, such as an example's own."
|
|
7820
7848
|
},
|
|
7849
|
+
{
|
|
7850
|
+
"name": "onNavigate",
|
|
7851
|
+
"type": "(id: string, event: MouseEvent<HTMLAnchorElement>) => void",
|
|
7852
|
+
"required": false,
|
|
7853
|
+
"description": "Called when people follow a link, with its section's id and the click, before envUI scrolls the section into view and focuses it. Each link is an `#id` link through LinkProvider's link component, so the application's router, or else the browser, changes the address. Call preventDefault to make the jump yourself, without envUI's scroll or the address change."
|
|
7854
|
+
},
|
|
7821
7855
|
{
|
|
7822
7856
|
"name": "aria-label",
|
|
7823
7857
|
"type": "string",
|
|
@@ -7887,7 +7921,7 @@
|
|
|
7887
7921
|
"TextField": {
|
|
7888
7922
|
"kind": "component",
|
|
7889
7923
|
"source": "packages/ui/src/forms/TextField.tsx",
|
|
7890
|
-
"description": "A labelled single-line text input: a native input with its label above it, a description and an error, at the control height in an outline or ghost look, with
|
|
7924
|
+
"description": "A labelled single-line text input: a native input with its label above it, a description and an error, at the control height in an outline or ghost look, with optional start content, an end action, prefix and suffix.",
|
|
7891
7925
|
"props": [
|
|
7892
7926
|
{
|
|
7893
7927
|
"name": "ref",
|
|
@@ -7945,10 +7979,10 @@
|
|
|
7945
7979
|
"description": "The field's look: outline, a box with a thin edge, or ghost, a faint fill without an edge, for a search at the top of a sidebar or a list."
|
|
7946
7980
|
},
|
|
7947
7981
|
{
|
|
7948
|
-
"name": "
|
|
7982
|
+
"name": "start",
|
|
7949
7983
|
"type": "ReactNode",
|
|
7950
7984
|
"required": false,
|
|
7951
|
-
"description": "
|
|
7985
|
+
"description": "Content at the start of the field, before the value, in the room of one icon, such as IconSearch or IconMail: an envUI icon takes the field's icon size. It is hidden from assistive technology."
|
|
7952
7986
|
},
|
|
7953
7987
|
{
|
|
7954
7988
|
"name": "endAction",
|
|
@@ -7971,15 +8005,15 @@
|
|
|
7971
8005
|
},
|
|
7972
8006
|
{
|
|
7973
8007
|
"name": "prefix",
|
|
7974
|
-
"type": "
|
|
8008
|
+
"type": "ReactNode",
|
|
7975
8009
|
"required": false,
|
|
7976
|
-
"description": "Short, non-interactive
|
|
8010
|
+
"description": "Short, non-interactive content before the value: text, such as the start of an address, or any content, such as a currency's flag beside its code, or a small Avatar, at its own size. It is cut short with an ellipsis where it is long, is not part of the value, and its text is read after the label."
|
|
7977
8011
|
},
|
|
7978
8012
|
{
|
|
7979
8013
|
"name": "suffix",
|
|
7980
|
-
"type": "
|
|
8014
|
+
"type": "ReactNode",
|
|
7981
8015
|
"required": false,
|
|
7982
|
-
"description": "Short, non-interactive
|
|
8016
|
+
"description": "Short, non-interactive content after the value: text, such as a unit, or any content, such as an icon beside the unit. It is cut short with an ellipsis where it is long, is not part of the value, and its text is read after the label."
|
|
7983
8017
|
}
|
|
7984
8018
|
],
|
|
7985
8019
|
"native": [
|
|
@@ -8098,6 +8132,12 @@
|
|
|
8098
8132
|
"type": "'sharp' | 'rounded' | 'round'",
|
|
8099
8133
|
"required": false,
|
|
8100
8134
|
"description": "The corner shape inside: sharp, rounded or round. Defaults to the corners of the enclosing Theme, and to rounded outside any."
|
|
8135
|
+
},
|
|
8136
|
+
{
|
|
8137
|
+
"name": "render",
|
|
8138
|
+
"type": "ReactElement",
|
|
8139
|
+
"required": false,
|
|
8140
|
+
"description": "The boundary's element, for its meaning or its place in the markup, such as render={<section />} for a landmark or render={<tbody />} inside a table. The boundary's class and attributes merge into its props, as on Text: classes join, styles merge, both event handlers run and both refs receive the node. A div by default."
|
|
8101
8141
|
}
|
|
8102
8142
|
],
|
|
8103
8143
|
"native": [
|
|
@@ -8110,7 +8150,7 @@
|
|
|
8110
8150
|
"ThemeMenuRadioGroup": {
|
|
8111
8151
|
"kind": "component",
|
|
8112
8152
|
"source": "packages/ui/src/foundations/ThemeMenuRadioGroup.tsx",
|
|
8113
|
-
"description": "The theme choice for a Menu: System, Light and Dark as radio items. Inside a ThemePreferenceProvider it shows and
|
|
8153
|
+
"description": "The theme choice for a Menu: System, Light and Dark as radio items. Inside a ThemePreferenceProvider it shows and changes the provider's preference; value and onValueChange connect it to a preference outside one.",
|
|
8114
8154
|
"props": [
|
|
8115
8155
|
{
|
|
8116
8156
|
"name": "value",
|
|
@@ -8123,8 +8163,8 @@
|
|
|
8123
8163
|
"name": "onValueChange",
|
|
8124
8164
|
"type": "(value: ThemePreference) => void",
|
|
8125
8165
|
"required": false,
|
|
8126
|
-
"default": "the nearest ThemePreferenceProvider's setPreference
|
|
8127
|
-
"description": "Called with the preference chosen, for
|
|
8166
|
+
"default": "the nearest ThemePreferenceProvider's setPreference",
|
|
8167
|
+
"description": "Called with the preference chosen, for a group outside a ThemePreferenceProvider."
|
|
8128
8168
|
},
|
|
8129
8169
|
{
|
|
8130
8170
|
"name": "label",
|
|
@@ -8143,7 +8183,19 @@
|
|
|
8143
8183
|
"type": "boolean",
|
|
8144
8184
|
"required": false,
|
|
8145
8185
|
"default": "false",
|
|
8146
|
-
"description": "Close the menu after a choice. Off by default, so people see the theme change with the menu still open."
|
|
8186
|
+
"description": "Close the menu after a choice. Off by default, so people see the theme change with the menu still open. It applies to the choices given as children too, unless one sets its own."
|
|
8187
|
+
},
|
|
8188
|
+
{
|
|
8189
|
+
"name": "children",
|
|
8190
|
+
"type": "ReactNode",
|
|
8191
|
+
"required": false,
|
|
8192
|
+
"description": "The choices, as Menu.RadioItems valued system, light or dark, in place of the three default ones: such as Light and Dark alone, or a choice with a hint beside it."
|
|
8193
|
+
},
|
|
8194
|
+
{
|
|
8195
|
+
"name": "className",
|
|
8196
|
+
"type": "string",
|
|
8197
|
+
"required": false,
|
|
8198
|
+
"description": "The group's class, beside env-menu-group."
|
|
8147
8199
|
}
|
|
8148
8200
|
],
|
|
8149
8201
|
"native": [],
|
|
@@ -8153,8 +8205,8 @@
|
|
|
8153
8205
|
},
|
|
8154
8206
|
"ThemePreferenceProvider": {
|
|
8155
8207
|
"kind": "component",
|
|
8156
|
-
"source": "packages/ui/src/foundations/
|
|
8157
|
-
"description": "
|
|
8208
|
+
"source": "packages/ui/src/foundations/ThemePreferenceProvider.tsx",
|
|
8209
|
+
"description": "Themes the application by the theme preference, which the application keeps where it chooses, following the system's theme for a system preference, and themes the document root.",
|
|
8158
8210
|
"props": [
|
|
8159
8211
|
{
|
|
8160
8212
|
"name": "children",
|
|
@@ -8167,14 +8219,33 @@
|
|
|
8167
8219
|
"type": "ThemeDefinition",
|
|
8168
8220
|
"required": false,
|
|
8169
8221
|
"default": "{}",
|
|
8170
|
-
"description": "The application's theme, from defineTheme: its
|
|
8222
|
+
"description": "The application's theme, from defineTheme: its contrast, scale, selection and corners. Give createThemeBootstrapScript the same theme, so the root has it before the first paint. Left out, the contrast and scale are an enclosing Theme's, or else the page's on the root, or else system, and the look is an enclosing Theme's, or else neutral and rounded."
|
|
8223
|
+
},
|
|
8224
|
+
{
|
|
8225
|
+
"name": "preference",
|
|
8226
|
+
"type": "'light' | 'dark' | 'system'",
|
|
8227
|
+
"required": false,
|
|
8228
|
+
"description": "The chosen preference, for an application that keeps it itself: in a cookie, the user's account or, with useStoredThemePreference, localStorage. Give onPreferenceChange with it."
|
|
8229
|
+
},
|
|
8230
|
+
{
|
|
8231
|
+
"name": "defaultPreference",
|
|
8232
|
+
"type": "'light' | 'dark' | 'system'",
|
|
8233
|
+
"required": false,
|
|
8234
|
+
"default": "'system'",
|
|
8235
|
+
"description": "The preference while `preference` is left out, until people choose another."
|
|
8236
|
+
},
|
|
8237
|
+
{
|
|
8238
|
+
"name": "onPreferenceChange",
|
|
8239
|
+
"type": "(preference: ThemePreference) => void",
|
|
8240
|
+
"required": false,
|
|
8241
|
+
"description": "Called with the preference people choose, such as with ThemeToggle, for the application to keep."
|
|
8171
8242
|
},
|
|
8172
8243
|
{
|
|
8173
8244
|
"name": "applyToDocument",
|
|
8174
8245
|
"type": "boolean",
|
|
8175
8246
|
"required": false,
|
|
8176
8247
|
"default": "true",
|
|
8177
|
-
"description": "Theme the document root as well as this subtree (default). Root theming covers the page background, native controls, portals rendered by other libraries and the content of every theme-color meta tag, which takes the canvas color. One provider per document applies to it: pass false to any other, nested in it or beside it. In development, envUI reports two providers that both apply. Outside any Theme, its boundary around the children is a plain element that takes the root's look, with none of a Theme's class and attributes, unless its contrast is system while the page set a contrast of its own on the root. Rendered on the server, and as the page hydrates, it
|
|
8248
|
+
"description": "Theme the document root as well as this subtree (default). Root theming covers the page background, native controls, portals rendered by other libraries and the content of every theme-color meta tag, which takes the canvas color. One provider per document applies to it: pass false to any other, nested in it or beside it. In development, envUI reports two providers that both apply. Outside any Theme, its boundary around the children is a plain element that takes the root's look, with none of a Theme's class and attributes, unless its contrast is system while the page set a contrast of its own on the root. Rendered on the server, and as the page hydrates, it leaves the page's look to the theme createThemeBootstrapScript gave the root, and a system preference renders light; once hydrated, it themes the root itself."
|
|
8178
8249
|
},
|
|
8179
8250
|
{
|
|
8180
8251
|
"name": "className",
|
|
@@ -8191,7 +8262,7 @@
|
|
|
8191
8262
|
"ThemeToggle": {
|
|
8192
8263
|
"kind": "component",
|
|
8193
8264
|
"source": "packages/ui/src/foundations/ThemeToggle.tsx",
|
|
8194
|
-
"description": "Switches between the light and dark themes
|
|
8265
|
+
"description": "Switches between the light and dark themes, through the nearest ThemePreferenceProvider.",
|
|
8195
8266
|
"props": [
|
|
8196
8267
|
{
|
|
8197
8268
|
"name": "aria-labelledby",
|
|
@@ -8200,6 +8271,12 @@
|
|
|
8200
8271
|
"requiredWhen": "in some forms",
|
|
8201
8272
|
"description": "The id of visible text that names the action; this or aria-label."
|
|
8202
8273
|
},
|
|
8274
|
+
{
|
|
8275
|
+
"name": "render",
|
|
8276
|
+
"type": "ReactElement",
|
|
8277
|
+
"required": false,
|
|
8278
|
+
"description": "As Button's: another element to render the button as, such as a label for a file input shaped like an icon button. Its class, look, state attributes, icon and handlers merge into that element's props; disabled reports aria-disabled and blocks presses."
|
|
8279
|
+
},
|
|
8203
8280
|
{
|
|
8204
8281
|
"name": "size",
|
|
8205
8282
|
"type": "'sm' | 'md' | 'lg'",
|
|
@@ -8233,6 +8310,13 @@
|
|
|
8233
8310
|
"type": "string",
|
|
8234
8311
|
"required": false,
|
|
8235
8312
|
"description": "The button's name; without it, Switch to dark theme or Switch to light theme, or EnvUIProvider's messages.themePreference."
|
|
8313
|
+
},
|
|
8314
|
+
{
|
|
8315
|
+
"name": "icon",
|
|
8316
|
+
"type": "ReactNode",
|
|
8317
|
+
"required": false,
|
|
8318
|
+
"default": "the dark mode icon in the light theme, the light mode icon in the dark theme",
|
|
8319
|
+
"description": "The button's icon, such as one of the application's own; useThemePreference gives the theme to choose it by."
|
|
8236
8320
|
}
|
|
8237
8321
|
],
|
|
8238
8322
|
"native": [
|
|
@@ -8247,6 +8331,12 @@
|
|
|
8247
8331
|
"source": "packages/ui/src/forms/TimePicker.tsx",
|
|
8248
8332
|
"description": "A field for a time of day that shows the value in the reader's locale and opens wheels of its hours, minutes every `minuteStep` and, on a 12-hour clock, the day's halves to choose it.",
|
|
8249
8333
|
"props": [
|
|
8334
|
+
{
|
|
8335
|
+
"name": "onOpenChange",
|
|
8336
|
+
"type": "(open: boolean, details: TimePickerOpenChangeDetails) => void",
|
|
8337
|
+
"required": false,
|
|
8338
|
+
"description": "Called with the new state, and why, when the popup opens or closes."
|
|
8339
|
+
},
|
|
8250
8340
|
{
|
|
8251
8341
|
"name": "value",
|
|
8252
8342
|
"type": "string | null",
|
|
@@ -8383,10 +8473,16 @@
|
|
|
8383
8473
|
"description": "Whether an uncontrolled popup starts open; closed by default."
|
|
8384
8474
|
},
|
|
8385
8475
|
{
|
|
8386
|
-
"name": "
|
|
8387
|
-
"type": "
|
|
8476
|
+
"name": "popupHeader",
|
|
8477
|
+
"type": "ReactNode",
|
|
8388
8478
|
"required": false,
|
|
8389
|
-
"description": "
|
|
8479
|
+
"description": "Content at the top of the popup, above the calendar or the list, such as presets: buttons for Tomorrow or Next Monday that set the value, from a field the application controls."
|
|
8480
|
+
},
|
|
8481
|
+
{
|
|
8482
|
+
"name": "popupFooter",
|
|
8483
|
+
"type": "ReactNode",
|
|
8484
|
+
"required": false,
|
|
8485
|
+
"description": "Content in the popup's footer, after its shortcut to the current date or time and before Clear, such as a note of the time zone or another action."
|
|
8390
8486
|
},
|
|
8391
8487
|
{
|
|
8392
8488
|
"name": "label",
|
|
@@ -8467,7 +8563,9 @@
|
|
|
8467
8563
|
"Toolbar.Group",
|
|
8468
8564
|
"Toolbar.Separator",
|
|
8469
8565
|
"Toolbar.Button",
|
|
8470
|
-
"Toolbar.Link"
|
|
8566
|
+
"Toolbar.Link",
|
|
8567
|
+
"Toolbar.Item",
|
|
8568
|
+
"Toolbar.Input"
|
|
8471
8569
|
],
|
|
8472
8570
|
"entries": [
|
|
8473
8571
|
"@envsemble/envui"
|
|
@@ -8562,6 +8660,51 @@
|
|
|
8562
8660
|
"@envsemble/envui"
|
|
8563
8661
|
]
|
|
8564
8662
|
},
|
|
8663
|
+
"Toolbar.Input": {
|
|
8664
|
+
"kind": "component",
|
|
8665
|
+
"source": "packages/ui/src/actions/Toolbar.tsx",
|
|
8666
|
+
"description": "A text input as one stop of a toolbar's arrow-key path, such as a font size: the arrow keys move its caret, and leave it for the next control at the text's ends. Name it with aria-label.",
|
|
8667
|
+
"props": [
|
|
8668
|
+
{
|
|
8669
|
+
"name": "render",
|
|
8670
|
+
"type": "ReactElement",
|
|
8671
|
+
"required": false,
|
|
8672
|
+
"description": "The input to render, such as an input of the application's own; a native input by default. The toolbar's props and keyboard handling merge into its props."
|
|
8673
|
+
}
|
|
8674
|
+
],
|
|
8675
|
+
"native": [
|
|
8676
|
+
"input"
|
|
8677
|
+
],
|
|
8678
|
+
"entries": [
|
|
8679
|
+
"@envsemble/envui"
|
|
8680
|
+
]
|
|
8681
|
+
},
|
|
8682
|
+
"Toolbar.Item": {
|
|
8683
|
+
"kind": "component",
|
|
8684
|
+
"source": "packages/ui/src/actions/Toolbar.tsx",
|
|
8685
|
+
"description": "Any button-like control as one stop of a toolbar's arrow-key path, such as a labelled Button or a Menu's trigger: `<Menu.Root trigger={<Toolbar.Item render={<Button>Paragraph</Button>} />}>`.",
|
|
8686
|
+
"props": [
|
|
8687
|
+
{
|
|
8688
|
+
"name": "render",
|
|
8689
|
+
"type": "ReactElement",
|
|
8690
|
+
"required": true,
|
|
8691
|
+
"description": "The control, which joins the toolbar's arrow-key path as one of its stops: a button with a visible label, such as <Button start={<IconShare />}>Share</Button>, or the trigger of a Menu or another popup. The item's props, ref and keyboard handling merge into its props; a Button takes the toolbar's ghost variant unless it sets another."
|
|
8692
|
+
},
|
|
8693
|
+
{
|
|
8694
|
+
"name": "disabled",
|
|
8695
|
+
"type": "boolean",
|
|
8696
|
+
"required": false,
|
|
8697
|
+
"default": "false",
|
|
8698
|
+
"description": "The control can't be pressed, and leaves the arrow keys' path."
|
|
8699
|
+
}
|
|
8700
|
+
],
|
|
8701
|
+
"native": [
|
|
8702
|
+
"button"
|
|
8703
|
+
],
|
|
8704
|
+
"entries": [
|
|
8705
|
+
"@envsemble/envui"
|
|
8706
|
+
]
|
|
8707
|
+
},
|
|
8565
8708
|
"Toolbar.Link": {
|
|
8566
8709
|
"kind": "component",
|
|
8567
8710
|
"source": "packages/ui/src/actions/Toolbar.tsx",
|
|
@@ -8648,7 +8791,7 @@
|
|
|
8648
8791
|
"name": "children",
|
|
8649
8792
|
"type": "ReactNode",
|
|
8650
8793
|
"required": false,
|
|
8651
|
-
"description": "The controls: Toolbar.Button, Toolbar.Link, Toolbar.Group and Toolbar.Separator."
|
|
8794
|
+
"description": "The controls: Toolbar.Button, Toolbar.Link, Toolbar.Item, Toolbar.Input, Toolbar.Group and Toolbar.Separator."
|
|
8652
8795
|
}
|
|
8653
8796
|
],
|
|
8654
8797
|
"native": [
|
|
@@ -8699,6 +8842,13 @@
|
|
|
8699
8842
|
"required": false,
|
|
8700
8843
|
"description": "Class of the tooltip's popup, beside env-tooltip."
|
|
8701
8844
|
},
|
|
8845
|
+
{
|
|
8846
|
+
"name": "underline",
|
|
8847
|
+
"type": "boolean",
|
|
8848
|
+
"required": false,
|
|
8849
|
+
"default": "true",
|
|
8850
|
+
"description": "Whether a text trigger takes the quiet dotted underline, env-hover-detail, that says it shows more on hover or focus. False leaves its class alone, for text styled its own way, such as"
|
|
8851
|
+
},
|
|
8702
8852
|
{
|
|
8703
8853
|
"name": "side",
|
|
8704
8854
|
"type": "'top' | 'bottom' | 'left' | 'right' | 'inline-start' | 'inline-end'",
|
|
@@ -8927,26 +9077,26 @@
|
|
|
8927
9077
|
"countDiffLines": {
|
|
8928
9078
|
"kind": "function",
|
|
8929
9079
|
"source": "packages/ui/src/content/countDiffLines.ts",
|
|
8930
|
-
"description": "How many lines a change adds and removes, as a
|
|
9080
|
+
"description": "How many lines a change adds and removes, such as for the size of a change beside its file's name.",
|
|
8931
9081
|
"signature": "(before: string, after: string, filename?: string): { additions: number; deletions: number; }",
|
|
8932
9082
|
"entries": [
|
|
8933
9083
|
"@envsemble/envui/diff"
|
|
8934
9084
|
]
|
|
8935
9085
|
},
|
|
8936
|
-
"
|
|
9086
|
+
"createStoredThemeBootstrapScript": {
|
|
8937
9087
|
"kind": "function",
|
|
8938
|
-
"source": "packages/ui/src/
|
|
8939
|
-
"description": "
|
|
8940
|
-
"signature": "(
|
|
9088
|
+
"source": "packages/ui/src/foundations/themeStorage.ts",
|
|
9089
|
+
"description": "Inline script for the document head of an application that keeps the theme preference with useStoredThemePreference: createThemeBootstrapScript's script, with the preference stored in localStorage, so a stored dark theme does not flash light while the application loads.",
|
|
9090
|
+
"signature": "(theme?: ThemeDefinition, { storageKey, defaultPreference }?: ThemeStorageOptions): string",
|
|
8941
9091
|
"entries": [
|
|
8942
|
-
"@envsemble/envui/
|
|
9092
|
+
"@envsemble/envui/theme-storage"
|
|
8943
9093
|
]
|
|
8944
9094
|
},
|
|
8945
9095
|
"createThemeBootstrapScript": {
|
|
8946
9096
|
"kind": "function",
|
|
8947
9097
|
"source": "packages/ui/src/foundations/themeBootstrap.ts",
|
|
8948
|
-
"description": "Inline script for the document head. It themes the root element before the first paint, so a
|
|
8949
|
-
"signature": "(theme?: ThemeDefinition): string",
|
|
9098
|
+
"description": "Inline script for the document head. It themes the root element before the first paint, so a chosen or system dark theme does not flash light while the application loads, and the contrast, scale, selection and corners of the theme apply from the start. Give it the theme and the preference ThemePreferenceProvider takes.",
|
|
9099
|
+
"signature": "(theme?: ThemeDefinition, { preference }?: ThemeBootstrapOptions): string",
|
|
8950
9100
|
"entries": [
|
|
8951
9101
|
"@envsemble/envui",
|
|
8952
9102
|
"@envsemble/envui/theme-bootstrap"
|
|
@@ -8971,15 +9121,6 @@
|
|
|
8971
9121
|
"@envsemble/envui"
|
|
8972
9122
|
]
|
|
8973
9123
|
},
|
|
8974
|
-
"installDevMode": {
|
|
8975
|
-
"kind": "function",
|
|
8976
|
-
"source": "packages/ui/src/dev/install.tsx",
|
|
8977
|
-
"description": "Installs dev mode: `window.envui.layout` with `describe()`, `check()` and `at()`, a button in the corner and Alt+Shift+D, which open the page in a new tab with the 3D view and the inspector over the whole window. Closing that tab ends dev mode; the page it came from stays as it was. Load it in development only, so production builds contain none of it: if (import.meta.env.DEV) { void import('@envsemble/envui/dev').then(({ installDevMode }) => installDevMode()); } Calling it again returns the dev mode already installed, until it is uninstalled.",
|
|
8978
|
-
"signature": "(options?: DevModeOptions): DevModeHandle",
|
|
8979
|
-
"entries": [
|
|
8980
|
-
"@envsemble/envui/dev"
|
|
8981
|
-
]
|
|
8982
|
-
},
|
|
8983
9124
|
"isPlaceholder": {
|
|
8984
9125
|
"kind": "function",
|
|
8985
9126
|
"source": "packages/ui/src/foundations/placeholders.ts",
|
|
@@ -8998,20 +9139,20 @@
|
|
|
8998
9139
|
"@envsemble/envui"
|
|
8999
9140
|
]
|
|
9000
9141
|
},
|
|
9001
|
-
"
|
|
9142
|
+
"useContainerSize": {
|
|
9002
9143
|
"kind": "function",
|
|
9003
|
-
"source": "packages/ui/src/
|
|
9004
|
-
"description": "The
|
|
9005
|
-
"signature": "(
|
|
9144
|
+
"source": "packages/ui/src/foundations/useContainerSize.ts",
|
|
9145
|
+
"description": "The size of an element, kept up to date as it changes: its inline and block size in CSS pixels, along its writing mode, from a ResizeObserver. It is undefined on the server and until the element is measured, which happens before the browser paints it; an element that stops being rendered, such as one in a hidden tab panel, keeps its last size until it shows again. Pass a ref object, read once the element mounts, or the element itself, such as one kept in state by a callback ref. Prefer a container query (`@container`) where only styles change. const panel = useRef<HTMLDivElement>(null); const size = useContainerSize(panel); const narrow = size !== undefined && size.inlineSize < 640;",
|
|
9146
|
+
"signature": "<T extends Element>(target: RefObject<T | null> | T | null, options?: ContainerSizeOptions): ContainerSize | undefined",
|
|
9006
9147
|
"entries": [
|
|
9007
9148
|
"@envsemble/envui"
|
|
9008
9149
|
]
|
|
9009
9150
|
},
|
|
9010
|
-
"
|
|
9151
|
+
"useDialogPending": {
|
|
9011
9152
|
"kind": "function",
|
|
9012
|
-
"source": "packages/ui/src/
|
|
9013
|
-
"description": "
|
|
9014
|
-
"signature": "
|
|
9153
|
+
"source": "packages/ui/src/overlays/Dialog.tsx",
|
|
9154
|
+
"description": "Whether the Dialog or Sheet around it is pending, for an action component of the application's own, such as a Button wrapped for analytics, to show the work its press started.",
|
|
9155
|
+
"signature": "(): boolean",
|
|
9015
9156
|
"entries": [
|
|
9016
9157
|
"@envsemble/envui"
|
|
9017
9158
|
]
|
|
@@ -9036,13 +9177,22 @@
|
|
|
9036
9177
|
},
|
|
9037
9178
|
"useSkeleton": {
|
|
9038
9179
|
"kind": "function",
|
|
9039
|
-
"source": "packages/ui/src/foundations/
|
|
9180
|
+
"source": "packages/ui/src/foundations/useSkeleton.ts",
|
|
9040
9181
|
"description": "Whether the component is inside a skeleton: a surface with `skeleton` around it. A component of the application's own reads it to give its skeleton a look of its own, such as a chart's.",
|
|
9041
9182
|
"signature": "(): boolean",
|
|
9042
9183
|
"entries": [
|
|
9043
9184
|
"@envsemble/envui"
|
|
9044
9185
|
]
|
|
9045
9186
|
},
|
|
9187
|
+
"useStoredThemePreference": {
|
|
9188
|
+
"kind": "function",
|
|
9189
|
+
"source": "packages/ui/src/foundations/useStoredThemePreference.ts",
|
|
9190
|
+
"description": "Keeps the theme preference in localStorage, follows a choice made in another window of the same origin, and keeps a choice for the page's life where storage is blocked. Spread what it returns on ThemePreferenceProvider, and give createStoredThemeBootstrapScript the same options. On the server and while the page hydrates it returns the default, as the server rendered it.",
|
|
9191
|
+
"signature": "({ storageKey, defaultPreference, }?: ThemeStorageOptions): StoredThemePreference",
|
|
9192
|
+
"entries": [
|
|
9193
|
+
"@envsemble/envui/theme-storage"
|
|
9194
|
+
]
|
|
9195
|
+
},
|
|
9046
9196
|
"useTheme": {
|
|
9047
9197
|
"kind": "function",
|
|
9048
9198
|
"source": "packages/ui/src/foundations/Theme.tsx",
|
|
@@ -9054,7 +9204,7 @@
|
|
|
9054
9204
|
},
|
|
9055
9205
|
"useThemePreference": {
|
|
9056
9206
|
"kind": "function",
|
|
9057
|
-
"source": "packages/ui/src/foundations/
|
|
9207
|
+
"source": "packages/ui/src/foundations/ThemePreferenceProvider.tsx",
|
|
9058
9208
|
"description": "The theme preference from the nearest ThemePreferenceProvider.",
|
|
9059
9209
|
"signature": "(): ThemePreferenceValue",
|
|
9060
9210
|
"entries": [
|