@primer/components 29.1.1 → 30.0.0-rc.48fd5c94
Sign up to get free protection for your applications and to get access to all the features.
- package/.changeset/README.md +8 -0
- package/.changeset/config.json +10 -0
- package/.devcontainer/devcontainer.json +8 -0
- package/.eslintrc.json +136 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
- package/.github/ISSUE_TEMPLATE/new_component_proposal_template.md +41 -0
- package/.github/dependabot.yml +18 -0
- package/.github/pull_request_template.md +18 -0
- package/.github/workflows/ci.yml +31 -0
- package/.github/workflows/deploy_preview.yml +47 -0
- package/.github/workflows/deploy_production.yml +70 -0
- package/.github/workflows/release.yml +35 -0
- package/.github/workflows/release_canary.yml +70 -0
- package/.github/workflows/release_candidate.yml +60 -0
- package/.github/workflows/size.yml +13 -0
- package/.github/workflows/stale.yml +26 -0
- package/.gitignore +10 -0
- package/.npmrc +4 -0
- package/.nvmrc +1 -0
- package/.storybook/main.js +11 -0
- package/.storybook/preview.js +69 -0
- package/.vscode/launch.json +21 -0
- package/.vscode/settings.json +13 -0
- package/@types/@styled-system/index.d.ts +0 -0
- package/@types/@styled-system/prop-types/index.d.ts +1 -0
- package/@types/@styled-system/props/index.d.ts +1 -0
- package/@types/jest-styled-components/index.d.ts +1 -0
- package/CHANGELOG.md +11 -1
- package/CODEOWNERS +2 -0
- package/babel-defines.js +13 -0
- package/babel.config.js +39 -0
- package/contributor-docs/CODE_OF_CONDUCT.md +76 -0
- package/contributor-docs/CONTRIBUTING.md +274 -0
- package/contributor-docs/adrs/adr-001-typescript.md +23 -0
- package/contributor-docs/adrs/adr-002-behavior-isolation.md +106 -0
- package/contributor-docs/behaviors.md +132 -0
- package/contributor-docs/component-contents-api-patterns.md +316 -0
- package/contributor-docs/principles.md +39 -0
- package/dist/browser.esm.js +130 -130
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +113 -113
- package/dist/browser.umd.js.map +1 -1
- package/docs/.eslintrc +0 -0
- package/docs/.gitignore +91 -0
- package/docs/components/PropsList.js +5 -0
- package/docs/components/State.js +9 -0
- package/docs/components/constants.js +34 -0
- package/docs/components/index.js +2 -0
- package/docs/content/ActionList.mdx +72 -0
- package/docs/content/ActionMenu.mdx +80 -0
- package/docs/content/AnchoredOverlay.mdx +37 -0
- package/docs/content/Avatar.mdx +33 -0
- package/docs/content/AvatarStack.mdx +43 -0
- package/docs/content/BorderBox.md +46 -0
- package/docs/content/Box.md +74 -0
- package/docs/content/BranchName.md +18 -0
- package/docs/content/Breadcrumbs.md +52 -0
- package/docs/content/Buttons.md +56 -0
- package/docs/content/CircleBadge.md +45 -0
- package/docs/content/CircleOcticon.md +18 -0
- package/docs/content/CounterLabel.md +32 -0
- package/docs/content/Details.md +105 -0
- package/docs/content/Dialog.md +108 -0
- package/docs/content/Dialog2.mdx +179 -0
- package/docs/content/Dropdown.md +72 -0
- package/docs/content/DropdownMenu.mdx +49 -0
- package/docs/content/FilterList.md +44 -0
- package/docs/content/FilteredSearch.md +39 -0
- package/docs/content/Flash.md +44 -0
- package/docs/content/Flex.md +58 -0
- package/docs/content/FormGroup.md +46 -0
- package/docs/content/Grid.md +59 -0
- package/docs/content/Header.md +79 -0
- package/docs/content/Heading.md +22 -0
- package/docs/content/Label.md +42 -0
- package/docs/content/LabelGroup.md +31 -0
- package/docs/content/Link.md +37 -0
- package/docs/content/Overlay.mdx +94 -0
- package/docs/content/Pagehead.md +27 -0
- package/docs/content/Pagination.md +187 -0
- package/docs/content/PointerBox.md +81 -0
- package/docs/content/Popover.md +137 -0
- package/docs/content/Portal.mdx +78 -0
- package/docs/content/Position.md +100 -0
- package/docs/content/ProgressBar.mdx +29 -0
- package/docs/content/SelectMenu.md +435 -0
- package/docs/content/SelectPanel.mdx +67 -0
- package/docs/content/SideNav.md +179 -0
- package/docs/content/Spinner.mdx +32 -0
- package/docs/content/StateLabel.md +35 -0
- package/docs/content/StyledOcticon.md +36 -0
- package/docs/content/SubNav.md +102 -0
- package/docs/content/TabNav.md +50 -0
- package/docs/content/Text.md +31 -0
- package/docs/content/TextInput.md +34 -0
- package/docs/content/Timeline.md +138 -0
- package/docs/content/Tooltip.md +41 -0
- package/docs/content/Truncate.md +64 -0
- package/docs/content/UnderlineNav.md +53 -0
- package/docs/content/anchoredPosition.mdx +163 -0
- package/docs/content/core-concepts.md +70 -0
- package/docs/content/focusTrap.mdx +103 -0
- package/docs/content/focusZone.mdx +145 -0
- package/docs/content/getting-started.md +138 -0
- package/docs/content/index.md +33 -0
- package/docs/content/linting.md +35 -0
- package/docs/content/overriding-styles.mdx +81 -0
- package/docs/content/philosophy.md +23 -0
- package/docs/content/primer-theme.md +89 -0
- package/docs/content/ssr.mdx +43 -0
- package/docs/content/system-props.mdx +37 -0
- package/docs/content/theme-reference.md +16 -0
- package/docs/content/theming.md +249 -0
- package/docs/content/useOnEscapePress.mdx +56 -0
- package/docs/content/useOnOutsideClick.mdx +57 -0
- package/docs/content/useOpenAndCloseFocus.mdx +49 -0
- package/docs/content/useOverlay.mdx +62 -0
- package/docs/content/useSafeTimeout.mdx +32 -0
- package/docs/gatsby-config.js +30 -0
- package/docs/gatsby-node.js +101 -0
- package/docs/package-lock.json +20979 -0
- package/docs/package.json +35 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/hero.js +21 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/live-code.js +84 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/live-preview-wrapper.js +39 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/nav-dropdown.js +48 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/wrap-page-element.js +25 -0
- package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +54 -0
- package/docs/src/@primer/gatsby-theme-doctocat/nav.yml +127 -0
- package/docs/src/@primer/gatsby-theme-doctocat/primer-components-hero.svg +1411 -0
- package/docs/src/props.js +77 -0
- package/jest.config.js +13 -0
- package/lib/Breadcrumbs.d.ts +40 -0
- package/lib/{Breadcrumb.js → Breadcrumbs.js} +31 -21
- package/lib/__tests__/ActionList.d.ts +1 -0
- package/lib/__tests__/ActionList.js +67 -0
- package/lib/__tests__/ActionMenu.d.ts +1 -0
- package/lib/__tests__/ActionMenu.js +154 -0
- package/lib/__tests__/AnchoredOverlay.d.ts +1 -0
- package/lib/__tests__/AnchoredOverlay.js +161 -0
- package/lib/__tests__/Avatar.d.ts +1 -0
- package/lib/__tests__/Avatar.js +70 -0
- package/lib/__tests__/AvatarStack.d.ts +1 -0
- package/lib/__tests__/AvatarStack.js +71 -0
- package/lib/__tests__/BorderBox.d.ts +1 -0
- package/lib/__tests__/BorderBox.js +61 -0
- package/lib/__tests__/Box.d.ts +1 -0
- package/lib/__tests__/Box.js +81 -0
- package/lib/__tests__/BranchName.d.ts +1 -0
- package/lib/__tests__/BranchName.js +39 -0
- package/lib/__tests__/Breadcrumbs.d.ts +1 -0
- package/lib/__tests__/Breadcrumbs.js +40 -0
- package/lib/__tests__/BreadcrumbsItem.d.ts +1 -0
- package/lib/__tests__/BreadcrumbsItem.js +52 -0
- package/lib/__tests__/Button.d.ts +1 -0
- package/lib/__tests__/Button.js +152 -0
- package/lib/__tests__/Caret.d.ts +1 -0
- package/lib/__tests__/Caret.js +52 -0
- package/lib/__tests__/CircleBadge.d.ts +1 -0
- package/lib/__tests__/CircleBadge.js +87 -0
- package/lib/__tests__/CircleOcticon.d.ts +1 -0
- package/lib/__tests__/CircleOcticon.js +74 -0
- package/lib/__tests__/CounterLabel.d.ts +1 -0
- package/lib/__tests__/CounterLabel.js +61 -0
- package/lib/__tests__/Details.d.ts +1 -0
- package/lib/__tests__/Details.js +120 -0
- package/lib/__tests__/Dialog.d.ts +1 -0
- package/lib/__tests__/Dialog.js +188 -0
- package/lib/__tests__/Dropdown.d.ts +1 -0
- package/lib/__tests__/Dropdown.js +70 -0
- package/lib/__tests__/DropdownMenu.d.ts +1 -0
- package/lib/__tests__/DropdownMenu.js +153 -0
- package/lib/__tests__/FilterList.d.ts +1 -0
- package/lib/__tests__/FilterList.js +39 -0
- package/lib/__tests__/FilterListItem.d.ts +1 -0
- package/lib/__tests__/FilterListItem.js +49 -0
- package/lib/__tests__/FilteredSearch.d.ts +1 -0
- package/lib/__tests__/FilteredSearch.js +39 -0
- package/lib/__tests__/Flash.d.ts +1 -0
- package/lib/__tests__/Flash.js +65 -0
- package/lib/__tests__/Flex.d.ts +1 -0
- package/lib/__tests__/Flex.js +77 -0
- package/lib/__tests__/FormGroup.d.ts +1 -0
- package/lib/__tests__/FormGroup.js +58 -0
- package/lib/__tests__/Grid.d.ts +1 -0
- package/lib/__tests__/Grid.js +107 -0
- package/lib/__tests__/Header.d.ts +1 -0
- package/lib/__tests__/Header.js +63 -0
- package/lib/__tests__/Heading.d.ts +1 -0
- package/lib/__tests__/Heading.js +112 -0
- package/lib/__tests__/Label.d.ts +1 -0
- package/lib/__tests__/Label.js +49 -0
- package/lib/__tests__/LabelGroup.d.ts +1 -0
- package/lib/__tests__/LabelGroup.js +41 -0
- package/lib/__tests__/Link.d.ts +1 -0
- package/lib/__tests__/Link.js +73 -0
- package/lib/__tests__/Overlay.d.ts +1 -0
- package/lib/__tests__/Overlay.js +145 -0
- package/lib/__tests__/Pagehead.d.ts +1 -0
- package/lib/__tests__/Pagehead.js +40 -0
- package/lib/__tests__/Pagination/Pagination.d.ts +1 -0
- package/lib/__tests__/Pagination/Pagination.js +50 -0
- package/lib/__tests__/Pagination/PaginationModel.d.ts +1 -0
- package/lib/__tests__/Pagination/PaginationModel.js +186 -0
- package/lib/__tests__/PointerBox.d.ts +1 -0
- package/lib/__tests__/PointerBox.js +49 -0
- package/lib/__tests__/Popover.d.ts +1 -0
- package/lib/__tests__/Popover.js +70 -0
- package/lib/__tests__/Portal.d.ts +1 -0
- package/lib/__tests__/Portal.js +124 -0
- package/lib/__tests__/Position.d.ts +1 -0
- package/lib/__tests__/Position.js +149 -0
- package/lib/__tests__/ProgressBar.d.ts +1 -0
- package/lib/__tests__/ProgressBar.js +71 -0
- package/lib/__tests__/SelectMenu.d.ts +1 -0
- package/lib/__tests__/SelectMenu.js +155 -0
- package/lib/__tests__/SelectPanel.d.ts +1 -0
- package/lib/__tests__/SelectPanel.js +83 -0
- package/lib/__tests__/SideNav.d.ts +1 -0
- package/lib/__tests__/SideNav.js +75 -0
- package/lib/__tests__/Spinner.d.ts +1 -0
- package/lib/__tests__/Spinner.js +56 -0
- package/lib/__tests__/StateLabel.d.ts +1 -0
- package/lib/__tests__/StateLabel.js +74 -0
- package/lib/__tests__/StyledOcticon.d.ts +1 -0
- package/lib/__tests__/StyledOcticon.js +43 -0
- package/lib/__tests__/SubNav.d.ts +1 -0
- package/lib/__tests__/SubNav.js +65 -0
- package/lib/__tests__/SubNavLink.d.ts +1 -0
- package/lib/__tests__/SubNavLink.js +52 -0
- package/lib/__tests__/TabNav.d.ts +1 -0
- package/lib/__tests__/TabNav.js +53 -0
- package/lib/__tests__/Text.d.ts +1 -0
- package/lib/__tests__/Text.js +108 -0
- package/lib/__tests__/TextInput.d.ts +1 -0
- package/lib/__tests__/TextInput.js +81 -0
- package/lib/__tests__/ThemeProvider.d.ts +1 -0
- package/lib/__tests__/ThemeProvider.js +444 -0
- package/lib/__tests__/Timeline.d.ts +1 -0
- package/lib/__tests__/Timeline.js +80 -0
- package/lib/__tests__/Tooltip.d.ts +1 -0
- package/lib/__tests__/Tooltip.js +72 -0
- package/lib/__tests__/Truncate.d.ts +1 -0
- package/lib/__tests__/Truncate.js +66 -0
- package/lib/__tests__/UnderlineNav.d.ts +1 -0
- package/lib/__tests__/UnderlineNav.js +75 -0
- package/lib/__tests__/UnderlineNavLink.d.ts +1 -0
- package/lib/__tests__/UnderlineNavLink.js +54 -0
- package/lib/__tests__/behaviors/anchoredPosition.d.ts +1 -0
- package/lib/__tests__/behaviors/anchoredPosition.js +390 -0
- package/lib/__tests__/behaviors/focusTrap.d.ts +1 -0
- package/lib/__tests__/behaviors/focusTrap.js +234 -0
- package/lib/__tests__/behaviors/focusZone.d.ts +1 -0
- package/lib/__tests__/behaviors/focusZone.js +570 -0
- package/lib/__tests__/behaviors/iterateFocusableElements.d.ts +1 -0
- package/lib/__tests__/behaviors/iterateFocusableElements.js +55 -0
- package/lib/__tests__/filterObject.d.ts +1 -0
- package/lib/__tests__/filterObject.js +30 -0
- package/lib/__tests__/hooks/useAnchoredPosition.d.ts +1 -0
- package/lib/__tests__/hooks/useAnchoredPosition.js +54 -0
- package/lib/__tests__/hooks/useOnEscapePress.d.ts +1 -0
- package/lib/__tests__/hooks/useOnEscapePress.js +32 -0
- package/lib/__tests__/hooks/useOnOutsideClick.d.ts +1 -0
- package/lib/__tests__/hooks/useOnOutsideClick.js +87 -0
- package/lib/__tests__/hooks/useOpenAndCloseFocus.d.ts +1 -0
- package/lib/__tests__/hooks/useOpenAndCloseFocus.js +60 -0
- package/lib/__tests__/hooks/useProvidedStateOrCreate.d.ts +1 -0
- package/lib/__tests__/hooks/useProvidedStateOrCreate.js +45 -0
- package/lib/__tests__/theme.d.ts +1 -0
- package/lib/__tests__/theme.js +36 -0
- package/lib/__tests__/themeGet.d.ts +1 -0
- package/lib/__tests__/themeGet.js +25 -0
- package/lib/__tests__/useSafeTimeout.d.ts +1 -0
- package/lib/__tests__/useSafeTimeout.js +45 -0
- package/lib/index.d.ts +2 -2
- package/lib/index.js +8 -2
- package/lib/stories/ActionList.stories.js +382 -0
- package/lib/stories/ActionMenu.stories.js +338 -0
- package/lib/stories/AnchoredOverlay.stories.js +127 -0
- package/lib/stories/AvatarStack.stories.js +49 -0
- package/lib/stories/Button.stories.js +114 -0
- package/lib/stories/ConfirmationDialog.stories.js +111 -0
- package/lib/stories/Dialog.stories.js +265 -0
- package/lib/stories/DropdownMenu.stories.js +122 -0
- package/lib/stories/Overlay.stories.js +185 -0
- package/lib/stories/Portal.stories.js +104 -0
- package/lib/stories/SelectPanel.stories.js +342 -0
- package/lib/stories/ThemeProvider.stories.js +102 -0
- package/lib/stories/useAnchoredPosition.stories.js +351 -0
- package/lib/stories/useFocusTrap.stories.js +356 -0
- package/lib/stories/useFocusZone.stories.js +599 -0
- package/lib-esm/Breadcrumbs.d.ts +40 -0
- package/lib-esm/{Breadcrumb.js → Breadcrumbs.js} +28 -19
- package/lib-esm/__tests__/ActionList.d.ts +1 -0
- package/lib-esm/__tests__/ActionList.js +54 -0
- package/lib-esm/__tests__/ActionMenu.d.ts +1 -0
- package/lib-esm/__tests__/ActionMenu.js +141 -0
- package/lib-esm/__tests__/AnchoredOverlay.d.ts +1 -0
- package/lib-esm/__tests__/AnchoredOverlay.js +135 -0
- package/lib-esm/__tests__/Avatar.d.ts +1 -0
- package/lib-esm/__tests__/Avatar.js +58 -0
- package/lib-esm/__tests__/AvatarStack.d.ts +1 -0
- package/lib-esm/__tests__/AvatarStack.js +57 -0
- package/lib-esm/__tests__/BorderBox.d.ts +1 -0
- package/lib-esm/__tests__/BorderBox.js +49 -0
- package/lib-esm/__tests__/Box.d.ts +1 -0
- package/lib-esm/__tests__/Box.js +69 -0
- package/lib-esm/__tests__/BranchName.d.ts +1 -0
- package/lib-esm/__tests__/BranchName.js +28 -0
- package/lib-esm/__tests__/Breadcrumbs.d.ts +1 -0
- package/lib-esm/__tests__/Breadcrumbs.js +29 -0
- package/lib-esm/__tests__/BreadcrumbsItem.d.ts +1 -0
- package/lib-esm/__tests__/BreadcrumbsItem.js +41 -0
- package/lib-esm/__tests__/Button.d.ts +1 -0
- package/lib-esm/__tests__/Button.js +141 -0
- package/lib-esm/__tests__/Caret.d.ts +1 -0
- package/lib-esm/__tests__/Caret.js +42 -0
- package/lib-esm/__tests__/CircleBadge.d.ts +1 -0
- package/lib-esm/__tests__/CircleBadge.js +73 -0
- package/lib-esm/__tests__/CircleOcticon.d.ts +1 -0
- package/lib-esm/__tests__/CircleOcticon.js +61 -0
- package/lib-esm/__tests__/CounterLabel.d.ts +1 -0
- package/lib-esm/__tests__/CounterLabel.js +49 -0
- package/lib-esm/__tests__/Details.d.ts +1 -0
- package/lib-esm/__tests__/Details.js +109 -0
- package/lib-esm/__tests__/Dialog.d.ts +1 -0
- package/lib-esm/__tests__/Dialog.js +174 -0
- package/lib-esm/__tests__/Dropdown.d.ts +1 -0
- package/lib-esm/__tests__/Dropdown.js +59 -0
- package/lib-esm/__tests__/DropdownMenu.d.ts +1 -0
- package/lib-esm/__tests__/DropdownMenu.js +139 -0
- package/lib-esm/__tests__/FilterList.d.ts +1 -0
- package/lib-esm/__tests__/FilterList.js +28 -0
- package/lib-esm/__tests__/FilterListItem.d.ts +1 -0
- package/lib-esm/__tests__/FilterListItem.js +38 -0
- package/lib-esm/__tests__/FilteredSearch.d.ts +1 -0
- package/lib-esm/__tests__/FilteredSearch.js +28 -0
- package/lib-esm/__tests__/Flash.d.ts +1 -0
- package/lib-esm/__tests__/Flash.js +53 -0
- package/lib-esm/__tests__/Flex.d.ts +1 -0
- package/lib-esm/__tests__/Flex.js +66 -0
- package/lib-esm/__tests__/FormGroup.d.ts +1 -0
- package/lib-esm/__tests__/FormGroup.js +47 -0
- package/lib-esm/__tests__/Grid.d.ts +1 -0
- package/lib-esm/__tests__/Grid.js +96 -0
- package/lib-esm/__tests__/Header.d.ts +1 -0
- package/lib-esm/__tests__/Header.js +52 -0
- package/lib-esm/__tests__/Heading.d.ts +1 -0
- package/lib-esm/__tests__/Heading.js +101 -0
- package/lib-esm/__tests__/Label.d.ts +1 -0
- package/lib-esm/__tests__/Label.js +38 -0
- package/lib-esm/__tests__/LabelGroup.d.ts +1 -0
- package/lib-esm/__tests__/LabelGroup.js +28 -0
- package/lib-esm/__tests__/Link.d.ts +1 -0
- package/lib-esm/__tests__/Link.js +62 -0
- package/lib-esm/__tests__/Overlay.d.ts +1 -0
- package/lib-esm/__tests__/Overlay.js +123 -0
- package/lib-esm/__tests__/Pagehead.d.ts +1 -0
- package/lib-esm/__tests__/Pagehead.js +28 -0
- package/lib-esm/__tests__/Pagination/Pagination.d.ts +1 -0
- package/lib-esm/__tests__/Pagination/Pagination.js +37 -0
- package/lib-esm/__tests__/Pagination/PaginationModel.d.ts +1 -0
- package/lib-esm/__tests__/Pagination/PaginationModel.js +182 -0
- package/lib-esm/__tests__/PointerBox.d.ts +1 -0
- package/lib-esm/__tests__/PointerBox.js +38 -0
- package/lib-esm/__tests__/Popover.d.ts +1 -0
- package/lib-esm/__tests__/Popover.js +56 -0
- package/lib-esm/__tests__/Portal.d.ts +1 -0
- package/lib-esm/__tests__/Portal.js +104 -0
- package/lib-esm/__tests__/Position.d.ts +1 -0
- package/lib-esm/__tests__/Position.js +138 -0
- package/lib-esm/__tests__/ProgressBar.d.ts +1 -0
- package/lib-esm/__tests__/ProgressBar.js +60 -0
- package/lib-esm/__tests__/SelectMenu.d.ts +1 -0
- package/lib-esm/__tests__/SelectMenu.js +145 -0
- package/lib-esm/__tests__/SelectPanel.d.ts +1 -0
- package/lib-esm/__tests__/SelectPanel.js +67 -0
- package/lib-esm/__tests__/SideNav.d.ts +1 -0
- package/lib-esm/__tests__/SideNav.js +63 -0
- package/lib-esm/__tests__/Spinner.d.ts +1 -0
- package/lib-esm/__tests__/Spinner.js +45 -0
- package/lib-esm/__tests__/StateLabel.d.ts +1 -0
- package/lib-esm/__tests__/StateLabel.js +63 -0
- package/lib-esm/__tests__/StyledOcticon.d.ts +1 -0
- package/lib-esm/__tests__/StyledOcticon.js +31 -0
- package/lib-esm/__tests__/SubNav.d.ts +1 -0
- package/lib-esm/__tests__/SubNav.js +52 -0
- package/lib-esm/__tests__/SubNavLink.d.ts +1 -0
- package/lib-esm/__tests__/SubNavLink.js +41 -0
- package/lib-esm/__tests__/TabNav.d.ts +1 -0
- package/lib-esm/__tests__/TabNav.js +42 -0
- package/lib-esm/__tests__/Text.d.ts +1 -0
- package/lib-esm/__tests__/Text.js +95 -0
- package/lib-esm/__tests__/TextInput.d.ts +1 -0
- package/lib-esm/__tests__/TextInput.js +70 -0
- package/lib-esm/__tests__/ThemeProvider.d.ts +1 -0
- package/lib-esm/__tests__/ThemeProvider.js +408 -0
- package/lib-esm/__tests__/Timeline.d.ts +1 -0
- package/lib-esm/__tests__/Timeline.js +69 -0
- package/lib-esm/__tests__/Tooltip.d.ts +1 -0
- package/lib-esm/__tests__/Tooltip.js +61 -0
- package/lib-esm/__tests__/Truncate.d.ts +1 -0
- package/lib-esm/__tests__/Truncate.js +55 -0
- package/lib-esm/__tests__/UnderlineNav.d.ts +1 -0
- package/lib-esm/__tests__/UnderlineNav.js +62 -0
- package/lib-esm/__tests__/UnderlineNavLink.d.ts +1 -0
- package/lib-esm/__tests__/UnderlineNavLink.js +43 -0
- package/lib-esm/__tests__/behaviors/anchoredPosition.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/anchoredPosition.js +388 -0
- package/lib-esm/__tests__/behaviors/focusTrap.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/focusTrap.js +227 -0
- package/lib-esm/__tests__/behaviors/focusZone.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/focusZone.js +487 -0
- package/lib-esm/__tests__/behaviors/iterateFocusableElements.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/iterateFocusableElements.js +48 -0
- package/lib-esm/__tests__/filterObject.d.ts +1 -0
- package/lib-esm/__tests__/filterObject.js +27 -0
- package/lib-esm/__tests__/hooks/useAnchoredPosition.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useAnchoredPosition.js +46 -0
- package/lib-esm/__tests__/hooks/useOnEscapePress.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useOnEscapePress.js +23 -0
- package/lib-esm/__tests__/hooks/useOnOutsideClick.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useOnOutsideClick.js +68 -0
- package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.js +52 -0
- package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.js +36 -0
- package/lib-esm/__tests__/theme.d.ts +1 -0
- package/lib-esm/__tests__/theme.js +33 -0
- package/lib-esm/__tests__/themeGet.d.ts +1 -0
- package/lib-esm/__tests__/themeGet.js +22 -0
- package/lib-esm/__tests__/useSafeTimeout.d.ts +1 -0
- package/lib-esm/__tests__/useSafeTimeout.js +39 -0
- package/lib-esm/index.d.ts +2 -2
- package/lib-esm/index.js +1 -1
- package/lib-esm/stories/ActionList.stories.js +334 -0
- package/lib-esm/stories/ActionMenu.stories.js +293 -0
- package/lib-esm/stories/AnchoredOverlay.stories.js +101 -0
- package/lib-esm/stories/AvatarStack.stories.js +32 -0
- package/lib-esm/stories/Button.stories.js +78 -0
- package/lib-esm/stories/ConfirmationDialog.stories.js +86 -0
- package/lib-esm/stories/Dialog.stories.js +240 -0
- package/lib-esm/stories/DropdownMenu.stories.js +94 -0
- package/lib-esm/stories/Overlay.stories.js +154 -0
- package/lib-esm/stories/Portal.stories.js +68 -0
- package/lib-esm/stories/SelectPanel.stories.js +284 -0
- package/lib-esm/stories/ThemeProvider.stories.js +83 -0
- package/lib-esm/stories/useAnchoredPosition.stories.js +313 -0
- package/lib-esm/stories/useFocusTrap.stories.js +309 -0
- package/lib-esm/stories/useFocusZone.stories.js +554 -0
- package/migrating.md +250 -0
- package/now.json +17 -0
- package/package-lock.json +28942 -0
- package/package.json +6 -5
- package/rollup.config.js +36 -0
- package/script/build +19 -0
- package/script/setup +12 -0
- package/src/ActionList/Divider.tsx +25 -0
- package/src/ActionList/Group.tsx +45 -0
- package/src/ActionList/Header.tsx +74 -0
- package/src/ActionList/Item.tsx +460 -0
- package/src/ActionList/List.tsx +253 -0
- package/src/ActionList/index.ts +21 -0
- package/src/ActionMenu.tsx +106 -0
- package/src/AnchoredOverlay/AnchoredOverlay.tsx +180 -0
- package/src/AnchoredOverlay/index.ts +2 -0
- package/src/Avatar.tsx +46 -0
- package/src/AvatarPair.tsx +35 -0
- package/src/AvatarStack.tsx +161 -0
- package/src/BaseStyles.tsx +53 -0
- package/src/BorderBox.tsx +18 -0
- package/src/Box.tsx +54 -0
- package/src/BranchName.tsx +19 -0
- package/src/Breadcrumbs.tsx +101 -0
- package/src/Button/Button.tsx +40 -0
- package/src/Button/ButtonBase.tsx +43 -0
- package/src/Button/ButtonClose.tsx +40 -0
- package/src/Button/ButtonDanger.tsx +43 -0
- package/src/Button/ButtonGroup.tsx +55 -0
- package/src/Button/ButtonInvisible.tsx +27 -0
- package/src/Button/ButtonOutline.tsx +43 -0
- package/src/Button/ButtonPrimary.tsx +41 -0
- package/src/Button/ButtonStyles.tsx +36 -0
- package/src/Button/ButtonTableList.tsx +58 -0
- package/src/Button/index.ts +16 -0
- package/src/Caret.tsx +133 -0
- package/src/CircleBadge.tsx +55 -0
- package/src/CircleOcticon.tsx +37 -0
- package/src/CounterLabel.tsx +52 -0
- package/src/Details.tsx +23 -0
- package/src/Dialog/ConfirmationDialog.tsx +184 -0
- package/src/Dialog/Dialog.tsx +419 -0
- package/src/Dialog.tsx +149 -0
- package/src/Dropdown.tsx +158 -0
- package/src/DropdownMenu/DropdownButton.tsx +15 -0
- package/src/DropdownMenu/DropdownMenu.tsx +115 -0
- package/src/DropdownMenu/index.ts +4 -0
- package/src/DropdownStyles.ts +128 -0
- package/src/FilterList.tsx +81 -0
- package/src/FilteredActionList/FilteredActionList.tsx +152 -0
- package/src/FilteredActionList/index.ts +2 -0
- package/src/FilteredSearch.tsx +28 -0
- package/src/Flash.tsx +77 -0
- package/src/Flex.tsx +15 -0
- package/src/FormGroup.tsx +27 -0
- package/src/Grid.tsx +15 -0
- package/src/Header.tsx +84 -0
- package/src/Heading.tsx +21 -0
- package/src/Label.tsx +75 -0
- package/src/LabelGroup.tsx +18 -0
- package/src/Link.tsx +46 -0
- package/src/Overlay.tsx +194 -0
- package/src/Pagehead.tsx +17 -0
- package/src/Pagination/Pagination.tsx +214 -0
- package/src/Pagination/index.ts +4 -0
- package/src/Pagination/model.tsx +187 -0
- package/src/PointerBox.tsx +31 -0
- package/src/Popover.tsx +236 -0
- package/src/Portal/Portal.tsx +96 -0
- package/src/Portal/index.ts +5 -0
- package/src/Position.tsx +63 -0
- package/src/ProgressBar.tsx +52 -0
- package/src/SelectMenu/SelectMenu.tsx +125 -0
- package/src/SelectMenu/SelectMenuContext.tsx +9 -0
- package/src/SelectMenu/SelectMenuDivider.tsx +25 -0
- package/src/SelectMenu/SelectMenuFilter.tsx +51 -0
- package/src/SelectMenu/SelectMenuFooter.tsx +28 -0
- package/src/SelectMenu/SelectMenuHeader.tsx +50 -0
- package/src/SelectMenu/SelectMenuItem.tsx +137 -0
- package/src/SelectMenu/SelectMenuList.tsx +42 -0
- package/src/SelectMenu/SelectMenuLoadingAnimation.tsx +24 -0
- package/src/SelectMenu/SelectMenuModal.tsx +121 -0
- package/src/SelectMenu/SelectMenuTab.tsx +88 -0
- package/src/SelectMenu/SelectMenuTabPanel.tsx +30 -0
- package/src/SelectMenu/SelectMenuTabs.tsx +44 -0
- package/src/SelectMenu/hooks/useKeyboardNav.js +90 -0
- package/src/SelectMenu/index.ts +15 -0
- package/src/SelectPanel/SelectPanel.tsx +172 -0
- package/src/SelectPanel/index.ts +2 -0
- package/src/SideNav.tsx +193 -0
- package/src/Spinner.tsx +59 -0
- package/src/StateLabel.tsx +110 -0
- package/src/StyledOcticon.tsx +24 -0
- package/src/SubNav.tsx +129 -0
- package/src/TabNav.tsx +77 -0
- package/src/Text.tsx +13 -0
- package/src/TextInput.tsx +183 -0
- package/src/ThemeProvider.tsx +176 -0
- package/src/Timeline.tsx +141 -0
- package/src/Tooltip.tsx +263 -0
- package/src/Truncate.tsx +36 -0
- package/src/UnderlineNav.tsx +110 -0
- package/src/__tests__/.eslintrc.json +11 -0
- package/src/__tests__/ActionList.tsx +49 -0
- package/src/__tests__/ActionMenu.tsx +138 -0
- package/src/__tests__/AnchoredOverlay.tsx +151 -0
- package/src/__tests__/Avatar.tsx +45 -0
- package/src/__tests__/AvatarStack.tsx +45 -0
- package/src/__tests__/BorderBox.tsx +44 -0
- package/src/__tests__/Box.tsx +43 -0
- package/src/__tests__/BranchName.tsx +27 -0
- package/src/__tests__/Breadcrumbs.tsx +28 -0
- package/src/__tests__/BreadcrumbsItem.tsx +32 -0
- package/src/__tests__/Button.tsx +129 -0
- package/src/__tests__/Caret.tsx +36 -0
- package/src/__tests__/CircleBadge.tsx +69 -0
- package/src/__tests__/CircleOcticon.tsx +52 -0
- package/src/__tests__/CounterLabel.tsx +51 -0
- package/src/__tests__/Details.tsx +116 -0
- package/src/__tests__/Dialog.tsx +157 -0
- package/src/__tests__/Dropdown.tsx +57 -0
- package/src/__tests__/DropdownMenu.tsx +138 -0
- package/src/__tests__/FilterList.tsx +27 -0
- package/src/__tests__/FilterListItem.tsx +32 -0
- package/src/__tests__/FilteredSearch.tsx +27 -0
- package/src/__tests__/Flash.tsx +46 -0
- package/src/__tests__/Flex.tsx +59 -0
- package/src/__tests__/FormGroup.tsx +39 -0
- package/src/__tests__/Grid.tsx +83 -0
- package/src/__tests__/Header.tsx +50 -0
- package/src/__tests__/Heading.tsx +92 -0
- package/src/__tests__/Label.tsx +35 -0
- package/src/__tests__/LabelGroup.tsx +31 -0
- package/src/__tests__/Link.tsx +48 -0
- package/src/__tests__/Overlay.tsx +103 -0
- package/src/__tests__/Pagehead.tsx +24 -0
- package/src/__tests__/Pagination/Pagination.tsx +31 -0
- package/src/__tests__/Pagination/PaginationModel.tsx +133 -0
- package/src/__tests__/Pagination/__snapshots__/Pagination.tsx.snap +184 -0
- package/src/__tests__/PointerBox.tsx +35 -0
- package/src/__tests__/Popover.tsx +69 -0
- package/src/__tests__/Portal.tsx +103 -0
- package/src/__tests__/Position.tsx +118 -0
- package/src/__tests__/ProgressBar.tsx +41 -0
- package/src/__tests__/SelectMenu.tsx +142 -0
- package/src/__tests__/SelectPanel.tsx +65 -0
- package/src/__tests__/SideNav.tsx +63 -0
- package/src/__tests__/Spinner.tsx +44 -0
- package/src/__tests__/StateLabel.tsx +50 -0
- package/src/__tests__/StyledOcticon.tsx +28 -0
- package/src/__tests__/SubNav.tsx +51 -0
- package/src/__tests__/SubNavLink.tsx +32 -0
- package/src/__tests__/TabNav.tsx +33 -0
- package/src/__tests__/Text.tsx +79 -0
- package/src/__tests__/TextInput.tsx +50 -0
- package/src/__tests__/ThemeProvider.tsx +441 -0
- package/src/__tests__/Timeline.tsx +59 -0
- package/src/__tests__/Tooltip.tsx +53 -0
- package/src/__tests__/Truncate.tsx +45 -0
- package/src/__tests__/UnderlineNav.tsx +59 -0
- package/src/__tests__/UnderlineNavLink.tsx +32 -0
- package/src/__tests__/__snapshots__/ActionList.tsx.snap +27 -0
- package/src/__tests__/__snapshots__/ActionMenu.tsx.snap +80 -0
- package/src/__tests__/__snapshots__/AnchoredOverlay.tsx.snap +332 -0
- package/src/__tests__/__snapshots__/Avatar.tsx.snap +19 -0
- package/src/__tests__/__snapshots__/AvatarStack.tsx.snap +377 -0
- package/src/__tests__/__snapshots__/BorderBox.tsx.snap +14 -0
- package/src/__tests__/__snapshots__/Box.tsx.snap +201 -0
- package/src/__tests__/__snapshots__/BranchName.tsx.snap +17 -0
- package/src/__tests__/__snapshots__/Breadcrumbs.tsx.snap +29 -0
- package/src/__tests__/__snapshots__/BreadcrumbsItem.tsx.snap +79 -0
- package/src/__tests__/__snapshots__/Button.tsx.snap +832 -0
- package/src/__tests__/__snapshots__/Caret.tsx.snap +373 -0
- package/src/__tests__/__snapshots__/CircleBadge.tsx.snap +141 -0
- package/src/__tests__/__snapshots__/CircleOcticon.tsx.snap +64 -0
- package/src/__tests__/__snapshots__/CounterLabel.tsx.snap +22 -0
- package/src/__tests__/__snapshots__/Details.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/Dialog.tsx.snap +200 -0
- package/src/__tests__/__snapshots__/Dropdown.tsx.snap +249 -0
- package/src/__tests__/__snapshots__/DropdownMenu.tsx.snap +106 -0
- package/src/__tests__/__snapshots__/FilterList.tsx.snap +13 -0
- package/src/__tests__/__snapshots__/FilterListItem.tsx.snap +80 -0
- package/src/__tests__/__snapshots__/FilteredSearch.tsx.snap +32 -0
- package/src/__tests__/__snapshots__/Flash.tsx.snap +32 -0
- package/src/__tests__/__snapshots__/Flex.tsx.snap +130 -0
- package/src/__tests__/__snapshots__/FormGroup.tsx.snap +25 -0
- package/src/__tests__/__snapshots__/Grid.tsx.snap +178 -0
- package/src/__tests__/__snapshots__/Header.tsx.snap +79 -0
- package/src/__tests__/__snapshots__/Heading.tsx.snap +13 -0
- package/src/__tests__/__snapshots__/Label.tsx.snap +74 -0
- package/src/__tests__/__snapshots__/LabelGroup.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/Link.tsx.snap +213 -0
- package/src/__tests__/__snapshots__/Pagehead.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/PointerBox.tsx.snap +174 -0
- package/src/__tests__/__snapshots__/Popover.tsx.snap +4687 -0
- package/src/__tests__/__snapshots__/Position.tsx.snap +44 -0
- package/src/__tests__/__snapshots__/ProgressBar.tsx.snap +53 -0
- package/src/__tests__/__snapshots__/SelectMenu.tsx.snap +469 -0
- package/src/__tests__/__snapshots__/SelectPanel.tsx.snap +123 -0
- package/src/__tests__/__snapshots__/SideNav.tsx.snap +143 -0
- package/src/__tests__/__snapshots__/Spinner.tsx.snap +33 -0
- package/src/__tests__/__snapshots__/StateLabel.tsx.snap +409 -0
- package/src/__tests__/__snapshots__/StyledOcticon.tsx.snap +25 -0
- package/src/__tests__/__snapshots__/SubNav.tsx.snap +44 -0
- package/src/__tests__/__snapshots__/SubNavLink.tsx.snap +199 -0
- package/src/__tests__/__snapshots__/TabNav.tsx.snap +58 -0
- package/src/__tests__/__snapshots__/Text.tsx.snap +7 -0
- package/src/__tests__/__snapshots__/TextInput.tsx.snap +440 -0
- package/src/__tests__/__snapshots__/ThemeProvider.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/Timeline.tsx.snap +159 -0
- package/src/__tests__/__snapshots__/Tooltip.tsx.snap +227 -0
- package/src/__tests__/__snapshots__/Truncate.tsx.snap +17 -0
- package/src/__tests__/__snapshots__/UnderlineNav.tsx.snap +59 -0
- package/src/__tests__/__snapshots__/UnderlineNavLink.tsx.snap +130 -0
- package/src/__tests__/behaviors/anchoredPosition.ts +295 -0
- package/src/__tests__/behaviors/focusTrap.tsx +236 -0
- package/src/__tests__/behaviors/focusZone.tsx +549 -0
- package/src/__tests__/behaviors/iterateFocusableElements.tsx +61 -0
- package/src/__tests__/filterObject.ts +54 -0
- package/src/__tests__/hooks/useAnchoredPosition.tsx +31 -0
- package/src/__tests__/hooks/useOnEscapePress.tsx +16 -0
- package/src/__tests__/hooks/useOnOutsideClick.tsx +48 -0
- package/src/__tests__/hooks/useOpenAndCloseFocus.tsx +48 -0
- package/src/__tests__/hooks/useProvidedStateOrCreate.tsx +39 -0
- package/src/__tests__/theme.ts +41 -0
- package/src/__tests__/themeGet.ts +15 -0
- package/src/__tests__/useSafeTimeout.tsx +36 -0
- package/src/behaviors/anchoredPosition.ts +442 -0
- package/src/behaviors/focusTrap.ts +184 -0
- package/src/behaviors/focusZone.ts +713 -0
- package/src/constants.ts +62 -0
- package/src/hooks/index.ts +11 -0
- package/src/hooks/useAnchoredPosition.ts +53 -0
- package/src/hooks/useCombinedRefs.ts +40 -0
- package/src/hooks/useDetails.tsx +54 -0
- package/src/hooks/useDialog.ts +121 -0
- package/src/hooks/useFocusTrap.ts +80 -0
- package/src/hooks/useFocusZone.ts +64 -0
- package/src/hooks/useOnEscapePress.ts +63 -0
- package/src/hooks/useOnOutsideClick.tsx +82 -0
- package/src/hooks/useOpenAndCloseFocus.ts +27 -0
- package/src/hooks/useOverlay.tsx +32 -0
- package/src/hooks/useProvidedRefOrCreate.ts +14 -0
- package/src/hooks/useProvidedStateOrCreate.ts +27 -0
- package/src/hooks/useRenderForcingRef.ts +22 -0
- package/src/hooks/useResizeObserver.ts +11 -0
- package/src/hooks/useSafeTimeout.ts +38 -0
- package/src/hooks/useScrollFlash.ts +21 -0
- package/src/index.ts +165 -0
- package/src/polyfills/eventListenerSignal.ts +66 -0
- package/src/stories/ActionList.stories.tsx +364 -0
- package/src/stories/ActionMenu.stories.tsx +322 -0
- package/src/stories/AnchoredOverlay.stories.tsx +117 -0
- package/src/stories/AvatarStack.stories.tsx +37 -0
- package/src/stories/Button.stories.tsx +88 -0
- package/src/stories/ConfirmationDialog.stories.tsx +105 -0
- package/src/stories/Dialog.stories.tsx +240 -0
- package/src/stories/DropdownMenu.stories.tsx +84 -0
- package/src/stories/Overlay.stories.tsx +186 -0
- package/src/stories/Portal.stories.tsx +109 -0
- package/src/stories/SelectPanel.stories.tsx +300 -0
- package/src/stories/ThemeProvider.stories.tsx +104 -0
- package/src/stories/useAnchoredPosition.stories.tsx +320 -0
- package/src/stories/useFocusTrap.stories.tsx +400 -0
- package/src/stories/useFocusZone.stories.tsx +663 -0
- package/src/sx.ts +9 -0
- package/src/theme-preval.js +136 -0
- package/src/theme.ts +3 -0
- package/src/utils/deprecate.tsx +73 -0
- package/src/utils/isNumeric.tsx +4 -0
- package/src/utils/iterateFocusableElements.ts +121 -0
- package/src/utils/ssr.tsx +1 -0
- package/src/utils/test-deprecations.tsx +19 -0
- package/src/utils/test-helpers.tsx +7 -0
- package/src/utils/test-matchers.tsx +109 -0
- package/src/utils/testing.tsx +243 -0
- package/src/utils/theme.js +64 -0
- package/src/utils/types.ts +90 -0
- package/src/utils/uniqueId.ts +6 -0
- package/src/utils/userAgent.ts +7 -0
- package/stats.html +3279 -0
- package/tsconfig.build.json +7 -0
- package/tsconfig.json +20 -0
- package/lib/Breadcrumb.d.ts +0 -23
- package/lib-esm/Breadcrumb.d.ts +0 -23
@@ -0,0 +1,460 @@
|
|
1
|
+
import {CheckIcon, IconProps} from '@primer/octicons-react'
|
2
|
+
import React, {useCallback} from 'react'
|
3
|
+
import {get} from '../constants'
|
4
|
+
import sx, {SxProp} from '../sx'
|
5
|
+
import Truncate from '../Truncate'
|
6
|
+
import {ItemInput} from './List'
|
7
|
+
import styled from 'styled-components'
|
8
|
+
import {StyledHeader} from './Header'
|
9
|
+
import {StyledDivider} from './Divider'
|
10
|
+
import {useColorSchemeVar, useTheme} from '../ThemeProvider'
|
11
|
+
import {
|
12
|
+
activeDescendantActivatedDirectly,
|
13
|
+
activeDescendantActivatedIndirectly,
|
14
|
+
isActiveDescendantAttribute
|
15
|
+
} from '../behaviors/focusZone'
|
16
|
+
import {useSSRSafeId} from '@react-aria/ssr'
|
17
|
+
|
18
|
+
/**
|
19
|
+
* These colors are not yet in our default theme. Need to remove this once they are added.
|
20
|
+
*/
|
21
|
+
const customItemThemes = {
|
22
|
+
default: {
|
23
|
+
hover: {
|
24
|
+
light: 'rgba(46, 77, 108, 0.06)',
|
25
|
+
dark: 'rgba(201, 206, 212, 0.12)',
|
26
|
+
dark_dimmed: 'rgba(201, 206, 212, 0.12)'
|
27
|
+
},
|
28
|
+
focus: {
|
29
|
+
light: 'rgba(54, 77, 100, 0.16)',
|
30
|
+
dark: 'rgba(201, 206, 212, 0.24)',
|
31
|
+
dark_dimmed: 'rgba(201, 206, 212, 0.24)'
|
32
|
+
}
|
33
|
+
},
|
34
|
+
danger: {
|
35
|
+
hover: {
|
36
|
+
light: 'rgba(234, 74, 90, 0.08)',
|
37
|
+
dark: 'rgba(248, 81, 73, 0.16)',
|
38
|
+
dark_dimmed: 'rgba(248, 81, 73, 0.16)'
|
39
|
+
},
|
40
|
+
focus: {
|
41
|
+
light: 'rgba(234, 74, 90, 0.14)',
|
42
|
+
dark: 'rgba(248, 81, 73, 0.24)',
|
43
|
+
dark_dimmed: 'rgba(248, 81, 73, 0.24)'
|
44
|
+
}
|
45
|
+
}
|
46
|
+
} as const
|
47
|
+
|
48
|
+
/**
|
49
|
+
* Contract for props passed to the `Item` component.
|
50
|
+
*/
|
51
|
+
export interface ItemProps extends Omit<React.ComponentPropsWithoutRef<'div'>, 'id'>, SxProp {
|
52
|
+
/**
|
53
|
+
* Primary text which names an `Item`.
|
54
|
+
*/
|
55
|
+
text?: string
|
56
|
+
|
57
|
+
/**
|
58
|
+
* Secondary text which provides additional information about an `Item`.
|
59
|
+
*/
|
60
|
+
description?: string
|
61
|
+
|
62
|
+
/**
|
63
|
+
* Secondary text style variations. Usage is discretionary.
|
64
|
+
*
|
65
|
+
* - `"inline"` - Secondary text is positioned beside primary text.
|
66
|
+
* - `"block"` - Secondary text is positioned below primary text.
|
67
|
+
*/
|
68
|
+
descriptionVariant?: 'inline' | 'block'
|
69
|
+
|
70
|
+
/**
|
71
|
+
* Icon (or similar) positioned before `Item` text.
|
72
|
+
*/
|
73
|
+
leadingVisual?: React.FunctionComponent<IconProps>
|
74
|
+
|
75
|
+
/**
|
76
|
+
* Icon (or similar) positioned after `Item` text.
|
77
|
+
*/
|
78
|
+
trailingIcon?: React.FunctionComponent<IconProps>
|
79
|
+
|
80
|
+
/**
|
81
|
+
* Text positioned after `Item` text and optional trailing icon.
|
82
|
+
*/
|
83
|
+
trailingText?: string
|
84
|
+
|
85
|
+
/**
|
86
|
+
* Style variations associated with various `Item` types.
|
87
|
+
*
|
88
|
+
* - `"default"` - An action `Item`.
|
89
|
+
* - `"danger"` - A destructive action `Item`.
|
90
|
+
*/
|
91
|
+
variant?: 'default' | 'danger'
|
92
|
+
|
93
|
+
/**
|
94
|
+
* Whether to display a divider above the `Item` when it does not follow a `Header` or `Divider`.
|
95
|
+
*/
|
96
|
+
showDivider?: boolean
|
97
|
+
|
98
|
+
/**
|
99
|
+
* For `Item`s which can be selected, whether the `Item` is currently selected.
|
100
|
+
*/
|
101
|
+
selected?: boolean
|
102
|
+
|
103
|
+
/**
|
104
|
+
* For `Item`s which can be selected, whether `multiple` `Item`s or a `single` `Item` can be selected
|
105
|
+
*/
|
106
|
+
selectionVariant?: 'single' | 'multiple'
|
107
|
+
|
108
|
+
/**
|
109
|
+
* Designates the group that an item belongs to.
|
110
|
+
*/
|
111
|
+
groupId?: string
|
112
|
+
|
113
|
+
/**
|
114
|
+
* Items that are disabled can not be clicked, selected, or navigated through.
|
115
|
+
*/
|
116
|
+
disabled?: boolean
|
117
|
+
|
118
|
+
/**
|
119
|
+
* Callback that will trigger both on click selection and keyboard selection.
|
120
|
+
*/
|
121
|
+
onAction?: (item: ItemProps, event: React.MouseEvent<HTMLDivElement> | React.KeyboardEvent<HTMLDivElement>) => void
|
122
|
+
|
123
|
+
/**
|
124
|
+
* An id associated with this item. Should be unique between items
|
125
|
+
*/
|
126
|
+
id?: number | string
|
127
|
+
}
|
128
|
+
|
129
|
+
const getItemVariant = (variant = 'default', disabled?: boolean) => {
|
130
|
+
if (disabled) {
|
131
|
+
return {
|
132
|
+
color: get('colors.fg.muted'),
|
133
|
+
iconColor: get('colors.fg.muted'),
|
134
|
+
annotationColor: get('colors.fg.muted'),
|
135
|
+
hoverCursor: 'default'
|
136
|
+
}
|
137
|
+
}
|
138
|
+
|
139
|
+
switch (variant) {
|
140
|
+
case 'danger':
|
141
|
+
return {
|
142
|
+
color: get('colors.danger.fg'),
|
143
|
+
iconColor: get('colors.danger.fg'),
|
144
|
+
annotationColor: get('colors.fg.muted'),
|
145
|
+
hoverCursor: 'pointer'
|
146
|
+
}
|
147
|
+
default:
|
148
|
+
return {
|
149
|
+
color: 'inherit',
|
150
|
+
iconColor: get('colors.fg.muted'),
|
151
|
+
annotationColor: get('colors.fg.muted'),
|
152
|
+
hoverCursor: 'pointer'
|
153
|
+
}
|
154
|
+
}
|
155
|
+
}
|
156
|
+
|
157
|
+
const DividedContent = styled.div`
|
158
|
+
display: flex;
|
159
|
+
min-width: 0;
|
160
|
+
|
161
|
+
/* Required for dividers */
|
162
|
+
position: relative;
|
163
|
+
flex-grow: 1;
|
164
|
+
`
|
165
|
+
|
166
|
+
const MainContent = styled.div`
|
167
|
+
align-items: baseline;
|
168
|
+
display: flex;
|
169
|
+
min-width: 0;
|
170
|
+
flex-direction: var(--main-content-flex-direction);
|
171
|
+
flex-grow: 1;
|
172
|
+
`
|
173
|
+
|
174
|
+
const StyledItem = styled.div<
|
175
|
+
{
|
176
|
+
variant: ItemProps['variant']
|
177
|
+
showDivider: ItemProps['showDivider']
|
178
|
+
item?: ItemInput
|
179
|
+
hoverBackground: string
|
180
|
+
focusBackground: string
|
181
|
+
} & SxProp
|
182
|
+
>`
|
183
|
+
/* 6px vertical padding + 20px line height = 32px total height
|
184
|
+
*
|
185
|
+
* TODO: When rem-based spacing on a 4px scale lands, replace
|
186
|
+
* hardcoded '6px' with 'calc((${get('space.s32')} - ${get('space.20')}) / 2)'.
|
187
|
+
*/
|
188
|
+
padding: 6px ${get('space.2')};
|
189
|
+
display: flex;
|
190
|
+
border-radius: ${get('radii.2')};
|
191
|
+
color: ${({variant, item}) => getItemVariant(variant, item?.disabled).color};
|
192
|
+
// 2 frames on a 60hz monitor
|
193
|
+
transition: background 33.333ms linear;
|
194
|
+
|
195
|
+
@media (hover: hover) and (pointer: fine) {
|
196
|
+
:hover {
|
197
|
+
// allow override in case another item in the list is active/focused
|
198
|
+
background: var(--item-hover-bg-override, ${({hoverBackground}) => hoverBackground});
|
199
|
+
cursor: ${({variant, item}) => getItemVariant(variant, item?.disabled).hoverCursor};
|
200
|
+
}
|
201
|
+
}
|
202
|
+
|
203
|
+
// Item dividers
|
204
|
+
:not(:first-of-type):not(${StyledDivider} + &):not(${StyledHeader} + &) {
|
205
|
+
margin-top: ${({showDivider}) => (showDivider ? `1px` : '0')};
|
206
|
+
|
207
|
+
${DividedContent}::before {
|
208
|
+
content: ' ';
|
209
|
+
display: block;
|
210
|
+
position: absolute;
|
211
|
+
width: 100%;
|
212
|
+
top: -7px;
|
213
|
+
// NB: This 'get' won’t execute if it’s moved into the arrow function below.
|
214
|
+
border: 0 solid ${get('colors.border.muted')};
|
215
|
+
border-top-width: ${({showDivider}) => (showDivider ? `1px` : '0')};
|
216
|
+
}
|
217
|
+
}
|
218
|
+
|
219
|
+
// Item dividers should not be visible:
|
220
|
+
// - above Hovered
|
221
|
+
&:hover ${DividedContent}::before,
|
222
|
+
// - below Hovered
|
223
|
+
// '*' instead of '&' because '&' maps to separate class names depending on 'variant'
|
224
|
+
:hover + * ${DividedContent}::before {
|
225
|
+
// allow override in case another item in the list is active/focused
|
226
|
+
border-color: var(--item-hover-divider-border-color-override, transparent) !important;
|
227
|
+
}
|
228
|
+
|
229
|
+
// - above Focused
|
230
|
+
&:focus ${DividedContent}::before,
|
231
|
+
// - below Focused
|
232
|
+
// '*' instead of '&' because '&' maps to separate class names depending on 'variant'
|
233
|
+
:focus + * ${DividedContent}::before,
|
234
|
+
// - above Active Descendent
|
235
|
+
&[${isActiveDescendantAttribute}] ${DividedContent}::before,
|
236
|
+
// - below Active Descendent
|
237
|
+
[${isActiveDescendantAttribute}] + & ${DividedContent}::before {
|
238
|
+
// '!important' because all the ':not's above give higher specificity
|
239
|
+
border-color: transparent !important;
|
240
|
+
}
|
241
|
+
|
242
|
+
// Active Descendant
|
243
|
+
&[${isActiveDescendantAttribute}='${activeDescendantActivatedDirectly}'] {
|
244
|
+
background: ${({focusBackground}) => focusBackground};
|
245
|
+
}
|
246
|
+
&[${isActiveDescendantAttribute}='${activeDescendantActivatedIndirectly}'] {
|
247
|
+
background: ${({hoverBackground}) => hoverBackground};
|
248
|
+
}
|
249
|
+
|
250
|
+
&:focus {
|
251
|
+
background: ${({focusBackground}) => focusBackground};
|
252
|
+
outline: none;
|
253
|
+
}
|
254
|
+
|
255
|
+
&:active {
|
256
|
+
background: ${({focusBackground}) => focusBackground};
|
257
|
+
}
|
258
|
+
|
259
|
+
${sx}
|
260
|
+
`
|
261
|
+
|
262
|
+
export const TextContainer = styled.span<{
|
263
|
+
dangerouslySetInnerHtml?: React.DOMAttributes<HTMLDivElement>['dangerouslySetInnerHTML']
|
264
|
+
}>``
|
265
|
+
|
266
|
+
const BaseVisualContainer = styled.div<{variant?: ItemProps['variant']; disabled?: boolean}>`
|
267
|
+
// Match visual height to adjacent text line height.
|
268
|
+
// TODO: When rem-based spacing on a 4px scale lands, replace
|
269
|
+
// hardcoded '20px' with '${get('space.s20')}'.
|
270
|
+
height: 20px;
|
271
|
+
width: ${get('space.3')};
|
272
|
+
margin-right: ${get('space.2')};
|
273
|
+
`
|
274
|
+
|
275
|
+
const ColoredVisualContainer = styled(BaseVisualContainer)`
|
276
|
+
svg {
|
277
|
+
fill: ${({variant, disabled}) => getItemVariant(variant, disabled).iconColor};
|
278
|
+
font-size: ${get('fontSizes.0')};
|
279
|
+
}
|
280
|
+
`
|
281
|
+
|
282
|
+
const LeadingVisualContainer = styled(ColoredVisualContainer)`
|
283
|
+
flex-shrink: 0;
|
284
|
+
display: flex;
|
285
|
+
flex-direction: column;
|
286
|
+
justify-content: center;
|
287
|
+
`
|
288
|
+
|
289
|
+
const TrailingContent = styled(ColoredVisualContainer)`
|
290
|
+
color: ${({variant, disabled}) => getItemVariant(variant, disabled).annotationColor}};
|
291
|
+
margin-left: ${get('space.2')};
|
292
|
+
margin-right: 0;
|
293
|
+
width: auto;
|
294
|
+
div:nth-child(2) {
|
295
|
+
margin-left: ${get('space.2')};
|
296
|
+
}
|
297
|
+
`
|
298
|
+
|
299
|
+
const DescriptionContainer = styled.span`
|
300
|
+
color: ${get('colors.fg.muted')};
|
301
|
+
font-size: ${get('fontSizes.0')};
|
302
|
+
// TODO: When rem-based spacing on a 4px scale lands, replace
|
303
|
+
// hardcoded '16px' with '${get('lh-12')}'.
|
304
|
+
line-height: 16px;
|
305
|
+
margin-left: var(--description-container-margin-left);
|
306
|
+
min-width: 0;
|
307
|
+
flex-grow: 1;
|
308
|
+
flex-basis: var(--description-container-flex-basis);
|
309
|
+
`
|
310
|
+
|
311
|
+
const MultiSelectInput = styled.input`
|
312
|
+
pointer-events: none;
|
313
|
+
`
|
314
|
+
|
315
|
+
/**
|
316
|
+
* An actionable or selectable `Item` with an optional icon and description.
|
317
|
+
*/
|
318
|
+
export function Item(itemProps: Partial<ItemProps> & {item?: ItemInput}): JSX.Element {
|
319
|
+
const {
|
320
|
+
text,
|
321
|
+
description,
|
322
|
+
descriptionVariant = 'inline',
|
323
|
+
selected,
|
324
|
+
selectionVariant,
|
325
|
+
leadingVisual: LeadingVisual,
|
326
|
+
trailingIcon: TrailingIcon,
|
327
|
+
trailingText,
|
328
|
+
variant = 'default',
|
329
|
+
showDivider,
|
330
|
+
disabled,
|
331
|
+
onAction,
|
332
|
+
onKeyPress,
|
333
|
+
children,
|
334
|
+
onClick,
|
335
|
+
id,
|
336
|
+
...props
|
337
|
+
} = itemProps
|
338
|
+
|
339
|
+
const labelId = useSSRSafeId()
|
340
|
+
const descriptionId = useSSRSafeId()
|
341
|
+
|
342
|
+
const keyPressHandler = useCallback(
|
343
|
+
event => {
|
344
|
+
if (disabled) {
|
345
|
+
return
|
346
|
+
}
|
347
|
+
onKeyPress?.(event)
|
348
|
+
const isCheckbox = event.target instanceof HTMLInputElement && event.target.type === 'checkbox'
|
349
|
+
if (isCheckbox && event.key === ' ') {
|
350
|
+
// space key on a checkbox will also trigger a click event. Ignore the space key so we don't get double events
|
351
|
+
return
|
352
|
+
}
|
353
|
+
|
354
|
+
if (!event.defaultPrevented && [' ', 'Enter'].includes(event.key)) {
|
355
|
+
onAction?.(itemProps as ItemProps, event)
|
356
|
+
}
|
357
|
+
},
|
358
|
+
[onAction, disabled, itemProps, onKeyPress]
|
359
|
+
)
|
360
|
+
|
361
|
+
const clickHandler = useCallback(
|
362
|
+
event => {
|
363
|
+
if (disabled) {
|
364
|
+
return
|
365
|
+
}
|
366
|
+
onClick?.(event)
|
367
|
+
if (!event.defaultPrevented) {
|
368
|
+
onAction?.(itemProps as ItemProps, event)
|
369
|
+
}
|
370
|
+
},
|
371
|
+
[onAction, disabled, itemProps, onClick]
|
372
|
+
)
|
373
|
+
|
374
|
+
const customItemTheme = customItemThemes[variant]
|
375
|
+
const hoverBackground = useColorSchemeVar(customItemTheme.hover, 'inherit')
|
376
|
+
const focusBackground = useColorSchemeVar(customItemTheme.focus, 'inherit')
|
377
|
+
|
378
|
+
const {theme} = useTheme()
|
379
|
+
|
380
|
+
return (
|
381
|
+
<StyledItem
|
382
|
+
tabIndex={disabled ? undefined : -1}
|
383
|
+
variant={variant}
|
384
|
+
showDivider={showDivider}
|
385
|
+
aria-selected={selected}
|
386
|
+
aria-labelledby={text ? labelId : undefined}
|
387
|
+
aria-describedby={description ? descriptionId : undefined}
|
388
|
+
{...props}
|
389
|
+
data-id={id}
|
390
|
+
onKeyPress={keyPressHandler}
|
391
|
+
onClick={clickHandler}
|
392
|
+
hoverBackground={disabled ? 'inherit' : hoverBackground}
|
393
|
+
focusBackground={disabled ? 'inherit' : focusBackground}
|
394
|
+
>
|
395
|
+
{!!selected === selected && (
|
396
|
+
<BaseVisualContainer>
|
397
|
+
{selectionVariant === 'multiple' ? (
|
398
|
+
<>
|
399
|
+
{/*
|
400
|
+
* readOnly is required because we are doing a one-way bind to `checked`.
|
401
|
+
* aria-readonly="false" tells screen that they can still interact with the checkbox
|
402
|
+
*/}
|
403
|
+
<MultiSelectInput
|
404
|
+
disabled={disabled}
|
405
|
+
tabIndex={-1}
|
406
|
+
type="checkbox"
|
407
|
+
checked={selected}
|
408
|
+
aria-label={text}
|
409
|
+
readOnly
|
410
|
+
aria-readonly="false"
|
411
|
+
/>
|
412
|
+
</>
|
413
|
+
) : (
|
414
|
+
selected && <CheckIcon fill={theme?.colors.text.primary} />
|
415
|
+
)}
|
416
|
+
</BaseVisualContainer>
|
417
|
+
)}
|
418
|
+
{LeadingVisual && (
|
419
|
+
<LeadingVisualContainer variant={variant} disabled={disabled}>
|
420
|
+
<LeadingVisual />
|
421
|
+
</LeadingVisualContainer>
|
422
|
+
)}
|
423
|
+
<DividedContent>
|
424
|
+
<MainContent
|
425
|
+
style={
|
426
|
+
{'--main-content-flex-direction': descriptionVariant === 'inline' ? 'row' : 'column'} as React.CSSProperties
|
427
|
+
}
|
428
|
+
>
|
429
|
+
{children}
|
430
|
+
{text ? <TextContainer id={labelId}>{text}</TextContainer> : null}
|
431
|
+
{description ? (
|
432
|
+
<DescriptionContainer
|
433
|
+
id={descriptionId}
|
434
|
+
style={
|
435
|
+
{
|
436
|
+
'--description-container-margin-left': descriptionVariant === 'inline' ? get('space.2')(theme) : 0,
|
437
|
+
'--description-container-flex-basis': descriptionVariant === 'inline' ? 0 : 'auto'
|
438
|
+
} as React.CSSProperties
|
439
|
+
}
|
440
|
+
>
|
441
|
+
{descriptionVariant === 'block' ? (
|
442
|
+
description
|
443
|
+
) : (
|
444
|
+
<Truncate title={description} inline={true} maxWidth="100%">
|
445
|
+
{description}
|
446
|
+
</Truncate>
|
447
|
+
)}
|
448
|
+
</DescriptionContainer>
|
449
|
+
) : null}
|
450
|
+
</MainContent>
|
451
|
+
{TrailingIcon || trailingText ? (
|
452
|
+
<TrailingContent variant={variant} disabled={disabled}>
|
453
|
+
{trailingText}
|
454
|
+
{TrailingIcon && <TrailingIcon />}
|
455
|
+
</TrailingContent>
|
456
|
+
) : null}
|
457
|
+
</DividedContent>
|
458
|
+
</StyledItem>
|
459
|
+
)
|
460
|
+
}
|
@@ -0,0 +1,253 @@
|
|
1
|
+
import React from 'react'
|
2
|
+
import type {AriaRole} from '../utils/types'
|
3
|
+
import {Group, GroupProps} from './Group'
|
4
|
+
import {Item, ItemProps} from './Item'
|
5
|
+
import {Divider} from './Divider'
|
6
|
+
import styled from 'styled-components'
|
7
|
+
import {get} from '../constants'
|
8
|
+
import {SystemCssProperties} from '@styled-system/css'
|
9
|
+
import {hasActiveDescendantAttribute} from '../behaviors/focusZone'
|
10
|
+
|
11
|
+
export type ItemInput = ItemProps | (Partial<ItemProps> & {renderItem: typeof Item})
|
12
|
+
|
13
|
+
/**
|
14
|
+
* Contract for props passed to the `List` component.
|
15
|
+
*/
|
16
|
+
export interface ListPropsBase {
|
17
|
+
/**
|
18
|
+
* A collection of `Item` props and `Item`-level custom `Item` renderers.
|
19
|
+
*/
|
20
|
+
items: ItemInput[]
|
21
|
+
|
22
|
+
/**
|
23
|
+
* The ARIA role describing the function of `List` component. `listbox` is a common value.
|
24
|
+
*/
|
25
|
+
role?: AriaRole
|
26
|
+
|
27
|
+
/**
|
28
|
+
* id to attach to the base DOM node of the list
|
29
|
+
*/
|
30
|
+
id?: string
|
31
|
+
|
32
|
+
/**
|
33
|
+
* A `List`-level custom `Item` renderer. Every `Item` within this `List`
|
34
|
+
* without a `Group`-level or `Item`-level custom `Item` renderer will be
|
35
|
+
* rendered using this function component.
|
36
|
+
*/
|
37
|
+
renderItem?: typeof Item
|
38
|
+
|
39
|
+
/**
|
40
|
+
* A `List`-level custom `Group` renderer. Every `Group` within this `List`
|
41
|
+
* without a `Group`-level custom `Item` renderer will be rendered using
|
42
|
+
* this function component.
|
43
|
+
*/
|
44
|
+
renderGroup?: typeof Group
|
45
|
+
|
46
|
+
/**
|
47
|
+
* Style variations. Usage is discretionary.
|
48
|
+
*
|
49
|
+
* - `"inset"` - `List` children are offset (vertically and horizontally) from `List`’s edges
|
50
|
+
* - `"full"` - `List` children are flush (vertically and horizontally) with `List` edges
|
51
|
+
*/
|
52
|
+
variant?: 'inset' | 'full'
|
53
|
+
|
54
|
+
/**
|
55
|
+
* For `Item`s which can be selected, whether `multiple` `Item`s or a `single` `Item` can be selected
|
56
|
+
*/
|
57
|
+
selectionVariant?: 'single' | 'multiple'
|
58
|
+
|
59
|
+
/**
|
60
|
+
* Whether to display a divider above each `Item` in this `List` when it does not follow a `Header` or `Divider`.
|
61
|
+
*/
|
62
|
+
showItemDividers?: boolean
|
63
|
+
}
|
64
|
+
|
65
|
+
/**
|
66
|
+
* Contract for props passed to the `List` component, when its `Item`s are collected in `Group`s.
|
67
|
+
*/
|
68
|
+
export interface GroupedListProps extends ListPropsBase {
|
69
|
+
/**
|
70
|
+
* A collection of `Group` props (except `items`), plus a unique group identifier
|
71
|
+
* and `Group`-level custom `Item` or `Group` renderers.
|
72
|
+
*/
|
73
|
+
groupMetadata: ((
|
74
|
+
| Omit<GroupProps, 'items'>
|
75
|
+
| Omit<Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group}, 'items'>
|
76
|
+
) & {groupId: string})[]
|
77
|
+
|
78
|
+
/**
|
79
|
+
* A collection of `Item` props, plus associated group identifiers
|
80
|
+
* and `Item`-level custom `Item` renderers.
|
81
|
+
*/
|
82
|
+
items: ((ItemProps | (Partial<ItemProps> & {renderItem: typeof Item})) & {groupId: string})[]
|
83
|
+
}
|
84
|
+
|
85
|
+
/**
|
86
|
+
* Asserts that the given value fulfills the `GroupedListProps` contract.
|
87
|
+
* @param props A value which fulfills either the `ListPropsBase` or the `GroupedListProps` contract.
|
88
|
+
*/
|
89
|
+
function isGroupedListProps(props: ListProps): props is GroupedListProps {
|
90
|
+
return 'groupMetadata' in props
|
91
|
+
}
|
92
|
+
|
93
|
+
/**
|
94
|
+
* Contract for props passed to the `List` component.
|
95
|
+
*/
|
96
|
+
export type ListProps = ListPropsBase | GroupedListProps
|
97
|
+
|
98
|
+
const StyledList = styled.div`
|
99
|
+
font-size: ${get('fontSizes.1')};
|
100
|
+
/* 14px font-size * 1.428571429 = 20px line height
|
101
|
+
*
|
102
|
+
* TODO: When rem-based spacing on a 4px scale lands, replace
|
103
|
+
* hardcoded '20px'
|
104
|
+
*/
|
105
|
+
line-height: 20px;
|
106
|
+
|
107
|
+
&[${hasActiveDescendantAttribute}], &:focus-within {
|
108
|
+
--item-hover-bg-override: none;
|
109
|
+
--item-hover-divider-border-color-override: ${get('colors.border.muted')};
|
110
|
+
}
|
111
|
+
`
|
112
|
+
|
113
|
+
/**
|
114
|
+
* Returns `sx` prop values for `List` children matching the given `List` style variation.
|
115
|
+
* @param variant `List` style variation.
|
116
|
+
*/
|
117
|
+
function useListVariant(variant: ListProps['variant'] = 'inset'): {
|
118
|
+
firstGroupStyle?: SystemCssProperties
|
119
|
+
lastGroupStyle?: SystemCssProperties
|
120
|
+
headerStyle?: SystemCssProperties
|
121
|
+
itemStyle?: SystemCssProperties
|
122
|
+
} {
|
123
|
+
switch (variant) {
|
124
|
+
case 'full':
|
125
|
+
return {
|
126
|
+
headerStyle: {paddingX: get('space.2')},
|
127
|
+
itemStyle: {borderRadius: 0}
|
128
|
+
}
|
129
|
+
default:
|
130
|
+
return {
|
131
|
+
firstGroupStyle: {marginTop: get('space.2')},
|
132
|
+
lastGroupStyle: {marginBottom: get('space.2')},
|
133
|
+
itemStyle: {marginX: get('space.2')}
|
134
|
+
}
|
135
|
+
}
|
136
|
+
}
|
137
|
+
|
138
|
+
/**
|
139
|
+
* Lists `Item`s, either grouped or ungrouped, with a `Divider` between each `Group`.
|
140
|
+
*/
|
141
|
+
export const List = React.forwardRef<HTMLDivElement, ListProps>((props, forwardedRef): JSX.Element => {
|
142
|
+
// Get `sx` prop values for `List` children matching the given `List` style variation.
|
143
|
+
const {firstGroupStyle, lastGroupStyle, headerStyle, itemStyle} = useListVariant(props.variant)
|
144
|
+
|
145
|
+
/**
|
146
|
+
* Render a `Group` using the first of the following renderers that is defined:
|
147
|
+
* A `Group`-level or `List`-level custom `Group` renderer, or
|
148
|
+
* the default `Group` renderer.
|
149
|
+
*/
|
150
|
+
const renderGroup = (
|
151
|
+
groupProps: GroupProps | (Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group})
|
152
|
+
) => {
|
153
|
+
const GroupComponent = (('renderGroup' in groupProps && groupProps.renderGroup) ?? props.renderGroup) || Group
|
154
|
+
return <GroupComponent {...groupProps} key={groupProps.groupId} />
|
155
|
+
}
|
156
|
+
|
157
|
+
/**
|
158
|
+
* Render an `Item` using the first of the following renderers that is defined:
|
159
|
+
* An `Item`-level, `Group`-level, or `List`-level custom `Item` renderer,
|
160
|
+
* or the default `Item` renderer.
|
161
|
+
*/
|
162
|
+
const renderItem = (itemProps: ItemInput, item: ItemInput, itemIndex: number) => {
|
163
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
164
|
+
const ItemComponent = ('renderItem' in itemProps && itemProps.renderItem) || props.renderItem || Item
|
165
|
+
const key = itemProps.key ?? itemProps.id?.toString() ?? itemIndex.toString()
|
166
|
+
return (
|
167
|
+
<ItemComponent
|
168
|
+
showDivider={props.showItemDividers}
|
169
|
+
selectionVariant={props.selectionVariant}
|
170
|
+
{...itemProps}
|
171
|
+
key={key}
|
172
|
+
sx={{...itemStyle, ...itemProps.sx}}
|
173
|
+
item={item}
|
174
|
+
/>
|
175
|
+
)
|
176
|
+
}
|
177
|
+
|
178
|
+
/**
|
179
|
+
* An array of `Group`s, each with an associated `Header` and with an array of `Item`s belonging to that `Group`.
|
180
|
+
*/
|
181
|
+
let groups: (GroupProps | (Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group}))[] = []
|
182
|
+
|
183
|
+
// Collect rendered `Item`s into `Group`s, avoiding excess iteration over the lists of `items` and `groupMetadata`:
|
184
|
+
if (!isGroupedListProps(props)) {
|
185
|
+
// When no `groupMetadata`s is provided, collect rendered `Item`s into a single anonymous `Group`.
|
186
|
+
groups = [{items: props.items.map((item, index) => renderItem(item, item, index)), groupId: '0'}]
|
187
|
+
} else {
|
188
|
+
// When `groupMetadata` is provided, collect rendered `Item`s into their associated `Group`s.
|
189
|
+
|
190
|
+
/**
|
191
|
+
* A map of group identifiers to `Group`s, each with an associated array of `Item`s belonging to that `Group`.
|
192
|
+
*/
|
193
|
+
const groupMap = props.groupMetadata.reduce(
|
194
|
+
(groupAccumulator, groupMetadata) => groupAccumulator.set(groupMetadata.groupId, groupMetadata),
|
195
|
+
new Map<string, GroupProps | (Partial<GroupProps> & {renderItem?: typeof Item; renderGroup?: typeof Group})>()
|
196
|
+
)
|
197
|
+
|
198
|
+
for (const itemProps of props.items) {
|
199
|
+
// Look up the group associated with the current item.
|
200
|
+
const group = groupMap.get(itemProps.groupId)
|
201
|
+
const itemIndex = group?.items?.length ?? 0
|
202
|
+
|
203
|
+
// Upsert the group to include the current item (rendered).
|
204
|
+
groupMap.set(itemProps.groupId, {
|
205
|
+
...group,
|
206
|
+
items: [
|
207
|
+
...(group?.items ?? []),
|
208
|
+
renderItem(
|
209
|
+
{
|
210
|
+
showDivider: group?.showItemDividers,
|
211
|
+
...(group && 'renderItem' in group && {renderItem: group.renderItem}),
|
212
|
+
...itemProps
|
213
|
+
},
|
214
|
+
itemProps,
|
215
|
+
itemIndex
|
216
|
+
)
|
217
|
+
]
|
218
|
+
})
|
219
|
+
}
|
220
|
+
|
221
|
+
groups = [...groupMap.values()]
|
222
|
+
}
|
223
|
+
|
224
|
+
return (
|
225
|
+
<StyledList {...props} ref={forwardedRef}>
|
226
|
+
{groups.map(({header, ...groupProps}, index) => {
|
227
|
+
const hasFilledHeader = header?.variant === 'filled'
|
228
|
+
const shouldShowDivider = index > 0 && !hasFilledHeader
|
229
|
+
return (
|
230
|
+
<React.Fragment key={groupProps.groupId}>
|
231
|
+
{shouldShowDivider ? <Divider key={`${groupProps.groupId}-divider`} /> : null}
|
232
|
+
{renderGroup({
|
233
|
+
sx: {
|
234
|
+
...(index === 0 && firstGroupStyle),
|
235
|
+
...(index === groups.length - 1 && lastGroupStyle),
|
236
|
+
...(index > 0 && !shouldShowDivider && {mt: 2})
|
237
|
+
},
|
238
|
+
...(header && {
|
239
|
+
header: {
|
240
|
+
...header,
|
241
|
+
sx: {...headerStyle, ...header.sx}
|
242
|
+
}
|
243
|
+
}),
|
244
|
+
...groupProps
|
245
|
+
})}
|
246
|
+
</React.Fragment>
|
247
|
+
)
|
248
|
+
})}
|
249
|
+
</StyledList>
|
250
|
+
)
|
251
|
+
})
|
252
|
+
|
253
|
+
List.displayName = 'ActionList'
|