@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
@@ -336,13 +336,14 @@ render(<SelectFields />)
|
|
336
336
|
|
337
337
|
### ActionList.Group
|
338
338
|
|
339
|
-
| Name | Type
|
340
|
-
| :--------------- |
|
341
|
-
| children\* | `ActionList.Item[] or ActionList.LinkItem[]`
|
342
|
-
| title | string
|
343
|
-
| auxiliaryText | string
|
344
|
-
| variant | `'filled'` or `'subtle'`
|
345
|
-
| selectionVariant | `'single'` or `'multiple'` or `false`
|
339
|
+
| Name | Type | Default | Description |
|
340
|
+
| :--------------- | :------------------------------------------------------------------------------------------------ | :--------: | :--------------------------------------------------------------------------------------------------------------------------------------- |
|
341
|
+
| children\* | `ActionList.Item[] or ActionList.LinkItem[]` | - | Required. |
|
342
|
+
| title | string | - | Optional. Primary text which names a `Group` |
|
343
|
+
| auxiliaryText | string | - | Optional. Secondary text which provides additional information about a `Group`. |
|
344
|
+
| variant | `'filled'` or `'subtle'` | `'subtle'` | Optional. `"filled"` - Superimposed on a background, offset from nearby content, `"subtle"` - Relatively less offset from nearby content |
|
345
|
+
| selectionVariant | `'single'` or `'multiple'` or `false` | - | Optional. Set `selectionVariant` at the group level |
|
346
|
+
| role | [AriaRole](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques#roles) | - | Optional. \* The ARIA role describing the function of the list inside `Group` component. `listbox` or `menu` are a common values. |
|
346
347
|
|
347
348
|
<br />
|
348
349
|
|
@@ -27,26 +27,21 @@ This ensures that the NavLink gets `activeClassName='selected'`
|
|
27
27
|
</Breadcrumbs>
|
28
28
|
```
|
29
29
|
|
30
|
-
## System props
|
31
|
-
|
32
|
-
<Note variant="warning">
|
33
|
-
|
34
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
35
|
-
|
36
|
-
</Note>
|
37
|
-
|
38
|
-
Breadcrumbs and Breadcrumbs.Item components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
39
|
-
|
40
30
|
## Component props
|
41
31
|
|
42
32
|
### Breadcrumbs
|
43
33
|
|
44
|
-
|
34
|
+
| Prop name | Type | Default | Description |
|
35
|
+
| :-------- | :---------------- | :-----: | :----------------------------------- |
|
36
|
+
| children | ReactNode | | The `Breadcrumbs.Item`s |
|
37
|
+
| className | string | | |
|
38
|
+
| sx | SystemStyleObject | `{}` | Style to be applied to the component |
|
45
39
|
|
46
40
|
### Breadcrumbs.Item
|
47
41
|
|
48
|
-
| Prop name | Type
|
49
|
-
| :-------- |
|
50
|
-
| as |
|
51
|
-
| href |
|
52
|
-
| selected |
|
42
|
+
| Prop name | Type | Default | Description |
|
43
|
+
| :-------- | :---------------- | :-----: | :----------------------------------------------- |
|
44
|
+
| as | string | `a` | Sets the HTML tag for the component |
|
45
|
+
| href | string | | URL to be used for the Link |
|
46
|
+
| selected | boolean | `false` | Used to style the link as selected or unselected |
|
47
|
+
| sx | SystemStyleObject | `{}` | Style to be applied to the component |
|
package/docs/content/Buttons.md
CHANGED
@@ -17,9 +17,9 @@ To create a button group, wrap `Button` elements in the `ButtonGroup` element. `
|
|
17
17
|
<ButtonOutline>Button Outline</ButtonOutline>
|
18
18
|
<ButtonPrimary>Button Primary</ButtonPrimary>
|
19
19
|
<ButtonInvisible>Button Invisible</ButtonInvisible>
|
20
|
-
<ButtonClose onClick={() => window.alert('button clicked')}/>
|
20
|
+
<ButtonClose onClick={() => window.alert('button clicked')} />
|
21
21
|
|
22
|
-
<ButtonGroup display=
|
22
|
+
<ButtonGroup display="block" my={2}>
|
23
23
|
<Button>Button</Button>
|
24
24
|
<Button>Button</Button>
|
25
25
|
<Button>Button</Button>
|
@@ -29,27 +29,17 @@ To create a button group, wrap `Button` elements in the `ButtonGroup` element. `
|
|
29
29
|
</>
|
30
30
|
```
|
31
31
|
|
32
|
-
## System props
|
33
|
-
|
34
|
-
<Note variant="warning">
|
35
|
-
|
36
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
37
|
-
|
38
|
-
</Note>
|
39
|
-
|
40
|
-
`Button` and `ButtonGroup` components get `COMMON` and `LAYOUT` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
41
|
-
|
42
32
|
## Component props
|
43
33
|
|
44
34
|
Native `<button>` HTML attributes are forwarded to the underlying React `button` component and are not listed below.
|
45
35
|
|
46
36
|
### Button
|
47
37
|
|
48
|
-
| Prop name | Type
|
49
|
-
| :-------- |
|
50
|
-
| as | String
|
51
|
-
|
|
52
|
-
| variant | String
|
38
|
+
| Prop name | Type | Default | Description |
|
39
|
+
| :-------- | :---------------- | :------: | :-------------------------------------------------------------------------------------------------------------------------- |
|
40
|
+
| as | String | `button` | sets the HTML tag for the component |
|
41
|
+
| sx | SystemStyleObject | {} | Additional styles |
|
42
|
+
| variant | String | 'medium' | a value of `small`, `medium`, or `large` results in smaller or larger Button text size; no effect if `fontSize` prop is set |
|
53
43
|
|
54
44
|
### ButtonGroup
|
55
45
|
|
@@ -12,16 +12,6 @@ Use CircleBadge to visually connect logos of third party services like in market
|
|
12
12
|
</CircleBadge>
|
13
13
|
```
|
14
14
|
|
15
|
-
## System props
|
16
|
-
|
17
|
-
<Note variant="warning">
|
18
|
-
|
19
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
20
|
-
|
21
|
-
</Note>
|
22
|
-
|
23
|
-
CircleBadge and CircleBadge.Icon components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
24
|
-
|
25
15
|
## Component props
|
26
16
|
|
27
17
|
### CircleBadge
|
@@ -15,16 +15,6 @@ Use the CounterLabel component to add a count to navigational elements and butto
|
|
15
15
|
</>
|
16
16
|
```
|
17
17
|
|
18
|
-
## System props
|
19
|
-
|
20
|
-
<Note variant="warning">
|
21
|
-
|
22
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
23
|
-
|
24
|
-
</Note>
|
25
|
-
|
26
|
-
CounterLabel components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
27
|
-
|
28
18
|
## Component props
|
29
19
|
|
30
20
|
| Name | Type | Default | Description |
|
package/docs/content/Dialog.md
CHANGED
@@ -84,25 +84,22 @@ You can also pass any non-text content into the header:
|
|
84
84
|
</State>
|
85
85
|
```
|
86
86
|
|
87
|
-
##
|
88
|
-
|
89
|
-
<Note variant="warning">
|
90
|
-
|
91
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
92
|
-
|
93
|
-
</Note>
|
87
|
+
## Component props
|
94
88
|
|
95
|
-
|
89
|
+
### Dialog
|
96
90
|
|
97
|
-
|
91
|
+
| Prop name | Type | Default | Description |
|
92
|
+
| :-------------- | :---------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
93
|
+
| isOpen | Boolean | | Set whether or not the dialog is shown |
|
94
|
+
| onDismiss | Function | | A user-provided function that should close the dialog |
|
95
|
+
| returnFocusRef | React ref | | The element to restore focus back to after the `Dialog` is closed |
|
96
|
+
| initialFocusRef | React ref | | Element inside of the `Dialog` you'd like to be focused when the Dialog is opened. If nothing is passed to `initialFocusRef` the close button is focused. |
|
97
|
+
| aria-labelledby | string | | Pass an id to use for the aria-label. Use either a `aria-label` or an `aria-labelledby` but not both. |
|
98
|
+
| aria-label | string | | Pass a label to be used to describe the Dialog. Use either a `aria-label` or an `aria-labelledby` but not both. |
|
99
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
98
100
|
|
99
|
-
|
100
|
-
| :-------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
101
|
-
| isOpen | Boolean | Set whether or not the dialog is shown |
|
102
|
-
| onDismiss | Function | A user-provided function that should close the dialog |
|
103
|
-
| returnFocusRef | React ref | The element to restore focus back to after the `Dialog` is closed |
|
104
|
-
| initialFocusRef | React ref | Element inside of the `Dialog` you'd like to be focused when the Dialog is opened. If nothing is passed to `initialFocusRef` the close button is focused. |
|
105
|
-
| aria-labelledby | string | Pass an id to use for the aria-label. Use either a `aria-label` or an `aria-labelledby` but not both. |
|
106
|
-
| aria-label | string | Pass a label to be used to describe the Dialog. Use either a `aria-label` or an `aria-labelledby` but not both. |
|
101
|
+
### Dialog.Header
|
107
102
|
|
108
|
-
|
103
|
+
| Prop name | Type | Default | Description |
|
104
|
+
| :-------- | :---------------- | :------ | :----------------------------------- |
|
105
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Dialog2.mdx
CHANGED
@@ -87,6 +87,7 @@ By default, the Dialog component implements the design and interactions defined
|
|
87
87
|
| role | `"dialog" │ "alertdialog"` | `"dialog"` | The ARIA role given to the dialog element. More info: [dialog](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal), [alertdialog](https://www.w3.org/TR/wai-aria-practices-1.1/#alertdialog) |
|
88
88
|
| width | `"small" │ "medium" │ "large" │ "xlarge"` | `"xlarge"` | The fixed width of the dialog. |
|
89
89
|
| height | `"small" │ "large" │ "auto"` | `"auto"` | The fixed height of the dialog, or, auto to adjust the height based on its contents. |
|
90
|
+
| sx | `SystemStyleObject` | {} | Style to be applied to the component |
|
90
91
|
|
91
92
|
### DialogHeaderProps
|
92
93
|
|
package/docs/content/Dropdown.md
CHANGED
@@ -37,36 +37,29 @@ Dropdown.Menu wraps your menu content. Be sure to pass a `direction` prop to thi
|
|
37
37
|
</Dropdown>
|
38
38
|
```
|
39
39
|
|
40
|
-
## System props
|
41
|
-
|
42
|
-
<Note variant="warning">
|
43
|
-
|
44
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
45
|
-
|
46
|
-
</Note>
|
47
|
-
|
48
|
-
Dropdown, Dropdown.Menu, Dropdown.Button, Dropdown.Caret, and Dropdown.Item all get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
49
|
-
|
50
40
|
## Component props
|
51
41
|
|
52
42
|
The Dropdown component is extended from the [`Details`](/Details) component and gets all props that the [`Details`](/Details) component gets.
|
53
43
|
|
54
44
|
#### Dropdown.Menu
|
55
45
|
|
56
|
-
| Name | Type
|
57
|
-
| :-------- |
|
58
|
-
| direction | String
|
46
|
+
| Name | Type | Default | Description |
|
47
|
+
| :-------- | :---------------- | :-----: | :------------------------------------------------------------------------------------ |
|
48
|
+
| direction | String | 'sw' | Sets the direction of the dropdown menu. Pick from 'ne', 'e', 'se', 's', 'sw', or 'w' |
|
49
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
59
50
|
|
60
51
|
#### Dropdown.Button
|
61
52
|
|
62
|
-
|
63
|
-
| :------ | :------- | :-----: | :----------------------------------------------------------------------------------------------------------- |
|
64
|
-
| onClick | Function | none | Use the `onClick` handler to add additional functionality when the button is clicked, such as fetching data. |
|
53
|
+
See https://primer.style/react/Buttons#component-props
|
65
54
|
|
66
55
|
#### Dropdown.Caret
|
67
56
|
|
68
|
-
|
57
|
+
| Name | Type | Default | Description |
|
58
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
59
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
69
60
|
|
70
61
|
#### Dropdown.Item
|
71
62
|
|
72
|
-
|
63
|
+
| Name | Type | Default | Description |
|
64
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
65
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
@@ -18,27 +18,20 @@ The FilterList component is a menu with filter options that filter the main cont
|
|
18
18
|
</FilterList>
|
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
|
-
FilterList 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
23
|
#### FilterList
|
34
24
|
|
35
|
-
|
25
|
+
| Name | Type | Default | Description |
|
26
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
27
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
36
28
|
|
37
29
|
#### FilterList.Item
|
38
30
|
|
39
|
-
| Name | Type
|
40
|
-
| :------- |
|
41
|
-
| count | Number
|
42
|
-
| as | String
|
43
|
-
| selected | Boolean
|
44
|
-
| small | Boolean
|
31
|
+
| Name | Type | Default | Description |
|
32
|
+
| :------- | :---------------- | :-----: | :--------------------------------------------------------------- |
|
33
|
+
| count | Number | | Number to be displayed in the list item |
|
34
|
+
| as | String | `a` | sets the HTML tag for the component |
|
35
|
+
| selected | Boolean | | Used to set selected style |
|
36
|
+
| small | Boolean | false | Used to create a smaller version of the standard FilterList.Item |
|
37
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
@@ -22,18 +22,11 @@ The FilteredSearch component helps style a Dropdown and a TextInput side-by-side
|
|
22
22
|
</FilteredSearch>
|
23
23
|
```
|
24
24
|
|
25
|
-
## System props
|
26
|
-
|
27
|
-
<Note variant="warning">
|
28
|
-
|
29
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
30
|
-
|
31
|
-
</Note>
|
32
|
-
|
33
|
-
FilteredSearch gets `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
34
|
-
|
35
25
|
## Component props
|
36
26
|
|
37
27
|
#### FilteredSearch.Children
|
38
28
|
|
39
|
-
|
29
|
+
| Name | Type | Default | Description |
|
30
|
+
| :------- | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------- |
|
31
|
+
| children | | | FilteredSearch is expected to contain a [`Dropdown`](/Dropdown) followed by a [`TextInput`](/TextInput). |
|
32
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Flash.md
CHANGED
@@ -26,19 +26,10 @@ Flash components with icons inside of them will automatically set the correct co
|
|
26
26
|
</Flash>
|
27
27
|
```
|
28
28
|
|
29
|
-
## System props
|
30
|
-
|
31
|
-
<Note variant="warning">
|
32
|
-
|
33
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
34
|
-
|
35
|
-
</Note>
|
36
|
-
|
37
|
-
Flash components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
38
|
-
|
39
29
|
## Component props
|
40
30
|
|
41
|
-
| Name | Type
|
42
|
-
| :------ |
|
43
|
-
| full | Boolean
|
44
|
-
|
|
31
|
+
| Name | Type | Default | Description |
|
32
|
+
| :------ | :---------------- | :-----: | :----------------------------------------------------------------------------------------------------------------------- |
|
33
|
+
| full | Boolean | | Creates a full width Flash component |
|
34
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
35
|
+
| variant | String | default | Can be one of `default`, `success`, `warning`, or `danger` - sets the background color and border of the Flash component |
|
@@ -20,27 +20,19 @@ Adds styles for multiple form elements used together.
|
|
20
20
|
</>
|
21
21
|
```
|
22
22
|
|
23
|
-
## System props
|
24
|
-
|
25
|
-
<Note variant="warning">
|
26
|
-
|
27
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
28
|
-
|
29
|
-
</Note>
|
30
|
-
|
31
|
-
FormGroup components get `COMMON` system props. FormGroup.Label components get `COMMON` and `TYPOGRAPHY` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
32
|
-
|
33
23
|
## Component props
|
34
24
|
|
35
25
|
### FormGroup
|
36
26
|
|
37
|
-
| Name | Type
|
38
|
-
| :--- |
|
39
|
-
| as | String
|
27
|
+
| Name | Type | Default | Description |
|
28
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
29
|
+
| as | String | `div` | Sets the HTML tag for the component |
|
30
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
40
31
|
|
41
32
|
### FormGroup.Label
|
42
33
|
|
43
|
-
| Name | Type
|
44
|
-
| :------ |
|
45
|
-
| as | String
|
46
|
-
| htmlFor | String
|
34
|
+
| Name | Type | Default | Description |
|
35
|
+
| :------ | :---------------- | :-----: | :----------------------------------------------------------------------------- |
|
36
|
+
| as | String | `label` | Sets the HTML tag for the component |
|
37
|
+
| htmlFor | String | | The value of `htmlFor` needs to be the same as the `id` of the input it labels |
|
38
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Header.md
CHANGED
@@ -53,27 +53,25 @@ All items directly under the Header component should be a `Header.Item` componen
|
|
53
53
|
</Header>
|
54
54
|
```
|
55
55
|
|
56
|
-
##
|
57
|
-
|
58
|
-
<Note variant="warning">
|
59
|
-
|
60
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
61
|
-
|
62
|
-
</Note>
|
56
|
+
## Component props
|
63
57
|
|
64
|
-
|
58
|
+
### Header
|
65
59
|
|
66
|
-
|
60
|
+
| Name | Type | Default | Description |
|
61
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
62
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
67
63
|
|
68
64
|
### Header.Item
|
69
65
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
| full
|
66
|
+
| Name | Type | Default | Description |
|
67
|
+
| :--- | :---------------- | :-----: | :----------------------------------------- |
|
68
|
+
| full | Boolean | | stretches item to fill the available space |
|
69
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
73
70
|
|
74
71
|
### Header.Link
|
75
72
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
| as
|
79
|
-
| href
|
73
|
+
| Name | Type | Default | Description |
|
74
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
75
|
+
| as | String | | sets the HTML tag for the component |
|
76
|
+
| href | String | | URL to be used for the Link |
|
77
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Label.md
CHANGED
@@ -8,35 +8,42 @@ The Label component is used to add contextual metadata to a design. Visually it
|
|
8
8
|
|
9
9
|
```jsx live
|
10
10
|
<>
|
11
|
-
<Label variant="small" outline sx={{borderColor:
|
12
|
-
|
13
|
-
|
11
|
+
<Label variant="small" outline sx={{borderColor: 'danger.emphasis', mr: 2, color: 'danger.fg'}}>
|
12
|
+
small
|
13
|
+
</Label>
|
14
|
+
<Label variant="medium" sx={{mr: 2}}>
|
15
|
+
medium (default)
|
16
|
+
</Label>
|
17
|
+
<Label variant="large" sx={{mr: 2}}>
|
18
|
+
large
|
19
|
+
</Label>
|
14
20
|
<Label variant="xl">xl label</Label>
|
15
21
|
|
16
|
-
<Box mt={4}/>
|
17
|
-
<Label variant="medium" sx={{bg:
|
18
|
-
|
19
|
-
|
20
|
-
<Label variant="medium" sx={{bg:
|
21
|
-
|
22
|
+
<Box mt={4} />
|
23
|
+
<Label variant="medium" sx={{bg: '#A575FF', m: 1}}>
|
24
|
+
good first issue
|
25
|
+
</Label>
|
26
|
+
<Label variant="medium" sx={{bg: '#FF75C8', m: 1}}>
|
27
|
+
🚂 deploy: train
|
28
|
+
</Label>
|
29
|
+
<Label variant="medium" sx={{bg: '#1C90FA', m: 1}}>
|
30
|
+
css
|
31
|
+
</Label>
|
32
|
+
<Label variant="medium" sx={{bg: '#FFF06C', color: '#24292E', m: 1}}>
|
33
|
+
documentation
|
34
|
+
</Label>
|
35
|
+
<Label variant="medium" sx={{bg: '#656BFE', m: 1}}>
|
36
|
+
primer
|
37
|
+
</Label>
|
22
38
|
</>
|
23
39
|
```
|
24
40
|
|
25
|
-
## System props
|
26
|
-
|
27
|
-
<Note variant="warning">
|
28
|
-
|
29
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
30
|
-
|
31
|
-
</Note>
|
32
|
-
|
33
|
-
Label components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
34
|
-
|
35
41
|
## Component props
|
36
42
|
|
37
|
-
| Name | Type
|
38
|
-
| :--------- |
|
39
|
-
| outline | Boolean
|
40
|
-
| variant | String
|
41
|
-
| dropshadow | Boolean
|
42
|
-
| bg | String
|
43
|
+
| Name | Type | Default | Description |
|
44
|
+
| :--------- | :---------------- | :--------------------: | :----------------------------------------------------------------------------- |
|
45
|
+
| outline | Boolean | | Creates an outline style label |
|
46
|
+
| variant | String | 'medium' | Can be one of `small`, `medium` (default), `large` or `xl` . |
|
47
|
+
| dropshadow | Boolean | | Adds a dropshadow to the label |
|
48
|
+
| bg | String | 'label.primary.border' | Part of the `COMMON` system props, used to change the background of the label. |
|
49
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
@@ -9,23 +9,13 @@ The LabelGroup component is used to add commonly used margins and wrapping for g
|
|
9
9
|
```jsx live
|
10
10
|
<LabelGroup>
|
11
11
|
<Label>Default label</Label>
|
12
|
-
<Label sx={{color:
|
13
|
-
Label with background indicating a closed PR state
|
14
|
-
</Label>
|
12
|
+
<Label sx={{color: 'fg.onEmphasis', bg: 'danger.emphasis'}}>Label with background indicating a closed PR state</Label>
|
15
13
|
<Label outline>Default outline label</Label>
|
16
14
|
</LabelGroup>
|
17
15
|
```
|
18
16
|
|
19
|
-
## System props
|
20
|
-
|
21
|
-
<Note variant="warning">
|
22
|
-
|
23
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
24
|
-
|
25
|
-
</Note>
|
26
|
-
|
27
|
-
LabelGroup components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
28
|
-
|
29
17
|
## Component props
|
30
18
|
|
31
|
-
|
19
|
+
| Name | Type | Default | Description |
|
20
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
21
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Link.md
CHANGED
@@ -16,22 +16,13 @@ In special cases where you'd like a `<button>` styled like a `Link`, use `<Link
|
|
16
16
|
</Link>
|
17
17
|
```
|
18
18
|
|
19
|
-
## System props
|
20
|
-
|
21
|
-
<Note variant="warning">
|
22
|
-
|
23
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
24
|
-
|
25
|
-
</Note>
|
26
|
-
|
27
|
-
Link components get `COMMON` and `TYPOGRAPHY` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
28
|
-
|
29
19
|
## Component props
|
30
20
|
|
31
|
-
| Name | Type
|
32
|
-
| :--------- |
|
33
|
-
| href | String
|
34
|
-
| muted | Boolean
|
35
|
-
| underline | Boolean
|
36
|
-
| as | String
|
37
|
-
| hoverColor | String
|
21
|
+
| Name | Type | Default | Description |
|
22
|
+
| :--------- | :---------------- | :-----: | :------------------------------------------------------------------------------ |
|
23
|
+
| href | String | | URL to be used for the Link |
|
24
|
+
| muted | Boolean | false | Uses a less prominent shade for Link color, and the default link shade on hover |
|
25
|
+
| underline | Boolean | false | Adds underline to the Link |
|
26
|
+
| as | String | 'a' | Can be 'a', 'button', 'input', or 'summary' |
|
27
|
+
| hoverColor | String | | Color used when hovering over link |
|
28
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Overlay.mdx
CHANGED
@@ -65,16 +65,6 @@ const Demo = () => {
|
|
65
65
|
render(<Demo />)
|
66
66
|
```
|
67
67
|
|
68
|
-
## System props
|
69
|
-
|
70
|
-
<Note variant="warning">
|
71
|
-
|
72
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
73
|
-
|
74
|
-
</Note>
|
75
|
-
|
76
|
-
`Overlay` gets `COMMON` system props. Read the [System Props](/system-props) doc page for a full list of available props.
|
77
|
-
|
78
68
|
## Component props
|
79
69
|
|
80
70
|
| Name | Type | Default | Description |
|
@@ -92,3 +82,4 @@ System props are deprecated in all components except [Box](/Box). Please use the
|
|
92
82
|
| top | `number` | 0 | Vertical position of the overlay, relative to its closest positioned ancestor (often its `Portal`). |
|
93
83
|
| left | `number` | 0 | Horizontal position of the overlay, relative to its closest positioned ancestor (often its `Portal`). |
|
94
84
|
| portalContainerName | `string` | `undefined` | Optional. If defined, Overlays will be rendered in the named portal. See also `Portal`. |
|
85
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|
package/docs/content/Pagehead.md
CHANGED
@@ -10,18 +10,9 @@ Give a page a clear, separated title and optional top nav by using Pagehead.
|
|
10
10
|
<Pagehead>Pagehead</Pagehead>
|
11
11
|
```
|
12
12
|
|
13
|
-
## System props
|
14
|
-
|
15
|
-
<Note variant="warning">
|
16
|
-
|
17
|
-
System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
|
18
|
-
|
19
|
-
</Note>
|
20
|
-
|
21
|
-
Pagehead components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
|
22
|
-
|
23
13
|
## Component props
|
24
14
|
|
25
|
-
| Name | Type
|
26
|
-
| :--- |
|
27
|
-
| as | String
|
15
|
+
| Name | Type | Default | Description |
|
16
|
+
| :--- | :---------------- | :-----: | :----------------------------------- |
|
17
|
+
| as | String | `div` | Sets the HTML tag for the component |
|
18
|
+
| sx | SystemStyleObject | {} | Style to be applied to the component |
|