@astryxdesign/core 0.1.4-canary.ff77e1c → 0.1.4
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/dist/AlertDialog/AlertDialog.d.ts +1 -1
- package/dist/AlertDialog/AlertDialog.d.ts.map +1 -1
- package/dist/AlertDialog/AlertDialog.js +18 -20
- package/dist/AlertDialog/useImperativeAlertDialog.js +3 -3
- package/dist/AppShell/AppShell.d.ts +1 -1
- package/dist/AppShell/AppShell.d.ts.map +1 -1
- package/dist/AppShell/AppShell.js +53 -55
- package/dist/AspectRatio/AspectRatio.d.ts +10 -48
- package/dist/AspectRatio/AspectRatio.d.ts.map +1 -1
- package/dist/AspectRatio/AspectRatio.js +12 -33
- package/dist/AspectRatio/index.d.ts +1 -1
- package/dist/AspectRatio/index.d.ts.map +1 -1
- package/dist/Avatar/Avatar.d.ts.map +1 -1
- package/dist/Avatar/Avatar.js +25 -27
- package/dist/Avatar/AvatarStatusDot.js +5 -5
- package/dist/AvatarGroup/AvatarGroup.js +5 -5
- package/dist/AvatarGroup/AvatarGroupOverflow.js +5 -5
- package/dist/Badge/Badge.js +3 -3
- package/dist/Banner/Banner.d.ts.map +1 -1
- package/dist/Banner/Banner.js +25 -32
- package/dist/Blockquote/Blockquote.js +7 -7
- package/dist/Breadcrumbs/BreadcrumbItem.js +17 -17
- package/dist/Breadcrumbs/Breadcrumbs.js +7 -7
- package/dist/Button/Button.js +19 -19
- package/dist/ButtonGroup/ButtonGroup.js +7 -7
- package/dist/Calendar/Calendar.d.ts.map +1 -1
- package/dist/Calendar/Calendar.js +48 -68
- package/dist/Calendar/dayCellUtils.d.ts.map +1 -1
- package/dist/Calendar/styles.d.ts +2 -2
- package/dist/Calendar/styles.d.ts.map +1 -1
- package/dist/Calendar/styles.js +2 -2
- package/dist/Card/Card.d.ts +2 -4
- package/dist/Card/Card.d.ts.map +1 -1
- package/dist/Card/Card.js +10 -18
- package/dist/Carousel/Carousel.d.ts.map +1 -1
- package/dist/Carousel/Carousel.js +21 -24
- package/dist/Carousel/carousel.markers.stylex.d.ts +7 -0
- package/dist/Carousel/carousel.markers.stylex.d.ts.map +1 -0
- package/dist/Carousel/carousel.markers.stylex.js +12 -0
- package/dist/Center/Center.js +3 -3
- package/dist/Chat/ChatComposer.js +23 -23
- package/dist/Chat/ChatComposerDrawer.js +14 -14
- package/dist/Chat/ChatComposerInput.d.ts +1 -1
- package/dist/Chat/ChatComposerInput.d.ts.map +1 -1
- package/dist/Chat/ChatComposerInput.js +15 -27
- package/dist/Chat/ChatDictationButton.d.ts +1 -1
- package/dist/Chat/ChatDictationButton.d.ts.map +1 -1
- package/dist/Chat/ChatDictationButton.js +11 -13
- package/dist/Chat/ChatLayout.js +17 -17
- package/dist/Chat/ChatLayoutScrollButton.d.ts +1 -1
- package/dist/Chat/ChatLayoutScrollButton.d.ts.map +1 -1
- package/dist/Chat/ChatLayoutScrollButton.js +10 -12
- package/dist/Chat/ChatMessage.js +12 -12
- package/dist/Chat/ChatMessageBubble.js +7 -7
- package/dist/Chat/ChatMessageList.js +14 -14
- package/dist/Chat/ChatMessageMetadata.d.ts +1 -1
- package/dist/Chat/ChatMessageMetadata.d.ts.map +1 -1
- package/dist/Chat/ChatMessageMetadata.js +12 -14
- package/dist/Chat/ChatPastedTextToken.js +13 -13
- package/dist/Chat/ChatSendButton.js +3 -3
- package/dist/Chat/ChatSystemMessage.d.ts +1 -1
- package/dist/Chat/ChatSystemMessage.d.ts.map +1 -1
- package/dist/Chat/ChatSystemMessage.js +17 -17
- package/dist/Chat/ChatTokenizedText.d.ts +1 -1
- package/dist/Chat/ChatTokenizedText.d.ts.map +1 -1
- package/dist/Chat/ChatTokenizedText.js +15 -24
- package/dist/Chat/ChatToolCalls.d.ts.map +1 -1
- package/dist/Chat/ChatToolCalls.js +74 -81
- package/dist/Chat/index.d.ts +1 -1
- package/dist/Chat/index.d.ts.map +1 -1
- package/dist/Chat/useTriggerMenu.d.ts.map +1 -1
- package/dist/Chat/useTriggerMenu.js +15 -15
- package/dist/CheckboxInput/CheckboxInput.d.ts +1 -1
- package/dist/CheckboxInput/CheckboxInput.d.ts.map +1 -1
- package/dist/CheckboxInput/CheckboxInput.js +23 -25
- package/dist/CheckboxList/CheckboxList.js +9 -9
- package/dist/CheckboxList/CheckboxListItem.d.ts +1 -1
- package/dist/CheckboxList/CheckboxListItem.d.ts.map +1 -1
- package/dist/CheckboxList/CheckboxListItem.js +6 -8
- package/dist/Citation/Citation.js +10 -10
- package/dist/ClickableCard/ClickableCard.d.ts.map +1 -1
- package/dist/ClickableCard/ClickableCard.js +9 -32
- package/dist/Code/Code.js +3 -3
- package/dist/CodeBlock/CodeBlock.d.ts +1 -10
- package/dist/CodeBlock/CodeBlock.d.ts.map +1 -1
- package/dist/CodeBlock/CodeBlock.js +52 -88
- package/dist/Collapsible/Collapsible.d.ts +3 -9
- package/dist/Collapsible/Collapsible.d.ts.map +1 -1
- package/dist/Collapsible/Collapsible.js +22 -110
- package/dist/Collapsible/CollapsibleGroup.d.ts +7 -39
- package/dist/Collapsible/CollapsibleGroup.d.ts.map +1 -1
- package/dist/Collapsible/CollapsibleGroup.js +12 -73
- package/dist/Collapsible/CollapsibleGroupContext.d.ts +0 -31
- package/dist/Collapsible/CollapsibleGroupContext.d.ts.map +1 -1
- package/dist/Collapsible/CollapsibleGroupContext.js +3 -33
- package/dist/Collapsible/index.d.ts +0 -1
- package/dist/Collapsible/index.d.ts.map +1 -1
- package/dist/Collapsible/useCollapsible.d.ts +1 -4
- package/dist/Collapsible/useCollapsible.d.ts.map +1 -1
- package/dist/Collapsible/useCollapsible.js +6 -20
- package/dist/CommandPalette/CommandPalette.d.ts.map +1 -1
- package/dist/CommandPalette/CommandPalette.js +34 -36
- package/dist/CommandPalette/CommandPaletteEmpty.js +3 -3
- package/dist/CommandPalette/CommandPaletteFooter.js +16 -16
- package/dist/CommandPalette/CommandPaletteGroup.js +5 -5
- package/dist/CommandPalette/CommandPaletteInput.js +13 -13
- package/dist/CommandPalette/CommandPaletteItem.js +3 -3
- package/dist/CommandPalette/CommandPaletteList.js +3 -3
- package/dist/ContextMenu/ContextMenu.d.ts +2 -7
- package/dist/ContextMenu/ContextMenu.d.ts.map +1 -1
- package/dist/ContextMenu/ContextMenu.js +43 -76
- package/dist/DateInput/DateInput.js +18 -18
- package/dist/DateRangeInput/DateRangeInput.js +21 -21
- package/dist/DateTimeInput/DateTimeInput.d.ts +2 -5
- package/dist/DateTimeInput/DateTimeInput.d.ts.map +1 -1
- package/dist/DateTimeInput/DateTimeInput.js +26 -30
- package/dist/DateTimeInput/index.d.ts +1 -1
- package/dist/DateTimeInput/index.d.ts.map +1 -1
- package/dist/Dialog/Dialog.js +9 -9
- package/dist/Dialog/DialogHeader.js +16 -16
- package/dist/Dialog/useImperativeDialog.js +3 -3
- package/dist/Divider/Divider.js +7 -7
- package/dist/DropdownMenu/DropdownMenu.js +10 -10
- package/dist/DropdownMenu/DropdownMenuItem.d.ts +17 -2
- package/dist/DropdownMenu/DropdownMenuItem.d.ts.map +1 -1
- package/dist/DropdownMenu/DropdownMenuItem.js +3 -3
- package/dist/DropdownMenu/renderDropdownItems.js +10 -10
- package/dist/EmptyState/EmptyState.js +9 -9
- package/dist/Field/Field.js +17 -17
- package/dist/Field/FieldLabel.js +15 -15
- package/dist/Field/InputClearButton.js +5 -5
- package/dist/FieldStatus/FieldStatus.js +3 -3
- package/dist/FileInput/FileInput.js +29 -29
- package/dist/FormLayout/FormLayout.js +5 -5
- package/dist/Grid/Grid.d.ts +3 -4
- package/dist/Grid/Grid.d.ts.map +1 -1
- package/dist/Grid/Grid.js +12 -29
- package/dist/Grid/GridSpan.js +3 -3
- package/dist/HStack/HStack.js +3 -3
- package/dist/Heading/Heading.js +10 -10
- package/dist/HoverCard/HoverCard.js +9 -9
- package/dist/HoverCard/useHoverCard.d.ts +1 -5
- package/dist/HoverCard/useHoverCard.d.ts.map +1 -1
- package/dist/HoverCard/useHoverCard.js +3 -3
- package/dist/Icon/Icon.d.ts.map +1 -1
- package/dist/Icon/Icon.js +12 -16
- package/dist/Icon/defaultIcons.js +116 -116
- package/dist/IconButton/IconButton.js +3 -3
- package/dist/InputGroup/InputGroup.js +11 -11
- package/dist/InputGroup/InputGroupText.js +3 -3
- package/dist/Item/Item.js +18 -18
- package/dist/Kbd/Kbd.js +5 -5
- package/dist/Layer/LayerProvider.js +7 -7
- package/dist/Layer/useLayer.d.ts +2 -29
- package/dist/Layer/useLayer.d.ts.map +1 -1
- package/dist/Layer/useLayer.js +31 -44
- package/dist/Layout/Layout.js +21 -21
- package/dist/Layout/LayoutContent.js +3 -3
- package/dist/Layout/LayoutFooter.js +5 -5
- package/dist/Layout/LayoutHeader.js +5 -5
- package/dist/Layout/LayoutPanel.js +3 -3
- package/dist/Lightbox/Lightbox.d.ts.map +1 -1
- package/dist/Lightbox/Lightbox.js +31 -55
- package/dist/Lightbox/useLightbox.js +3 -3
- package/dist/Link/Link.js +15 -15
- package/dist/Link/LinkProvider.js +3 -3
- package/dist/Link/useLinkify.js +3 -3
- package/dist/List/List.js +11 -11
- package/dist/List/ListItem.js +11 -11
- package/dist/Markdown/Markdown.d.ts.map +1 -1
- package/dist/Markdown/Markdown.js +102 -102
- package/dist/MetadataList/MetadataList.js +10 -10
- package/dist/MetadataList/MetadataListItem.js +15 -15
- package/dist/MobileNav/MobileNav.d.ts +1 -1
- package/dist/MobileNav/MobileNav.d.ts.map +1 -1
- package/dist/MobileNav/MobileNav.js +23 -26
- package/dist/MobileNav/MobileNavToggle.js +5 -5
- package/dist/MoreMenu/MoreMenu.js +3 -3
- package/dist/MultiSelector/MultiSelector.js +56 -56
- package/dist/NavIcon/NavIcon.js +3 -3
- package/dist/NavMenu/NavHeadingMenu.js +5 -5
- package/dist/NavMenu/NavHeadingMenuItem.js +8 -8
- package/dist/NumberInput/NumberInput.d.ts.map +1 -1
- package/dist/NumberInput/NumberInput.js +32 -48
- package/dist/Outline/Outline.js +15 -15
- package/dist/OverflowList/OverflowList.js +8 -8
- package/dist/Overlay/Overlay.js +3 -3
- package/dist/Overlay/OverlayScrim.js +5 -5
- package/dist/Overlay/useOverlay.js +3 -3
- package/dist/Pagination/Pagination.d.ts +1 -1
- package/dist/Pagination/Pagination.d.ts.map +1 -1
- package/dist/Pagination/Pagination.js +72 -125
- package/dist/Popover/Popover.js +16 -16
- package/dist/Popover/usePopover.js +7 -7
- package/dist/PowerSearch/PowerSearch.d.ts.map +1 -1
- package/dist/PowerSearch/PowerSearch.js +92 -110
- package/dist/PowerSearch/PowerSearchEditPopover.js +84 -84
- package/dist/PowerSearch/PowerSearchFilterEditor.js +3 -3
- package/dist/PowerSearch/PowerSearchToken.js +5 -5
- package/dist/PowerSearch/PowerSearchValueEditor.js +54 -54
- package/dist/ProgressBar/ProgressBar.d.ts.map +1 -1
- package/dist/ProgressBar/ProgressBar.js +18 -25
- package/dist/RadioList/RadioList.js +7 -7
- package/dist/RadioList/RadioListItem.d.ts +1 -1
- package/dist/RadioList/RadioListItem.d.ts.map +1 -1
- package/dist/RadioList/RadioListItem.js +21 -24
- package/dist/Resizable/ResizeHandle.d.ts.map +1 -1
- package/dist/Resizable/ResizeHandle.js +10 -28
- package/dist/Section/Section.js +5 -5
- package/dist/SegmentedControl/SegmentedControl.d.ts +1 -1
- package/dist/SegmentedControl/SegmentedControl.d.ts.map +1 -1
- package/dist/SegmentedControl/SegmentedControl.js +10 -32
- package/dist/SegmentedControl/SegmentedControlItem.d.ts +1 -1
- package/dist/SegmentedControl/SegmentedControlItem.d.ts.map +1 -1
- package/dist/SegmentedControl/SegmentedControlItem.js +12 -18
- package/dist/SelectableCard/SelectableCard.js +5 -5
- package/dist/Selector/Selector.js +46 -46
- package/dist/Selector/SelectorOption.js +3 -3
- package/dist/SideNav/SideNav.d.ts.map +1 -1
- package/dist/SideNav/SideNav.js +34 -38
- package/dist/SideNav/SideNavCollapseButton.d.ts +1 -1
- package/dist/SideNav/SideNavCollapseButton.d.ts.map +1 -1
- package/dist/SideNav/SideNavCollapseButton.js +6 -8
- package/dist/SideNav/SideNavHeading.js +87 -87
- package/dist/SideNav/SideNavItem.js +42 -42
- package/dist/SideNav/SideNavSection.d.ts +1 -1
- package/dist/SideNav/SideNavSection.d.ts.map +1 -1
- package/dist/SideNav/SideNavSection.js +16 -18
- package/dist/Skeleton/Skeleton.js +3 -3
- package/dist/Slider/Slider.js +23 -23
- package/dist/Spinner/Spinner.js +9 -9
- package/dist/StatusDot/StatusDot.js +5 -5
- package/dist/Switch/Switch.d.ts +4 -8
- package/dist/Switch/Switch.d.ts.map +1 -1
- package/dist/Switch/Switch.js +29 -34
- package/dist/TabList/Tab.js +18 -18
- package/dist/TabList/TabList.js +5 -5
- package/dist/TabList/TabMenu.d.ts.map +1 -1
- package/dist/TabList/TabMenu.js +30 -57
- package/dist/TabList/tab.markers.stylex.d.ts +1 -1
- package/dist/Table/BaseTable.d.ts.map +1 -1
- package/dist/Table/BaseTable.js +39 -50
- package/dist/Table/Table.js +7 -7
- package/dist/Table/TableBody.d.ts +1 -1
- package/dist/Table/TableBody.d.ts.map +1 -1
- package/dist/Table/TableBody.js +5 -9
- package/dist/Table/TableCell.js +3 -3
- package/dist/Table/TableFooter.d.ts +1 -1
- package/dist/Table/TableFooter.d.ts.map +1 -1
- package/dist/Table/TableFooter.js +5 -9
- package/dist/Table/TableHeader.d.ts +1 -1
- package/dist/Table/TableHeader.d.ts.map +1 -1
- package/dist/Table/TableHeader.js +5 -9
- package/dist/Table/TableHeaderCell.js +3 -3
- package/dist/Table/TableRow.js +5 -5
- package/dist/Table/plugins/columnResize/useTableColumnResize.d.ts.map +1 -1
- package/dist/Table/plugins/columnResize/useTableColumnResize.js +11 -14
- package/dist/Table/plugins/filtering/useTableFiltering.js +71 -71
- package/dist/Table/plugins/pagination/paginateData.d.ts.map +1 -1
- package/dist/Table/plugins/pagination/paginateData.js +1 -5
- package/dist/Table/plugins/pagination/useTablePagination.js +7 -7
- package/dist/Table/plugins/rowExpansion/useTableRowExpansion.js +22 -22
- package/dist/Table/plugins/selection/useTableSelection.js +18 -18
- package/dist/Table/plugins/selection/useTableSelectionState.d.ts.map +1 -1
- package/dist/Table/plugins/selection/useTableSelectionState.js +1 -11
- package/dist/Table/plugins/sortable/useTableSortable.js +17 -17
- package/dist/Table/plugins/sortable/useTableSortableState.d.ts.map +1 -1
- package/dist/Table/plugins/sortable/useTableSortableState.js +4 -8
- package/dist/Table/tableContextMenu.js +9 -9
- package/dist/Text/Text.js +10 -10
- package/dist/TextArea/TextArea.js +14 -14
- package/dist/TextInput/TextInput.js +15 -15
- package/dist/Thumbnail/Thumbnail.d.ts +2 -3
- package/dist/Thumbnail/Thumbnail.d.ts.map +1 -1
- package/dist/Thumbnail/Thumbnail.js +29 -30
- package/dist/TimeInput/TimeInput.d.ts.map +1 -1
- package/dist/TimeInput/TimeInput.js +21 -26
- package/dist/Timestamp/Timestamp.d.ts +1 -1
- package/dist/Timestamp/Timestamp.d.ts.map +1 -1
- package/dist/Timestamp/Timestamp.js +26 -37
- package/dist/Toast/Toast.d.ts.map +1 -1
- package/dist/Toast/Toast.js +17 -25
- package/dist/Toast/ToastViewport.d.ts.map +1 -1
- package/dist/Toast/ToastViewport.js +11 -23
- package/dist/Toast/useToast.d.ts.map +1 -1
- package/dist/Toast/useToast.js +4 -44
- package/dist/ToggleButton/ToggleButton.js +12 -12
- package/dist/ToggleButton/ToggleButtonGroup.js +5 -5
- package/dist/Token/Token.js +21 -21
- package/dist/Tokenizer/Tokenizer.d.ts.map +1 -1
- package/dist/Tokenizer/Tokenizer.js +34 -36
- package/dist/Toolbar/Toolbar.js +18 -18
- package/dist/Tooltip/Tooltip.js +11 -11
- package/dist/Tooltip/useTooltip.d.ts +1 -5
- package/dist/Tooltip/useTooltip.d.ts.map +1 -1
- package/dist/Tooltip/useTooltip.js +3 -3
- package/dist/TopNav/TopNav.js +32 -32
- package/dist/TopNav/TopNavHeading.js +67 -67
- package/dist/TopNav/TopNavItem.js +5 -5
- package/dist/TopNav/TopNavMegaMenu.js +30 -30
- package/dist/TopNav/TopNavMegaMenuFeaturedCard.d.ts +1 -1
- package/dist/TopNav/TopNavMegaMenuFeaturedCard.d.ts.map +1 -1
- package/dist/TopNav/TopNavMegaMenuFeaturedCard.js +14 -25
- package/dist/TopNav/TopNavMegaMenuItem.js +16 -16
- package/dist/TopNav/TopNavMenu.js +32 -32
- package/dist/TreeList/TreeList.js +8 -8
- package/dist/TreeList/TreeListBranches.js +11 -11
- package/dist/TreeList/TreeListItem.js +30 -30
- package/dist/Typeahead/BaseTypeahead.d.ts.map +1 -1
- package/dist/Typeahead/BaseTypeahead.js +20 -23
- package/dist/Typeahead/Typeahead.js +12 -12
- package/dist/Typeahead/TypeaheadItem.js +10 -10
- package/dist/VStack/VStack.js +3 -3
- package/dist/astryx.css +0 -7
- package/dist/astryx.umd.js +59 -59
- package/dist/astryx.umd.js.map +4 -4
- package/dist/docs-types.d.ts +2 -8
- package/dist/docs-types.d.ts.map +1 -1
- package/dist/hooks/focusableSelector.d.ts +1 -1
- package/dist/hooks/focusableSelector.d.ts.map +1 -1
- package/dist/hooks/focusableSelector.js +1 -1
- package/dist/hooks/index.d.ts +0 -2
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/hooks/index.js +0 -1
- package/dist/hooks/useFocusTrap.d.ts +0 -3
- package/dist/hooks/useFocusTrap.d.ts.map +1 -1
- package/dist/hooks/useFocusTrap.js +1 -38
- package/dist/hooks/useInteractiveRole.d.ts +2 -6
- package/dist/hooks/useInteractiveRole.d.ts.map +1 -1
- package/dist/hooks/useInteractiveRole.js +2 -6
- package/dist/hooks/useKeyboardHint.js +9 -9
- package/dist/hooks/useStreamingText.d.ts +1 -3
- package/dist/hooks/useStreamingText.d.ts.map +1 -1
- package/dist/hooks/useStreamingText.js +5 -14
- package/dist/theme/MediaTheme.js +3 -3
- package/dist/theme/Theme.js +7 -7
- package/dist/theme/defineTheme.d.ts +1 -1
- package/dist/theme/defineTheme.d.ts.map +1 -1
- package/dist/theme/expandColorScale.d.ts.map +1 -1
- package/dist/theme/expandColorScale.js +3 -10
- package/dist/theme/hct.d.ts +15 -0
- package/dist/theme/hct.d.ts.map +1 -1
- package/dist/theme/hct.js +9 -9
- package/dist/theme/syntax/SyntaxTheme.js +5 -5
- package/dist/theme/tokens.d.ts +2 -10
- package/dist/theme/tokens.d.ts.map +1 -1
- package/dist/theme/tokens.js +4 -220
- package/dist/theme/useTheme.d.ts +2 -3
- package/dist/theme/useTheme.d.ts.map +1 -1
- package/dist/theme/useTheme.js +6 -73
- package/dist/utils/index.d.ts +0 -3
- package/dist/utils/index.d.ts.map +1 -1
- package/dist/utils/index.js +1 -3
- package/dist/utils/timeParser.d.ts.map +1 -1
- package/dist/utils/timeParser.js +5 -8
- package/package.json +3 -3
- package/src/AlertDialog/AlertDialog.doc.mjs +0 -4
- package/src/AlertDialog/AlertDialog.tsx +0 -2
- package/src/AppShell/AppShell.tsx +0 -2
- package/src/AspectRatio/AspectRatio.doc.mjs +1 -28
- package/src/AspectRatio/AspectRatio.test.tsx +1 -142
- package/src/AspectRatio/AspectRatio.tsx +10 -70
- package/src/AspectRatio/index.ts +1 -5
- package/src/Avatar/Avatar.doc.mjs +0 -11
- package/src/Avatar/Avatar.test.tsx +1 -32
- package/src/Avatar/Avatar.tsx +20 -12
- package/src/AvatarGroup/AvatarGroup.doc.mjs +0 -1
- package/src/Banner/Banner.doc.mjs +0 -8
- package/src/Banner/Banner.test.tsx +0 -38
- package/src/Banner/Banner.tsx +1 -8
- package/src/Calendar/Calendar.doc.mjs +1 -1
- package/src/Calendar/Calendar.test.tsx +17 -122
- package/src/Calendar/Calendar.tsx +5 -26
- package/src/Calendar/dayCellUtils.ts +1 -3
- package/src/Calendar/styles.ts +2 -12
- package/src/Card/Card.doc.mjs +1 -1
- package/src/Card/Card.tsx +6 -16
- package/src/Carousel/Carousel.doc.mjs +12 -12
- package/src/Carousel/Carousel.test.tsx +0 -13
- package/src/Carousel/Carousel.tsx +2 -4
- package/src/Carousel/carousel.markers.stylex.ts +10 -0
- package/src/Chat/Chat.doc.mjs +1 -1
- package/src/Chat/ChatComposerInput.test.tsx +1 -27
- package/src/Chat/ChatComposerInput.tsx +15 -20
- package/src/Chat/ChatDictationButton.tsx +4 -4
- package/src/Chat/ChatLayoutScrollButton.tsx +1 -3
- package/src/Chat/ChatMessageMetadata.tsx +6 -4
- package/src/Chat/ChatSystemMessage.test.tsx +11 -26
- package/src/Chat/ChatSystemMessage.tsx +7 -7
- package/src/Chat/ChatTokenizedText.test.tsx +16 -29
- package/src/Chat/ChatTokenizedText.tsx +8 -15
- package/src/Chat/ChatToolCalls.test.tsx +0 -55
- package/src/Chat/ChatToolCalls.tsx +12 -10
- package/src/Chat/index.ts +4 -1
- package/src/Chat/useTriggerMenu.tsx +4 -1
- package/src/CheckboxInput/CheckboxInput.doc.mjs +3 -3
- package/src/CheckboxInput/CheckboxInput.test.tsx +4 -71
- package/src/CheckboxInput/CheckboxInput.tsx +0 -2
- package/src/CheckboxList/CheckboxList.test.tsx +0 -19
- package/src/CheckboxList/CheckboxListItem.tsx +2 -11
- package/src/Citation/Citation.doc.mjs +0 -5
- package/src/ClickableCard/ClickableCard.tsx +2 -45
- package/src/CodeBlock/CodeBlock.doc.mjs +2 -7
- package/src/CodeBlock/CodeBlock.test.tsx +3 -122
- package/src/CodeBlock/CodeBlock.tsx +4 -62
- package/src/Collapsible/Collapsible.doc.mjs +4 -8
- package/src/Collapsible/Collapsible.tsx +10 -86
- package/src/Collapsible/CollapsibleGroup.doc.mjs +3 -27
- package/src/Collapsible/CollapsibleGroup.test.tsx +0 -318
- package/src/Collapsible/CollapsibleGroup.tsx +9 -107
- package/src/Collapsible/CollapsibleGroupContext.tsx +2 -42
- package/src/Collapsible/index.ts +0 -4
- package/src/Collapsible/useCollapsible.ts +6 -20
- package/src/CommandPalette/CommandPalette.doc.mjs +0 -5
- package/src/CommandPalette/CommandPalette.tsx +3 -5
- package/src/CommandPalette/CommandPaletteEmpty.doc.mjs +0 -5
- package/src/CommandPalette/CommandPaletteGroup.doc.mjs +0 -10
- package/src/CommandPalette/CommandPaletteInput.doc.mjs +0 -6
- package/src/CommandPalette/CommandPaletteItem.doc.mjs +0 -6
- package/src/CommandPalette/CommandPaletteList.doc.mjs +0 -9
- package/src/ContextMenu/ContextMenu.doc.mjs +0 -15
- package/src/ContextMenu/ContextMenu.test.tsx +0 -87
- package/src/ContextMenu/ContextMenu.tsx +28 -87
- package/src/ContextMenu/ContextMenuItem.doc.mjs +0 -6
- package/src/DateInput/DateInput.test.tsx +20 -11
- package/src/DateRangeInput/DateRangeInput.test.tsx +44 -31
- package/src/DateTimeInput/DateTimeInput.doc.mjs +2 -3
- package/src/DateTimeInput/DateTimeInput.test.tsx +16 -118
- package/src/DateTimeInput/DateTimeInput.tsx +2 -8
- package/src/DateTimeInput/index.ts +0 -1
- package/src/Dialog/Dialog.doc.mjs +0 -4
- package/src/Dialog/DialogHeader.doc.mjs +0 -45
- package/src/DropdownMenu/DropdownMenu.doc.mjs +1 -1
- package/src/DropdownMenu/DropdownMenu.test.tsx +2 -22
- package/src/DropdownMenu/DropdownMenuItem.tsx +17 -5
- package/src/EmptyState/EmptyState.doc.mjs +1 -1
- package/src/Field/Field.test.tsx +4 -1
- package/src/Field/FieldLabel.test.tsx +2 -2
- package/src/FormLayout/__snapshots__/FormLayout.test.tsx.snap +3 -0
- package/src/Grid/Grid.test.tsx +18 -43
- package/src/Grid/Grid.tsx +9 -26
- package/src/HoverCard/HoverCard.doc.mjs +6 -6
- package/src/HoverCard/useHoverCard.doc.mjs +5 -5
- package/src/HoverCard/useHoverCard.tsx +2 -9
- package/src/Icon/Icon.test.tsx +29 -41
- package/src/Icon/Icon.tsx +2 -6
- package/src/InputGroup/InputGroup.doc.mjs +0 -1
- package/src/InputGroup/InputGroup.tsx +2 -2
- package/src/Item/Item.tsx +1 -1
- package/src/Layer/useLayer.doc.mjs +2 -2
- package/src/Layer/useLayer.test.tsx +2 -221
- package/src/Layer/useLayer.tsx +30 -69
- package/src/Layout/LayoutContent.doc.mjs +0 -12
- package/src/Layout/LayoutPanel.doc.mjs +0 -40
- package/src/Lightbox/Lightbox.doc.mjs +0 -5
- package/src/Lightbox/Lightbox.test.tsx +2 -123
- package/src/Lightbox/Lightbox.tsx +1 -29
- package/src/Markdown/Markdown.tsx +7 -9
- package/src/Markdown/parser.perf.test.ts +12 -34
- package/src/MobileNav/MobileNav.test.tsx +0 -56
- package/src/MobileNav/MobileNav.tsx +8 -13
- package/src/NavMenu/NavMenu.doc.mjs +0 -15
- package/src/NumberInput/NumberInput.test.tsx +3 -48
- package/src/NumberInput/NumberInput.tsx +15 -32
- package/src/Outline/Outline.doc.mjs +0 -2
- package/src/Overlay/Overlay.doc.mjs +0 -6
- package/src/Pagination/Pagination.test.tsx +0 -162
- package/src/Pagination/Pagination.tsx +26 -80
- package/src/Popover/Popover.doc.mjs +6 -6
- package/src/Popover/Popover.test.tsx +0 -65
- package/src/Popover/usePopover.doc.mjs +1 -1
- package/src/PowerSearch/PowerSearch.doc.mjs +2 -2
- package/src/PowerSearch/PowerSearch.test.tsx +1 -109
- package/src/PowerSearch/PowerSearch.tsx +16 -37
- package/src/ProgressBar/ProgressBar.doc.mjs +0 -2
- package/src/ProgressBar/ProgressBar.test.tsx +0 -30
- package/src/ProgressBar/ProgressBar.tsx +5 -12
- package/src/RadioList/RadioList.test.tsx +0 -19
- package/src/RadioList/RadioListItem.tsx +4 -9
- package/src/Resizable/ResizeHandle.tsx +4 -22
- package/src/SegmentedControl/SegmentedControl.doc.mjs +1 -1
- package/src/SegmentedControl/SegmentedControl.test.tsx +0 -192
- package/src/SegmentedControl/SegmentedControl.tsx +5 -27
- package/src/SegmentedControl/SegmentedControlItem.tsx +4 -9
- package/src/SelectableCard/SelectableCard.doc.mjs +1 -1
- package/src/Selector/Selector.test.tsx +1 -27
- package/src/SideNav/SideNav.doc.mjs +1 -7
- package/src/SideNav/SideNav.test.tsx +0 -66
- package/src/SideNav/SideNav.tsx +2 -6
- package/src/SideNav/SideNavCollapseButton.tsx +3 -4
- package/src/SideNav/SideNavSection.tsx +4 -6
- package/src/Switch/Switch.doc.mjs +7 -7
- package/src/Switch/Switch.test.tsx +3 -102
- package/src/Switch/Switch.tsx +7 -20
- package/src/TabList/TabList.test.tsx +1 -185
- package/src/TabList/TabMenu.tsx +9 -45
- package/src/Table/BaseTable.tsx +2 -13
- package/src/Table/Table.doc.mjs +0 -5
- package/src/Table/Table.test.tsx +0 -87
- package/src/Table/TableBody.tsx +2 -15
- package/src/Table/TableFooter.tsx +2 -15
- package/src/Table/TableHeader.tsx +2 -15
- package/src/Table/plugins/columnResize/useTableColumnResize.test.tsx +0 -13
- package/src/Table/plugins/columnResize/useTableColumnResize.tsx +1 -3
- package/src/Table/plugins/pagination/paginateData.ts +1 -5
- package/src/Table/plugins/pagination/useTablePagination.test.tsx +0 -13
- package/src/Table/plugins/selection/useTableSelectionState.test.tsx +0 -23
- package/src/Table/plugins/selection/useTableSelectionState.tsx +6 -11
- package/src/Table/plugins/sortable/useTableSortableState.test.tsx +1 -35
- package/src/Table/plugins/sortable/useTableSortableState.tsx +4 -8
- package/src/TextArea/TextArea.test.tsx +3 -3
- package/src/TextInput/TextInput.test.tsx +3 -3
- package/src/Thumbnail/Thumbnail.test.tsx +2 -36
- package/src/Thumbnail/Thumbnail.tsx +2 -4
- package/src/TimeInput/TimeInput.test.tsx +0 -37
- package/src/TimeInput/TimeInput.tsx +1 -11
- package/src/Timestamp/Timestamp.doc.mjs +1 -1
- package/src/Timestamp/Timestamp.test.tsx +0 -52
- package/src/Timestamp/Timestamp.tsx +16 -30
- package/src/Toast/Toast.tsx +3 -11
- package/src/Toast/ToastViewport.test.tsx +0 -64
- package/src/Toast/ToastViewport.tsx +0 -12
- package/src/Toast/useToast.tsx +0 -41
- package/src/ToggleButton/ToggleButton.doc.mjs +0 -1
- package/src/Tokenizer/Tokenizer.doc.mjs +2 -2
- package/src/Tokenizer/Tokenizer.test.tsx +0 -54
- package/src/Tokenizer/Tokenizer.tsx +4 -5
- package/src/Tooltip/Tooltip.doc.mjs +6 -6
- package/src/Tooltip/useTooltip.doc.mjs +5 -5
- package/src/Tooltip/useTooltip.tsx +2 -12
- package/src/TopNav/TopNav.doc.mjs +1 -1
- package/src/TopNav/TopNav.test.tsx +7 -23
- package/src/TopNav/TopNavMegaMenuFeaturedCard.tsx +2 -9
- package/src/TreeList/TreeList.doc.mjs +2 -2
- package/src/Typeahead/BaseTypeahead.doc.mjs +0 -19
- package/src/Typeahead/BaseTypeahead.tsx +2 -5
- package/src/Typeahead/Typeahead.doc.mjs +1 -1
- package/src/Typeahead/Typeahead.test.tsx +1 -45
- package/src/docs-types.ts +1 -9
- package/src/hooks/focusableSelector.ts +1 -1
- package/src/hooks/index.ts +0 -3
- package/src/hooks/useFocusTrap.doc.mjs +2 -4
- package/src/hooks/useFocusTrap.test.tsx +1 -149
- package/src/hooks/useFocusTrap.ts +1 -50
- package/src/hooks/useInteractiveRole.ts +4 -12
- package/src/hooks/useStreamingText.test.ts +19 -54
- package/src/hooks/useStreamingText.ts +5 -16
- package/src/hooks/useTreeFocus.test.tsx +3 -1
- package/src/reset.css +0 -29
- package/src/theme/SyntaxTheme.doc.mjs +4 -4
- package/src/theme/defineTheme.ts +13 -4
- package/src/theme/derivedVarRegistry.test.ts +2 -2
- package/src/theme/expandColorScale.test.ts +0 -29
- package/src/theme/expandColorScale.ts +6 -11
- package/src/theme/hct.ts +17 -9
- package/src/theme/tokens.test.ts +9 -182
- package/src/theme/tokens.ts +4 -239
- package/src/theme/useTheme.test.tsx +2 -126
- package/src/theme/useTheme.ts +6 -87
- package/src/utils/index.ts +0 -4
- package/src/utils/sharedResizeObserver.test.ts +2 -2
- package/src/utils/timeParser.test.ts +0 -13
- package/src/utils/timeParser.ts +5 -8
- package/dist/hooks/useHotkeys.d.ts +0 -51
- package/dist/hooks/useHotkeys.d.ts.map +0 -1
- package/dist/hooks/useHotkeys.js +0 -160
- package/dist/utils/color.d.ts +0 -42
- package/dist/utils/color.d.ts.map +0 -1
- package/dist/utils/color.js +0 -150
- package/dist/utils/composeEventHandlers.d.ts +0 -30
- package/dist/utils/composeEventHandlers.d.ts.map +0 -1
- package/dist/utils/composeEventHandlers.js +0 -40
- package/src/Chat/ChatDictationButton.test.tsx +0 -43
- package/src/Chat/ChatLayoutScrollButton.test.tsx +0 -33
- package/src/Chat/ChatMessageMetadata.test.tsx +0 -32
- package/src/Collapsible/Collapsible.test.tsx +0 -405
- package/src/FieldStatus/FieldStatus.test.tsx +0 -282
- package/src/InteractiveRoleContext/InteractiveRoleContext.test.tsx +0 -185
- package/src/Layout/Layout.test.tsx +0 -285
- package/src/Layout/LayoutSlots.test.tsx +0 -364
- package/src/Outline/parseOutlineFromMarkdown.test.ts +0 -80
- package/src/OverflowList/OverflowList.test.tsx +0 -416
- package/src/Overlay/Overlay.test.tsx +0 -356
- package/src/Resizable/ResizeHandle.test.tsx +0 -218
- package/src/SizeContext/SizeContext.test.tsx +0 -226
- package/src/Toast/useToast.test.tsx +0 -258
- package/src/__tests__/TestIcon.tsx +0 -26
- package/src/__tests__/fastRoleQueries.ts +0 -66
- package/src/docPropReferences.test.ts +0 -178
- package/src/hooks/useHotkeys.doc.mjs +0 -52
- package/src/hooks/useHotkeys.test.ts +0 -245
- package/src/hooks/useHotkeys.ts +0 -203
- package/src/theme/themingTargets.test.ts +0 -353
- package/src/utils/color.test.ts +0 -133
- package/src/utils/color.ts +0 -148
- package/src/utils/composeEventHandlers.test.ts +0 -71
- package/src/utils/composeEventHandlers.ts +0 -44
- package/src/utils/mergeProps.test.ts +0 -166
|
@@ -1,178 +0,0 @@
|
|
|
1
|
-
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
-
|
|
3
|
-
/* eslint-disable @typescript-eslint/no-require-imports */
|
|
4
|
-
/**
|
|
5
|
-
* @file Guards doc prose against docs/source prop mismatches (#3360).
|
|
6
|
-
*
|
|
7
|
-
* Scans every {Name}.doc.mjs for prose phrases like "the foo prop on Bar"
|
|
8
|
-
* and verifies the referenced prop is documented on the referenced
|
|
9
|
-
* component. Doc prose is LLM training signal: a reference to a prop that
|
|
10
|
-
* doesn't exist steers codegen toward hallucinated APIs (#3360 shipped a
|
|
11
|
-
* bullet pointing at a nonexistent CodeBlock syntaxTheme prop).
|
|
12
|
-
*
|
|
13
|
-
* A reference to a missing prop is allowed only when the same string
|
|
14
|
-
* explicitly negates it ("no such prop exists" / "does not exist"), the
|
|
15
|
-
* corrective-bullet pattern used to counter known hallucinations.
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
import {describe, it, expect} from 'vitest';
|
|
19
|
-
import {readdirSync} from 'node:fs';
|
|
20
|
-
import {join, relative} from 'node:path';
|
|
21
|
-
|
|
22
|
-
const SRC_DIR = __dirname;
|
|
23
|
-
|
|
24
|
-
type DocModule = {
|
|
25
|
-
docs?: {
|
|
26
|
-
name?: string;
|
|
27
|
-
props?: {name: string}[];
|
|
28
|
-
components?: {name?: string; props?: {name: string}[]}[];
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
|
-
|
|
32
|
-
/**
|
|
33
|
-
* Props intentionally omitted from doc props[]: PropDoc in docs-types.ts
|
|
34
|
-
* says to skip internal/styling props, so prose may reference them even
|
|
35
|
-
* though no doc lists them.
|
|
36
|
-
*/
|
|
37
|
-
const UNIVERSAL_PROPS = new Set([
|
|
38
|
-
'xstyle',
|
|
39
|
-
'className',
|
|
40
|
-
'style',
|
|
41
|
-
'ref',
|
|
42
|
-
'data-testid',
|
|
43
|
-
]);
|
|
44
|
-
|
|
45
|
-
/**
|
|
46
|
-
* Matches prose like "the foo prop on Bar", "foo prop of Bar", and
|
|
47
|
-
* conjunction targets: "foo prop on Bar or Baz". Group 1 is the prop
|
|
48
|
-
* (camelCase, lowercase first letter), group 2 the component name list.
|
|
49
|
-
*/
|
|
50
|
-
const PROP_REF_PATTERN =
|
|
51
|
-
/\b([a-z][A-Za-z0-9]*) prop (?:on|of) (?:the )?([A-Z][A-Za-z0-9]*(?:(?:,(?: and| or)?| and| or) [A-Z][A-Za-z0-9]*)*)/g;
|
|
52
|
-
|
|
53
|
-
/** A same-string negation marks the reference as a deliberate counter-signal. */
|
|
54
|
-
const NEGATION_PATTERN = /no such prop|does not exist|doesn't exist/i;
|
|
55
|
-
|
|
56
|
-
function findDocFiles(dir: string): string[] {
|
|
57
|
-
const files: string[] = [];
|
|
58
|
-
for (const entry of readdirSync(dir, {withFileTypes: true})) {
|
|
59
|
-
const full = join(dir, entry.name);
|
|
60
|
-
if (entry.isDirectory()) {
|
|
61
|
-
files.push(...findDocFiles(full));
|
|
62
|
-
} else if (entry.name.endsWith('.doc.mjs')) {
|
|
63
|
-
files.push(full);
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
return files;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
/** Collect every string value reachable from a doc module export. */
|
|
70
|
-
function collectStrings(value: unknown, out: string[]): void {
|
|
71
|
-
if (typeof value === 'string') {
|
|
72
|
-
out.push(value);
|
|
73
|
-
} else if (Array.isArray(value)) {
|
|
74
|
-
for (const item of value) {
|
|
75
|
-
collectStrings(item, out);
|
|
76
|
-
}
|
|
77
|
-
} else if (value && typeof value === 'object') {
|
|
78
|
-
for (const item of Object.values(value)) {
|
|
79
|
-
collectStrings(item, out);
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
const docFiles = findDocFiles(SRC_DIR);
|
|
85
|
-
|
|
86
|
-
// Component name → documented prop names, from every doc file's props[]
|
|
87
|
-
// (single and sub-component docs) and inline components[] entries.
|
|
88
|
-
const documentedProps = new Map<string, Set<string>>();
|
|
89
|
-
for (const file of docFiles) {
|
|
90
|
-
const mod = require(file) as DocModule;
|
|
91
|
-
const docs = mod.docs;
|
|
92
|
-
if (!docs) {
|
|
93
|
-
continue;
|
|
94
|
-
}
|
|
95
|
-
const entries = [
|
|
96
|
-
{name: docs.name, props: docs.props},
|
|
97
|
-
...(docs.components || []),
|
|
98
|
-
];
|
|
99
|
-
for (const {name, props} of entries) {
|
|
100
|
-
if (!name || !Array.isArray(props)) {
|
|
101
|
-
continue;
|
|
102
|
-
}
|
|
103
|
-
const set = documentedProps.get(name) || new Set<string>();
|
|
104
|
-
for (const prop of props) {
|
|
105
|
-
set.add(prop.name);
|
|
106
|
-
}
|
|
107
|
-
documentedProps.set(name, set);
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
interface Violation {
|
|
112
|
-
file: string;
|
|
113
|
-
component: string;
|
|
114
|
-
prop: string;
|
|
115
|
-
excerpt: string;
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
function findViolations(): Violation[] {
|
|
119
|
-
const violations: Violation[] = [];
|
|
120
|
-
for (const file of docFiles) {
|
|
121
|
-
const strings: string[] = [];
|
|
122
|
-
collectStrings(require(file), strings);
|
|
123
|
-
for (const text of strings) {
|
|
124
|
-
let match;
|
|
125
|
-
while ((match = PROP_REF_PATTERN.exec(text)) !== null) {
|
|
126
|
-
const [, prop, componentList] = match;
|
|
127
|
-
if (UNIVERSAL_PROPS.has(prop) || NEGATION_PATTERN.test(text)) {
|
|
128
|
-
continue;
|
|
129
|
-
}
|
|
130
|
-
for (const component of componentList.split(
|
|
131
|
-
/,(?: and| or)?| and | or /,
|
|
132
|
-
)) {
|
|
133
|
-
const name = component.trim();
|
|
134
|
-
if (!name) {
|
|
135
|
-
continue;
|
|
136
|
-
}
|
|
137
|
-
const known = documentedProps.get(name);
|
|
138
|
-
if (known && !known.has(prop)) {
|
|
139
|
-
violations.push({
|
|
140
|
-
file: relative(SRC_DIR, file),
|
|
141
|
-
component: name,
|
|
142
|
-
prop,
|
|
143
|
-
excerpt: text.slice(
|
|
144
|
-
Math.max(0, match.index - 40),
|
|
145
|
-
match.index + match[0].length + 20,
|
|
146
|
-
),
|
|
147
|
-
});
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
}
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
return violations;
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
describe('doc prose prop references', () => {
|
|
157
|
-
it('sanity: discovers doc files and documented components', () => {
|
|
158
|
-
expect(docFiles.length).toBeGreaterThan(0);
|
|
159
|
-
expect(documentedProps.size).toBeGreaterThan(0);
|
|
160
|
-
});
|
|
161
|
-
|
|
162
|
-
it('every "X prop on Y" reference names a documented prop of Y', () => {
|
|
163
|
-
const violations = findViolations();
|
|
164
|
-
expect(
|
|
165
|
-
violations,
|
|
166
|
-
violations
|
|
167
|
-
.map(
|
|
168
|
-
v =>
|
|
169
|
-
`${v.file} references prop "${v.prop}" on ${v.component}, ` +
|
|
170
|
-
`which does not document it (…${v.excerpt}…). Either the prop ` +
|
|
171
|
-
`doesn't exist (fix the prose; negate with "no such prop ` +
|
|
172
|
-
`exists" if countering a known hallucination) or it exists in ` +
|
|
173
|
-
`source but is missing from the component's doc props[] (add it).`,
|
|
174
|
-
)
|
|
175
|
-
.join('\n'),
|
|
176
|
-
).toEqual([]);
|
|
177
|
-
});
|
|
178
|
-
});
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
-
|
|
3
|
-
/** @type {import('../docs-types').HookDoc} */
|
|
4
|
-
export const docs = {
|
|
5
|
-
name: 'useHotkeys',
|
|
6
|
-
displayName: 'useHotkeys',
|
|
7
|
-
keywords: ['hotkey', 'shortcut', 'keyboard', 'keydown', 'command', 'palette', 'mod', 'cmd', 'ctrl', 'kbd'],
|
|
8
|
-
params: [
|
|
9
|
-
{
|
|
10
|
-
name: 'hotkeys',
|
|
11
|
-
type: 'Hotkey[]',
|
|
12
|
-
description:
|
|
13
|
-
'Shortcut registrations. Each entry: `{ keys, onPress, allowInInputs?, isDisabled? }`. `keys` is a "+"-separated combo like "mod+k", "shift+/", "escape" — "mod" is ⌘ on macOS and Ctrl elsewhere. `onPress` receives the KeyboardEvent after preventDefault(). `allowInInputs` (default false) lets the hotkey fire while typing in inputs/textareas/selects/contenteditable. `isDisabled` temporarily disables the entry.',
|
|
14
|
-
required: true,
|
|
15
|
-
},
|
|
16
|
-
],
|
|
17
|
-
returns: [],
|
|
18
|
-
usage: {
|
|
19
|
-
description:
|
|
20
|
-
'Registers global keyboard shortcuts with a single window keydown listener per hook instance. Handlers live in a ref, so re-renders never re-subscribe. Skips events from typing targets (input, textarea, select, contenteditable) unless allowInInputs, skips defaultPrevented events, and calls preventDefault() on match. SSR-safe.',
|
|
21
|
-
bestPractices: [
|
|
22
|
-
{ guidance: true, description: 'Use for app-level shortcuts like command palettes (mod+k), help overlays (shift+/), and navigation keys.' },
|
|
23
|
-
{ guidance: true, description: 'Pair with the Kbd component to display the same combo you register — both resolve "mod" per platform identically.' },
|
|
24
|
-
{ guidance: true, description: 'Use isDisabled to suspend shortcuts while a modal or wizard owns the keyboard, instead of unmounting the hook.' },
|
|
25
|
-
{ guidance: false, description: 'Use for focus-scoped keyboard navigation inside a widget; use useListFocus or useGridFocus instead.' },
|
|
26
|
-
],
|
|
27
|
-
},
|
|
28
|
-
relatedComponents: ['Kbd'],
|
|
29
|
-
relatedHooks: ['useListFocus', 'useGridFocus'],
|
|
30
|
-
importPath: '@astryxdesign/core/hooks',
|
|
31
|
-
category: 'interaction',
|
|
32
|
-
};
|
|
33
|
-
|
|
34
|
-
/** @type {import('../docs-types').HookTranslationDoc} */
|
|
35
|
-
export const docsDense = {
|
|
36
|
-
description:
|
|
37
|
-
'Global keyboard shortcuts w/ one window keydown listener per hook instance. Handlers kept in ref — re-renders never re-subscribe. Skips typing targets (input/textarea/select/contenteditable) unless allowInInputs, skips defaultPrevented, preventDefault() on match. "mod" = ⌘ on macOS, Ctrl elsewhere. SSR-safe.',
|
|
38
|
-
paramDescriptions: {
|
|
39
|
-
hotkeys:
|
|
40
|
-
'array of { keys, onPress, allowInInputs?, isDisabled? }. keys = "+"-separated combo ("mod+k", "shift+/", "escape").',
|
|
41
|
-
},
|
|
42
|
-
usage: {
|
|
43
|
-
description:
|
|
44
|
-
'Global keyboard shortcuts w/ one window keydown listener per hook instance. Handlers kept in ref — re-renders never re-subscribe. Skips typing targets unless allowInInputs, skips defaultPrevented, preventDefault() on match. SSR-safe.',
|
|
45
|
-
bestPractices: [
|
|
46
|
-
{ guidance: true, description: 'Use for app-level shortcuts: command palettes (mod+k), help overlays (shift+/), navigation keys.' },
|
|
47
|
-
{ guidance: true, description: 'Pair w/ Kbd component to display same combo registered — both resolve "mod" per platform identically.' },
|
|
48
|
-
{ guidance: true, description: 'Use isDisabled to suspend shortcuts while modal/wizard owns keyboard, instead of unmounting hook.' },
|
|
49
|
-
{ guidance: false, description: 'Use for focus-scoped keyboard nav inside widget; use useListFocus / useGridFocus instead.' },
|
|
50
|
-
],
|
|
51
|
-
},
|
|
52
|
-
};
|
|
@@ -1,245 +0,0 @@
|
|
|
1
|
-
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* @file useHotkeys.test.ts
|
|
5
|
-
* @input Uses vitest, @testing-library/react, useHotkeys hook
|
|
6
|
-
* @output Unit tests for useHotkeys hook
|
|
7
|
-
* @position Testing; validates useHotkeys.ts implementation
|
|
8
|
-
*
|
|
9
|
-
* SYNC: When useHotkeys.ts changes, update tests to match new behavior
|
|
10
|
-
*/
|
|
11
|
-
|
|
12
|
-
import {describe, it, expect, vi, afterEach} from 'vitest';
|
|
13
|
-
import {renderHook} from '@testing-library/react';
|
|
14
|
-
import {useHotkeys, type Hotkey} from './useHotkeys';
|
|
15
|
-
|
|
16
|
-
function stubApplePlatform() {
|
|
17
|
-
// jsdom's navigator has no userAgentData; platform drives detection.
|
|
18
|
-
vi.stubGlobal('navigator', {platform: 'MacIntel'});
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
function stubOtherPlatform() {
|
|
22
|
-
vi.stubGlobal('navigator', {platform: 'Win32'});
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
function press(
|
|
26
|
-
key: string,
|
|
27
|
-
init: KeyboardEventInit & {target?: HTMLElement} = {},
|
|
28
|
-
): KeyboardEvent {
|
|
29
|
-
const {target, ...eventInit} = init;
|
|
30
|
-
const event = new KeyboardEvent('keydown', {
|
|
31
|
-
key,
|
|
32
|
-
bubbles: true,
|
|
33
|
-
cancelable: true,
|
|
34
|
-
...eventInit,
|
|
35
|
-
});
|
|
36
|
-
(target ?? window).dispatchEvent(event);
|
|
37
|
-
return event;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
afterEach(() => {
|
|
41
|
-
vi.unstubAllGlobals();
|
|
42
|
-
vi.restoreAllMocks();
|
|
43
|
-
document.body.innerHTML = '';
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
describe('useHotkeys', () => {
|
|
47
|
-
it('fires on mod+k via metaKey on Apple platforms', () => {
|
|
48
|
-
stubApplePlatform();
|
|
49
|
-
const onPress = vi.fn();
|
|
50
|
-
renderHook(() => useHotkeys([{keys: 'mod+k', onPress}]));
|
|
51
|
-
|
|
52
|
-
const event = press('k', {metaKey: true});
|
|
53
|
-
expect(onPress).toHaveBeenCalledTimes(1);
|
|
54
|
-
expect(onPress).toHaveBeenCalledWith(event);
|
|
55
|
-
expect(event.defaultPrevented).toBe(true);
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
it('maps mod to ctrlKey on non-Apple platforms', () => {
|
|
59
|
-
stubOtherPlatform();
|
|
60
|
-
const onPress = vi.fn();
|
|
61
|
-
renderHook(() => useHotkeys([{keys: 'mod+k', onPress}]));
|
|
62
|
-
|
|
63
|
-
press('k', {metaKey: true});
|
|
64
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
65
|
-
|
|
66
|
-
press('k', {ctrlKey: true});
|
|
67
|
-
expect(onPress).toHaveBeenCalledTimes(1);
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
it('does not fire a bare key when modifiers are held', () => {
|
|
71
|
-
stubApplePlatform();
|
|
72
|
-
const onPress = vi.fn();
|
|
73
|
-
renderHook(() => useHotkeys([{keys: 'k', onPress}]));
|
|
74
|
-
|
|
75
|
-
press('k', {metaKey: true});
|
|
76
|
-
press('k', {ctrlKey: true});
|
|
77
|
-
press('k', {altKey: true});
|
|
78
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
79
|
-
|
|
80
|
-
press('k');
|
|
81
|
-
expect(onPress).toHaveBeenCalledTimes(1);
|
|
82
|
-
});
|
|
83
|
-
|
|
84
|
-
it('matches named keys: escape, enter, space, arrows', () => {
|
|
85
|
-
stubApplePlatform();
|
|
86
|
-
const onEscape = vi.fn();
|
|
87
|
-
const onEnter = vi.fn();
|
|
88
|
-
const onSpace = vi.fn();
|
|
89
|
-
const onDown = vi.fn();
|
|
90
|
-
renderHook(() =>
|
|
91
|
-
useHotkeys([
|
|
92
|
-
{keys: 'escape', onPress: onEscape},
|
|
93
|
-
{keys: 'enter', onPress: onEnter},
|
|
94
|
-
{keys: 'space', onPress: onSpace},
|
|
95
|
-
{keys: 'down', onPress: onDown},
|
|
96
|
-
]),
|
|
97
|
-
);
|
|
98
|
-
|
|
99
|
-
press('Escape');
|
|
100
|
-
press('Enter');
|
|
101
|
-
press(' ');
|
|
102
|
-
press('ArrowDown');
|
|
103
|
-
expect(onEscape).toHaveBeenCalledTimes(1);
|
|
104
|
-
expect(onEnter).toHaveBeenCalledTimes(1);
|
|
105
|
-
expect(onSpace).toHaveBeenCalledTimes(1);
|
|
106
|
-
expect(onDown).toHaveBeenCalledTimes(1);
|
|
107
|
-
});
|
|
108
|
-
|
|
109
|
-
it('requires shift when specified and ignores shift otherwise', () => {
|
|
110
|
-
stubApplePlatform();
|
|
111
|
-
const onSlash = vi.fn();
|
|
112
|
-
const onLetter = vi.fn();
|
|
113
|
-
renderHook(() =>
|
|
114
|
-
useHotkeys([
|
|
115
|
-
{keys: 'shift+/', onPress: onSlash},
|
|
116
|
-
{keys: 'c', onPress: onLetter},
|
|
117
|
-
]),
|
|
118
|
-
);
|
|
119
|
-
|
|
120
|
-
press('/');
|
|
121
|
-
expect(onSlash).not.toHaveBeenCalled();
|
|
122
|
-
press('/', {shiftKey: true});
|
|
123
|
-
expect(onSlash).toHaveBeenCalledTimes(1);
|
|
124
|
-
|
|
125
|
-
// Shift not specified → matches regardless of shift state.
|
|
126
|
-
press('C', {shiftKey: true});
|
|
127
|
-
press('c');
|
|
128
|
-
expect(onLetter).toHaveBeenCalledTimes(2);
|
|
129
|
-
});
|
|
130
|
-
|
|
131
|
-
it('skips typing targets by default', () => {
|
|
132
|
-
stubApplePlatform();
|
|
133
|
-
const onPress = vi.fn();
|
|
134
|
-
renderHook(() => useHotkeys([{keys: 'mod+k', onPress}]));
|
|
135
|
-
|
|
136
|
-
const input = document.createElement('input');
|
|
137
|
-
document.body.appendChild(input);
|
|
138
|
-
press('k', {metaKey: true, target: input});
|
|
139
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
140
|
-
|
|
141
|
-
const textarea = document.createElement('textarea');
|
|
142
|
-
document.body.appendChild(textarea);
|
|
143
|
-
press('k', {metaKey: true, target: textarea});
|
|
144
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
145
|
-
});
|
|
146
|
-
|
|
147
|
-
it('fires in typing targets when allowInInputs is true', () => {
|
|
148
|
-
stubApplePlatform();
|
|
149
|
-
const onPress = vi.fn();
|
|
150
|
-
renderHook(() =>
|
|
151
|
-
useHotkeys([{keys: 'escape', onPress, allowInInputs: true}]),
|
|
152
|
-
);
|
|
153
|
-
|
|
154
|
-
const input = document.createElement('input');
|
|
155
|
-
document.body.appendChild(input);
|
|
156
|
-
press('Escape', {target: input});
|
|
157
|
-
expect(onPress).toHaveBeenCalledTimes(1);
|
|
158
|
-
});
|
|
159
|
-
|
|
160
|
-
it('respects isDisabled', () => {
|
|
161
|
-
stubApplePlatform();
|
|
162
|
-
const onPress = vi.fn();
|
|
163
|
-
const {rerender} = renderHook(
|
|
164
|
-
({isDisabled}: {isDisabled: boolean}) =>
|
|
165
|
-
useHotkeys([{keys: 'mod+k', onPress, isDisabled}]),
|
|
166
|
-
{initialProps: {isDisabled: true}},
|
|
167
|
-
);
|
|
168
|
-
|
|
169
|
-
press('k', {metaKey: true});
|
|
170
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
171
|
-
|
|
172
|
-
rerender({isDisabled: false});
|
|
173
|
-
press('k', {metaKey: true});
|
|
174
|
-
expect(onPress).toHaveBeenCalledTimes(1);
|
|
175
|
-
});
|
|
176
|
-
|
|
177
|
-
it('skips events that are already defaultPrevented', () => {
|
|
178
|
-
stubApplePlatform();
|
|
179
|
-
const onPress = vi.fn();
|
|
180
|
-
renderHook(() => useHotkeys([{keys: 'mod+k', onPress}]));
|
|
181
|
-
|
|
182
|
-
const event = new KeyboardEvent('keydown', {
|
|
183
|
-
key: 'k',
|
|
184
|
-
metaKey: true,
|
|
185
|
-
bubbles: true,
|
|
186
|
-
cancelable: true,
|
|
187
|
-
});
|
|
188
|
-
event.preventDefault();
|
|
189
|
-
window.dispatchEvent(event);
|
|
190
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
191
|
-
});
|
|
192
|
-
|
|
193
|
-
it('unsubscribes on unmount', () => {
|
|
194
|
-
stubApplePlatform();
|
|
195
|
-
const onPress = vi.fn();
|
|
196
|
-
const removeSpy = vi.spyOn(window, 'removeEventListener');
|
|
197
|
-
const {unmount} = renderHook(() => useHotkeys([{keys: 'mod+k', onPress}]));
|
|
198
|
-
|
|
199
|
-
unmount();
|
|
200
|
-
expect(removeSpy).toHaveBeenCalledWith('keydown', expect.any(Function));
|
|
201
|
-
|
|
202
|
-
press('k', {metaKey: true});
|
|
203
|
-
expect(onPress).not.toHaveBeenCalled();
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
it('does not re-subscribe on re-render, but uses latest handlers', () => {
|
|
207
|
-
stubApplePlatform();
|
|
208
|
-
const addSpy = vi.spyOn(window, 'addEventListener');
|
|
209
|
-
const first = vi.fn();
|
|
210
|
-
const second = vi.fn();
|
|
211
|
-
|
|
212
|
-
const {rerender} = renderHook(
|
|
213
|
-
({hotkeys}: {hotkeys: Hotkey[]}) => useHotkeys(hotkeys),
|
|
214
|
-
{initialProps: {hotkeys: [{keys: 'mod+k', onPress: first}]}},
|
|
215
|
-
);
|
|
216
|
-
|
|
217
|
-
const keydownSubscriptions = () =>
|
|
218
|
-
addSpy.mock.calls.filter(([type]) => type === 'keydown').length;
|
|
219
|
-
const initialCount = keydownSubscriptions();
|
|
220
|
-
|
|
221
|
-
rerender({hotkeys: [{keys: 'mod+k', onPress: second}]});
|
|
222
|
-
rerender({hotkeys: [{keys: 'mod+k', onPress: second}]});
|
|
223
|
-
expect(keydownSubscriptions()).toBe(initialCount);
|
|
224
|
-
|
|
225
|
-
press('k', {metaKey: true});
|
|
226
|
-
expect(first).not.toHaveBeenCalled();
|
|
227
|
-
expect(second).toHaveBeenCalledTimes(1);
|
|
228
|
-
});
|
|
229
|
-
|
|
230
|
-
it('only fires the first matching hotkey per event', () => {
|
|
231
|
-
stubApplePlatform();
|
|
232
|
-
const first = vi.fn();
|
|
233
|
-
const second = vi.fn();
|
|
234
|
-
renderHook(() =>
|
|
235
|
-
useHotkeys([
|
|
236
|
-
{keys: 'mod+k', onPress: first},
|
|
237
|
-
{keys: 'mod+k', onPress: second},
|
|
238
|
-
]),
|
|
239
|
-
);
|
|
240
|
-
|
|
241
|
-
press('k', {metaKey: true});
|
|
242
|
-
expect(first).toHaveBeenCalledTimes(1);
|
|
243
|
-
expect(second).not.toHaveBeenCalled();
|
|
244
|
-
});
|
|
245
|
-
});
|
package/src/hooks/useHotkeys.ts
DELETED
|
@@ -1,203 +0,0 @@
|
|
|
1
|
-
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
-
|
|
3
|
-
'use client';
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* @file useHotkeys.ts
|
|
7
|
-
* @input Uses React useEffect, useRef
|
|
8
|
-
* @output Exports useHotkeys hook and Hotkey interface for global keyboard shortcuts
|
|
9
|
-
* @position Core hook; used by consumers for app-level keyboard shortcuts
|
|
10
|
-
*
|
|
11
|
-
* Registers a single window keydown listener per hook instance. Handlers
|
|
12
|
-
* are kept in a ref so re-renders never re-subscribe (subscribe once on
|
|
13
|
-
* mount, unsubscribe on unmount). SSR-safe — window is only touched
|
|
14
|
-
* inside the effect.
|
|
15
|
-
*
|
|
16
|
-
* Skips events that are already handled (defaultPrevented) and events
|
|
17
|
-
* targeting typing surfaces (input, textarea, select, contenteditable)
|
|
18
|
-
* unless a hotkey opts in via `allowInInputs`.
|
|
19
|
-
*
|
|
20
|
-
* Platform-aware: `mod` maps to metaKey (⌘) on Apple platforms and
|
|
21
|
-
* ctrlKey elsewhere — mirrors the detection used by Kbd.
|
|
22
|
-
*
|
|
23
|
-
* SYNC: When modified, update:
|
|
24
|
-
* - /packages/core/src/hooks/index.ts
|
|
25
|
-
* - /packages/core/src/hooks/useHotkeys.doc.mjs
|
|
26
|
-
*/
|
|
27
|
-
|
|
28
|
-
import {useEffect, useRef} from 'react';
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* A single keyboard shortcut registration.
|
|
32
|
-
*/
|
|
33
|
-
export interface Hotkey {
|
|
34
|
-
/**
|
|
35
|
-
* Key combo, e.g. 'mod+k', 'shift+/', 'c', 'escape'.
|
|
36
|
-
* 'mod' = ⌘ on macOS, Ctrl elsewhere.
|
|
37
|
-
*
|
|
38
|
-
* Format: '+'-separated modifiers (mod, ctrl, meta, shift, alt) followed
|
|
39
|
-
* by a final key compared case-insensitively against event.key.
|
|
40
|
-
* Named keys: 'escape', 'enter', 'space', 'up', 'down', 'left', 'right'
|
|
41
|
-
* (arrow names map to ArrowUp/ArrowDown/ArrowLeft/ArrowRight).
|
|
42
|
-
* Use 'plus' for a literal '+' key.
|
|
43
|
-
*
|
|
44
|
-
* Shift semantics: when 'shift' is not specified, shift state is ignored,
|
|
45
|
-
* so single letters match regardless of shift. When 'shift' is specified,
|
|
46
|
-
* shiftKey must be pressed and the final key is still compared against
|
|
47
|
-
* event.key — for punctuation that shift transforms (e.g. shift+/ produces
|
|
48
|
-
* '?' on US layouts), prefer registering the produced character instead.
|
|
49
|
-
*/
|
|
50
|
-
keys: string;
|
|
51
|
-
/** Called when the combo matches. The event has preventDefault() applied. */
|
|
52
|
-
onPress: (event: KeyboardEvent) => void;
|
|
53
|
-
/**
|
|
54
|
-
* Fire even when focus is in an input/textarea/select/contenteditable.
|
|
55
|
-
* @default false
|
|
56
|
-
*/
|
|
57
|
-
allowInInputs?: boolean;
|
|
58
|
-
/** Temporarily disable this hotkey without unregistering it. */
|
|
59
|
-
isDisabled?: boolean;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
/** Aliases for the final key of a combo, normalized to event.key values. */
|
|
63
|
-
const KEY_ALIASES: Record<string, string> = {
|
|
64
|
-
esc: 'escape',
|
|
65
|
-
space: ' ',
|
|
66
|
-
up: 'arrowup',
|
|
67
|
-
down: 'arrowdown',
|
|
68
|
-
left: 'arrowleft',
|
|
69
|
-
right: 'arrowright',
|
|
70
|
-
return: 'enter',
|
|
71
|
-
plus: '+',
|
|
72
|
-
};
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* Detects whether the current platform is macOS/iOS.
|
|
76
|
-
* Prefers the User-Agent Client Hints API when available (modern Chrome/Edge),
|
|
77
|
-
* falls back to navigator.platform (deprecated but universally supported).
|
|
78
|
-
* Mirrors the detection used by Kbd so displayed and handled shortcuts agree.
|
|
79
|
-
*/
|
|
80
|
-
function isApplePlatform(): boolean {
|
|
81
|
-
if (typeof navigator === 'undefined') {
|
|
82
|
-
return false;
|
|
83
|
-
}
|
|
84
|
-
const uaData = 'userAgentData' in navigator ? navigator.userAgentData : null;
|
|
85
|
-
if (uaData && typeof uaData === 'object' && 'platform' in uaData) {
|
|
86
|
-
return /mac/i.test((uaData as {platform: string}).platform ?? '');
|
|
87
|
-
}
|
|
88
|
-
return /Mac|iPhone|iPad|iPod/.test(navigator.platform ?? '');
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* Whether the event target is a typing surface where global shortcuts
|
|
93
|
-
* should stay silent by default.
|
|
94
|
-
*/
|
|
95
|
-
function isTypingTarget(target: EventTarget | null): boolean {
|
|
96
|
-
if (!(target instanceof HTMLElement)) {
|
|
97
|
-
return false;
|
|
98
|
-
}
|
|
99
|
-
if (target.isContentEditable) {
|
|
100
|
-
return true;
|
|
101
|
-
}
|
|
102
|
-
const tag = target.tagName;
|
|
103
|
-
return tag === 'INPUT' || tag === 'TEXTAREA' || tag === 'SELECT';
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
/**
|
|
107
|
-
* Whether a keydown event matches a '+'-separated combo string.
|
|
108
|
-
*/
|
|
109
|
-
function matchesCombo(
|
|
110
|
-
keys: string,
|
|
111
|
-
event: KeyboardEvent,
|
|
112
|
-
isApple: boolean,
|
|
113
|
-
): boolean {
|
|
114
|
-
const parts = keys
|
|
115
|
-
.toLowerCase()
|
|
116
|
-
.split('+')
|
|
117
|
-
.map(part => part.trim())
|
|
118
|
-
.filter(Boolean);
|
|
119
|
-
if (parts.length === 0) {
|
|
120
|
-
return false;
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
const key = parts[parts.length - 1];
|
|
124
|
-
const mods = new Set(parts.slice(0, -1));
|
|
125
|
-
|
|
126
|
-
const wantsMod = mods.has('mod');
|
|
127
|
-
const wantsCtrl = mods.has('ctrl') || (wantsMod && !isApple);
|
|
128
|
-
const wantsMeta = mods.has('meta') || (wantsMod && isApple);
|
|
129
|
-
const wantsAlt = mods.has('alt');
|
|
130
|
-
const wantsShift = mods.has('shift');
|
|
131
|
-
|
|
132
|
-
// Non-shift modifiers must match exactly so 'k' doesn't fire on 'mod+k'.
|
|
133
|
-
if (event.ctrlKey !== wantsCtrl) {
|
|
134
|
-
return false;
|
|
135
|
-
}
|
|
136
|
-
if (event.metaKey !== wantsMeta) {
|
|
137
|
-
return false;
|
|
138
|
-
}
|
|
139
|
-
if (event.altKey !== wantsAlt) {
|
|
140
|
-
return false;
|
|
141
|
-
}
|
|
142
|
-
// Shift is only enforced when specified — see Hotkey.keys docs.
|
|
143
|
-
if (wantsShift && !event.shiftKey) {
|
|
144
|
-
return false;
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
const expected = KEY_ALIASES[key] ?? key;
|
|
148
|
-
return event.key.toLowerCase() === expected;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* Registers global keyboard shortcuts on window.
|
|
153
|
-
*
|
|
154
|
-
* A single keydown listener is attached per hook instance; the hotkey
|
|
155
|
-
* definitions live in a ref, so re-renders update behavior without
|
|
156
|
-
* re-subscribing. First matching hotkey wins per event.
|
|
157
|
-
*
|
|
158
|
-
* @param hotkeys - Shortcut registrations to listen for.
|
|
159
|
-
*
|
|
160
|
-
* @example
|
|
161
|
-
* ```
|
|
162
|
-
* useHotkeys([
|
|
163
|
-
* { keys: 'mod+k', onPress: () => openCommandPalette() },
|
|
164
|
-
* { keys: 'escape', onPress: () => closePanel(), allowInInputs: true },
|
|
165
|
-
* { keys: 'c', onPress: () => compose(), isDisabled: isModalOpen },
|
|
166
|
-
* ]);
|
|
167
|
-
* ```
|
|
168
|
-
*/
|
|
169
|
-
export function useHotkeys(hotkeys: Hotkey[]): void {
|
|
170
|
-
const hotkeysRef = useRef(hotkeys);
|
|
171
|
-
|
|
172
|
-
// Keep the latest definitions available to the stable listener.
|
|
173
|
-
useEffect(() => {
|
|
174
|
-
hotkeysRef.current = hotkeys;
|
|
175
|
-
});
|
|
176
|
-
|
|
177
|
-
useEffect(() => {
|
|
178
|
-
const isApple = isApplePlatform();
|
|
179
|
-
|
|
180
|
-
const handleKeyDown = (event: KeyboardEvent) => {
|
|
181
|
-
if (event.defaultPrevented) {
|
|
182
|
-
return;
|
|
183
|
-
}
|
|
184
|
-
const isTyping = isTypingTarget(event.target);
|
|
185
|
-
for (const hotkey of hotkeysRef.current) {
|
|
186
|
-
if (hotkey.isDisabled) {
|
|
187
|
-
continue;
|
|
188
|
-
}
|
|
189
|
-
if (isTyping && !hotkey.allowInInputs) {
|
|
190
|
-
continue;
|
|
191
|
-
}
|
|
192
|
-
if (matchesCombo(hotkey.keys, event, isApple)) {
|
|
193
|
-
event.preventDefault();
|
|
194
|
-
hotkey.onPress(event);
|
|
195
|
-
return;
|
|
196
|
-
}
|
|
197
|
-
}
|
|
198
|
-
};
|
|
199
|
-
|
|
200
|
-
window.addEventListener('keydown', handleKeyDown);
|
|
201
|
-
return () => window.removeEventListener('keydown', handleKeyDown);
|
|
202
|
-
}, []);
|
|
203
|
-
}
|