@primer/components 31.2.0-rc.c7f73427 → 31.2.1-rc.0e01900c
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/.github/workflows/ci.yml +5 -2
- package/.github/workflows/release.yml +1 -0
- package/.github/workflows/release_canary.yml +1 -0
- package/CHANGELOG.md +18 -0
- package/dist/browser.esm.js +656 -645
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +211 -200
- package/dist/browser.umd.js.map +1 -1
- package/docs/content/ActionList2.mdx +358 -0
- package/docs/content/StateLabel.md +5 -4
- package/docs/content/getting-started.md +1 -1
- package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +17 -0
- package/lib/ActionList/Divider.jsx +29 -0
- package/lib/ActionList/Group.jsx +23 -0
- package/lib/ActionList/Header.jsx +66 -0
- package/lib/ActionList/Item.js +28 -19
- package/lib/ActionList/Item.jsx +311 -0
- package/lib/ActionList/List.jsx +138 -0
- package/lib/ActionList/index.js +12 -23
- package/lib/ActionList2/Description.d.ts +12 -0
- package/lib/ActionList2/Description.js +57 -0
- package/lib/ActionList2/Description.jsx +29 -0
- package/lib/ActionList2/Divider.d.ts +5 -0
- package/lib/ActionList2/Divider.js +35 -0
- package/lib/ActionList2/Divider.jsx +22 -0
- package/lib/ActionList2/Group.d.ts +11 -0
- package/lib/ActionList2/Group.js +57 -0
- package/lib/ActionList2/Group.jsx +25 -0
- package/lib/ActionList2/Header.d.ts +26 -0
- package/lib/ActionList2/Header.js +55 -0
- package/lib/ActionList2/Header.jsx +36 -0
- package/lib/ActionList2/Item.d.ts +63 -0
- package/lib/ActionList2/Item.js +242 -0
- package/lib/ActionList2/Item.jsx +174 -0
- package/lib/ActionList2/LinkItem.d.ts +17 -0
- package/lib/ActionList2/LinkItem.js +57 -0
- package/lib/ActionList2/LinkItem.jsx +28 -0
- package/lib/ActionList2/List.d.ts +26 -0
- package/lib/ActionList2/List.js +59 -0
- package/lib/ActionList2/List.jsx +41 -0
- package/lib/ActionList2/Selection.d.ts +5 -0
- package/lib/ActionList2/Selection.js +84 -0
- package/lib/ActionList2/Selection.jsx +50 -0
- package/lib/ActionList2/Visuals.d.ts +9 -0
- package/lib/ActionList2/Visuals.js +90 -0
- package/lib/ActionList2/Visuals.jsx +48 -0
- package/lib/ActionList2/index.d.ts +36 -0
- package/lib/ActionList2/index.js +29 -0
- package/lib/ActionMenu.jsx +73 -0
- package/lib/AnchoredOverlay/AnchoredOverlay.jsx +100 -0
- package/lib/AnchoredOverlay/index.js +4 -12
- package/lib/Autocomplete/Autocomplete.d.ts +28 -28
- package/lib/Autocomplete/Autocomplete.jsx +100 -0
- package/lib/Autocomplete/AutocompleteContext.jsx +5 -0
- package/lib/Autocomplete/AutocompleteInput.d.ts +28 -28
- package/lib/Autocomplete/AutocompleteInput.jsx +113 -0
- package/lib/Autocomplete/AutocompleteMenu.jsx +190 -0
- package/lib/Autocomplete/AutocompleteOverlay.jsx +55 -0
- package/lib/Autocomplete/index.js +7 -14
- package/lib/Avatar.jsx +34 -0
- package/lib/AvatarPair.jsx +29 -0
- package/lib/AvatarStack.jsx +151 -0
- package/lib/BaseStyles.jsx +65 -0
- package/lib/BorderBox.jsx +18 -0
- package/lib/Box.jsx +10 -0
- package/lib/BranchName.jsx +20 -0
- package/lib/Breadcrumbs.jsx +74 -0
- package/lib/Button/Button.d.ts +25 -25
- package/lib/Button/Button.jsx +60 -0
- package/lib/Button/ButtonBase.jsx +36 -0
- package/lib/Button/ButtonClose.d.ts +45 -45
- package/lib/Button/ButtonClose.jsx +55 -0
- package/lib/Button/ButtonDanger.d.ts +25 -25
- package/lib/Button/ButtonDanger.jsx +63 -0
- package/lib/Button/ButtonGroup.jsx +55 -0
- package/lib/Button/ButtonInvisible.d.ts +25 -25
- package/lib/Button/ButtonInvisible.jsx +52 -0
- package/lib/Button/ButtonOutline.d.ts +25 -25
- package/lib/Button/ButtonOutline.jsx +63 -0
- package/lib/Button/ButtonPrimary.d.ts +25 -25
- package/lib/Button/ButtonPrimary.jsx +62 -0
- package/lib/Button/ButtonStyles.jsx +37 -0
- package/lib/Button/ButtonTableList.jsx +49 -0
- package/lib/Button/index.js +21 -70
- package/lib/Caret.jsx +93 -0
- package/lib/CircleBadge.jsx +43 -0
- package/lib/CircleOcticon.d.ts +42 -42
- package/lib/CircleOcticon.jsx +21 -0
- package/lib/CounterLabel.jsx +44 -0
- package/lib/Details.jsx +21 -0
- package/lib/Dialog/ConfirmationDialog.jsx +146 -0
- package/lib/Dialog/Dialog.js +1 -0
- package/lib/Dialog/Dialog.jsx +273 -0
- package/lib/Dialog.d.ts +45 -45
- package/lib/Dialog.jsx +131 -0
- package/lib/Dropdown.d.ts +176 -176
- package/lib/Dropdown.jsx +134 -0
- package/lib/DropdownMenu/DropdownButton.d.ts +46 -46
- package/lib/DropdownMenu/DropdownButton.jsx +14 -0
- package/lib/DropdownMenu/DropdownMenu.jsx +70 -0
- package/lib/DropdownMenu/index.js +6 -20
- package/lib/DropdownStyles.js +18 -26
- package/lib/FilterList.d.ts +42 -42
- package/lib/FilterList.jsx +63 -0
- package/lib/FilteredActionList/FilteredActionList.jsx +100 -0
- package/lib/FilteredActionList/index.js +4 -12
- package/lib/FilteredSearch.jsx +29 -0
- package/lib/Flash.jsx +70 -0
- package/lib/Flex.jsx +15 -0
- package/lib/FormGroup.jsx +25 -0
- package/lib/Grid.jsx +15 -0
- package/lib/Header.jsx +90 -0
- package/lib/Heading.jsx +21 -0
- package/lib/Label.jsx +84 -0
- package/lib/LabelGroup.jsx +19 -0
- package/lib/Link.jsx +38 -0
- package/lib/NewButton/button-counter.d.ts +6 -0
- package/lib/NewButton/button-counter.js +31 -0
- package/lib/NewButton/button-counter.jsx +14 -0
- package/lib/NewButton/button.d.ts +13 -0
- package/lib/NewButton/button.js +316 -0
- package/lib/NewButton/button.jsx +278 -0
- package/lib/NewButton/index.d.ts +14 -0
- package/lib/NewButton/index.js +8 -0
- package/lib/NewButton/types.d.ts +32 -0
- package/lib/NewButton/types.js +2 -0
- package/lib/Overlay.jsx +156 -0
- package/lib/Pagehead.jsx +18 -0
- package/lib/Pagination/Pagination.jsx +163 -0
- package/lib/Pagination/index.js +6 -12
- package/lib/Pagination/model.jsx +174 -0
- package/lib/PointerBox.jsx +25 -0
- package/lib/Popover.jsx +210 -0
- package/lib/Portal/Portal.jsx +79 -0
- package/lib/Portal/index.js +5 -16
- package/lib/Position.d.ts +4 -4
- package/lib/Position.jsx +46 -0
- package/lib/ProgressBar.jsx +39 -0
- package/lib/SelectMenu/SelectMenu.d.ts +246 -246
- package/lib/SelectMenu/SelectMenu.jsx +114 -0
- package/lib/SelectMenu/SelectMenuContext.jsx +5 -0
- package/lib/SelectMenu/SelectMenuDivider.jsx +43 -0
- package/lib/SelectMenu/SelectMenuFilter.jsx +59 -0
- package/lib/SelectMenu/SelectMenuFooter.jsx +46 -0
- package/lib/SelectMenu/SelectMenuHeader.jsx +44 -0
- package/lib/SelectMenu/SelectMenuItem.d.ts +1 -1
- package/lib/SelectMenu/SelectMenuItem.jsx +143 -0
- package/lib/SelectMenu/SelectMenuList.jsx +60 -0
- package/lib/SelectMenu/SelectMenuLoadingAnimation.jsx +21 -0
- package/lib/SelectMenu/SelectMenuModal.d.ts +1 -1
- package/lib/SelectMenu/SelectMenuModal.jsx +119 -0
- package/lib/SelectMenu/SelectMenuTab.jsx +93 -0
- package/lib/SelectMenu/SelectMenuTabPanel.jsx +43 -0
- package/lib/SelectMenu/SelectMenuTabs.jsx +58 -0
- package/lib/SelectMenu/hooks/useKeyboardNav.js +80 -96
- package/lib/SelectMenu/index.js +7 -14
- package/lib/SelectPanel/SelectPanel.jsx +105 -0
- package/lib/SelectPanel/index.js +4 -12
- package/lib/SideNav.jsx +177 -0
- package/lib/Spinner.jsx +35 -0
- package/lib/StateLabel.d.ts +1 -1
- package/lib/StateLabel.js +6 -1
- package/lib/StateLabel.jsx +94 -0
- package/lib/StyledOcticon.jsx +20 -0
- package/lib/SubNav.jsx +104 -0
- package/lib/TabNav.jsx +60 -0
- package/lib/Text.jsx +14 -0
- package/lib/TextInput.jsx +23 -0
- package/lib/TextInputWithTokens.d.ts +28 -28
- package/lib/TextInputWithTokens.jsx +218 -0
- package/lib/ThemeProvider.jsx +130 -0
- package/lib/Timeline.d.ts +43 -43
- package/lib/Timeline.jsx +124 -0
- package/lib/Token/AvatarToken.d.ts +1 -1
- package/lib/Token/AvatarToken.jsx +54 -0
- package/lib/Token/IssueLabelToken.d.ts +1 -1
- package/lib/Token/IssueLabelToken.jsx +125 -0
- package/lib/Token/Token.d.ts +1 -1
- package/lib/Token/Token.jsx +103 -0
- package/lib/Token/TokenBase.jsx +88 -0
- package/lib/Token/_RemoveTokenButton.jsx +108 -0
- package/lib/Token/_TokenTextContainer.jsx +49 -0
- package/lib/Token/index.js +11 -30
- package/lib/Tooltip.jsx +246 -0
- package/lib/Truncate.jsx +27 -0
- package/lib/UnderlineNav.jsx +90 -0
- package/lib/_TextInputWrapper.jsx +120 -0
- package/lib/_UnstyledTextInput.jsx +22 -0
- package/lib/__tests__/ActionList.test.jsx +49 -0
- package/lib/__tests__/ActionList.types.test.jsx +45 -0
- package/lib/__tests__/ActionList2.test.d.ts +1 -0
- package/lib/__tests__/ActionList2.test.js +53 -0
- package/lib/__tests__/ActionList2.test.jsx +46 -0
- package/lib/__tests__/ActionMenu.test.jsx +124 -0
- package/lib/__tests__/AnchoredOverlay.test.jsx +121 -0
- package/lib/__tests__/Autocomplete.test.jsx +299 -0
- package/lib/__tests__/Avatar.test.jsx +42 -0
- package/lib/__tests__/AvatarStack.test.jsx +43 -0
- package/lib/__tests__/BorderBox.test.jsx +36 -0
- package/lib/__tests__/Box.test.jsx +41 -0
- package/lib/__tests__/BranchName.test.jsx +27 -0
- package/lib/__tests__/Breadcrumbs.test.jsx +28 -0
- package/lib/__tests__/BreadcrumbsItem.test.jsx +31 -0
- package/lib/__tests__/Button.test.jsx +100 -0
- package/lib/__tests__/Caret.test.jsx +37 -0
- package/lib/__tests__/CircleBadge.test.jsx +55 -0
- package/lib/__tests__/CircleOcticon.test.jsx +45 -0
- package/lib/__tests__/ConfirmationDialog.test.jsx +119 -0
- package/lib/__tests__/CounterLabel.test.jsx +36 -0
- package/lib/__tests__/Details.test.jsx +85 -0
- package/lib/__tests__/Dialog.test.jsx +139 -0
- package/lib/__tests__/Dropdown.test.jsx +49 -0
- package/lib/__tests__/DropdownMenu.test.jsx +119 -0
- package/lib/__tests__/FilterList.test.jsx +27 -0
- package/lib/__tests__/FilterListItem.test.jsx +31 -0
- package/lib/__tests__/FilteredSearch.test.jsx +27 -0
- package/lib/__tests__/Flash.test.jsx +36 -0
- package/lib/__tests__/Flex.test.jsx +51 -0
- package/lib/__tests__/FormGroup.test.jsx +36 -0
- package/lib/__tests__/Grid.test.jsx +69 -0
- package/lib/__tests__/Header.test.jsx +45 -0
- package/lib/__tests__/Heading.test.jsx +71 -0
- package/lib/__tests__/KeyPaths.types.test.js +5 -8
- package/lib/__tests__/Label.test.jsx +33 -0
- package/lib/__tests__/LabelGroup.test.jsx +29 -0
- package/lib/__tests__/Link.test.jsx +43 -0
- package/lib/__tests__/Merge.types.test.js +13 -19
- package/lib/__tests__/NewButton.test.d.ts +1 -0
- package/lib/__tests__/NewButton.test.js +95 -0
- package/lib/__tests__/NewButton.test.jsx +61 -0
- package/lib/__tests__/Overlay.test.jsx +105 -0
- package/lib/__tests__/Pagehead.test.jsx +25 -0
- package/lib/__tests__/Pagination/Pagination.test.jsx +32 -0
- package/lib/__tests__/Pagination/PaginationModel.test.jsx +118 -0
- package/lib/__tests__/PointerBox.test.jsx +33 -0
- package/lib/__tests__/Popover.test.jsx +58 -0
- package/lib/__tests__/Portal.test.jsx +102 -0
- package/lib/__tests__/Position.test.jsx +96 -0
- package/lib/__tests__/ProgressBar.test.jsx +38 -0
- package/lib/__tests__/SelectMenu.test.jsx +120 -0
- package/lib/__tests__/SelectPanel.test.jsx +48 -0
- package/lib/__tests__/SideNav.test.jsx +55 -0
- package/lib/__tests__/Spinner.test.jsx +41 -0
- package/lib/__tests__/StateLabel.test.jsx +46 -0
- package/lib/__tests__/StyledOcticon.test.jsx +28 -0
- package/lib/__tests__/SubNav.test.jsx +47 -0
- package/lib/__tests__/SubNavLink.test.jsx +31 -0
- package/lib/__tests__/TabNav.test.jsx +32 -0
- package/lib/__tests__/Text.test.jsx +71 -0
- package/lib/__tests__/TextInput.test.jsx +45 -0
- package/lib/__tests__/TextInputWithTokens.test.jsx +302 -0
- package/lib/__tests__/ThemeProvider.test.jsx +314 -0
- package/lib/__tests__/Timeline.test.jsx +51 -0
- package/lib/__tests__/Token.test.jsx +93 -0
- package/lib/__tests__/Tooltip.test.jsx +46 -0
- package/lib/__tests__/Truncate.test.jsx +41 -0
- package/lib/__tests__/UnderlineNav.test.jsx +53 -0
- package/lib/__tests__/UnderlineNavLink.test.jsx +31 -0
- package/lib/__tests__/behaviors/anchoredPosition.test.js +229 -376
- package/lib/__tests__/behaviors/focusTrap.test.jsx +184 -0
- package/lib/__tests__/behaviors/focusZone.test.jsx +406 -0
- package/lib/__tests__/behaviors/iterateFocusableElements.test.jsx +58 -0
- package/lib/__tests__/behaviors/scrollIntoViewingArea.test.js +145 -216
- package/lib/__tests__/filterObject.test.js +48 -27
- package/lib/__tests__/hooks/useAnchoredPosition.test.jsx +29 -0
- package/lib/__tests__/hooks/useOnEscapePress.test.jsx +19 -0
- package/lib/__tests__/hooks/useOnOutsideClick.test.jsx +63 -0
- package/lib/__tests__/hooks/useOpenAndCloseFocus.test.jsx +61 -0
- package/lib/__tests__/hooks/useProvidedStateOrCreate.test.jsx +56 -0
- package/lib/__tests__/theme.test.js +33 -34
- package/lib/__tests__/themeGet.test.js +12 -23
- package/lib/__tests__/useSafeTimeout.test.jsx +36 -0
- package/lib/__tests__/utils/createSlots.test.d.ts +1 -0
- package/lib/__tests__/utils/createSlots.test.js +75 -0
- package/lib/__tests__/utils/createSlots.test.jsx +57 -0
- package/lib/behaviors/anchoredPosition.js +205 -234
- package/lib/behaviors/focusTrap.js +121 -157
- package/lib/behaviors/focusZone.js +434 -509
- package/lib/behaviors/scrollIntoViewingArea.js +18 -35
- package/lib/constants.js +39 -43
- package/lib/drafts.d.ts +8 -0
- package/lib/drafts.js +21 -0
- package/lib/hooks/index.js +16 -60
- package/lib/hooks/useAnchoredPosition.js +32 -40
- package/lib/hooks/useCombinedRefs.js +32 -36
- package/lib/hooks/useDetails.jsx +39 -0
- package/lib/hooks/useDialog.js +72 -96
- package/lib/hooks/useFocusTrap.js +43 -60
- package/lib/hooks/useFocusZone.js +54 -50
- package/lib/hooks/useOnEscapePress.js +25 -36
- package/lib/hooks/useOnOutsideClick.jsx +61 -0
- package/lib/hooks/useOpenAndCloseFocus.js +22 -34
- package/lib/hooks/useOverlay.jsx +15 -0
- package/lib/hooks/useProvidedRefOrCreate.js +10 -14
- package/lib/hooks/useProvidedStateOrCreate.js +13 -16
- package/lib/hooks/useRenderForcingRef.js +13 -17
- package/lib/hooks/useResizeObserver.js +15 -18
- package/lib/hooks/useSafeTimeout.js +22 -30
- package/lib/hooks/useScrollFlash.js +16 -23
- package/lib/index.d.ts +2 -0
- package/lib/index.js +163 -636
- package/lib/polyfills/eventListenerSignal.js +37 -45
- package/lib/stories/ActionList2.stories.js +908 -0
- package/lib/stories/NewButton.stories.js +230 -0
- package/lib/sx.d.ts +2 -0
- package/lib/sx.js +10 -14
- package/lib/theme-preval.js +65 -2945
- package/lib/theme.js +3 -12
- package/lib/utils/create-slots.d.ts +17 -0
- package/lib/utils/create-slots.js +105 -0
- package/lib/utils/create-slots.jsx +65 -0
- package/lib/utils/deprecate.jsx +59 -0
- package/lib/utils/isNumeric.jsx +7 -0
- package/lib/utils/iterateFocusableElements.js +63 -85
- package/lib/utils/ssr.jsx +6 -0
- package/lib/utils/test-deprecations.jsx +20 -0
- package/lib/utils/test-helpers.jsx +8 -0
- package/lib/utils/test-matchers.jsx +100 -0
- package/lib/utils/testing.d.ts +14 -1
- package/lib/utils/testing.jsx +206 -0
- package/lib/utils/theme.js +33 -47
- package/lib/utils/types/AriaRole.js +2 -1
- package/lib/utils/types/ComponentProps.js +2 -1
- package/lib/utils/types/Flatten.js +2 -1
- package/lib/utils/types/KeyPaths.js +2 -1
- package/lib/utils/types/MandateProps.js +16 -1
- package/lib/utils/types/Merge.js +2 -1
- package/lib/utils/types/index.js +16 -69
- package/lib/utils/uniqueId.js +5 -8
- package/lib/utils/use-force-update.d.ts +1 -0
- package/lib/utils/use-force-update.js +13 -0
- package/lib/utils/useIsomorphicLayoutEffect.js +8 -11
- package/lib/utils/userAgent.js +8 -12
- package/lib-esm/ActionList/Item.js +28 -19
- package/lib-esm/ActionList2/Description.d.ts +12 -0
- package/lib-esm/ActionList2/Description.js +41 -0
- package/lib-esm/ActionList2/Divider.d.ts +5 -0
- package/lib-esm/ActionList2/Divider.js +23 -0
- package/lib-esm/ActionList2/Group.d.ts +11 -0
- package/lib-esm/ActionList2/Group.js +40 -0
- package/lib-esm/ActionList2/Header.d.ts +26 -0
- package/lib-esm/ActionList2/Header.js +44 -0
- package/lib-esm/ActionList2/Item.d.ts +63 -0
- package/lib-esm/ActionList2/Item.js +208 -0
- package/lib-esm/ActionList2/LinkItem.d.ts +17 -0
- package/lib-esm/ActionList2/LinkItem.js +43 -0
- package/lib-esm/ActionList2/List.d.ts +26 -0
- package/lib-esm/ActionList2/List.js +37 -0
- package/lib-esm/ActionList2/Selection.d.ts +5 -0
- package/lib-esm/ActionList2/Selection.js +66 -0
- package/lib-esm/ActionList2/Visuals.d.ts +9 -0
- package/lib-esm/ActionList2/Visuals.js +68 -0
- package/lib-esm/ActionList2/index.d.ts +36 -0
- package/lib-esm/ActionList2/index.js +33 -0
- package/lib-esm/Autocomplete/Autocomplete.d.ts +28 -28
- package/lib-esm/Autocomplete/AutocompleteInput.d.ts +28 -28
- package/lib-esm/Button/Button.d.ts +25 -25
- package/lib-esm/Button/ButtonClose.d.ts +45 -45
- package/lib-esm/Button/ButtonDanger.d.ts +25 -25
- package/lib-esm/Button/ButtonInvisible.d.ts +25 -25
- package/lib-esm/Button/ButtonOutline.d.ts +25 -25
- package/lib-esm/Button/ButtonPrimary.d.ts +25 -25
- package/lib-esm/CircleOcticon.d.ts +42 -42
- package/lib-esm/Dialog/Dialog.js +1 -0
- package/lib-esm/Dialog.d.ts +45 -45
- package/lib-esm/Dropdown.d.ts +176 -176
- package/lib-esm/DropdownMenu/DropdownButton.d.ts +46 -46
- package/lib-esm/FilterList.d.ts +42 -42
- package/lib-esm/NewButton/button-counter.d.ts +6 -0
- package/lib-esm/NewButton/button-counter.js +18 -0
- package/lib-esm/NewButton/button.d.ts +13 -0
- package/lib-esm/NewButton/button.js +298 -0
- package/lib-esm/NewButton/index.d.ts +14 -0
- package/lib-esm/NewButton/index.js +5 -0
- package/lib-esm/NewButton/types.d.ts +32 -0
- package/lib-esm/NewButton/types.js +1 -0
- package/lib-esm/Position.d.ts +4 -4
- package/lib-esm/SelectMenu/SelectMenu.d.ts +246 -246
- package/lib-esm/SelectMenu/SelectMenuItem.d.ts +1 -1
- package/lib-esm/SelectMenu/SelectMenuModal.d.ts +1 -1
- package/lib-esm/StateLabel.d.ts +1 -1
- package/lib-esm/StateLabel.js +7 -2
- package/lib-esm/TextInputWithTokens.d.ts +28 -28
- package/lib-esm/Timeline.d.ts +43 -43
- package/lib-esm/Token/AvatarToken.d.ts +1 -1
- package/lib-esm/Token/IssueLabelToken.d.ts +1 -1
- package/lib-esm/Token/Token.d.ts +1 -1
- package/lib-esm/__tests__/ActionList2.test.d.ts +1 -0
- package/lib-esm/__tests__/ActionList2.test.js +41 -0
- package/lib-esm/__tests__/NewButton.test.d.ts +1 -0
- package/lib-esm/__tests__/NewButton.test.js +84 -0
- package/lib-esm/__tests__/utils/createSlots.test.d.ts +1 -0
- package/lib-esm/__tests__/utils/createSlots.test.js +67 -0
- package/lib-esm/drafts.d.ts +8 -0
- package/lib-esm/drafts.js +9 -0
- package/lib-esm/index.d.ts +2 -0
- package/lib-esm/index.js +1 -0
- package/lib-esm/stories/ActionList2.stories.js +796 -0
- package/lib-esm/stories/NewButton.stories.js +178 -0
- package/lib-esm/sx.d.ts +2 -0
- package/lib-esm/sx.js +3 -1
- package/lib-esm/theme-preval.js +81 -2
- package/lib-esm/utils/create-slots.d.ts +17 -0
- package/lib-esm/utils/create-slots.js +84 -0
- package/lib-esm/utils/testing.d.ts +14 -1
- package/lib-esm/utils/use-force-update.d.ts +1 -0
- package/lib-esm/utils/use-force-update.js +6 -0
- package/package-lock.json +153 -14
- package/package.json +7 -4
- package/script/build +1 -1
- package/src/ActionList/Item.tsx +32 -19
- package/src/ActionList2/Description.tsx +52 -0
- package/src/ActionList2/Divider.tsx +24 -0
- package/src/ActionList2/Group.tsx +34 -0
- package/src/ActionList2/Header.tsx +58 -0
- package/src/ActionList2/Item.tsx +246 -0
- package/src/ActionList2/LinkItem.tsx +49 -0
- package/src/ActionList2/List.tsx +55 -0
- package/src/ActionList2/Selection.tsx +60 -0
- package/src/ActionList2/Visuals.tsx +76 -0
- package/src/ActionList2/index.ts +39 -0
- package/src/Dialog/Dialog.tsx +1 -0
- package/src/NewButton/button-counter.tsx +15 -0
- package/src/NewButton/button.tsx +279 -0
- package/src/NewButton/index.ts +10 -0
- package/src/NewButton/types.ts +36 -0
- package/src/StateLabel.tsx +14 -2
- package/src/__tests__/ActionList2.test.tsx +47 -0
- package/src/__tests__/NewButton.test.tsx +70 -0
- package/src/__tests__/__snapshots__/ActionList2.test.tsx.snap +14 -0
- package/src/__tests__/__snapshots__/Autocomplete.test.tsx.snap +722 -255
- package/src/__tests__/__snapshots__/CircleBadge.test.tsx.snap +1 -0
- package/src/__tests__/__snapshots__/CircleOcticon.test.tsx.snap +1 -0
- package/src/__tests__/__snapshots__/Dialog.test.tsx.snap +1 -0
- package/src/__tests__/__snapshots__/DropdownMenu.test.tsx.snap +1 -0
- package/src/__tests__/__snapshots__/NewButton.test.tsx.snap +300 -0
- package/src/__tests__/__snapshots__/SelectMenu.test.tsx.snap +4 -0
- package/src/__tests__/__snapshots__/SelectPanel.test.tsx.snap +1 -0
- package/src/__tests__/__snapshots__/StateLabel.test.tsx.snap +13 -6
- package/src/__tests__/__snapshots__/StyledOcticon.test.tsx.snap +1 -0
- package/src/__tests__/__snapshots__/TextInputWithTokens.test.tsx.snap +66 -0
- package/src/__tests__/__snapshots__/Token.test.tsx.snap +17 -0
- package/src/__tests__/utils/__snapshots__/createSlots.test.tsx.snap +55 -0
- package/src/__tests__/utils/createSlots.test.tsx +74 -0
- package/src/drafts.ts +10 -0
- package/src/index.ts +2 -0
- package/src/stories/ActionList2.stories.tsx +1291 -0
- package/src/stories/NewButton.stories.tsx +201 -0
- package/src/sx.ts +3 -0
- package/src/theme-preval.js +1 -0
- package/src/utils/create-slots.tsx +96 -0
- package/src/utils/use-force-update.ts +7 -0
- package/stats.html +1 -1
- package/tsconfig.base.json +20 -0
- package/tsconfig.build.json +2 -2
- package/tsconfig.json +4 -17
@@ -0,0 +1,311 @@
|
|
1
|
+
"use strict";
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
3
|
+
if (k2 === undefined) k2 = k;
|
4
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
5
|
+
}) : (function(o, m, k, k2) {
|
6
|
+
if (k2 === undefined) k2 = k;
|
7
|
+
o[k2] = m[k];
|
8
|
+
}));
|
9
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
10
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
11
|
+
}) : function(o, v) {
|
12
|
+
o["default"] = v;
|
13
|
+
});
|
14
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
15
|
+
if (mod && mod.__esModule) return mod;
|
16
|
+
var result = {};
|
17
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
18
|
+
__setModuleDefault(result, mod);
|
19
|
+
return result;
|
20
|
+
};
|
21
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
22
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
23
|
+
};
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
25
|
+
exports.Item = exports.TextContainer = void 0;
|
26
|
+
const octicons_react_1 = require("@primer/octicons-react");
|
27
|
+
const react_1 = __importStar(require("react"));
|
28
|
+
const constants_1 = require("../constants");
|
29
|
+
const sx_1 = __importDefault(require("../sx"));
|
30
|
+
const Truncate_1 = __importDefault(require("../Truncate"));
|
31
|
+
const styled_components_1 = __importDefault(require("styled-components"));
|
32
|
+
const Header_1 = require("./Header");
|
33
|
+
const Divider_1 = require("./Divider");
|
34
|
+
const ThemeProvider_1 = require("../ThemeProvider");
|
35
|
+
const focusZone_1 = require("../behaviors/focusZone");
|
36
|
+
const ssr_1 = require("@react-aria/ssr");
|
37
|
+
/**
|
38
|
+
* These colors are not yet in our default theme. Need to remove this once they are added.
|
39
|
+
*/
|
40
|
+
const customItemThemes = {
|
41
|
+
default: {
|
42
|
+
hover: {
|
43
|
+
light: 'rgba(46, 77, 108, 0.06)',
|
44
|
+
dark: 'rgba(201, 206, 212, 0.12)',
|
45
|
+
dark_dimmed: 'rgba(201, 206, 212, 0.12)'
|
46
|
+
},
|
47
|
+
focus: {
|
48
|
+
light: 'rgba(54, 77, 100, 0.16)',
|
49
|
+
dark: 'rgba(201, 206, 212, 0.24)',
|
50
|
+
dark_dimmed: 'rgba(201, 206, 212, 0.24)'
|
51
|
+
}
|
52
|
+
},
|
53
|
+
danger: {
|
54
|
+
hover: {
|
55
|
+
light: 'rgba(234, 74, 90, 0.08)',
|
56
|
+
dark: 'rgba(248, 81, 73, 0.16)',
|
57
|
+
dark_dimmed: 'rgba(248, 81, 73, 0.16)'
|
58
|
+
},
|
59
|
+
focus: {
|
60
|
+
light: 'rgba(234, 74, 90, 0.14)',
|
61
|
+
dark: 'rgba(248, 81, 73, 0.24)',
|
62
|
+
dark_dimmed: 'rgba(248, 81, 73, 0.24)'
|
63
|
+
}
|
64
|
+
}
|
65
|
+
};
|
66
|
+
const getItemVariant = (variant = 'default', disabled) => {
|
67
|
+
if (disabled) {
|
68
|
+
return {
|
69
|
+
color: constants_1.get('colors.primer.fg.disabled'),
|
70
|
+
iconColor: constants_1.get('colors.primer.fg.disabled'),
|
71
|
+
annotationColor: constants_1.get('colors.primer.fg.disabled'),
|
72
|
+
hoverCursor: 'default'
|
73
|
+
};
|
74
|
+
}
|
75
|
+
switch (variant) {
|
76
|
+
case 'danger':
|
77
|
+
return {
|
78
|
+
color: constants_1.get('colors.danger.fg'),
|
79
|
+
iconColor: constants_1.get('colors.danger.fg'),
|
80
|
+
annotationColor: constants_1.get('colors.fg.muted'),
|
81
|
+
hoverCursor: 'pointer'
|
82
|
+
};
|
83
|
+
default:
|
84
|
+
return {
|
85
|
+
color: constants_1.get('colors.fg.default'),
|
86
|
+
iconColor: constants_1.get('colors.fg.muted'),
|
87
|
+
annotationColor: constants_1.get('colors.fg.muted'),
|
88
|
+
hoverCursor: 'pointer'
|
89
|
+
};
|
90
|
+
}
|
91
|
+
};
|
92
|
+
const DividedContent = styled_components_1.default.div `
|
93
|
+
display: flex;
|
94
|
+
min-width: 0;
|
95
|
+
|
96
|
+
/* Required for dividers */
|
97
|
+
position: relative;
|
98
|
+
flex-grow: 1;
|
99
|
+
`;
|
100
|
+
const MainContent = styled_components_1.default.div `
|
101
|
+
align-items: baseline;
|
102
|
+
display: flex;
|
103
|
+
min-width: 0;
|
104
|
+
flex-direction: var(--main-content-flex-direction);
|
105
|
+
flex-grow: 1;
|
106
|
+
`;
|
107
|
+
const StyledItem = styled_components_1.default.div `
|
108
|
+
/* 6px vertical padding + 20px line height = 32px total height
|
109
|
+
*
|
110
|
+
* TODO: When rem-based spacing on a 4px scale lands, replace
|
111
|
+
* hardcoded '6px' with 'calc((${constants_1.get('space.s32')} - ${constants_1.get('space.20')}) / 2)'.
|
112
|
+
*/
|
113
|
+
padding: 6px ${constants_1.get('space.2')};
|
114
|
+
display: flex;
|
115
|
+
border-radius: ${constants_1.get('radii.2')};
|
116
|
+
color: ${({ variant, item }) => getItemVariant(variant, item?.disabled).color};
|
117
|
+
// 2 frames on a 60hz monitor
|
118
|
+
transition: background 33.333ms linear;
|
119
|
+
text-decoration: none;
|
120
|
+
|
121
|
+
@media (hover: hover) and (pointer: fine) {
|
122
|
+
:hover {
|
123
|
+
// allow override in case another item in the list is active/focused
|
124
|
+
background: var(--item-hover-bg-override, ${({ hoverBackground }) => hoverBackground});
|
125
|
+
cursor: ${({ variant, item }) => getItemVariant(variant, item?.disabled).hoverCursor};
|
126
|
+
}
|
127
|
+
}
|
128
|
+
|
129
|
+
// Item dividers
|
130
|
+
:not(:first-of-type):not(${Divider_1.StyledDivider} + &):not(${Header_1.StyledHeader} + &) {
|
131
|
+
margin-top: ${({ showDivider }) => (showDivider ? `1px` : '0')};
|
132
|
+
|
133
|
+
${DividedContent}::before {
|
134
|
+
content: ' ';
|
135
|
+
display: block;
|
136
|
+
position: absolute;
|
137
|
+
width: 100%;
|
138
|
+
top: -7px;
|
139
|
+
// NB: This 'get' won’t execute if it’s moved into the arrow function below.
|
140
|
+
border: 0 solid ${constants_1.get('colors.border.muted')};
|
141
|
+
border-top-width: ${({ showDivider }) => (showDivider ? `1px` : '0')};
|
142
|
+
}
|
143
|
+
}
|
144
|
+
|
145
|
+
// Item dividers should not be visible:
|
146
|
+
// - above Hovered
|
147
|
+
&:hover ${DividedContent}::before,
|
148
|
+
// - below Hovered
|
149
|
+
// '*' instead of '&' because '&' maps to separate class names depending on 'variant'
|
150
|
+
:hover + * ${DividedContent}::before {
|
151
|
+
// allow override in case another item in the list is active/focused
|
152
|
+
border-color: var(--item-hover-divider-border-color-override, transparent) !important;
|
153
|
+
}
|
154
|
+
|
155
|
+
// - above Focused
|
156
|
+
&:focus ${DividedContent}::before,
|
157
|
+
// - below Focused
|
158
|
+
// '*' instead of '&' because '&' maps to separate class names depending on 'variant'
|
159
|
+
:focus + * ${DividedContent}::before,
|
160
|
+
// - above Active Descendent
|
161
|
+
&[${focusZone_1.isActiveDescendantAttribute}] ${DividedContent}::before,
|
162
|
+
// - below Active Descendent
|
163
|
+
[${focusZone_1.isActiveDescendantAttribute}] + & ${DividedContent}::before {
|
164
|
+
// '!important' because all the ':not's above give higher specificity
|
165
|
+
border-color: transparent !important;
|
166
|
+
}
|
167
|
+
|
168
|
+
// Active Descendant
|
169
|
+
&[${focusZone_1.isActiveDescendantAttribute}='${focusZone_1.activeDescendantActivatedDirectly}'] {
|
170
|
+
background: ${({ focusBackground }) => focusBackground};
|
171
|
+
}
|
172
|
+
&[${focusZone_1.isActiveDescendantAttribute}='${focusZone_1.activeDescendantActivatedIndirectly}'] {
|
173
|
+
background: ${({ hoverBackground }) => hoverBackground};
|
174
|
+
}
|
175
|
+
|
176
|
+
&:focus {
|
177
|
+
background: ${({ focusBackground }) => focusBackground};
|
178
|
+
outline: none;
|
179
|
+
}
|
180
|
+
|
181
|
+
&:active {
|
182
|
+
background: ${({ focusBackground }) => focusBackground};
|
183
|
+
}
|
184
|
+
|
185
|
+
${sx_1.default}
|
186
|
+
`;
|
187
|
+
exports.TextContainer = styled_components_1.default.span ``;
|
188
|
+
const BaseVisualContainer = styled_components_1.default.div `
|
189
|
+
// Match visual height to adjacent text line height.
|
190
|
+
// TODO: When rem-based spacing on a 4px scale lands, replace
|
191
|
+
// hardcoded '20px' with '${constants_1.get('space.s20')}'.
|
192
|
+
height: 20px;
|
193
|
+
width: ${constants_1.get('space.3')};
|
194
|
+
margin-right: ${constants_1.get('space.2')};
|
195
|
+
display: flex;
|
196
|
+
justify-content: center;
|
197
|
+
align-items: center;
|
198
|
+
`;
|
199
|
+
const ColoredVisualContainer = styled_components_1.default(BaseVisualContainer) `
|
200
|
+
svg {
|
201
|
+
fill: ${({ variant, disabled }) => getItemVariant(variant, disabled).iconColor};
|
202
|
+
font-size: ${constants_1.get('fontSizes.0')};
|
203
|
+
}
|
204
|
+
`;
|
205
|
+
const LeadingVisualContainer = styled_components_1.default(ColoredVisualContainer) `
|
206
|
+
flex-shrink: 0;
|
207
|
+
display: flex;
|
208
|
+
flex-direction: column;
|
209
|
+
justify-content: center;
|
210
|
+
`;
|
211
|
+
const TrailingContent = styled_components_1.default(ColoredVisualContainer) `
|
212
|
+
color: ${({ variant, disabled }) => getItemVariant(variant, disabled).annotationColor}};
|
213
|
+
margin-left: ${constants_1.get('space.2')};
|
214
|
+
margin-right: 0;
|
215
|
+
width: auto;
|
216
|
+
div:nth-child(2) {
|
217
|
+
margin-left: ${constants_1.get('space.2')};
|
218
|
+
}
|
219
|
+
`;
|
220
|
+
const DescriptionContainer = styled_components_1.default.span `
|
221
|
+
color: ${constants_1.get('colors.fg.muted')};
|
222
|
+
font-size: ${constants_1.get('fontSizes.0')};
|
223
|
+
// TODO: When rem-based spacing on a 4px scale lands, replace
|
224
|
+
// hardcoded '16px' with '${constants_1.get('lh-12')}'.
|
225
|
+
line-height: 16px;
|
226
|
+
margin-left: var(--description-container-margin-left);
|
227
|
+
min-width: 0;
|
228
|
+
flex-grow: 1;
|
229
|
+
flex-basis: var(--description-container-flex-basis);
|
230
|
+
`;
|
231
|
+
const MultiSelectIcon = styled_components_1.default.svg `
|
232
|
+
rect {
|
233
|
+
fill: ${({ selected }) => (selected ? constants_1.get('colors.accent.fg') : constants_1.get('colors.canvas.default'))};
|
234
|
+
stroke: ${({ selected }) => (selected ? constants_1.get('colors.accent.fg') : constants_1.get('colors.border.default'))};
|
235
|
+
}
|
236
|
+
path {
|
237
|
+
fill: ${constants_1.get('colors.fg.onEmphasis')};
|
238
|
+
boxshadow: ${constants_1.get('shadow.small')};
|
239
|
+
opacity: ${({ selected }) => (selected ? 1 : 0)};
|
240
|
+
}
|
241
|
+
`;
|
242
|
+
/**
|
243
|
+
* An actionable or selectable `Item` with an optional icon and description.
|
244
|
+
*/
|
245
|
+
exports.Item = react_1.default.forwardRef((itemProps, ref) => {
|
246
|
+
const { as: Component, text, description, descriptionVariant = 'inline', selected, selectionVariant, leadingVisual: LeadingVisual, trailingIcon: TrailingIcon, trailingVisual: TrailingVisual, trailingText, variant = 'default', showDivider, disabled, onAction, onKeyPress, children, onClick, id, ...props } = itemProps;
|
247
|
+
const labelId = ssr_1.useSSRSafeId();
|
248
|
+
const descriptionId = ssr_1.useSSRSafeId();
|
249
|
+
const keyPressHandler = react_1.useCallback(event => {
|
250
|
+
if (disabled) {
|
251
|
+
return;
|
252
|
+
}
|
253
|
+
onKeyPress?.(event);
|
254
|
+
if (!event.defaultPrevented && [' ', 'Enter'].includes(event.key)) {
|
255
|
+
onAction?.(itemProps, event);
|
256
|
+
}
|
257
|
+
}, [onAction, disabled, itemProps, onKeyPress]);
|
258
|
+
const clickHandler = react_1.useCallback(event => {
|
259
|
+
if (disabled) {
|
260
|
+
return;
|
261
|
+
}
|
262
|
+
onClick?.(event);
|
263
|
+
if (!event.defaultPrevented) {
|
264
|
+
onAction?.(itemProps, event);
|
265
|
+
}
|
266
|
+
}, [onAction, disabled, itemProps, onClick]);
|
267
|
+
const customItemTheme = customItemThemes[variant];
|
268
|
+
const hoverBackground = ThemeProvider_1.useColorSchemeVar(customItemTheme.hover, 'inherit');
|
269
|
+
const focusBackground = ThemeProvider_1.useColorSchemeVar(customItemTheme.focus, 'inherit');
|
270
|
+
const { theme } = ThemeProvider_1.useTheme();
|
271
|
+
return (<StyledItem ref={ref} as={Component} tabIndex={disabled ? undefined : -1} variant={variant} showDivider={showDivider} aria-selected={selected} aria-labelledby={text ? labelId : undefined} aria-describedby={description ? descriptionId : undefined} {...props} data-id={id} onKeyPress={keyPressHandler} onClick={clickHandler} hoverBackground={disabled ? 'inherit' : hoverBackground} focusBackground={disabled ? 'inherit' : focusBackground}>
|
272
|
+
{!!selected === selected && (<BaseVisualContainer>
|
273
|
+
{selectionVariant === 'multiple' ? (<>
|
274
|
+
{/**
|
275
|
+
* we use a svg instead of an input because there should not
|
276
|
+
* be an interactive element inside an option
|
277
|
+
* svg copied from primer/css
|
278
|
+
*/}
|
279
|
+
<MultiSelectIcon selected={selected} width="16" height="16" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
|
280
|
+
<rect x="2" y="2" width="12" height="12" rx="4"></rect>
|
281
|
+
<path fillRule="evenodd" strokeWidth="0" d="M4.03231 8.69862C3.84775 8.20646 4.49385 7.77554 4.95539 7.77554C5.41693 7.77554 6.80154 9.85246 6.80154 9.85246C6.80154 9.85246 10.2631 4.314 10.4938 4.08323C10.7246 3.85246 11.8785 4.08323 11.4169 5.00631C11.0081 5.82388 7.26308 11.4678 7.26308 11.4678C7.26308 11.4678 6.80154 12.1602 6.34 11.4678C5.87846 10.7755 4.21687 9.19077 4.03231 8.69862Z"/>
|
282
|
+
</MultiSelectIcon>
|
283
|
+
</>) : (selected && <octicons_react_1.CheckIcon fill={theme?.colors.fg.default}/>)}
|
284
|
+
</BaseVisualContainer>)}
|
285
|
+
{LeadingVisual && (<LeadingVisualContainer variant={variant} disabled={disabled}>
|
286
|
+
<LeadingVisual />
|
287
|
+
</LeadingVisualContainer>)}
|
288
|
+
<DividedContent>
|
289
|
+
<MainContent style={{ '--main-content-flex-direction': descriptionVariant === 'inline' ? 'row' : 'column' }}>
|
290
|
+
{children}
|
291
|
+
{text ? <exports.TextContainer id={labelId}>{text}</exports.TextContainer> : null}
|
292
|
+
{description ? (<DescriptionContainer id={descriptionId} style={{
|
293
|
+
'--description-container-margin-left': descriptionVariant === 'inline' ? constants_1.get('space.2')(theme) : 0,
|
294
|
+
'--description-container-flex-basis': descriptionVariant === 'inline' ? 0 : 'auto'
|
295
|
+
}}>
|
296
|
+
{descriptionVariant === 'block' ? (description) : (<Truncate_1.default title={description} inline={true} maxWidth="100%">
|
297
|
+
{description}
|
298
|
+
</Truncate_1.default>)}
|
299
|
+
</DescriptionContainer>) : null}
|
300
|
+
</MainContent>
|
301
|
+
{/* backward compatibility: prefer TrailingVisual but fallback to TrailingIcon */}
|
302
|
+
{TrailingVisual ? (<TrailingContent variant={variant} disabled={disabled}>
|
303
|
+
{typeof TrailingVisual === 'function' ? <TrailingVisual /> : TrailingVisual}
|
304
|
+
</TrailingContent>) : TrailingIcon || trailingText ? (<TrailingContent variant={variant} disabled={disabled}>
|
305
|
+
{trailingText}
|
306
|
+
{TrailingIcon && <TrailingIcon />}
|
307
|
+
</TrailingContent>) : null}
|
308
|
+
</DividedContent>
|
309
|
+
</StyledItem>);
|
310
|
+
});
|
311
|
+
exports.Item.displayName = 'ActionList.Item';
|
@@ -0,0 +1,138 @@
|
|
1
|
+
"use strict";
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
4
|
+
};
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
6
|
+
exports.List = void 0;
|
7
|
+
const react_1 = __importDefault(require("react"));
|
8
|
+
const Group_1 = require("./Group");
|
9
|
+
const Item_1 = require("./Item");
|
10
|
+
const Divider_1 = require("./Divider");
|
11
|
+
const styled_components_1 = __importDefault(require("styled-components"));
|
12
|
+
const constants_1 = require("../constants");
|
13
|
+
const focusZone_1 = require("../behaviors/focusZone");
|
14
|
+
/**
|
15
|
+
* Asserts that the given value fulfills the `GroupedListProps` contract.
|
16
|
+
* @param props A value which fulfills either the `ListPropsBase` or the `GroupedListProps` contract.
|
17
|
+
*/
|
18
|
+
function isGroupedListProps(props) {
|
19
|
+
return 'groupMetadata' in props;
|
20
|
+
}
|
21
|
+
const StyledList = styled_components_1.default.div `
|
22
|
+
font-size: ${constants_1.get('fontSizes.1')};
|
23
|
+
/* 14px font-size * 1.428571429 = 20px line height
|
24
|
+
*
|
25
|
+
* TODO: When rem-based spacing on a 4px scale lands, replace
|
26
|
+
* hardcoded '20px'
|
27
|
+
*/
|
28
|
+
line-height: 20px;
|
29
|
+
|
30
|
+
&[${focusZone_1.hasActiveDescendantAttribute}], &:focus-within {
|
31
|
+
--item-hover-bg-override: none;
|
32
|
+
--item-hover-divider-border-color-override: ${constants_1.get('colors.border.muted')};
|
33
|
+
}
|
34
|
+
`;
|
35
|
+
/**
|
36
|
+
* Returns `sx` prop values for `List` children matching the given `List` style variation.
|
37
|
+
* @param variant `List` style variation.
|
38
|
+
*/
|
39
|
+
function useListVariant(variant = 'inset') {
|
40
|
+
switch (variant) {
|
41
|
+
case 'full':
|
42
|
+
return {
|
43
|
+
headerStyle: { paddingX: constants_1.get('space.2') },
|
44
|
+
itemStyle: { borderRadius: 0 }
|
45
|
+
};
|
46
|
+
default:
|
47
|
+
return {
|
48
|
+
firstGroupStyle: { marginTop: constants_1.get('space.2') },
|
49
|
+
lastGroupStyle: { marginBottom: constants_1.get('space.2') },
|
50
|
+
itemStyle: { marginX: constants_1.get('space.2') }
|
51
|
+
};
|
52
|
+
}
|
53
|
+
}
|
54
|
+
/**
|
55
|
+
* Lists `Item`s, either grouped or ungrouped, with a `Divider` between each `Group`.
|
56
|
+
*/
|
57
|
+
exports.List = react_1.default.forwardRef((props, forwardedRef) => {
|
58
|
+
// Get `sx` prop values for `List` children matching the given `List` style variation.
|
59
|
+
const { firstGroupStyle, lastGroupStyle, headerStyle, itemStyle } = useListVariant(props.variant);
|
60
|
+
/**
|
61
|
+
* Render a `Group` using the first of the following renderers that is defined:
|
62
|
+
* A `Group`-level or `List`-level custom `Group` renderer, or
|
63
|
+
* the default `Group` renderer.
|
64
|
+
*/
|
65
|
+
const renderGroup = (groupProps) => {
|
66
|
+
const GroupComponent = (('renderGroup' in groupProps && groupProps.renderGroup) ?? props.renderGroup) || Group_1.Group;
|
67
|
+
return <GroupComponent {...groupProps} key={groupProps.groupId}/>;
|
68
|
+
};
|
69
|
+
/**
|
70
|
+
* Render an `Item` using the first of the following renderers that is defined:
|
71
|
+
* An `Item`-level, `Group`-level, or `List`-level custom `Item` renderer,
|
72
|
+
* or the default `Item` renderer.
|
73
|
+
*/
|
74
|
+
const renderItem = (itemProps, item, itemIndex) => {
|
75
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
76
|
+
const ItemComponent = ('renderItem' in itemProps && itemProps.renderItem) || props.renderItem || Item_1.Item;
|
77
|
+
const key = ('key' in itemProps ? itemProps.key : undefined) ?? itemProps.id?.toString() ?? itemIndex.toString();
|
78
|
+
return (<ItemComponent showDivider={props.showItemDividers} selectionVariant={props.selectionVariant} {...itemProps} key={key} sx={{ ...itemStyle, ...itemProps.sx }} item={item}/>);
|
79
|
+
};
|
80
|
+
/**
|
81
|
+
* An array of `Group`s, each with an associated `Header` and with an array of `Item`s belonging to that `Group`.
|
82
|
+
*/
|
83
|
+
let groups = [];
|
84
|
+
// Collect rendered `Item`s into `Group`s, avoiding excess iteration over the lists of `items` and `groupMetadata`:
|
85
|
+
if (!isGroupedListProps(props)) {
|
86
|
+
// When no `groupMetadata`s is provided, collect rendered `Item`s into a single anonymous `Group`.
|
87
|
+
groups = [{ items: props.items.map((item, index) => renderItem(item, item, index)), groupId: '0' }];
|
88
|
+
}
|
89
|
+
else {
|
90
|
+
// When `groupMetadata` is provided, collect rendered `Item`s into their associated `Group`s.
|
91
|
+
/**
|
92
|
+
* A map of group identifiers to `Group`s, each with an associated array of `Item`s belonging to that `Group`.
|
93
|
+
*/
|
94
|
+
const groupMap = props.groupMetadata.reduce((groupAccumulator, groupMetadata) => groupAccumulator.set(groupMetadata.groupId, groupMetadata), new Map());
|
95
|
+
for (const itemProps of props.items) {
|
96
|
+
// Look up the group associated with the current item.
|
97
|
+
const group = groupMap.get(itemProps.groupId);
|
98
|
+
const itemIndex = group?.items?.length ?? 0;
|
99
|
+
// Upsert the group to include the current item (rendered).
|
100
|
+
groupMap.set(itemProps.groupId, {
|
101
|
+
...group,
|
102
|
+
items: [
|
103
|
+
...(group?.items ?? []),
|
104
|
+
renderItem({
|
105
|
+
showDivider: group?.showItemDividers,
|
106
|
+
...(group && 'renderItem' in group && { renderItem: group.renderItem }),
|
107
|
+
...itemProps
|
108
|
+
}, itemProps, itemIndex)
|
109
|
+
]
|
110
|
+
});
|
111
|
+
}
|
112
|
+
groups = [...groupMap.values()];
|
113
|
+
}
|
114
|
+
return (<StyledList {...props} ref={forwardedRef}>
|
115
|
+
{groups.map(({ header, ...groupProps }, index) => {
|
116
|
+
const hasFilledHeader = header?.variant === 'filled';
|
117
|
+
const shouldShowDivider = index > 0 && !hasFilledHeader;
|
118
|
+
return (<react_1.default.Fragment key={groupProps.groupId}>
|
119
|
+
{shouldShowDivider ? <Divider_1.Divider key={`${groupProps.groupId}-divider`}/> : null}
|
120
|
+
{renderGroup({
|
121
|
+
sx: {
|
122
|
+
...(index === 0 && firstGroupStyle),
|
123
|
+
...(index === groups.length - 1 && lastGroupStyle),
|
124
|
+
...(index > 0 && !shouldShowDivider && { mt: 2 })
|
125
|
+
},
|
126
|
+
...(header && {
|
127
|
+
header: {
|
128
|
+
...header,
|
129
|
+
sx: { ...headerStyle, ...header.sx }
|
130
|
+
}
|
131
|
+
}),
|
132
|
+
...groupProps
|
133
|
+
})}
|
134
|
+
</react_1.default.Fragment>);
|
135
|
+
})}
|
136
|
+
</StyledList>);
|
137
|
+
});
|
138
|
+
exports.List.displayName = 'ActionList';
|
package/lib/ActionList/index.js
CHANGED
@@ -1,29 +1,18 @@
|
|
1
1
|
"use strict";
|
2
|
-
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
4
|
-
value: true
|
5
|
-
});
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
6
3
|
exports.ActionList = void 0;
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
var _Item = require("./Item");
|
13
|
-
|
14
|
-
var _Divider = require("./Divider");
|
15
|
-
|
4
|
+
const List_1 = require("./List");
|
5
|
+
const Group_1 = require("./Group");
|
6
|
+
const Item_1 = require("./Item");
|
7
|
+
const Divider_1 = require("./Divider");
|
16
8
|
/**
|
17
9
|
* Collection of list-related components.
|
18
10
|
*/
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
/** Visually separates `Item`s or `Group`s in an `ActionList`. */
|
27
|
-
Divider: _Divider.Divider
|
11
|
+
exports.ActionList = Object.assign(List_1.List, {
|
12
|
+
/** Collects related `Items` in an `ActionList`. */
|
13
|
+
Group: Group_1.Group,
|
14
|
+
/** An actionable or selectable `Item` with an optional icon and description. */
|
15
|
+
Item: Item_1.Item,
|
16
|
+
/** Visually separates `Item`s or `Group`s in an `ActionList`. */
|
17
|
+
Divider: Divider_1.Divider
|
28
18
|
});
|
29
|
-
exports.ActionList = ActionList;
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import React from 'react';
|
2
|
+
import { SxProp } from '../sx';
|
3
|
+
export declare type DescriptionProps = {
|
4
|
+
/**
|
5
|
+
* Secondary text style variations.
|
6
|
+
*
|
7
|
+
* - `"inline"` - Secondary text is positioned beside primary text.
|
8
|
+
* - `"block"` - Secondary text is positioned below primary text.
|
9
|
+
*/
|
10
|
+
variant?: 'inline' | 'block';
|
11
|
+
} & SxProp;
|
12
|
+
export declare const Description: React.FC<DescriptionProps>;
|
@@ -0,0 +1,57 @@
|
|
1
|
+
"use strict";
|
2
|
+
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
4
|
+
value: true
|
5
|
+
});
|
6
|
+
exports.Description = void 0;
|
7
|
+
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
9
|
+
|
10
|
+
var _Box = _interopRequireDefault(require("../Box"));
|
11
|
+
|
12
|
+
var _sx = require("../sx");
|
13
|
+
|
14
|
+
var _Truncate = _interopRequireDefault(require("../Truncate"));
|
15
|
+
|
16
|
+
var _Item = require("./Item");
|
17
|
+
|
18
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
19
|
+
|
20
|
+
const Description = ({
|
21
|
+
variant = 'inline',
|
22
|
+
sx = {},
|
23
|
+
...props
|
24
|
+
}) => {
|
25
|
+
const styles = {
|
26
|
+
fontSize: 0,
|
27
|
+
lineHeight: '16px',
|
28
|
+
flexGrow: 1,
|
29
|
+
flexBasis: 0,
|
30
|
+
minWidth: 0,
|
31
|
+
marginLeft: variant === 'block' ? 0 : 2
|
32
|
+
};
|
33
|
+
return /*#__PURE__*/_react.default.createElement(_Item.Slot, {
|
34
|
+
name: variant === 'block' ? 'BlockDescription' : 'InlineDescription'
|
35
|
+
}, ({
|
36
|
+
blockDescriptionId,
|
37
|
+
inlineDescriptionId,
|
38
|
+
disabled
|
39
|
+
}) => variant === 'block' ? /*#__PURE__*/_react.default.createElement(_Box.default, {
|
40
|
+
as: "span",
|
41
|
+
sx: (0, _sx.merge)({ ...styles,
|
42
|
+
color: disabled ? 'fg.disabled' : 'fg.muted'
|
43
|
+
}, sx),
|
44
|
+
id: blockDescriptionId
|
45
|
+
}, props.children) : /*#__PURE__*/_react.default.createElement(_Truncate.default, {
|
46
|
+
id: inlineDescriptionId,
|
47
|
+
sx: (0, _sx.merge)({ ...styles,
|
48
|
+
color: disabled ? 'fg.disabled' : 'fg.muted'
|
49
|
+
}, sx),
|
50
|
+
title: props.children,
|
51
|
+
inline: true,
|
52
|
+
maxWidth: "100%"
|
53
|
+
}, props.children));
|
54
|
+
};
|
55
|
+
|
56
|
+
exports.Description = Description;
|
57
|
+
Description.displayName = "Description";
|
@@ -0,0 +1,29 @@
|
|
1
|
+
"use strict";
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
4
|
+
};
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
6
|
+
exports.Description = void 0;
|
7
|
+
const react_1 = __importDefault(require("react"));
|
8
|
+
const Box_1 = __importDefault(require("../Box"));
|
9
|
+
const sx_1 = require("../sx");
|
10
|
+
const Truncate_1 = __importDefault(require("../Truncate"));
|
11
|
+
const Item_1 = require("./Item");
|
12
|
+
const Description = ({ variant = 'inline', sx = {}, ...props }) => {
|
13
|
+
const styles = {
|
14
|
+
fontSize: 0,
|
15
|
+
lineHeight: '16px',
|
16
|
+
flexGrow: 1,
|
17
|
+
flexBasis: 0,
|
18
|
+
minWidth: 0,
|
19
|
+
marginLeft: variant === 'block' ? 0 : 2
|
20
|
+
};
|
21
|
+
return (<Item_1.Slot name={variant === 'block' ? 'BlockDescription' : 'InlineDescription'}>
|
22
|
+
{({ blockDescriptionId, inlineDescriptionId, disabled }) => variant === 'block' ? (<Box_1.default as="span" sx={sx_1.merge({ ...styles, color: disabled ? 'fg.disabled' : 'fg.muted' }, sx)} id={blockDescriptionId}>
|
23
|
+
{props.children}
|
24
|
+
</Box_1.default>) : (<Truncate_1.default id={inlineDescriptionId} sx={sx_1.merge({ ...styles, color: disabled ? 'fg.disabled' : 'fg.muted' }, sx)} title={props.children} inline={true} maxWidth="100%">
|
25
|
+
{props.children}
|
26
|
+
</Truncate_1.default>)}
|
27
|
+
</Item_1.Slot>);
|
28
|
+
};
|
29
|
+
exports.Description = Description;
|
@@ -0,0 +1,35 @@
|
|
1
|
+
"use strict";
|
2
|
+
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
4
|
+
value: true
|
5
|
+
});
|
6
|
+
exports.Divider = Divider;
|
7
|
+
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
9
|
+
|
10
|
+
var _Box = _interopRequireDefault(require("../Box"));
|
11
|
+
|
12
|
+
var _constants = require("../constants");
|
13
|
+
|
14
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
15
|
+
|
16
|
+
/**
|
17
|
+
* Visually separates `Item`s or `Group`s in an `ActionList`.
|
18
|
+
*/
|
19
|
+
function Divider() {
|
20
|
+
return /*#__PURE__*/_react.default.createElement(_Box.default, {
|
21
|
+
as: "li",
|
22
|
+
role: "separator",
|
23
|
+
sx: {
|
24
|
+
height: 1,
|
25
|
+
backgroundColor: 'actionListItem.inlineDivider',
|
26
|
+
marginTop: theme => `calc(${(0, _constants.get)('space.2')(theme)} - 1px)`,
|
27
|
+
marginBottom: 2,
|
28
|
+
listStyle: 'none' // hide the ::marker inserted by browser's stylesheet
|
29
|
+
|
30
|
+
},
|
31
|
+
"data-component": "ActionList.Divider"
|
32
|
+
});
|
33
|
+
}
|
34
|
+
|
35
|
+
Divider.displayName = "Divider";
|
@@ -0,0 +1,22 @@
|
|
1
|
+
"use strict";
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
4
|
+
};
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
6
|
+
exports.Divider = void 0;
|
7
|
+
const react_1 = __importDefault(require("react"));
|
8
|
+
const Box_1 = __importDefault(require("../Box"));
|
9
|
+
const constants_1 = require("../constants");
|
10
|
+
/**
|
11
|
+
* Visually separates `Item`s or `Group`s in an `ActionList`.
|
12
|
+
*/
|
13
|
+
function Divider() {
|
14
|
+
return (<Box_1.default as="li" role="separator" sx={{
|
15
|
+
height: 1,
|
16
|
+
backgroundColor: 'actionListItem.inlineDivider',
|
17
|
+
marginTop: (theme) => `calc(${constants_1.get('space.2')(theme)} - 1px)`,
|
18
|
+
marginBottom: 2,
|
19
|
+
listStyle: 'none' // hide the ::marker inserted by browser's stylesheet
|
20
|
+
}} data-component="ActionList.Divider"/>);
|
21
|
+
}
|
22
|
+
exports.Divider = Divider;
|
@@ -0,0 +1,11 @@
|
|
1
|
+
import React from 'react';
|
2
|
+
import { SxProp } from '../sx';
|
3
|
+
import { HeaderProps } from './Header';
|
4
|
+
import { ListProps } from './List';
|
5
|
+
export declare type GroupProps = HeaderProps & SxProp & {
|
6
|
+
selectionVariant?: ListProps['selectionVariant'] | false;
|
7
|
+
};
|
8
|
+
declare type ContextProps = Pick<GroupProps, 'selectionVariant'>;
|
9
|
+
export declare const GroupContext: React.Context<ContextProps>;
|
10
|
+
export declare const Group: React.FC<GroupProps>;
|
11
|
+
export {};
|