@primer/components 0.0.0-2021983515 → 0.0.0-2022530194733
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 +105 -492
- package/README.md +16 -16
- package/codemods/lib/modifyProps.js +7 -9
- package/codemods/lib/prettify.js +1 -1
- package/codemods/lib/replaceImportSource.js +5 -5
- package/dist/browser.esm.js +889 -1279
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +839 -1234
- package/dist/browser.umd.js.map +1 -1
- package/index.d.ts +940 -0
- package/lib/AvatarPair.js +5 -6
- package/lib/AvatarStack.js +10 -10
- package/lib/BaseStyles.js +19 -18
- package/lib/BorderBox.js +5 -4
- package/lib/Box.js +2 -2
- package/lib/BranchName.js +1 -1
- package/lib/{Breadcrumbs.js → Breadcrumb.js} +23 -33
- package/lib/Button/Button.js +3 -3
- package/lib/Button/ButtonClose.js +4 -4
- package/lib/Button/ButtonDanger.js +2 -2
- package/lib/Button/ButtonInvisible.js +3 -3
- package/lib/Button/ButtonOutline.js +2 -2
- package/lib/Button/ButtonPrimary.js +2 -2
- package/lib/Button/ButtonTableList.js +1 -1
- package/lib/CircleBadge.js +1 -1
- package/lib/CircleOcticon.js +7 -9
- package/lib/CounterLabel.js +2 -2
- package/lib/Dialog.js +14 -13
- package/lib/Dropdown.js +2 -2
- package/lib/DropdownStyles.js +6 -6
- package/lib/FilterList.js +1 -1
- package/lib/Flash.js +1 -1
- package/lib/Flex.js +0 -3
- package/lib/Grid.js +3 -4
- package/lib/Header.js +2 -3
- package/lib/Label.js +4 -4
- package/lib/Link.js +12 -1
- package/lib/Overlay.js +36 -126
- package/lib/Pagehead.js +1 -1
- package/lib/Pagination/Pagination.js +2 -3
- package/lib/Popover.js +3 -3
- package/lib/Portal/Portal.js +12 -20
- package/lib/Position.js +27 -46
- package/lib/ProgressBar.js +1 -1
- package/lib/SelectMenu/SelectMenu.js +4 -4
- package/lib/SelectMenu/SelectMenuContext.js +1 -1
- package/lib/SelectMenu/SelectMenuDivider.js +3 -3
- package/lib/SelectMenu/SelectMenuFilter.js +6 -6
- package/lib/SelectMenu/SelectMenuFooter.js +3 -3
- package/lib/SelectMenu/SelectMenuHeader.js +2 -2
- package/lib/SelectMenu/SelectMenuItem.js +4 -4
- package/lib/SelectMenu/SelectMenuList.js +3 -3
- package/lib/SelectMenu/SelectMenuLoadingAnimation.js +15 -4
- package/lib/SelectMenu/SelectMenuModal.js +7 -7
- package/lib/SelectMenu/SelectMenuTab.js +3 -3
- package/lib/SelectMenu/SelectMenuTabPanel.js +3 -3
- package/lib/SelectMenu/SelectMenuTabs.js +2 -2
- package/lib/SelectMenu/hooks/useKeyboardNav.js +0 -2
- package/lib/SideNav.js +12 -20
- package/lib/StateLabel.js +4 -4
- package/lib/SubNav.js +3 -5
- package/lib/TabNav.js +3 -3
- package/lib/TextInput.js +59 -22
- package/lib/ThemeProvider.js +15 -32
- package/lib/Timeline.js +29 -24
- package/lib/Tooltip.js +1 -2
- package/lib/UnderlineNav.js +2 -2
- package/lib/behaviors/anchoredPosition.js +9 -17
- package/lib/behaviors/focusTrap.js +14 -32
- package/lib/behaviors/focusZone.js +148 -218
- package/lib/constants.js +2 -3
- package/lib/hooks/index.js +1 -9
- package/lib/hooks/useAnchoredPosition.js +4 -11
- package/lib/hooks/useDialog.js +1 -1
- package/lib/hooks/useFocusTrap.js +8 -26
- package/lib/hooks/useFocusZone.js +7 -7
- package/lib/hooks/useMouseIntent.js +58 -0
- package/lib/hooks/useOnEscapePress.js +10 -53
- package/lib/hooks/useOnOutsideClick.js +35 -62
- package/lib/hooks/useOpenAndCloseFocus.js +3 -8
- package/lib/hooks/useOverlay.js +19 -9
- package/lib/hooks/useSafeTimeout.js +0 -1
- package/lib/index.js +12 -112
- package/lib/polyfills/eventListenerSignal.js +1 -6
- package/lib/stories/Button.stories.js +114 -0
- package/lib/stories/Overlay.stories.js +102 -0
- package/lib/stories/Portal.stories.js +108 -0
- package/lib/stories/ThemeProvider.stories.js +95 -0
- package/lib/stories/useAnchoredPosition.stories.js +349 -0
- package/lib/stories/useFocusTrap.stories.js +278 -0
- package/lib/stories/useFocusZone.stories.js +490 -0
- package/lib/theme-preval.js +2057 -5148
- package/lib/utils/deprecate.js +2 -3
- package/lib/utils/isNumeric.js +0 -1
- package/lib/utils/iterateFocusableElements.js +1 -1
- package/lib/utils/test-deprecations.js +0 -1
- package/lib/utils/test-matchers.js +12 -3
- package/lib/utils/testing.js +4 -4
- package/lib/utils/theme.js +1 -1
- package/lib/utils/{types/AriaRole.js → types.js} +0 -0
- package/lib/utils/uniqueId.js +0 -1
- package/lib-esm/AvatarPair.js +5 -6
- package/lib-esm/AvatarStack.js +11 -11
- package/lib-esm/BaseStyles.js +16 -16
- package/lib-esm/BorderBox.js +3 -5
- package/lib-esm/Box.js +2 -2
- package/lib-esm/BranchName.js +1 -1
- package/lib-esm/{Breadcrumbs.js → Breadcrumb.js} +22 -32
- package/lib-esm/Button/Button.js +1 -1
- package/lib-esm/Button/ButtonClose.js +2 -2
- package/lib-esm/Button/ButtonInvisible.js +1 -1
- package/lib-esm/Button/ButtonTableList.js +1 -1
- package/lib-esm/CircleBadge.js +1 -1
- package/lib-esm/CircleOcticon.js +6 -9
- package/lib-esm/CounterLabel.js +2 -2
- package/lib-esm/Dialog.js +12 -10
- package/lib-esm/Dropdown.js +2 -2
- package/lib-esm/DropdownStyles.js +6 -6
- package/lib-esm/FilterList.js +1 -1
- package/lib-esm/Flash.js +1 -1
- package/lib-esm/Flex.js +0 -4
- package/lib-esm/Grid.js +2 -5
- package/lib-esm/Header.js +0 -1
- package/lib-esm/Label.js +2 -2
- package/lib-esm/Link.js +12 -1
- package/lib-esm/Overlay.js +38 -119
- package/lib-esm/Pagehead.js +1 -1
- package/lib-esm/Pagination/Pagination.js +2 -3
- package/lib-esm/Popover.js +3 -3
- package/lib-esm/Portal/Portal.js +12 -19
- package/lib-esm/Portal/index.js +1 -1
- package/lib-esm/Position.js +20 -45
- package/lib-esm/ProgressBar.js +1 -1
- package/lib-esm/SelectMenu/SelectMenu.js +3 -3
- package/lib-esm/SelectMenu/SelectMenuContext.js +1 -1
- package/lib-esm/SelectMenu/SelectMenuDivider.js +1 -1
- package/lib-esm/SelectMenu/SelectMenuFilter.js +4 -4
- package/lib-esm/SelectMenu/SelectMenuFooter.js +1 -1
- package/lib-esm/SelectMenu/SelectMenuHeader.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuItem.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuList.js +1 -1
- package/lib-esm/SelectMenu/SelectMenuLoadingAnimation.js +10 -5
- package/lib-esm/SelectMenu/SelectMenuModal.js +5 -5
- package/lib-esm/SelectMenu/SelectMenuTab.js +1 -1
- package/lib-esm/SelectMenu/SelectMenuTabPanel.js +1 -1
- package/lib-esm/SelectMenu/hooks/useKeyboardNav.js +0 -2
- package/lib-esm/SideNav.js +7 -16
- package/lib-esm/StateLabel.js +4 -4
- package/lib-esm/SubNav.js +4 -7
- package/lib-esm/TabNav.js +4 -5
- package/lib-esm/TextInput.js +49 -22
- package/lib-esm/ThemeProvider.js +16 -31
- package/lib-esm/Timeline.js +24 -19
- package/lib-esm/Tooltip.js +1 -2
- package/lib-esm/UnderlineNav.js +3 -4
- package/lib-esm/behaviors/anchoredPosition.js +9 -17
- package/lib-esm/behaviors/focusTrap.js +14 -32
- package/lib-esm/behaviors/focusZone.js +148 -213
- package/lib-esm/constants.js +1 -2
- package/lib-esm/hooks/index.js +1 -2
- package/lib-esm/hooks/useAnchoredPosition.js +5 -10
- package/lib-esm/hooks/useDialog.js +1 -1
- package/lib-esm/hooks/useFocusTrap.js +8 -25
- package/lib-esm/hooks/useFocusZone.js +5 -5
- package/lib-esm/hooks/useMouseIntent.js +50 -0
- package/lib-esm/hooks/useOnEscapePress.js +10 -53
- package/lib-esm/hooks/useOnOutsideClick.js +37 -62
- package/lib-esm/hooks/useOpenAndCloseFocus.js +3 -8
- package/lib-esm/hooks/useOverlay.js +18 -9
- package/lib-esm/hooks/useSafeTimeout.js +0 -1
- package/lib-esm/index.js +10 -22
- package/lib-esm/polyfills/eventListenerSignal.js +1 -6
- package/lib-esm/stories/Button.stories.js +79 -0
- package/lib-esm/stories/Overlay.stories.js +80 -0
- package/lib-esm/stories/Portal.stories.js +72 -0
- package/lib-esm/stories/ThemeProvider.stories.js +76 -0
- package/lib-esm/stories/useAnchoredPosition.stories.js +311 -0
- package/lib-esm/stories/useFocusTrap.stories.js +234 -0
- package/lib-esm/stories/useFocusZone.stories.js +445 -0
- package/lib-esm/theme-preval.js +2057 -5148
- package/lib-esm/utils/deprecate.js +2 -3
- package/lib-esm/utils/isNumeric.js +0 -1
- package/lib-esm/utils/iterateFocusableElements.js +1 -1
- package/lib-esm/utils/test-deprecations.js +1 -1
- package/lib-esm/utils/test-matchers.js +11 -3
- package/lib-esm/utils/testing.js +6 -6
- package/lib-esm/utils/theme.js +1 -1
- package/lib-esm/utils/{test-helpers.d.ts → types.js} +0 -0
- package/lib-esm/utils/uniqueId.js +0 -1
- package/package.json +95 -103
- package/codemods/__tests__/deprecateUtilityComponents.js +0 -200
- package/codemods/__tests__/removeSystemProps.js +0 -225
- package/codemods/deprecateUtilityComponents.js +0 -111
- package/codemods/removeSystemProps.js +0 -312
- package/lib/ActionList/Divider.d.ts +0 -9
- package/lib/ActionList/Divider.js +0 -40
- package/lib/ActionList/Group.d.ts +0 -28
- package/lib/ActionList/Group.js +0 -35
- package/lib/ActionList/Header.d.ts +0 -29
- package/lib/ActionList/Header.js +0 -51
- package/lib/ActionList/Item.d.ts +0 -92
- package/lib/ActionList/Item.js +0 -288
- package/lib/ActionList/List.d.ts +0 -88
- package/lib/ActionList/List.js +0 -199
- package/lib/ActionList/index.d.ts +0 -17
- package/lib/ActionList/index.js +0 -29
- package/lib/ActionMenu.d.ts +0 -40
- package/lib/ActionMenu.js +0 -103
- package/lib/AnchoredOverlay/AnchoredOverlay.d.ts +0 -62
- package/lib/AnchoredOverlay/AnchoredOverlay.js +0 -124
- package/lib/AnchoredOverlay/index.d.ts +0 -2
- package/lib/AnchoredOverlay/index.js +0 -13
- package/lib/Autocomplete/Autocomplete.d.ts +0 -40
- package/lib/Autocomplete/Autocomplete.js +0 -68
- package/lib/Autocomplete/AutocompleteContext.d.ts +0 -17
- package/lib/Autocomplete/AutocompleteContext.js +0 -11
- package/lib/Autocomplete/AutocompleteInput.d.ts +0 -9
- package/lib/Autocomplete/AutocompleteInput.js +0 -150
- package/lib/Autocomplete/AutocompleteMenu.d.ts +0 -71
- package/lib/Autocomplete/AutocompleteMenu.js +0 -223
- package/lib/Autocomplete/AutocompleteOverlay.d.ts +0 -17
- package/lib/Autocomplete/AutocompleteOverlay.js +0 -69
- package/lib/Autocomplete/index.d.ts +0 -2
- package/lib/Autocomplete/index.js +0 -15
- package/lib/Avatar.d.ts +0 -15
- package/lib/AvatarPair.d.ts +0 -8
- package/lib/AvatarStack.d.ts +0 -8
- package/lib/BaseStyles.d.ts +0 -14
- package/lib/BorderBox.d.ts +0 -7
- package/lib/Box.d.ts +0 -6
- package/lib/BranchName.d.ts +0 -6
- package/lib/Breadcrumbs.d.ts +0 -40
- package/lib/Button/Button.d.ts +0 -284
- package/lib/Button/ButtonBase.d.ts +0 -12
- package/lib/Button/ButtonClose.d.ts +0 -321
- package/lib/Button/ButtonDanger.d.ts +0 -284
- package/lib/Button/ButtonGroup.d.ts +0 -4
- package/lib/Button/ButtonInvisible.d.ts +0 -284
- package/lib/Button/ButtonOutline.d.ts +0 -284
- package/lib/Button/ButtonPrimary.d.ts +0 -284
- package/lib/Button/ButtonStyles.d.ts +0 -2
- package/lib/Button/ButtonTableList.d.ts +0 -6
- package/lib/Button/index.d.ts +0 -16
- package/lib/Caret.d.ts +0 -21
- package/lib/CircleBadge.d.ts +0 -25
- package/lib/CircleOcticon.d.ts +0 -391
- package/lib/CounterLabel.d.ts +0 -8
- package/lib/Details.d.ts +0 -6
- package/lib/Dialog/ConfirmationDialog.d.ts +0 -44
- package/lib/Dialog/ConfirmationDialog.js +0 -191
- package/lib/Dialog/Dialog.d.ts +0 -167
- package/lib/Dialog/Dialog.js +0 -304
- package/lib/Dialog.d.ts +0 -406
- package/lib/Dropdown.d.ts +0 -1262
- package/lib/DropdownMenu/DropdownButton.d.ts +0 -323
- package/lib/DropdownMenu/DropdownButton.js +0 -31
- package/lib/DropdownMenu/DropdownMenu.d.ts +0 -43
- package/lib/DropdownMenu/DropdownMenu.js +0 -94
- package/lib/DropdownMenu/index.d.ts +0 -4
- package/lib/DropdownMenu/index.js +0 -21
- package/lib/DropdownStyles.d.ts +0 -3
- package/lib/FilterList.d.ts +0 -321
- package/lib/FilteredActionList/FilteredActionList.d.ts +0 -16
- package/lib/FilteredActionList/FilteredActionList.js +0 -137
- package/lib/FilteredActionList/index.d.ts +0 -2
- package/lib/FilteredActionList/index.js +0 -13
- package/lib/FilteredSearch.d.ts +0 -6
- package/lib/Flash.d.ts +0 -9
- package/lib/Flex.d.ts +0 -7
- package/lib/FormGroup.d.ts +0 -12
- package/lib/Grid.d.ts +0 -7
- package/lib/Header.d.ts +0 -24
- package/lib/Heading.d.ts +0 -6
- package/lib/Label.d.ts +0 -11
- package/lib/LabelGroup.d.ts +0 -6
- package/lib/Link.d.ts +0 -10
- package/lib/Overlay.d.ts +0 -63
- package/lib/Pagehead.d.ts +0 -6
- package/lib/Pagination/Pagination.d.ts +0 -24
- package/lib/Pagination/index.d.ts +0 -3
- package/lib/Pagination/model.d.ts +0 -26
- package/lib/PointerBox.d.ts +0 -11
- package/lib/Popover.d.ts +0 -21
- package/lib/Portal/Portal.d.ts +0 -25
- package/lib/Portal/index.d.ts +0 -4
- package/lib/Position.d.ts +0 -34
- package/lib/ProgressBar.d.ts +0 -21
- package/lib/SelectMenu/SelectMenu.d.ts +0 -1832
- package/lib/SelectMenu/SelectMenuContext.d.ts +0 -8
- package/lib/SelectMenu/SelectMenuDivider.d.ts +0 -6
- package/lib/SelectMenu/SelectMenuFilter.d.ts +0 -9
- package/lib/SelectMenu/SelectMenuFooter.d.ts +0 -6
- package/lib/SelectMenu/SelectMenuHeader.d.ts +0 -11
- package/lib/SelectMenu/SelectMenuItem.d.ts +0 -15
- package/lib/SelectMenu/SelectMenuList.d.ts +0 -6
- package/lib/SelectMenu/SelectMenuLoadingAnimation.d.ts +0 -7
- package/lib/SelectMenu/SelectMenuModal.d.ts +0 -15
- package/lib/SelectMenu/SelectMenuTab.d.ts +0 -14
- package/lib/SelectMenu/SelectMenuTabPanel.d.ts +0 -13
- package/lib/SelectMenu/SelectMenuTabs.d.ts +0 -11
- package/lib/SelectMenu/hooks/useKeyboardNav.d.ts +0 -2
- package/lib/SelectMenu/index.d.ts +0 -2
- package/lib/SelectPanel/SelectPanel.d.ts +0 -25
- package/lib/SelectPanel/SelectPanel.js +0 -147
- package/lib/SelectPanel/index.d.ts +0 -2
- package/lib/SelectPanel/index.js +0 -13
- package/lib/SideNav.d.ts +0 -31
- package/lib/Spinner.d.ts +0 -17
- package/lib/Spinner.js +0 -60
- package/lib/StateLabel.d.ts +0 -16
- package/lib/StyledOcticon.d.ts +0 -12
- package/lib/SubNav.d.ts +0 -32
- package/lib/TabNav.d.ts +0 -20
- package/lib/Text.d.ts +0 -6
- package/lib/TextInput.d.ts +0 -14
- package/lib/TextInputWithTokens.d.ts +0 -323
- package/lib/TextInputWithTokens.js +0 -244
- package/lib/ThemeProvider.d.ts +0 -26
- package/lib/Timeline.d.ts +0 -407
- package/lib/Token/IssueLabelToken.d.ts +0 -14
- package/lib/Token/IssueLabelToken.js +0 -144
- package/lib/Token/ProfileToken.d.ts +0 -7
- package/lib/Token/ProfileToken.js +0 -53
- package/lib/Token/Token.d.ts +0 -15
- package/lib/Token/Token.js +0 -94
- package/lib/Token/TokenBase.d.ts +0 -17
- package/lib/Token/TokenBase.js +0 -108
- package/lib/Token/_RemoveTokenButton.d.ts +0 -12
- package/lib/Token/_RemoveTokenButton.js +0 -77
- package/lib/Token/_TokenTextContainer.d.ts +0 -3
- package/lib/Token/_TokenTextContainer.js +0 -28
- package/lib/Token/index.d.ts +0 -3
- package/lib/Token/index.js +0 -31
- package/lib/Tooltip.d.ts +0 -18
- package/lib/Truncate.d.ts +0 -11
- package/lib/UnderlineNav.d.ts +0 -25
- package/lib/_TextInputWrapper.d.ts +0 -10
- package/lib/_TextInputWrapper.js +0 -51
- package/lib/_UnstyledTextInput.d.ts +0 -2
- package/lib/_UnstyledTextInput.js +0 -20
- package/lib/behaviors/anchoredPosition.d.ts +0 -89
- package/lib/behaviors/focusTrap.d.ts +0 -12
- package/lib/behaviors/focusZone.d.ts +0 -137
- package/lib/constants.d.ts +0 -20
- package/lib/hooks/index.d.ts +0 -11
- package/lib/hooks/useAnchoredPosition.d.ts +0 -20
- package/lib/hooks/useCombinedRefs.d.ts +0 -10
- package/lib/hooks/useCombinedRefs.js +0 -49
- package/lib/hooks/useDetails.d.ts +0 -17
- package/lib/hooks/useDialog.d.ts +0 -16
- package/lib/hooks/useFocusTrap.d.ts +0 -32
- package/lib/hooks/useFocusZone.d.ts +0 -23
- package/lib/hooks/useOnEscapePress.d.ts +0 -23
- package/lib/hooks/useOnOutsideClick.d.ts +0 -8
- package/lib/hooks/useOpenAndCloseFocus.d.ts +0 -8
- package/lib/hooks/useOverlay.d.ts +0 -15
- package/lib/hooks/useProvidedRefOrCreate.d.ts +0 -10
- package/lib/hooks/useProvidedStateOrCreate.d.ts +0 -10
- package/lib/hooks/useProvidedStateOrCreate.js +0 -27
- package/lib/hooks/useRenderForcingRef.d.ts +0 -8
- package/lib/hooks/useRenderForcingRef.js +0 -25
- package/lib/hooks/useResizeObserver.d.ts +0 -1
- package/lib/hooks/useResizeObserver.js +0 -20
- package/lib/hooks/useSafeTimeout.d.ts +0 -12
- package/lib/hooks/useScrollFlash.d.ts +0 -6
- package/lib/hooks/useScrollFlash.js +0 -29
- package/lib/index.d.ts +0 -114
- package/lib/polyfills/eventListenerSignal.d.ts +0 -6
- package/lib/sx.d.ts +0 -6
- package/lib/theme-preval.d.ts +0 -49
- package/lib/theme.d.ts +0 -2
- package/lib/utils/deprecate.d.ts +0 -18
- package/lib/utils/isNumeric.d.ts +0 -1
- package/lib/utils/iterateFocusableElements.d.ts +0 -42
- package/lib/utils/scrollIntoViewingArea.d.ts +0 -1
- package/lib/utils/scrollIntoViewingArea.js +0 -39
- package/lib/utils/ssr.d.ts +0 -1
- package/lib/utils/ssr.js +0 -19
- package/lib/utils/test-deprecations.d.ts +0 -1
- package/lib/utils/test-helpers.d.ts +0 -0
- package/lib/utils/test-helpers.js +0 -9
- package/lib/utils/test-matchers.d.ts +0 -1
- package/lib/utils/testing.d.ts +0 -1028
- package/lib/utils/theme.d.ts +0 -9
- package/lib/utils/types/AriaRole.d.ts +0 -4
- package/lib/utils/types/ComponentProps.d.ts +0 -9
- package/lib/utils/types/ComponentProps.js +0 -1
- package/lib/utils/types/Flatten.d.ts +0 -4
- package/lib/utils/types/Flatten.js +0 -1
- package/lib/utils/types/Merge.d.ts +0 -19
- package/lib/utils/types/Merge.js +0 -1
- package/lib/utils/types/index.d.ts +0 -4
- package/lib/utils/types/index.js +0 -57
- package/lib/utils/uniqueId.d.ts +0 -1
- package/lib/utils/userAgent.d.ts +0 -1
- package/lib-esm/ActionList/Divider.d.ts +0 -9
- package/lib-esm/ActionList/Divider.js +0 -23
- package/lib-esm/ActionList/Group.d.ts +0 -28
- package/lib-esm/ActionList/Group.js +0 -24
- package/lib-esm/ActionList/Header.d.ts +0 -29
- package/lib-esm/ActionList/Header.js +0 -33
- package/lib-esm/ActionList/Item.d.ts +0 -92
- package/lib-esm/ActionList/Item.js +0 -253
- package/lib-esm/ActionList/List.d.ts +0 -88
- package/lib-esm/ActionList/List.js +0 -181
- package/lib-esm/ActionList/index.d.ts +0 -17
- package/lib-esm/ActionList/index.js +0 -18
- package/lib-esm/ActionMenu.d.ts +0 -40
- package/lib-esm/ActionMenu.js +0 -82
- package/lib-esm/AnchoredOverlay/AnchoredOverlay.d.ts +0 -62
- package/lib-esm/AnchoredOverlay/AnchoredOverlay.js +0 -104
- package/lib-esm/AnchoredOverlay/index.d.ts +0 -2
- package/lib-esm/AnchoredOverlay/index.js +0 -1
- package/lib-esm/Autocomplete/Autocomplete.d.ts +0 -40
- package/lib-esm/Autocomplete/Autocomplete.js +0 -47
- package/lib-esm/Autocomplete/AutocompleteContext.d.ts +0 -17
- package/lib-esm/Autocomplete/AutocompleteContext.js +0 -2
- package/lib-esm/Autocomplete/AutocompleteInput.d.ts +0 -9
- package/lib-esm/Autocomplete/AutocompleteInput.js +0 -131
- package/lib-esm/Autocomplete/AutocompleteMenu.d.ts +0 -71
- package/lib-esm/Autocomplete/AutocompleteMenu.js +0 -204
- package/lib-esm/Autocomplete/AutocompleteOverlay.d.ts +0 -17
- package/lib-esm/Autocomplete/AutocompleteOverlay.js +0 -51
- package/lib-esm/Autocomplete/index.d.ts +0 -2
- package/lib-esm/Autocomplete/index.js +0 -1
- package/lib-esm/Avatar.d.ts +0 -15
- package/lib-esm/AvatarPair.d.ts +0 -8
- package/lib-esm/AvatarStack.d.ts +0 -8
- package/lib-esm/BaseStyles.d.ts +0 -14
- package/lib-esm/BorderBox.d.ts +0 -7
- package/lib-esm/Box.d.ts +0 -6
- package/lib-esm/BranchName.d.ts +0 -6
- package/lib-esm/Breadcrumbs.d.ts +0 -40
- package/lib-esm/Button/Button.d.ts +0 -284
- package/lib-esm/Button/ButtonBase.d.ts +0 -12
- package/lib-esm/Button/ButtonClose.d.ts +0 -321
- package/lib-esm/Button/ButtonDanger.d.ts +0 -284
- package/lib-esm/Button/ButtonGroup.d.ts +0 -4
- package/lib-esm/Button/ButtonInvisible.d.ts +0 -284
- package/lib-esm/Button/ButtonOutline.d.ts +0 -284
- package/lib-esm/Button/ButtonPrimary.d.ts +0 -284
- package/lib-esm/Button/ButtonStyles.d.ts +0 -2
- package/lib-esm/Button/ButtonTableList.d.ts +0 -6
- package/lib-esm/Button/index.d.ts +0 -16
- package/lib-esm/Caret.d.ts +0 -21
- package/lib-esm/CircleBadge.d.ts +0 -25
- package/lib-esm/CircleOcticon.d.ts +0 -391
- package/lib-esm/CounterLabel.d.ts +0 -8
- package/lib-esm/Details.d.ts +0 -6
- package/lib-esm/Dialog/ConfirmationDialog.d.ts +0 -44
- package/lib-esm/Dialog/ConfirmationDialog.js +0 -169
- package/lib-esm/Dialog/Dialog.d.ts +0 -167
- package/lib-esm/Dialog/Dialog.js +0 -274
- package/lib-esm/Dialog.d.ts +0 -406
- package/lib-esm/Dropdown.d.ts +0 -1262
- package/lib-esm/DropdownMenu/DropdownButton.d.ts +0 -323
- package/lib-esm/DropdownMenu/DropdownButton.js +0 -16
- package/lib-esm/DropdownMenu/DropdownMenu.d.ts +0 -43
- package/lib-esm/DropdownMenu/DropdownMenu.js +0 -77
- package/lib-esm/DropdownMenu/index.d.ts +0 -4
- package/lib-esm/DropdownMenu/index.js +0 -2
- package/lib-esm/DropdownStyles.d.ts +0 -3
- package/lib-esm/FilterList.d.ts +0 -321
- package/lib-esm/FilteredActionList/FilteredActionList.d.ts +0 -16
- package/lib-esm/FilteredActionList/FilteredActionList.js +0 -109
- package/lib-esm/FilteredActionList/index.d.ts +0 -2
- package/lib-esm/FilteredActionList/index.js +0 -1
- package/lib-esm/FilteredSearch.d.ts +0 -6
- package/lib-esm/Flash.d.ts +0 -9
- package/lib-esm/Flex.d.ts +0 -7
- package/lib-esm/FormGroup.d.ts +0 -12
- package/lib-esm/Grid.d.ts +0 -7
- package/lib-esm/Header.d.ts +0 -24
- package/lib-esm/Heading.d.ts +0 -6
- package/lib-esm/Label.d.ts +0 -11
- package/lib-esm/LabelGroup.d.ts +0 -6
- package/lib-esm/Link.d.ts +0 -10
- package/lib-esm/Overlay.d.ts +0 -63
- package/lib-esm/Pagehead.d.ts +0 -6
- package/lib-esm/Pagination/Pagination.d.ts +0 -24
- package/lib-esm/Pagination/index.d.ts +0 -3
- package/lib-esm/Pagination/model.d.ts +0 -26
- package/lib-esm/PointerBox.d.ts +0 -11
- package/lib-esm/Popover.d.ts +0 -21
- package/lib-esm/Portal/Portal.d.ts +0 -25
- package/lib-esm/Portal/index.d.ts +0 -4
- package/lib-esm/Position.d.ts +0 -34
- package/lib-esm/ProgressBar.d.ts +0 -21
- package/lib-esm/SelectMenu/SelectMenu.d.ts +0 -1832
- package/lib-esm/SelectMenu/SelectMenuContext.d.ts +0 -8
- package/lib-esm/SelectMenu/SelectMenuDivider.d.ts +0 -6
- package/lib-esm/SelectMenu/SelectMenuFilter.d.ts +0 -9
- package/lib-esm/SelectMenu/SelectMenuFooter.d.ts +0 -6
- package/lib-esm/SelectMenu/SelectMenuHeader.d.ts +0 -11
- package/lib-esm/SelectMenu/SelectMenuItem.d.ts +0 -15
- package/lib-esm/SelectMenu/SelectMenuList.d.ts +0 -6
- package/lib-esm/SelectMenu/SelectMenuLoadingAnimation.d.ts +0 -7
- package/lib-esm/SelectMenu/SelectMenuModal.d.ts +0 -15
- package/lib-esm/SelectMenu/SelectMenuTab.d.ts +0 -14
- package/lib-esm/SelectMenu/SelectMenuTabPanel.d.ts +0 -13
- package/lib-esm/SelectMenu/SelectMenuTabs.d.ts +0 -11
- package/lib-esm/SelectMenu/hooks/useKeyboardNav.d.ts +0 -2
- package/lib-esm/SelectMenu/index.d.ts +0 -2
- package/lib-esm/SelectPanel/SelectPanel.d.ts +0 -25
- package/lib-esm/SelectPanel/SelectPanel.js +0 -127
- package/lib-esm/SelectPanel/index.d.ts +0 -2
- package/lib-esm/SelectPanel/index.js +0 -1
- package/lib-esm/SideNav.d.ts +0 -31
- package/lib-esm/Spinner.d.ts +0 -17
- package/lib-esm/Spinner.js +0 -46
- package/lib-esm/StateLabel.d.ts +0 -16
- package/lib-esm/StyledOcticon.d.ts +0 -12
- package/lib-esm/SubNav.d.ts +0 -32
- package/lib-esm/TabNav.d.ts +0 -20
- package/lib-esm/Text.d.ts +0 -6
- package/lib-esm/TextInput.d.ts +0 -14
- package/lib-esm/TextInputWithTokens.d.ts +0 -323
- package/lib-esm/TextInputWithTokens.js +0 -219
- package/lib-esm/ThemeProvider.d.ts +0 -26
- package/lib-esm/Timeline.d.ts +0 -407
- package/lib-esm/Token/IssueLabelToken.d.ts +0 -14
- package/lib-esm/Token/IssueLabelToken.js +0 -124
- package/lib-esm/Token/ProfileToken.d.ts +0 -7
- package/lib-esm/Token/ProfileToken.js +0 -33
- package/lib-esm/Token/Token.d.ts +0 -15
- package/lib-esm/Token/Token.js +0 -73
- package/lib-esm/Token/TokenBase.d.ts +0 -17
- package/lib-esm/Token/TokenBase.js +0 -87
- package/lib-esm/Token/_RemoveTokenButton.d.ts +0 -12
- package/lib-esm/Token/_RemoveTokenButton.js +0 -60
- package/lib-esm/Token/_TokenTextContainer.d.ts +0 -3
- package/lib-esm/Token/_TokenTextContainer.js +0 -15
- package/lib-esm/Token/index.d.ts +0 -3
- package/lib-esm/Token/index.js +0 -3
- package/lib-esm/Tooltip.d.ts +0 -18
- package/lib-esm/Truncate.d.ts +0 -11
- package/lib-esm/UnderlineNav.d.ts +0 -25
- package/lib-esm/_TextInputWrapper.d.ts +0 -10
- package/lib-esm/_TextInputWrapper.js +0 -31
- package/lib-esm/_UnstyledTextInput.d.ts +0 -2
- package/lib-esm/_UnstyledTextInput.js +0 -7
- package/lib-esm/behaviors/anchoredPosition.d.ts +0 -89
- package/lib-esm/behaviors/focusTrap.d.ts +0 -12
- package/lib-esm/behaviors/focusZone.d.ts +0 -137
- package/lib-esm/constants.d.ts +0 -20
- package/lib-esm/hooks/index.d.ts +0 -11
- package/lib-esm/hooks/useAnchoredPosition.d.ts +0 -20
- package/lib-esm/hooks/useCombinedRefs.d.ts +0 -10
- package/lib-esm/hooks/useCombinedRefs.js +0 -36
- package/lib-esm/hooks/useDetails.d.ts +0 -17
- package/lib-esm/hooks/useDialog.d.ts +0 -16
- package/lib-esm/hooks/useFocusTrap.d.ts +0 -32
- package/lib-esm/hooks/useFocusZone.d.ts +0 -23
- package/lib-esm/hooks/useOnEscapePress.d.ts +0 -23
- package/lib-esm/hooks/useOnOutsideClick.d.ts +0 -8
- package/lib-esm/hooks/useOpenAndCloseFocus.d.ts +0 -8
- package/lib-esm/hooks/useOverlay.d.ts +0 -15
- package/lib-esm/hooks/useProvidedRefOrCreate.d.ts +0 -10
- package/lib-esm/hooks/useProvidedStateOrCreate.d.ts +0 -10
- package/lib-esm/hooks/useProvidedStateOrCreate.js +0 -20
- package/lib-esm/hooks/useRenderForcingRef.d.ts +0 -8
- package/lib-esm/hooks/useRenderForcingRef.js +0 -18
- package/lib-esm/hooks/useResizeObserver.d.ts +0 -1
- package/lib-esm/hooks/useResizeObserver.js +0 -10
- package/lib-esm/hooks/useSafeTimeout.d.ts +0 -12
- package/lib-esm/hooks/useScrollFlash.d.ts +0 -6
- package/lib-esm/hooks/useScrollFlash.js +0 -22
- package/lib-esm/index.d.ts +0 -114
- package/lib-esm/polyfills/eventListenerSignal.d.ts +0 -6
- package/lib-esm/sx.d.ts +0 -6
- package/lib-esm/theme-preval.d.ts +0 -49
- package/lib-esm/theme.d.ts +0 -2
- package/lib-esm/utils/deprecate.d.ts +0 -18
- package/lib-esm/utils/isNumeric.d.ts +0 -1
- package/lib-esm/utils/iterateFocusableElements.d.ts +0 -42
- package/lib-esm/utils/scrollIntoViewingArea.d.ts +0 -1
- package/lib-esm/utils/scrollIntoViewingArea.js +0 -30
- package/lib-esm/utils/ssr.d.ts +0 -1
- package/lib-esm/utils/ssr.js +0 -1
- package/lib-esm/utils/test-deprecations.d.ts +0 -1
- package/lib-esm/utils/test-helpers.js +0 -7
- package/lib-esm/utils/test-matchers.d.ts +0 -1
- package/lib-esm/utils/testing.d.ts +0 -1028
- package/lib-esm/utils/theme.d.ts +0 -9
- package/lib-esm/utils/types/AriaRole.d.ts +0 -4
- package/lib-esm/utils/types/AriaRole.js +0 -1
- package/lib-esm/utils/types/ComponentProps.d.ts +0 -9
- package/lib-esm/utils/types/ComponentProps.js +0 -1
- package/lib-esm/utils/types/Flatten.d.ts +0 -4
- package/lib-esm/utils/types/Flatten.js +0 -1
- package/lib-esm/utils/types/Merge.d.ts +0 -19
- package/lib-esm/utils/types/Merge.js +0 -1
- package/lib-esm/utils/types/index.d.ts +0 -4
- package/lib-esm/utils/types/index.js +0 -4
- package/lib-esm/utils/uniqueId.d.ts +0 -1
- package/lib-esm/utils/userAgent.d.ts +0 -1
@@ -0,0 +1,445 @@
|
|
1
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
2
|
+
import React, { useCallback, useRef, useState } from 'react';
|
3
|
+
import styled, { createGlobalStyle } from 'styled-components';
|
4
|
+
import { Absolute, BaseStyles, BorderBox, Button, Flash, Grid, theme, ThemeProvider } from '..';
|
5
|
+
import { FocusKeys } from '../behaviors/focusZone';
|
6
|
+
import Flex from '../Flex';
|
7
|
+
import { themeGet } from '@styled-system/theme-get';
|
8
|
+
import { useFocusZone } from '../hooks/useFocusZone';
|
9
|
+
import { useTheme } from '../ThemeProvider';
|
10
|
+
import { ButtonDanger, ButtonPrimary } from '../Button';
|
11
|
+
export default {
|
12
|
+
title: 'Hooks/useFocusZone',
|
13
|
+
decorators: [Story => {
|
14
|
+
return /*#__PURE__*/React.createElement(ThemeProvider, {
|
15
|
+
theme: theme
|
16
|
+
}, /*#__PURE__*/React.createElement(BaseStyles, null, /*#__PURE__*/React.createElement(Story, null)));
|
17
|
+
}]
|
18
|
+
}; // NOTE: the below styles are solely intended as a visual aid for
|
19
|
+
// this Storybook story, but they're not recommended for a real site!
|
20
|
+
|
21
|
+
const HelperGlobalStyling = createGlobalStyle`
|
22
|
+
*:focus {
|
23
|
+
outline: 2px solid ${themeGet('colors.border.info')} !important;
|
24
|
+
}
|
25
|
+
`;
|
26
|
+
const MarginButton = styled(Button).withConfig({
|
27
|
+
displayName: "useFocusZonestories__MarginButton",
|
28
|
+
componentId: "e94kdz-0"
|
29
|
+
})(["margin:", ";"], themeGet('space.1'));
|
30
|
+
export const BasicFocusZone = () => {
|
31
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
32
|
+
const [lastKey, setLastKey] = useState('none');
|
33
|
+
const reportKey = useCallback(event => {
|
34
|
+
setLastKey(event.key);
|
35
|
+
}, []);
|
36
|
+
const [fzEnabled, setFzEnabled] = useState(true);
|
37
|
+
const {
|
38
|
+
containerRef
|
39
|
+
} = useFocusZone({
|
40
|
+
disabled: !fzEnabled
|
41
|
+
}, [fzEnabled]);
|
42
|
+
const ToggleButton = fzEnabled ? ButtonDanger : ButtonPrimary;
|
43
|
+
const toggleFz = useCallback(() => {
|
44
|
+
setFzEnabled(!fzEnabled);
|
45
|
+
}, [fzEnabled]);
|
46
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
47
|
+
flexDirection: "column",
|
48
|
+
alignItems: "flex-start",
|
49
|
+
onKeyDownCapture: reportKey
|
50
|
+
}, /*#__PURE__*/React.createElement(Absolute, {
|
51
|
+
right: 5,
|
52
|
+
top: 2
|
53
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(ToggleButton, {
|
54
|
+
mb: 3,
|
55
|
+
onClick: toggleFz
|
56
|
+
}, fzEnabled ? 'Disable' : 'Enable', " Focus Zone"), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(BorderBox, {
|
57
|
+
borderColor: "gray.5",
|
58
|
+
ref: containerRef,
|
59
|
+
m: 4,
|
60
|
+
p: 4
|
61
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Use Up Arrow, Down Arrow, Home, and End to move focus within this box."), /*#__PURE__*/React.createElement(Flex, {
|
62
|
+
flexDirection: "column",
|
63
|
+
alignItems: "flex-start"
|
64
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Durian"), /*#__PURE__*/React.createElement(MarginButton, null, "Elderberry"), /*#__PURE__*/React.createElement(MarginButton, null, "Fig"))), /*#__PURE__*/React.createElement(MarginButton, null, "Kiwi"), /*#__PURE__*/React.createElement(MarginButton, null, "Lemon"), /*#__PURE__*/React.createElement(MarginButton, null, "Mango")));
|
65
|
+
};
|
66
|
+
export const FocusOutBehavior = () => {
|
67
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
68
|
+
const [lastKey, setLastKey] = useState('none');
|
69
|
+
const reportKey = useCallback(event => {
|
70
|
+
setLastKey(event.key);
|
71
|
+
}, []);
|
72
|
+
const {
|
73
|
+
containerRef: containerRef1
|
74
|
+
} = useFocusZone({
|
75
|
+
focusOutBehavior: 'stop',
|
76
|
+
bindKeys: FocusKeys.ArrowHorizontal | FocusKeys.HomeAndEnd
|
77
|
+
});
|
78
|
+
const {
|
79
|
+
containerRef: containerRef2
|
80
|
+
} = useFocusZone({
|
81
|
+
focusOutBehavior: 'wrap',
|
82
|
+
bindKeys: FocusKeys.ArrowHorizontal | FocusKeys.HomeAndEnd
|
83
|
+
});
|
84
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
85
|
+
flexDirection: "column",
|
86
|
+
alignItems: "flex-start",
|
87
|
+
onKeyDownCapture: reportKey
|
88
|
+
}, /*#__PURE__*/React.createElement(Absolute, {
|
89
|
+
right: 5,
|
90
|
+
top: 2
|
91
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(BorderBox, {
|
92
|
+
borderColor: "gray.5",
|
93
|
+
ref: containerRef1,
|
94
|
+
m: 4,
|
95
|
+
p: 4
|
96
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Use Left Arrow, Right Arrow, Home, and End to move focus within this box. Focus stops at the ends."), /*#__PURE__*/React.createElement(Flex, {
|
97
|
+
flexDirection: "row",
|
98
|
+
alignItems: "flex-start"
|
99
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Durian"), /*#__PURE__*/React.createElement(MarginButton, null, "Elderberry"), /*#__PURE__*/React.createElement(MarginButton, null, "Fig"))), /*#__PURE__*/React.createElement(BorderBox, {
|
100
|
+
borderColor: "gray.5",
|
101
|
+
ref: containerRef2,
|
102
|
+
m: 4,
|
103
|
+
p: 4
|
104
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Use Left Arrow, Right Arrow, Home, and End to move focus within this box. Focus is circular."), /*#__PURE__*/React.createElement(Flex, {
|
105
|
+
flexDirection: "row",
|
106
|
+
alignItems: "flex-start"
|
107
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Grapefruit"), /*#__PURE__*/React.createElement(MarginButton, null, "Honeydew"), /*#__PURE__*/React.createElement(MarginButton, null, "Jackfruit"))), /*#__PURE__*/React.createElement(MarginButton, null, "Kiwi"), /*#__PURE__*/React.createElement(MarginButton, null, "Lemon"), /*#__PURE__*/React.createElement(MarginButton, null, "Mango")));
|
108
|
+
};
|
109
|
+
|
110
|
+
function getSiblingIndex(element) {
|
111
|
+
let child = element;
|
112
|
+
let i = 0;
|
113
|
+
|
114
|
+
while ((child = child.previousElementSibling) != null) {
|
115
|
+
++i;
|
116
|
+
}
|
117
|
+
|
118
|
+
return i;
|
119
|
+
}
|
120
|
+
|
121
|
+
export const CustomFocusMovement = () => {
|
122
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
123
|
+
const [lastKey, setLastKey] = useState('none');
|
124
|
+
const reportKey = useCallback(event => {
|
125
|
+
setLastKey(event.key);
|
126
|
+
}, []);
|
127
|
+
const containerRef = useRef(null);
|
128
|
+
const getNextFocusable = useCallback((direction, from, event) => {
|
129
|
+
const toEnd = direction === 'start' || direction === 'end';
|
130
|
+
|
131
|
+
if (from && containerRef.current) {
|
132
|
+
const currentIndex = getSiblingIndex(from);
|
133
|
+
let nextIndex = currentIndex;
|
134
|
+
|
135
|
+
if (['End', 'ArrowRight'].includes(event.key)) {
|
136
|
+
while (nextIndex % 3 !== 2) {
|
137
|
+
nextIndex += 1;
|
138
|
+
|
139
|
+
if (!toEnd) {
|
140
|
+
break;
|
141
|
+
}
|
142
|
+
}
|
143
|
+
}
|
144
|
+
|
145
|
+
if (['Home', 'ArrowLeft'].includes(event.key)) {
|
146
|
+
while (nextIndex % 3 !== 0) {
|
147
|
+
nextIndex -= 1;
|
148
|
+
|
149
|
+
if (!toEnd) {
|
150
|
+
break;
|
151
|
+
}
|
152
|
+
}
|
153
|
+
}
|
154
|
+
|
155
|
+
if (event.key === 'ArrowUp') {
|
156
|
+
while (nextIndex - 3 >= 0) {
|
157
|
+
nextIndex -= 3;
|
158
|
+
|
159
|
+
if (!toEnd) {
|
160
|
+
break;
|
161
|
+
}
|
162
|
+
}
|
163
|
+
}
|
164
|
+
|
165
|
+
if (event.key === 'ArrowDown') {
|
166
|
+
while (nextIndex + 3 < 9) {
|
167
|
+
nextIndex += 3;
|
168
|
+
|
169
|
+
if (!toEnd) {
|
170
|
+
break;
|
171
|
+
}
|
172
|
+
}
|
173
|
+
}
|
174
|
+
|
175
|
+
return containerRef.current.children[nextIndex];
|
176
|
+
}
|
177
|
+
}, [containerRef]);
|
178
|
+
useFocusZone({
|
179
|
+
containerRef,
|
180
|
+
getNextFocusable
|
181
|
+
});
|
182
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
183
|
+
flexDirection: "column",
|
184
|
+
alignItems: "flex-start",
|
185
|
+
onKeyDownCapture: reportKey
|
186
|
+
}, /*#__PURE__*/React.createElement(Absolute, {
|
187
|
+
right: 5,
|
188
|
+
top: 2
|
189
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(BorderBox, {
|
190
|
+
borderColor: "gray.5",
|
191
|
+
m: 4,
|
192
|
+
p: 4
|
193
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Use arrow keys to move focus within this box."), /*#__PURE__*/React.createElement(Grid, {
|
194
|
+
ref: containerRef,
|
195
|
+
gridTemplateRows: "1fr 1fr 1fr",
|
196
|
+
gridTemplateColumns: "1fr 1fr 1fr"
|
197
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(MarginButton, null, "Durian"), /*#__PURE__*/React.createElement(MarginButton, null, "Elderberry"), /*#__PURE__*/React.createElement(MarginButton, null, "Fig"), /*#__PURE__*/React.createElement(MarginButton, null, "Grapefruit"), /*#__PURE__*/React.createElement(MarginButton, null, "Honeydew"), /*#__PURE__*/React.createElement(MarginButton, null, "Jackfruit"), /*#__PURE__*/React.createElement(MarginButton, null, "Kiwi"))), /*#__PURE__*/React.createElement(MarginButton, null, "Lemon"), /*#__PURE__*/React.createElement(MarginButton, null, "Mango")));
|
198
|
+
};
|
199
|
+
export const FocusInStrategy = () => {
|
200
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
201
|
+
const [lastKey, setLastKey] = useState('none');
|
202
|
+
const reportKey = useCallback(event => {
|
203
|
+
setLastKey(event.key);
|
204
|
+
}, []);
|
205
|
+
const {
|
206
|
+
containerRef: firstContainerRef
|
207
|
+
} = useFocusZone({
|
208
|
+
bindKeys: FocusKeys.ArrowHorizontal | FocusKeys.HomeAndEnd,
|
209
|
+
focusInStrategy: 'first'
|
210
|
+
});
|
211
|
+
const {
|
212
|
+
containerRef: prevContainerRef
|
213
|
+
} = useFocusZone({
|
214
|
+
bindKeys: FocusKeys.ArrowHorizontal | FocusKeys.HomeAndEnd,
|
215
|
+
focusInStrategy: 'previous'
|
216
|
+
});
|
217
|
+
const customContainerRef = useRef(null);
|
218
|
+
const customStrategy = React.useCallback(() => {
|
219
|
+
if (customContainerRef.current) {
|
220
|
+
const buttons = Array.from(customContainerRef.current.querySelectorAll('button'));
|
221
|
+
return buttons[Math.floor(Math.random() * 3)];
|
222
|
+
}
|
223
|
+
}, [customContainerRef]);
|
224
|
+
useFocusZone({
|
225
|
+
containerRef: customContainerRef,
|
226
|
+
bindKeys: FocusKeys.ArrowHorizontal | FocusKeys.HomeAndEnd,
|
227
|
+
focusInStrategy: customStrategy
|
228
|
+
});
|
229
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
230
|
+
flexDirection: "column",
|
231
|
+
alignItems: "flex-start",
|
232
|
+
onKeyDownCapture: reportKey
|
233
|
+
}, /*#__PURE__*/React.createElement(Absolute, {
|
234
|
+
right: 5,
|
235
|
+
top: 2
|
236
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(BorderBox, {
|
237
|
+
borderColor: "gray.5",
|
238
|
+
ref: firstContainerRef,
|
239
|
+
m: 4,
|
240
|
+
p: 4
|
241
|
+
}, /*#__PURE__*/React.createElement("strong", null, "\u201CFirst\u201D strategy (focus first focusable element)"), /*#__PURE__*/React.createElement(Flex, {
|
242
|
+
flexDirection: "row",
|
243
|
+
alignItems: "flex-start"
|
244
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(MarginButton, null, "Durian"))), /*#__PURE__*/React.createElement(BorderBox, {
|
245
|
+
borderColor: "gray.5",
|
246
|
+
ref: prevContainerRef,
|
247
|
+
m: 4,
|
248
|
+
p: 4
|
249
|
+
}, /*#__PURE__*/React.createElement("strong", null, "\u201CPrevious\u201D strategy (most recently focused element)"), /*#__PURE__*/React.createElement(Flex, {
|
250
|
+
flexDirection: "row",
|
251
|
+
alignItems: "flex-start"
|
252
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Elderberry"), /*#__PURE__*/React.createElement(MarginButton, null, "Fig"), /*#__PURE__*/React.createElement(MarginButton, null, "Grapefruit"))), /*#__PURE__*/React.createElement(BorderBox, {
|
253
|
+
borderColor: "gray.5",
|
254
|
+
ref: customContainerRef,
|
255
|
+
m: 4,
|
256
|
+
p: 4
|
257
|
+
}, /*#__PURE__*/React.createElement("strong", null, "\u201CCustom\u201D strategy (choose randomly for this example)"), /*#__PURE__*/React.createElement(Flex, {
|
258
|
+
flexDirection: "row",
|
259
|
+
alignItems: "flex-start"
|
260
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Honeydew"), /*#__PURE__*/React.createElement(MarginButton, null, "Jackfruit"), /*#__PURE__*/React.createElement(MarginButton, null, "Kiwi"))), /*#__PURE__*/React.createElement(MarginButton, null, "Lemon"), /*#__PURE__*/React.createElement(MarginButton, null, "Mango")));
|
261
|
+
};
|
262
|
+
export const SpecialSituations = () => {
|
263
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
264
|
+
const [lastKey, setLastKey] = useState('none');
|
265
|
+
const reportKey = useCallback(event => {
|
266
|
+
setLastKey(event.key);
|
267
|
+
}, []);
|
268
|
+
const {
|
269
|
+
containerRef: vContainerRef
|
270
|
+
} = useFocusZone({
|
271
|
+
bindKeys: FocusKeys.ArrowVertical | FocusKeys.JK | FocusKeys.WS | FocusKeys.Tab | FocusKeys.PageUpDown | FocusKeys.HomeAndEnd
|
272
|
+
});
|
273
|
+
const {
|
274
|
+
containerRef: hContainerRef
|
275
|
+
} = useFocusZone({
|
276
|
+
focusOutBehavior: 'wrap',
|
277
|
+
bindKeys: FocusKeys.ArrowHorizontal
|
278
|
+
});
|
279
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
280
|
+
flexDirection: "column",
|
281
|
+
alignItems: "flex-start",
|
282
|
+
onKeyDownCapture: reportKey
|
283
|
+
}, /*#__PURE__*/React.createElement(Flash, {
|
284
|
+
mb: 3
|
285
|
+
}, "This story is very esoteric! It only exists to show some of the nuance of the arrow key focus behavior in different situations. Focus treatment within your component should be evaluated for your particular UX using the ", /*#__PURE__*/React.createElement("a", {
|
286
|
+
href: "https://www.w3.org/TR/wai-aria-practices-1.1/#keyboard"
|
287
|
+
}, "ARIA guidelines"), "."), /*#__PURE__*/React.createElement(Absolute, {
|
288
|
+
right: 5,
|
289
|
+
top: 2
|
290
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(BorderBox, {
|
291
|
+
borderColor: "gray.5",
|
292
|
+
ref: vContainerRef,
|
293
|
+
m: 4,
|
294
|
+
p: 4
|
295
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Bound keys: Up, Down, PageUp, PageDown, W, S, J, K, Home, End, Tab"), /*#__PURE__*/React.createElement(Flex, {
|
296
|
+
flexDirection: "column",
|
297
|
+
alignItems: "flex-start"
|
298
|
+
}, /*#__PURE__*/React.createElement("input", {
|
299
|
+
style: {
|
300
|
+
width: '250px'
|
301
|
+
},
|
302
|
+
type: "text",
|
303
|
+
defaultValue: "Printable characters won't move focus"
|
304
|
+
}), /*#__PURE__*/React.createElement(MarginButton, null, "Regular button"), /*#__PURE__*/React.createElement("select", null, /*#__PURE__*/React.createElement("option", null, "Down arrow invokes dropdown"), /*#__PURE__*/React.createElement("option", null, "Unless Cmd (mac)/Ctrl (Windows)"), /*#__PURE__*/React.createElement("option", null, "Is held")), /*#__PURE__*/React.createElement("textarea", {
|
305
|
+
style: {
|
306
|
+
width: '250px',
|
307
|
+
height: '95px'
|
308
|
+
},
|
309
|
+
defaultValue: "Up/Down only works when at beginning/end. PageUp and PageDown completely disabled. Printable characters will never move focus."
|
310
|
+
}))), /*#__PURE__*/React.createElement(BorderBox, {
|
311
|
+
borderColor: "gray.5",
|
312
|
+
ref: hContainerRef,
|
313
|
+
m: 4,
|
314
|
+
p: 4
|
315
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Use Left Arrow and Right Arrow to move focus within this box. Focus is circular."), /*#__PURE__*/React.createElement(Flex, {
|
316
|
+
flexDirection: "row",
|
317
|
+
alignItems: "center"
|
318
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Grapefruit"), /*#__PURE__*/React.createElement("input", {
|
319
|
+
style: {
|
320
|
+
width: '300px'
|
321
|
+
},
|
322
|
+
type: "text",
|
323
|
+
defaultValue: "Left/Right only work at beginning/end of input."
|
324
|
+
}), /*#__PURE__*/React.createElement(MarginButton, null, "Jackfruit"))), /*#__PURE__*/React.createElement(MarginButton, null, "Kiwi"), /*#__PURE__*/React.createElement(MarginButton, null, "Lemon"), /*#__PURE__*/React.createElement(MarginButton, null, "Mango")));
|
325
|
+
};
|
326
|
+
export const ChangingSubtree = () => {
|
327
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
328
|
+
const [lastKey, setLastKey] = useState('none');
|
329
|
+
const reportKey = useCallback(event => {
|
330
|
+
setLastKey(event.key);
|
331
|
+
}, []);
|
332
|
+
const {
|
333
|
+
containerRef
|
334
|
+
} = useFocusZone({
|
335
|
+
bindKeys: FocusKeys.ArrowVertical
|
336
|
+
});
|
337
|
+
const [buttonCount, setButtonCount] = useState(3);
|
338
|
+
const removeButton = useCallback(() => {
|
339
|
+
setButtonCount(buttonCount - 1);
|
340
|
+
}, [setButtonCount, buttonCount]);
|
341
|
+
const addButton = useCallback(() => {
|
342
|
+
setButtonCount(buttonCount + 1);
|
343
|
+
}, [setButtonCount, buttonCount]);
|
344
|
+
const buttons = [];
|
345
|
+
|
346
|
+
for (let i = 0; i < buttonCount; ++i) {
|
347
|
+
buttons.push( /*#__PURE__*/React.createElement(MarginButton, {
|
348
|
+
key: 'button' + i
|
349
|
+
}, i + 1));
|
350
|
+
}
|
351
|
+
|
352
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
353
|
+
flexDirection: "column",
|
354
|
+
alignItems: "flex-start",
|
355
|
+
onKeyDownCapture: reportKey
|
356
|
+
}, /*#__PURE__*/React.createElement(Flash, {
|
357
|
+
mb: 3
|
358
|
+
}, "This story demonstrates that focusZone is consistent even when the container\u2019s subtree changes."), /*#__PURE__*/React.createElement(Absolute, {
|
359
|
+
right: 5,
|
360
|
+
top: 2
|
361
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(BorderBox, {
|
362
|
+
borderColor: "gray.5",
|
363
|
+
ref: containerRef,
|
364
|
+
m: 4,
|
365
|
+
p: 4
|
366
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Bound keys: Arrow Up and Arrow Down"), /*#__PURE__*/React.createElement(Flex, {
|
367
|
+
flexDirection: "column",
|
368
|
+
alignItems: "flex-start"
|
369
|
+
}, buttons)), /*#__PURE__*/React.createElement(Flex, {
|
370
|
+
flexDirection: "row"
|
371
|
+
}, /*#__PURE__*/React.createElement(MarginButton, {
|
372
|
+
onClick: removeButton
|
373
|
+
}, "Remove Button"), /*#__PURE__*/React.createElement(MarginButton, {
|
374
|
+
onClick: addButton
|
375
|
+
}, "Add Button"))));
|
376
|
+
};
|
377
|
+
export const ActiveDescendant = () => {
|
378
|
+
// Display each key press in the top-right corner of the page as a visual aid
|
379
|
+
const [lastKey, setLastKey] = useState('none');
|
380
|
+
const reportKey = useCallback(event => {
|
381
|
+
setLastKey(event.key);
|
382
|
+
}, []);
|
383
|
+
const containerRef = useRef(null);
|
384
|
+
const controllingElementRef = useRef(null);
|
385
|
+
const {
|
386
|
+
theme
|
387
|
+
} = useTheme(); // We set up two arrow focus behaviors on the same container!
|
388
|
+
// 1. Handles the active descendant treatment when the <input> element is focused
|
389
|
+
// 2. Handles regular focus treatment when the container itself is focused.
|
390
|
+
|
391
|
+
useFocusZone({
|
392
|
+
containerRef,
|
393
|
+
activeDescendantFocus: controllingElementRef,
|
394
|
+
bindKeys: FocusKeys.ArrowVertical,
|
395
|
+
onActiveDescendantChanged: (current, previous) => {
|
396
|
+
if (current) {
|
397
|
+
current.style.outline = `2px solid ${theme.colors.border.info}`;
|
398
|
+
}
|
399
|
+
|
400
|
+
if (previous) {
|
401
|
+
previous.style.outline = '';
|
402
|
+
}
|
403
|
+
},
|
404
|
+
focusableElementFilter: elem => elem instanceof HTMLButtonElement
|
405
|
+
});
|
406
|
+
useFocusZone({
|
407
|
+
containerRef,
|
408
|
+
bindKeys: FocusKeys.ArrowVertical,
|
409
|
+
getNextFocusable: (direction, from) => {
|
410
|
+
if (direction === 'previous' && from && from === containerRef.current) {
|
411
|
+
var _controllingElementRe;
|
412
|
+
|
413
|
+
return (_controllingElementRe = controllingElementRef.current) !== null && _controllingElementRe !== void 0 ? _controllingElementRe : undefined;
|
414
|
+
}
|
415
|
+
}
|
416
|
+
});
|
417
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(HelperGlobalStyling, null), /*#__PURE__*/React.createElement(Flex, {
|
418
|
+
flexDirection: "column",
|
419
|
+
alignItems: "flex-start",
|
420
|
+
onKeyDownCapture: reportKey
|
421
|
+
}, /*#__PURE__*/React.createElement(Flash, {
|
422
|
+
mb: 3
|
423
|
+
}, "This story demonstrates using the `aria-activedescendant` pattern for managing both a focused element and an active element. Below, you can focus the input box then use the up/down arrow keys to change the active descendant (dark blue outline). Furthermore, this story shows how to simultaneously set up a regular arrow key focus treatment on the buttons. This pattern is used in a select menu with a filter box."), /*#__PURE__*/React.createElement(Absolute, {
|
424
|
+
right: 5,
|
425
|
+
top: 2
|
426
|
+
}, "Last key pressed: ", lastKey), /*#__PURE__*/React.createElement(MarginButton, null, "Apple"), /*#__PURE__*/React.createElement(MarginButton, null, "Banana"), /*#__PURE__*/React.createElement(MarginButton, null, "Cantaloupe"), /*#__PURE__*/React.createElement(BorderBox, {
|
427
|
+
borderColor: "gray.5",
|
428
|
+
m: 4,
|
429
|
+
p: 4
|
430
|
+
}, /*#__PURE__*/React.createElement("strong", null, "Bound keys: Arrow Up and Arrow Down"), /*#__PURE__*/React.createElement(Flex, {
|
431
|
+
flexDirection: "column",
|
432
|
+
alignItems: "flex-start"
|
433
|
+
}, /*#__PURE__*/React.createElement("input", {
|
434
|
+
ref: controllingElementRef,
|
435
|
+
type: "text",
|
436
|
+
defaultValue: "Focus remains here.",
|
437
|
+
"aria-controls": "list"
|
438
|
+
}), /*#__PURE__*/React.createElement(Flex, {
|
439
|
+
id: "list",
|
440
|
+
tabIndex: 0,
|
441
|
+
flexDirection: "column",
|
442
|
+
alignItems: "flex-start",
|
443
|
+
ref: containerRef
|
444
|
+
}, /*#__PURE__*/React.createElement(MarginButton, null, "Durian"), /*#__PURE__*/React.createElement(MarginButton, null, "Elderberry"), /*#__PURE__*/React.createElement(MarginButton, null, "Fig"), /*#__PURE__*/React.createElement(MarginButton, null, "Grapefruit")))), /*#__PURE__*/React.createElement(MarginButton, null, "Honeydew"), /*#__PURE__*/React.createElement(MarginButton, null, "Jackfruit"), /*#__PURE__*/React.createElement(MarginButton, null, "Kiwi")));
|
445
|
+
};
|