@primer/components 31.2.0-rc.6afeaa37 → 31.2.0-rc.76ed571d
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 +4 -0
- package/dist/browser.esm.js +209 -209
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +195 -195
- package/dist/browser.umd.js.map +1 -1
- package/docs/content/ActionList2.mdx +14 -8
- package/docs/content/StateLabel.md +5 -4
- package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +2 -2
- 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.jsx +301 -0
- package/lib/ActionList/List.jsx +138 -0
- package/lib/ActionList/index.js +12 -23
- package/lib/ActionList2/Description.jsx +30 -0
- package/lib/ActionList2/Divider.jsx +22 -0
- package/lib/ActionList2/Group.jsx +25 -0
- package/lib/ActionList2/Header.jsx +36 -0
- package/lib/ActionList2/Item.jsx +174 -0
- package/lib/ActionList2/LinkItem.jsx +28 -0
- package/lib/ActionList2/List.jsx +41 -0
- package/lib/ActionList2/Selection.jsx +36 -0
- package/lib/ActionList2/Visuals.jsx +48 -0
- package/lib/ActionList2/index.js +23 -41
- 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.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 +86 -0
- package/lib/__tests__/NewButton.test.jsx +55 -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.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/{unreleased.d.ts → drafts.d.ts} +2 -1
- 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 +3 -2
- package/lib/stories/NewButton.stories.js +230 -0
- package/lib/sx.js +10 -22
- package/lib/theme-preval.js +64 -3023
- package/lib/theme.js +3 -12
- 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.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.js +8 -14
- package/lib/utils/useIsomorphicLayoutEffect.js +8 -11
- package/lib/utils/userAgent.js +8 -12
- 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__/NewButton.test.d.ts +1 -0
- package/lib-esm/__tests__/NewButton.test.js +76 -0
- package/lib-esm/{unreleased.d.ts → drafts.d.ts} +2 -1
- package/lib-esm/{unreleased.js → drafts.js} +3 -2
- package/lib-esm/index.d.ts +2 -0
- package/lib-esm/index.js +1 -0
- package/lib-esm/stories/ActionList2.stories.js +3 -3
- package/lib-esm/stories/NewButton.stories.js +178 -0
- package/package-lock.json +7 -7
- package/package.json +4 -3
- package/script/build +1 -1
- 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__/NewButton.test.tsx +64 -0
- package/src/__tests__/__snapshots__/Autocomplete.test.tsx.snap +1 -0
- 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 +182 -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/{unreleased.ts → drafts.ts} +2 -1
- package/src/index.ts +2 -0
- package/src/stories/ActionList2.stories.tsx +12 -9
- package/src/stories/NewButton.stories.tsx +201 -0
- package/stats.html +1 -1
- package/tsconfig.base.json +20 -0
- package/tsconfig.build.json +2 -2
- package/tsconfig.json +4 -17
- package/lib/unreleased.js +0 -18
@@ -7,7 +7,7 @@ description: An ActionList is a list of items which can be activated or selected
|
|
7
7
|
---
|
8
8
|
|
9
9
|
import {BorderBox, Avatar} from '@primer/components'
|
10
|
-
import {ActionList} from '@primer/components/
|
10
|
+
import {ActionList} from '@primer/components/drafts'
|
11
11
|
import {Props} from '../src/props'
|
12
12
|
|
13
13
|
import {ImageContainer} from '@primer/gatsby-theme-doctocat'
|
@@ -48,7 +48,7 @@ import {LinkIcon, AlertIcon, ArrowRightIcon} from '@primer/octicons-react'
|
|
48
48
|
<br />
|
49
49
|
|
50
50
|
```js
|
51
|
-
import {ActionList} from '@primer/components/
|
51
|
+
import {ActionList} from '@primer/components/drafts'
|
52
52
|
```
|
53
53
|
|
54
54
|
<br />
|
@@ -58,7 +58,8 @@ import {ActionList} from '@primer/components/unreleased'
|
|
58
58
|
## Minimal example
|
59
59
|
|
60
60
|
```javascript live noinline
|
61
|
-
|
61
|
+
// import {ActionList} from '@primer/components/drafts'
|
62
|
+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
|
62
63
|
|
63
64
|
render(
|
64
65
|
<ActionList>
|
@@ -79,7 +80,8 @@ Leading visuals are optional and appear at the start of an item. They can be oct
|
|
79
80
|
|
80
81
|
<!-- prettier-ignore -->
|
81
82
|
```javascript live noinline
|
82
|
-
|
83
|
+
// import {ActionList} from '@primer/components/drafts'
|
84
|
+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
|
83
85
|
|
84
86
|
render(
|
85
87
|
<ActionList>
|
@@ -106,7 +108,8 @@ render(
|
|
106
108
|
Trailing visual and trailing text can display auxiliary information. They're placed at the right of the item, and can denote status, keyboard shortcuts, or be used to set expectations about what the action does.
|
107
109
|
|
108
110
|
```javascript live noinline
|
109
|
-
|
111
|
+
// import {ActionList} from '@primer/components/drafts'
|
112
|
+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
|
110
113
|
|
111
114
|
render(
|
112
115
|
<ActionList>
|
@@ -137,7 +140,8 @@ render(
|
|
137
140
|
Item dividers allow users to parse heavier amounts of information. They're placed between items and are useful in complex lists, particularly when descriptions or multi-line text is present.
|
138
141
|
|
139
142
|
```javascript live noinline
|
140
|
-
|
143
|
+
// import {ActionList} from '@primer/components/drafts'
|
144
|
+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
|
141
145
|
|
142
146
|
render(
|
143
147
|
<ActionList showDividers>
|
@@ -172,7 +176,8 @@ When you want to add links to the List instead of actions, use `ActionList.LinkI
|
|
172
176
|
|
173
177
|
<!-- prettier-ignore -->
|
174
178
|
```javascript live noinline
|
175
|
-
|
179
|
+
// import {ActionList} from '@primer/components/drafts'
|
180
|
+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
|
176
181
|
|
177
182
|
render(
|
178
183
|
<ActionList>
|
@@ -207,7 +212,8 @@ render(
|
|
207
212
|
## With Groups
|
208
213
|
|
209
214
|
```javascript live noinline
|
210
|
-
|
215
|
+
// import {ActionList} from '@primer/components/drafts'
|
216
|
+
const {ActionList} = drafts // ignore docs silliness; import like that ↑
|
211
217
|
|
212
218
|
const SelectFields = () => {
|
213
219
|
const [options, setOptions] = React.useState([
|
@@ -14,6 +14,7 @@ Use StateLabel components to show the status of an issue or pull request.
|
|
14
14
|
<StateLabel status="pullClosed">Closed</StateLabel>
|
15
15
|
<StateLabel status="pullMerged">Merged</StateLabel>
|
16
16
|
<StateLabel status="draft">Draft</StateLabel>
|
17
|
+
<StateLabel status="issueDraft">Draft</StateLabel>
|
17
18
|
</>
|
18
19
|
```
|
19
20
|
|
@@ -29,7 +30,7 @@ StateLabel components get `COMMON` system props. Read our [System Props](/system
|
|
29
30
|
|
30
31
|
## Component props
|
31
32
|
|
32
|
-
| Name | Type | Default | Description
|
33
|
-
| :------ | :----- | :------: |
|
34
|
-
| variant | String | 'normal' | a value of `small` or `normal` results in a smaller or larger version of the StateLabel.
|
35
|
-
| status | String | | Can be one of `issueOpened`, `issueClosed`, `pullOpened`, `pullClosed`, `pullMerged`, or `
|
33
|
+
| Name | Type | Default | Description |
|
34
|
+
| :------ | :----- | :------: | :------------------------------------------------------------------------------------------------------------- |
|
35
|
+
| variant | String | 'normal' | a value of `small` or `normal` results in a smaller or larger version of the StateLabel. |
|
36
|
+
| status | String | | Can be one of `issueOpened`, `issueClosed`, `pullOpened`, `pullClosed`, `pullMerged`, `draft` or `issueDraft`. |
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import React from 'react'
|
2
2
|
import * as primerComponents from '@primer/components'
|
3
|
-
import * as
|
3
|
+
import * as drafts from '@primer/components/drafts'
|
4
4
|
import * as doctocatComponents from '@primer/gatsby-theme-doctocat'
|
5
5
|
import {
|
6
6
|
CheckIcon,
|
@@ -40,7 +40,7 @@ const ReactRouterLink = ({to, ...props}) => {
|
|
40
40
|
export default {
|
41
41
|
...doctocatComponents,
|
42
42
|
...primerComponents,
|
43
|
-
|
43
|
+
drafts,
|
44
44
|
ReactRouterLink,
|
45
45
|
State,
|
46
46
|
CheckIcon,
|
@@ -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.Divider = exports.StyledDivider = void 0;
|
7
|
+
const react_1 = __importDefault(require("react"));
|
8
|
+
const styled_components_1 = __importDefault(require("styled-components"));
|
9
|
+
const constants_1 = require("../constants");
|
10
|
+
exports.StyledDivider = styled_components_1.default.div `
|
11
|
+
height: 1px;
|
12
|
+
background: ${constants_1.get('colors.border.muted')};
|
13
|
+
margin-top: calc(${constants_1.get('space.2')} - 1px);
|
14
|
+
margin-bottom: ${constants_1.get('space.2')};
|
15
|
+
`;
|
16
|
+
/**
|
17
|
+
* Visually separates `Item`s or `Group`s in an `ActionList`.
|
18
|
+
*/
|
19
|
+
function Divider() {
|
20
|
+
return <exports.StyledDivider />;
|
21
|
+
}
|
22
|
+
exports.Divider = Divider;
|
23
|
+
/**
|
24
|
+
* `Divider` fulfills the `ItemPropsWithCustomRenderer` contract,
|
25
|
+
* so it can be used inline in an `ActionList`’s `items` prop.
|
26
|
+
* In other words, `items={[ActionList.Divider]}` is supported as a concise
|
27
|
+
* alternative to `items={[{renderItem: () => <ActionList.Divider />}]}`.
|
28
|
+
*/
|
29
|
+
Divider.renderItem = Divider;
|
@@ -0,0 +1,23 @@
|
|
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.Group = void 0;
|
7
|
+
const react_1 = __importDefault(require("react"));
|
8
|
+
const styled_components_1 = __importDefault(require("styled-components"));
|
9
|
+
const sx_1 = __importDefault(require("../sx"));
|
10
|
+
const Header_1 = require("./Header");
|
11
|
+
const StyledGroup = styled_components_1.default.div `
|
12
|
+
${sx_1.default}
|
13
|
+
`;
|
14
|
+
/**
|
15
|
+
* Collects related `Items` in an `ActionList`.
|
16
|
+
*/
|
17
|
+
function Group({ header, items, ...props }) {
|
18
|
+
return (<StyledGroup {...props}>
|
19
|
+
{header && <Header_1.Header {...header}/>}
|
20
|
+
{items}
|
21
|
+
</StyledGroup>);
|
22
|
+
}
|
23
|
+
exports.Group = Group;
|
@@ -0,0 +1,66 @@
|
|
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.Header = exports.StyledHeader = void 0;
|
26
|
+
const react_1 = __importDefault(require("react"));
|
27
|
+
const styled_components_1 = __importStar(require("styled-components"));
|
28
|
+
const constants_1 = require("../constants");
|
29
|
+
const sx_1 = __importDefault(require("../sx"));
|
30
|
+
exports.StyledHeader = styled_components_1.default.div `
|
31
|
+
{
|
32
|
+
/* 6px vertical padding + 20px line height = 32px total height
|
33
|
+
*
|
34
|
+
* TODO: When rem-based spacing on a 4px scale lands, replace
|
35
|
+
* hardcoded '6px' with 'calc((${constants_1.get('space.s32')} - ${constants_1.get('space.20')}) / 2)'.
|
36
|
+
*/
|
37
|
+
}
|
38
|
+
padding: 6px ${constants_1.get('space.3')};
|
39
|
+
font-size: ${constants_1.get('fontSizes.0')};
|
40
|
+
font-weight: ${constants_1.get('fontWeights.bold')};
|
41
|
+
color: ${constants_1.get('colors.fg.muted')};
|
42
|
+
|
43
|
+
${({ variant }) => variant === 'filled' &&
|
44
|
+
styled_components_1.css `
|
45
|
+
background: ${constants_1.get('colors.canvas.subtle')};
|
46
|
+
margin: ${constants_1.get('space.2')} 0;
|
47
|
+
border-top: 1px solid ${constants_1.get('colors.neutral.muted')};
|
48
|
+
border-bottom: 1px solid ${constants_1.get('colors.neutral.muted')};
|
49
|
+
|
50
|
+
&:first-child {
|
51
|
+
margin-top: 0;
|
52
|
+
}
|
53
|
+
`}
|
54
|
+
|
55
|
+
${sx_1.default}
|
56
|
+
`;
|
57
|
+
/**
|
58
|
+
* Displays the name and description of a `Group`.
|
59
|
+
*/
|
60
|
+
function Header({ variant = 'subtle', title, auxiliaryText, children: _children, ...props }) {
|
61
|
+
return (<exports.StyledHeader role="heading" variant={variant} {...props}>
|
62
|
+
{title}
|
63
|
+
{auxiliaryText && <span>{auxiliaryText}</span>}
|
64
|
+
</exports.StyledHeader>);
|
65
|
+
}
|
66
|
+
exports.Header = Header;
|
@@ -0,0 +1,301 @@
|
|
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
|
+
`;
|
196
|
+
const ColoredVisualContainer = styled_components_1.default(BaseVisualContainer) `
|
197
|
+
svg {
|
198
|
+
fill: ${({ variant, disabled }) => getItemVariant(variant, disabled).iconColor};
|
199
|
+
font-size: ${constants_1.get('fontSizes.0')};
|
200
|
+
}
|
201
|
+
`;
|
202
|
+
const LeadingVisualContainer = styled_components_1.default(ColoredVisualContainer) `
|
203
|
+
flex-shrink: 0;
|
204
|
+
display: flex;
|
205
|
+
flex-direction: column;
|
206
|
+
justify-content: center;
|
207
|
+
`;
|
208
|
+
const TrailingContent = styled_components_1.default(ColoredVisualContainer) `
|
209
|
+
color: ${({ variant, disabled }) => getItemVariant(variant, disabled).annotationColor}};
|
210
|
+
margin-left: ${constants_1.get('space.2')};
|
211
|
+
margin-right: 0;
|
212
|
+
width: auto;
|
213
|
+
div:nth-child(2) {
|
214
|
+
margin-left: ${constants_1.get('space.2')};
|
215
|
+
}
|
216
|
+
`;
|
217
|
+
const DescriptionContainer = styled_components_1.default.span `
|
218
|
+
color: ${constants_1.get('colors.fg.muted')};
|
219
|
+
font-size: ${constants_1.get('fontSizes.0')};
|
220
|
+
// TODO: When rem-based spacing on a 4px scale lands, replace
|
221
|
+
// hardcoded '16px' with '${constants_1.get('lh-12')}'.
|
222
|
+
line-height: 16px;
|
223
|
+
margin-left: var(--description-container-margin-left);
|
224
|
+
min-width: 0;
|
225
|
+
flex-grow: 1;
|
226
|
+
flex-basis: var(--description-container-flex-basis);
|
227
|
+
`;
|
228
|
+
const MultiSelectInput = styled_components_1.default.input `
|
229
|
+
pointer-events: none;
|
230
|
+
`;
|
231
|
+
/**
|
232
|
+
* An actionable or selectable `Item` with an optional icon and description.
|
233
|
+
*/
|
234
|
+
exports.Item = react_1.default.forwardRef((itemProps, ref) => {
|
235
|
+
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;
|
236
|
+
const labelId = ssr_1.useSSRSafeId();
|
237
|
+
const descriptionId = ssr_1.useSSRSafeId();
|
238
|
+
const keyPressHandler = react_1.useCallback(event => {
|
239
|
+
if (disabled) {
|
240
|
+
return;
|
241
|
+
}
|
242
|
+
onKeyPress?.(event);
|
243
|
+
const isCheckbox = event.target instanceof HTMLInputElement && event.target.type === 'checkbox';
|
244
|
+
if (isCheckbox && event.key === ' ') {
|
245
|
+
// space key on a checkbox will also trigger a click event. Ignore the space key so we don't get double events
|
246
|
+
return;
|
247
|
+
}
|
248
|
+
if (!event.defaultPrevented && [' ', 'Enter'].includes(event.key)) {
|
249
|
+
onAction?.(itemProps, event);
|
250
|
+
}
|
251
|
+
}, [onAction, disabled, itemProps, onKeyPress]);
|
252
|
+
const clickHandler = react_1.useCallback(event => {
|
253
|
+
if (disabled) {
|
254
|
+
return;
|
255
|
+
}
|
256
|
+
onClick?.(event);
|
257
|
+
if (!event.defaultPrevented) {
|
258
|
+
onAction?.(itemProps, event);
|
259
|
+
}
|
260
|
+
}, [onAction, disabled, itemProps, onClick]);
|
261
|
+
const customItemTheme = customItemThemes[variant];
|
262
|
+
const hoverBackground = ThemeProvider_1.useColorSchemeVar(customItemTheme.hover, 'inherit');
|
263
|
+
const focusBackground = ThemeProvider_1.useColorSchemeVar(customItemTheme.focus, 'inherit');
|
264
|
+
const { theme } = ThemeProvider_1.useTheme();
|
265
|
+
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}>
|
266
|
+
{!!selected === selected && (<BaseVisualContainer>
|
267
|
+
{selectionVariant === 'multiple' ? (<>
|
268
|
+
{/*
|
269
|
+
* readOnly is required because we are doing a one-way bind to `checked`.
|
270
|
+
* aria-readonly="false" tells screen that they can still interact with the checkbox
|
271
|
+
*/}
|
272
|
+
<MultiSelectInput disabled={disabled} tabIndex={-1} type="checkbox" checked={selected} aria-label={text} readOnly aria-readonly="false"/>
|
273
|
+
</>) : (selected && <octicons_react_1.CheckIcon fill={theme?.colors.fg.default}/>)}
|
274
|
+
</BaseVisualContainer>)}
|
275
|
+
{LeadingVisual && (<LeadingVisualContainer variant={variant} disabled={disabled}>
|
276
|
+
<LeadingVisual />
|
277
|
+
</LeadingVisualContainer>)}
|
278
|
+
<DividedContent>
|
279
|
+
<MainContent style={{ '--main-content-flex-direction': descriptionVariant === 'inline' ? 'row' : 'column' }}>
|
280
|
+
{children}
|
281
|
+
{text ? <exports.TextContainer id={labelId}>{text}</exports.TextContainer> : null}
|
282
|
+
{description ? (<DescriptionContainer id={descriptionId} style={{
|
283
|
+
'--description-container-margin-left': descriptionVariant === 'inline' ? constants_1.get('space.2')(theme) : 0,
|
284
|
+
'--description-container-flex-basis': descriptionVariant === 'inline' ? 0 : 'auto'
|
285
|
+
}}>
|
286
|
+
{descriptionVariant === 'block' ? (description) : (<Truncate_1.default title={description} inline={true} maxWidth="100%">
|
287
|
+
{description}
|
288
|
+
</Truncate_1.default>)}
|
289
|
+
</DescriptionContainer>) : null}
|
290
|
+
</MainContent>
|
291
|
+
{/* backward compatibility: prefer TrailingVisual but fallback to TrailingIcon */}
|
292
|
+
{TrailingVisual ? (<TrailingContent variant={variant} disabled={disabled}>
|
293
|
+
{typeof TrailingVisual === 'function' ? <TrailingVisual /> : TrailingVisual}
|
294
|
+
</TrailingContent>) : TrailingIcon || trailingText ? (<TrailingContent variant={variant} disabled={disabled}>
|
295
|
+
{trailingText}
|
296
|
+
{TrailingIcon && <TrailingIcon />}
|
297
|
+
</TrailingContent>) : null}
|
298
|
+
</DividedContent>
|
299
|
+
</StyledItem>);
|
300
|
+
});
|
301
|
+
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';
|