@primer/components 31.2.1-rc.f73a0f8c → 32.0.1-rc.44e3df9b
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +2 -5
- package/.github/workflows/release.yml +0 -1
- package/.github/workflows/release_canary.yml +0 -1
- package/CHANGELOG.md +74 -4
- package/dist/browser.esm.js +299 -361
- package/dist/browser.esm.js.map +1 -1
- package/dist/browser.umd.js +294 -356
- package/dist/browser.umd.js.map +1 -1
- package/docs/content/ActionList2.mdx +8 -7
- package/docs/content/Breadcrumbs.md +11 -16
- package/docs/content/Buttons.md +7 -17
- package/docs/content/CircleBadge.md +0 -10
- package/docs/content/CounterLabel.md +0 -10
- package/docs/content/Dialog.md +15 -18
- package/docs/content/Dialog2.mdx +1 -0
- package/docs/content/Dropdown.md +11 -18
- package/docs/content/FilterList.md +10 -17
- package/docs/content/FilteredSearch.md +4 -11
- package/docs/content/Flash.md +5 -14
- package/docs/content/FormGroup.md +9 -17
- package/docs/content/Header.md +14 -16
- package/docs/content/Label.md +32 -25
- package/docs/content/LabelGroup.md +4 -14
- package/docs/content/Link.md +8 -17
- package/docs/content/Overlay.mdx +1 -10
- package/docs/content/Pagehead.md +4 -13
- package/docs/content/Pagination.md +10 -19
- package/docs/content/Popover.md +11 -19
- package/docs/content/SelectMenu.md +50 -114
- package/docs/content/SideNav.md +15 -23
- package/docs/content/StateLabel.md +5 -14
- package/docs/content/StyledOcticon.md +7 -16
- package/docs/content/SubNav.md +19 -21
- package/docs/content/TabNav.md +10 -18
- package/docs/content/Timeline.md +34 -24
- package/docs/content/Tooltip.md +8 -17
- package/docs/content/Truncate.md +7 -16
- package/docs/content/UnderlineNav.md +13 -21
- package/docs/package-lock.json +269 -158
- package/docs/package.json +1 -1
- package/lib/ActionList/index.js +23 -12
- package/lib/ActionList2/Group.d.ts +28 -2
- package/lib/ActionList2/Group.js +55 -6
- package/lib/ActionList2/List.d.ts +1 -1
- package/lib/ActionList2/index.js +41 -23
- package/lib/AnchoredOverlay/index.js +12 -4
- package/lib/Autocomplete/Autocomplete.d.ts +3 -3
- package/lib/Autocomplete/AutocompleteInput.d.ts +3 -3
- package/lib/Autocomplete/index.js +14 -7
- package/lib/Breadcrumbs.d.ts +8 -7
- package/lib/Breadcrumbs.js +7 -12
- package/lib/Button/Button.d.ts +2 -3
- package/lib/Button/Button.js +2 -6
- package/lib/Button/ButtonBase.d.ts +5 -8
- package/lib/Button/ButtonBase.js +1 -5
- package/lib/Button/ButtonClose.d.ts +3 -46
- package/lib/Button/ButtonClose.js +1 -1
- package/lib/Button/ButtonDanger.d.ts +2 -3
- package/lib/Button/ButtonDanger.js +2 -6
- package/lib/Button/ButtonInvisible.d.ts +2 -3
- package/lib/Button/ButtonInvisible.js +2 -6
- package/lib/Button/ButtonOutline.d.ts +2 -3
- package/lib/Button/ButtonOutline.js +2 -6
- package/lib/Button/ButtonPrimary.d.ts +2 -3
- package/lib/Button/ButtonPrimary.js +2 -6
- package/lib/Button/ButtonTableList.d.ts +1 -2
- package/lib/Button/ButtonTableList.js +1 -1
- package/lib/Button/index.js +70 -21
- package/lib/CircleBadge.d.ts +4 -5
- package/lib/CircleBadge.js +1 -1
- package/lib/CircleOcticon.d.ts +1 -1
- package/lib/CounterLabel.d.ts +1 -2
- package/lib/CounterLabel.js +1 -1
- package/lib/Dialog/Dialog.d.ts +5 -9
- package/lib/Dialog/Dialog.js +17 -11
- package/lib/Dialog.d.ts +4 -5
- package/lib/Dialog.js +1 -1
- package/lib/Dropdown.d.ts +10 -99
- package/lib/Dropdown.js +3 -3
- package/lib/DropdownMenu/DropdownButton.d.ts +3 -47
- package/lib/DropdownMenu/DropdownButton.js +3 -1
- package/lib/DropdownMenu/index.js +20 -6
- package/lib/DropdownStyles.js +26 -18
- package/lib/FilterList.d.ts +264 -303
- package/lib/FilterList.js +2 -6
- package/lib/FilteredActionList/index.js +12 -4
- package/lib/FilteredSearch.d.ts +1 -2
- package/lib/FilteredSearch.js +1 -1
- package/lib/Flash.d.ts +1 -2
- package/lib/Flash.js +1 -1
- package/lib/FormGroup.d.ts +4 -5
- package/lib/FormGroup.js +2 -2
- package/lib/Header.d.ts +6 -7
- package/lib/Header.js +4 -4
- package/lib/Label.d.ts +1 -2
- package/lib/Label.js +2 -3
- package/lib/LabelGroup.d.ts +1 -2
- package/lib/LabelGroup.js +1 -1
- package/lib/Link.d.ts +1 -2
- package/lib/Link.js +1 -1
- package/lib/NewButton/button.js +34 -42
- package/lib/NewButton/index.js +12 -5
- package/lib/NewButton/types.js +1 -2
- package/lib/Overlay.d.ts +11 -10
- package/lib/Overlay.js +3 -4
- package/lib/Pagehead.d.ts +1 -2
- package/lib/Pagehead.js +1 -1
- package/lib/Pagination/Pagination.js +1 -1
- package/lib/Pagination/index.js +12 -6
- package/lib/Popover.d.ts +4 -5
- package/lib/Popover.js +4 -5
- package/lib/Portal/index.js +16 -5
- package/lib/Position.d.ts +4 -4
- package/lib/SelectMenu/SelectMenu.d.ts +21 -189
- package/lib/SelectMenu/SelectMenu.js +1 -3
- package/lib/SelectMenu/SelectMenuDivider.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuDivider.js +1 -1
- package/lib/SelectMenu/SelectMenuFilter.js +1 -1
- package/lib/SelectMenu/SelectMenuFooter.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuFooter.js +1 -1
- package/lib/SelectMenu/SelectMenuHeader.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuHeader.js +1 -1
- package/lib/SelectMenu/SelectMenuItem.d.ts +2 -3
- package/lib/SelectMenu/SelectMenuItem.js +1 -1
- package/lib/SelectMenu/SelectMenuList.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuList.js +1 -1
- package/lib/SelectMenu/SelectMenuLoadingAnimation.d.ts +2 -2
- package/lib/SelectMenu/SelectMenuLoadingAnimation.js +3 -1
- package/lib/SelectMenu/SelectMenuModal.d.ts +2 -3
- package/lib/SelectMenu/SelectMenuModal.js +1 -1
- package/lib/SelectMenu/SelectMenuTab.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuTab.js +1 -1
- package/lib/SelectMenu/SelectMenuTabPanel.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuTabPanel.js +1 -1
- package/lib/SelectMenu/SelectMenuTabs.d.ts +1 -2
- package/lib/SelectMenu/SelectMenuTabs.js +1 -1
- package/lib/SelectMenu/hooks/useKeyboardNav.js +96 -80
- package/lib/SelectMenu/index.js +14 -7
- package/lib/SelectPanel/index.js +12 -4
- package/lib/SideNav.d.ts +11 -8
- package/lib/SideNav.js +8 -15
- package/lib/StateLabel.d.ts +1 -2
- package/lib/StateLabel.js +6 -5
- package/lib/StyledOcticon.d.ts +1 -2
- package/lib/StyledOcticon.js +1 -3
- package/lib/SubNav.d.ts +5 -11
- package/lib/SubNav.js +7 -12
- package/lib/TabNav.d.ts +3 -4
- package/lib/TabNav.js +2 -2
- package/lib/TextInputWithTokens.d.ts +3 -3
- package/lib/Timeline.d.ts +19 -393
- package/lib/Timeline.js +16 -13
- package/lib/Token/Token.d.ts +1 -1
- package/lib/Token/index.js +30 -11
- package/lib/Tooltip.d.ts +1 -2
- package/lib/Tooltip.js +1 -1
- package/lib/Truncate.d.ts +1 -2
- package/lib/Truncate.js +1 -3
- package/lib/UnderlineNav.d.ts +2 -3
- package/lib/UnderlineNav.js +2 -2
- package/lib/__tests__/Breadcrumbs.test.js +4 -1
- package/lib/__tests__/Breadcrumbs.types.test.d.ts +3 -0
- package/lib/__tests__/Breadcrumbs.types.test.js +25 -0
- package/lib/__tests__/Button.test.js +6 -2
- package/lib/__tests__/CircleBadge.types.test.d.ts +3 -0
- package/lib/__tests__/CircleBadge.types.test.js +28 -0
- package/lib/__tests__/CounterLabel.types.test.d.ts +3 -0
- package/lib/__tests__/CounterLabel.types.test.js +28 -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.types.test.d.ts +3 -0
- package/lib/__tests__/Dropdown.types.test.js +31 -0
- package/lib/__tests__/FilterList.types.test.d.ts +3 -0
- package/lib/__tests__/FilterList.types.test.js +27 -0
- package/lib/__tests__/FilteredSearch.types.test.d.ts +3 -0
- package/lib/__tests__/FilteredSearch.types.test.js +28 -0
- package/lib/__tests__/Flash.types.test.d.ts +3 -0
- package/lib/__tests__/Flash.types.test.js +28 -0
- package/lib/__tests__/FormGroup.types.test.d.ts +3 -0
- package/lib/__tests__/FormGroup.types.test.js +28 -0
- package/lib/__tests__/Header.types.test.d.ts +3 -0
- package/lib/__tests__/Header.types.test.js +29 -0
- package/lib/__tests__/KeyPaths.types.test.js +8 -5
- package/lib/__tests__/Label.types.test.d.ts +3 -0
- package/lib/__tests__/Label.types.test.js +28 -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.js +11 -5
- 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.js +19 -13
- package/lib/__tests__/Overlay.types.test.d.ts +3 -0
- package/lib/__tests__/Overlay.types.test.js +35 -0
- package/lib/__tests__/Pagehead.types.test.d.ts +3 -0
- package/lib/__tests__/Pagehead.types.test.js +28 -0
- package/lib/__tests__/Pagination.types.test.d.ts +3 -0
- package/lib/__tests__/Pagination.types.test.js +33 -0
- package/lib/__tests__/Popover.types.test.d.ts +3 -0
- package/lib/__tests__/Popover.types.test.js +27 -0
- package/lib/__tests__/SelectMenu.types.test.d.ts +3 -0
- package/lib/__tests__/SelectMenu.types.test.js +47 -0
- package/lib/__tests__/SideNav.types.test.d.ts +3 -0
- package/lib/__tests__/SideNav.types.test.js +28 -0
- package/lib/__tests__/StateLabel.types.test.d.ts +3 -0
- package/lib/__tests__/StateLabel.types.test.js +28 -0
- package/lib/__tests__/StyledOcticon.types.test.d.ts +3 -0
- package/lib/__tests__/StyledOcticon.types.test.js +32 -0
- package/lib/__tests__/SubNav.types.test.d.ts +3 -0
- package/lib/__tests__/SubNav.types.test.js +27 -0
- package/lib/__tests__/TabNav.types.test.d.ts +3 -0
- package/lib/__tests__/TabNav.types.test.js +25 -0
- package/lib/__tests__/Timeline.types.test.d.ts +3 -0
- package/lib/__tests__/Timeline.types.test.js +31 -0
- package/lib/__tests__/Tooltip.types.test.d.ts +3 -0
- package/lib/__tests__/Tooltip.types.test.js +28 -0
- package/lib/__tests__/Truncate.types.test.d.ts +3 -0
- package/lib/__tests__/Truncate.types.test.js +31 -0
- package/lib/__tests__/UnderlineNav.types.test.d.ts +3 -0
- package/lib/__tests__/UnderlineNav.types.test.js +25 -0
- package/lib/__tests__/behaviors/anchoredPosition.test.js +376 -229
- package/lib/__tests__/behaviors/scrollIntoViewingArea.test.js +216 -145
- package/lib/__tests__/filterObject.test.js +27 -48
- package/lib/__tests__/theme.test.js +34 -33
- package/lib/__tests__/themeGet.test.js +23 -12
- package/lib/behaviors/anchoredPosition.js +234 -205
- package/lib/behaviors/focusTrap.js +157 -121
- package/lib/behaviors/focusZone.js +509 -434
- package/lib/behaviors/scrollIntoViewingArea.js +35 -18
- package/lib/constants.js +43 -39
- package/lib/drafts.js +30 -20
- package/lib/hooks/index.js +60 -16
- package/lib/hooks/useAnchoredPosition.js +40 -32
- package/lib/hooks/useCombinedRefs.js +36 -32
- package/lib/hooks/useDialog.js +96 -72
- package/lib/hooks/useFocusTrap.js +60 -43
- package/lib/hooks/useFocusZone.js +50 -54
- package/lib/hooks/useOnEscapePress.js +36 -25
- package/lib/hooks/useOpenAndCloseFocus.js +34 -22
- package/lib/hooks/useProvidedRefOrCreate.js +14 -10
- package/lib/hooks/useProvidedStateOrCreate.js +16 -13
- package/lib/hooks/useRenderForcingRef.js +17 -13
- package/lib/hooks/useResizeObserver.js +18 -15
- package/lib/hooks/useSafeTimeout.js +30 -22
- package/lib/hooks/useScrollFlash.js +23 -16
- package/lib/index.js +644 -163
- package/lib/polyfills/eventListenerSignal.js +45 -37
- package/lib/stories/ActionList2.stories.js +4 -3
- package/lib/stories/ActionMenu.stories.js +1 -3
- package/lib/stories/ConfirmationDialog.stories.js +16 -8
- package/lib/stories/Dialog.stories.js +6 -2
- package/lib/stories/useFocusTrap.stories.js +6 -2
- package/lib/stories/useFocusZone.stories.js +13 -5
- package/lib/sx.js +22 -10
- package/lib/theme-preval.js +3169 -64
- package/lib/theme.js +12 -3
- package/lib/utils/iterateFocusableElements.js +85 -63
- package/lib/utils/testing.d.ts +1 -1
- package/lib/utils/theme.js +47 -33
- package/lib/utils/types/AriaRole.js +1 -2
- package/lib/utils/types/ComponentProps.js +1 -2
- package/lib/utils/types/Flatten.js +1 -2
- package/lib/utils/types/KeyPaths.js +1 -2
- package/lib/utils/types/MandateProps.js +1 -16
- package/lib/utils/types/Merge.js +1 -2
- package/lib/utils/types/index.js +69 -16
- package/lib/utils/uniqueId.js +8 -5
- package/lib/utils/use-force-update.js +14 -8
- package/lib/utils/useIsomorphicLayoutEffect.js +11 -8
- package/lib/utils/userAgent.js +12 -8
- package/lib-esm/ActionList2/Group.d.ts +28 -2
- package/lib-esm/ActionList2/Group.js +52 -5
- package/lib-esm/ActionList2/List.d.ts +1 -1
- package/lib-esm/Autocomplete/Autocomplete.d.ts +3 -3
- package/lib-esm/Autocomplete/AutocompleteInput.d.ts +3 -3
- package/lib-esm/Breadcrumbs.d.ts +8 -7
- package/lib-esm/Breadcrumbs.js +8 -13
- package/lib-esm/Button/Button.d.ts +2 -3
- package/lib-esm/Button/Button.js +2 -2
- package/lib-esm/Button/ButtonBase.d.ts +5 -8
- package/lib-esm/Button/ButtonBase.js +1 -3
- package/lib-esm/Button/ButtonClose.d.ts +3 -46
- package/lib-esm/Button/ButtonClose.js +2 -2
- package/lib-esm/Button/ButtonDanger.d.ts +2 -3
- package/lib-esm/Button/ButtonDanger.js +2 -2
- package/lib-esm/Button/ButtonInvisible.d.ts +2 -3
- package/lib-esm/Button/ButtonInvisible.js +2 -2
- package/lib-esm/Button/ButtonOutline.d.ts +2 -3
- package/lib-esm/Button/ButtonOutline.js +2 -2
- package/lib-esm/Button/ButtonPrimary.d.ts +2 -3
- package/lib-esm/Button/ButtonPrimary.js +2 -2
- package/lib-esm/Button/ButtonTableList.d.ts +1 -2
- package/lib-esm/Button/ButtonTableList.js +2 -2
- package/lib-esm/CircleBadge.d.ts +4 -5
- package/lib-esm/CircleBadge.js +2 -2
- package/lib-esm/CircleOcticon.d.ts +1 -1
- package/lib-esm/CounterLabel.d.ts +1 -2
- package/lib-esm/CounterLabel.js +2 -2
- package/lib-esm/Dialog/Dialog.d.ts +5 -9
- package/lib-esm/Dialog/Dialog.js +12 -12
- package/lib-esm/Dialog.d.ts +4 -5
- package/lib-esm/Dialog.js +2 -2
- package/lib-esm/Dropdown.d.ts +10 -99
- package/lib-esm/Dropdown.js +4 -4
- package/lib-esm/DropdownMenu/DropdownButton.d.ts +3 -47
- package/lib-esm/DropdownMenu/DropdownButton.js +3 -1
- package/lib-esm/FilterList.d.ts +264 -303
- package/lib-esm/FilterList.js +3 -7
- package/lib-esm/FilteredSearch.d.ts +1 -2
- package/lib-esm/FilteredSearch.js +2 -2
- package/lib-esm/Flash.d.ts +1 -2
- package/lib-esm/Flash.js +2 -2
- package/lib-esm/FormGroup.d.ts +4 -5
- package/lib-esm/FormGroup.js +3 -3
- package/lib-esm/Header.d.ts +6 -7
- package/lib-esm/Header.js +5 -5
- package/lib-esm/Label.d.ts +1 -2
- package/lib-esm/Label.js +3 -4
- package/lib-esm/LabelGroup.d.ts +1 -2
- package/lib-esm/LabelGroup.js +2 -2
- package/lib-esm/Link.d.ts +1 -2
- package/lib-esm/Link.js +2 -2
- package/lib-esm/NewButton/button.js +31 -42
- package/lib-esm/Overlay.d.ts +11 -10
- package/lib-esm/Overlay.js +2 -3
- package/lib-esm/Pagehead.d.ts +1 -2
- package/lib-esm/Pagehead.js +2 -2
- package/lib-esm/Pagination/Pagination.js +2 -2
- package/lib-esm/Popover.d.ts +4 -5
- package/lib-esm/Popover.js +4 -5
- package/lib-esm/Position.d.ts +4 -4
- package/lib-esm/SelectMenu/SelectMenu.d.ts +21 -189
- package/lib-esm/SelectMenu/SelectMenu.js +1 -2
- package/lib-esm/SelectMenu/SelectMenuDivider.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuDivider.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuFilter.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuFooter.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuFooter.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuHeader.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuHeader.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuItem.d.ts +2 -3
- package/lib-esm/SelectMenu/SelectMenuItem.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuList.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuList.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuLoadingAnimation.d.ts +2 -2
- package/lib-esm/SelectMenu/SelectMenuLoadingAnimation.js +3 -2
- package/lib-esm/SelectMenu/SelectMenuModal.d.ts +2 -3
- package/lib-esm/SelectMenu/SelectMenuModal.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuTab.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuTab.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuTabPanel.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuTabPanel.js +2 -2
- package/lib-esm/SelectMenu/SelectMenuTabs.d.ts +1 -2
- package/lib-esm/SelectMenu/SelectMenuTabs.js +2 -2
- package/lib-esm/SideNav.d.ts +11 -8
- package/lib-esm/SideNav.js +8 -16
- package/lib-esm/StateLabel.d.ts +1 -2
- package/lib-esm/StateLabel.js +7 -6
- package/lib-esm/StyledOcticon.d.ts +1 -2
- package/lib-esm/StyledOcticon.js +1 -2
- package/lib-esm/SubNav.d.ts +5 -11
- package/lib-esm/SubNav.js +8 -13
- package/lib-esm/TabNav.d.ts +3 -4
- package/lib-esm/TabNav.js +3 -3
- package/lib-esm/TextInputWithTokens.d.ts +3 -3
- package/lib-esm/Timeline.d.ts +19 -393
- package/lib-esm/Timeline.js +12 -13
- package/lib-esm/Token/Token.d.ts +1 -1
- package/lib-esm/Tooltip.d.ts +1 -2
- package/lib-esm/Tooltip.js +2 -2
- package/lib-esm/Truncate.d.ts +1 -2
- package/lib-esm/Truncate.js +1 -2
- package/lib-esm/UnderlineNav.d.ts +2 -3
- package/lib-esm/UnderlineNav.js +3 -3
- package/lib-esm/__tests__/Breadcrumbs.test.js +4 -1
- 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__/Button.test.js +6 -2
- 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__/CounterLabel.types.test.d.ts +3 -0
- package/lib-esm/__tests__/CounterLabel.types.test.js +13 -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.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Dropdown.types.test.js +17 -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__/FilteredSearch.types.test.d.ts +3 -0
- package/lib-esm/__tests__/FilteredSearch.types.test.js +13 -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__/FormGroup.types.test.d.ts +3 -0
- package/lib-esm/__tests__/FormGroup.types.test.js +13 -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__/Label.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Label.types.test.js +13 -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.js +11 -5
- 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__/Overlay.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Overlay.types.test.js +20 -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.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Pagination.types.test.js +18 -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__/SelectMenu.types.test.d.ts +3 -0
- package/lib-esm/__tests__/SelectMenu.types.test.js +33 -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__/StateLabel.types.test.d.ts +3 -0
- package/lib-esm/__tests__/StateLabel.types.test.js +13 -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.types.test.d.ts +3 -0
- package/lib-esm/__tests__/SubNav.types.test.js +14 -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__/Timeline.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Timeline.types.test.js +18 -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.types.test.d.ts +3 -0
- package/lib-esm/__tests__/Truncate.types.test.js +16 -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/stories/ActionList2.stories.js +4 -3
- package/lib-esm/stories/ActionMenu.stories.js +1 -3
- package/lib-esm/stories/ConfirmationDialog.stories.js +16 -8
- package/lib-esm/stories/Dialog.stories.js +6 -2
- package/lib-esm/stories/useFocusTrap.stories.js +6 -2
- package/lib-esm/stories/useFocusZone.stories.js +13 -5
- package/lib-esm/theme-preval.js +446 -0
- package/lib-esm/utils/testing.d.ts +1 -1
- package/package-lock.json +16 -16
- package/package.json +4 -5
- package/script/build +1 -1
- package/src/ActionList2/Group.tsx +76 -7
- package/src/ActionList2/List.tsx +1 -1
- package/src/Breadcrumbs.tsx +11 -11
- package/src/Button/Button.tsx +2 -3
- package/src/Button/ButtonBase.tsx +2 -6
- package/src/Button/ButtonClose.tsx +2 -6
- package/src/Button/ButtonDanger.tsx +2 -3
- package/src/Button/ButtonInvisible.tsx +2 -3
- package/src/Button/ButtonOutline.tsx +2 -3
- package/src/Button/ButtonPrimary.tsx +2 -3
- package/src/Button/ButtonTableList.tsx +2 -15
- package/src/CircleBadge.tsx +2 -4
- package/src/CounterLabel.tsx +2 -4
- package/src/Dialog/Dialog.tsx +22 -11
- package/src/Dialog.tsx +2 -6
- package/src/Dropdown.tsx +3 -7
- package/src/DropdownMenu/DropdownButton.tsx +1 -1
- package/src/FilterList.tsx +5 -11
- package/src/FilteredSearch.tsx +2 -3
- package/src/Flash.tsx +2 -4
- package/src/FormGroup.tsx +3 -6
- package/src/Header.tsx +4 -14
- package/src/Label.tsx +2 -5
- package/src/LabelGroup.tsx +2 -3
- package/src/Link.tsx +2 -6
- package/src/NewButton/button.tsx +82 -78
- package/src/Overlay.tsx +13 -11
- package/src/Pagehead.tsx +2 -3
- package/src/Pagination/Pagination.tsx +3 -5
- package/src/Popover.tsx +3 -14
- package/src/SelectMenu/SelectMenu.tsx +1 -3
- package/src/SelectMenu/SelectMenuDivider.tsx +2 -3
- package/src/SelectMenu/SelectMenuFilter.tsx +2 -3
- package/src/SelectMenu/SelectMenuFooter.tsx +2 -3
- package/src/SelectMenu/SelectMenuHeader.tsx +2 -4
- package/src/SelectMenu/SelectMenuItem.tsx +2 -3
- package/src/SelectMenu/SelectMenuList.tsx +2 -3
- package/src/SelectMenu/SelectMenuLoadingAnimation.tsx +4 -3
- package/src/SelectMenu/SelectMenuModal.tsx +2 -4
- package/src/SelectMenu/SelectMenuTab.tsx +2 -3
- package/src/SelectMenu/SelectMenuTabPanel.tsx +2 -3
- package/src/SelectMenu/SelectMenuTabs.tsx +2 -3
- package/src/SideNav.tsx +11 -13
- package/src/StateLabel.tsx +3 -5
- package/src/StyledOcticon.tsx +1 -3
- package/src/SubNav.tsx +8 -13
- package/src/TabNav.tsx +3 -7
- package/src/Timeline.tsx +11 -12
- package/src/Tooltip.tsx +3 -3
- package/src/Truncate.tsx +0 -5
- package/src/UnderlineNav.tsx +3 -6
- package/src/__tests__/Breadcrumbs.test.tsx +1 -1
- package/src/__tests__/Breadcrumbs.types.test.tsx +22 -0
- package/src/__tests__/Button.test.tsx +2 -2
- package/src/__tests__/CircleBadge.types.test.tsx +11 -0
- package/src/__tests__/CounterLabel.types.test.tsx +11 -0
- package/src/__tests__/Dialog.types.test.tsx +11 -0
- package/src/__tests__/Dialog2.types.test.tsx +11 -0
- package/src/__tests__/Dropdown.types.test.tsx +21 -0
- package/src/__tests__/FilterList.types.test.tsx +17 -0
- package/src/__tests__/FilteredSearch.types.test.tsx +11 -0
- package/src/__tests__/Flash.types.test.tsx +11 -0
- package/src/__tests__/FormGroup.types.test.tsx +11 -0
- package/src/__tests__/Header.types.test.tsx +19 -0
- package/src/__tests__/Label.types.test.tsx +11 -0
- package/src/__tests__/LabelGroup.types.test.tsx +11 -0
- package/src/__tests__/Link.test.tsx +5 -5
- package/src/__tests__/Link.types.test.tsx +11 -0
- package/src/__tests__/Overlay.types.test.tsx +18 -0
- package/src/__tests__/Pagehead.types.test.tsx +11 -0
- package/src/__tests__/Pagination.types.test.tsx +11 -0
- package/src/__tests__/Popover.types.test.tsx +17 -0
- package/src/__tests__/SelectMenu.types.test.tsx +37 -0
- package/src/__tests__/SideNav.types.test.tsx +11 -0
- package/src/__tests__/StateLabel.types.test.tsx +11 -0
- package/src/__tests__/StyledOcticon.types.test.tsx +12 -0
- package/src/__tests__/SubNav.types.test.tsx +25 -0
- package/src/__tests__/TabNav.types.test.tsx +22 -0
- package/src/__tests__/Timeline.types.test.tsx +31 -0
- package/src/__tests__/Tooltip.types.test.tsx +11 -0
- package/src/__tests__/Truncate.types.test.tsx +11 -0
- package/src/__tests__/UnderlineNav.types.test.tsx +22 -0
- package/src/__tests__/__snapshots__/Label.test.tsx.snap +3 -4
- package/src/__tests__/__snapshots__/Link.test.tsx.snap +1 -2
- package/src/__tests__/__snapshots__/NewButton.test.tsx.snap +5 -0
- package/src/stories/ActionList2.stories.tsx +3 -3
- package/src/stories/ActionMenu.stories.tsx +1 -4
- package/src/stories/ConfirmationDialog.stories.tsx +4 -4
- package/src/stories/Dialog.stories.tsx +2 -2
- package/src/stories/useFocusTrap.stories.tsx +2 -2
- package/src/stories/useFocusZone.stories.tsx +4 -4
- package/stats.html +1 -1
- package/tsconfig.build.json +2 -2
- package/tsconfig.json +17 -4
- package/lib/ActionList/Divider.jsx +0 -29
- package/lib/ActionList/Group.jsx +0 -23
- package/lib/ActionList/Header.jsx +0 -66
- package/lib/ActionList/Item.jsx +0 -288
- package/lib/ActionList/List.jsx +0 -138
- package/lib/ActionList2/Description.jsx +0 -29
- package/lib/ActionList2/Divider.jsx +0 -22
- package/lib/ActionList2/Group.jsx +0 -25
- package/lib/ActionList2/Header.jsx +0 -36
- package/lib/ActionList2/Item.jsx +0 -174
- package/lib/ActionList2/LinkItem.jsx +0 -28
- package/lib/ActionList2/List.jsx +0 -41
- package/lib/ActionList2/Selection.jsx +0 -50
- package/lib/ActionList2/Visuals.jsx +0 -48
- package/lib/ActionMenu.jsx +0 -73
- package/lib/AnchoredOverlay/AnchoredOverlay.jsx +0 -100
- package/lib/Autocomplete/Autocomplete.jsx +0 -100
- package/lib/Autocomplete/AutocompleteContext.jsx +0 -5
- package/lib/Autocomplete/AutocompleteInput.jsx +0 -113
- package/lib/Autocomplete/AutocompleteMenu.jsx +0 -190
- package/lib/Autocomplete/AutocompleteOverlay.jsx +0 -55
- package/lib/Avatar.jsx +0 -34
- package/lib/AvatarPair.jsx +0 -29
- package/lib/AvatarStack.jsx +0 -151
- package/lib/BaseStyles.jsx +0 -65
- package/lib/BorderBox.jsx +0 -18
- package/lib/Box.jsx +0 -10
- package/lib/BranchName.jsx +0 -20
- package/lib/Breadcrumbs.jsx +0 -74
- package/lib/Button/Button.jsx +0 -60
- package/lib/Button/ButtonBase.jsx +0 -36
- package/lib/Button/ButtonClose.jsx +0 -55
- package/lib/Button/ButtonDanger.jsx +0 -63
- package/lib/Button/ButtonGroup.jsx +0 -55
- package/lib/Button/ButtonInvisible.jsx +0 -52
- package/lib/Button/ButtonOutline.jsx +0 -63
- package/lib/Button/ButtonPrimary.jsx +0 -62
- package/lib/Button/ButtonStyles.jsx +0 -37
- package/lib/Button/ButtonTableList.jsx +0 -49
- package/lib/Caret.jsx +0 -93
- package/lib/CircleBadge.jsx +0 -43
- package/lib/CircleOcticon.jsx +0 -21
- package/lib/CounterLabel.jsx +0 -44
- package/lib/Details.jsx +0 -21
- package/lib/Dialog/ConfirmationDialog.jsx +0 -146
- package/lib/Dialog/Dialog.jsx +0 -273
- package/lib/Dialog.jsx +0 -131
- package/lib/Dropdown.jsx +0 -134
- package/lib/DropdownMenu/DropdownButton.jsx +0 -14
- package/lib/DropdownMenu/DropdownMenu.jsx +0 -70
- package/lib/FilterList.jsx +0 -63
- package/lib/FilteredActionList/FilteredActionList.jsx +0 -100
- package/lib/FilteredSearch.jsx +0 -29
- package/lib/Flash.jsx +0 -70
- package/lib/Flex.jsx +0 -15
- package/lib/FormGroup.jsx +0 -25
- package/lib/Grid.jsx +0 -15
- package/lib/Header.jsx +0 -90
- package/lib/Heading.jsx +0 -21
- package/lib/Label.jsx +0 -84
- package/lib/LabelGroup.jsx +0 -19
- package/lib/Link.jsx +0 -38
- package/lib/NewButton/button-counter.jsx +0 -14
- package/lib/NewButton/button.jsx +0 -278
- package/lib/Overlay.jsx +0 -156
- package/lib/Pagehead.jsx +0 -18
- package/lib/Pagination/Pagination.jsx +0 -163
- package/lib/Pagination/model.jsx +0 -174
- package/lib/PointerBox.jsx +0 -25
- package/lib/Popover.jsx +0 -210
- package/lib/Portal/Portal.jsx +0 -79
- package/lib/Position.jsx +0 -46
- package/lib/ProgressBar.jsx +0 -39
- package/lib/SelectMenu/SelectMenu.jsx +0 -114
- package/lib/SelectMenu/SelectMenuContext.jsx +0 -5
- package/lib/SelectMenu/SelectMenuDivider.jsx +0 -43
- package/lib/SelectMenu/SelectMenuFilter.jsx +0 -59
- package/lib/SelectMenu/SelectMenuFooter.jsx +0 -46
- package/lib/SelectMenu/SelectMenuHeader.jsx +0 -44
- package/lib/SelectMenu/SelectMenuItem.jsx +0 -143
- package/lib/SelectMenu/SelectMenuList.jsx +0 -60
- package/lib/SelectMenu/SelectMenuLoadingAnimation.jsx +0 -21
- package/lib/SelectMenu/SelectMenuModal.jsx +0 -119
- package/lib/SelectMenu/SelectMenuTab.jsx +0 -93
- package/lib/SelectMenu/SelectMenuTabPanel.jsx +0 -43
- package/lib/SelectMenu/SelectMenuTabs.jsx +0 -58
- package/lib/SelectPanel/SelectPanel.jsx +0 -105
- package/lib/SideNav.jsx +0 -177
- package/lib/Spinner.jsx +0 -35
- package/lib/StateLabel.jsx +0 -94
- package/lib/StyledOcticon.jsx +0 -20
- package/lib/SubNav.jsx +0 -104
- package/lib/TabNav.jsx +0 -60
- package/lib/Text.jsx +0 -14
- package/lib/TextInput.jsx +0 -23
- package/lib/TextInputWithTokens.jsx +0 -218
- package/lib/ThemeProvider.jsx +0 -130
- package/lib/Timeline.jsx +0 -124
- package/lib/Token/AvatarToken.jsx +0 -54
- package/lib/Token/IssueLabelToken.jsx +0 -125
- package/lib/Token/Token.jsx +0 -103
- package/lib/Token/TokenBase.jsx +0 -88
- package/lib/Token/_RemoveTokenButton.jsx +0 -108
- package/lib/Token/_TokenTextContainer.jsx +0 -49
- package/lib/Tooltip.jsx +0 -246
- package/lib/Truncate.jsx +0 -27
- package/lib/UnderlineNav.jsx +0 -90
- package/lib/_TextInputWrapper.jsx +0 -120
- package/lib/_UnstyledTextInput.jsx +0 -22
- package/lib/__tests__/ActionList.test.jsx +0 -49
- package/lib/__tests__/ActionList.types.test.jsx +0 -45
- package/lib/__tests__/ActionList2.test.jsx +0 -46
- package/lib/__tests__/ActionMenu.test.jsx +0 -124
- package/lib/__tests__/AnchoredOverlay.test.jsx +0 -121
- package/lib/__tests__/Autocomplete.test.jsx +0 -299
- package/lib/__tests__/Avatar.test.jsx +0 -42
- package/lib/__tests__/AvatarStack.test.jsx +0 -43
- package/lib/__tests__/BorderBox.test.jsx +0 -36
- package/lib/__tests__/Box.test.jsx +0 -41
- package/lib/__tests__/BranchName.test.jsx +0 -27
- package/lib/__tests__/Breadcrumbs.test.jsx +0 -28
- package/lib/__tests__/BreadcrumbsItem.test.jsx +0 -31
- package/lib/__tests__/Button.test.jsx +0 -100
- package/lib/__tests__/Caret.test.jsx +0 -37
- package/lib/__tests__/CircleBadge.test.jsx +0 -55
- package/lib/__tests__/CircleOcticon.test.jsx +0 -45
- package/lib/__tests__/ConfirmationDialog.test.jsx +0 -119
- package/lib/__tests__/CounterLabel.test.jsx +0 -36
- package/lib/__tests__/Details.test.jsx +0 -85
- package/lib/__tests__/Dialog.test.jsx +0 -139
- package/lib/__tests__/Dropdown.test.jsx +0 -49
- package/lib/__tests__/DropdownMenu.test.jsx +0 -119
- package/lib/__tests__/FilterList.test.jsx +0 -27
- package/lib/__tests__/FilterListItem.test.jsx +0 -31
- package/lib/__tests__/FilteredSearch.test.jsx +0 -27
- package/lib/__tests__/Flash.test.jsx +0 -36
- package/lib/__tests__/Flex.test.jsx +0 -51
- package/lib/__tests__/FormGroup.test.jsx +0 -36
- package/lib/__tests__/Grid.test.jsx +0 -69
- package/lib/__tests__/Header.test.jsx +0 -45
- package/lib/__tests__/Heading.test.jsx +0 -71
- package/lib/__tests__/Label.test.jsx +0 -33
- package/lib/__tests__/LabelGroup.test.jsx +0 -29
- package/lib/__tests__/Link.test.jsx +0 -43
- package/lib/__tests__/NewButton.test.jsx +0 -61
- package/lib/__tests__/Overlay.test.jsx +0 -105
- package/lib/__tests__/Pagehead.test.jsx +0 -25
- package/lib/__tests__/Pagination/Pagination.test.jsx +0 -32
- package/lib/__tests__/Pagination/PaginationModel.test.jsx +0 -118
- package/lib/__tests__/PointerBox.test.jsx +0 -33
- package/lib/__tests__/Popover.test.jsx +0 -58
- package/lib/__tests__/Portal.test.jsx +0 -102
- package/lib/__tests__/Position.test.jsx +0 -96
- package/lib/__tests__/ProgressBar.test.jsx +0 -38
- package/lib/__tests__/SelectMenu.test.jsx +0 -120
- package/lib/__tests__/SelectPanel.test.jsx +0 -48
- package/lib/__tests__/SideNav.test.jsx +0 -55
- package/lib/__tests__/Spinner.test.jsx +0 -41
- package/lib/__tests__/StateLabel.test.jsx +0 -46
- package/lib/__tests__/StyledOcticon.test.jsx +0 -28
- package/lib/__tests__/SubNav.test.jsx +0 -47
- package/lib/__tests__/SubNavLink.test.jsx +0 -31
- package/lib/__tests__/TabNav.test.jsx +0 -32
- package/lib/__tests__/Text.test.jsx +0 -71
- package/lib/__tests__/TextInput.test.jsx +0 -45
- package/lib/__tests__/TextInputWithTokens.test.jsx +0 -302
- package/lib/__tests__/ThemeProvider.test.jsx +0 -314
- package/lib/__tests__/Timeline.test.jsx +0 -51
- package/lib/__tests__/Token.test.jsx +0 -93
- package/lib/__tests__/Tooltip.test.jsx +0 -46
- package/lib/__tests__/Truncate.test.jsx +0 -41
- package/lib/__tests__/UnderlineNav.test.jsx +0 -53
- package/lib/__tests__/UnderlineNavLink.test.jsx +0 -31
- package/lib/__tests__/behaviors/focusTrap.test.jsx +0 -184
- package/lib/__tests__/behaviors/focusZone.test.jsx +0 -406
- package/lib/__tests__/behaviors/iterateFocusableElements.test.jsx +0 -58
- package/lib/__tests__/hooks/useAnchoredPosition.test.jsx +0 -29
- package/lib/__tests__/hooks/useOnEscapePress.test.jsx +0 -19
- package/lib/__tests__/hooks/useOnOutsideClick.test.jsx +0 -63
- package/lib/__tests__/hooks/useOpenAndCloseFocus.test.jsx +0 -61
- package/lib/__tests__/hooks/useProvidedStateOrCreate.test.jsx +0 -56
- package/lib/__tests__/useSafeTimeout.test.jsx +0 -36
- package/lib/__tests__/utils/createSlots.test.jsx +0 -57
- package/lib/hooks/useDetails.jsx +0 -39
- package/lib/hooks/useOnOutsideClick.jsx +0 -61
- package/lib/hooks/useOverlay.jsx +0 -15
- package/lib/utils/create-slots.jsx +0 -65
- package/lib/utils/deprecate.jsx +0 -59
- package/lib/utils/isNumeric.jsx +0 -7
- package/lib/utils/ssr.jsx +0 -6
- package/lib/utils/test-deprecations.jsx +0 -20
- package/lib/utils/test-helpers.jsx +0 -8
- package/lib/utils/test-matchers.jsx +0 -100
- package/lib/utils/testing.jsx +0 -206
- package/tsconfig.base.json +0 -20
@@ -127,27 +127,18 @@ To hide all the page numbers and create a simple pagination container with just
|
|
127
127
|
</State>
|
128
128
|
```
|
129
129
|
|
130
|
-
## System props
|
131
|
-
|
132
|
-
<Note variant="warning">
|
133
|
-
|
134
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
135
|
-
|
136
|
-
</Note>
|
137
|
-
|
138
|
-
Pagination components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
139
|
-
|
140
130
|
## Component props
|
141
131
|
|
142
|
-
| Name | Type
|
143
|
-
| :------------------- |
|
144
|
-
| currentPage | Number
|
145
|
-
| hrefBuilder | Function
|
146
|
-
| marginPageCount | Number
|
147
|
-
| onPageChange | Function
|
148
|
-
| pageCount | Number
|
149
|
-
| showPages | Boolean
|
150
|
-
| surroundingPageCount | Number
|
132
|
+
| Name | Type | Default | Description |
|
133
|
+
| :------------------- | :---------------- | :--------: | :--------------------------------------------------------------------- |
|
134
|
+
| currentPage | Number | | **Required.** The currently selected page. |
|
135
|
+
| hrefBuilder | Function | `#${page}` | A function to generate links based on page number. |
|
136
|
+
| marginPageCount | Number | 1 | How many pages to always show at the left and right of the component. |
|
137
|
+
| onPageChange | Function | no-op | Called with event and page number when a page is clicked. |
|
138
|
+
| pageCount | Number | | **Required.** The total number of pages. |
|
139
|
+
| showPages | Boolean | `true` | Whether or not to show the individual page links. |
|
140
|
+
| surroundingPageCount | Number | 2 | How many pages to display on each side of the currently selected page. |
|
141
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
151
142
|
|
152
143
|
## Theming
|
153
144
|
|
package/docs/content/Popover.md
CHANGED
@@ -105,26 +105,17 @@ function CaretSelector(props) {
|
|
105
105
|
render(<PopoverDemo />)
|
106
106
|
```
|
107
107
|
|
108
|
-
## System props
|
109
|
-
|
110
|
-
<Note variant="warning">
|
111
|
-
|
112
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
113
|
-
|
114
|
-
</Note>
|
115
|
-
|
116
|
-
ProgressBar components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
117
|
-
|
118
108
|
## Component props
|
119
109
|
|
120
110
|
### Popover
|
121
111
|
|
122
|
-
| Name | Type
|
123
|
-
| :------- |
|
124
|
-
| as | String
|
125
|
-
| caret | String
|
126
|
-
| open | Boolean
|
127
|
-
| relative | Boolean
|
112
|
+
| Name | Type | Default | Description |
|
113
|
+
| :------- | :---------------- | :-----: | :----------------------------------------------------------------------------- |
|
114
|
+
| as | String | 'div' | Sets the HTML tag for the component. |
|
115
|
+
| caret | String | 'top' | Controls the position of the caret. See below for the list of caret positions. |
|
116
|
+
| open | Boolean | false | Controls the visibility of the popover. |
|
117
|
+
| relative | Boolean | false | Set to true to render the popover using relative positioning. |
|
118
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
128
119
|
|
129
120
|
#### Caret Positions
|
130
121
|
|
@@ -132,6 +123,7 @@ The `caret` prop can be one of the following values: `top`, `bottom`, `left`, `r
|
|
132
123
|
|
133
124
|
### Popover.Content
|
134
125
|
|
135
|
-
| Name | Type
|
136
|
-
| :--- |
|
137
|
-
| as | String
|
126
|
+
| Name | Type | Default | Description |
|
127
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
128
|
+
| as | String | 'div' | Sets the HTML tag for the component. |
|
129
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
@@ -33,10 +33,11 @@ Main wrapper component for select menu.
|
|
33
33
|
|
34
34
|
### Component Props
|
35
35
|
|
36
|
-
| Name | Type
|
37
|
-
| :--------- |
|
38
|
-
| initialTab | String
|
39
|
-
| ref | React ref
|
36
|
+
| Name | Type | Default | Description |
|
37
|
+
| :--------- | :---------------- | :-----: | :--------------------------------------------------------------------------------------------------------------------------------------- |
|
38
|
+
| initialTab | String | | If using the `SelectMenu.Tabs` component, you can use this prop to change the tab shown on open. By default, the first tab will be used. |
|
39
|
+
| ref | React ref | | ref to pass down to SelectMenu component |
|
40
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
40
41
|
|
41
42
|
## SelectMenu.MenuContext
|
42
43
|
|
@@ -82,9 +83,7 @@ const MyButton = () => {
|
|
82
83
|
Used to wrap the content in a `SelectMenu`.
|
83
84
|
|
84
85
|
```jsx
|
85
|
-
<SelectMenu.Modal>
|
86
|
-
{/* all menu content is wrapped in the modal*/}
|
87
|
-
</SelectMenu.Modal>
|
86
|
+
<SelectMenu.Modal>{/* all menu content is wrapped in the modal*/}</SelectMenu.Modal>
|
88
87
|
```
|
89
88
|
|
90
89
|
### Right-aligned modal
|
@@ -110,10 +109,11 @@ Use the `align='right'` prop to align the modal to the right. Note that this onl
|
|
110
109
|
|
111
110
|
### Component Props
|
112
111
|
|
113
|
-
| Prop name | Type
|
114
|
-
| :-------- |
|
115
|
-
| align | String
|
116
|
-
| width | String or Number
|
112
|
+
| Prop name | Type | Default | Description |
|
113
|
+
| :-------- | :---------------- | :------ | ------------------------------------------------- |
|
114
|
+
| align | String | 'left' | Use `right` to align the select menu to the right |
|
115
|
+
| width | String or Number | 300px | Sets the modal width |
|
116
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
117
117
|
|
118
118
|
## SelectMenu.List
|
119
119
|
|
@@ -125,7 +125,9 @@ Used to wrap the select menu list content. All menu items **must** be wrapped in
|
|
125
125
|
|
126
126
|
### Component Props
|
127
127
|
|
128
|
-
|
128
|
+
| Name | Type | Default | Description |
|
129
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
130
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
129
131
|
|
130
132
|
## SelectMenu.Item
|
131
133
|
|
@@ -139,22 +141,13 @@ You can use a `button` tag instead by utilizing the [`as` prop](/core-concepts#t
|
|
139
141
|
</SelectMenu.Item>
|
140
142
|
```
|
141
143
|
|
142
|
-
### System props
|
143
|
-
|
144
|
-
<Note variant="warning">
|
145
|
-
|
146
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
147
|
-
|
148
|
-
</Note>
|
149
|
-
|
150
|
-
SelectMenu components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
151
|
-
|
152
144
|
### Component Props
|
153
145
|
|
154
|
-
| Name | Type
|
155
|
-
| :------- |
|
156
|
-
| selected | boolean
|
157
|
-
| onClick | function
|
146
|
+
| Name | Type | Default | Description |
|
147
|
+
| :------- | :---------------- | :-----: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
148
|
+
| selected | boolean | | Used to apply styles to the selected items in the list. |
|
149
|
+
| onClick | function | | Function called when item is clicked. By default we also close the menu when items are clicked. If you would like the menu to stay open, pass an `e.preventDefault()` to your onClick handler. |
|
150
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
158
151
|
|
159
152
|
## SelectMenu.Filter
|
160
153
|
|
@@ -177,23 +170,14 @@ Use a `SelectMenu.Filter` to add a filter UI to your select menu. Users are expe
|
|
177
170
|
</SelectMenu>
|
178
171
|
```
|
179
172
|
|
180
|
-
### System Props
|
181
|
-
|
182
|
-
<Note variant="warning">
|
183
|
-
|
184
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
185
|
-
|
186
|
-
</Note>
|
187
|
-
|
188
|
-
SelectMenu.Filter components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
189
|
-
|
190
173
|
### Component Props
|
191
174
|
|
192
175
|
SelectMenu.Filter components receive all the props that the [TextInput](/TextInput) component gets.
|
193
176
|
|
194
|
-
| Name | Type
|
195
|
-
| :---- |
|
196
|
-
| value | String
|
177
|
+
| Name | Type | Default | Description |
|
178
|
+
| :---- | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------------- |
|
179
|
+
| value | String | | Users of this component must provide a value for the filter input that is managed in the consuming application |
|
180
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
197
181
|
|
198
182
|
## SelectMenu.Tabs
|
199
183
|
|
@@ -232,7 +216,9 @@ If you need access to the selected tab state, you can find it in the MenuContext
|
|
232
216
|
|
233
217
|
### Component Props
|
234
218
|
|
235
|
-
|
219
|
+
| Name | Type | Default | Description |
|
220
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
221
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
236
222
|
|
237
223
|
## SelectMenu.Tab
|
238
224
|
|
@@ -242,28 +228,19 @@ The `onClick` prop is optional and can be used for any events or data fetching y
|
|
242
228
|
|
243
229
|
```jsx
|
244
230
|
<>
|
245
|
-
<SelectMenu.Tab index={0} tabName="Repository"/>
|
246
|
-
<SelectMenu.Tab index={1} tabName="Organization"/>
|
231
|
+
<SelectMenu.Tab index={0} tabName="Repository" />
|
232
|
+
<SelectMenu.Tab index={1} tabName="Organization" />
|
247
233
|
</>
|
248
234
|
```
|
249
235
|
|
250
|
-
### System Props
|
251
|
-
|
252
|
-
<Note variant="warning">
|
253
|
-
|
254
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
255
|
-
|
256
|
-
</Note>
|
257
|
-
|
258
|
-
SelectMenu.Tab components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
259
|
-
|
260
236
|
### Component Props
|
261
237
|
|
262
|
-
| Name | Type
|
263
|
-
| :------ |
|
264
|
-
| tabName | String
|
265
|
-
| index | Number
|
266
|
-
| onClick | Function
|
238
|
+
| Name | Type | Default | Description |
|
239
|
+
| :------ | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------------------------- |
|
240
|
+
| tabName | String | | Used to identify the corresponding tab. Must match the string used in the `tabs` array in the `SelectMenu.Tabs` component. |
|
241
|
+
| index | Number | | The index at which the tab is in the list of tabs |
|
242
|
+
| onClick | Function | | Function to be called when the tab is clicked. Optional. |
|
243
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
267
244
|
|
268
245
|
## SelectMenu.TabPanel
|
269
246
|
|
@@ -275,21 +252,12 @@ Wraps the content for each tab. Make sure to use the `tabName` prop to identify
|
|
275
252
|
<SelectMenu.TabPanel tabName="Repository">{/* Wraps content for each tab */}</SelectMenu.TabPanel>
|
276
253
|
```
|
277
254
|
|
278
|
-
### System Props
|
279
|
-
|
280
|
-
<Note variant="warning">
|
281
|
-
|
282
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
283
|
-
|
284
|
-
</Note>
|
285
|
-
|
286
|
-
SelectMenu.TabPanel components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
287
|
-
|
288
255
|
### Component Props
|
289
256
|
|
290
|
-
| Name | Type
|
291
|
-
| :------ |
|
292
|
-
| tabName | String
|
257
|
+
| Name | Type | Default | Description |
|
258
|
+
| :------ | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------------------------- |
|
259
|
+
| tabName | String | | Used to identify the corresponding tab. Must match the string used in the `tabs` array in the `SelectMenu.Tabs` component. |
|
260
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
293
261
|
|
294
262
|
## SelectMenu.Divider
|
295
263
|
|
@@ -311,19 +279,11 @@ Use a `SelectMenu.Divider` to add information between items in a `SelectMenu.Lis
|
|
311
279
|
</SelectMenu>
|
312
280
|
```
|
313
281
|
|
314
|
-
### System Props
|
315
|
-
|
316
|
-
<Note variant="warning">
|
317
|
-
|
318
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
319
|
-
|
320
|
-
</Note>
|
321
|
-
|
322
|
-
SelectMenu.Divder components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
323
|
-
|
324
282
|
### Component Props
|
325
283
|
|
326
|
-
|
284
|
+
| Name | Type | Default | Description |
|
285
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
286
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
327
287
|
|
328
288
|
## SelectMenu.Footer
|
329
289
|
|
@@ -345,19 +305,11 @@ Use a `SelectMenu.Footer` to add content to the bottom of the select menu.
|
|
345
305
|
</SelectMenu>
|
346
306
|
```
|
347
307
|
|
348
|
-
### System Props
|
349
|
-
|
350
|
-
<Note variant="warning">
|
351
|
-
|
352
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
353
|
-
|
354
|
-
</Note>
|
355
|
-
|
356
|
-
SelectMenu.Footer components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
357
|
-
|
358
308
|
### Component Props
|
359
309
|
|
360
|
-
|
310
|
+
| Name | Type | Default | Description |
|
311
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
312
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
361
313
|
|
362
314
|
## SelectMenu.Header
|
363
315
|
|
@@ -379,19 +331,11 @@ Use a `SelectMenu.Header` to add a header to the top of the select menu content.
|
|
379
331
|
</SelectMenu>
|
380
332
|
```
|
381
333
|
|
382
|
-
### System Props
|
383
|
-
|
384
|
-
<Note variant="warning">
|
385
|
-
|
386
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
387
|
-
|
388
|
-
</Note>
|
389
|
-
|
390
|
-
SelectMenu.Header components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
391
|
-
|
392
334
|
### Component Props
|
393
335
|
|
394
|
-
|
336
|
+
| Name | Type | Default | Description |
|
337
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
338
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
395
339
|
|
396
340
|
## SelectMenu.LoadingAnimation
|
397
341
|
|
@@ -420,16 +364,8 @@ Use a `SelectMenu.LoadingAnimation` to add a loading animation inside of the Sel
|
|
420
364
|
</SelectMenu>
|
421
365
|
```
|
422
366
|
|
423
|
-
### System Props
|
424
|
-
|
425
|
-
<Note variant="warning">
|
426
|
-
|
427
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
428
|
-
|
429
|
-
</Note>
|
430
|
-
|
431
|
-
SelectMenu.LoadingAnimation components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
432
|
-
|
433
367
|
### Component Props
|
434
368
|
|
435
|
-
|
369
|
+
| Name | Type | Default | Description |
|
370
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
371
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/SideNav.md
CHANGED
@@ -147,33 +147,25 @@ If using React Router, you can use the `as` prop to render the element as a `Nav
|
|
147
147
|
<SideNav.Link as={NavLink} to="...">...</SideNav.Link>
|
148
148
|
```
|
149
149
|
|
150
|
-
## System props
|
151
|
-
|
152
|
-
<Note variant="warning">
|
153
|
-
|
154
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
155
|
-
|
156
|
-
</Note>
|
157
|
-
|
158
|
-
`SideNav` components get `COMMON`, `BORDER`, `LAYOUT`, and `FLEX` system props. `SideNav.Link` components get `COMMON` and `TYPOGRAPHY` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
159
|
-
|
160
150
|
## Component props
|
161
151
|
|
162
152
|
### SideNav
|
163
153
|
|
164
|
-
| Name | Type
|
165
|
-
| :------- |
|
166
|
-
| as | String
|
167
|
-
| bordered | Boolean
|
168
|
-
| variant | String
|
154
|
+
| Name | Type | Default | Description |
|
155
|
+
| :------- | :---------------- | :------: | :----------------------------------------------------------------------------- |
|
156
|
+
| as | String | 'nav' | Sets the HTML tag for the component. |
|
157
|
+
| bordered | Boolean | false | Renders the component with a border. |
|
158
|
+
| variant | String | 'normal' | Set to `lightweight` to render [in a lightweight style](#lightweight-variant). |
|
159
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
169
160
|
|
170
161
|
### SideNav.Link
|
171
162
|
|
172
|
-
| Name | Type
|
173
|
-
| :-------- |
|
174
|
-
| as | String
|
175
|
-
| href | String
|
176
|
-
| muted | Boolean
|
177
|
-
| selected | Boolean
|
178
|
-
| underline | Boolean
|
179
|
-
| variant | String
|
163
|
+
| Name | Type | Default | Description |
|
164
|
+
| :-------- | :---------------- | :------: | :------------------------------------------------------------------------------------------------ |
|
165
|
+
| as | String | 'a' | Sets the HTML tag for the component. |
|
166
|
+
| href | String | | URL to be used for the Link |
|
167
|
+
| muted | Boolean | false | Uses a less prominent shade for Link color, and the default link shade on hover |
|
168
|
+
| selected | Boolean | false | Sets the link as selected, giving it a different style and setting the `aria-current` attribute. |
|
169
|
+
| underline | Boolean | false | Adds underline to the Link |
|
170
|
+
| variant | String | 'normal' | Set to `full` to render [a full variant](#full-variant), suitable for including icons and labels. |
|
171
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
@@ -18,19 +18,10 @@ Use StateLabel components to show the status of an issue or pull request.
|
|
18
18
|
</>
|
19
19
|
```
|
20
20
|
|
21
|
-
## System props
|
22
|
-
|
23
|
-
<Note variant="warning">
|
24
|
-
|
25
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
26
|
-
|
27
|
-
</Note>
|
28
|
-
|
29
|
-
StateLabel components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
30
|
-
|
31
21
|
## Component props
|
32
22
|
|
33
|
-
| Name | Type
|
34
|
-
| :------ |
|
35
|
-
| variant | String
|
36
|
-
| status | String
|
23
|
+
| Name | Type | Default | Description |
|
24
|
+
| :------ | :---------------- | :------: | :------------------------------------------------------------------------------------------------------------- |
|
25
|
+
| variant | String | 'normal' | a value of `small` or `normal` results in a smaller or larger version of the StateLabel. |
|
26
|
+
| status | String | | Can be one of `issueOpened`, `issueClosed`, `pullOpened`, `pullClosed`, `pullMerged`, `draft` or `issueDraft`. |
|
27
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
@@ -14,23 +14,14 @@ StyledOcticon renders an [Octicon](https://octicons.github.com) with common syst
|
|
14
14
|
</>
|
15
15
|
```
|
16
16
|
|
17
|
-
## System props
|
18
|
-
|
19
|
-
<Note variant="warning">
|
20
|
-
|
21
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
22
|
-
|
23
|
-
</Note>
|
24
|
-
|
25
|
-
StyledOcticon components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
26
|
-
|
27
17
|
## Component props
|
28
18
|
|
29
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:
|
30
20
|
|
31
|
-
| Name | Type
|
32
|
-
| :------------ |
|
33
|
-
| ariaLabel | String
|
34
|
-
| icon | Component
|
35
|
-
| size | Number
|
36
|
-
| verticalAlign | String
|
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
CHANGED
@@ -72,31 +72,29 @@ This ensures that the NavLink gets `activeClassName='selected'`
|
|
72
72
|
</SubNav>
|
73
73
|
```
|
74
74
|
|
75
|
-
## System props
|
76
|
-
|
77
|
-
<Note variant="warning">
|
78
|
-
|
79
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
80
|
-
|
81
|
-
</Note>
|
82
|
-
|
83
|
-
SubNav and SubNav.Link components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
84
|
-
|
85
75
|
## Component props
|
86
76
|
|
87
77
|
### SubNav
|
88
78
|
|
89
|
-
|
|
90
|
-
| :--------- |
|
91
|
-
| actions | Node
|
92
|
-
| align | String
|
93
|
-
| full | Boolean
|
94
|
-
| aria-label | String
|
79
|
+
| Name | Type | Default | Description |
|
80
|
+
| :--------- | :---------------- | :-----: | :------------------------------------------------------------------------------------- |
|
81
|
+
| actions | Node | | Place another element, such as a button, to the opposite side of the navigation items. |
|
82
|
+
| align | String | | Use `right` to have navigation items aligned right. |
|
83
|
+
| full | Boolean | | Used to make navigation fill the width of the container. |
|
84
|
+
| aria-label | String | | Used to set the `aria-label` on the top level `<nav>` element. |
|
85
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
95
86
|
|
96
87
|
### SubNav.Link
|
97
88
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
| as
|
101
|
-
| href
|
102
|
-
| selected
|
89
|
+
| Name | Type | Default | Description |
|
90
|
+
| :------- | :---------------- | :-----: | :----------------------------------------------- |
|
91
|
+
| as | String | | sets the HTML tag for the component |
|
92
|
+
| href | String | | URL to be used for the Link |
|
93
|
+
| selected | Boolean | | Used to style the link as selected or unselected |
|
94
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
95
|
+
|
96
|
+
### SubNav.Links
|
97
|
+
|
98
|
+
| Name | Type | Default | Description |
|
99
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
100
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/TabNav.md
CHANGED
@@ -23,28 +23,20 @@ This ensures that the NavLink gets `activeClassName='selected'`
|
|
23
23
|
</TabNav>
|
24
24
|
```
|
25
25
|
|
26
|
-
## System props
|
27
|
-
|
28
|
-
<Note variant="warning">
|
29
|
-
|
30
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
31
|
-
|
32
|
-
</Note>
|
33
|
-
|
34
|
-
TabNav and TabNav.Link components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
35
|
-
|
36
26
|
## Component props
|
37
27
|
|
38
28
|
### TabNav
|
39
29
|
|
40
|
-
|
|
41
|
-
| :--------- |
|
42
|
-
| aria-label | String
|
30
|
+
| Name | Type | Default | Description |
|
31
|
+
| :--------- | :---------------- | :-----: | :------------------------------------------------------------- |
|
32
|
+
| aria-label | String | | Used to set the `aria-label` on the top level `<nav>` element. |
|
33
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
43
34
|
|
44
35
|
### TabNav.Link
|
45
36
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
| as
|
49
|
-
| href
|
50
|
-
| selected
|
37
|
+
| Name | Type | Default | Description |
|
38
|
+
| :------- | :---------------- | :-----: | :----------------------------------------------- |
|
39
|
+
| as | String | | sets the HTML tag for the component |
|
40
|
+
| href | String | | URL to be used for the Link |
|
41
|
+
| selected | Boolean | | Used to style the link as selected or unselected |
|
42
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|