@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,77 @@
|
|
1
|
+
import {Flash, Label} from '@primer/components'
|
2
|
+
import {H3} from '@primer/gatsby-theme-doctocat/src/components/heading'
|
3
|
+
import InlineCode from '@primer/gatsby-theme-doctocat/src/components/inline-code'
|
4
|
+
import Paragraph from '@primer/gatsby-theme-doctocat/src/components/paragraph'
|
5
|
+
import Table from '@primer/gatsby-theme-doctocat/src/components/table'
|
6
|
+
import {graphql, useStaticQuery} from 'gatsby'
|
7
|
+
import React from 'react'
|
8
|
+
|
9
|
+
/** Render prop documentation for the given component */
|
10
|
+
export function Props({of}) {
|
11
|
+
const data = useStaticQuery(graphql`
|
12
|
+
query {
|
13
|
+
allComponentMetadata {
|
14
|
+
nodes {
|
15
|
+
id
|
16
|
+
name
|
17
|
+
props {
|
18
|
+
description
|
19
|
+
defaultValue
|
20
|
+
name
|
21
|
+
required
|
22
|
+
type
|
23
|
+
}
|
24
|
+
}
|
25
|
+
}
|
26
|
+
}
|
27
|
+
`)
|
28
|
+
|
29
|
+
const displayName = of?.displayName || of?.name || ''
|
30
|
+
const component = data.allComponentMetadata.nodes.find(node => node.name === displayName)
|
31
|
+
|
32
|
+
if (!component) {
|
33
|
+
// eslint-disable-next-line no-console
|
34
|
+
console.error(`Could not find component ${displayName}`)
|
35
|
+
return (
|
36
|
+
<>
|
37
|
+
<H3>{displayName}</H3>
|
38
|
+
<Flash variant="danger">Component not found</Flash>
|
39
|
+
</>
|
40
|
+
)
|
41
|
+
}
|
42
|
+
|
43
|
+
return (
|
44
|
+
<>
|
45
|
+
<H3>{component.name}</H3>
|
46
|
+
{component.props.length > 0 ? (
|
47
|
+
<Table>
|
48
|
+
<thead>
|
49
|
+
<tr>
|
50
|
+
<th align="left">Prop</th>
|
51
|
+
<th align="left">Type</th>
|
52
|
+
<th align="left">Default</th>
|
53
|
+
<th align="left">Description</th>
|
54
|
+
</tr>
|
55
|
+
</thead>
|
56
|
+
<tbody>
|
57
|
+
{component.props.map(prop => (
|
58
|
+
<tr key={prop.name}>
|
59
|
+
<td style={{whiteSpace: 'nowrap'}}>
|
60
|
+
<InlineCode>{prop.name}</InlineCode>{' '}
|
61
|
+
{prop.required ? <Label style={{verticalAlign: 'text-top'}}>Required</Label> : null}
|
62
|
+
</td>
|
63
|
+
<td>
|
64
|
+
<InlineCode>{prop.type}</InlineCode>
|
65
|
+
</td>
|
66
|
+
<td>{prop.defaultValue ? <InlineCode>{prop.defaultValue}</InlineCode> : '–'}</td>
|
67
|
+
<td>{prop.description}</td>
|
68
|
+
</tr>
|
69
|
+
))}
|
70
|
+
</tbody>
|
71
|
+
</Table>
|
72
|
+
) : (
|
73
|
+
<Paragraph>No props</Paragraph>
|
74
|
+
)}
|
75
|
+
</>
|
76
|
+
)
|
77
|
+
}
|
package/jest.config.js
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
/* eslint-disable github/unescaped-html-literal */
|
2
|
+
module.exports = {
|
3
|
+
testEnvironment: 'jsdom',
|
4
|
+
cacheDirectory: '.test',
|
5
|
+
collectCoverage: true,
|
6
|
+
collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}', '!src/stories/**'],
|
7
|
+
setupFilesAfterEnv: [
|
8
|
+
'<rootDir>/src/utils/test-matchers.tsx',
|
9
|
+
'<rootDir>/src/utils/test-deprecations.tsx',
|
10
|
+
'<rootDir>/src/utils/test-helpers.tsx'
|
11
|
+
],
|
12
|
+
testRegex: '/(src|codemods)/__tests__/.*\\.[jt]sx?$'
|
13
|
+
}
|
@@ -0,0 +1,40 @@
|
|
1
|
+
import * as History from 'history';
|
2
|
+
import React from 'react';
|
3
|
+
import { SystemCommonProps, SystemFlexProps } from './constants';
|
4
|
+
import { SxProp } from './sx';
|
5
|
+
import { ComponentProps } from './utils/types';
|
6
|
+
declare const BreadcrumbsBase: import("styled-components").StyledComponent<"nav", any, SystemFlexProps & SystemCommonProps & SxProp, never>;
|
7
|
+
export declare type BreadcrumbsProps = ComponentProps<typeof BreadcrumbsBase>;
|
8
|
+
declare function Breadcrumbs({ className, children, theme, ...rest }: React.PropsWithChildren<BreadcrumbsProps>): JSX.Element;
|
9
|
+
declare namespace Breadcrumbs {
|
10
|
+
var displayName: string;
|
11
|
+
}
|
12
|
+
declare const BreadcrumbsItem: import("styled-components").StyledComponent<"a", any, {
|
13
|
+
to?: History.LocationDescriptor<unknown> | undefined;
|
14
|
+
selected?: boolean | undefined;
|
15
|
+
} & SystemCommonProps & SxProp, never>;
|
16
|
+
export declare type BreadcrumbsItemProps = ComponentProps<typeof BreadcrumbsItem>;
|
17
|
+
declare const _default: typeof Breadcrumbs & {
|
18
|
+
Item: import("styled-components").StyledComponent<"a", any, {
|
19
|
+
to?: History.LocationDescriptor<unknown> | undefined;
|
20
|
+
selected?: boolean | undefined;
|
21
|
+
} & SystemCommonProps & SxProp, never>;
|
22
|
+
};
|
23
|
+
export default _default;
|
24
|
+
/**
|
25
|
+
* @deprecated Use the `Breadcrumbs` component instead (i.e. `<Breadcrumb>` → `<Breadcrumbs>`)
|
26
|
+
*/
|
27
|
+
export declare const Breadcrumb: typeof Breadcrumbs & {
|
28
|
+
Item: import("styled-components").StyledComponent<"a", any, {
|
29
|
+
to?: History.LocationDescriptor<unknown> | undefined;
|
30
|
+
selected?: boolean | undefined;
|
31
|
+
} & SystemCommonProps & SxProp, never>;
|
32
|
+
};
|
33
|
+
/**
|
34
|
+
* @deprecated Use the `BreadcrumbsProps` type instead
|
35
|
+
*/
|
36
|
+
export declare type BreadcrumbProps = ComponentProps<typeof BreadcrumbsBase>;
|
37
|
+
/**
|
38
|
+
* @deprecated Use the `BreadcrumbsItemProps` type instead
|
39
|
+
*/
|
40
|
+
export declare type BreadcrumbItemProps = ComponentProps<typeof BreadcrumbsItem>;
|
@@ -3,7 +3,7 @@
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
4
4
|
value: true
|
5
5
|
});
|
6
|
-
exports.default = void 0;
|
6
|
+
exports.Breadcrumb = exports.default = void 0;
|
7
7
|
|
8
8
|
var _classnames = _interopRequireDefault(require("classnames"));
|
9
9
|
|
@@ -24,30 +24,28 @@ function _extends() { _extends = Object.assign || function (target) { for (var i
|
|
24
24
|
const SELECTED_CLASS = 'selected';
|
25
25
|
|
26
26
|
const Wrapper = _styledComponents.default.li.withConfig({
|
27
|
-
displayName: "
|
28
|
-
componentId: "
|
27
|
+
displayName: "Breadcrumbs__Wrapper",
|
28
|
+
componentId: "hwwoo0-0"
|
29
29
|
})(["display:inline-block;white-space:nowrap;list-style:none;&::after{padding-right:0.5em;padding-left:0.5em;color:", ";font-size:", ";content:'/';}&:first-child{margin-left:0;}&:last-child{&::after{content:none;}}"], (0, _constants.get)('colors.fg.muted'), (0, _constants.get)('fontSizes.1'));
|
30
30
|
|
31
|
-
const
|
32
|
-
displayName: "
|
33
|
-
componentId: "
|
31
|
+
const BreadcrumbsBase = _styledComponents.default.nav.withConfig({
|
32
|
+
displayName: "Breadcrumbs__BreadcrumbsBase",
|
33
|
+
componentId: "hwwoo0-1"
|
34
34
|
})(["display:flex;justify-content:space-between;", ";", ";", ";"], _constants.COMMON, _constants.FLEX, _sx.default);
|
35
35
|
|
36
|
-
function
|
36
|
+
function Breadcrumbs({
|
37
37
|
className,
|
38
38
|
children,
|
39
39
|
theme,
|
40
40
|
...rest
|
41
41
|
}) {
|
42
|
-
const classes = (0, _classnames.default)(className, 'Breadcrumb');
|
43
|
-
|
44
42
|
const wrappedChildren = _react.default.Children.map(children, child => /*#__PURE__*/_react.default.createElement(Wrapper, {
|
45
43
|
theme: theme
|
46
44
|
}, child));
|
47
45
|
|
48
|
-
return /*#__PURE__*/_react.default.createElement(
|
49
|
-
className:
|
50
|
-
"aria-label": "
|
46
|
+
return /*#__PURE__*/_react.default.createElement(BreadcrumbsBase, _extends({
|
47
|
+
className: className,
|
48
|
+
"aria-label": "Breadcrumbs",
|
51
49
|
theme: theme
|
52
50
|
}, rest), /*#__PURE__*/_react.default.createElement(_Box.default, {
|
53
51
|
as: "ol",
|
@@ -56,22 +54,34 @@ function Breadcrumb({
|
|
56
54
|
}, wrappedChildren));
|
57
55
|
}
|
58
56
|
|
59
|
-
|
57
|
+
Breadcrumbs.displayName = "Breadcrumbs";
|
60
58
|
|
61
|
-
const
|
59
|
+
const BreadcrumbsItem = _styledComponents.default.a.attrs(props => ({
|
62
60
|
activeClassName: typeof props.to === 'string' ? 'selected' : '',
|
63
61
|
className: (0, _classnames.default)(props.selected && SELECTED_CLASS, props.className),
|
64
62
|
'aria-current': props.selected ? 'page' : null
|
65
63
|
})).withConfig({
|
66
|
-
displayName: "
|
67
|
-
componentId: "
|
64
|
+
displayName: "Breadcrumbs__BreadcrumbsItem",
|
65
|
+
componentId: "hwwoo0-2"
|
68
66
|
})(["color:", ";display:inline-block;font-size:", ";text-decoration:none;&:hover{text-decoration:underline;}&.selected{color:", ";pointer-events:none;}", " ", ";"], (0, _constants.get)('colors.accent.fg'), (0, _constants.get)('fontSizes.1'), (0, _constants.get)('colors.fg.default'), _constants.COMMON, _sx.default);
|
69
67
|
|
70
|
-
|
71
|
-
|
68
|
+
Breadcrumbs.displayName = 'Breadcrumbs';
|
69
|
+
BreadcrumbsItem.displayName = 'Breadcrumbs.Item';
|
70
|
+
|
71
|
+
var _default = Object.assign(Breadcrumbs, {
|
72
|
+
Item: BreadcrumbsItem
|
73
|
+
});
|
74
|
+
/**
|
75
|
+
* @deprecated Use the `Breadcrumbs` component instead (i.e. `<Breadcrumb>` → `<Breadcrumbs>`)
|
76
|
+
*/
|
77
|
+
|
72
78
|
|
73
|
-
|
74
|
-
|
79
|
+
exports.default = _default;
|
80
|
+
const Breadcrumb = Object.assign(Breadcrumbs, {
|
81
|
+
Item: BreadcrumbsItem
|
75
82
|
});
|
83
|
+
/**
|
84
|
+
* @deprecated Use the `BreadcrumbsProps` type instead
|
85
|
+
*/
|
76
86
|
|
77
|
-
exports.
|
87
|
+
exports.Breadcrumb = Breadcrumb;
|
@@ -0,0 +1 @@
|
|
1
|
+
import 'babel-polyfill';
|
@@ -0,0 +1,67 @@
|
|
1
|
+
"use strict";
|
2
|
+
|
3
|
+
var _react = require("@testing-library/react");
|
4
|
+
|
5
|
+
require("babel-polyfill");
|
6
|
+
|
7
|
+
var _jestAxe = require("jest-axe");
|
8
|
+
|
9
|
+
var _react2 = _interopRequireDefault(require("react"));
|
10
|
+
|
11
|
+
var _theme = _interopRequireDefault(require("../theme"));
|
12
|
+
|
13
|
+
var _ActionList = require("../ActionList");
|
14
|
+
|
15
|
+
var _constants = require("../constants");
|
16
|
+
|
17
|
+
var _testing = require("../utils/testing");
|
18
|
+
|
19
|
+
var _ = require("..");
|
20
|
+
|
21
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
22
|
+
|
23
|
+
expect.extend(_jestAxe.toHaveNoViolations);
|
24
|
+
|
25
|
+
function SimpleActionList() {
|
26
|
+
return /*#__PURE__*/_react2.default.createElement(_.ThemeProvider, {
|
27
|
+
theme: _theme.default
|
28
|
+
}, /*#__PURE__*/_react2.default.createElement(_.BaseStyles, null, /*#__PURE__*/_react2.default.createElement(_ActionList.ActionList, {
|
29
|
+
items: [{
|
30
|
+
text: 'New file'
|
31
|
+
}, _ActionList.ActionList.Divider, {
|
32
|
+
text: 'Copy link'
|
33
|
+
}, {
|
34
|
+
text: 'Edit file'
|
35
|
+
}, {
|
36
|
+
text: 'Delete file',
|
37
|
+
variant: 'danger'
|
38
|
+
}]
|
39
|
+
})));
|
40
|
+
}
|
41
|
+
|
42
|
+
SimpleActionList.displayName = "SimpleActionList";
|
43
|
+
describe('ActionList', () => {
|
44
|
+
(0, _testing.behavesAsComponent)({
|
45
|
+
Component: _ActionList.ActionList,
|
46
|
+
systemPropArray: [_constants.COMMON],
|
47
|
+
options: {
|
48
|
+
skipAs: true,
|
49
|
+
skipSx: true
|
50
|
+
},
|
51
|
+
toRender: () => /*#__PURE__*/_react2.default.createElement(_ActionList.ActionList, {
|
52
|
+
items: []
|
53
|
+
})
|
54
|
+
});
|
55
|
+
(0, _testing.checkExports)('ActionList', {
|
56
|
+
default: undefined,
|
57
|
+
ActionList: _ActionList.ActionList
|
58
|
+
});
|
59
|
+
it('should have no axe violations', async () => {
|
60
|
+
const {
|
61
|
+
container
|
62
|
+
} = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(SimpleActionList, null));
|
63
|
+
const results = await (0, _jestAxe.axe)(container);
|
64
|
+
expect(results).toHaveNoViolations();
|
65
|
+
(0, _react.cleanup)();
|
66
|
+
});
|
67
|
+
});
|
@@ -0,0 +1 @@
|
|
1
|
+
import 'babel-polyfill';
|
@@ -0,0 +1,154 @@
|
|
1
|
+
"use strict";
|
2
|
+
|
3
|
+
var _react = require("@testing-library/react");
|
4
|
+
|
5
|
+
require("babel-polyfill");
|
6
|
+
|
7
|
+
var _jestAxe = require("jest-axe");
|
8
|
+
|
9
|
+
var _react2 = _interopRequireDefault(require("react"));
|
10
|
+
|
11
|
+
var _theme = _interopRequireDefault(require("../theme"));
|
12
|
+
|
13
|
+
var _ActionMenu = require("../ActionMenu");
|
14
|
+
|
15
|
+
var _constants = require("../constants");
|
16
|
+
|
17
|
+
var _testing = require("../utils/testing");
|
18
|
+
|
19
|
+
var _ = require("..");
|
20
|
+
|
21
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
22
|
+
|
23
|
+
expect.extend(_jestAxe.toHaveNoViolations);
|
24
|
+
const items = [{
|
25
|
+
text: 'New file'
|
26
|
+
}, {
|
27
|
+
text: 'Copy link'
|
28
|
+
}, {
|
29
|
+
text: 'Edit file'
|
30
|
+
}, {
|
31
|
+
text: 'Delete file',
|
32
|
+
variant: 'danger'
|
33
|
+
}];
|
34
|
+
const mockOnActivate = jest.fn();
|
35
|
+
|
36
|
+
function SimpleActionMenu() {
|
37
|
+
return /*#__PURE__*/_react2.default.createElement(_.ThemeProvider, {
|
38
|
+
theme: _theme.default
|
39
|
+
}, /*#__PURE__*/_react2.default.createElement(_.SSRProvider, null, /*#__PURE__*/_react2.default.createElement(_.BaseStyles, null, /*#__PURE__*/_react2.default.createElement("div", {
|
40
|
+
id: "something-else"
|
41
|
+
}, "X"), /*#__PURE__*/_react2.default.createElement(_ActionMenu.ActionMenu, {
|
42
|
+
onAction: mockOnActivate,
|
43
|
+
anchorContent: "Menu",
|
44
|
+
items: items
|
45
|
+
}), /*#__PURE__*/_react2.default.createElement("div", {
|
46
|
+
id: "portal-root"
|
47
|
+
}))));
|
48
|
+
}
|
49
|
+
|
50
|
+
SimpleActionMenu.displayName = "SimpleActionMenu";
|
51
|
+
describe('ActionMenu', () => {
|
52
|
+
afterEach(() => {
|
53
|
+
jest.clearAllMocks();
|
54
|
+
});
|
55
|
+
(0, _testing.behavesAsComponent)({
|
56
|
+
Component: _ActionMenu.ActionMenu,
|
57
|
+
systemPropArray: [_constants.COMMON],
|
58
|
+
options: {
|
59
|
+
skipAs: true,
|
60
|
+
skipSx: true
|
61
|
+
},
|
62
|
+
toRender: () => /*#__PURE__*/_react2.default.createElement(_.SSRProvider, null, /*#__PURE__*/_react2.default.createElement(_ActionMenu.ActionMenu, {
|
63
|
+
items: []
|
64
|
+
}))
|
65
|
+
});
|
66
|
+
(0, _testing.checkExports)('ActionMenu', {
|
67
|
+
default: undefined,
|
68
|
+
ActionMenu: _ActionMenu.ActionMenu
|
69
|
+
});
|
70
|
+
it('should have no axe violations', async () => {
|
71
|
+
const {
|
72
|
+
container
|
73
|
+
} = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(SimpleActionMenu, null));
|
74
|
+
const results = await (0, _jestAxe.axe)(container);
|
75
|
+
expect(results).toHaveNoViolations();
|
76
|
+
(0, _react.cleanup)();
|
77
|
+
});
|
78
|
+
it('should trigger the overlay on trigger click', async () => {
|
79
|
+
var _portalRoot, _portalRoot$textConte;
|
80
|
+
|
81
|
+
const menu = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(SimpleActionMenu, null));
|
82
|
+
let portalRoot = menu.baseElement.querySelector('#__primerPortalRoot__');
|
83
|
+
expect(portalRoot).toBeNull();
|
84
|
+
const anchor = await menu.findByText('Menu');
|
85
|
+
(0, _react.act)(() => {
|
86
|
+
_react.fireEvent.click(anchor);
|
87
|
+
});
|
88
|
+
portalRoot = menu.baseElement.querySelector('#__primerPortalRoot__');
|
89
|
+
expect(portalRoot).toBeTruthy();
|
90
|
+
const itemText = items.map(i => {
|
91
|
+
if (i.hasOwnProperty('text')) {
|
92
|
+
return i.text;
|
93
|
+
}
|
94
|
+
}).join('');
|
95
|
+
expect((_portalRoot = portalRoot) === null || _portalRoot === void 0 ? void 0 : (_portalRoot$textConte = _portalRoot.textContent) === null || _portalRoot$textConte === void 0 ? void 0 : _portalRoot$textConte.trim()).toEqual(itemText);
|
96
|
+
});
|
97
|
+
it('should dismiss the overlay on menuitem click', async () => {
|
98
|
+
var _portalRoot2;
|
99
|
+
|
100
|
+
const menu = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(SimpleActionMenu, null));
|
101
|
+
let portalRoot = await menu.baseElement.querySelector('#__primerPortalRoot__');
|
102
|
+
expect(portalRoot).toBeNull();
|
103
|
+
const anchor = await menu.findByText('Menu');
|
104
|
+
(0, _react.act)(() => {
|
105
|
+
_react.fireEvent.click(anchor);
|
106
|
+
});
|
107
|
+
portalRoot = menu.baseElement.querySelector('#__primerPortalRoot__');
|
108
|
+
expect(portalRoot).toBeTruthy();
|
109
|
+
const menuItem = await menu.queryByText(items[0].text);
|
110
|
+
(0, _react.act)(() => {
|
111
|
+
_react.fireEvent.click(menuItem);
|
112
|
+
});
|
113
|
+
expect((_portalRoot2 = portalRoot) === null || _portalRoot2 === void 0 ? void 0 : _portalRoot2.textContent).toEqual(''); // menu items are hidden
|
114
|
+
});
|
115
|
+
it('should dismiss the overlay on clicking outside overlay', async () => {
|
116
|
+
var _portalRoot3;
|
117
|
+
|
118
|
+
const menu = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(SimpleActionMenu, null));
|
119
|
+
let portalRoot = await menu.baseElement.querySelector('#__primerPortalRoot__');
|
120
|
+
expect(portalRoot).toBeNull();
|
121
|
+
const anchor = await menu.findByText('Menu');
|
122
|
+
(0, _react.act)(() => {
|
123
|
+
_react.fireEvent.click(anchor);
|
124
|
+
});
|
125
|
+
portalRoot = menu.baseElement.querySelector('#__primerPortalRoot__');
|
126
|
+
expect(portalRoot).toBeTruthy();
|
127
|
+
const somethingElse = await menu.baseElement.querySelector('#something-else');
|
128
|
+
(0, _react.act)(() => {
|
129
|
+
_react.fireEvent.mouseDown(somethingElse);
|
130
|
+
});
|
131
|
+
expect((_portalRoot3 = portalRoot) === null || _portalRoot3 === void 0 ? void 0 : _portalRoot3.textContent).toEqual(''); // menu items are hidden
|
132
|
+
});
|
133
|
+
it('should pass correct values to onAction on menu click', async () => {
|
134
|
+
var _portalRoot4;
|
135
|
+
|
136
|
+
const menu = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(SimpleActionMenu, null));
|
137
|
+
let portalRoot = await menu.baseElement.querySelector('#__primerPortalRoot__');
|
138
|
+
expect(portalRoot).toBeNull();
|
139
|
+
const anchor = await menu.findByText('Menu');
|
140
|
+
(0, _react.act)(() => {
|
141
|
+
_react.fireEvent.click(anchor);
|
142
|
+
});
|
143
|
+
portalRoot = menu.baseElement.querySelector('#__primerPortalRoot__');
|
144
|
+
expect(portalRoot).toBeTruthy();
|
145
|
+
const menuItem = await ((_portalRoot4 = portalRoot) === null || _portalRoot4 === void 0 ? void 0 : _portalRoot4.querySelector("[role='menuitem']"));
|
146
|
+
(0, _react.act)(() => {
|
147
|
+
_react.fireEvent.click(menuItem);
|
148
|
+
}); // onAction has been called with correct argument
|
149
|
+
|
150
|
+
expect(mockOnActivate).toHaveBeenCalledTimes(1);
|
151
|
+
const arg = mockOnActivate.mock.calls[0][0];
|
152
|
+
expect(arg.text).toEqual(items[0].text);
|
153
|
+
});
|
154
|
+
});
|
@@ -0,0 +1 @@
|
|
1
|
+
import 'babel-polyfill';
|
@@ -0,0 +1,161 @@
|
|
1
|
+
"use strict";
|
2
|
+
|
3
|
+
var _react = _interopRequireWildcard(require("react"));
|
4
|
+
|
5
|
+
var _AnchoredOverlay = require("../AnchoredOverlay");
|
6
|
+
|
7
|
+
var _testing = require("../utils/testing");
|
8
|
+
|
9
|
+
var _react2 = require("@testing-library/react");
|
10
|
+
|
11
|
+
var _jestAxe = require("jest-axe");
|
12
|
+
|
13
|
+
require("babel-polyfill");
|
14
|
+
|
15
|
+
var _index = require("../index");
|
16
|
+
|
17
|
+
var _theme = _interopRequireDefault(require("../theme"));
|
18
|
+
|
19
|
+
var _BaseStyles = _interopRequireDefault(require("../BaseStyles"));
|
20
|
+
|
21
|
+
var _ThemeProvider = require("../ThemeProvider");
|
22
|
+
|
23
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
24
|
+
|
25
|
+
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
26
|
+
|
27
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
28
|
+
|
29
|
+
expect.extend(_jestAxe.toHaveNoViolations);
|
30
|
+
|
31
|
+
const AnchoredOverlayTestComponent = ({
|
32
|
+
initiallyOpen = false,
|
33
|
+
onOpenCallback,
|
34
|
+
onCloseCallback
|
35
|
+
} = {}) => {
|
36
|
+
const [open, setOpen] = (0, _react.useState)(initiallyOpen);
|
37
|
+
const onOpen = (0, _react.useCallback)(gesture => {
|
38
|
+
setOpen(true);
|
39
|
+
onOpenCallback === null || onOpenCallback === void 0 ? void 0 : onOpenCallback(gesture);
|
40
|
+
}, [onOpenCallback]);
|
41
|
+
const onClose = (0, _react.useCallback)(gesture => {
|
42
|
+
setOpen(true);
|
43
|
+
onCloseCallback === null || onCloseCallback === void 0 ? void 0 : onCloseCallback(gesture);
|
44
|
+
}, [onCloseCallback]);
|
45
|
+
return /*#__PURE__*/_react.default.createElement(_ThemeProvider.ThemeProvider, {
|
46
|
+
theme: _theme.default
|
47
|
+
}, /*#__PURE__*/_react.default.createElement(_index.SSRProvider, null, /*#__PURE__*/_react.default.createElement(_BaseStyles.default, null, /*#__PURE__*/_react.default.createElement(_AnchoredOverlay.AnchoredOverlay, {
|
48
|
+
open: open,
|
49
|
+
onOpen: onOpen,
|
50
|
+
onClose: onClose,
|
51
|
+
renderAnchor: props => /*#__PURE__*/_react.default.createElement(_index.Button, props, "Anchor Button")
|
52
|
+
}, /*#__PURE__*/_react.default.createElement("button", {
|
53
|
+
type: "button"
|
54
|
+
}, "Focusable Child")))));
|
55
|
+
};
|
56
|
+
|
57
|
+
AnchoredOverlayTestComponent.displayName = "AnchoredOverlayTestComponent";
|
58
|
+
describe('AnchoredOverlay', () => {
|
59
|
+
(0, _testing.behavesAsComponent)({
|
60
|
+
Component: _AnchoredOverlay.AnchoredOverlay,
|
61
|
+
systemPropArray: [],
|
62
|
+
options: {
|
63
|
+
skipAs: true,
|
64
|
+
skipSx: true
|
65
|
+
},
|
66
|
+
toRender: () => /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, null)
|
67
|
+
});
|
68
|
+
(0, _testing.checkExports)('AnchoredOverlay', {
|
69
|
+
default: undefined,
|
70
|
+
AnchoredOverlay: _AnchoredOverlay.AnchoredOverlay
|
71
|
+
});
|
72
|
+
it('should have no axe violations when open', async () => {
|
73
|
+
const {
|
74
|
+
container
|
75
|
+
} = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
|
76
|
+
initiallyOpen: true
|
77
|
+
}));
|
78
|
+
const results = await (0, _jestAxe.axe)(container);
|
79
|
+
expect(results).toHaveNoViolations();
|
80
|
+
(0, _react2.cleanup)();
|
81
|
+
});
|
82
|
+
it('should have no axe violations when closed', async () => {
|
83
|
+
const {
|
84
|
+
container
|
85
|
+
} = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, null));
|
86
|
+
const results = await (0, _jestAxe.axe)(container);
|
87
|
+
expect(results).toHaveNoViolations();
|
88
|
+
(0, _react2.cleanup)();
|
89
|
+
});
|
90
|
+
it('should call onOpen when the anchor is clicked', () => {
|
91
|
+
const mockOpenCallback = jest.fn();
|
92
|
+
const mockCloseCallback = jest.fn();
|
93
|
+
const anchoredOverlay = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
|
94
|
+
onOpenCallback: mockOpenCallback,
|
95
|
+
onCloseCallback: mockCloseCallback
|
96
|
+
}));
|
97
|
+
const anchor = anchoredOverlay.baseElement.querySelector('[aria-haspopup="true"]');
|
98
|
+
|
99
|
+
_react2.fireEvent.click(anchor);
|
100
|
+
|
101
|
+
expect(mockOpenCallback).toHaveBeenCalledTimes(1);
|
102
|
+
expect(mockOpenCallback).toHaveBeenCalledWith('anchor-click');
|
103
|
+
expect(mockCloseCallback).toHaveBeenCalledTimes(0);
|
104
|
+
});
|
105
|
+
it('should call onOpen when the anchor activated by a key press', () => {
|
106
|
+
const mockOpenCallback = jest.fn();
|
107
|
+
const mockCloseCallback = jest.fn();
|
108
|
+
const anchoredOverlay = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
|
109
|
+
onOpenCallback: mockOpenCallback,
|
110
|
+
onCloseCallback: mockCloseCallback
|
111
|
+
}));
|
112
|
+
const anchor = anchoredOverlay.baseElement.querySelector('[aria-haspopup="true"]');
|
113
|
+
|
114
|
+
_react2.fireEvent.keyDown(anchor, {
|
115
|
+
key: ' '
|
116
|
+
});
|
117
|
+
|
118
|
+
expect(mockOpenCallback).toHaveBeenCalledTimes(1);
|
119
|
+
expect(mockOpenCallback).toHaveBeenCalledWith('anchor-key-press');
|
120
|
+
expect(mockCloseCallback).toHaveBeenCalledTimes(0);
|
121
|
+
});
|
122
|
+
it('should call onClose when the user clicks off of the overlay', () => {
|
123
|
+
const mockOpenCallback = jest.fn();
|
124
|
+
const mockCloseCallback = jest.fn();
|
125
|
+
const anchoredOverlay = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
|
126
|
+
initiallyOpen: true,
|
127
|
+
onOpenCallback: mockOpenCallback,
|
128
|
+
onCloseCallback: mockCloseCallback
|
129
|
+
}));
|
130
|
+
|
131
|
+
_react2.fireEvent.mouseDown(anchoredOverlay.baseElement);
|
132
|
+
|
133
|
+
expect(mockOpenCallback).toHaveBeenCalledTimes(0);
|
134
|
+
expect(mockCloseCallback).toHaveBeenCalledTimes(1);
|
135
|
+
expect(mockCloseCallback).toHaveBeenCalledWith('click-outside');
|
136
|
+
});
|
137
|
+
it('should call onClose when the escape key is pressed', async () => {
|
138
|
+
const mockOpenCallback = jest.fn();
|
139
|
+
const mockCloseCallback = jest.fn();
|
140
|
+
const anchoredOverlay = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
|
141
|
+
initiallyOpen: true,
|
142
|
+
onOpenCallback: mockOpenCallback,
|
143
|
+
onCloseCallback: mockCloseCallback
|
144
|
+
}));
|
145
|
+
const overlay = await anchoredOverlay.findByRole('none');
|
146
|
+
|
147
|
+
_react2.fireEvent.keyDown(overlay, {
|
148
|
+
key: 'Escape'
|
149
|
+
});
|
150
|
+
|
151
|
+
expect(mockOpenCallback).toHaveBeenCalledTimes(0);
|
152
|
+
expect(mockCloseCallback).toHaveBeenCalledTimes(1);
|
153
|
+
expect(mockCloseCallback).toHaveBeenCalledWith('escape');
|
154
|
+
});
|
155
|
+
it('should render consistently when open', () => {
|
156
|
+
const anchoredOverlay = (0, _react2.render)( /*#__PURE__*/_react.default.createElement(AnchoredOverlayTestComponent, {
|
157
|
+
initiallyOpen: true
|
158
|
+
}));
|
159
|
+
expect(anchoredOverlay).toMatchSnapshot();
|
160
|
+
});
|
161
|
+
});
|
@@ -0,0 +1 @@
|
|
1
|
+
import 'babel-polyfill';
|