@primer/components 32.1.0 → 33.0.0-rc.b3e4ccee
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 +137 -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/check_for_changeset.yml +25 -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 +9 -0
- package/.storybook/preview.js +117 -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 +18 -0
- 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 +230 -0
- package/contributor-docs/adrs/adr-001-typescript.md +23 -0
- package/contributor-docs/adrs/adr-002-behavior-isolation.md +108 -0
- package/contributor-docs/adrs/adr-003-prop-norms.md +72 -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 +106 -109
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +106 -109
- 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 +99 -0
- package/docs/content/ActionList2.mdx +379 -0
- package/docs/content/ActionMenu.mdx +80 -0
- package/docs/content/AnchoredOverlay.mdx +37 -0
- package/docs/content/Autocomplete.mdx +657 -0
- package/docs/content/Avatar.mdx +53 -0
- package/docs/content/AvatarStack.mdx +57 -0
- package/docs/content/BorderBox.md +46 -0
- package/docs/content/Box.mdx +96 -0
- package/docs/content/BranchName.md +39 -0
- package/docs/content/Breadcrumbs.md +68 -0
- package/docs/content/Buttons.md +47 -0
- package/docs/content/Checkbox.md +118 -0
- package/docs/content/CircleBadge.md +36 -0
- package/docs/content/CircleOcticon.md +19 -0
- package/docs/content/CounterLabel.md +22 -0
- package/docs/content/Details.md +102 -0
- package/docs/content/Dialog.md +106 -0
- package/docs/content/Dialog2.mdx +181 -0
- package/docs/content/Dropdown.md +66 -0
- package/docs/content/DropdownMenu.mdx +50 -0
- package/docs/content/FilterList.md +38 -0
- package/docs/content/FilteredSearch.md +33 -0
- package/docs/content/Flash.md +36 -0
- package/docs/content/Flex.md +58 -0
- package/docs/content/FormGroup.md +39 -0
- package/docs/content/Grid.md +59 -0
- package/docs/content/Header.md +78 -0
- package/docs/content/Heading.md +21 -0
- package/docs/content/Label.md +49 -0
- package/docs/content/LabelGroup.md +22 -0
- package/docs/content/Link.md +29 -0
- package/docs/content/Overlay.mdx +86 -0
- package/docs/content/Pagehead.md +19 -0
- package/docs/content/Pagination.md +179 -0
- package/docs/content/PointerBox.md +82 -0
- package/docs/content/Popover.md +130 -0
- package/docs/content/Portal.mdx +79 -0
- package/docs/content/Position.md +93 -0
- package/docs/content/ProgressBar.mdx +31 -0
- package/docs/content/SelectMenu.md +372 -0
- package/docs/content/SelectPanel.mdx +67 -0
- package/docs/content/SideNav.md +172 -0
- package/docs/content/Spinner.mdx +32 -0
- package/docs/content/StateLabel.md +28 -0
- package/docs/content/StyledOcticon.md +27 -0
- package/docs/content/SubNav.md +101 -0
- package/docs/content/TabNav.md +43 -0
- package/docs/content/Text.md +32 -0
- package/docs/content/TextInput.md +42 -0
- package/docs/content/TextInputWithTokens.mdx +211 -0
- package/docs/content/Timeline.md +149 -0
- package/docs/content/Token.mdx +381 -0
- package/docs/content/Tooltip.md +33 -0
- package/docs/content/Truncate.md +56 -0
- package/docs/content/UnderlineNav.md +46 -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 +82 -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/status.mdx +10 -0
- package/docs/content/system-props.mdx +37 -0
- package/docs/content/theme-reference.md +16 -0
- package/docs/content/theming.md +272 -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 +20867 -0
- package/docs/package.json +36 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/hero.js +21 -0
- package/docs/src/@primer/gatsby-theme-doctocat/components/live-preview-wrapper.js +41 -0
- package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +73 -0
- package/docs/src/@primer/gatsby-theme-doctocat/mdx-components.js +9 -0
- package/docs/src/@primer/gatsby-theme-doctocat/nav.yml +137 -0
- package/docs/src/@primer/gatsby-theme-doctocat/primer-components-hero.svg +1411 -0
- package/docs/src/component-checklist.js +81 -0
- package/docs/src/component-statuses.js +74 -0
- package/docs/src/props.js +77 -0
- package/jest.config.js +13 -0
- package/lib/ActionList/Item.js +3 -3
- package/lib/ActionList2/Item.js +3 -1
- package/lib/ActionList2/List.js +1 -2
- package/lib/ActionList2/Selection.js +3 -1
- package/lib/Autocomplete/Autocomplete.d.ts +1 -0
- package/lib/Autocomplete/AutocompleteInput.d.ts +1 -0
- package/lib/Avatar.d.ts +1 -2
- package/lib/Avatar.js +1 -1
- package/lib/BranchName.d.ts +1 -2
- package/lib/BranchName.js +1 -1
- package/lib/Button/Button.d.ts +1 -0
- package/lib/Button/ButtonClose.d.ts +2 -1
- package/lib/Button/ButtonDanger.d.ts +1 -0
- package/lib/Button/ButtonInvisible.d.ts +1 -0
- package/lib/Button/ButtonOutline.d.ts +1 -0
- package/lib/Button/ButtonPrimary.d.ts +1 -0
- package/lib/CircleOcticon.d.ts +1 -0
- package/lib/Details.d.ts +1 -2
- package/lib/Details.js +1 -3
- package/lib/Dialog.d.ts +3 -2
- package/lib/Dropdown.d.ts +6 -66
- package/lib/DropdownMenu/DropdownButton.d.ts +2 -1
- package/lib/FilterList.d.ts +1 -0
- package/lib/Heading.d.ts +1 -2
- package/lib/Heading.js +1 -6
- package/lib/Position.d.ts +4 -4
- package/lib/ProgressBar.d.ts +16 -11
- package/lib/ProgressBar.js +6 -10
- package/lib/SelectMenu/SelectMenu.d.ts +10 -4
- package/lib/SelectMenu/SelectMenuItem.d.ts +1 -1
- package/lib/SelectMenu/SelectMenuModal.d.ts +1 -1
- package/lib/Spinner.d.ts +1 -2
- package/lib/Spinner.js +1 -3
- package/lib/TextInputWithTokens.d.ts +1 -0
- package/lib/Token/AvatarToken.d.ts +1 -1
- package/lib/Token/IssueLabelToken.d.ts +1 -1
- package/lib/Token/Token.d.ts +1 -1
- package/lib/__tests__/ActionList.test.d.ts +1 -0
- package/lib/__tests__/ActionList.test.js +69 -0
- package/lib/__tests__/ActionList.types.test.d.ts +6 -0
- package/lib/__tests__/ActionList.types.test.js +69 -0
- package/lib/__tests__/ActionList2.test.d.ts +2 -0
- package/lib/__tests__/ActionList2.test.js +170 -0
- package/lib/__tests__/ActionMenu.test.d.ts +1 -0
- package/lib/__tests__/ActionMenu.test.js +151 -0
- package/lib/__tests__/AnchoredOverlay.test.d.ts +1 -0
- package/lib/__tests__/AnchoredOverlay.test.js +162 -0
- package/lib/__tests__/Autocomplete.test.d.ts +1 -0
- package/lib/__tests__/Autocomplete.test.js +528 -0
- package/lib/__tests__/Avatar.test.d.ts +1 -0
- package/lib/__tests__/Avatar.test.js +69 -0
- package/lib/__tests__/Avatar.types.test.d.ts +3 -0
- package/lib/__tests__/Avatar.types.test.js +31 -0
- package/lib/__tests__/AvatarStack.test.d.ts +1 -0
- package/lib/__tests__/AvatarStack.test.js +71 -0
- package/lib/__tests__/BorderBox.test.d.ts +1 -0
- package/lib/__tests__/BorderBox.test.js +58 -0
- package/lib/__tests__/Box.test.d.ts +1 -0
- package/lib/__tests__/Box.test.js +78 -0
- package/lib/__tests__/BranchName.test.d.ts +1 -0
- package/lib/__tests__/BranchName.test.js +36 -0
- package/lib/__tests__/BranchName.types.test.d.ts +3 -0
- package/lib/__tests__/BranchName.types.test.js +28 -0
- package/lib/__tests__/Breadcrumbs.test.d.ts +1 -0
- package/lib/__tests__/Breadcrumbs.test.js +40 -0
- package/lib/__tests__/Breadcrumbs.types.test.d.ts +3 -0
- package/lib/__tests__/Breadcrumbs.types.test.js +25 -0
- package/lib/__tests__/BreadcrumbsItem.test.d.ts +1 -0
- package/lib/__tests__/BreadcrumbsItem.test.js +49 -0
- package/lib/__tests__/Button.test.d.ts +1 -0
- package/lib/__tests__/Button.test.js +147 -0
- package/lib/__tests__/Caret.test.d.ts +1 -0
- package/lib/__tests__/Caret.test.js +52 -0
- package/lib/__tests__/Checkbox.test.d.ts +2 -0
- package/lib/__tests__/Checkbox.test.js +189 -0
- package/lib/__tests__/CircleBadge.test.d.ts +1 -0
- package/lib/__tests__/CircleBadge.test.js +83 -0
- package/lib/__tests__/CircleBadge.types.test.d.ts +3 -0
- package/lib/__tests__/CircleBadge.types.test.js +28 -0
- package/lib/__tests__/CircleOcticon.test.d.ts +1 -0
- package/lib/__tests__/CircleOcticon.test.js +71 -0
- package/lib/__tests__/ConfirmationDialog.test.d.ts +1 -0
- package/lib/__tests__/ConfirmationDialog.test.js +134 -0
- package/lib/__tests__/CounterLabel.test.d.ts +1 -0
- package/lib/__tests__/CounterLabel.test.js +58 -0
- package/lib/__tests__/CounterLabel.types.test.d.ts +3 -0
- package/lib/__tests__/CounterLabel.types.test.js +28 -0
- package/lib/__tests__/Details.test.d.ts +1 -0
- package/lib/__tests__/Details.test.js +117 -0
- package/lib/__tests__/Details.types.test.d.ts +3 -0
- package/lib/__tests__/Details.types.test.js +28 -0
- package/lib/__tests__/Dialog.test.d.ts +1 -0
- package/lib/__tests__/Dialog.test.js +184 -0
- package/lib/__tests__/Dialog.types.test.d.ts +3 -0
- package/lib/__tests__/Dialog.types.test.js +28 -0
- package/lib/__tests__/Dialog2.types.test.d.ts +3 -0
- package/lib/__tests__/Dialog2.types.test.js +31 -0
- package/lib/__tests__/Dropdown.test.d.ts +1 -0
- package/lib/__tests__/Dropdown.test.js +63 -0
- package/lib/__tests__/Dropdown.types.test.d.ts +3 -0
- package/lib/__tests__/Dropdown.types.test.js +31 -0
- package/lib/__tests__/DropdownMenu.test.d.ts +1 -0
- package/lib/__tests__/DropdownMenu.test.js +150 -0
- package/lib/__tests__/FilterList.test.d.ts +1 -0
- package/lib/__tests__/FilterList.test.js +36 -0
- package/lib/__tests__/FilterList.types.test.d.ts +3 -0
- package/lib/__tests__/FilterList.types.test.js +27 -0
- package/lib/__tests__/FilterListItem.test.d.ts +1 -0
- package/lib/__tests__/FilterListItem.test.js +46 -0
- package/lib/__tests__/FilteredSearch.test.d.ts +1 -0
- package/lib/__tests__/FilteredSearch.test.js +36 -0
- package/lib/__tests__/FilteredSearch.types.test.d.ts +3 -0
- package/lib/__tests__/FilteredSearch.types.test.js +28 -0
- package/lib/__tests__/Flash.test.d.ts +1 -0
- package/lib/__tests__/Flash.test.js +62 -0
- package/lib/__tests__/Flash.types.test.d.ts +3 -0
- package/lib/__tests__/Flash.types.test.js +28 -0
- package/lib/__tests__/Flex.test.d.ts +1 -0
- package/lib/__tests__/Flex.test.js +74 -0
- package/lib/__tests__/FormGroup.test.d.ts +1 -0
- package/lib/__tests__/FormGroup.test.js +54 -0
- package/lib/__tests__/FormGroup.types.test.d.ts +3 -0
- package/lib/__tests__/FormGroup.types.test.js +28 -0
- package/lib/__tests__/Grid.test.d.ts +1 -0
- package/lib/__tests__/Grid.test.js +104 -0
- package/lib/__tests__/Header.test.d.ts +1 -0
- package/lib/__tests__/Header.test.js +58 -0
- package/lib/__tests__/Header.types.test.d.ts +3 -0
- package/lib/__tests__/Header.types.test.js +29 -0
- package/lib/__tests__/Heading.test.d.ts +1 -0
- package/lib/__tests__/Heading.test.js +142 -0
- package/lib/__tests__/Heading.types.test.d.ts +3 -0
- package/lib/__tests__/Heading.types.test.js +28 -0
- package/lib/__tests__/KeyPaths.types.test.d.ts +11 -0
- package/lib/__tests__/KeyPaths.types.test.js +10 -0
- package/lib/__tests__/Label.test.d.ts +1 -0
- package/lib/__tests__/Label.test.js +46 -0
- package/lib/__tests__/Label.types.test.d.ts +3 -0
- package/lib/__tests__/Label.types.test.js +28 -0
- package/lib/__tests__/LabelGroup.test.d.ts +1 -0
- package/lib/__tests__/LabelGroup.test.js +38 -0
- package/lib/__tests__/LabelGroup.types.test.d.ts +3 -0
- package/lib/__tests__/LabelGroup.types.test.js +28 -0
- package/lib/__tests__/Link.test.d.ts +1 -0
- package/lib/__tests__/Link.test.js +76 -0
- package/lib/__tests__/Link.types.test.d.ts +3 -0
- package/lib/__tests__/Link.types.test.js +28 -0
- package/lib/__tests__/Merge.types.test.d.ts +30 -0
- package/lib/__tests__/Merge.types.test.js +27 -0
- package/lib/__tests__/NewButton.test.d.ts +1 -0
- package/lib/__tests__/NewButton.test.js +95 -0
- package/lib/__tests__/Overlay.test.d.ts +1 -0
- package/lib/__tests__/Overlay.test.js +145 -0
- package/lib/__tests__/Overlay.types.test.d.ts +6 -0
- package/lib/__tests__/Overlay.types.test.js +73 -0
- package/lib/__tests__/Pagehead.test.d.ts +1 -0
- package/lib/__tests__/Pagehead.test.js +37 -0
- package/lib/__tests__/Pagehead.types.test.d.ts +3 -0
- package/lib/__tests__/Pagehead.types.test.js +28 -0
- package/lib/__tests__/Pagination/Pagination.test.d.ts +1 -0
- package/lib/__tests__/Pagination/Pagination.test.js +47 -0
- package/lib/__tests__/Pagination/PaginationModel.test.d.ts +1 -0
- package/lib/__tests__/Pagination/PaginationModel.test.js +186 -0
- package/lib/__tests__/Pagination.types.test.d.ts +3 -0
- package/lib/__tests__/Pagination.types.test.js +33 -0
- package/lib/__tests__/PointerBox.test.d.ts +1 -0
- package/lib/__tests__/PointerBox.test.js +46 -0
- package/lib/__tests__/Popover.test.d.ts +1 -0
- package/lib/__tests__/Popover.test.js +66 -0
- package/lib/__tests__/Popover.types.test.d.ts +3 -0
- package/lib/__tests__/Popover.types.test.js +27 -0
- package/lib/__tests__/Portal.test.d.ts +1 -0
- package/lib/__tests__/Portal.test.js +124 -0
- package/lib/__tests__/Position.test.d.ts +1 -0
- package/lib/__tests__/Position.test.js +143 -0
- package/lib/__tests__/ProgressBar.test.d.ts +1 -0
- package/lib/__tests__/ProgressBar.test.js +68 -0
- package/lib/__tests__/SelectMenu.test.d.ts +1 -0
- package/lib/__tests__/SelectMenu.test.js +155 -0
- package/lib/__tests__/SelectMenu.types.test.d.ts +3 -0
- package/lib/__tests__/SelectMenu.types.test.js +47 -0
- package/lib/__tests__/SelectPanel.test.d.ts +1 -0
- package/lib/__tests__/SelectPanel.test.js +80 -0
- package/lib/__tests__/SelectPanel.types.test.d.ts +3 -0
- package/lib/__tests__/SelectPanel.types.test.js +44 -0
- package/lib/__tests__/SideNav.test.d.ts +1 -0
- package/lib/__tests__/SideNav.test.js +71 -0
- package/lib/__tests__/SideNav.types.test.d.ts +3 -0
- package/lib/__tests__/SideNav.types.test.js +28 -0
- package/lib/__tests__/Spinner.test.d.ts +1 -0
- package/lib/__tests__/Spinner.test.js +53 -0
- package/lib/__tests__/StateLabel.test.d.ts +1 -0
- package/lib/__tests__/StateLabel.test.js +71 -0
- package/lib/__tests__/StateLabel.types.test.d.ts +3 -0
- package/lib/__tests__/StateLabel.types.test.js +28 -0
- package/lib/__tests__/StyledOcticon.test.d.ts +1 -0
- package/lib/__tests__/StyledOcticon.test.js +40 -0
- package/lib/__tests__/StyledOcticon.types.test.d.ts +3 -0
- package/lib/__tests__/StyledOcticon.types.test.js +32 -0
- package/lib/__tests__/SubNav.test.d.ts +1 -0
- package/lib/__tests__/SubNav.test.js +62 -0
- package/lib/__tests__/SubNav.types.test.d.ts +3 -0
- package/lib/__tests__/SubNav.types.test.js +27 -0
- package/lib/__tests__/SubNavLink.test.d.ts +1 -0
- package/lib/__tests__/SubNavLink.test.js +49 -0
- package/lib/__tests__/TabNav.test.d.ts +1 -0
- package/lib/__tests__/TabNav.test.js +49 -0
- package/lib/__tests__/TabNav.types.test.d.ts +3 -0
- package/lib/__tests__/TabNav.types.test.js +25 -0
- package/lib/__tests__/Text.test.d.ts +1 -0
- package/lib/__tests__/Text.test.js +105 -0
- package/lib/__tests__/TextInput.test.d.ts +1 -0
- package/lib/__tests__/TextInput.test.js +78 -0
- package/lib/__tests__/TextInputWithTokens.test.d.ts +1 -0
- package/lib/__tests__/TextInputWithTokens.test.js +572 -0
- package/lib/__tests__/ThemeProvider.test.d.ts +1 -0
- package/lib/__tests__/ThemeProvider.test.js +444 -0
- package/lib/__tests__/Timeline.test.d.ts +1 -0
- package/lib/__tests__/Timeline.test.js +75 -0
- package/lib/__tests__/Timeline.types.test.d.ts +3 -0
- package/lib/__tests__/Timeline.types.test.js +31 -0
- package/lib/__tests__/Token.test.d.ts +1 -0
- package/lib/__tests__/Token.test.js +180 -0
- package/lib/__tests__/Tooltip.test.d.ts +1 -0
- package/lib/__tests__/Tooltip.test.js +69 -0
- package/lib/__tests__/Tooltip.types.test.d.ts +3 -0
- package/lib/__tests__/Tooltip.types.test.js +28 -0
- package/lib/__tests__/Truncate.test.d.ts +1 -0
- package/lib/__tests__/Truncate.test.js +63 -0
- package/lib/__tests__/Truncate.types.test.d.ts +3 -0
- package/lib/__tests__/Truncate.types.test.js +31 -0
- package/lib/__tests__/UnderlineNav.test.d.ts +1 -0
- package/lib/__tests__/UnderlineNav.test.js +72 -0
- package/lib/__tests__/UnderlineNav.types.test.d.ts +3 -0
- package/lib/__tests__/UnderlineNav.types.test.js +25 -0
- package/lib/__tests__/UnderlineNavLink.test.d.ts +1 -0
- package/lib/__tests__/UnderlineNavLink.test.js +51 -0
- package/lib/__tests__/behaviors/anchoredPosition.test.d.ts +1 -0
- package/lib/__tests__/behaviors/anchoredPosition.test.js +390 -0
- package/lib/__tests__/behaviors/focusTrap.test.d.ts +1 -0
- package/lib/__tests__/behaviors/focusTrap.test.js +234 -0
- package/lib/__tests__/behaviors/focusZone.test.d.ts +1 -0
- package/lib/__tests__/behaviors/focusZone.test.js +570 -0
- package/lib/__tests__/behaviors/iterateFocusableElements.test.d.ts +1 -0
- package/lib/__tests__/behaviors/iterateFocusableElements.test.js +55 -0
- package/lib/__tests__/behaviors/scrollIntoViewingArea.test.d.ts +1 -0
- package/lib/__tests__/behaviors/scrollIntoViewingArea.test.js +226 -0
- package/lib/__tests__/filterObject.test.d.ts +1 -0
- package/lib/__tests__/filterObject.test.js +30 -0
- package/lib/__tests__/hooks/useAnchoredPosition.test.d.ts +1 -0
- package/lib/__tests__/hooks/useAnchoredPosition.test.js +54 -0
- package/lib/__tests__/hooks/useOnEscapePress.test.d.ts +1 -0
- package/lib/__tests__/hooks/useOnEscapePress.test.js +32 -0
- package/lib/__tests__/hooks/useOnOutsideClick.test.d.ts +1 -0
- package/lib/__tests__/hooks/useOnOutsideClick.test.js +87 -0
- package/lib/__tests__/hooks/useOpenAndCloseFocus.test.d.ts +1 -0
- package/lib/__tests__/hooks/useOpenAndCloseFocus.test.js +60 -0
- package/lib/__tests__/hooks/useProvidedStateOrCreate.test.d.ts +1 -0
- package/lib/__tests__/hooks/useProvidedStateOrCreate.test.js +45 -0
- package/lib/__tests__/theme.test.d.ts +1 -0
- package/lib/__tests__/theme.test.js +36 -0
- package/lib/__tests__/themeGet.test.d.ts +1 -0
- package/lib/__tests__/themeGet.test.js +25 -0
- package/lib/__tests__/themePreval.test.d.ts +1 -0
- package/lib/__tests__/themePreval.test.js +14 -0
- package/lib/__tests__/useSafeTimeout.test.d.ts +1 -0
- package/lib/__tests__/useSafeTimeout.test.js +45 -0
- package/lib/__tests__/utils/createSlots.test.d.ts +1 -0
- package/lib/__tests__/utils/createSlots.test.js +75 -0
- package/lib/stories/ActionList.stories.js +454 -0
- package/lib/stories/ActionList2.stories.js +923 -0
- package/lib/stories/ActionMenu.stories.js +348 -0
- package/lib/stories/AnchoredOverlay.stories.js +127 -0
- package/lib/stories/Autocomplete.stories.js +619 -0
- package/lib/stories/AvatarStack.stories.js +49 -0
- package/lib/stories/Button.stories.js +125 -0
- package/lib/stories/Checkbox.stories.js +227 -0
- package/lib/stories/ConfirmationDialog.stories.js +119 -0
- package/lib/stories/Dialog.stories.js +269 -0
- package/lib/stories/DropdownMenu.stories.js +122 -0
- package/lib/stories/IssueLabelToken.stories.js +165 -0
- package/lib/stories/NewButton.stories.js +230 -0
- package/lib/stories/Overlay.stories.js +204 -0
- package/lib/stories/Portal.stories.js +104 -0
- package/lib/stories/ProfileToken.stories.js +162 -0
- package/lib/stories/SelectPanel.stories.js +399 -0
- package/lib/stories/TextInput.stories.js +144 -0
- package/lib/stories/TextInputWithTokens.stories.js +252 -0
- package/lib/stories/ThemeProvider.stories.js +102 -0
- package/lib/stories/Token.stories.js +176 -0
- package/lib/stories/useAnchoredPosition.stories.js +351 -0
- package/lib/stories/useFocusTrap.stories.js +360 -0
- package/lib/stories/useFocusZone.stories.js +607 -0
- package/lib/utils/testing.d.ts +1 -0
- package/lib/utils/testing.js +29 -0
- package/lib-esm/ActionList/Item.js +3 -3
- package/lib-esm/ActionList2/Item.js +3 -1
- package/lib-esm/ActionList2/List.js +1 -2
- package/lib-esm/ActionList2/Selection.js +3 -1
- package/lib-esm/Autocomplete/Autocomplete.d.ts +1 -0
- package/lib-esm/Autocomplete/AutocompleteInput.d.ts +1 -0
- package/lib-esm/Avatar.d.ts +1 -2
- package/lib-esm/Avatar.js +2 -2
- package/lib-esm/BranchName.d.ts +1 -2
- package/lib-esm/BranchName.js +2 -2
- package/lib-esm/Button/Button.d.ts +1 -0
- package/lib-esm/Button/ButtonClose.d.ts +2 -1
- package/lib-esm/Button/ButtonDanger.d.ts +1 -0
- package/lib-esm/Button/ButtonInvisible.d.ts +1 -0
- package/lib-esm/Button/ButtonOutline.d.ts +1 -0
- package/lib-esm/Button/ButtonPrimary.d.ts +1 -0
- package/lib-esm/CircleOcticon.d.ts +1 -0
- package/lib-esm/Details.d.ts +1 -2
- package/lib-esm/Details.js +1 -2
- package/lib-esm/Dialog.d.ts +3 -2
- package/lib-esm/Dropdown.d.ts +6 -66
- package/lib-esm/DropdownMenu/DropdownButton.d.ts +2 -1
- package/lib-esm/FilterList.d.ts +1 -0
- package/lib-esm/Heading.d.ts +1 -2
- package/lib-esm/Heading.js +2 -6
- package/lib-esm/Position.d.ts +4 -4
- package/lib-esm/ProgressBar.d.ts +16 -11
- package/lib-esm/ProgressBar.js +7 -11
- package/lib-esm/SelectMenu/SelectMenu.d.ts +10 -4
- package/lib-esm/SelectMenu/SelectMenuItem.d.ts +1 -1
- package/lib-esm/SelectMenu/SelectMenuModal.d.ts +1 -1
- package/lib-esm/Spinner.d.ts +1 -2
- package/lib-esm/Spinner.js +1 -2
- package/lib-esm/TextInputWithTokens.d.ts +1 -0
- package/lib-esm/Token/AvatarToken.d.ts +1 -1
- package/lib-esm/Token/IssueLabelToken.d.ts +1 -1
- package/lib-esm/Token/Token.d.ts +1 -1
- package/lib-esm/__tests__/ActionList.test.d.ts +1 -0
- package/lib-esm/__tests__/ActionList.test.js +57 -0
- package/lib-esm/__tests__/ActionList.types.test.d.ts +6 -0
- package/lib-esm/__tests__/ActionList.types.test.js +45 -0
- package/lib-esm/__tests__/ActionList2.test.d.ts +2 -0
- package/lib-esm/__tests__/ActionList2.test.js +144 -0
- package/lib-esm/__tests__/ActionMenu.test.d.ts +1 -0
- package/lib-esm/__tests__/ActionMenu.test.js +139 -0
- package/lib-esm/__tests__/AnchoredOverlay.test.d.ts +1 -0
- package/lib-esm/__tests__/AnchoredOverlay.test.js +136 -0
- package/lib-esm/__tests__/Autocomplete.test.d.ts +1 -0
- package/lib-esm/__tests__/Autocomplete.test.js +494 -0
- package/lib-esm/__tests__/Avatar.test.d.ts +1 -0
- package/lib-esm/__tests__/Avatar.test.js +58 -0
- package/lib-esm/__tests__/Avatar.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Avatar.types.test.js +16 -0
- package/lib-esm/__tests__/AvatarStack.test.d.ts +1 -0
- package/lib-esm/__tests__/AvatarStack.test.js +58 -0
- package/lib-esm/__tests__/BorderBox.test.d.ts +1 -0
- package/lib-esm/__tests__/BorderBox.test.js +47 -0
- package/lib-esm/__tests__/Box.test.d.ts +1 -0
- package/lib-esm/__tests__/Box.test.js +67 -0
- package/lib-esm/__tests__/BranchName.test.d.ts +1 -0
- package/lib-esm/__tests__/BranchName.test.js +26 -0
- package/lib-esm/__tests__/BranchName.types.test.d.ts +3 -0
- package/lib-esm/__tests__/BranchName.types.test.js +13 -0
- package/lib-esm/__tests__/Breadcrumbs.test.d.ts +1 -0
- package/lib-esm/__tests__/Breadcrumbs.test.js +30 -0
- package/lib-esm/__tests__/Breadcrumbs.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Breadcrumbs.types.test.js +12 -0
- package/lib-esm/__tests__/BreadcrumbsItem.test.d.ts +1 -0
- package/lib-esm/__tests__/BreadcrumbsItem.test.js +39 -0
- package/lib-esm/__tests__/Button.test.d.ts +1 -0
- package/lib-esm/__tests__/Button.test.js +137 -0
- package/lib-esm/__tests__/Caret.test.d.ts +1 -0
- package/lib-esm/__tests__/Caret.test.js +42 -0
- package/lib-esm/__tests__/Checkbox.test.d.ts +2 -0
- package/lib-esm/__tests__/Checkbox.test.js +169 -0
- package/lib-esm/__tests__/CircleBadge.test.d.ts +1 -0
- package/lib-esm/__tests__/CircleBadge.test.js +70 -0
- package/lib-esm/__tests__/CircleBadge.types.test.d.ts +3 -0
- package/lib-esm/__tests__/CircleBadge.types.test.js +13 -0
- package/lib-esm/__tests__/CircleOcticon.test.d.ts +1 -0
- package/lib-esm/__tests__/CircleOcticon.test.js +59 -0
- package/lib-esm/__tests__/ConfirmationDialog.test.d.ts +1 -0
- package/lib-esm/__tests__/ConfirmationDialog.test.js +113 -0
- package/lib-esm/__tests__/CounterLabel.test.d.ts +1 -0
- package/lib-esm/__tests__/CounterLabel.test.js +47 -0
- package/lib-esm/__tests__/CounterLabel.types.test.d.ts +3 -0
- package/lib-esm/__tests__/CounterLabel.types.test.js +13 -0
- package/lib-esm/__tests__/Details.test.d.ts +1 -0
- package/lib-esm/__tests__/Details.test.js +107 -0
- package/lib-esm/__tests__/Details.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Details.types.test.js +13 -0
- package/lib-esm/__tests__/Dialog.test.d.ts +1 -0
- package/lib-esm/__tests__/Dialog.test.js +171 -0
- package/lib-esm/__tests__/Dialog.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Dialog.types.test.js +13 -0
- package/lib-esm/__tests__/Dialog2.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Dialog2.types.test.js +16 -0
- package/lib-esm/__tests__/Dropdown.test.d.ts +1 -0
- package/lib-esm/__tests__/Dropdown.test.js +53 -0
- package/lib-esm/__tests__/Dropdown.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Dropdown.types.test.js +17 -0
- package/lib-esm/__tests__/DropdownMenu.test.d.ts +1 -0
- package/lib-esm/__tests__/DropdownMenu.test.js +137 -0
- package/lib-esm/__tests__/FilterList.test.d.ts +1 -0
- package/lib-esm/__tests__/FilterList.test.js +26 -0
- package/lib-esm/__tests__/FilterList.types.test.d.ts +3 -0
- package/lib-esm/__tests__/FilterList.types.test.js +13 -0
- package/lib-esm/__tests__/FilterListItem.test.d.ts +1 -0
- package/lib-esm/__tests__/FilterListItem.test.js +36 -0
- package/lib-esm/__tests__/FilteredSearch.test.d.ts +1 -0
- package/lib-esm/__tests__/FilteredSearch.test.js +26 -0
- package/lib-esm/__tests__/FilteredSearch.types.test.d.ts +3 -0
- package/lib-esm/__tests__/FilteredSearch.types.test.js +13 -0
- package/lib-esm/__tests__/Flash.test.d.ts +1 -0
- package/lib-esm/__tests__/Flash.test.js +51 -0
- package/lib-esm/__tests__/Flash.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Flash.types.test.js +13 -0
- package/lib-esm/__tests__/Flex.test.d.ts +1 -0
- package/lib-esm/__tests__/Flex.test.js +64 -0
- package/lib-esm/__tests__/FormGroup.test.d.ts +1 -0
- package/lib-esm/__tests__/FormGroup.test.js +44 -0
- package/lib-esm/__tests__/FormGroup.types.test.d.ts +3 -0
- package/lib-esm/__tests__/FormGroup.types.test.js +13 -0
- package/lib-esm/__tests__/Grid.test.d.ts +1 -0
- package/lib-esm/__tests__/Grid.test.js +94 -0
- package/lib-esm/__tests__/Header.test.d.ts +1 -0
- package/lib-esm/__tests__/Header.test.js +48 -0
- package/lib-esm/__tests__/Header.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Header.types.test.js +15 -0
- package/lib-esm/__tests__/Heading.test.d.ts +1 -0
- package/lib-esm/__tests__/Heading.test.js +131 -0
- package/lib-esm/__tests__/Heading.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Heading.types.test.js +13 -0
- package/lib-esm/__tests__/KeyPaths.types.test.d.ts +11 -0
- package/lib-esm/__tests__/KeyPaths.types.test.js +3 -0
- package/lib-esm/__tests__/Label.test.d.ts +1 -0
- package/lib-esm/__tests__/Label.test.js +36 -0
- package/lib-esm/__tests__/Label.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Label.types.test.js +13 -0
- package/lib-esm/__tests__/LabelGroup.test.d.ts +1 -0
- package/lib-esm/__tests__/LabelGroup.test.js +26 -0
- package/lib-esm/__tests__/LabelGroup.types.test.d.ts +3 -0
- package/lib-esm/__tests__/LabelGroup.types.test.js +13 -0
- package/lib-esm/__tests__/Link.test.d.ts +1 -0
- package/lib-esm/__tests__/Link.test.js +66 -0
- package/lib-esm/__tests__/Link.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Link.types.test.js +13 -0
- package/lib-esm/__tests__/Merge.types.test.d.ts +30 -0
- package/lib-esm/__tests__/Merge.types.test.js +14 -0
- package/lib-esm/__tests__/NewButton.test.d.ts +1 -0
- package/lib-esm/__tests__/NewButton.test.js +84 -0
- package/lib-esm/__tests__/Overlay.test.d.ts +1 -0
- package/lib-esm/__tests__/Overlay.test.js +123 -0
- package/lib-esm/__tests__/Overlay.types.test.d.ts +6 -0
- package/lib-esm/__tests__/Overlay.types.test.js +49 -0
- package/lib-esm/__tests__/Pagehead.test.d.ts +1 -0
- package/lib-esm/__tests__/Pagehead.test.js +26 -0
- package/lib-esm/__tests__/Pagehead.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Pagehead.types.test.js +13 -0
- package/lib-esm/__tests__/Pagination/Pagination.test.d.ts +1 -0
- package/lib-esm/__tests__/Pagination/Pagination.test.js +35 -0
- package/lib-esm/__tests__/Pagination/PaginationModel.test.d.ts +1 -0
- package/lib-esm/__tests__/Pagination/PaginationModel.test.js +182 -0
- package/lib-esm/__tests__/Pagination.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Pagination.types.test.js +18 -0
- package/lib-esm/__tests__/PointerBox.test.d.ts +1 -0
- package/lib-esm/__tests__/PointerBox.test.js +36 -0
- package/lib-esm/__tests__/Popover.test.d.ts +1 -0
- package/lib-esm/__tests__/Popover.test.js +53 -0
- package/lib-esm/__tests__/Popover.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Popover.types.test.js +13 -0
- package/lib-esm/__tests__/Portal.test.d.ts +1 -0
- package/lib-esm/__tests__/Portal.test.js +104 -0
- package/lib-esm/__tests__/Position.test.d.ts +1 -0
- package/lib-esm/__tests__/Position.test.js +133 -0
- package/lib-esm/__tests__/ProgressBar.test.d.ts +1 -0
- package/lib-esm/__tests__/ProgressBar.test.js +58 -0
- package/lib-esm/__tests__/SelectMenu.test.d.ts +1 -0
- package/lib-esm/__tests__/SelectMenu.test.js +145 -0
- package/lib-esm/__tests__/SelectMenu.types.test.d.ts +3 -0
- package/lib-esm/__tests__/SelectMenu.types.test.js +33 -0
- package/lib-esm/__tests__/SelectPanel.test.d.ts +1 -0
- package/lib-esm/__tests__/SelectPanel.test.js +65 -0
- package/lib-esm/__tests__/SelectPanel.types.test.d.ts +3 -0
- package/lib-esm/__tests__/SelectPanel.types.test.js +29 -0
- package/lib-esm/__tests__/SideNav.test.d.ts +1 -0
- package/lib-esm/__tests__/SideNav.test.js +60 -0
- package/lib-esm/__tests__/SideNav.types.test.d.ts +3 -0
- package/lib-esm/__tests__/SideNav.types.test.js +13 -0
- package/lib-esm/__tests__/Spinner.test.d.ts +1 -0
- package/lib-esm/__tests__/Spinner.test.js +43 -0
- package/lib-esm/__tests__/StateLabel.test.d.ts +1 -0
- package/lib-esm/__tests__/StateLabel.test.js +61 -0
- package/lib-esm/__tests__/StateLabel.types.test.d.ts +3 -0
- package/lib-esm/__tests__/StateLabel.types.test.js +13 -0
- package/lib-esm/__tests__/StyledOcticon.test.d.ts +1 -0
- package/lib-esm/__tests__/StyledOcticon.test.js +29 -0
- package/lib-esm/__tests__/StyledOcticon.types.test.d.ts +3 -0
- package/lib-esm/__tests__/StyledOcticon.types.test.js +16 -0
- package/lib-esm/__tests__/SubNav.test.d.ts +1 -0
- package/lib-esm/__tests__/SubNav.test.js +50 -0
- package/lib-esm/__tests__/SubNav.types.test.d.ts +3 -0
- package/lib-esm/__tests__/SubNav.types.test.js +14 -0
- package/lib-esm/__tests__/SubNavLink.test.d.ts +1 -0
- package/lib-esm/__tests__/SubNavLink.test.js +39 -0
- package/lib-esm/__tests__/TabNav.test.d.ts +1 -0
- package/lib-esm/__tests__/TabNav.test.js +39 -0
- package/lib-esm/__tests__/TabNav.types.test.d.ts +3 -0
- package/lib-esm/__tests__/TabNav.types.test.js +12 -0
- package/lib-esm/__tests__/Text.test.d.ts +1 -0
- package/lib-esm/__tests__/Text.test.js +93 -0
- package/lib-esm/__tests__/TextInput.test.d.ts +1 -0
- package/lib-esm/__tests__/TextInput.test.js +68 -0
- package/lib-esm/__tests__/TextInputWithTokens.test.d.ts +1 -0
- package/lib-esm/__tests__/TextInputWithTokens.test.js +511 -0
- package/lib-esm/__tests__/ThemeProvider.test.d.ts +1 -0
- package/lib-esm/__tests__/ThemeProvider.test.js +408 -0
- package/lib-esm/__tests__/Timeline.test.d.ts +1 -0
- package/lib-esm/__tests__/Timeline.test.js +65 -0
- package/lib-esm/__tests__/Timeline.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Timeline.types.test.js +18 -0
- package/lib-esm/__tests__/Token.test.d.ts +1 -0
- package/lib-esm/__tests__/Token.test.js +166 -0
- package/lib-esm/__tests__/Tooltip.test.d.ts +1 -0
- package/lib-esm/__tests__/Tooltip.test.js +59 -0
- package/lib-esm/__tests__/Tooltip.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Tooltip.types.test.js +13 -0
- package/lib-esm/__tests__/Truncate.test.d.ts +1 -0
- package/lib-esm/__tests__/Truncate.test.js +53 -0
- package/lib-esm/__tests__/Truncate.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Truncate.types.test.js +16 -0
- package/lib-esm/__tests__/UnderlineNav.test.d.ts +1 -0
- package/lib-esm/__tests__/UnderlineNav.test.js +60 -0
- package/lib-esm/__tests__/UnderlineNav.types.test.d.ts +3 -0
- package/lib-esm/__tests__/UnderlineNav.types.test.js +12 -0
- package/lib-esm/__tests__/UnderlineNavLink.test.d.ts +1 -0
- package/lib-esm/__tests__/UnderlineNavLink.test.js +41 -0
- package/lib-esm/__tests__/behaviors/anchoredPosition.test.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/anchoredPosition.test.js +388 -0
- package/lib-esm/__tests__/behaviors/focusTrap.test.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/focusTrap.test.js +227 -0
- package/lib-esm/__tests__/behaviors/focusZone.test.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/focusZone.test.js +487 -0
- package/lib-esm/__tests__/behaviors/iterateFocusableElements.test.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/iterateFocusableElements.test.js +48 -0
- package/lib-esm/__tests__/behaviors/scrollIntoViewingArea.test.d.ts +1 -0
- package/lib-esm/__tests__/behaviors/scrollIntoViewingArea.test.js +224 -0
- package/lib-esm/__tests__/filterObject.test.d.ts +1 -0
- package/lib-esm/__tests__/filterObject.test.js +27 -0
- package/lib-esm/__tests__/hooks/useAnchoredPosition.test.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useAnchoredPosition.test.js +46 -0
- package/lib-esm/__tests__/hooks/useOnEscapePress.test.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useOnEscapePress.test.js +23 -0
- package/lib-esm/__tests__/hooks/useOnOutsideClick.test.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useOnOutsideClick.test.js +68 -0
- package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.test.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.test.js +52 -0
- package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.test.d.ts +1 -0
- package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.test.js +36 -0
- package/lib-esm/__tests__/theme.test.d.ts +1 -0
- package/lib-esm/__tests__/theme.test.js +33 -0
- package/lib-esm/__tests__/themeGet.test.d.ts +1 -0
- package/lib-esm/__tests__/themeGet.test.js +22 -0
- package/lib-esm/__tests__/themePreval.test.d.ts +1 -0
- package/lib-esm/__tests__/themePreval.test.js +7 -0
- package/lib-esm/__tests__/useSafeTimeout.test.d.ts +1 -0
- package/lib-esm/__tests__/useSafeTimeout.test.js +39 -0
- package/lib-esm/__tests__/utils/createSlots.test.d.ts +1 -0
- package/lib-esm/__tests__/utils/createSlots.test.js +67 -0
- package/lib-esm/stories/ActionList.stories.js +395 -0
- package/lib-esm/stories/ActionList2.stories.js +811 -0
- package/lib-esm/stories/ActionMenu.stories.js +303 -0
- package/lib-esm/stories/AnchoredOverlay.stories.js +101 -0
- package/lib-esm/stories/Autocomplete.stories.js +560 -0
- package/lib-esm/stories/AvatarStack.stories.js +32 -0
- package/lib-esm/stories/Button.stories.js +86 -0
- package/lib-esm/stories/Checkbox.stories.js +197 -0
- package/lib-esm/stories/ConfirmationDialog.stories.js +94 -0
- package/lib-esm/stories/Dialog.stories.js +244 -0
- package/lib-esm/stories/DropdownMenu.stories.js +94 -0
- package/lib-esm/stories/IssueLabelToken.stories.js +139 -0
- package/lib-esm/stories/NewButton.stories.js +178 -0
- package/lib-esm/stories/Overlay.stories.js +173 -0
- package/lib-esm/stories/Portal.stories.js +68 -0
- package/lib-esm/stories/ProfileToken.stories.js +136 -0
- package/lib-esm/stories/SelectPanel.stories.js +334 -0
- package/lib-esm/stories/TextInput.stories.js +117 -0
- package/lib-esm/stories/TextInputWithTokens.stories.js +210 -0
- package/lib-esm/stories/ThemeProvider.stories.js +83 -0
- package/lib-esm/stories/Token.stories.js +146 -0
- package/lib-esm/stories/useAnchoredPosition.stories.js +313 -0
- package/lib-esm/stories/useFocusTrap.stories.js +313 -0
- package/lib-esm/stories/useFocusZone.stories.js +562 -0
- package/lib-esm/utils/testing.d.ts +1 -0
- package/lib-esm/utils/testing.js +24 -0
- package/migrating.md +250 -0
- package/now.json +17 -0
- package/package-lock.json +66668 -0
- package/package.json +2 -2
- package/rollup.config.js +36 -0
- package/script/build +21 -0
- package/script/build-storybook +10 -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 +481 -0
- package/src/ActionList/List.tsx +258 -0
- package/src/ActionList/index.ts +21 -0
- package/src/ActionList2/Description.tsx +52 -0
- package/src/ActionList2/Divider.tsx +24 -0
- package/src/ActionList2/Group.tsx +103 -0
- package/src/ActionList2/Item.tsx +247 -0
- package/src/ActionList2/LinkItem.tsx +49 -0
- package/src/ActionList2/List.tsx +50 -0
- package/src/ActionList2/Selection.tsx +61 -0
- package/src/ActionList2/Visuals.tsx +76 -0
- package/src/ActionList2/index.ts +39 -0
- package/src/ActionMenu.tsx +106 -0
- package/src/AnchoredOverlay/AnchoredOverlay.tsx +191 -0
- package/src/AnchoredOverlay/index.ts +2 -0
- package/src/Autocomplete/Autocomplete.tsx +103 -0
- package/src/Autocomplete/AutocompleteContext.tsx +19 -0
- package/src/Autocomplete/AutocompleteInput.tsx +179 -0
- package/src/Autocomplete/AutocompleteMenu.tsx +341 -0
- package/src/Autocomplete/AutocompleteOverlay.tsx +68 -0
- package/src/Autocomplete/index.ts +2 -0
- package/src/Avatar.tsx +44 -0
- package/src/AvatarPair.tsx +35 -0
- package/src/AvatarStack.tsx +159 -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 +39 -0
- package/src/Button/ButtonBase.tsx +39 -0
- package/src/Button/ButtonClose.tsx +36 -0
- package/src/Button/ButtonDanger.tsx +42 -0
- package/src/Button/ButtonGroup.tsx +55 -0
- package/src/Button/ButtonInvisible.tsx +31 -0
- package/src/Button/ButtonOutline.tsx +42 -0
- package/src/Button/ButtonPrimary.tsx +40 -0
- package/src/Button/ButtonStyles.tsx +36 -0
- package/src/Button/ButtonTableList.tsx +45 -0
- package/src/Button/index.ts +16 -0
- package/src/Caret.tsx +133 -0
- package/src/Checkbox.tsx +75 -0
- package/src/CircleBadge.tsx +53 -0
- package/src/CircleOcticon.tsx +37 -0
- package/src/CounterLabel.tsx +50 -0
- package/src/Details.tsx +19 -0
- package/src/Dialog/ConfirmationDialog.tsx +184 -0
- package/src/Dialog/Dialog.tsx +444 -0
- package/src/Dialog.tsx +145 -0
- package/src/Dropdown.tsx +154 -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 +75 -0
- package/src/FilteredActionList/FilteredActionList.tsx +142 -0
- package/src/FilteredActionList/index.ts +2 -0
- package/src/FilteredSearch.tsx +27 -0
- package/src/Flash.tsx +75 -0
- package/src/Flex.tsx +15 -0
- package/src/FormGroup.tsx +24 -0
- package/src/Grid.tsx +15 -0
- package/src/Header.tsx +74 -0
- package/src/Heading.tsx +14 -0
- package/src/Label.tsx +72 -0
- package/src/LabelGroup.tsx +17 -0
- package/src/Link.tsx +42 -0
- package/src/NewButton/button-counter.tsx +15 -0
- package/src/NewButton/button.tsx +283 -0
- package/src/NewButton/index.ts +10 -0
- package/src/NewButton/types.ts +36 -0
- package/src/Overlay.tsx +203 -0
- package/src/Pagehead.tsx +16 -0
- package/src/Pagination/Pagination.tsx +212 -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 +225 -0
- package/src/Portal/Portal.tsx +97 -0
- package/src/Portal/index.ts +5 -0
- package/src/Position.tsx +63 -0
- package/src/ProgressBar.tsx +53 -0
- package/src/SelectMenu/SelectMenu.tsx +123 -0
- package/src/SelectMenu/SelectMenuContext.tsx +9 -0
- package/src/SelectMenu/SelectMenuDivider.tsx +24 -0
- package/src/SelectMenu/SelectMenuFilter.tsx +50 -0
- package/src/SelectMenu/SelectMenuFooter.tsx +27 -0
- package/src/SelectMenu/SelectMenuHeader.tsx +48 -0
- package/src/SelectMenu/SelectMenuItem.tsx +136 -0
- package/src/SelectMenu/SelectMenuList.tsx +41 -0
- package/src/SelectMenu/SelectMenuLoadingAnimation.tsx +25 -0
- package/src/SelectMenu/SelectMenuModal.tsx +119 -0
- package/src/SelectMenu/SelectMenuTab.tsx +87 -0
- package/src/SelectMenu/SelectMenuTabPanel.tsx +29 -0
- package/src/SelectMenu/SelectMenuTabs.tsx +43 -0
- package/src/SelectMenu/hooks/useKeyboardNav.js +90 -0
- package/src/SelectMenu/index.ts +15 -0
- package/src/SelectPanel/SelectPanel.tsx +173 -0
- package/src/SelectPanel/index.ts +2 -0
- package/src/SideNav.tsx +191 -0
- package/src/Spinner.tsx +57 -0
- package/src/StateLabel.tsx +112 -0
- package/src/StyledOcticon.tsx +22 -0
- package/src/SubNav.tsx +124 -0
- package/src/TabNav.tsx +73 -0
- package/src/Text.tsx +13 -0
- package/src/TextInput.tsx +68 -0
- package/src/TextInputWithTokens.tsx +351 -0
- package/src/ThemeProvider.tsx +176 -0
- package/src/Timeline.tsx +140 -0
- package/src/Token/AvatarToken.tsx +54 -0
- package/src/Token/IssueLabelToken.tsx +150 -0
- package/src/Token/Token.tsx +126 -0
- package/src/Token/TokenBase.tsx +129 -0
- package/src/Token/_RemoveTokenButton.tsx +111 -0
- package/src/Token/_TokenTextContainer.tsx +47 -0
- package/src/Token/index.ts +3 -0
- package/src/Tooltip.tsx +263 -0
- package/src/Truncate.tsx +31 -0
- package/src/UnderlineNav.tsx +107 -0
- package/src/_TextInputWrapper.tsx +113 -0
- package/src/_UnstyledTextInput.tsx +19 -0
- package/src/__tests__/.eslintrc.json +11 -0
- package/src/__tests__/ActionList.test.tsx +53 -0
- package/src/__tests__/ActionList.types.test.tsx +51 -0
- package/src/__tests__/ActionList2.test.tsx +156 -0
- package/src/__tests__/ActionMenu.test.tsx +136 -0
- package/src/__tests__/AnchoredOverlay.test.tsx +150 -0
- package/src/__tests__/Autocomplete.test.tsx +444 -0
- package/src/__tests__/Avatar.test.tsx +44 -0
- package/src/__tests__/Avatar.types.test.tsx +11 -0
- package/src/__tests__/AvatarStack.test.tsx +48 -0
- package/src/__tests__/BorderBox.test.tsx +43 -0
- package/src/__tests__/Box.test.tsx +42 -0
- package/src/__tests__/BranchName.test.tsx +26 -0
- package/src/__tests__/BranchName.types.test.tsx +11 -0
- package/src/__tests__/Breadcrumbs.test.tsx +27 -0
- package/src/__tests__/Breadcrumbs.types.test.tsx +22 -0
- package/src/__tests__/BreadcrumbsItem.test.tsx +31 -0
- package/src/__tests__/Button.test.tsx +128 -0
- package/src/__tests__/Caret.test.tsx +36 -0
- package/src/__tests__/Checkbox.test.tsx +155 -0
- package/src/__tests__/CircleBadge.test.tsx +66 -0
- package/src/__tests__/CircleBadge.types.test.tsx +11 -0
- package/src/__tests__/CircleOcticon.test.tsx +50 -0
- package/src/__tests__/ConfirmationDialog.test.tsx +120 -0
- package/src/__tests__/CounterLabel.test.tsx +50 -0
- package/src/__tests__/CounterLabel.types.test.tsx +11 -0
- package/src/__tests__/Details.test.tsx +115 -0
- package/src/__tests__/Details.types.test.tsx +11 -0
- package/src/__tests__/Dialog.test.tsx +155 -0
- package/src/__tests__/Dialog.types.test.tsx +11 -0
- package/src/__tests__/Dialog2.types.test.tsx +11 -0
- package/src/__tests__/Dropdown.test.tsx +53 -0
- package/src/__tests__/Dropdown.types.test.tsx +21 -0
- package/src/__tests__/DropdownMenu.test.tsx +136 -0
- package/src/__tests__/FilterList.test.tsx +26 -0
- package/src/__tests__/FilterList.types.test.tsx +17 -0
- package/src/__tests__/FilterListItem.test.tsx +31 -0
- package/src/__tests__/FilteredSearch.test.tsx +26 -0
- package/src/__tests__/FilteredSearch.types.test.tsx +11 -0
- package/src/__tests__/Flash.test.tsx +45 -0
- package/src/__tests__/Flash.types.test.tsx +11 -0
- package/src/__tests__/Flex.test.tsx +58 -0
- package/src/__tests__/FormGroup.test.tsx +38 -0
- package/src/__tests__/FormGroup.types.test.tsx +11 -0
- package/src/__tests__/Grid.test.tsx +82 -0
- package/src/__tests__/Header.test.tsx +49 -0
- package/src/__tests__/Header.types.test.tsx +19 -0
- package/src/__tests__/Heading.test.tsx +137 -0
- package/src/__tests__/Heading.types.test.tsx +11 -0
- package/src/__tests__/KeyPaths.types.test.ts +14 -0
- package/src/__tests__/Label.test.tsx +34 -0
- package/src/__tests__/Label.types.test.tsx +11 -0
- package/src/__tests__/LabelGroup.test.tsx +30 -0
- package/src/__tests__/LabelGroup.types.test.tsx +11 -0
- package/src/__tests__/Link.test.tsx +47 -0
- package/src/__tests__/Link.types.test.tsx +11 -0
- package/src/__tests__/Merge.types.test.ts +39 -0
- package/src/__tests__/NewButton.test.tsx +70 -0
- package/src/__tests__/Overlay.test.tsx +103 -0
- package/src/__tests__/Overlay.types.test.tsx +33 -0
- package/src/__tests__/Pagehead.test.tsx +23 -0
- package/src/__tests__/Pagehead.types.test.tsx +11 -0
- package/src/__tests__/Pagination/Pagination.test.tsx +30 -0
- package/src/__tests__/Pagination/PaginationModel.test.tsx +133 -0
- package/src/__tests__/Pagination/__snapshots__/Pagination.test.tsx.snap +184 -0
- package/src/__tests__/Pagination.types.test.tsx +11 -0
- package/src/__tests__/PointerBox.test.tsx +34 -0
- package/src/__tests__/Popover.test.tsx +68 -0
- package/src/__tests__/Popover.types.test.tsx +17 -0
- package/src/__tests__/Portal.test.tsx +103 -0
- package/src/__tests__/Position.test.tsx +117 -0
- package/src/__tests__/ProgressBar.test.tsx +40 -0
- package/src/__tests__/SelectMenu.test.tsx +142 -0
- package/src/__tests__/SelectMenu.types.test.tsx +37 -0
- package/src/__tests__/SelectPanel.test.tsx +63 -0
- package/src/__tests__/SelectPanel.types.test.tsx +31 -0
- package/src/__tests__/SideNav.test.tsx +62 -0
- package/src/__tests__/SideNav.types.test.tsx +11 -0
- package/src/__tests__/Spinner.test.tsx +42 -0
- package/src/__tests__/StateLabel.test.tsx +48 -0
- package/src/__tests__/StateLabel.types.test.tsx +11 -0
- package/src/__tests__/StyledOcticon.test.tsx +26 -0
- package/src/__tests__/StyledOcticon.types.test.tsx +12 -0
- package/src/__tests__/SubNav.test.tsx +50 -0
- package/src/__tests__/SubNav.types.test.tsx +25 -0
- package/src/__tests__/SubNavLink.test.tsx +31 -0
- package/src/__tests__/TabNav.test.tsx +32 -0
- package/src/__tests__/TabNav.types.test.tsx +22 -0
- package/src/__tests__/Text.test.tsx +78 -0
- package/src/__tests__/TextInput.test.tsx +49 -0
- package/src/__tests__/TextInputWithTokens.test.tsx +422 -0
- package/src/__tests__/ThemeProvider.test.tsx +441 -0
- package/src/__tests__/Timeline.test.tsx +58 -0
- package/src/__tests__/Timeline.types.test.tsx +31 -0
- package/src/__tests__/Token.test.tsx +118 -0
- package/src/__tests__/Tooltip.test.tsx +52 -0
- package/src/__tests__/Tooltip.types.test.tsx +11 -0
- package/src/__tests__/Truncate.test.tsx +43 -0
- package/src/__tests__/Truncate.types.test.tsx +11 -0
- package/src/__tests__/UnderlineNav.test.tsx +58 -0
- package/src/__tests__/UnderlineNav.types.test.tsx +22 -0
- package/src/__tests__/UnderlineNavLink.test.tsx +31 -0
- package/src/__tests__/__snapshots__/ActionList.test.tsx.snap +223 -0
- package/src/__tests__/__snapshots__/ActionList2.test.tsx.snap +14 -0
- package/src/__tests__/__snapshots__/ActionMenu.test.tsx.snap +80 -0
- package/src/__tests__/__snapshots__/AnchoredOverlay.test.tsx.snap +232 -0
- package/src/__tests__/__snapshots__/Autocomplete.test.tsx.snap +3901 -0
- package/src/__tests__/__snapshots__/Avatar.test.tsx.snap +19 -0
- package/src/__tests__/__snapshots__/AvatarStack.test.tsx.snap +377 -0
- package/src/__tests__/__snapshots__/BorderBox.test.tsx.snap +14 -0
- package/src/__tests__/__snapshots__/Box.test.tsx.snap +201 -0
- package/src/__tests__/__snapshots__/BranchName.test.tsx.snap +17 -0
- package/src/__tests__/__snapshots__/Breadcrumbs.test.tsx.snap +29 -0
- package/src/__tests__/__snapshots__/BreadcrumbsItem.test.tsx.snap +79 -0
- package/src/__tests__/__snapshots__/Button.test.tsx.snap +840 -0
- package/src/__tests__/__snapshots__/Caret.test.tsx.snap +373 -0
- package/src/__tests__/__snapshots__/Checkbox.test.tsx.snap +16 -0
- package/src/__tests__/__snapshots__/CircleBadge.test.tsx.snap +142 -0
- package/src/__tests__/__snapshots__/CircleOcticon.test.tsx.snap +65 -0
- package/src/__tests__/__snapshots__/ConfirmationDialog.test.tsx.snap +89 -0
- package/src/__tests__/__snapshots__/CounterLabel.test.tsx.snap +22 -0
- package/src/__tests__/__snapshots__/Details.test.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/Dialog.test.tsx.snap +201 -0
- package/src/__tests__/__snapshots__/Dropdown.test.tsx.snap +249 -0
- package/src/__tests__/__snapshots__/DropdownMenu.test.tsx.snap +107 -0
- package/src/__tests__/__snapshots__/FilterList.test.tsx.snap +13 -0
- package/src/__tests__/__snapshots__/FilterListItem.test.tsx.snap +80 -0
- package/src/__tests__/__snapshots__/FilteredSearch.test.tsx.snap +32 -0
- package/src/__tests__/__snapshots__/Flash.test.tsx.snap +32 -0
- package/src/__tests__/__snapshots__/Flex.test.tsx.snap +130 -0
- package/src/__tests__/__snapshots__/FormGroup.test.tsx.snap +25 -0
- package/src/__tests__/__snapshots__/Grid.test.tsx.snap +178 -0
- package/src/__tests__/__snapshots__/Header.test.tsx.snap +79 -0
- package/src/__tests__/__snapshots__/Heading.test.tsx.snap +13 -0
- package/src/__tests__/__snapshots__/Label.test.tsx.snap +73 -0
- package/src/__tests__/__snapshots__/LabelGroup.test.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/Link.test.tsx.snap +212 -0
- package/src/__tests__/__snapshots__/NewButton.test.tsx.snap +305 -0
- package/src/__tests__/__snapshots__/Pagehead.test.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/PointerBox.test.tsx.snap +174 -0
- package/src/__tests__/__snapshots__/Popover.test.tsx.snap +4687 -0
- package/src/__tests__/__snapshots__/Position.test.tsx.snap +44 -0
- package/src/__tests__/__snapshots__/ProgressBar.test.tsx.snap +53 -0
- package/src/__tests__/__snapshots__/SelectMenu.test.tsx.snap +473 -0
- package/src/__tests__/__snapshots__/SelectPanel.test.tsx.snap +124 -0
- package/src/__tests__/__snapshots__/SideNav.test.tsx.snap +143 -0
- package/src/__tests__/__snapshots__/Spinner.test.tsx.snap +33 -0
- package/src/__tests__/__snapshots__/StateLabel.test.tsx.snap +395 -0
- package/src/__tests__/__snapshots__/StyledOcticon.test.tsx.snap +26 -0
- package/src/__tests__/__snapshots__/SubNav.test.tsx.snap +44 -0
- package/src/__tests__/__snapshots__/SubNavLink.test.tsx.snap +199 -0
- package/src/__tests__/__snapshots__/TabNav.test.tsx.snap +58 -0
- package/src/__tests__/__snapshots__/Text.test.tsx.snap +7 -0
- package/src/__tests__/__snapshots__/TextInput.test.tsx.snap +446 -0
- package/src/__tests__/__snapshots__/TextInputWithTokens.test.tsx.snap +6045 -0
- package/src/__tests__/__snapshots__/ThemeProvider.test.tsx.snap +15 -0
- package/src/__tests__/__snapshots__/Timeline.test.tsx.snap +159 -0
- package/src/__tests__/__snapshots__/Token.test.tsx.snap +3811 -0
- package/src/__tests__/__snapshots__/Tooltip.test.tsx.snap +227 -0
- package/src/__tests__/__snapshots__/Truncate.test.tsx.snap +17 -0
- package/src/__tests__/__snapshots__/UnderlineNav.test.tsx.snap +59 -0
- package/src/__tests__/__snapshots__/UnderlineNavLink.test.tsx.snap +130 -0
- package/src/__tests__/__snapshots__/themePreval.test.ts.snap +3176 -0
- package/src/__tests__/behaviors/anchoredPosition.test.ts +295 -0
- package/src/__tests__/behaviors/focusTrap.test.tsx +236 -0
- package/src/__tests__/behaviors/focusZone.test.tsx +549 -0
- package/src/__tests__/behaviors/iterateFocusableElements.test.tsx +61 -0
- package/src/__tests__/behaviors/scrollIntoViewingArea.test.ts +195 -0
- package/src/__tests__/filterObject.test.ts +54 -0
- package/src/__tests__/hooks/useAnchoredPosition.test.tsx +31 -0
- package/src/__tests__/hooks/useOnEscapePress.test.tsx +16 -0
- package/src/__tests__/hooks/useOnOutsideClick.test.tsx +48 -0
- package/src/__tests__/hooks/useOpenAndCloseFocus.test.tsx +48 -0
- package/src/__tests__/hooks/useProvidedStateOrCreate.test.tsx +39 -0
- package/src/__tests__/theme.test.ts +41 -0
- package/src/__tests__/themeGet.test.ts +15 -0
- package/src/__tests__/themePreval.test.ts +8 -0
- package/src/__tests__/useSafeTimeout.test.tsx +36 -0
- package/src/__tests__/utils/__snapshots__/createSlots.test.tsx.snap +55 -0
- package/src/__tests__/utils/createSlots.test.tsx +74 -0
- package/src/behaviors/anchoredPosition.ts +442 -0
- package/src/behaviors/focusTrap.ts +184 -0
- package/src/behaviors/focusZone.ts +713 -0
- package/src/behaviors/scrollIntoViewingArea.ts +27 -0
- package/src/constants.ts +62 -0
- package/src/drafts.ts +10 -0
- package/src/hooks/index.ts +11 -0
- package/src/hooks/useAnchoredPosition.ts +54 -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 +32 -0
- package/src/hooks/useOverlay.tsx +34 -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 +175 -0
- package/src/polyfills/eventListenerSignal.ts +66 -0
- package/src/stories/ActionList.stories.tsx +436 -0
- package/src/stories/ActionList2.stories.tsx +1305 -0
- package/src/stories/ActionMenu.stories.tsx +331 -0
- package/src/stories/AnchoredOverlay.stories.tsx +117 -0
- package/src/stories/Autocomplete.stories.tsx +655 -0
- package/src/stories/AvatarStack.stories.tsx +37 -0
- package/src/stories/Button.stories.tsx +92 -0
- package/src/stories/Checkbox.stories.tsx +164 -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/IssueLabelToken.stories.tsx +138 -0
- package/src/stories/NewButton.stories.tsx +201 -0
- package/src/stories/Overlay.stories.tsx +213 -0
- package/src/stories/Portal.stories.tsx +109 -0
- package/src/stories/ProfileToken.stories.tsx +129 -0
- package/src/stories/SelectPanel.stories.tsx +353 -0
- package/src/stories/TextInput.stories.tsx +113 -0
- package/src/stories/TextInputWithTokens.stories.tsx +155 -0
- package/src/stories/ThemeProvider.stories.tsx +104 -0
- package/src/stories/Token.stories.tsx +137 -0
- package/src/stories/useAnchoredPosition.stories.tsx +332 -0
- package/src/stories/useFocusTrap.stories.tsx +400 -0
- package/src/stories/useFocusZone.stories.tsx +663 -0
- package/src/sx.ts +24 -0
- package/src/theme-preval.js +80 -0
- package/src/theme.ts +89 -0
- package/src/utils/create-slots.tsx +96 -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 +264 -0
- package/src/utils/theme.js +64 -0
- package/src/utils/types/AriaRole.ts +71 -0
- package/src/utils/types/ComponentProps.ts +13 -0
- package/src/utils/types/Flatten.ts +4 -0
- package/src/utils/types/KeyPaths.ts +10 -0
- package/src/utils/types/MandateProps.ts +19 -0
- package/src/utils/types/Merge.ts +20 -0
- package/src/utils/types/index.ts +5 -0
- package/src/utils/uniqueId.ts +6 -0
- package/src/utils/use-force-update.ts +7 -0
- package/src/utils/useIsomorphicLayoutEffect.ts +10 -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/ActionList2/Header.d.ts +0 -26
- package/lib/ActionList2/Header.js +0 -55
- package/lib-esm/ActionList2/Header.d.ts +0 -26
- package/lib-esm/ActionList2/Header.js +0 -44
@@ -0,0 +1,57 @@
|
|
1
|
+
---
|
2
|
+
title: AvatarStack
|
3
|
+
status: Alpha
|
4
|
+
description: Use an avatar stack to display two or more avatars in an inline stack.
|
5
|
+
source: https://github.com/primer/react/blob/main/src/AvatarStack.tsx
|
6
|
+
---
|
7
|
+
|
8
|
+
import {AvatarStack} from '@primer/components'
|
9
|
+
|
10
|
+
### Default example
|
11
|
+
|
12
|
+
```jsx live
|
13
|
+
<AvatarStack>
|
14
|
+
<Avatar alt="Primer" src="https://avatars.githubusercontent.com/primer" />
|
15
|
+
<Avatar alt="GitHub" src="https://avatars.githubusercontent.com/github" />
|
16
|
+
<Avatar alt="Atom" src="https://avatars.githubusercontent.com/atom" />
|
17
|
+
<Avatar alt="Desktop" src="https://avatars.githubusercontent.com/desktop" />
|
18
|
+
</AvatarStack>
|
19
|
+
```
|
20
|
+
|
21
|
+
### Right aligned
|
22
|
+
|
23
|
+
```jsx live
|
24
|
+
<AvatarStack alignRight>
|
25
|
+
<Avatar alt="Primer" src="https://avatars.githubusercontent.com/primer" />
|
26
|
+
<Avatar alt="GitHub" src="https://avatars.githubusercontent.com/github" />
|
27
|
+
<Avatar alt="Atom" src="https://avatars.githubusercontent.com/atom" />
|
28
|
+
<Avatar alt="Desktop" src="https://avatars.githubusercontent.com/desktop" />
|
29
|
+
</AvatarStack>
|
30
|
+
```
|
31
|
+
|
32
|
+
## Props
|
33
|
+
|
34
|
+
| Name | Type | Default | Description |
|
35
|
+
| :--------- | :---------------- | :-----: | :----------------------------------- |
|
36
|
+
| alignRight | Boolean | | Creates right aligned AvatarStack |
|
37
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
38
|
+
|
39
|
+
## Component status
|
40
|
+
|
41
|
+
<ComponentChecklist
|
42
|
+
items={{
|
43
|
+
propsDocumented: true,
|
44
|
+
noUnnecessaryDeps: true,
|
45
|
+
adaptsToThemes: true,
|
46
|
+
adaptsToScreenSizes: true,
|
47
|
+
fullTestCoverage: false,
|
48
|
+
usedInProduction: true,
|
49
|
+
usageExamplesDocumented: true,
|
50
|
+
designReviewed: false,
|
51
|
+
a11yReviewed: false,
|
52
|
+
stableApi: false,
|
53
|
+
addressedApiFeedback: false,
|
54
|
+
hasDesignGuidelines: false,
|
55
|
+
hasFigmaComponent: false
|
56
|
+
}}
|
57
|
+
/>
|
@@ -0,0 +1,46 @@
|
|
1
|
+
---
|
2
|
+
title: BorderBox
|
3
|
+
status: Deprecated
|
4
|
+
---
|
5
|
+
|
6
|
+
BorderBox is a Box component with a border. When no `borderColor` is present, the component defaults to a primary border.
|
7
|
+
|
8
|
+
## Deprecation
|
9
|
+
|
10
|
+
Use [Box](/Box) instead.
|
11
|
+
|
12
|
+
**Before**
|
13
|
+
|
14
|
+
```jsx
|
15
|
+
<BorderBox>Item 1</BorderBox>
|
16
|
+
```
|
17
|
+
|
18
|
+
**After**
|
19
|
+
|
20
|
+
```jsx
|
21
|
+
<Box borderWidth="1px" borderStyle="solid" borderColor="border.default" borderRadius={2}>
|
22
|
+
Item 1
|
23
|
+
</Box>
|
24
|
+
```
|
25
|
+
|
26
|
+
## Default example
|
27
|
+
|
28
|
+
```jsx live
|
29
|
+
<BorderBox>This is a BorderBox</BorderBox>
|
30
|
+
```
|
31
|
+
|
32
|
+
Note that `BorderBox` has default props set for `borderWidth`, `borderStyle`, and `borderColor`. This means that you cannot use `border={0} borderBottom={1}` or similar patterns; instead, use individual properties like `borderWidth={0} borderBottomWidth={1}`.
|
33
|
+
|
34
|
+
## System props
|
35
|
+
|
36
|
+
BorderBox components get `COMMON`, `LAYOUT`, `BORDER`, and `FLEX` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
37
|
+
|
38
|
+
## Component props
|
39
|
+
|
40
|
+
| Prop name | Type | Default | Description |
|
41
|
+
| :----------- | :--------------- | :---------------------------: | :------------------------------------------------------------ |
|
42
|
+
| borderWidth | String | '1px' | Sets the border, use theme values or provide your own. |
|
43
|
+
| borderStyle | String | 'solid' | Sets the border style, use theme values or provide your own. |
|
44
|
+
| borderColor | String | 'border.primary' (from theme) | Sets the border color, use theme values or provide your own. |
|
45
|
+
| borderRadius | String or Number | 2 (from theme) | Sets the border radius, use theme values or provide your own. |
|
46
|
+
| boxShadow | String | | Sets box shadow, use theme values or provide your own. |
|
@@ -0,0 +1,96 @@
|
|
1
|
+
---
|
2
|
+
title: Box
|
3
|
+
status: Beta
|
4
|
+
description: A low-level utility component that accepts styled system props to enable custom theme-aware styling
|
5
|
+
source: https://github.com/primer/react/blob/main/src/Box.tsx
|
6
|
+
---
|
7
|
+
|
8
|
+
import {Props} from '../src/props'
|
9
|
+
import {ComponentChecklist} from '../src/component-checklist'
|
10
|
+
import {Box} from '@primer/components'
|
11
|
+
|
12
|
+
```jsx live
|
13
|
+
<Box color="fg.muted" bg="canvas.subtle" p={3}>
|
14
|
+
Hello
|
15
|
+
</Box>
|
16
|
+
```
|
17
|
+
|
18
|
+
## Props
|
19
|
+
|
20
|
+
<Props of={Box} />
|
21
|
+
|
22
|
+
Box also accepts all [styled system props](https://styled-system.com/table/).
|
23
|
+
|
24
|
+
## Examples
|
25
|
+
|
26
|
+
### Border on all sides
|
27
|
+
|
28
|
+
```jsx live
|
29
|
+
<Box borderColor="border.default" borderWidth={1} borderStyle="solid" p={3}>
|
30
|
+
Hello
|
31
|
+
</Box>
|
32
|
+
```
|
33
|
+
|
34
|
+
### Border on one side
|
35
|
+
|
36
|
+
```jsx live
|
37
|
+
<Box borderColor="border.default" borderBottomWidth={1} borderBottomStyle="solid" pb={3}>
|
38
|
+
Hello
|
39
|
+
</Box>
|
40
|
+
```
|
41
|
+
|
42
|
+
### Flexbox
|
43
|
+
|
44
|
+
Use Box to create [flexbox](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Flexbox) layouts.
|
45
|
+
|
46
|
+
```jsx live
|
47
|
+
<Box display="flex">
|
48
|
+
<Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
|
49
|
+
1
|
50
|
+
</Box>
|
51
|
+
<Box flexGrow={1} p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
|
52
|
+
2
|
53
|
+
</Box>
|
54
|
+
<Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
|
55
|
+
3
|
56
|
+
</Box>
|
57
|
+
</Box>
|
58
|
+
```
|
59
|
+
|
60
|
+
### Grid
|
61
|
+
|
62
|
+
Use Box to create [grid](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Grids) layouts.
|
63
|
+
|
64
|
+
```jsx live
|
65
|
+
<Box display="grid" gridTemplateColumns="1fr 1fr" gridGap={3}>
|
66
|
+
<Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
|
67
|
+
1
|
68
|
+
</Box>
|
69
|
+
<Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
|
70
|
+
2
|
71
|
+
</Box>
|
72
|
+
<Box p={3} borderColor="border.default" borderWidth={1} borderStyle="solid">
|
73
|
+
3
|
74
|
+
</Box>
|
75
|
+
</Box>
|
76
|
+
```
|
77
|
+
|
78
|
+
## Component status
|
79
|
+
|
80
|
+
<ComponentChecklist
|
81
|
+
items={{
|
82
|
+
propsDocumented: true,
|
83
|
+
noUnnecessaryDeps: true,
|
84
|
+
adaptsToThemes: true,
|
85
|
+
adaptsToScreenSizes: true,
|
86
|
+
fullTestCoverage: true,
|
87
|
+
usedInProduction: true,
|
88
|
+
usageExamplesDocumented: true,
|
89
|
+
designReviewed: null,
|
90
|
+
a11yReviewed: null,
|
91
|
+
stableApi: false,
|
92
|
+
addressedApiFeedback: false,
|
93
|
+
hasDesignGuidelines: null,
|
94
|
+
hasFigmaComponent: null
|
95
|
+
}}
|
96
|
+
/>
|
@@ -0,0 +1,39 @@
|
|
1
|
+
---
|
2
|
+
title: BranchName
|
3
|
+
status: Alpha
|
4
|
+
source: https://github.com/primer/react/blob/main/src/BranchName.tsx
|
5
|
+
---
|
6
|
+
|
7
|
+
BranchName is a label-type component rendered as an `<a>` tag by default with monospace font.
|
8
|
+
|
9
|
+
```jsx live
|
10
|
+
<BranchName>a_new_feature_branch</BranchName>
|
11
|
+
```
|
12
|
+
|
13
|
+
## Props
|
14
|
+
|
15
|
+
| Name | Type | Default | Description |
|
16
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
17
|
+
| as | String | `<a>` | sets the HTML tag for the component |
|
18
|
+
| href | String | | a URL to link the component to |
|
19
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
20
|
+
|
21
|
+
## Component status
|
22
|
+
|
23
|
+
<ComponentChecklist
|
24
|
+
items={{
|
25
|
+
propsDocumented: true,
|
26
|
+
noUnnecessaryDeps: true,
|
27
|
+
adaptsToThemes: true,
|
28
|
+
adaptsToScreenSizes: true,
|
29
|
+
fullTestCoverage: true,
|
30
|
+
usedInProduction: false,
|
31
|
+
usageExamplesDocumented: true,
|
32
|
+
designReviewed: false,
|
33
|
+
a11yReviewed: false,
|
34
|
+
stableApi: false,
|
35
|
+
addressedApiFeedback: false,
|
36
|
+
hasDesignGuidelines: false,
|
37
|
+
hasFigmaComponent: false
|
38
|
+
}}
|
39
|
+
/>
|
@@ -0,0 +1,68 @@
|
|
1
|
+
---
|
2
|
+
title: Breadcrumbs
|
3
|
+
status: Alpha
|
4
|
+
description: Use breadcrumbs to show navigational context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages.
|
5
|
+
source: https://github.com/primer/react/blob/main/src/Breadcrumbs.tsx
|
6
|
+
---
|
7
|
+
|
8
|
+
Breadcrumbs are used to show taxonomical context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages. Breadcrumbs are most appropriate on pages that:
|
9
|
+
|
10
|
+
- Are many levels deep on a site
|
11
|
+
- Do not have a section-level navigation
|
12
|
+
- May need the ability to quickly go back to the previous (parent) page
|
13
|
+
|
14
|
+
To use Breadcrumbs with [react-router](https://github.com/ReactTraining/react-router) or
|
15
|
+
[react-router-dom](https://www.npmjs.com/package/react-router-dom), pass
|
16
|
+
`as={NavLink}` and omit the `selected` prop.
|
17
|
+
This ensures that the NavLink gets `activeClassName='selected'`
|
18
|
+
|
19
|
+
## Default example
|
20
|
+
|
21
|
+
```jsx live
|
22
|
+
<Breadcrumbs>
|
23
|
+
<Breadcrumbs.Item href="/">Home</Breadcrumbs.Item>
|
24
|
+
<Breadcrumbs.Item href="/about">About</Breadcrumbs.Item>
|
25
|
+
<Breadcrumbs.Item href="/about/team" selected>
|
26
|
+
Team
|
27
|
+
</Breadcrumbs.Item>
|
28
|
+
</Breadcrumbs>
|
29
|
+
```
|
30
|
+
|
31
|
+
## Props
|
32
|
+
|
33
|
+
### Breadcrumbs
|
34
|
+
|
35
|
+
| Prop name | Type | Default | Description |
|
36
|
+
| :-------- | :---------------- | :-----: | :----------------------------------- |
|
37
|
+
| children | ReactNode | | The `Breadcrumbs.Item`s |
|
38
|
+
| className | string | | |
|
39
|
+
| sx | SystemStyleObject | `{}` | Style to be applied to the component |
|
40
|
+
|
41
|
+
### Breadcrumbs.Item
|
42
|
+
|
43
|
+
| Prop name | Type | Default | Description |
|
44
|
+
| :-------- | :---------------- | :-----: | :----------------------------------------------- |
|
45
|
+
| as | string | `a` | Sets the HTML tag for the component |
|
46
|
+
| href | string | | URL to be used for the Link |
|
47
|
+
| selected | boolean | `false` | Used to style the link as selected or unselected |
|
48
|
+
| sx | SystemStyleObject | `{}` | Style to be applied to the component |
|
49
|
+
|
50
|
+
## Component status
|
51
|
+
|
52
|
+
<ComponentChecklist
|
53
|
+
items={{
|
54
|
+
propsDocumented: true,
|
55
|
+
noUnnecessaryDeps: true,
|
56
|
+
adaptsToThemes: true,
|
57
|
+
adaptsToScreenSizes: false,
|
58
|
+
fullTestCoverage: false,
|
59
|
+
usedInProduction: true,
|
60
|
+
usageExamplesDocumented: true,
|
61
|
+
designReviewed: false,
|
62
|
+
a11yReviewed: false,
|
63
|
+
stableApi: false,
|
64
|
+
addressedApiFeedback: false,
|
65
|
+
hasDesignGuidelines: false,
|
66
|
+
hasFigmaComponent: false
|
67
|
+
}}
|
68
|
+
/>
|
@@ -0,0 +1,47 @@
|
|
1
|
+
---
|
2
|
+
title: Button
|
3
|
+
status: Alpha
|
4
|
+
---
|
5
|
+
|
6
|
+
`Button` is used for actions, like in forms, while `Link` is used for destinations, or moving from one page to another.
|
7
|
+
|
8
|
+
In special cases where you'd like to use a `<a>` styled like a Button, use `<Button as='a'>` and provide an `href`.
|
9
|
+
|
10
|
+
To create a button group, wrap `Button` elements in the `ButtonGroup` element. `ButtonGroup` gets the same props as `Box`.
|
11
|
+
|
12
|
+
## Default examples
|
13
|
+
|
14
|
+
```jsx live
|
15
|
+
<>
|
16
|
+
<Button>Button</Button>
|
17
|
+
<ButtonDanger>Button Danger</ButtonDanger>
|
18
|
+
<ButtonOutline>Button Outline</ButtonOutline>
|
19
|
+
<ButtonPrimary>Button Primary</ButtonPrimary>
|
20
|
+
<ButtonInvisible>Button Invisible</ButtonInvisible>
|
21
|
+
<ButtonClose onClick={() => window.alert('button clicked')} />
|
22
|
+
|
23
|
+
<ButtonGroup display="block" my={2}>
|
24
|
+
<Button>Button</Button>
|
25
|
+
<Button>Button</Button>
|
26
|
+
<Button>Button</Button>
|
27
|
+
</ButtonGroup>
|
28
|
+
|
29
|
+
<ButtonTableList>Button Table List </ButtonTableList>
|
30
|
+
</>
|
31
|
+
```
|
32
|
+
|
33
|
+
## Component props
|
34
|
+
|
35
|
+
Native `<button>` HTML attributes are forwarded to the underlying React `button` component and are not listed below.
|
36
|
+
|
37
|
+
### Button
|
38
|
+
|
39
|
+
| Prop name | Type | Default | Description |
|
40
|
+
| :-------- | :---------------- | :------: | :-------------------------------------------------------------------------------------------------------------------------- |
|
41
|
+
| as | String | `button` | sets the HTML tag for the component |
|
42
|
+
| sx | SystemStyleObject | {} | Additional styles |
|
43
|
+
| variant | String | 'medium' | a value of `small`, `medium`, or `large` results in smaller or larger Button text size; no effect if `fontSize` prop is set |
|
44
|
+
|
45
|
+
### ButtonGroup
|
46
|
+
|
47
|
+
`ButtonGroup` has access to the same props as `Box`
|
@@ -0,0 +1,118 @@
|
|
1
|
+
---
|
2
|
+
title: Checkbox
|
3
|
+
description: Use checkboxes to toggle between checked and unchecked states in a list or as a standalone form field
|
4
|
+
status: Alpha
|
5
|
+
source: https://github.com/primer/react/blob/main/src/Checklist.tsx
|
6
|
+
storybook: '/react/storybook?path=/story/forms-checkbox--default'
|
7
|
+
---
|
8
|
+
|
9
|
+
import {ComponentChecklist} from '../src/component-checklist'
|
10
|
+
|
11
|
+
## Default example
|
12
|
+
|
13
|
+
The `Checkbox` component can be used in controlled and uncontrolled modes.
|
14
|
+
|
15
|
+
```jsx live
|
16
|
+
<>
|
17
|
+
<Box as="form" sx={{p: 3, pt: 0, display: 'flex', alignItems: 'center'}}>
|
18
|
+
<Checkbox id="default-checkbox" />
|
19
|
+
<Text as="label" htmlFor="default-checkbox" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}}>
|
20
|
+
Default checkbox
|
21
|
+
</Text>
|
22
|
+
</Box>
|
23
|
+
<Box as="form" sx={{p: 3, display: 'flex', alignItems: 'center'}}>
|
24
|
+
<Checkbox id="always-checked-checkbox" checked={true} />
|
25
|
+
<Text as="label" htmlFor="always-checked-checkbox" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}}>
|
26
|
+
Always checked
|
27
|
+
</Text>
|
28
|
+
</Box>
|
29
|
+
<Box as="form" sx={{p: 3, display: 'flex', alignItems: 'center'}}>
|
30
|
+
<Checkbox id="always-unchecked-checkbox" checked={false} />
|
31
|
+
<Text as="label" htmlFor="always-unchecked-checkbox" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}}>
|
32
|
+
Always unchecked
|
33
|
+
</Text>
|
34
|
+
</Box>
|
35
|
+
|
36
|
+
<Box as="form" sx={{p: 3, display: 'flex', alignItems: 'center'}}>
|
37
|
+
<Checkbox id="inactive-checkbox" checked={true} disabled />
|
38
|
+
<Text as="label" htmlFor="inactive-checkbox" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}}>
|
39
|
+
Inactive
|
40
|
+
</Text>
|
41
|
+
</Box>
|
42
|
+
</>
|
43
|
+
```
|
44
|
+
|
45
|
+
<Note variant="warning">
|
46
|
+
Checkbox components should always be accompanied by a corresponding label to improve support for assistive technologies.
|
47
|
+
</Note>
|
48
|
+
|
49
|
+
## Indeterminate example
|
50
|
+
|
51
|
+
An `indeterminate` checkbox state should be used if the input value is neither true nor false. This can be useful in situations where you are required to display an incomplete state, or one that is dependent on other input selections to determine a value.
|
52
|
+
|
53
|
+
```jsx live
|
54
|
+
<>
|
55
|
+
<Box as="form" sx={{p: 3, pt: 0, pb: 1, display: 'flex', alignItems: 'center'}}>
|
56
|
+
<Checkbox id="indeterminate-checkbox" onChange={() => {}} indeterminate={true} />
|
57
|
+
<Text as="label" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}} htmlFor="controlled-checkbox">
|
58
|
+
<Text sx={{display: 'block'}}>Default checkbox</Text>
|
59
|
+
</Text>
|
60
|
+
</Box>
|
61
|
+
<Box key={`sub-checkbox-0`} as="form" sx={{p: 1, pl: 6, display: 'flex', alignItems: 'center'}}>
|
62
|
+
<Checkbox id={`sub-checkbox-0`} checked={true} onChange={() => {}} />
|
63
|
+
<Text as="label" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}} htmlFor={`sub-checkbox-0`}>
|
64
|
+
<Text sx={{display: 'block'}}>Checkbox 1</Text>
|
65
|
+
</Text>
|
66
|
+
</Box>
|
67
|
+
<Box key={`sub-checkbox-1`} as="form" sx={{p: 1, pl: 6, display: 'flex', alignItems: 'center'}}>
|
68
|
+
<Checkbox id={`sub-checkbox-1`} checked={false} onChange={() => {}} />
|
69
|
+
<Text as="label" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}} htmlFor={`sub-checkbox-1`}>
|
70
|
+
<Text sx={{display: 'block'}}>Checkbox 2</Text>
|
71
|
+
</Text>
|
72
|
+
</Box>
|
73
|
+
<Box key={`sub-checkbox-2`} as="form" sx={{p: 1, pl: 6, display: 'flex', alignItems: 'center'}}>
|
74
|
+
<Checkbox id={`sub-checkbox-2`} checked={false} onChange={() => {}} />
|
75
|
+
<Text as="label" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}} htmlFor={`sub-checkbox-2`}>
|
76
|
+
<Text sx={{display: 'block'}}>Checkbox 3</Text>
|
77
|
+
</Text>
|
78
|
+
</Box>
|
79
|
+
<Box key={`sub-checkbox-3`} as="form" sx={{p: 1, pl: 6, display: 'flex', alignItems: 'center'}}>
|
80
|
+
<Checkbox id={`sub-checkbox-3`} checked={false} onChange={() => {}} />
|
81
|
+
<Text as="label" sx={{fontSize: 2, fontWeight: 'bold', marginLeft: 1}} htmlFor={`sub-checkbox-3`}>
|
82
|
+
<Text sx={{display: 'block'}}>Checkbox 4</Text>
|
83
|
+
</Text>
|
84
|
+
</Box>
|
85
|
+
</>
|
86
|
+
```
|
87
|
+
|
88
|
+
## Component props
|
89
|
+
|
90
|
+
Native `<input>` attributes are forwarded to the underlying React `input` component and are not listed below.
|
91
|
+
|
92
|
+
| Name | Type | Default | Description |
|
93
|
+
| :------------- | :---------- | :-------: | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
94
|
+
| checked | Boolean | undefined | Optional. Modifies true/false value of the native checkbox |
|
95
|
+
| defaultChecked | Boolean | undefined | Optional. Checks the input by default in uncontrolled mode |
|
96
|
+
| onChange | ChangeEvent | undefined | Optional. A callback function that is triggered when the checked state has been changed. |
|
97
|
+
| disabled | Boolean | undefined | Optional. Modifies the native disabled state of the native checkbox |
|
98
|
+
| indeterminate | Boolean | undefined | Optional. Applies an [indeterminate](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#attr-indeterminate) state to the checkbox |
|
99
|
+
|
100
|
+
## Component status
|
101
|
+
|
102
|
+
<ComponentChecklist
|
103
|
+
items={{
|
104
|
+
propsDocumented: true,
|
105
|
+
noUnnecessaryDeps: true,
|
106
|
+
adaptsToThemes: true,
|
107
|
+
adaptsToScreenSizes: true,
|
108
|
+
fullTestCoverage: true,
|
109
|
+
usedInProduction: false,
|
110
|
+
usageExamplesDocumented: false,
|
111
|
+
designReviewed: false,
|
112
|
+
a11yReviewed: false,
|
113
|
+
stableApi: false,
|
114
|
+
addressedApiFeedback: false,
|
115
|
+
hasDesignGuidelines: false,
|
116
|
+
hasFigmaComponent: false
|
117
|
+
}}
|
118
|
+
/>
|
@@ -0,0 +1,36 @@
|
|
1
|
+
---
|
2
|
+
title: CircleBadge
|
3
|
+
status: Alpha
|
4
|
+
---
|
5
|
+
|
6
|
+
Use CircleBadge to visually connect logos of third party services like in marketplace. Use CircleBadge.Icon to add an Octicon to the CircleBadge.
|
7
|
+
|
8
|
+
## Default example
|
9
|
+
|
10
|
+
```jsx live
|
11
|
+
<CircleBadge>
|
12
|
+
<CircleBadge.Icon icon={ZapIcon} />
|
13
|
+
</CircleBadge>
|
14
|
+
```
|
15
|
+
|
16
|
+
## Component props
|
17
|
+
|
18
|
+
### CircleBadge
|
19
|
+
|
20
|
+
| Name | Type | Default | Description |
|
21
|
+
| :------ | :------ | :------: | :---------------------------------------------------------------------------------------------------------- |
|
22
|
+
| as | String | `div` | sets the HTML tag for the component |
|
23
|
+
| inline | Boolean | false | Styles the badge to display inline |
|
24
|
+
| size | Number | | sets the size of the badge in pixels; overrides any value for `variant` prop when set |
|
25
|
+
| variant | String | 'medium' | a value of `small`, `medium`, or `large` creates a smaller or larger badge; no effect if `size` prop is set |
|
26
|
+
|
27
|
+
### CircleBadge.Icon
|
28
|
+
|
29
|
+
CircleBadge.Icon components receive all the same props at [StyledOcticon]. They are listed below for convenience:
|
30
|
+
|
31
|
+
| Name | Type | Default | Description |
|
32
|
+
| :------------ | :-------- | :-----------: | :----------------------------------------------------------------------------------------------------------- |
|
33
|
+
| ariaLabel | String | | Specifies the `aria-label` attribute, which is read verbatim by screen readers |
|
34
|
+
| icon | Component | | [Octicon component](https://github.com/primer/octicons/tree/master/lib/octicons_react) used in the component |
|
35
|
+
| size | Number | 16 | Sets the uniform `width` and `height` of the SVG element |
|
36
|
+
| verticalAlign | String | `text-bottom` | Sets the `vertical-align` CSS property |
|
@@ -0,0 +1,19 @@
|
|
1
|
+
---
|
2
|
+
title: CircleOcticon
|
3
|
+
status: Alpha
|
4
|
+
---
|
5
|
+
|
6
|
+
CircleOcticon renders any Octicon with a circle background. CircleOcticons are most commonly used to represent the status of a pull request in the comment timeline.
|
7
|
+
|
8
|
+
## Default example
|
9
|
+
|
10
|
+
```jsx live
|
11
|
+
<CircleOcticon icon={CheckIcon} size={32} sx={{bg: 'success.fg', color: 'fg.onEmphasis'}} />
|
12
|
+
```
|
13
|
+
|
14
|
+
## Component props
|
15
|
+
|
16
|
+
| Name | Type | Default | Description |
|
17
|
+
| :--- | :------ | :-----: | :------------------------------------------------ |
|
18
|
+
| icon | Octicon | | Octicon component used in the component |
|
19
|
+
| size | Number | 32 | used to set the width and height of the component |
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: CounterLabel
|
3
|
+
status: Alpha
|
4
|
+
---
|
5
|
+
|
6
|
+
Use the CounterLabel component to add a count to navigational elements and buttons.
|
7
|
+
|
8
|
+
## Default example
|
9
|
+
|
10
|
+
```jsx live
|
11
|
+
<>
|
12
|
+
<CounterLabel>12</CounterLabel>
|
13
|
+
<CounterLabel scheme="primary">13</CounterLabel>
|
14
|
+
<CounterLabel scheme="secondary">13</CounterLabel>
|
15
|
+
</>
|
16
|
+
```
|
17
|
+
|
18
|
+
## Component props
|
19
|
+
|
20
|
+
| Name | Type | Default | Description |
|
21
|
+
| :----- | :----- | :-----: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
22
|
+
| scheme | String | | Pass in 'primary' for a darker background and inverse text, or 'gray-light' for a lighter background and primary text. Omitting the scheme prop renders the default counter scheme |
|
@@ -0,0 +1,102 @@
|
|
1
|
+
---
|
2
|
+
title: Details
|
3
|
+
status: Alpha
|
4
|
+
---
|
5
|
+
|
6
|
+
`Details` is a styled `details` element for use with the `useDetails` hook. The `useDetails` hook returns the `open` state, a `setOpen` function to manually change the open state, and **`getDetailsProps` which must be spread onto your `Details` element in order for `Details` to get receive the proper behaviors provided by the hook**. See Kent Dodd's article on this pattern [here](https://kentcdodds.com/blog/how-to-give-rendering-control-to-users-with-prop-getters).
|
7
|
+
|
8
|
+
The `useDetails` hook also takes a few configuration options as parameters which are noted in the table below.
|
9
|
+
|
10
|
+
You must use a `summary` element as your `Details` trigger button. To style your summary element like a [Button](./Button), you can use the `as` prop (see example below).
|
11
|
+
|
12
|
+
It's also possible to use the `useDetails` hook with components other than the Primer `Details`, such as a custom `Details` or `Modal` wrapper in your consuming application. All that matters is that the outer element is a `details` and it contains a `summary` for the button that opens and closes the component, and that `getDetailsProps` is properly spread onto the component rendering your `details` element.
|
13
|
+
|
14
|
+
```jsx live
|
15
|
+
<State>
|
16
|
+
{([]) => {
|
17
|
+
const {getDetailsProps} = useDetails({closeOnOutsideClick: true})
|
18
|
+
return (
|
19
|
+
<Details {...getDetailsProps()}>
|
20
|
+
<Button as="summary">Hello</Button>
|
21
|
+
This is some content
|
22
|
+
</Details>
|
23
|
+
)
|
24
|
+
}}
|
25
|
+
</State>
|
26
|
+
```
|
27
|
+
|
28
|
+
You can use the `open` state returned from the hook to conditionally render content:
|
29
|
+
|
30
|
+
```jsx live
|
31
|
+
<State>
|
32
|
+
{([]) => {
|
33
|
+
const {getDetailsProps, open} = useDetails({closeOnOutsideClick: true})
|
34
|
+
return (
|
35
|
+
<Details {...getDetailsProps()}>
|
36
|
+
<Button as="summary">{open ? 'open' : 'close'}</Button>
|
37
|
+
This is some content
|
38
|
+
</Details>
|
39
|
+
)
|
40
|
+
}}
|
41
|
+
</State>
|
42
|
+
```
|
43
|
+
|
44
|
+
You can also manually show/hide the content using the `setOpen` function returned from the hook. This can be useful if you have action items in the content of the component such as confirmation buttons:
|
45
|
+
|
46
|
+
```jsx live
|
47
|
+
<State>
|
48
|
+
{([]) => {
|
49
|
+
const {getDetailsProps, setOpen} = useDetails({closeOnOutsideClick: true})
|
50
|
+
return (
|
51
|
+
<Details {...getDetailsProps()}>
|
52
|
+
<Button as="summary">Delete item</Button>
|
53
|
+
Are you sure?
|
54
|
+
<ButtonDanger onClick={() => setOpen(false)}>Yes I'm sure</ButtonDanger>
|
55
|
+
</Details>
|
56
|
+
)
|
57
|
+
}}
|
58
|
+
</State>
|
59
|
+
```
|
60
|
+
|
61
|
+
In previous versions of Primer React Components, we allowed users to pass in a custom `onToggle` function. You can do this now by overriding the `onToggle` function returned in `getDetailsProps`. Please note that in most cases, you'll want the hook's handling of `onToggle` to be run as well, so that the internal state is properly updated. To do this, manually call the `onToggle` handler returned from `useDetails` before executing your custom `onToggle` code.
|
62
|
+
|
63
|
+
```jsx live
|
64
|
+
<State>
|
65
|
+
{([]) => {
|
66
|
+
const {getDetailsProps, open, setOpen} = useDetails({closeOnOutsideClick: true})
|
67
|
+
const {onToggle, ...detailsProps} = getDetailsProps()
|
68
|
+
const customToggle = e => {
|
69
|
+
onToggle(e)
|
70
|
+
window.alert('hi')
|
71
|
+
}
|
72
|
+
return (
|
73
|
+
<Details {...detailsProps} onToggle={customToggle}>
|
74
|
+
<Button as="summary">{open ? 'Open' : 'Closed'}</Button>
|
75
|
+
Hello World
|
76
|
+
</Details>
|
77
|
+
)
|
78
|
+
}}
|
79
|
+
</State>
|
80
|
+
```
|
81
|
+
|
82
|
+
## Details props
|
83
|
+
|
84
|
+
| Name | Type | Default | Description |
|
85
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
86
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
87
|
+
|
88
|
+
## `useDetails` hook configuration options
|
89
|
+
|
90
|
+
| Name | Type | Default | Description |
|
91
|
+
| :------------------ | :-------- | :-----: | :------------------------------------------------------------------------ |
|
92
|
+
| defaultOpen | Boolean | | Sets the initial open/closed state |
|
93
|
+
| closeOnOutsideClick | Boolean | false | Sets whether or not element will close when the user clicks outside of it |
|
94
|
+
| ref | React ref | | optional ref to pass down to Details component |
|
95
|
+
|
96
|
+
### Values returned by the `useDetails` hook
|
97
|
+
|
98
|
+
| Name | Type | Description |
|
99
|
+
| :-------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
100
|
+
| open | string | Whether or not Details is currently open |
|
101
|
+
| setOpen | function | Used to manually change the open state of the Details component |
|
102
|
+
| getDetailsProps | Object | Contains an `onToggle` function, the `ref` to pass down to `Details` and the `open` attribute. In most cases, you won't need to interact with any of these values directly, but if you'd like to override any of these yourself you may. |
|