@primer/components 33.1.0-rc.6856bcf5 → 33.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/package.json +1 -1
- package/.changeset/README.md +0 -8
- package/.changeset/config.json +0 -10
- package/.devcontainer/devcontainer.json +0 -8
- package/.eslintrc.json +0 -137
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -38
- package/.github/ISSUE_TEMPLATE/new_component_proposal_template.md +0 -41
- package/.github/dependabot.yml +0 -18
- package/.github/pull_request_template.md +0 -18
- package/.github/workflows/check_for_changeset.yml +0 -25
- package/.github/workflows/ci.yml +0 -31
- package/.github/workflows/deploy_preview.yml +0 -47
- package/.github/workflows/deploy_production.yml +0 -70
- package/.github/workflows/release.yml +0 -14
- package/.github/workflows/release_canary.yml +0 -14
- package/.github/workflows/release_candidate.yml +0 -14
- package/.github/workflows/size.yml +0 -13
- package/.github/workflows/stale.yml +0 -26
- package/.github/workflows/statuses.yml +0 -32
- package/.gitignore +0 -11
- package/.npmrc +0 -4
- package/.nvmrc +0 -1
- package/.storybook/main.js +0 -9
- package/.storybook/preview.js +0 -117
- package/.vscode/launch.json +0 -21
- package/.vscode/settings.json +0 -13
- package/@types/@styled-system/index.d.ts +0 -0
- package/@types/@styled-system/prop-types/index.d.ts +0 -1
- package/@types/@styled-system/props/index.d.ts +0 -1
- package/@types/jest-styled-components/index.d.ts +0 -1
- package/CHANGELOG.md +0 -1010
- package/CODEOWNERS +0 -2
- package/babel-defines.js +0 -13
- package/babel.config.js +0 -39
- package/contributor-docs/CODE_OF_CONDUCT.md +0 -76
- package/contributor-docs/CONTRIBUTING.md +0 -227
- package/contributor-docs/adrs/adr-001-typescript.md +0 -23
- package/contributor-docs/adrs/adr-002-behavior-isolation.md +0 -108
- package/contributor-docs/adrs/adr-003-prop-norms.md +0 -72
- package/contributor-docs/behaviors.md +0 -132
- package/contributor-docs/component-contents-api-patterns.md +0 -316
- package/contributor-docs/principles.md +0 -39
- package/docs/.eslintrc +0 -0
- package/docs/.gitignore +0 -91
- package/docs/components/PropsList.js +0 -5
- package/docs/components/State.js +0 -9
- package/docs/components/constants.js +0 -34
- package/docs/components/index.js +0 -2
- package/docs/content/ActionList.mdx +0 -99
- package/docs/content/ActionMenu.mdx +0 -80
- package/docs/content/AnchoredOverlay.mdx +0 -157
- package/docs/content/Autocomplete.mdx +0 -657
- package/docs/content/Avatar.mdx +0 -68
- package/docs/content/AvatarPair.mdx +0 -47
- package/docs/content/AvatarStack.mdx +0 -65
- package/docs/content/BorderBox.md +0 -46
- package/docs/content/Box.mdx +0 -98
- package/docs/content/BranchName.mdx +0 -52
- package/docs/content/Breadcrumbs.mdx +0 -76
- package/docs/content/Buttons.md +0 -47
- package/docs/content/Checkbox.md +0 -118
- package/docs/content/CircleBadge.md +0 -36
- package/docs/content/CircleOcticon.md +0 -19
- package/docs/content/CounterLabel.md +0 -22
- package/docs/content/Details.md +0 -102
- package/docs/content/Dialog.md +0 -106
- package/docs/content/Dialog2.mdx +0 -181
- package/docs/content/Dropdown.md +0 -66
- package/docs/content/DropdownMenu.mdx +0 -50
- package/docs/content/FilterList.md +0 -38
- package/docs/content/FilteredSearch.md +0 -33
- package/docs/content/Flash.md +0 -36
- package/docs/content/Flex.md +0 -58
- package/docs/content/FormGroup.md +0 -39
- package/docs/content/Grid.md +0 -59
- package/docs/content/Header.md +0 -78
- package/docs/content/Heading.md +0 -21
- package/docs/content/Label.md +0 -49
- package/docs/content/LabelGroup.md +0 -22
- package/docs/content/Link.mdx +0 -75
- package/docs/content/Overlay.mdx +0 -86
- package/docs/content/Pagehead.md +0 -19
- package/docs/content/Pagination.md +0 -179
- package/docs/content/PointerBox.md +0 -82
- package/docs/content/Popover.md +0 -130
- package/docs/content/Portal.mdx +0 -79
- package/docs/content/Position.md +0 -93
- package/docs/content/ProgressBar.mdx +0 -31
- package/docs/content/Radio.md +0 -90
- package/docs/content/SelectMenu.md +0 -372
- package/docs/content/SelectPanel.mdx +0 -67
- package/docs/content/SideNav.md +0 -172
- package/docs/content/Spinner.mdx +0 -32
- package/docs/content/StateLabel.md +0 -28
- package/docs/content/StyledOcticon.md +0 -27
- package/docs/content/SubNav.md +0 -101
- package/docs/content/TabNav.md +0 -43
- package/docs/content/Text.md +0 -32
- package/docs/content/TextInput.mdx +0 -125
- package/docs/content/TextInputWithTokens.mdx +0 -211
- package/docs/content/Timeline.md +0 -149
- package/docs/content/Token.mdx +0 -381
- package/docs/content/Tooltip.md +0 -33
- package/docs/content/Truncate.md +0 -56
- package/docs/content/UnderlineNav.md +0 -46
- package/docs/content/anchoredPosition.mdx +0 -163
- package/docs/content/core-concepts.md +0 -70
- package/docs/content/drafts/ActionList2.mdx +0 -484
- package/docs/content/drafts/ActionMenu2.mdx +0 -302
- package/docs/content/focusTrap.mdx +0 -103
- package/docs/content/focusZone.mdx +0 -145
- package/docs/content/getting-started.md +0 -138
- package/docs/content/index.md +0 -33
- package/docs/content/linting.md +0 -35
- package/docs/content/overriding-styles.mdx +0 -82
- package/docs/content/philosophy.md +0 -23
- package/docs/content/primer-theme.md +0 -89
- package/docs/content/ssr.mdx +0 -43
- package/docs/content/status.mdx +0 -10
- package/docs/content/system-props.mdx +0 -37
- package/docs/content/theme-reference.md +0 -16
- package/docs/content/theming.md +0 -272
- package/docs/content/useOnEscapePress.mdx +0 -56
- package/docs/content/useOnOutsideClick.mdx +0 -57
- package/docs/content/useOpenAndCloseFocus.mdx +0 -49
- package/docs/content/useOverlay.mdx +0 -62
- package/docs/content/useSafeTimeout.mdx +0 -32
- package/docs/gatsby-config.js +0 -30
- package/docs/gatsby-node.js +0 -101
- package/docs/package-lock.json +0 -20867
- package/docs/package.json +0 -36
- package/docs/src/@primer/gatsby-theme-doctocat/components/hero.js +0 -21
- package/docs/src/@primer/gatsby-theme-doctocat/components/live-preview-wrapper.js +0 -41
- package/docs/src/@primer/gatsby-theme-doctocat/live-code-scope.js +0 -81
- package/docs/src/@primer/gatsby-theme-doctocat/mdx-components.js +0 -22
- package/docs/src/@primer/gatsby-theme-doctocat/nav.yml +0 -141
- package/docs/src/@primer/gatsby-theme-doctocat/primer-components-hero.svg +0 -1411
- package/docs/src/component-checklist.js +0 -89
- package/docs/src/component-statuses.js +0 -74
- package/docs/src/props-table.js +0 -165
- package/docs/src/props.js +0 -63
- package/jest.config.js +0 -13
- package/lib/__tests__/ActionList.test.d.ts +0 -1
- package/lib/__tests__/ActionList.test.js +0 -69
- package/lib/__tests__/ActionList.types.test.d.ts +0 -6
- package/lib/__tests__/ActionList.types.test.js +0 -69
- package/lib/__tests__/ActionList2.test.d.ts +0 -2
- package/lib/__tests__/ActionList2.test.js +0 -170
- package/lib/__tests__/ActionMenu.test.d.ts +0 -1
- package/lib/__tests__/ActionMenu.test.js +0 -151
- package/lib/__tests__/AnchoredOverlay.test.d.ts +0 -1
- package/lib/__tests__/AnchoredOverlay.test.js +0 -162
- package/lib/__tests__/Autocomplete.test.d.ts +0 -1
- package/lib/__tests__/Autocomplete.test.js +0 -528
- package/lib/__tests__/Avatar.test.d.ts +0 -1
- package/lib/__tests__/Avatar.test.js +0 -69
- package/lib/__tests__/Avatar.types.test.d.ts +0 -3
- package/lib/__tests__/Avatar.types.test.js +0 -31
- package/lib/__tests__/AvatarStack.test.d.ts +0 -1
- package/lib/__tests__/AvatarStack.test.js +0 -71
- package/lib/__tests__/BorderBox.test.d.ts +0 -1
- package/lib/__tests__/BorderBox.test.js +0 -58
- package/lib/__tests__/Box.test.d.ts +0 -1
- package/lib/__tests__/Box.test.js +0 -78
- package/lib/__tests__/BranchName.test.d.ts +0 -1
- package/lib/__tests__/BranchName.test.js +0 -36
- package/lib/__tests__/BranchName.types.test.d.ts +0 -3
- package/lib/__tests__/BranchName.types.test.js +0 -28
- package/lib/__tests__/Breadcrumbs.test.d.ts +0 -1
- package/lib/__tests__/Breadcrumbs.test.js +0 -40
- package/lib/__tests__/Breadcrumbs.types.test.d.ts +0 -3
- package/lib/__tests__/Breadcrumbs.types.test.js +0 -25
- package/lib/__tests__/BreadcrumbsItem.test.d.ts +0 -1
- package/lib/__tests__/BreadcrumbsItem.test.js +0 -49
- package/lib/__tests__/Button.test.d.ts +0 -1
- package/lib/__tests__/Button.test.js +0 -147
- package/lib/__tests__/Caret.test.d.ts +0 -1
- package/lib/__tests__/Caret.test.js +0 -52
- package/lib/__tests__/Checkbox.test.d.ts +0 -2
- package/lib/__tests__/Checkbox.test.js +0 -189
- package/lib/__tests__/CircleBadge.test.d.ts +0 -1
- package/lib/__tests__/CircleBadge.test.js +0 -83
- package/lib/__tests__/CircleBadge.types.test.d.ts +0 -3
- package/lib/__tests__/CircleBadge.types.test.js +0 -28
- package/lib/__tests__/CircleOcticon.test.d.ts +0 -1
- package/lib/__tests__/CircleOcticon.test.js +0 -71
- package/lib/__tests__/ConfirmationDialog.test.d.ts +0 -1
- package/lib/__tests__/ConfirmationDialog.test.js +0 -134
- package/lib/__tests__/CounterLabel.test.d.ts +0 -1
- package/lib/__tests__/CounterLabel.test.js +0 -58
- package/lib/__tests__/CounterLabel.types.test.d.ts +0 -3
- package/lib/__tests__/CounterLabel.types.test.js +0 -28
- package/lib/__tests__/Details.test.d.ts +0 -1
- package/lib/__tests__/Details.test.js +0 -117
- package/lib/__tests__/Details.types.test.d.ts +0 -3
- package/lib/__tests__/Details.types.test.js +0 -28
- package/lib/__tests__/Dialog.test.d.ts +0 -1
- package/lib/__tests__/Dialog.test.js +0 -184
- package/lib/__tests__/Dialog.types.test.d.ts +0 -3
- package/lib/__tests__/Dialog.types.test.js +0 -28
- package/lib/__tests__/Dialog2.types.test.d.ts +0 -3
- package/lib/__tests__/Dialog2.types.test.js +0 -31
- package/lib/__tests__/Dropdown.test.d.ts +0 -1
- package/lib/__tests__/Dropdown.test.js +0 -63
- package/lib/__tests__/Dropdown.types.test.d.ts +0 -3
- package/lib/__tests__/Dropdown.types.test.js +0 -31
- package/lib/__tests__/DropdownMenu.test.d.ts +0 -1
- package/lib/__tests__/DropdownMenu.test.js +0 -150
- package/lib/__tests__/FilterList.test.d.ts +0 -1
- package/lib/__tests__/FilterList.test.js +0 -36
- package/lib/__tests__/FilterList.types.test.d.ts +0 -3
- package/lib/__tests__/FilterList.types.test.js +0 -27
- package/lib/__tests__/FilterListItem.test.d.ts +0 -1
- package/lib/__tests__/FilterListItem.test.js +0 -46
- package/lib/__tests__/FilteredSearch.test.d.ts +0 -1
- package/lib/__tests__/FilteredSearch.test.js +0 -36
- package/lib/__tests__/FilteredSearch.types.test.d.ts +0 -3
- package/lib/__tests__/FilteredSearch.types.test.js +0 -28
- package/lib/__tests__/Flash.test.d.ts +0 -1
- package/lib/__tests__/Flash.test.js +0 -62
- package/lib/__tests__/Flash.types.test.d.ts +0 -3
- package/lib/__tests__/Flash.types.test.js +0 -28
- package/lib/__tests__/Flex.test.d.ts +0 -1
- package/lib/__tests__/Flex.test.js +0 -74
- package/lib/__tests__/FormGroup.test.d.ts +0 -1
- package/lib/__tests__/FormGroup.test.js +0 -54
- package/lib/__tests__/FormGroup.types.test.d.ts +0 -3
- package/lib/__tests__/FormGroup.types.test.js +0 -28
- package/lib/__tests__/Grid.test.d.ts +0 -1
- package/lib/__tests__/Grid.test.js +0 -104
- package/lib/__tests__/Header.test.d.ts +0 -1
- package/lib/__tests__/Header.test.js +0 -58
- package/lib/__tests__/Header.types.test.d.ts +0 -3
- package/lib/__tests__/Header.types.test.js +0 -29
- package/lib/__tests__/Heading.test.d.ts +0 -1
- package/lib/__tests__/Heading.test.js +0 -142
- package/lib/__tests__/Heading.types.test.d.ts +0 -3
- package/lib/__tests__/Heading.types.test.js +0 -28
- package/lib/__tests__/KeyPaths.types.test.d.ts +0 -11
- package/lib/__tests__/KeyPaths.types.test.js +0 -10
- package/lib/__tests__/Label.test.d.ts +0 -1
- package/lib/__tests__/Label.test.js +0 -46
- package/lib/__tests__/Label.types.test.d.ts +0 -3
- package/lib/__tests__/Label.types.test.js +0 -28
- package/lib/__tests__/LabelGroup.test.d.ts +0 -1
- package/lib/__tests__/LabelGroup.test.js +0 -38
- package/lib/__tests__/LabelGroup.types.test.d.ts +0 -3
- package/lib/__tests__/LabelGroup.types.test.js +0 -28
- package/lib/__tests__/Link.test.d.ts +0 -1
- package/lib/__tests__/Link.test.js +0 -76
- package/lib/__tests__/Link.types.test.d.ts +0 -3
- package/lib/__tests__/Link.types.test.js +0 -28
- package/lib/__tests__/Merge.types.test.d.ts +0 -30
- package/lib/__tests__/Merge.types.test.js +0 -27
- package/lib/__tests__/NewButton.test.d.ts +0 -1
- package/lib/__tests__/NewButton.test.js +0 -95
- package/lib/__tests__/Overlay.test.d.ts +0 -1
- package/lib/__tests__/Overlay.test.js +0 -145
- package/lib/__tests__/Overlay.types.test.d.ts +0 -6
- package/lib/__tests__/Overlay.types.test.js +0 -73
- package/lib/__tests__/Pagehead.test.d.ts +0 -1
- package/lib/__tests__/Pagehead.test.js +0 -37
- package/lib/__tests__/Pagehead.types.test.d.ts +0 -3
- package/lib/__tests__/Pagehead.types.test.js +0 -28
- package/lib/__tests__/Pagination/Pagination.test.d.ts +0 -1
- package/lib/__tests__/Pagination/Pagination.test.js +0 -47
- package/lib/__tests__/Pagination/PaginationModel.test.d.ts +0 -1
- package/lib/__tests__/Pagination/PaginationModel.test.js +0 -186
- package/lib/__tests__/Pagination.types.test.d.ts +0 -3
- package/lib/__tests__/Pagination.types.test.js +0 -33
- package/lib/__tests__/PointerBox.test.d.ts +0 -1
- package/lib/__tests__/PointerBox.test.js +0 -46
- package/lib/__tests__/Popover.test.d.ts +0 -1
- package/lib/__tests__/Popover.test.js +0 -66
- package/lib/__tests__/Popover.types.test.d.ts +0 -3
- package/lib/__tests__/Popover.types.test.js +0 -27
- package/lib/__tests__/Portal.test.d.ts +0 -1
- package/lib/__tests__/Portal.test.js +0 -124
- package/lib/__tests__/Position.test.d.ts +0 -1
- package/lib/__tests__/Position.test.js +0 -143
- package/lib/__tests__/ProgressBar.test.d.ts +0 -1
- package/lib/__tests__/ProgressBar.test.js +0 -68
- package/lib/__tests__/Radio.test.d.ts +0 -2
- package/lib/__tests__/Radio.test.js +0 -202
- package/lib/__tests__/SelectMenu.test.d.ts +0 -1
- package/lib/__tests__/SelectMenu.test.js +0 -155
- package/lib/__tests__/SelectMenu.types.test.d.ts +0 -3
- package/lib/__tests__/SelectMenu.types.test.js +0 -47
- package/lib/__tests__/SelectPanel.test.d.ts +0 -1
- package/lib/__tests__/SelectPanel.test.js +0 -80
- package/lib/__tests__/SelectPanel.types.test.d.ts +0 -3
- package/lib/__tests__/SelectPanel.types.test.js +0 -44
- package/lib/__tests__/SideNav.test.d.ts +0 -1
- package/lib/__tests__/SideNav.test.js +0 -71
- package/lib/__tests__/SideNav.types.test.d.ts +0 -3
- package/lib/__tests__/SideNav.types.test.js +0 -28
- package/lib/__tests__/Spinner.test.d.ts +0 -1
- package/lib/__tests__/Spinner.test.js +0 -53
- package/lib/__tests__/StateLabel.test.d.ts +0 -1
- package/lib/__tests__/StateLabel.test.js +0 -71
- package/lib/__tests__/StateLabel.types.test.d.ts +0 -3
- package/lib/__tests__/StateLabel.types.test.js +0 -28
- package/lib/__tests__/StyledOcticon.test.d.ts +0 -1
- package/lib/__tests__/StyledOcticon.test.js +0 -40
- package/lib/__tests__/StyledOcticon.types.test.d.ts +0 -3
- package/lib/__tests__/StyledOcticon.types.test.js +0 -32
- package/lib/__tests__/SubNav.test.d.ts +0 -1
- package/lib/__tests__/SubNav.test.js +0 -62
- package/lib/__tests__/SubNav.types.test.d.ts +0 -3
- package/lib/__tests__/SubNav.types.test.js +0 -27
- package/lib/__tests__/SubNavLink.test.d.ts +0 -1
- package/lib/__tests__/SubNavLink.test.js +0 -49
- package/lib/__tests__/TabNav.test.d.ts +0 -1
- package/lib/__tests__/TabNav.test.js +0 -49
- package/lib/__tests__/TabNav.types.test.d.ts +0 -3
- package/lib/__tests__/TabNav.types.test.js +0 -25
- package/lib/__tests__/Text.test.d.ts +0 -1
- package/lib/__tests__/Text.test.js +0 -105
- package/lib/__tests__/TextInput.test.d.ts +0 -1
- package/lib/__tests__/TextInput.test.js +0 -78
- package/lib/__tests__/TextInputWithTokens.test.d.ts +0 -1
- package/lib/__tests__/TextInputWithTokens.test.js +0 -572
- package/lib/__tests__/ThemeProvider.test.d.ts +0 -1
- package/lib/__tests__/ThemeProvider.test.js +0 -558
- package/lib/__tests__/Timeline.test.d.ts +0 -1
- package/lib/__tests__/Timeline.test.js +0 -75
- package/lib/__tests__/Timeline.types.test.d.ts +0 -3
- package/lib/__tests__/Timeline.types.test.js +0 -31
- package/lib/__tests__/Token.test.d.ts +0 -1
- package/lib/__tests__/Token.test.js +0 -180
- package/lib/__tests__/Tooltip.test.d.ts +0 -1
- package/lib/__tests__/Tooltip.test.js +0 -69
- package/lib/__tests__/Tooltip.types.test.d.ts +0 -3
- package/lib/__tests__/Tooltip.types.test.js +0 -28
- package/lib/__tests__/Truncate.test.d.ts +0 -1
- package/lib/__tests__/Truncate.test.js +0 -63
- package/lib/__tests__/Truncate.types.test.d.ts +0 -3
- package/lib/__tests__/Truncate.types.test.js +0 -31
- package/lib/__tests__/UnderlineNav.test.d.ts +0 -1
- package/lib/__tests__/UnderlineNav.test.js +0 -72
- package/lib/__tests__/UnderlineNav.types.test.d.ts +0 -3
- package/lib/__tests__/UnderlineNav.types.test.js +0 -25
- package/lib/__tests__/UnderlineNavLink.test.d.ts +0 -1
- package/lib/__tests__/UnderlineNavLink.test.js +0 -51
- package/lib/__tests__/behaviors/anchoredPosition.test.d.ts +0 -1
- package/lib/__tests__/behaviors/anchoredPosition.test.js +0 -390
- package/lib/__tests__/behaviors/focusTrap.test.d.ts +0 -1
- package/lib/__tests__/behaviors/focusTrap.test.js +0 -234
- package/lib/__tests__/behaviors/focusZone.test.d.ts +0 -1
- package/lib/__tests__/behaviors/focusZone.test.js +0 -570
- package/lib/__tests__/behaviors/iterateFocusableElements.test.d.ts +0 -1
- package/lib/__tests__/behaviors/iterateFocusableElements.test.js +0 -55
- package/lib/__tests__/behaviors/scrollIntoViewingArea.test.d.ts +0 -1
- package/lib/__tests__/behaviors/scrollIntoViewingArea.test.js +0 -226
- package/lib/__tests__/filterObject.test.d.ts +0 -1
- package/lib/__tests__/filterObject.test.js +0 -30
- package/lib/__tests__/hooks/useAnchoredPosition.test.d.ts +0 -1
- package/lib/__tests__/hooks/useAnchoredPosition.test.js +0 -54
- package/lib/__tests__/hooks/useOnEscapePress.test.d.ts +0 -1
- package/lib/__tests__/hooks/useOnEscapePress.test.js +0 -32
- package/lib/__tests__/hooks/useOnOutsideClick.test.d.ts +0 -1
- package/lib/__tests__/hooks/useOnOutsideClick.test.js +0 -87
- package/lib/__tests__/hooks/useOpenAndCloseFocus.test.d.ts +0 -1
- package/lib/__tests__/hooks/useOpenAndCloseFocus.test.js +0 -60
- package/lib/__tests__/hooks/useProvidedStateOrCreate.test.d.ts +0 -1
- package/lib/__tests__/hooks/useProvidedStateOrCreate.test.js +0 -45
- package/lib/__tests__/theme.test.d.ts +0 -1
- package/lib/__tests__/theme.test.js +0 -36
- package/lib/__tests__/themeGet.test.d.ts +0 -1
- package/lib/__tests__/themeGet.test.js +0 -25
- package/lib/__tests__/themePreval.test.d.ts +0 -1
- package/lib/__tests__/themePreval.test.js +0 -14
- package/lib/__tests__/useSafeTimeout.test.d.ts +0 -1
- package/lib/__tests__/useSafeTimeout.test.js +0 -45
- package/lib/__tests__/utils/createSlots.test.d.ts +0 -1
- package/lib/__tests__/utils/createSlots.test.js +0 -75
- package/lib/stories/ActionList.stories.js +0 -454
- package/lib/stories/ActionList2.stories.js +0 -923
- package/lib/stories/ActionMenu.stories.js +0 -348
- package/lib/stories/ActionMenu2.stories.js +0 -455
- package/lib/stories/AnchoredOverlay.stories.js +0 -127
- package/lib/stories/Autocomplete.stories.js +0 -619
- package/lib/stories/AvatarStack.stories.js +0 -49
- package/lib/stories/Button.stories.js +0 -125
- package/lib/stories/Checkbox.stories.js +0 -227
- package/lib/stories/ConfirmationDialog.stories.js +0 -119
- package/lib/stories/Dialog.stories.js +0 -269
- package/lib/stories/DropdownMenu.stories.js +0 -122
- package/lib/stories/IssueLabelToken.stories.js +0 -165
- package/lib/stories/NewButton.stories.js +0 -230
- package/lib/stories/Overlay.stories.js +0 -204
- package/lib/stories/Portal.stories.js +0 -104
- package/lib/stories/ProfileToken.stories.js +0 -162
- package/lib/stories/Radio.stories.js +0 -146
- package/lib/stories/SelectPanel.stories.js +0 -399
- package/lib/stories/TextInput.stories.js +0 -144
- package/lib/stories/TextInputWithTokens.stories.js +0 -252
- package/lib/stories/ThemeProvider.stories.js +0 -98
- package/lib/stories/Token.stories.js +0 -176
- package/lib/stories/useAnchoredPosition.stories.js +0 -351
- package/lib/stories/useFocusTrap.stories.js +0 -350
- package/lib/stories/useFocusZone.stories.js +0 -603
- package/lib-esm/__tests__/ActionList.test.d.ts +0 -1
- package/lib-esm/__tests__/ActionList.test.js +0 -57
- package/lib-esm/__tests__/ActionList.types.test.d.ts +0 -6
- package/lib-esm/__tests__/ActionList.types.test.js +0 -45
- package/lib-esm/__tests__/ActionList2.test.d.ts +0 -2
- package/lib-esm/__tests__/ActionList2.test.js +0 -144
- package/lib-esm/__tests__/ActionMenu.test.d.ts +0 -1
- package/lib-esm/__tests__/ActionMenu.test.js +0 -139
- package/lib-esm/__tests__/AnchoredOverlay.test.d.ts +0 -1
- package/lib-esm/__tests__/AnchoredOverlay.test.js +0 -136
- package/lib-esm/__tests__/Autocomplete.test.d.ts +0 -1
- package/lib-esm/__tests__/Autocomplete.test.js +0 -494
- package/lib-esm/__tests__/Avatar.test.d.ts +0 -1
- package/lib-esm/__tests__/Avatar.test.js +0 -58
- package/lib-esm/__tests__/Avatar.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Avatar.types.test.js +0 -16
- package/lib-esm/__tests__/AvatarStack.test.d.ts +0 -1
- package/lib-esm/__tests__/AvatarStack.test.js +0 -58
- package/lib-esm/__tests__/BorderBox.test.d.ts +0 -1
- package/lib-esm/__tests__/BorderBox.test.js +0 -47
- package/lib-esm/__tests__/Box.test.d.ts +0 -1
- package/lib-esm/__tests__/Box.test.js +0 -67
- package/lib-esm/__tests__/BranchName.test.d.ts +0 -1
- package/lib-esm/__tests__/BranchName.test.js +0 -26
- package/lib-esm/__tests__/BranchName.types.test.d.ts +0 -3
- package/lib-esm/__tests__/BranchName.types.test.js +0 -13
- package/lib-esm/__tests__/Breadcrumbs.test.d.ts +0 -1
- package/lib-esm/__tests__/Breadcrumbs.test.js +0 -30
- package/lib-esm/__tests__/Breadcrumbs.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Breadcrumbs.types.test.js +0 -12
- package/lib-esm/__tests__/BreadcrumbsItem.test.d.ts +0 -1
- package/lib-esm/__tests__/BreadcrumbsItem.test.js +0 -39
- package/lib-esm/__tests__/Button.test.d.ts +0 -1
- package/lib-esm/__tests__/Button.test.js +0 -137
- package/lib-esm/__tests__/Caret.test.d.ts +0 -1
- package/lib-esm/__tests__/Caret.test.js +0 -42
- package/lib-esm/__tests__/Checkbox.test.d.ts +0 -2
- package/lib-esm/__tests__/Checkbox.test.js +0 -169
- package/lib-esm/__tests__/CircleBadge.test.d.ts +0 -1
- package/lib-esm/__tests__/CircleBadge.test.js +0 -70
- package/lib-esm/__tests__/CircleBadge.types.test.d.ts +0 -3
- package/lib-esm/__tests__/CircleBadge.types.test.js +0 -13
- package/lib-esm/__tests__/CircleOcticon.test.d.ts +0 -1
- package/lib-esm/__tests__/CircleOcticon.test.js +0 -59
- package/lib-esm/__tests__/ConfirmationDialog.test.d.ts +0 -1
- package/lib-esm/__tests__/ConfirmationDialog.test.js +0 -113
- package/lib-esm/__tests__/CounterLabel.test.d.ts +0 -1
- package/lib-esm/__tests__/CounterLabel.test.js +0 -47
- package/lib-esm/__tests__/CounterLabel.types.test.d.ts +0 -3
- package/lib-esm/__tests__/CounterLabel.types.test.js +0 -13
- package/lib-esm/__tests__/Details.test.d.ts +0 -1
- package/lib-esm/__tests__/Details.test.js +0 -107
- package/lib-esm/__tests__/Details.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Details.types.test.js +0 -13
- package/lib-esm/__tests__/Dialog.test.d.ts +0 -1
- package/lib-esm/__tests__/Dialog.test.js +0 -171
- package/lib-esm/__tests__/Dialog.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Dialog.types.test.js +0 -13
- package/lib-esm/__tests__/Dialog2.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Dialog2.types.test.js +0 -16
- package/lib-esm/__tests__/Dropdown.test.d.ts +0 -1
- package/lib-esm/__tests__/Dropdown.test.js +0 -53
- package/lib-esm/__tests__/Dropdown.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Dropdown.types.test.js +0 -17
- package/lib-esm/__tests__/DropdownMenu.test.d.ts +0 -1
- package/lib-esm/__tests__/DropdownMenu.test.js +0 -137
- package/lib-esm/__tests__/FilterList.test.d.ts +0 -1
- package/lib-esm/__tests__/FilterList.test.js +0 -26
- package/lib-esm/__tests__/FilterList.types.test.d.ts +0 -3
- package/lib-esm/__tests__/FilterList.types.test.js +0 -13
- package/lib-esm/__tests__/FilterListItem.test.d.ts +0 -1
- package/lib-esm/__tests__/FilterListItem.test.js +0 -36
- package/lib-esm/__tests__/FilteredSearch.test.d.ts +0 -1
- package/lib-esm/__tests__/FilteredSearch.test.js +0 -26
- package/lib-esm/__tests__/FilteredSearch.types.test.d.ts +0 -3
- package/lib-esm/__tests__/FilteredSearch.types.test.js +0 -13
- package/lib-esm/__tests__/Flash.test.d.ts +0 -1
- package/lib-esm/__tests__/Flash.test.js +0 -51
- package/lib-esm/__tests__/Flash.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Flash.types.test.js +0 -13
- package/lib-esm/__tests__/Flex.test.d.ts +0 -1
- package/lib-esm/__tests__/Flex.test.js +0 -64
- package/lib-esm/__tests__/FormGroup.test.d.ts +0 -1
- package/lib-esm/__tests__/FormGroup.test.js +0 -44
- package/lib-esm/__tests__/FormGroup.types.test.d.ts +0 -3
- package/lib-esm/__tests__/FormGroup.types.test.js +0 -13
- package/lib-esm/__tests__/Grid.test.d.ts +0 -1
- package/lib-esm/__tests__/Grid.test.js +0 -94
- package/lib-esm/__tests__/Header.test.d.ts +0 -1
- package/lib-esm/__tests__/Header.test.js +0 -48
- package/lib-esm/__tests__/Header.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Header.types.test.js +0 -15
- package/lib-esm/__tests__/Heading.test.d.ts +0 -1
- package/lib-esm/__tests__/Heading.test.js +0 -131
- package/lib-esm/__tests__/Heading.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Heading.types.test.js +0 -13
- package/lib-esm/__tests__/KeyPaths.types.test.d.ts +0 -11
- package/lib-esm/__tests__/KeyPaths.types.test.js +0 -3
- package/lib-esm/__tests__/Label.test.d.ts +0 -1
- package/lib-esm/__tests__/Label.test.js +0 -36
- package/lib-esm/__tests__/Label.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Label.types.test.js +0 -13
- package/lib-esm/__tests__/LabelGroup.test.d.ts +0 -1
- package/lib-esm/__tests__/LabelGroup.test.js +0 -26
- package/lib-esm/__tests__/LabelGroup.types.test.d.ts +0 -3
- package/lib-esm/__tests__/LabelGroup.types.test.js +0 -13
- package/lib-esm/__tests__/Link.test.d.ts +0 -1
- package/lib-esm/__tests__/Link.test.js +0 -66
- package/lib-esm/__tests__/Link.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Link.types.test.js +0 -13
- package/lib-esm/__tests__/Merge.types.test.d.ts +0 -30
- package/lib-esm/__tests__/Merge.types.test.js +0 -14
- package/lib-esm/__tests__/NewButton.test.d.ts +0 -1
- package/lib-esm/__tests__/NewButton.test.js +0 -84
- package/lib-esm/__tests__/Overlay.test.d.ts +0 -1
- package/lib-esm/__tests__/Overlay.test.js +0 -123
- package/lib-esm/__tests__/Overlay.types.test.d.ts +0 -6
- package/lib-esm/__tests__/Overlay.types.test.js +0 -49
- package/lib-esm/__tests__/Pagehead.test.d.ts +0 -1
- package/lib-esm/__tests__/Pagehead.test.js +0 -26
- package/lib-esm/__tests__/Pagehead.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Pagehead.types.test.js +0 -13
- package/lib-esm/__tests__/Pagination/Pagination.test.d.ts +0 -1
- package/lib-esm/__tests__/Pagination/Pagination.test.js +0 -35
- package/lib-esm/__tests__/Pagination/PaginationModel.test.d.ts +0 -1
- package/lib-esm/__tests__/Pagination/PaginationModel.test.js +0 -182
- package/lib-esm/__tests__/Pagination.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Pagination.types.test.js +0 -18
- package/lib-esm/__tests__/PointerBox.test.d.ts +0 -1
- package/lib-esm/__tests__/PointerBox.test.js +0 -36
- package/lib-esm/__tests__/Popover.test.d.ts +0 -1
- package/lib-esm/__tests__/Popover.test.js +0 -53
- package/lib-esm/__tests__/Popover.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Popover.types.test.js +0 -13
- package/lib-esm/__tests__/Portal.test.d.ts +0 -1
- package/lib-esm/__tests__/Portal.test.js +0 -104
- package/lib-esm/__tests__/Position.test.d.ts +0 -1
- package/lib-esm/__tests__/Position.test.js +0 -133
- package/lib-esm/__tests__/ProgressBar.test.d.ts +0 -1
- package/lib-esm/__tests__/ProgressBar.test.js +0 -58
- package/lib-esm/__tests__/Radio.test.d.ts +0 -2
- package/lib-esm/__tests__/Radio.test.js +0 -183
- package/lib-esm/__tests__/SelectMenu.test.d.ts +0 -1
- package/lib-esm/__tests__/SelectMenu.test.js +0 -145
- package/lib-esm/__tests__/SelectMenu.types.test.d.ts +0 -3
- package/lib-esm/__tests__/SelectMenu.types.test.js +0 -33
- package/lib-esm/__tests__/SelectPanel.test.d.ts +0 -1
- package/lib-esm/__tests__/SelectPanel.test.js +0 -65
- package/lib-esm/__tests__/SelectPanel.types.test.d.ts +0 -3
- package/lib-esm/__tests__/SelectPanel.types.test.js +0 -29
- package/lib-esm/__tests__/SideNav.test.d.ts +0 -1
- package/lib-esm/__tests__/SideNav.test.js +0 -60
- package/lib-esm/__tests__/SideNav.types.test.d.ts +0 -3
- package/lib-esm/__tests__/SideNav.types.test.js +0 -13
- package/lib-esm/__tests__/Spinner.test.d.ts +0 -1
- package/lib-esm/__tests__/Spinner.test.js +0 -43
- package/lib-esm/__tests__/StateLabel.test.d.ts +0 -1
- package/lib-esm/__tests__/StateLabel.test.js +0 -61
- package/lib-esm/__tests__/StateLabel.types.test.d.ts +0 -3
- package/lib-esm/__tests__/StateLabel.types.test.js +0 -13
- package/lib-esm/__tests__/StyledOcticon.test.d.ts +0 -1
- package/lib-esm/__tests__/StyledOcticon.test.js +0 -29
- package/lib-esm/__tests__/StyledOcticon.types.test.d.ts +0 -3
- package/lib-esm/__tests__/StyledOcticon.types.test.js +0 -16
- package/lib-esm/__tests__/SubNav.test.d.ts +0 -1
- package/lib-esm/__tests__/SubNav.test.js +0 -50
- package/lib-esm/__tests__/SubNav.types.test.d.ts +0 -3
- package/lib-esm/__tests__/SubNav.types.test.js +0 -14
- package/lib-esm/__tests__/SubNavLink.test.d.ts +0 -1
- package/lib-esm/__tests__/SubNavLink.test.js +0 -39
- package/lib-esm/__tests__/TabNav.test.d.ts +0 -1
- package/lib-esm/__tests__/TabNav.test.js +0 -39
- package/lib-esm/__tests__/TabNav.types.test.d.ts +0 -3
- package/lib-esm/__tests__/TabNav.types.test.js +0 -12
- package/lib-esm/__tests__/Text.test.d.ts +0 -1
- package/lib-esm/__tests__/Text.test.js +0 -93
- package/lib-esm/__tests__/TextInput.test.d.ts +0 -1
- package/lib-esm/__tests__/TextInput.test.js +0 -68
- package/lib-esm/__tests__/TextInputWithTokens.test.d.ts +0 -1
- package/lib-esm/__tests__/TextInputWithTokens.test.js +0 -511
- package/lib-esm/__tests__/ThemeProvider.test.d.ts +0 -1
- package/lib-esm/__tests__/ThemeProvider.test.js +0 -522
- package/lib-esm/__tests__/Timeline.test.d.ts +0 -1
- package/lib-esm/__tests__/Timeline.test.js +0 -65
- package/lib-esm/__tests__/Timeline.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Timeline.types.test.js +0 -18
- package/lib-esm/__tests__/Token.test.d.ts +0 -1
- package/lib-esm/__tests__/Token.test.js +0 -166
- package/lib-esm/__tests__/Tooltip.test.d.ts +0 -1
- package/lib-esm/__tests__/Tooltip.test.js +0 -59
- package/lib-esm/__tests__/Tooltip.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Tooltip.types.test.js +0 -13
- package/lib-esm/__tests__/Truncate.test.d.ts +0 -1
- package/lib-esm/__tests__/Truncate.test.js +0 -53
- package/lib-esm/__tests__/Truncate.types.test.d.ts +0 -3
- package/lib-esm/__tests__/Truncate.types.test.js +0 -16
- package/lib-esm/__tests__/UnderlineNav.test.d.ts +0 -1
- package/lib-esm/__tests__/UnderlineNav.test.js +0 -60
- package/lib-esm/__tests__/UnderlineNav.types.test.d.ts +0 -3
- package/lib-esm/__tests__/UnderlineNav.types.test.js +0 -12
- package/lib-esm/__tests__/UnderlineNavLink.test.d.ts +0 -1
- package/lib-esm/__tests__/UnderlineNavLink.test.js +0 -41
- package/lib-esm/__tests__/behaviors/anchoredPosition.test.d.ts +0 -1
- package/lib-esm/__tests__/behaviors/anchoredPosition.test.js +0 -388
- package/lib-esm/__tests__/behaviors/focusTrap.test.d.ts +0 -1
- package/lib-esm/__tests__/behaviors/focusTrap.test.js +0 -227
- package/lib-esm/__tests__/behaviors/focusZone.test.d.ts +0 -1
- package/lib-esm/__tests__/behaviors/focusZone.test.js +0 -487
- package/lib-esm/__tests__/behaviors/iterateFocusableElements.test.d.ts +0 -1
- package/lib-esm/__tests__/behaviors/iterateFocusableElements.test.js +0 -48
- package/lib-esm/__tests__/behaviors/scrollIntoViewingArea.test.d.ts +0 -1
- package/lib-esm/__tests__/behaviors/scrollIntoViewingArea.test.js +0 -224
- package/lib-esm/__tests__/filterObject.test.d.ts +0 -1
- package/lib-esm/__tests__/filterObject.test.js +0 -27
- package/lib-esm/__tests__/hooks/useAnchoredPosition.test.d.ts +0 -1
- package/lib-esm/__tests__/hooks/useAnchoredPosition.test.js +0 -46
- package/lib-esm/__tests__/hooks/useOnEscapePress.test.d.ts +0 -1
- package/lib-esm/__tests__/hooks/useOnEscapePress.test.js +0 -23
- package/lib-esm/__tests__/hooks/useOnOutsideClick.test.d.ts +0 -1
- package/lib-esm/__tests__/hooks/useOnOutsideClick.test.js +0 -68
- package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.test.d.ts +0 -1
- package/lib-esm/__tests__/hooks/useOpenAndCloseFocus.test.js +0 -52
- package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.test.d.ts +0 -1
- package/lib-esm/__tests__/hooks/useProvidedStateOrCreate.test.js +0 -36
- package/lib-esm/__tests__/theme.test.d.ts +0 -1
- package/lib-esm/__tests__/theme.test.js +0 -33
- package/lib-esm/__tests__/themeGet.test.d.ts +0 -1
- package/lib-esm/__tests__/themeGet.test.js +0 -22
- package/lib-esm/__tests__/themePreval.test.d.ts +0 -1
- package/lib-esm/__tests__/themePreval.test.js +0 -7
- package/lib-esm/__tests__/useSafeTimeout.test.d.ts +0 -1
- package/lib-esm/__tests__/useSafeTimeout.test.js +0 -39
- package/lib-esm/__tests__/utils/createSlots.test.d.ts +0 -1
- package/lib-esm/__tests__/utils/createSlots.test.js +0 -67
- package/lib-esm/stories/ActionList.stories.js +0 -395
- package/lib-esm/stories/ActionList2.stories.js +0 -811
- package/lib-esm/stories/ActionMenu.stories.js +0 -303
- package/lib-esm/stories/ActionMenu2.stories.js +0 -393
- package/lib-esm/stories/AnchoredOverlay.stories.js +0 -101
- package/lib-esm/stories/Autocomplete.stories.js +0 -560
- package/lib-esm/stories/AvatarStack.stories.js +0 -32
- package/lib-esm/stories/Button.stories.js +0 -86
- package/lib-esm/stories/Checkbox.stories.js +0 -197
- package/lib-esm/stories/ConfirmationDialog.stories.js +0 -94
- package/lib-esm/stories/Dialog.stories.js +0 -244
- package/lib-esm/stories/DropdownMenu.stories.js +0 -94
- package/lib-esm/stories/IssueLabelToken.stories.js +0 -139
- package/lib-esm/stories/NewButton.stories.js +0 -178
- package/lib-esm/stories/Overlay.stories.js +0 -173
- package/lib-esm/stories/Portal.stories.js +0 -68
- package/lib-esm/stories/ProfileToken.stories.js +0 -136
- package/lib-esm/stories/Radio.stories.js +0 -121
- package/lib-esm/stories/SelectPanel.stories.js +0 -334
- package/lib-esm/stories/TextInput.stories.js +0 -117
- package/lib-esm/stories/TextInputWithTokens.stories.js +0 -210
- package/lib-esm/stories/ThemeProvider.stories.js +0 -79
- package/lib-esm/stories/Token.stories.js +0 -146
- package/lib-esm/stories/useAnchoredPosition.stories.js +0 -313
- package/lib-esm/stories/useFocusTrap.stories.js +0 -303
- package/lib-esm/stories/useFocusZone.stories.js +0 -558
- package/migrating.md +0 -250
- package/now.json +0 -17
- package/package-lock.json +0 -64490
- package/rollup.config.js +0 -36
- package/script/build +0 -21
- package/script/build-storybook +0 -10
- package/script/component-status-project/build.ts +0 -100
- package/script/component-status-project/deploy.rb +0 -142
- package/script/setup +0 -12
- package/src/ActionList/Divider.tsx +0 -25
- package/src/ActionList/Group.tsx +0 -45
- package/src/ActionList/Header.tsx +0 -74
- package/src/ActionList/Item.tsx +0 -481
- package/src/ActionList/List.tsx +0 -258
- package/src/ActionList/index.ts +0 -21
- package/src/ActionList2/ActionListContainerContext.tsx +0 -14
- package/src/ActionList2/Description.tsx +0 -52
- package/src/ActionList2/Divider.tsx +0 -29
- package/src/ActionList2/Group.tsx +0 -103
- package/src/ActionList2/Item.tsx +0 -255
- package/src/ActionList2/LinkItem.tsx +0 -49
- package/src/ActionList2/List.tsx +0 -54
- package/src/ActionList2/Selection.tsx +0 -70
- package/src/ActionList2/Visuals.tsx +0 -76
- package/src/ActionList2/index.ts +0 -39
- package/src/ActionMenu.tsx +0 -106
- package/src/ActionMenu2.tsx +0 -116
- package/src/AnchoredOverlay/AnchoredOverlay.tsx +0 -191
- package/src/AnchoredOverlay/index.ts +0 -2
- package/src/Autocomplete/Autocomplete.tsx +0 -103
- package/src/Autocomplete/AutocompleteContext.tsx +0 -19
- package/src/Autocomplete/AutocompleteInput.tsx +0 -179
- package/src/Autocomplete/AutocompleteMenu.tsx +0 -341
- package/src/Autocomplete/AutocompleteOverlay.tsx +0 -68
- package/src/Autocomplete/index.ts +0 -2
- package/src/Avatar.tsx +0 -44
- package/src/AvatarPair.tsx +0 -35
- package/src/AvatarStack.tsx +0 -159
- package/src/BaseStyles.tsx +0 -53
- package/src/BorderBox.tsx +0 -18
- package/src/Box.tsx +0 -54
- package/src/BranchName.tsx +0 -20
- package/src/Breadcrumbs.tsx +0 -101
- package/src/Button/Button.tsx +0 -39
- package/src/Button/ButtonBase.tsx +0 -39
- package/src/Button/ButtonClose.tsx +0 -36
- package/src/Button/ButtonDanger.tsx +0 -42
- package/src/Button/ButtonGroup.tsx +0 -55
- package/src/Button/ButtonInvisible.tsx +0 -31
- package/src/Button/ButtonOutline.tsx +0 -42
- package/src/Button/ButtonPrimary.tsx +0 -40
- package/src/Button/ButtonStyles.tsx +0 -36
- package/src/Button/ButtonTableList.tsx +0 -45
- package/src/Button/index.ts +0 -16
- package/src/Caret.tsx +0 -133
- package/src/Checkbox.tsx +0 -75
- package/src/CircleBadge.tsx +0 -53
- package/src/CircleOcticon.tsx +0 -37
- package/src/CounterLabel.tsx +0 -50
- package/src/Details.tsx +0 -19
- package/src/Dialog/ConfirmationDialog.tsx +0 -184
- package/src/Dialog/Dialog.tsx +0 -444
- package/src/Dialog.tsx +0 -145
- package/src/Dropdown.tsx +0 -154
- package/src/DropdownMenu/DropdownButton.tsx +0 -15
- package/src/DropdownMenu/DropdownMenu.tsx +0 -115
- package/src/DropdownMenu/index.ts +0 -4
- package/src/DropdownStyles.ts +0 -128
- package/src/FilterList.tsx +0 -75
- package/src/FilteredActionList/FilteredActionList.tsx +0 -142
- package/src/FilteredActionList/index.ts +0 -2
- package/src/FilteredSearch.tsx +0 -27
- package/src/Flash.tsx +0 -75
- package/src/Flex.tsx +0 -15
- package/src/FormGroup.tsx +0 -24
- package/src/Grid.tsx +0 -15
- package/src/Header.tsx +0 -74
- package/src/Heading.tsx +0 -14
- package/src/Label.tsx +0 -72
- package/src/LabelGroup.tsx +0 -17
- package/src/Link.tsx +0 -42
- package/src/NewButton/button-counter.tsx +0 -15
- package/src/NewButton/button.tsx +0 -283
- package/src/NewButton/index.ts +0 -10
- package/src/NewButton/types.ts +0 -36
- package/src/Overlay.tsx +0 -203
- package/src/Pagehead.tsx +0 -16
- package/src/Pagination/Pagination.tsx +0 -212
- package/src/Pagination/index.ts +0 -4
- package/src/Pagination/model.tsx +0 -187
- package/src/PointerBox.tsx +0 -31
- package/src/Popover.tsx +0 -225
- package/src/Portal/Portal.tsx +0 -97
- package/src/Portal/index.ts +0 -5
- package/src/Position.tsx +0 -63
- package/src/ProgressBar.tsx +0 -53
- package/src/Radio.tsx +0 -76
- package/src/SelectMenu/SelectMenu.tsx +0 -123
- package/src/SelectMenu/SelectMenuContext.tsx +0 -9
- package/src/SelectMenu/SelectMenuDivider.tsx +0 -24
- package/src/SelectMenu/SelectMenuFilter.tsx +0 -50
- package/src/SelectMenu/SelectMenuFooter.tsx +0 -27
- package/src/SelectMenu/SelectMenuHeader.tsx +0 -48
- package/src/SelectMenu/SelectMenuItem.tsx +0 -136
- package/src/SelectMenu/SelectMenuList.tsx +0 -41
- package/src/SelectMenu/SelectMenuLoadingAnimation.tsx +0 -25
- package/src/SelectMenu/SelectMenuModal.tsx +0 -119
- package/src/SelectMenu/SelectMenuTab.tsx +0 -87
- package/src/SelectMenu/SelectMenuTabPanel.tsx +0 -29
- package/src/SelectMenu/SelectMenuTabs.tsx +0 -43
- package/src/SelectMenu/hooks/useKeyboardNav.js +0 -90
- package/src/SelectMenu/index.ts +0 -15
- package/src/SelectPanel/SelectPanel.tsx +0 -173
- package/src/SelectPanel/index.ts +0 -2
- package/src/SideNav.tsx +0 -191
- package/src/Spinner.tsx +0 -57
- package/src/StateLabel.tsx +0 -112
- package/src/StyledOcticon.tsx +0 -22
- package/src/SubNav.tsx +0 -124
- package/src/TabNav.tsx +0 -73
- package/src/Text.tsx +0 -13
- package/src/TextInput.tsx +0 -68
- package/src/TextInputWithTokens.tsx +0 -351
- package/src/ThemeProvider.tsx +0 -193
- package/src/Timeline.tsx +0 -140
- package/src/Token/AvatarToken.tsx +0 -54
- package/src/Token/IssueLabelToken.tsx +0 -150
- package/src/Token/Token.tsx +0 -126
- package/src/Token/TokenBase.tsx +0 -129
- package/src/Token/_RemoveTokenButton.tsx +0 -111
- package/src/Token/_TokenTextContainer.tsx +0 -47
- package/src/Token/index.ts +0 -3
- package/src/Tooltip.tsx +0 -263
- package/src/Truncate.tsx +0 -31
- package/src/UnderlineNav.tsx +0 -107
- package/src/_TextInputWrapper.tsx +0 -113
- package/src/_UnstyledTextInput.tsx +0 -19
- package/src/__tests__/.eslintrc.json +0 -11
- package/src/__tests__/ActionList.test.tsx +0 -53
- package/src/__tests__/ActionList.types.test.tsx +0 -51
- package/src/__tests__/ActionList2.test.tsx +0 -156
- package/src/__tests__/ActionMenu.test.tsx +0 -136
- package/src/__tests__/AnchoredOverlay.test.tsx +0 -150
- package/src/__tests__/Autocomplete.test.tsx +0 -444
- package/src/__tests__/Avatar.test.tsx +0 -44
- package/src/__tests__/Avatar.types.test.tsx +0 -11
- package/src/__tests__/AvatarStack.test.tsx +0 -48
- package/src/__tests__/BorderBox.test.tsx +0 -43
- package/src/__tests__/Box.test.tsx +0 -42
- package/src/__tests__/BranchName.test.tsx +0 -26
- package/src/__tests__/BranchName.types.test.tsx +0 -11
- package/src/__tests__/Breadcrumbs.test.tsx +0 -27
- package/src/__tests__/Breadcrumbs.types.test.tsx +0 -22
- package/src/__tests__/BreadcrumbsItem.test.tsx +0 -31
- package/src/__tests__/Button.test.tsx +0 -128
- package/src/__tests__/Caret.test.tsx +0 -36
- package/src/__tests__/Checkbox.test.tsx +0 -155
- package/src/__tests__/CircleBadge.test.tsx +0 -66
- package/src/__tests__/CircleBadge.types.test.tsx +0 -11
- package/src/__tests__/CircleOcticon.test.tsx +0 -50
- package/src/__tests__/ConfirmationDialog.test.tsx +0 -120
- package/src/__tests__/CounterLabel.test.tsx +0 -50
- package/src/__tests__/CounterLabel.types.test.tsx +0 -11
- package/src/__tests__/Details.test.tsx +0 -115
- package/src/__tests__/Details.types.test.tsx +0 -11
- package/src/__tests__/Dialog.test.tsx +0 -155
- package/src/__tests__/Dialog.types.test.tsx +0 -11
- package/src/__tests__/Dialog2.types.test.tsx +0 -11
- package/src/__tests__/Dropdown.test.tsx +0 -53
- package/src/__tests__/Dropdown.types.test.tsx +0 -21
- package/src/__tests__/DropdownMenu.test.tsx +0 -136
- package/src/__tests__/FilterList.test.tsx +0 -26
- package/src/__tests__/FilterList.types.test.tsx +0 -17
- package/src/__tests__/FilterListItem.test.tsx +0 -31
- package/src/__tests__/FilteredSearch.test.tsx +0 -26
- package/src/__tests__/FilteredSearch.types.test.tsx +0 -11
- package/src/__tests__/Flash.test.tsx +0 -45
- package/src/__tests__/Flash.types.test.tsx +0 -11
- package/src/__tests__/Flex.test.tsx +0 -58
- package/src/__tests__/FormGroup.test.tsx +0 -38
- package/src/__tests__/FormGroup.types.test.tsx +0 -11
- package/src/__tests__/Grid.test.tsx +0 -82
- package/src/__tests__/Header.test.tsx +0 -49
- package/src/__tests__/Header.types.test.tsx +0 -19
- package/src/__tests__/Heading.test.tsx +0 -137
- package/src/__tests__/Heading.types.test.tsx +0 -11
- package/src/__tests__/KeyPaths.types.test.ts +0 -14
- package/src/__tests__/Label.test.tsx +0 -34
- package/src/__tests__/Label.types.test.tsx +0 -11
- package/src/__tests__/LabelGroup.test.tsx +0 -30
- package/src/__tests__/LabelGroup.types.test.tsx +0 -11
- package/src/__tests__/Link.test.tsx +0 -47
- package/src/__tests__/Link.types.test.tsx +0 -11
- package/src/__tests__/Merge.types.test.ts +0 -39
- package/src/__tests__/NewButton.test.tsx +0 -70
- package/src/__tests__/Overlay.test.tsx +0 -103
- package/src/__tests__/Overlay.types.test.tsx +0 -33
- package/src/__tests__/Pagehead.test.tsx +0 -23
- package/src/__tests__/Pagehead.types.test.tsx +0 -11
- package/src/__tests__/Pagination/Pagination.test.tsx +0 -30
- package/src/__tests__/Pagination/PaginationModel.test.tsx +0 -133
- package/src/__tests__/Pagination/__snapshots__/Pagination.test.tsx.snap +0 -184
- package/src/__tests__/Pagination.types.test.tsx +0 -11
- package/src/__tests__/PointerBox.test.tsx +0 -34
- package/src/__tests__/Popover.test.tsx +0 -68
- package/src/__tests__/Popover.types.test.tsx +0 -17
- package/src/__tests__/Portal.test.tsx +0 -103
- package/src/__tests__/Position.test.tsx +0 -117
- package/src/__tests__/ProgressBar.test.tsx +0 -40
- package/src/__tests__/Radio.test.tsx +0 -174
- package/src/__tests__/SelectMenu.test.tsx +0 -142
- package/src/__tests__/SelectMenu.types.test.tsx +0 -37
- package/src/__tests__/SelectPanel.test.tsx +0 -63
- package/src/__tests__/SelectPanel.types.test.tsx +0 -31
- package/src/__tests__/SideNav.test.tsx +0 -62
- package/src/__tests__/SideNav.types.test.tsx +0 -11
- package/src/__tests__/Spinner.test.tsx +0 -42
- package/src/__tests__/StateLabel.test.tsx +0 -48
- package/src/__tests__/StateLabel.types.test.tsx +0 -11
- package/src/__tests__/StyledOcticon.test.tsx +0 -26
- package/src/__tests__/StyledOcticon.types.test.tsx +0 -12
- package/src/__tests__/SubNav.test.tsx +0 -50
- package/src/__tests__/SubNav.types.test.tsx +0 -25
- package/src/__tests__/SubNavLink.test.tsx +0 -31
- package/src/__tests__/TabNav.test.tsx +0 -32
- package/src/__tests__/TabNav.types.test.tsx +0 -22
- package/src/__tests__/Text.test.tsx +0 -78
- package/src/__tests__/TextInput.test.tsx +0 -49
- package/src/__tests__/TextInputWithTokens.test.tsx +0 -422
- package/src/__tests__/ThemeProvider.test.tsx +0 -557
- package/src/__tests__/Timeline.test.tsx +0 -58
- package/src/__tests__/Timeline.types.test.tsx +0 -31
- package/src/__tests__/Token.test.tsx +0 -118
- package/src/__tests__/Tooltip.test.tsx +0 -52
- package/src/__tests__/Tooltip.types.test.tsx +0 -11
- package/src/__tests__/Truncate.test.tsx +0 -43
- package/src/__tests__/Truncate.types.test.tsx +0 -11
- package/src/__tests__/UnderlineNav.test.tsx +0 -58
- package/src/__tests__/UnderlineNav.types.test.tsx +0 -22
- package/src/__tests__/UnderlineNavLink.test.tsx +0 -31
- package/src/__tests__/__snapshots__/ActionList.test.tsx.snap +0 -223
- package/src/__tests__/__snapshots__/ActionList2.test.tsx.snap +0 -14
- package/src/__tests__/__snapshots__/ActionMenu.test.tsx.snap +0 -80
- package/src/__tests__/__snapshots__/AnchoredOverlay.test.tsx.snap +0 -232
- package/src/__tests__/__snapshots__/Autocomplete.test.tsx.snap +0 -3901
- package/src/__tests__/__snapshots__/Avatar.test.tsx.snap +0 -19
- package/src/__tests__/__snapshots__/AvatarStack.test.tsx.snap +0 -377
- package/src/__tests__/__snapshots__/BorderBox.test.tsx.snap +0 -14
- package/src/__tests__/__snapshots__/Box.test.tsx.snap +0 -201
- package/src/__tests__/__snapshots__/BranchName.test.tsx.snap +0 -19
- package/src/__tests__/__snapshots__/Breadcrumbs.test.tsx.snap +0 -29
- package/src/__tests__/__snapshots__/BreadcrumbsItem.test.tsx.snap +0 -79
- package/src/__tests__/__snapshots__/Button.test.tsx.snap +0 -840
- package/src/__tests__/__snapshots__/Caret.test.tsx.snap +0 -373
- package/src/__tests__/__snapshots__/Checkbox.test.tsx.snap +0 -16
- package/src/__tests__/__snapshots__/CircleBadge.test.tsx.snap +0 -142
- package/src/__tests__/__snapshots__/CircleOcticon.test.tsx.snap +0 -65
- package/src/__tests__/__snapshots__/ConfirmationDialog.test.tsx.snap +0 -89
- package/src/__tests__/__snapshots__/CounterLabel.test.tsx.snap +0 -22
- package/src/__tests__/__snapshots__/Details.test.tsx.snap +0 -15
- package/src/__tests__/__snapshots__/Dialog.test.tsx.snap +0 -201
- package/src/__tests__/__snapshots__/Dropdown.test.tsx.snap +0 -249
- package/src/__tests__/__snapshots__/DropdownMenu.test.tsx.snap +0 -107
- package/src/__tests__/__snapshots__/FilterList.test.tsx.snap +0 -13
- package/src/__tests__/__snapshots__/FilterListItem.test.tsx.snap +0 -80
- package/src/__tests__/__snapshots__/FilteredSearch.test.tsx.snap +0 -32
- package/src/__tests__/__snapshots__/Flash.test.tsx.snap +0 -32
- package/src/__tests__/__snapshots__/Flex.test.tsx.snap +0 -130
- package/src/__tests__/__snapshots__/FormGroup.test.tsx.snap +0 -25
- package/src/__tests__/__snapshots__/Grid.test.tsx.snap +0 -178
- package/src/__tests__/__snapshots__/Header.test.tsx.snap +0 -79
- package/src/__tests__/__snapshots__/Heading.test.tsx.snap +0 -13
- package/src/__tests__/__snapshots__/Label.test.tsx.snap +0 -73
- package/src/__tests__/__snapshots__/LabelGroup.test.tsx.snap +0 -15
- package/src/__tests__/__snapshots__/Link.test.tsx.snap +0 -212
- package/src/__tests__/__snapshots__/NewButton.test.tsx.snap +0 -305
- package/src/__tests__/__snapshots__/Pagehead.test.tsx.snap +0 -15
- package/src/__tests__/__snapshots__/PointerBox.test.tsx.snap +0 -174
- package/src/__tests__/__snapshots__/Popover.test.tsx.snap +0 -4687
- package/src/__tests__/__snapshots__/Position.test.tsx.snap +0 -44
- package/src/__tests__/__snapshots__/ProgressBar.test.tsx.snap +0 -53
- package/src/__tests__/__snapshots__/Radio.test.tsx.snap +0 -16
- package/src/__tests__/__snapshots__/SelectMenu.test.tsx.snap +0 -473
- package/src/__tests__/__snapshots__/SelectPanel.test.tsx.snap +0 -124
- package/src/__tests__/__snapshots__/SideNav.test.tsx.snap +0 -143
- package/src/__tests__/__snapshots__/Spinner.test.tsx.snap +0 -33
- package/src/__tests__/__snapshots__/StateLabel.test.tsx.snap +0 -395
- package/src/__tests__/__snapshots__/StyledOcticon.test.tsx.snap +0 -26
- package/src/__tests__/__snapshots__/SubNav.test.tsx.snap +0 -44
- package/src/__tests__/__snapshots__/SubNavLink.test.tsx.snap +0 -199
- package/src/__tests__/__snapshots__/TabNav.test.tsx.snap +0 -58
- package/src/__tests__/__snapshots__/Text.test.tsx.snap +0 -7
- package/src/__tests__/__snapshots__/TextInput.test.tsx.snap +0 -446
- package/src/__tests__/__snapshots__/TextInputWithTokens.test.tsx.snap +0 -6045
- package/src/__tests__/__snapshots__/ThemeProvider.test.tsx.snap +0 -15
- package/src/__tests__/__snapshots__/Timeline.test.tsx.snap +0 -159
- package/src/__tests__/__snapshots__/Token.test.tsx.snap +0 -3811
- package/src/__tests__/__snapshots__/Tooltip.test.tsx.snap +0 -227
- package/src/__tests__/__snapshots__/Truncate.test.tsx.snap +0 -17
- package/src/__tests__/__snapshots__/UnderlineNav.test.tsx.snap +0 -59
- package/src/__tests__/__snapshots__/UnderlineNavLink.test.tsx.snap +0 -130
- package/src/__tests__/__snapshots__/themePreval.test.ts.snap +0 -3176
- package/src/__tests__/behaviors/anchoredPosition.test.ts +0 -295
- package/src/__tests__/behaviors/focusTrap.test.tsx +0 -236
- package/src/__tests__/behaviors/focusZone.test.tsx +0 -549
- package/src/__tests__/behaviors/iterateFocusableElements.test.tsx +0 -61
- package/src/__tests__/behaviors/scrollIntoViewingArea.test.ts +0 -195
- package/src/__tests__/filterObject.test.ts +0 -54
- package/src/__tests__/hooks/useAnchoredPosition.test.tsx +0 -31
- package/src/__tests__/hooks/useOnEscapePress.test.tsx +0 -16
- package/src/__tests__/hooks/useOnOutsideClick.test.tsx +0 -48
- package/src/__tests__/hooks/useOpenAndCloseFocus.test.tsx +0 -48
- package/src/__tests__/hooks/useProvidedStateOrCreate.test.tsx +0 -39
- package/src/__tests__/theme.test.ts +0 -41
- package/src/__tests__/themeGet.test.ts +0 -15
- package/src/__tests__/themePreval.test.ts +0 -8
- package/src/__tests__/useSafeTimeout.test.tsx +0 -36
- package/src/__tests__/utils/__snapshots__/createSlots.test.tsx.snap +0 -55
- package/src/__tests__/utils/createSlots.test.tsx +0 -74
- package/src/behaviors/anchoredPosition.ts +0 -442
- package/src/behaviors/focusTrap.ts +0 -184
- package/src/behaviors/focusZone.ts +0 -713
- package/src/behaviors/scrollIntoViewingArea.ts +0 -27
- package/src/constants.ts +0 -62
- package/src/drafts.ts +0 -11
- package/src/hooks/index.ts +0 -12
- package/src/hooks/useAnchoredPosition.ts +0 -54
- package/src/hooks/useCombinedRefs.ts +0 -40
- package/src/hooks/useDetails.tsx +0 -54
- package/src/hooks/useDialog.ts +0 -121
- package/src/hooks/useFocusTrap.ts +0 -80
- package/src/hooks/useFocusZone.ts +0 -64
- package/src/hooks/useOnEscapePress.ts +0 -63
- package/src/hooks/useOnOutsideClick.tsx +0 -82
- package/src/hooks/useOpenAndCloseFocus.ts +0 -32
- package/src/hooks/useOverlay.tsx +0 -34
- package/src/hooks/useProvidedRefOrCreate.ts +0 -14
- package/src/hooks/useProvidedStateOrCreate.ts +0 -27
- package/src/hooks/useRenderForcingRef.ts +0 -22
- package/src/hooks/useResizeObserver.ts +0 -11
- package/src/hooks/useSafeTimeout.ts +0 -38
- package/src/hooks/useScrollFlash.ts +0 -21
- package/src/index.ts +0 -177
- package/src/polyfills/eventListenerSignal.ts +0 -66
- package/src/stories/ActionList.stories.tsx +0 -436
- package/src/stories/ActionList2.stories.tsx +0 -1305
- package/src/stories/ActionMenu.stories.tsx +0 -331
- package/src/stories/ActionMenu2.stories.tsx +0 -605
- package/src/stories/AnchoredOverlay.stories.tsx +0 -117
- package/src/stories/Autocomplete.stories.tsx +0 -655
- package/src/stories/AvatarStack.stories.tsx +0 -37
- package/src/stories/Button.stories.tsx +0 -92
- package/src/stories/Checkbox.stories.tsx +0 -162
- package/src/stories/ConfirmationDialog.stories.tsx +0 -105
- package/src/stories/Dialog.stories.tsx +0 -240
- package/src/stories/DropdownMenu.stories.tsx +0 -84
- package/src/stories/IssueLabelToken.stories.tsx +0 -138
- package/src/stories/NewButton.stories.tsx +0 -201
- package/src/stories/Overlay.stories.tsx +0 -213
- package/src/stories/Portal.stories.tsx +0 -109
- package/src/stories/ProfileToken.stories.tsx +0 -129
- package/src/stories/Radio.stories.tsx +0 -126
- package/src/stories/SelectPanel.stories.tsx +0 -353
- package/src/stories/TextInput.stories.tsx +0 -113
- package/src/stories/TextInputWithTokens.stories.tsx +0 -155
- package/src/stories/ThemeProvider.stories.tsx +0 -104
- package/src/stories/Token.stories.tsx +0 -137
- package/src/stories/useAnchoredPosition.stories.tsx +0 -332
- package/src/stories/useFocusTrap.stories.tsx +0 -400
- package/src/stories/useFocusZone.stories.tsx +0 -663
- package/src/sx.ts +0 -24
- package/src/theme-preval.js +0 -80
- package/src/theme.ts +0 -89
- package/src/utils/create-slots.tsx +0 -96
- package/src/utils/deprecate.tsx +0 -73
- package/src/utils/isNumeric.tsx +0 -4
- package/src/utils/iterateFocusableElements.ts +0 -121
- package/src/utils/ssr.tsx +0 -1
- package/src/utils/test-deprecations.tsx +0 -19
- package/src/utils/test-helpers.tsx +0 -7
- package/src/utils/test-matchers.tsx +0 -109
- package/src/utils/testing.tsx +0 -264
- package/src/utils/theme.js +0 -64
- package/src/utils/types/AriaRole.ts +0 -71
- package/src/utils/types/ComponentProps.ts +0 -13
- package/src/utils/types/Flatten.ts +0 -4
- package/src/utils/types/KeyPaths.ts +0 -10
- package/src/utils/types/MandateProps.ts +0 -19
- package/src/utils/types/Merge.ts +0 -20
- package/src/utils/types/index.ts +0 -5
- package/src/utils/uniqueId.ts +0 -6
- package/src/utils/use-force-update.ts +0 -7
- package/src/utils/useIsomorphicLayoutEffect.ts +0 -10
- package/src/utils/userAgent.ts +0 -7
- package/stats.html +0 -3279
- package/tsconfig.build.json +0 -7
- package/tsconfig.json +0 -20
@@ -1,27 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: StyledOcticon
|
3
|
-
status: Alpha
|
4
|
-
---
|
5
|
-
|
6
|
-
StyledOcticon renders an [Octicon](https://octicons.github.com) with common system props, including `color`, margin, and padding.
|
7
|
-
|
8
|
-
## Default example
|
9
|
-
|
10
|
-
```jsx live
|
11
|
-
<>
|
12
|
-
<StyledOcticon icon={CheckIcon} size={32} color="success.fg" mr={2} />
|
13
|
-
<StyledOcticon icon={XIcon} size={32} color="danger.fg" />
|
14
|
-
</>
|
15
|
-
```
|
16
|
-
|
17
|
-
## Component props
|
18
|
-
|
19
|
-
StyledOcticon passes all of its props except the common system props down to the [Octicon component](https://github.com/primer/octicons/tree/master/lib/octicons_react#usage), including:
|
20
|
-
|
21
|
-
| Name | Type | Default | Description |
|
22
|
-
| :------------ | :---------------- | :-----------: | :----------------------------------------------------------------------------------------------------------- |
|
23
|
-
| ariaLabel | String | | Specifies the `aria-label` attribute, which is read verbatim by screen readers |
|
24
|
-
| icon | Component | | [Octicon component](https://github.com/primer/octicons/tree/master/lib/octicons_react) used in the component |
|
25
|
-
| size | Number | 16 | Sets the uniform `width` and `height` of the SVG element |
|
26
|
-
| verticalAlign | String | `text-bottom` | Sets the `vertical-align` CSS property |
|
27
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/SubNav.md
DELETED
@@ -1,101 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: SubNav
|
3
|
-
status: Alpha
|
4
|
-
---
|
5
|
-
|
6
|
-
Use the SubNav component for navigation on a dashboard-type interface with another set of navigation components above it. This helps distinguish navigation hierarchy.
|
7
|
-
|
8
|
-
To use SubNav with [react-router](https://github.com/ReactTraining/react-router) or
|
9
|
-
[react-router-dom](https://www.npmjs.com/package/react-router-dom), pass
|
10
|
-
`as={NavLink}` and omit the `selected` prop.
|
11
|
-
This ensures that the NavLink gets `activeClassName='selected'`
|
12
|
-
|
13
|
-
**Attention:** Make sure to properly label your `SubNav` with an `aria-label` to provide context about the type of navigation contained in `SubNav`.
|
14
|
-
|
15
|
-
## Default example
|
16
|
-
|
17
|
-
```jsx live
|
18
|
-
<SubNav aria-label="Main">
|
19
|
-
<SubNav.Links>
|
20
|
-
<SubNav.Link href="#home" selected>
|
21
|
-
Home
|
22
|
-
</SubNav.Link>
|
23
|
-
<SubNav.Link href="#documentation">Documentation</SubNav.Link>
|
24
|
-
<SubNav.Link href="#support">Support</SubNav.Link>
|
25
|
-
</SubNav.Links>
|
26
|
-
</SubNav>
|
27
|
-
```
|
28
|
-
|
29
|
-
## SubNav with search example
|
30
|
-
|
31
|
-
```jsx live
|
32
|
-
<SubNav aria-label="Main">
|
33
|
-
<SubNav.Links>
|
34
|
-
<SubNav.Link href="#home" selected>
|
35
|
-
Home
|
36
|
-
</SubNav.Link>
|
37
|
-
<SubNav.Link href="#documentation">Documentation</SubNav.Link>
|
38
|
-
<SubNav.Link href="#support">Support</SubNav.Link>
|
39
|
-
</SubNav.Links>
|
40
|
-
|
41
|
-
<TextInput type="search" icon={SearchIcon} sx={{width: 320}} />
|
42
|
-
</SubNav>
|
43
|
-
```
|
44
|
-
|
45
|
-
## SubNav with filtered search example
|
46
|
-
|
47
|
-
```jsx live
|
48
|
-
<SubNav aria-label="Main">
|
49
|
-
<FilteredSearch>
|
50
|
-
<Dropdown>
|
51
|
-
<Dropdown.Button>Filter</Dropdown.Button>
|
52
|
-
<Dropdown.Menu direction="sw">
|
53
|
-
<Dropdown.Item>
|
54
|
-
<a href="#">Item 1</a>
|
55
|
-
</Dropdown.Item>
|
56
|
-
<Dropdown.Item>
|
57
|
-
<a href="#">Item 2</a>
|
58
|
-
</Dropdown.Item>
|
59
|
-
<Dropdown.Item>
|
60
|
-
<a href="#">Item 3</a>
|
61
|
-
</Dropdown.Item>
|
62
|
-
</Dropdown.Menu>
|
63
|
-
</Dropdown>
|
64
|
-
<TextInput type="search" icon={SearchIcon} width={320} />
|
65
|
-
</FilteredSearch>
|
66
|
-
<SubNav.Links>
|
67
|
-
<SubNav.Link href="#home" selected>
|
68
|
-
Home
|
69
|
-
</SubNav.Link>
|
70
|
-
<SubNav.Link href="#documentation">Documentation</SubNav.Link>
|
71
|
-
<SubNav.Link href="#support">Support</SubNav.Link>
|
72
|
-
</SubNav.Links>
|
73
|
-
</SubNav>
|
74
|
-
```
|
75
|
-
|
76
|
-
## Component props
|
77
|
-
|
78
|
-
### SubNav
|
79
|
-
|
80
|
-
| Name | Type | Default | Description |
|
81
|
-
| :--------- | :---------------- | :-----: | :------------------------------------------------------------------------------------- |
|
82
|
-
| actions | Node | | Place another element, such as a button, to the opposite side of the navigation items. |
|
83
|
-
| align | String | | Use `right` to have navigation items aligned right. |
|
84
|
-
| full | Boolean | | Used to make navigation fill the width of the container. |
|
85
|
-
| aria-label | String | | Used to set the `aria-label` on the top level `<nav>` element. |
|
86
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
87
|
-
|
88
|
-
### SubNav.Link
|
89
|
-
|
90
|
-
| Name | Type | Default | Description |
|
91
|
-
| :------- | :---------------- | :-----: | :----------------------------------------------- |
|
92
|
-
| as | String | | sets the HTML tag for the component |
|
93
|
-
| href | String | | URL to be used for the Link |
|
94
|
-
| selected | Boolean | | Used to style the link as selected or unselected |
|
95
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
96
|
-
|
97
|
-
### SubNav.Links
|
98
|
-
|
99
|
-
| Name | Type | Default | Description |
|
100
|
-
| :--- | :---------------- | :-----: | :----------------------------------- |
|
101
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/TabNav.md
DELETED
@@ -1,43 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: TabNav
|
3
|
-
status: Alpha
|
4
|
-
---
|
5
|
-
|
6
|
-
Use the TabNav component to style navigation with a tab-based selected state, typically used for navigation placed at the top of the page.
|
7
|
-
|
8
|
-
To use TabNav with [react-router](https://github.com/ReactTraining/react-router) or
|
9
|
-
[react-router-dom](https://www.npmjs.com/package/react-router-dom), pass
|
10
|
-
`as={NavLink}` and omit the `selected` prop.
|
11
|
-
This ensures that the NavLink gets `activeClassName='selected'`
|
12
|
-
|
13
|
-
**Attention:** Make sure to properly label your `TabNav` with an `aria-label` to provide context about the type of navigation contained in `TabNav`.
|
14
|
-
|
15
|
-
## Default example
|
16
|
-
|
17
|
-
```jsx live
|
18
|
-
<TabNav aria-label="Main">
|
19
|
-
<TabNav.Link href="#home" selected>
|
20
|
-
Home
|
21
|
-
</TabNav.Link>
|
22
|
-
<TabNav.Link href="#documentation">Documentation</TabNav.Link>
|
23
|
-
<TabNav.Link href="#support">Support</TabNav.Link>
|
24
|
-
</TabNav>
|
25
|
-
```
|
26
|
-
|
27
|
-
## Component props
|
28
|
-
|
29
|
-
### TabNav
|
30
|
-
|
31
|
-
| Name | Type | Default | Description |
|
32
|
-
| :--------- | :---------------- | :-----: | :------------------------------------------------------------- |
|
33
|
-
| aria-label | String | | Used to set the `aria-label` on the top level `<nav>` element. |
|
34
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
35
|
-
|
36
|
-
### TabNav.Link
|
37
|
-
|
38
|
-
| Name | Type | Default | Description |
|
39
|
-
| :------- | :---------------- | :-----: | :----------------------------------------------- |
|
40
|
-
| as | String | | sets the HTML tag for the component |
|
41
|
-
| href | String | | URL to be used for the Link |
|
42
|
-
| selected | Boolean | | Used to style the link as selected or unselected |
|
43
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Text.md
DELETED
@@ -1,32 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Text
|
3
|
-
status: Alpha
|
4
|
-
---
|
5
|
-
|
6
|
-
The Text component is a wrapper component that will apply typography styles to the text inside.
|
7
|
-
|
8
|
-
## Default example
|
9
|
-
|
10
|
-
```jsx live
|
11
|
-
<>
|
12
|
-
<Text as="p" fontWeight="bold">
|
13
|
-
bold
|
14
|
-
</Text>
|
15
|
-
<Text as="p" color="danger.fg">
|
16
|
-
danger color
|
17
|
-
</Text>
|
18
|
-
<Text as="p" color="fg.onEmphasis" bg="neutral.emphasis" p={2}>
|
19
|
-
inverse colors
|
20
|
-
</Text>
|
21
|
-
</>
|
22
|
-
```
|
23
|
-
|
24
|
-
## System props
|
25
|
-
|
26
|
-
Text components get `TYPOGRAPHY` and `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
27
|
-
|
28
|
-
## Component props
|
29
|
-
|
30
|
-
| Name | Type | Default | Description |
|
31
|
-
| :--- | :----- | :-----: | :---------------------------------- |
|
32
|
-
| as | String | `span` | Sets the HTML tag for the component |
|
@@ -1,125 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: TextInput
|
3
|
-
status: Alpha
|
4
|
-
source: https://github.com/primer/react/blob/main/src/TextInput.tsx
|
5
|
-
---
|
6
|
-
|
7
|
-
import {PropsTable} from '../src/props-table'
|
8
|
-
import {Link} from '@primer/components'
|
9
|
-
|
10
|
-
TextInput is a form component to add default styling to the native text input.
|
11
|
-
|
12
|
-
**Note:** Don't forget to set `aria-label` to make the TextInput accessible to screen reader users.
|
13
|
-
|
14
|
-
## Examples
|
15
|
-
|
16
|
-
```jsx live
|
17
|
-
<>
|
18
|
-
<TextInput aria-label="Zipcode" name="zipcode" placeholder="Zipcode" autoComplete="postal-code" />
|
19
|
-
|
20
|
-
<TextInput sx={{ml: 4}} aria-label="City" name="city" placeholder="City" contrast />
|
21
|
-
|
22
|
-
<TextInput
|
23
|
-
sx={{ml: 4}}
|
24
|
-
icon={SearchIcon}
|
25
|
-
aria-label="Zipcode"
|
26
|
-
name="zipcode"
|
27
|
-
placeholder="Find user"
|
28
|
-
autoComplete="postal-code"
|
29
|
-
/>
|
30
|
-
</>
|
31
|
-
```
|
32
|
-
|
33
|
-
## Props
|
34
|
-
|
35
|
-
### TextInput
|
36
|
-
|
37
|
-
<PropsTable>
|
38
|
-
<PropsTable.Row name="aria-label" type="string" description="Allows input to be accessible." />
|
39
|
-
<PropsTable.Row
|
40
|
-
name="block"
|
41
|
-
type="boolean"
|
42
|
-
defaultValue="false"
|
43
|
-
description={
|
44
|
-
<>
|
45
|
-
Adds <InlineCode>display: block</InlineCode> to element
|
46
|
-
</>
|
47
|
-
}
|
48
|
-
/>
|
49
|
-
<PropsTable.Row
|
50
|
-
name="contrast"
|
51
|
-
type="boolean"
|
52
|
-
defaultValue="false"
|
53
|
-
description="Changes background color to a higher contrast color"
|
54
|
-
/>
|
55
|
-
<PropsTable.Row
|
56
|
-
name="variant"
|
57
|
-
type="'small' | 'large'"
|
58
|
-
description="Creates a smaller or larger input than the default."
|
59
|
-
/>
|
60
|
-
<PropsTable.Row
|
61
|
-
name="width"
|
62
|
-
type={
|
63
|
-
<>
|
64
|
-
string | number | <Link href="https://styled-system.com/guides/array-props">Array<string | number></Link>
|
65
|
-
</>
|
66
|
-
}
|
67
|
-
description="Set the width of the input"
|
68
|
-
/>
|
69
|
-
<PropsTable.Row
|
70
|
-
name="maxWidth"
|
71
|
-
type={
|
72
|
-
<>
|
73
|
-
string | number | <Link href="https://styled-system.com/guides/array-props">Array<string | number></Link>
|
74
|
-
</>
|
75
|
-
}
|
76
|
-
description="Set the maximum width of the input"
|
77
|
-
/>
|
78
|
-
<PropsTable.Row
|
79
|
-
name="minWidth"
|
80
|
-
type={
|
81
|
-
<>
|
82
|
-
string | number | <Link href="https://styled-system.com/guides/array-props">Array<string | number></Link>
|
83
|
-
</>
|
84
|
-
}
|
85
|
-
description="Set the minimum width of the input"
|
86
|
-
/>
|
87
|
-
<PropsTable.Row
|
88
|
-
name="icon"
|
89
|
-
type="React.ComponentType"
|
90
|
-
description="An Octicon React component. To be used inside of input. Positioned on the left edge."
|
91
|
-
/>
|
92
|
-
<PropsTable.SxRow />
|
93
|
-
<PropsTable.RefRow
|
94
|
-
elementType="input"
|
95
|
-
refType="HTMLInputElement"
|
96
|
-
description="A ref to the input element rendered by this component. Note: this is not the outermost element rendered by TextInput. There is also a div wrapper for which a ref is not accepted."
|
97
|
-
/>
|
98
|
-
<PropsTable.PassthroughPropsRow
|
99
|
-
elementName="input"
|
100
|
-
passthroughPropsLink={
|
101
|
-
<Link href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes">MDN</Link>
|
102
|
-
}
|
103
|
-
/>
|
104
|
-
</PropsTable>
|
105
|
-
|
106
|
-
## Status
|
107
|
-
|
108
|
-
<ComponentChecklist
|
109
|
-
items={{
|
110
|
-
propsDocumented: true,
|
111
|
-
noUnnecessaryDeps: true,
|
112
|
-
adaptsToThemes: true,
|
113
|
-
adaptsToScreenSizes: true,
|
114
|
-
fullTestCoverage: false,
|
115
|
-
usedInProduction: true,
|
116
|
-
usageExamplesDocumented: false,
|
117
|
-
hasStorybookStories: false,
|
118
|
-
designReviewed: false,
|
119
|
-
a11yReviewed: false,
|
120
|
-
stableApi: false,
|
121
|
-
addressedApiFeedback: false,
|
122
|
-
hasDesignGuidelines: false,
|
123
|
-
hasFigmaComponent: false
|
124
|
-
}}
|
125
|
-
/>
|
@@ -1,211 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: TextInputWithTokens
|
3
|
-
status: Alpha
|
4
|
-
source: https://github.com/primer/react/tree/main/src/TextInputWithTokens.tsx
|
5
|
-
---
|
6
|
-
|
7
|
-
import {Props} from '../src/props'
|
8
|
-
import {TextInputWithTokens} from '@primer/components'
|
9
|
-
|
10
|
-
A `TextInputWithTokens` component is used to show multiple values in one field.
|
11
|
-
|
12
|
-
It supports all of the features of a [TextInput](/TextInput) component, but it can render a list of [Tokens](/Token) next to the area a user types in.
|
13
|
-
|
14
|
-
## Basic Example
|
15
|
-
|
16
|
-
```javascript live noinline
|
17
|
-
const BasicExample = () => {
|
18
|
-
const [tokens, setTokens] = React.useState([
|
19
|
-
{text: 'zero', id: 0},
|
20
|
-
{text: 'one', id: 1},
|
21
|
-
{text: 'two', id: 2}
|
22
|
-
])
|
23
|
-
const onTokenRemove = tokenId => {
|
24
|
-
setTokens(tokens.filter(token => token.id !== tokenId))
|
25
|
-
}
|
26
|
-
|
27
|
-
return (
|
28
|
-
<>
|
29
|
-
<Box as="label" display="block" htmlFor="inputWithTokens-basic">
|
30
|
-
Basic example tokens
|
31
|
-
</Box>
|
32
|
-
<TextInputWithTokens tokens={tokens} onTokenRemove={onTokenRemove} id="inputWithTokens-basic" />
|
33
|
-
</>
|
34
|
-
)
|
35
|
-
}
|
36
|
-
|
37
|
-
render(BasicExample)
|
38
|
-
```
|
39
|
-
|
40
|
-
## Component Props
|
41
|
-
|
42
|
-
| Name | Type | Default | Description |
|
43
|
-
| :--------------------- | :------------------------------------ | :----------: | :------------------------------------------------------------------------------------------------------------------------ |
|
44
|
-
| tokens | `TokenProps[]` | `undefined` | Required. The array of tokens to render |
|
45
|
-
| onTokenRemove | `(tokenId: string \| number) => void` | `undefined` | Required. The function that gets called when a token is removed |
|
46
|
-
| tokenComponent | `React.ComponentType<any>` | `Token` | Optional. The component used to render each token |
|
47
|
-
| maxHeight | `React.CSSProperties['maxHeight']` | `undefined` | Optional. The maximum height of the component. If the content in the input exceeds this height, it will scroll vertically |
|
48
|
-
| preventTokenWrapping | `boolean` | `false` | Optional. Whether tokens should render inline horizontally. By default, tokens wrap to new lines. |
|
49
|
-
| size | `TokenSizeKeys` | `extralarge` | Optional. The size of the tokens |
|
50
|
-
| hideTokenRemoveButtons | `boolean` | `false` | Optional. Whether the remove buttons should be rendered in the tokens |
|
51
|
-
| visibleTokenCount | `number` | `undefined` | Optional. The number of tokens to display before truncating |
|
52
|
-
|
53
|
-
## Adding and removing tokens
|
54
|
-
|
55
|
-
The array passed to the `tokens` prop needs to be manually updated to add and remove tokens.
|
56
|
-
|
57
|
-
The function passed to the `onRemoveToken` prop is called when:
|
58
|
-
|
59
|
-
- Clicking the remove button in the token
|
60
|
-
- Pressing the `Backspace` key when the input is empty
|
61
|
-
- Selecting a token using the arrow keys or by clicking on a token and then pressing the `Backspace` key
|
62
|
-
|
63
|
-
There is no function that gets called to "add" a token, so the user needs to be provided with a UI to select tokens.
|
64
|
-
|
65
|
-
## Custom token rendering
|
66
|
-
|
67
|
-
By default, the `Token` component is used to render the tokens in the input. If this component does not make sense for the kinds of tokens you're rendering, you can pass a component to the `tokenComponent` prop
|
68
|
-
|
69
|
-
Example: a `TextInputWithTokens` that renders tokens as `IssueLabelToken`:
|
70
|
-
|
71
|
-
```javascript live noinline
|
72
|
-
const UsingIssueLabelTokens = () => {
|
73
|
-
const [tokens, setTokens] = React.useState([
|
74
|
-
{text: 'enhancement', id: 1, fillColor: '#a2eeef'},
|
75
|
-
{text: 'bug', id: 2, fillColor: '#d73a4a'},
|
76
|
-
{text: 'good first issue', id: 3, fillColor: '#0cf478'}
|
77
|
-
])
|
78
|
-
const onTokenRemove = tokenId => {
|
79
|
-
setTokens(tokens.filter(token => token.id !== tokenId))
|
80
|
-
}
|
81
|
-
|
82
|
-
return (
|
83
|
-
<>
|
84
|
-
<Box as="label" display="block" htmlFor="inputWithTokens-issueLabels">
|
85
|
-
Issue labels
|
86
|
-
</Box>
|
87
|
-
<TextInputWithTokens
|
88
|
-
tokenComponent={IssueLabelToken}
|
89
|
-
tokens={tokens}
|
90
|
-
onTokenRemove={onTokenRemove}
|
91
|
-
id="inputWithTokens-issueLabels"
|
92
|
-
/>
|
93
|
-
</>
|
94
|
-
)
|
95
|
-
}
|
96
|
-
|
97
|
-
render(<UsingIssueLabelTokens />)
|
98
|
-
```
|
99
|
-
|
100
|
-
## Dealing with long lists of tokens
|
101
|
-
|
102
|
-
By default, all tokens will be visible when the component is rendered.
|
103
|
-
|
104
|
-
If the component is being used in an area where it's height needs to be constrained, there are options to limit the height of the input.
|
105
|
-
|
106
|
-
### Hide and show tokens
|
107
|
-
|
108
|
-
```javascript live noinline
|
109
|
-
const VisibleTokenCountExample = () => {
|
110
|
-
const [tokens, setTokens] = React.useState([
|
111
|
-
{text: 'zero', id: 0},
|
112
|
-
{text: 'one', id: 1},
|
113
|
-
{text: 'two', id: 2},
|
114
|
-
{text: 'three', id: 3}
|
115
|
-
])
|
116
|
-
const onTokenRemove = tokenId => {
|
117
|
-
setTokens(tokens.filter(token => token.id !== tokenId))
|
118
|
-
}
|
119
|
-
|
120
|
-
return (
|
121
|
-
<Box maxWidth="500px">
|
122
|
-
<Box as="label" display="block" htmlFor="inputWithTokens-basic">
|
123
|
-
Tokens truncated after 2
|
124
|
-
</Box>
|
125
|
-
<TextInputWithTokens
|
126
|
-
visibleTokenCount={2}
|
127
|
-
block
|
128
|
-
tokens={tokens}
|
129
|
-
onTokenRemove={onTokenRemove}
|
130
|
-
id="inputWithTokens-basic"
|
131
|
-
/>
|
132
|
-
</Box>
|
133
|
-
)
|
134
|
-
}
|
135
|
-
|
136
|
-
render(VisibleTokenCountExample)
|
137
|
-
```
|
138
|
-
|
139
|
-
### Render tokens on a single line
|
140
|
-
|
141
|
-
```javascript live noinline
|
142
|
-
const PreventTokenWrappingExample = () => {
|
143
|
-
const [tokens, setTokens] = React.useState([
|
144
|
-
{text: 'zero', id: 0},
|
145
|
-
{text: 'one', id: 1},
|
146
|
-
{text: 'two', id: 2},
|
147
|
-
{text: 'three', id: 3},
|
148
|
-
{text: 'four', id: 4},
|
149
|
-
{text: 'five', id: 5},
|
150
|
-
{text: 'six', id: 6},
|
151
|
-
{text: 'seven', id: 7}
|
152
|
-
])
|
153
|
-
const onTokenRemove = tokenId => {
|
154
|
-
setTokens(tokens.filter(token => token.id !== tokenId))
|
155
|
-
}
|
156
|
-
|
157
|
-
return (
|
158
|
-
<Box maxWidth="500px">
|
159
|
-
<Box as="label" display="block" htmlFor="inputWithTokens-basic">
|
160
|
-
Tokens on one line
|
161
|
-
</Box>
|
162
|
-
<TextInputWithTokens
|
163
|
-
preventTokenWrapping
|
164
|
-
block
|
165
|
-
tokens={tokens}
|
166
|
-
onTokenRemove={onTokenRemove}
|
167
|
-
id="inputWithTokens-basic"
|
168
|
-
/>
|
169
|
-
</Box>
|
170
|
-
)
|
171
|
-
}
|
172
|
-
|
173
|
-
render(PreventTokenWrappingExample)
|
174
|
-
```
|
175
|
-
|
176
|
-
### Set a maximum height for the input
|
177
|
-
|
178
|
-
```javascript live noinline
|
179
|
-
const MaxHeightExample = () => {
|
180
|
-
const [tokens, setTokens] = React.useState([
|
181
|
-
{text: 'zero', id: 0},
|
182
|
-
{text: 'one', id: 1},
|
183
|
-
{text: 'two', id: 2},
|
184
|
-
{text: 'three', id: 3},
|
185
|
-
{text: 'four', id: 4},
|
186
|
-
{text: 'five', id: 5},
|
187
|
-
{text: 'six', id: 6},
|
188
|
-
{text: 'seven', id: 7}
|
189
|
-
])
|
190
|
-
const onTokenRemove = tokenId => {
|
191
|
-
setTokens(tokens.filter(token => token.id !== tokenId))
|
192
|
-
}
|
193
|
-
|
194
|
-
return (
|
195
|
-
<Box maxWidth="500px">
|
196
|
-
<Box as="label" display="block" htmlFor="inputWithTokens-basic">
|
197
|
-
Tokens restricted to a max height
|
198
|
-
</Box>
|
199
|
-
<TextInputWithTokens
|
200
|
-
maxHeight="50px"
|
201
|
-
block
|
202
|
-
tokens={tokens}
|
203
|
-
onTokenRemove={onTokenRemove}
|
204
|
-
id="inputWithTokens-basic"
|
205
|
-
/>
|
206
|
-
</Box>
|
207
|
-
)
|
208
|
-
}
|
209
|
-
|
210
|
-
render(MaxHeightExample)
|
211
|
-
```
|
package/docs/content/Timeline.md
DELETED
@@ -1,149 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Timeline
|
3
|
-
status: Alpha
|
4
|
-
---
|
5
|
-
|
6
|
-
The Timeline.Item component is used to display items on a vertical timeline, connected by Timeline.Badge elements.
|
7
|
-
|
8
|
-
## Example with in-line links
|
9
|
-
|
10
|
-
```jsx live
|
11
|
-
<Timeline>
|
12
|
-
<Timeline.Item>
|
13
|
-
<Timeline.Badge>
|
14
|
-
<StyledOcticon icon={FlameIcon} />
|
15
|
-
</Timeline.Badge>
|
16
|
-
<Timeline.Body>
|
17
|
-
<Link href="#" sx={{fontWeight: 'bold', color: 'fg.default', mr: 1}} muted>
|
18
|
-
Monalisa
|
19
|
-
</Link>
|
20
|
-
created one <Link href="#" sx={{fontWeight: 'bold', color: 'fg.default', mr: 1}} muted>
|
21
|
-
hot potato
|
22
|
-
</Link>
|
23
|
-
<Link href="#" color="fg.muted" muted>
|
24
|
-
Just now
|
25
|
-
</Link>
|
26
|
-
</Timeline.Body>
|
27
|
-
</Timeline.Item>
|
28
|
-
</Timeline>
|
29
|
-
```
|
30
|
-
|
31
|
-
## Default Color example
|
32
|
-
|
33
|
-
The default Timeline.Badge color is dark text on a light grey background.
|
34
|
-
|
35
|
-
```jsx live
|
36
|
-
<Timeline>
|
37
|
-
<Timeline.Item>
|
38
|
-
<Timeline.Badge>
|
39
|
-
<StyledOcticon icon={FlameIcon} />
|
40
|
-
</Timeline.Badge>
|
41
|
-
<Timeline.Body>Default badge color</Timeline.Body>
|
42
|
-
</Timeline.Item>
|
43
|
-
</Timeline>
|
44
|
-
```
|
45
|
-
|
46
|
-
## Adding color to a Badge
|
47
|
-
|
48
|
-
To have color variants, use the `bg` prop on the `Timeline.Badge`. If an icon is being used, set the `color` prop
|
49
|
-
of the child `StyledOcticon` if necessary.
|
50
|
-
|
51
|
-
```jsx live
|
52
|
-
<Timeline>
|
53
|
-
<Timeline.Item>
|
54
|
-
<Timeline.Badge sx={{bg: 'danger.emphasis'}}>
|
55
|
-
<StyledOcticon icon={FlameIcon} sx={{color: 'fg.onEmphasis'}} />
|
56
|
-
</Timeline.Badge>
|
57
|
-
<Timeline.Body>Background used when closed events occur</Timeline.Body>
|
58
|
-
</Timeline.Item>
|
59
|
-
<Timeline.Item>
|
60
|
-
<Timeline.Badge sx={{bg: 'danger.emphasis'}}>
|
61
|
-
<StyledOcticon icon={FlameIcon} color="fg.onEmphasis" />
|
62
|
-
</Timeline.Badge>
|
63
|
-
<Timeline.Body>Background when opened or passed events occur</Timeline.Body>
|
64
|
-
</Timeline.Item>
|
65
|
-
<Timeline.Item>
|
66
|
-
<Timeline.Badge sx={{bg: 'danger.emphasis'}}>
|
67
|
-
<StyledOcticon icon={FlameIcon} sx={{color: 'fg.onEmphasis'}} />
|
68
|
-
</Timeline.Badge>
|
69
|
-
<Timeline.Body>Background used when pull requests are merged</Timeline.Body>
|
70
|
-
</Timeline.Item>
|
71
|
-
</Timeline>
|
72
|
-
```
|
73
|
-
|
74
|
-
## Condensed items
|
75
|
-
|
76
|
-
Timeline has a condensed prop that will reduce the vertical padding and remove the background from the badge item. These are most commonly used in commits. To condense a single item, remove the top or bottom padding with the `pt={0}` or `pb={0}` prop.
|
77
|
-
|
78
|
-
```jsx live
|
79
|
-
<Timeline>
|
80
|
-
<Timeline.Item condensed>
|
81
|
-
<Timeline.Badge>
|
82
|
-
<StyledOcticon icon={GitCommitIcon} />
|
83
|
-
</Timeline.Badge>
|
84
|
-
<Timeline.Body>This is the message of a condensed TimelineItem</Timeline.Body>
|
85
|
-
</Timeline.Item>
|
86
|
-
<Timeline.Item condensed>
|
87
|
-
<Timeline.Badge>
|
88
|
-
<StyledOcticon icon={GitCommitIcon} />
|
89
|
-
</Timeline.Badge>
|
90
|
-
<Timeline.Body>This is the message of a condensed TimelineItem</Timeline.Body>
|
91
|
-
</Timeline.Item>
|
92
|
-
</Timeline>
|
93
|
-
```
|
94
|
-
|
95
|
-
## Timeline Break
|
96
|
-
|
97
|
-
To create a visual break in the timeline, use Timeline.Break. This adds a horizontal bar across the timeline to show that something has disrupted it. Usually this happens when a close or merged event occurs.
|
98
|
-
|
99
|
-
```jsx live
|
100
|
-
<Timeline>
|
101
|
-
<Timeline.Item>
|
102
|
-
<Timeline.Badge sx={{bg: 'danger.emphasis'}}>
|
103
|
-
<StyledOcticon icon={FlameIcon} color="fg.onEmphasis" />
|
104
|
-
</Timeline.Badge>
|
105
|
-
<Timeline.Body>Background used when closed events occur</Timeline.Body>
|
106
|
-
</Timeline.Item>
|
107
|
-
<Timeline.Break />
|
108
|
-
<Timeline.Item>
|
109
|
-
<Timeline.Badge sx={{bg: 'success.emphasis'}}>
|
110
|
-
<StyledOcticon icon={FlameIcon} sx={{color: 'fg.onEmphasis'}} />
|
111
|
-
</Timeline.Badge>
|
112
|
-
<Timeline.Body>Background when opened or passed events occur</Timeline.Body>
|
113
|
-
</Timeline.Item>
|
114
|
-
</Timeline>
|
115
|
-
```
|
116
|
-
|
117
|
-
## Component props
|
118
|
-
|
119
|
-
### Timeline
|
120
|
-
|
121
|
-
| Name | Type | Default | Description |
|
122
|
-
| :---------- | :---------------- | :-----: | :-------------------------------------------------------------------------------- |
|
123
|
-
| clipSidebar | Boolean | | Hides the sidebar above the first Timeline.Item and below the last Timeline.Item. |
|
124
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
125
|
-
|
126
|
-
### Timeline.Item
|
127
|
-
|
128
|
-
| Name | Type | Default | Description |
|
129
|
-
| :-------- | :---------------- | :-----: | :-------------------------------------------------------------------- |
|
130
|
-
| condensed | Boolean | | Reduces vertical padding and removes background from an item's badge. |
|
131
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
132
|
-
|
133
|
-
### Timeline.Badge
|
134
|
-
|
135
|
-
| Name | Type | Default | Description |
|
136
|
-
| :--- | :---------------- | :-----: | :----------------------------------- |
|
137
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
138
|
-
|
139
|
-
### Timeline.Body
|
140
|
-
|
141
|
-
| Name | Type | Default | Description |
|
142
|
-
| :--- | :---------------- | :-----: | :----------------------------------- |
|
143
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
144
|
-
|
145
|
-
### Timeline.Break
|
146
|
-
|
147
|
-
| Name | Type | Default | Description |
|
148
|
-
| :--- | :---------------- | :-----: | :----------------------------------- |
|
149
|
-
| sx | SystemStyleObject | {} | Style to be applied to the component |
|