@carbon/ibm-products 1.0.0-rc.1 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +11 -12
- package/css/index-full-carbon.css +33427 -0
- package/css/index-full-carbon.css.map +1 -0
- package/css/index-full-carbon.min.css +9 -0
- package/css/index-without-carbon-released-only.css +7831 -0
- package/css/index-without-carbon-released-only.css.map +1 -0
- package/css/index-without-carbon-released-only.min.css +9 -0
- package/css/index-without-carbon.css +9841 -0
- package/css/index-without-carbon.css.map +1 -0
- package/css/index-without-carbon.min.css +9 -0
- package/css/index.css +22317 -0
- package/css/index.css.map +1 -0
- package/css/index.min.css +9 -0
- package/es/components/APIKeyModal/APIKeyDownloader.js +103 -0
- package/es/components/APIKeyModal/APIKeyModal.js +593 -0
- package/es/components/APIKeyModal/index.js +7 -0
- package/es/components/AboutModal/AboutModal.js +202 -0
- package/es/components/AboutModal/index.js +7 -0
- package/es/components/ActionBar/ActionBar.js +274 -0
- package/es/components/ActionBar/ActionBarItem.js +99 -0
- package/es/components/ActionBar/ActionBarOverflowItems.js +70 -0
- package/es/components/ActionBar/index.js +8 -0
- package/es/components/ActionSet/ActionSet.js +195 -0
- package/es/components/ActionSet/actions.js +48 -0
- package/es/components/ActionSet/index.js +7 -0
- package/es/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js +349 -0
- package/es/components/BreadcrumbWithOverflow/index.js +8 -0
- package/es/components/ButtonMenu/ButtonMenu.js +108 -0
- package/es/components/ButtonMenu/ButtonMenuItem.js +30 -0
- package/es/components/ButtonMenu/index.js +8 -0
- package/es/components/ButtonSetWithOverflow/ButtonSetWithOverflow.js +231 -0
- package/es/components/ButtonSetWithOverflow/index.js +7 -0
- package/es/components/Card/Card.js +242 -0
- package/es/components/Card/CardFooter.js +72 -0
- package/es/components/Card/CardHeader.js +53 -0
- package/es/components/Card/index.js +9 -0
- package/es/components/Cascade/Cascade.js +88 -0
- package/es/components/Cascade/index.js +1 -0
- package/es/components/ComboButton/ComboButton.js +110 -0
- package/es/components/ComboButton/ComboButtonItem/index.js +39 -0
- package/es/components/ComboButton/index.js +8 -0
- package/es/components/CreateFullPage/CreateFullPage.js +454 -0
- package/es/components/CreateFullPage/CreateFullPageSection.js +53 -0
- package/es/components/CreateFullPage/CreateFullPageStep.js +112 -0
- package/es/components/CreateFullPage/constants.js +8 -0
- package/es/components/CreateFullPage/index.js +9 -0
- package/es/components/CreateInfluencer/CreateInfluencer.js +273 -0
- package/es/components/CreateInfluencer/index.js +7 -0
- package/es/components/CreateModal/CreateModal.js +152 -0
- package/es/components/CreateModal/index.js +8 -0
- package/es/components/CreateSidePanel/CreateSidePanel.js +175 -0
- package/es/components/CreateSidePanel/index.js +7 -0
- package/es/components/CreateTearsheet/CreateTearsheet.js +371 -0
- package/es/components/CreateTearsheet/CreateTearsheetDivider.js +33 -0
- package/es/components/CreateTearsheet/CreateTearsheetSection.js +83 -0
- package/es/components/CreateTearsheet/CreateTearsheetStep.js +129 -0
- package/es/components/CreateTearsheet/constants.js +8 -0
- package/es/components/CreateTearsheet/index.js +10 -0
- package/es/components/CreateTearsheet/preview-components/MultiStepTearsheet.js +244 -0
- package/es/components/CreateTearsheet/preview-components/MultiStepWithIntro.js +295 -0
- package/es/components/CreateTearsheet/preview-components/MultiStepWithSectionsTearsheet.js +327 -0
- package/es/components/CreateTearsheetNarrow/CreateTearsheetNarrow.js +174 -0
- package/es/components/CreateTearsheetNarrow/index.js +7 -0
- package/es/components/EditSidePanel/EditSidePanel.js +209 -0
- package/es/components/EditSidePanel/index.js +7 -0
- package/es/components/EmptyStates/EmptyState.js +118 -0
- package/es/components/EmptyStates/EmptyStateContent.js +85 -0
- package/es/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js +113 -0
- package/es/components/EmptyStates/ErrorEmptyState/index.js +7 -0
- package/es/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js +113 -0
- package/es/components/EmptyStates/NoDataEmptyState/index.js +7 -0
- package/es/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js +113 -0
- package/es/components/EmptyStates/NoTagsEmptyState/index.js +7 -0
- package/es/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js +113 -0
- package/es/components/EmptyStates/NotFoundEmptyState/index.js +7 -0
- package/es/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js +113 -0
- package/es/components/EmptyStates/NotificationsEmptyState/index.js +7 -0
- package/es/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js +113 -0
- package/es/components/EmptyStates/UnauthorizedEmptyState/index.js +7 -0
- package/es/components/EmptyStates/assets/ErrorIllustration.js +217 -0
- package/es/components/EmptyStates/assets/NoDataIllustration.js +180 -0
- package/es/components/EmptyStates/assets/NoTagsIllustration.js +488 -0
- package/es/components/EmptyStates/assets/NotFoundIllustration.js +365 -0
- package/es/components/EmptyStates/assets/NotificationsIllustration.js +336 -0
- package/es/components/EmptyStates/assets/UnauthorizedIllustration.js +309 -0
- package/es/components/EmptyStates/index.js +13 -0
- package/es/components/ExampleComponent/ExampleComponent.js +160 -0
- package/es/components/ExampleComponent/index.js +7 -0
- package/es/components/ExportModal/ExportModal.js +276 -0
- package/es/components/ExportModal/index.js +7 -0
- package/es/components/ExpressiveCard/ExpressiveCard.js +138 -0
- package/es/components/ExpressiveCard/index.js +7 -0
- package/es/components/HTTPErrors/HTTPError403/HTTPError403.js +87 -0
- package/es/components/HTTPErrors/HTTPError403/index.js +7 -0
- package/es/components/HTTPErrors/HTTPError404/HTTPError404.js +87 -0
- package/es/components/HTTPErrors/HTTPError404/index.js +7 -0
- package/es/components/HTTPErrors/HTTPErrorContent.js +84 -0
- package/es/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js +87 -0
- package/es/components/HTTPErrors/HTTPErrorOther/index.js +7 -0
- package/es/components/HTTPErrors/assets/HTTPErrorSvg403.js +1238 -0
- package/es/components/HTTPErrors/assets/HTTPErrorSvg404.js +1037 -0
- package/es/components/HTTPErrors/assets/HTTPErrorSvgOther.js +1088 -0
- package/es/components/HTTPErrors/index.js +9 -0
- package/es/components/ImportModal/ImportModal.js +421 -0
- package/es/components/ImportModal/index.js +7 -0
- package/es/components/LoadingBar/LoadingBar.js +160 -0
- package/es/components/LoadingBar/index.js +7 -0
- package/es/components/ModifiedTabs/ModifiedTabLabelNew.js +34 -0
- package/es/components/ModifiedTabs/ModifiedTabLabelWithClose.js +54 -0
- package/es/components/ModifiedTabs/ModifiedTabs.js +113 -0
- package/es/components/ModifiedTabs/index.js +1 -0
- package/es/components/NotificationsPanel/NotificationsPanel.js +547 -0
- package/es/components/NotificationsPanel/NotificationsPanel_data.js +134 -0
- package/es/components/NotificationsPanel/index.js +7 -0
- package/es/components/NotificationsPanel/preview-components/UnreadNotificationBell.js +49 -0
- package/es/components/NotificationsPanel/utils.js +56 -0
- package/es/components/OptionsTile/OptionsTile.js +306 -0
- package/es/components/OptionsTile/index.js +7 -0
- package/es/components/PageHeader/PageHeader.js +789 -0
- package/es/components/PageHeader/PageHeaderDemo.data.js +614 -0
- package/es/components/PageHeader/PageHeaderTitle.js +49 -0
- package/es/components/PageHeader/PageHeaderUtils.js +187 -0
- package/es/components/PageHeader/index.js +7 -0
- package/es/components/ProductiveCard/ProductiveCard.js +118 -0
- package/es/components/ProductiveCard/index.js +7 -0
- package/es/components/RemoveModal/RemoveModal.js +189 -0
- package/es/components/RemoveModal/index.js +7 -0
- package/es/components/Saving/Saving.js +156 -0
- package/es/components/Saving/index.js +7 -0
- package/es/components/SidePanel/SidePanel.js +643 -0
- package/es/components/SidePanel/constants.js +13 -0
- package/es/components/SidePanel/index.js +7 -0
- package/es/components/StatusIcon/StatusIcon.js +132 -0
- package/es/components/StatusIcon/index.js +7 -0
- package/es/components/TagSet/TagSet.js +326 -0
- package/es/components/TagSet/TagSetModal.js +118 -0
- package/es/components/TagSet/TagSetOverflow.js +121 -0
- package/es/components/TagSet/index.js +7 -0
- package/es/components/Tearsheet/Tearsheet.js +180 -0
- package/es/components/Tearsheet/TearsheetNarrow.js +148 -0
- package/es/components/Tearsheet/TearsheetShell.js +390 -0
- package/es/components/Tearsheet/index.js +8 -0
- package/es/components/Toolbar/Toolbar.js +54 -0
- package/es/components/Toolbar/ToolbarButton.js +57 -0
- package/es/components/Toolbar/ToolbarGroup.js +37 -0
- package/es/components/Toolbar/index.js +9 -0
- package/es/components/UserProfileImage/UserProfileImage.js +136 -0
- package/es/components/UserProfileImage/index.js +8 -0
- package/es/components/WebTerminal/WebTerminal.js +168 -0
- package/es/components/WebTerminal/index.js +1 -0
- package/es/components/WebTerminal/preview-components/Navigation.js +31 -0
- package/es/components/WebTerminal/preview-components/documentationLinks.js +25 -0
- package/es/components/WebTerminal/preview-components/index.js +5 -0
- package/es/components/_Canary/Canary.js +48 -0
- package/es/components/_Canary/index.js +7 -0
- package/es/components/index.js +37 -0
- package/es/generated/feature-flags/feature-flags.js +15 -0
- package/es/global/js/hooks/index.js +14 -0
- package/es/global/js/hooks/useClickOutside.js +21 -0
- package/es/global/js/hooks/useCreateComponentFocus.js +37 -0
- package/es/global/js/hooks/useCreateComponentStepChange.js +250 -0
- package/es/global/js/hooks/usePreviousValue.js +19 -0
- package/es/global/js/hooks/useResetCreateComponent.js +40 -0
- package/es/global/js/hooks/useValidCreateStepCount.js +23 -0
- package/es/global/js/hooks/useWindowResize.js +67 -0
- package/es/global/js/hooks/useWindowScroll.js +80 -0
- package/es/global/js/package-settings.js +161 -0
- package/es/global/js/utils/ClickListener.js +70 -0
- package/es/global/js/utils/Wrap.js +85 -0
- package/es/global/js/utils/devtools.js +20 -0
- package/es/global/js/utils/getFocusableElements.js +14 -0
- package/es/global/js/utils/hasValidType.js +94 -0
- package/es/global/js/utils/keyboardNavigation.js +34 -0
- package/es/global/js/utils/pconsole.js +36 -0
- package/es/global/js/utils/props-helper.js +272 -0
- package/es/global/js/utils/scrollableAncestor.js +40 -0
- package/es/global/js/utils/story-helper.js +75 -0
- package/es/global/js/utils/test-helper.js +296 -0
- package/es/global/js/utils/unwrap-if-fragment.js +71 -0
- package/es/global/js/utils/uuidv4.js +12 -0
- package/es/global/js/utils/uuidv4.spec.js +23 -0
- package/es/global/js/utils/wait.js +8 -0
- package/es/global/js/utils/wrapFocus.js +74 -0
- package/es/index.js +8 -0
- package/es/settings.js +73 -0
- package/lib/components/APIKeyModal/APIKeyDownloader.js +127 -0
- package/lib/components/APIKeyModal/APIKeyModal.js +619 -0
- package/lib/components/APIKeyModal/index.js +13 -0
- package/lib/components/AboutModal/AboutModal.js +222 -0
- package/lib/components/AboutModal/index.js +13 -0
- package/lib/components/ActionBar/ActionBar.js +294 -0
- package/lib/components/ActionBar/ActionBarItem.js +107 -0
- package/lib/components/ActionBar/ActionBarOverflowItems.js +94 -0
- package/lib/components/ActionBar/index.js +21 -0
- package/lib/components/ActionSet/ActionSet.js +205 -0
- package/lib/components/ActionSet/actions.js +60 -0
- package/lib/components/ActionSet/index.js +13 -0
- package/lib/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js +366 -0
- package/lib/components/BreadcrumbWithOverflow/index.js +13 -0
- package/lib/components/ButtonMenu/ButtonMenu.js +115 -0
- package/lib/components/ButtonMenu/ButtonMenuItem.js +44 -0
- package/lib/components/ButtonMenu/index.js +21 -0
- package/lib/components/ButtonSetWithOverflow/ButtonSetWithOverflow.js +255 -0
- package/lib/components/ButtonSetWithOverflow/index.js +13 -0
- package/lib/components/Card/Card.js +260 -0
- package/lib/components/Card/CardFooter.js +90 -0
- package/lib/components/Card/CardHeader.js +70 -0
- package/lib/components/Card/index.js +29 -0
- package/lib/components/Cascade/Cascade.js +109 -0
- package/lib/components/Cascade/index.js +13 -0
- package/lib/components/ComboButton/ComboButton.js +129 -0
- package/lib/components/ComboButton/ComboButtonItem/index.js +49 -0
- package/lib/components/ComboButton/index.js +21 -0
- package/lib/components/CreateFullPage/CreateFullPage.js +478 -0
- package/lib/components/CreateFullPage/CreateFullPageSection.js +74 -0
- package/lib/components/CreateFullPage/CreateFullPageStep.js +134 -0
- package/lib/components/CreateFullPage/constants.js +16 -0
- package/lib/components/CreateFullPage/index.js +29 -0
- package/lib/components/CreateInfluencer/CreateInfluencer.js +304 -0
- package/lib/components/CreateInfluencer/index.js +13 -0
- package/lib/components/CreateModal/CreateModal.js +161 -0
- package/lib/components/CreateModal/index.js +13 -0
- package/lib/components/CreateSidePanel/CreateSidePanel.js +187 -0
- package/lib/components/CreateSidePanel/index.js +13 -0
- package/lib/components/CreateTearsheet/CreateTearsheet.js +397 -0
- package/lib/components/CreateTearsheet/CreateTearsheetDivider.js +48 -0
- package/lib/components/CreateTearsheet/CreateTearsheetSection.js +105 -0
- package/lib/components/CreateTearsheet/CreateTearsheetStep.js +151 -0
- package/lib/components/CreateTearsheet/constants.js +17 -0
- package/lib/components/CreateTearsheet/index.js +37 -0
- package/lib/components/CreateTearsheet/preview-components/MultiStepTearsheet.js +268 -0
- package/lib/components/CreateTearsheet/preview-components/MultiStepWithIntro.js +320 -0
- package/lib/components/CreateTearsheet/preview-components/MultiStepWithSectionsTearsheet.js +354 -0
- package/lib/components/CreateTearsheetNarrow/CreateTearsheetNarrow.js +184 -0
- package/lib/components/CreateTearsheetNarrow/index.js +13 -0
- package/lib/components/EditSidePanel/EditSidePanel.js +220 -0
- package/lib/components/EditSidePanel/index.js +13 -0
- package/lib/components/EmptyStates/EmptyState.js +134 -0
- package/lib/components/EmptyStates/EmptyStateContent.js +94 -0
- package/lib/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js +128 -0
- package/lib/components/EmptyStates/ErrorEmptyState/index.js +13 -0
- package/lib/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js +128 -0
- package/lib/components/EmptyStates/NoDataEmptyState/index.js +13 -0
- package/lib/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js +128 -0
- package/lib/components/EmptyStates/NoTagsEmptyState/index.js +13 -0
- package/lib/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js +128 -0
- package/lib/components/EmptyStates/NotFoundEmptyState/index.js +13 -0
- package/lib/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js +128 -0
- package/lib/components/EmptyStates/NotificationsEmptyState/index.js +13 -0
- package/lib/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js +128 -0
- package/lib/components/EmptyStates/UnauthorizedEmptyState/index.js +13 -0
- package/lib/components/EmptyStates/assets/ErrorIllustration.js +226 -0
- package/lib/components/EmptyStates/assets/NoDataIllustration.js +189 -0
- package/lib/components/EmptyStates/assets/NoTagsIllustration.js +497 -0
- package/lib/components/EmptyStates/assets/NotFoundIllustration.js +374 -0
- package/lib/components/EmptyStates/assets/NotificationsIllustration.js +345 -0
- package/lib/components/EmptyStates/assets/UnauthorizedIllustration.js +318 -0
- package/lib/components/EmptyStates/index.js +61 -0
- package/lib/components/ExampleComponent/ExampleComponent.js +169 -0
- package/lib/components/ExampleComponent/index.js +13 -0
- package/lib/components/ExportModal/ExportModal.js +298 -0
- package/lib/components/ExportModal/index.js +13 -0
- package/lib/components/ExpressiveCard/ExpressiveCard.js +161 -0
- package/lib/components/ExpressiveCard/index.js +13 -0
- package/lib/components/HTTPErrors/HTTPError403/HTTPError403.js +98 -0
- package/lib/components/HTTPErrors/HTTPError403/index.js +13 -0
- package/lib/components/HTTPErrors/HTTPError404/HTTPError404.js +98 -0
- package/lib/components/HTTPErrors/HTTPError404/index.js +13 -0
- package/lib/components/HTTPErrors/HTTPErrorContent.js +90 -0
- package/lib/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js +98 -0
- package/lib/components/HTTPErrors/HTTPErrorOther/index.js +13 -0
- package/lib/components/HTTPErrors/assets/HTTPErrorSvg403.js +1251 -0
- package/lib/components/HTTPErrors/assets/HTTPErrorSvg404.js +1050 -0
- package/lib/components/HTTPErrors/assets/HTTPErrorSvgOther.js +1101 -0
- package/lib/components/HTTPErrors/index.js +29 -0
- package/lib/components/ImportModal/ImportModal.js +443 -0
- package/lib/components/ImportModal/index.js +13 -0
- package/lib/components/LoadingBar/LoadingBar.js +174 -0
- package/lib/components/LoadingBar/index.js +13 -0
- package/lib/components/ModifiedTabs/ModifiedTabLabelNew.js +48 -0
- package/lib/components/ModifiedTabs/ModifiedTabLabelWithClose.js +68 -0
- package/lib/components/ModifiedTabs/ModifiedTabs.js +137 -0
- package/lib/components/ModifiedTabs/index.js +13 -0
- package/lib/components/NotificationsPanel/NotificationsPanel.js +569 -0
- package/lib/components/NotificationsPanel/NotificationsPanel_data.js +146 -0
- package/lib/components/NotificationsPanel/index.js +13 -0
- package/lib/components/NotificationsPanel/preview-components/UnreadNotificationBell.js +58 -0
- package/lib/components/NotificationsPanel/utils.js +65 -0
- package/lib/components/OptionsTile/OptionsTile.js +327 -0
- package/lib/components/OptionsTile/index.js +13 -0
- package/lib/components/PageHeader/PageHeader.js +822 -0
- package/lib/components/PageHeader/PageHeaderDemo.data.js +623 -0
- package/lib/components/PageHeader/PageHeaderTitle.js +63 -0
- package/lib/components/PageHeader/PageHeaderUtils.js +205 -0
- package/lib/components/PageHeader/index.js +13 -0
- package/lib/components/ProductiveCard/ProductiveCard.js +141 -0
- package/lib/components/ProductiveCard/index.js +13 -0
- package/lib/components/RemoveModal/RemoveModal.js +210 -0
- package/lib/components/RemoveModal/index.js +13 -0
- package/lib/components/Saving/Saving.js +175 -0
- package/lib/components/Saving/index.js +13 -0
- package/lib/components/SidePanel/SidePanel.js +668 -0
- package/lib/components/SidePanel/constants.js +21 -0
- package/lib/components/SidePanel/index.js +13 -0
- package/lib/components/StatusIcon/StatusIcon.js +145 -0
- package/lib/components/StatusIcon/index.js +13 -0
- package/lib/components/TagSet/TagSet.js +352 -0
- package/lib/components/TagSet/TagSetModal.js +139 -0
- package/lib/components/TagSet/TagSetOverflow.js +147 -0
- package/lib/components/TagSet/index.js +13 -0
- package/lib/components/Tearsheet/Tearsheet.js +192 -0
- package/lib/components/Tearsheet/TearsheetNarrow.js +160 -0
- package/lib/components/Tearsheet/TearsheetShell.js +420 -0
- package/lib/components/Tearsheet/index.js +21 -0
- package/lib/components/Toolbar/Toolbar.js +72 -0
- package/lib/components/Toolbar/ToolbarButton.js +75 -0
- package/lib/components/Toolbar/ToolbarGroup.js +52 -0
- package/lib/components/Toolbar/index.js +29 -0
- package/lib/components/UserProfileImage/UserProfileImage.js +146 -0
- package/lib/components/UserProfileImage/index.js +13 -0
- package/lib/components/WebTerminal/WebTerminal.js +186 -0
- package/lib/components/WebTerminal/index.js +13 -0
- package/lib/components/WebTerminal/preview-components/Navigation.js +44 -0
- package/lib/components/WebTerminal/preview-components/documentationLinks.js +32 -0
- package/lib/components/WebTerminal/preview-components/index.js +15 -0
- package/lib/components/_Canary/Canary.js +54 -0
- package/lib/components/_Canary/index.js +13 -0
- package/lib/components/index.js +343 -0
- package/lib/generated/feature-flags/feature-flags.js +22 -0
- package/lib/global/js/hooks/index.js +75 -0
- package/lib/global/js/hooks/useClickOutside.js +31 -0
- package/lib/global/js/hooks/useCreateComponentFocus.js +48 -0
- package/lib/global/js/hooks/useCreateComponentStepChange.js +263 -0
- package/lib/global/js/hooks/usePreviousValue.js +29 -0
- package/lib/global/js/hooks/useResetCreateComponent.js +50 -0
- package/lib/global/js/hooks/useValidCreateStepCount.js +33 -0
- package/lib/global/js/hooks/useWindowResize.js +79 -0
- package/lib/global/js/hooks/useWindowScroll.js +91 -0
- package/lib/global/js/package-settings.js +166 -0
- package/lib/global/js/utils/ClickListener.js +89 -0
- package/lib/global/js/utils/Wrap.js +93 -0
- package/lib/global/js/utils/devtools.js +31 -0
- package/lib/global/js/utils/getFocusableElements.js +25 -0
- package/lib/global/js/utils/hasValidType.js +110 -0
- package/lib/global/js/utils/keyboardNavigation.js +45 -0
- package/lib/global/js/utils/pconsole.js +53 -0
- package/lib/global/js/utils/props-helper.js +304 -0
- package/lib/global/js/utils/scrollableAncestor.js +48 -0
- package/lib/global/js/utils/story-helper.js +100 -0
- package/lib/global/js/utils/test-helper.js +342 -0
- package/lib/global/js/utils/unwrap-if-fragment.js +82 -0
- package/lib/global/js/utils/uuidv4.js +20 -0
- package/lib/global/js/utils/uuidv4.spec.js +28 -0
- package/lib/global/js/utils/wait.js +16 -0
- package/lib/global/js/utils/wrapFocus.js +84 -0
- package/lib/index.js +30 -0
- package/lib/settings.js +92 -0
- package/package.json +5 -5
- package/scss/components/APIKeyModal/_api-key-modal.scss +63 -0
- package/scss/components/APIKeyModal/_index.scss +10 -0
- package/scss/components/APIKeyModal/_storybook-styles.scss +33 -0
- package/scss/components/AboutModal/_about-modal.scss +116 -0
- package/scss/components/AboutModal/_index.scss +8 -0
- package/scss/components/AboutModal/_storybook-styles.scss +15 -0
- package/scss/components/ActionBar/_action-bar.scss +67 -0
- package/scss/components/ActionBar/_index.scss +8 -0
- package/scss/components/ActionSet/_action-set.scss +114 -0
- package/scss/components/ActionSet/_index.scss +8 -0
- package/scss/components/ActionSet/_storybook-styles.scss +38 -0
- package/scss/components/BreadcrumbWithOverflow/_breadcrumb-with-overflow.scss +86 -0
- package/scss/components/BreadcrumbWithOverflow/_index.scss +8 -0
- package/scss/components/ButtonMenu/_button-menu.scss +36 -0
- package/scss/components/ButtonMenu/_index.scss +8 -0
- package/scss/components/ButtonMenu/_storybook-styles.scss +6 -0
- package/scss/components/ButtonSetWithOverflow/_button-set-with-overflow.scss +52 -0
- package/scss/components/ButtonSetWithOverflow/_index.scss +8 -0
- package/scss/components/Card/_card.scss +121 -0
- package/scss/components/Card/_index.scss +10 -0
- package/scss/components/Card/_storybook-styles.scss +12 -0
- package/scss/components/Cascade/_cascade.scss +50 -0
- package/scss/components/Cascade/_index.scss +10 -0
- package/scss/components/Cascade/_storybook-styles.scss +32 -0
- package/scss/components/ComboButton/_combo-button.scss +64 -0
- package/scss/components/ComboButton/_index.scss +10 -0
- package/scss/components/CreateFullPage/_create-full-page.scss +187 -0
- package/scss/components/CreateFullPage/_index.scss +8 -0
- package/scss/components/CreateFullPage/_storybook-styles.scss +51 -0
- package/scss/components/CreateInfluencer/_create-influencer.scss +89 -0
- package/scss/components/CreateInfluencer/_index.scss +8 -0
- package/scss/components/CreateModal/_create-modal.scss +81 -0
- package/scss/components/CreateModal/_index.scss +8 -0
- package/scss/components/CreateModal/_storybook-styles.scss +50 -0
- package/scss/components/CreateSidePanel/_create-side-panel.scss +99 -0
- package/scss/components/CreateSidePanel/_index.scss +8 -0
- package/scss/components/CreateSidePanel/_storybook-styles.scss +27 -0
- package/scss/components/CreateTearsheet/_create-tearsheet.scss +136 -0
- package/scss/components/CreateTearsheet/_index.scss +8 -0
- package/scss/components/CreateTearsheet/_storybook-styles.scss +53 -0
- package/scss/components/CreateTearsheetNarrow/_create-tearsheet-narrow.scss +68 -0
- package/scss/components/CreateTearsheetNarrow/_index.scss +8 -0
- package/scss/components/CreateTearsheetNarrow/_storybook-styles.scss +32 -0
- package/scss/components/EditSidePanel/_edit-side-panel.scss +66 -0
- package/scss/components/EditSidePanel/_index.scss +8 -0
- package/scss/components/EditSidePanel/_storybook-styles.scss +35 -0
- package/scss/components/EmptyStates/_empty-state.scss +62 -0
- package/scss/components/EmptyStates/_index.scss +8 -0
- package/scss/components/EmptyStates/_storybook-styles.scss +6 -0
- package/scss/components/ExampleComponent/_example-component.scss +39 -0
- package/scss/components/ExampleComponent/_index.scss +8 -0
- package/scss/components/ExampleComponent/_storybook-styles.scss +6 -0
- package/scss/components/ExportModal/_export-modal.scss +61 -0
- package/scss/components/ExportModal/_index.scss +10 -0
- package/scss/components/ExportModal/_storybook-styles.scss +6 -0
- package/scss/components/ExpressiveCard/_expressive-card.scss +25 -0
- package/scss/components/ExpressiveCard/_index.scss +10 -0
- package/scss/components/ExpressiveCard/_storybook-styles.scss +25 -0
- package/scss/components/HTTPErrors/_http-errors.scss +72 -0
- package/scss/components/HTTPErrors/_index.scss +8 -0
- package/scss/components/HTTPErrors/_storybook-styles.scss +6 -0
- package/scss/components/ImportModal/_import-modal.scss +88 -0
- package/scss/components/ImportModal/_index.scss +8 -0
- package/scss/components/ImportModal/_storybook-styles.scss +6 -0
- package/scss/components/LoadingBar/_index.scss +8 -0
- package/scss/components/LoadingBar/_loading-bar.scss +211 -0
- package/scss/components/LoadingBar/_storybook-styles.scss +19 -0
- package/scss/components/ModifiedTabs/_index.scss +1 -0
- package/scss/components/ModifiedTabs/_modified-tabs.scss +72 -0
- package/scss/components/ModifiedTabs/_storybook-styles.scss +6 -0
- package/scss/components/NotificationsPanel/_index.scss +8 -0
- package/scss/components/NotificationsPanel/_notifications-panel.scss +285 -0
- package/scss/components/NotificationsPanel/_storybook-styles.scss +6 -0
- package/scss/components/OptionsTile/_index.scss +8 -0
- package/scss/components/OptionsTile/_options-tile.scss +221 -0
- package/scss/components/OptionsTile/_storybook-styles.scss +33 -0
- package/scss/components/PageHeader/_index.scss +10 -0
- package/scss/components/PageHeader/_page-header.scss +641 -0
- package/scss/components/PageHeader/_storybook-styles.scss +76 -0
- package/scss/components/ProductiveCard/_index.scss +10 -0
- package/scss/components/ProductiveCard/_productive-card.scss +71 -0
- package/scss/components/ProductiveCard/_storybook-styles.scss +22 -0
- package/scss/components/RemoveModal/_index.scss +10 -0
- package/scss/components/RemoveModal/_remove-modal.scss +40 -0
- package/scss/components/RemoveModal/_storybook-styles.scss +6 -0
- package/scss/components/Saving/_index.scss +10 -0
- package/scss/components/Saving/_saving.scss +42 -0
- package/scss/components/Saving/_storybook-styles.scss +12 -0
- package/scss/components/SidePanel/_index.scss +8 -0
- package/scss/components/SidePanel/_side-panel-variables.scss +14 -0
- package/scss/components/SidePanel/_side-panel.scss +496 -0
- package/scss/components/SidePanel/_storybook-styles.scss +38 -0
- package/scss/components/StatusIcon/_index.scss +8 -0
- package/scss/components/StatusIcon/_status-icon.scss +139 -0
- package/scss/components/StatusIcon/_storybook-styles.scss +6 -0
- package/scss/components/TagSet/_index.scss +8 -0
- package/scss/components/TagSet/_tag-set.scss +162 -0
- package/scss/components/Tearsheet/_index.scss +8 -0
- package/scss/components/Tearsheet/_storybook-styles.scss +24 -0
- package/scss/components/Tearsheet/_tearsheet.scss +308 -0
- package/scss/components/Toolbar/_index.scss +8 -0
- package/scss/components/Toolbar/_toolbar.scss +78 -0
- package/scss/components/UserProfileImage/_color-map.scss +39 -0
- package/scss/components/UserProfileImage/_index.scss +8 -0
- package/scss/components/UserProfileImage/_storybook.scss +6 -0
- package/scss/components/UserProfileImage/_user-profile-image.scss +137 -0
- package/scss/components/WebTerminal/_index.scss +1 -0
- package/scss/components/WebTerminal/_storybook-styles.scss +14 -0
- package/scss/components/WebTerminal/_web-terminal.scss +70 -0
- package/scss/components/_Canary/_canary.scss +9 -0
- package/scss/components/_index-released-only.scss +34 -0
- package/scss/components/_index.scss +44 -0
- package/scss/generated/feature-flags/_feature-flags.scss +19 -0
- package/scss/global/styles/_generate-carbon-modules.scss +14 -0
- package/scss/global/styles/_imported-carbon-modules.scss +25 -0
- package/scss/global/styles/_mixins.scss +22 -0
- package/scss/global/styles/_project-settings.scss +22 -0
- package/scss/index-full-carbon.scss +11 -0
- package/scss/index-without-carbon-released-only.scss +13 -0
- package/scss/index-without-carbon.scss +13 -0
- package/scss/index.scss +10 -0
@@ -0,0 +1,789 @@
|
|
1
|
+
import _extends from "@babel/runtime/helpers/extends";
|
2
|
+
import _defineProperty from "@babel/runtime/helpers/defineProperty";
|
3
|
+
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
|
4
|
+
import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
|
5
|
+
var _excluded = ["actionBarItems", "actionBarMenuOptionsClass", "actionBarOverflowAriaLabel", "allTagsModalSearchLabel", "allTagsModalSearchPlaceholderText", "allTagsModalTitle", "hasBackgroundAlways", "breadcrumbOverflowAriaLabel", "breadcrumbs", "children", "className", "collapseHeader", "collapseHeaderIconDescription", "collapseTitle", "disableBreadcrumbScroll", "expandHeaderIconDescription", "fullWidthGrid", "hasCollapseHeaderToggle", "narrowGrid", "navigation", "pageActions", "pageActionsOverflowLabel", "pageActionsMenuOptionsClass", "showAllTagsLabel", "subtitle", "tags", "title", "withoutBackground"];
|
6
|
+
|
7
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
|
8
|
+
|
9
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
10
|
+
|
11
|
+
//
|
12
|
+
// Copyright IBM Corp. 2020, 2021
|
13
|
+
//
|
14
|
+
// This source code is licensed under the Apache-2.0 license found in the
|
15
|
+
// LICENSE file in the root directory of this source tree.
|
16
|
+
//
|
17
|
+
import React, { useEffect, useRef, useState } from 'react';
|
18
|
+
import PropTypes from 'prop-types';
|
19
|
+
import { layout05, baseFontSize } from '@carbon/layout';
|
20
|
+
import cx from 'classnames';
|
21
|
+
import { useResizeDetector } from 'react-resize-detector';
|
22
|
+
import { Grid, Column, Row, Button, Tag } from 'carbon-components-react';
|
23
|
+
import { useWindowResize, useNearestScroll } from '../../global/js/hooks';
|
24
|
+
import { getDevtoolsProps } from '../../global/js/utils/devtools';
|
25
|
+
import { deprecateProp, prepareProps } from '../../global/js/utils/props-helper';
|
26
|
+
import { pkg } from '../../settings';
|
27
|
+
import { ActionBar } from '../ActionBar/';
|
28
|
+
import { BreadcrumbWithOverflow } from '../BreadcrumbWithOverflow';
|
29
|
+
import { TagSet, string_required_if_more_than_10_tags } from '../TagSet/TagSet';
|
30
|
+
import { ButtonSetWithOverflow } from '../ButtonSetWithOverflow';
|
31
|
+
import { ChevronUp16 } from '@carbon/icons-react';
|
32
|
+
var componentName = 'PageHeader';
|
33
|
+
import { blockClass, utilCheckUpdateVerticalSpace, utilGetBreadcrumbItemForTitle, utilSetCollapsed } from './PageHeaderUtils';
|
34
|
+
import { PageHeaderTitle } from './PageHeaderTitle';
|
35
|
+
export var PageHeader = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
|
36
|
+
var _withoutBackground, _ref5, _cx2, _ref6, _cx4, _cx7;
|
37
|
+
|
38
|
+
var actionBarItems = _ref.actionBarItems,
|
39
|
+
actionBarMenuOptionsClass = _ref.actionBarMenuOptionsClass,
|
40
|
+
actionBarOverflowAriaLabel = _ref.actionBarOverflowAriaLabel,
|
41
|
+
allTagsModalSearchLabel = _ref.allTagsModalSearchLabel,
|
42
|
+
allTagsModalSearchPlaceholderText = _ref.allTagsModalSearchPlaceholderText,
|
43
|
+
allTagsModalTitle = _ref.allTagsModalTitle,
|
44
|
+
deprecated_hasBackgroundAlways = _ref.hasBackgroundAlways,
|
45
|
+
breadcrumbOverflowAriaLabel = _ref.breadcrumbOverflowAriaLabel,
|
46
|
+
breadcrumbs = _ref.breadcrumbs,
|
47
|
+
children = _ref.children,
|
48
|
+
className = _ref.className,
|
49
|
+
collapseHeader = _ref.collapseHeader,
|
50
|
+
collapseHeaderIconDescription = _ref.collapseHeaderIconDescription,
|
51
|
+
collapseTitle = _ref.collapseTitle,
|
52
|
+
disableBreadcrumbScroll = _ref.disableBreadcrumbScroll,
|
53
|
+
expandHeaderIconDescription = _ref.expandHeaderIconDescription,
|
54
|
+
fullWidthGrid = _ref.fullWidthGrid,
|
55
|
+
hasCollapseHeaderToggle = _ref.hasCollapseHeaderToggle,
|
56
|
+
narrowGrid = _ref.narrowGrid,
|
57
|
+
navigation = _ref.navigation,
|
58
|
+
pageActions = _ref.pageActions,
|
59
|
+
pageActionsOverflowLabel = _ref.pageActionsOverflowLabel,
|
60
|
+
pageActionsMenuOptionsClass = _ref.pageActionsMenuOptionsClass,
|
61
|
+
showAllTagsLabel = _ref.showAllTagsLabel,
|
62
|
+
subtitle = _ref.subtitle,
|
63
|
+
tags = _ref.tags,
|
64
|
+
title = _ref.title,
|
65
|
+
withoutBackground = _ref.withoutBackground,
|
66
|
+
rest = _objectWithoutProperties(_ref, _excluded);
|
67
|
+
|
68
|
+
// handle deprecated props - START
|
69
|
+
// if withoutBackground is null check deprecated_hasBackgroundAlways and default false
|
70
|
+
(_withoutBackground = withoutBackground) !== null && _withoutBackground !== void 0 ? _withoutBackground : withoutBackground = !(deprecated_hasBackgroundAlways !== null && deprecated_hasBackgroundAlways !== void 0 ? deprecated_hasBackgroundAlways : true); // handle deprecated props - END
|
71
|
+
|
72
|
+
var _useState = useState({}),
|
73
|
+
_useState2 = _slicedToArray(_useState, 2),
|
74
|
+
metrics = _useState2[0],
|
75
|
+
setMetrics = _useState2[1];
|
76
|
+
|
77
|
+
var _useState3 = useState(_objectSpread({}, rest.style)),
|
78
|
+
_useState4 = _slicedToArray(_useState3, 2),
|
79
|
+
pageHeaderStyles = _useState4[0],
|
80
|
+
setPageHeaderStyles = _useState4[1]; // refs
|
81
|
+
|
82
|
+
|
83
|
+
var localHeaderRef = useRef(null);
|
84
|
+
var headerRef = ref || localHeaderRef;
|
85
|
+
var sizingContainerRef = useRef();
|
86
|
+
var offsetTopMeasuringRef = useRef(null); // utility functions
|
87
|
+
|
88
|
+
var checkUpdateVerticalSpace = function checkUpdateVerticalSpace() {
|
89
|
+
return utilCheckUpdateVerticalSpace(headerRef, offsetTopMeasuringRef, navigation, disableBreadcrumbScroll, setMetrics);
|
90
|
+
}; // state based on props only
|
91
|
+
|
92
|
+
|
93
|
+
var hasActionBar = actionBarItems && actionBarItems.length > 0;
|
94
|
+
var hasBreadcrumbRow = breadcrumbs || actionBarItems; // NOTE: The buffer is used to add space between the bottom of the header and the last content
|
95
|
+
// Not pre-collapsed and (subtitle or children)
|
96
|
+
|
97
|
+
var lastRowBufferActive = (title || pageActions) && !collapseTitle || subtitle || children; // state based on scroll/resize based effects
|
98
|
+
|
99
|
+
var _useState5 = useState(false),
|
100
|
+
_useState6 = _slicedToArray(_useState5, 2),
|
101
|
+
pageActionsInBreadcrumbRow = _useState6[0],
|
102
|
+
setPageActionsInBreadcrumbRow = _useState6[1];
|
103
|
+
|
104
|
+
var _useState7 = useState(0),
|
105
|
+
_useState8 = _slicedToArray(_useState7, 2),
|
106
|
+
scrollYValue = _useState8[0],
|
107
|
+
setScrollYValue = _useState8[1];
|
108
|
+
|
109
|
+
var _useState9 = useState(false),
|
110
|
+
_useState10 = _slicedToArray(_useState9, 2),
|
111
|
+
hasCollapseButton = _useState10[0],
|
112
|
+
setHasCollapseButton = _useState10[1];
|
113
|
+
|
114
|
+
var _useState11 = useState(false),
|
115
|
+
_useState12 = _slicedToArray(_useState11, 2),
|
116
|
+
spaceForCollapseButton = _useState12[0],
|
117
|
+
setSpaceForCollapseButton = _useState12[1];
|
118
|
+
|
119
|
+
var _useState13 = useState(0),
|
120
|
+
_useState14 = _slicedToArray(_useState13, 2),
|
121
|
+
actionBarMaxWidth = _useState14[0],
|
122
|
+
setActionBarMaxWidth = _useState14[1];
|
123
|
+
|
124
|
+
var _useState15 = useState(0),
|
125
|
+
_useState16 = _slicedToArray(_useState15, 2),
|
126
|
+
actionBarMinWidth = _useState16[0],
|
127
|
+
setActionBarMinWidth = _useState16[1];
|
128
|
+
|
129
|
+
var _useState17 = useState(0),
|
130
|
+
_useState18 = _slicedToArray(_useState17, 2),
|
131
|
+
pageActionInBreadcrumbMaxWidth = _useState18[0],
|
132
|
+
setPageActionInBreadcrumbMaxWidth = _useState18[1];
|
133
|
+
|
134
|
+
var _useState19 = useState(0),
|
135
|
+
_useState20 = _slicedToArray(_useState19, 2),
|
136
|
+
pageActionInBreadcrumbMinWidth = _useState20[0],
|
137
|
+
setPageActionInBreadcrumbMinWidth = _useState20[1];
|
138
|
+
|
139
|
+
var _useState21 = useState(0),
|
140
|
+
_useState22 = _slicedToArray(_useState21, 2),
|
141
|
+
actionBarColumnWidth = _useState22[0],
|
142
|
+
setActionBarColumnWidth = _useState22[1];
|
143
|
+
|
144
|
+
var _useState23 = useState(false),
|
145
|
+
_useState24 = _slicedToArray(_useState23, 2),
|
146
|
+
fullyCollapsed = _useState24[0],
|
147
|
+
setFullyCollapsed = _useState24[1]; // handlers
|
148
|
+
|
149
|
+
|
150
|
+
var handleActionBarWidthChange = function handleActionBarWidthChange(_ref2) {
|
151
|
+
var minWidth = _ref2.minWidth,
|
152
|
+
maxWidth = _ref2.maxWidth;
|
153
|
+
|
154
|
+
/* don't know how to test resize */
|
155
|
+
|
156
|
+
/* istanbul ignore next */
|
157
|
+
setActionBarMaxWidth(maxWidth);
|
158
|
+
/* don't know how to test resize */
|
159
|
+
|
160
|
+
/* istanbul ignore next */
|
161
|
+
|
162
|
+
setActionBarMinWidth(minWidth);
|
163
|
+
};
|
164
|
+
|
165
|
+
var handlePageActionWidthChange = function handlePageActionWidthChange(_ref3) {
|
166
|
+
var minWidth = _ref3.minWidth,
|
167
|
+
maxWidth = _ref3.maxWidth;
|
168
|
+
|
169
|
+
/* don't know how to test resize */
|
170
|
+
|
171
|
+
/* istanbul ignore next */
|
172
|
+
setPageActionInBreadcrumbMaxWidth(maxWidth);
|
173
|
+
/* don't know how to test resize */
|
174
|
+
|
175
|
+
/* istanbul ignore next */
|
176
|
+
|
177
|
+
setPageActionInBreadcrumbMinWidth(minWidth);
|
178
|
+
};
|
179
|
+
/* istanbul ignore next */
|
180
|
+
|
181
|
+
|
182
|
+
var handleResizeActionBarColumn = function handleResizeActionBarColumn(width) {
|
183
|
+
/* don't know how to test resize */
|
184
|
+
|
185
|
+
/* istanbul ignore next */
|
186
|
+
setActionBarColumnWidth(width);
|
187
|
+
};
|
188
|
+
/* istanbul ignore next */
|
189
|
+
|
190
|
+
|
191
|
+
var handleResize = function handleResize() {
|
192
|
+
// receives width and height parameters if needed
|
193
|
+
|
194
|
+
/* don't know how to test resize */
|
195
|
+
|
196
|
+
/* istanbul ignore next */
|
197
|
+
checkUpdateVerticalSpace();
|
198
|
+
};
|
199
|
+
|
200
|
+
var handleCollapseToggle = function handleCollapseToggle() {
|
201
|
+
utilSetCollapsed(!fullyCollapsed, metrics.headerOffset, metrics.headerTopValue);
|
202
|
+
}; // use effects
|
203
|
+
|
204
|
+
|
205
|
+
useEffect(function () {
|
206
|
+
if (pageActions !== null && pageActions !== void 0 && pageActions.content) {
|
207
|
+
var minWidth = pageActions.minWidth,
|
208
|
+
maxWidth = pageActions.maxWidth;
|
209
|
+
handlePageActionWidthChange({
|
210
|
+
minWidth: minWidth,
|
211
|
+
maxWidth: maxWidth
|
212
|
+
});
|
213
|
+
}
|
214
|
+
}, [pageActions]);
|
215
|
+
useEffect(function () {
|
216
|
+
// Determine the location of the pageAction buttons
|
217
|
+
|
218
|
+
/* istanbul ignore next */
|
219
|
+
setPageActionsInBreadcrumbRow(collapseTitle || scrollYValue > metrics.titleRowSpaceAbove && hasActionBar);
|
220
|
+
}, [hasActionBar, metrics.breadcrumbRowSpaceBelow, metrics.titleRowSpaceAbove, collapseTitle, scrollYValue]);
|
221
|
+
useEffect(function () {
|
222
|
+
// Assesses the size of the action bar and page action area and their required
|
223
|
+
// space before setting their sizes
|
224
|
+
//
|
225
|
+
var newActionBarWidth = 'initial';
|
226
|
+
var newPageActionInBreadcrumbWidth = 'initial';
|
227
|
+
/* don't know how to test resize */
|
228
|
+
|
229
|
+
/* istanbul ignore if */
|
230
|
+
|
231
|
+
if (actionBarColumnWidth > 0) {
|
232
|
+
if (pageActionInBreadcrumbMaxWidth > 0 && actionBarColumnWidth > actionBarMaxWidth + pageActionInBreadcrumbMaxWidth) {
|
233
|
+
newPageActionInBreadcrumbWidth = "".concat(pageActionInBreadcrumbMaxWidth, "px");
|
234
|
+
} else if (pageActionInBreadcrumbMinWidth > 0) {
|
235
|
+
newPageActionInBreadcrumbWidth = "".concat(pageActionInBreadcrumbMinWidth, "px");
|
236
|
+
}
|
237
|
+
|
238
|
+
if (actionBarMaxWidth > 0 && actionBarColumnWidth > pageActionInBreadcrumbMinWidth + actionBarMaxWidth) {
|
239
|
+
newActionBarWidth = "".concat(actionBarMaxWidth, "px");
|
240
|
+
} else {
|
241
|
+
if (actionBarMinWidth > 0) {
|
242
|
+
newActionBarWidth = "".concat(actionBarColumnWidth - pageActionInBreadcrumbMinWidth, "px");
|
243
|
+
}
|
244
|
+
}
|
245
|
+
}
|
246
|
+
|
247
|
+
setPageHeaderStyles(function (prev) {
|
248
|
+
var _objectSpread2;
|
249
|
+
|
250
|
+
return _objectSpread(_objectSpread({}, prev), {}, (_objectSpread2 = {}, _defineProperty(_objectSpread2, "--".concat(blockClass, "--max-action-bar-width-px"), newActionBarWidth), _defineProperty(_objectSpread2, "--".concat(blockClass, "--button-set-in-breadcrumb-width-px"), "".concat(newPageActionInBreadcrumbWidth)), _objectSpread2));
|
251
|
+
});
|
252
|
+
}, [actionBarColumnWidth, actionBarMaxWidth, actionBarMinWidth, pageActionInBreadcrumbMaxWidth, pageActionInBreadcrumbMinWidth, headerRef]);
|
253
|
+
useEffect(function () {
|
254
|
+
// Updates custom CSS props used to manage scroll behavior
|
255
|
+
|
256
|
+
/* istanbul ignore next */
|
257
|
+
setPageHeaderStyles(function (prev) {
|
258
|
+
var _objectSpread3;
|
259
|
+
|
260
|
+
return _objectSpread(_objectSpread({}, prev), {}, (_objectSpread3 = {}, _defineProperty(_objectSpread3, "--".concat(blockClass, "--height-px"), "".concat(metrics.headerHeight, "px")), _defineProperty(_objectSpread3, "--".concat(blockClass, "--width-px"), "".concat(metrics.headerWidth, "px")), _defineProperty(_objectSpread3, "--".concat(blockClass, "--header-top"), "".concat(metrics.headerTopValue + metrics.headerOffset, "px")), _defineProperty(_objectSpread3, "--".concat(blockClass, "--breadcrumb-title-visibility"), scrollYValue > 0 ? 'visible' : 'hidden'), _defineProperty(_objectSpread3, "--".concat(blockClass, "--scroll"), "".concat(scrollYValue)), _defineProperty(_objectSpread3, "--".concat(blockClass, "--breadcrumb-title-top"), "".concat(Math.max(0, metrics.breadcrumbTitleHeight + metrics.titleRowSpaceAbove - scrollYValue), "px")), _defineProperty(_objectSpread3, "--".concat(blockClass, "--breadcrumb-title-opacity"), "".concat(Math.min(1, Math.max(0, (scrollYValue - (metrics.titleRowSpaceAbove || 0)) / (metrics.breadcrumbTitleHeight || 1) // don't want to divide by zero
|
261
|
+
)))), _defineProperty(_objectSpread3, "--".concat(blockClass, "--breadcrumb-row-width-px"), "".concat(metrics.breadcrumbRowWidth, "px")), _objectSpread3));
|
262
|
+
});
|
263
|
+
}, [headerRef, disableBreadcrumbScroll, metrics, metrics.breadcrumbRowHeight, metrics.breadcrumbRowSpaceBelow, metrics.breadcrumbTitleHeight, metrics.breadcrumbRowWidth, metrics.headerHeight, metrics.headerWidth, metrics.headerOffset, metrics.headerTopValue, metrics.navigationRowHeight, navigation, scrollYValue, tags]);
|
264
|
+
useNearestScroll(headerRef, // on scroll or various layout changes check updates if needed
|
265
|
+
function (_ref4) {
|
266
|
+
var current = _ref4.current;
|
267
|
+
setPageHeaderStyles(function (prev) {
|
268
|
+
return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, "--".concat(blockClass, "--breadcrumb-top"), "".concat(metrics.headerOffset, "px")));
|
269
|
+
});
|
270
|
+
var fullyCollapsed = current.scrollY + metrics.headerTopValue + metrics.headerOffset >= 0;
|
271
|
+
setFullyCollapsed(fullyCollapsed); // set offset for tagset tooltip
|
272
|
+
|
273
|
+
/* istanbul ignore next */
|
274
|
+
|
275
|
+
var tagsetTooltipOffset = fullyCollapsed ? metrics.headerHeight + metrics.headerTopValue + metrics.headerOffset : metrics.headerHeight + metrics.headerOffset;
|
276
|
+
/* istanbul ignore next */
|
277
|
+
|
278
|
+
document.documentElement.style.setProperty("--".concat(blockClass, "--tagset-tooltip-position"), fullyCollapsed ? 'fixed' : 'absolute');
|
279
|
+
document.documentElement.style.setProperty("--".concat(blockClass, "--tagset-tooltip-offset"), "".concat(tagsetTooltipOffset, "px"));
|
280
|
+
setScrollYValue(current.scrollY);
|
281
|
+
}, [metrics.headerHeight, metrics.headerTopValue, metrics.headerOffset, disableBreadcrumbScroll]);
|
282
|
+
useWindowResize(function () {
|
283
|
+
// on window resize and other updates some values may have changed
|
284
|
+
checkUpdateVerticalSpace();
|
285
|
+
}, [actionBarItems, children, breadcrumbs, disableBreadcrumbScroll, navigation, pageActions, subtitle, tags, title]);
|
286
|
+
useEffect(function () {
|
287
|
+
checkUpdateVerticalSpace(); // eslint-disable-next-line react-hooks/exhaustive-deps
|
288
|
+
}, [fullWidthGrid, narrowGrid]);
|
289
|
+
useEffect(function () {
|
290
|
+
// Determines the appropriate header background opacity based on the header config/height/scroll and the withoutBackground setting
|
291
|
+
var result = withoutBackground ? 0 : 1;
|
292
|
+
|
293
|
+
if (!result && metrics.headerHeight > 0 && (breadcrumbs || actionBarItems || tags || navigation)) {
|
294
|
+
var startAddingAt = parseFloat(layout05, 10) * parseInt(baseFontSize);
|
295
|
+
var scrollRemaining = metrics.headerHeight - scrollYValue;
|
296
|
+
/* don't know how to test resize */
|
297
|
+
|
298
|
+
/* istanbul ignore if */
|
299
|
+
|
300
|
+
if (scrollRemaining < startAddingAt) {
|
301
|
+
var distanceAddingOver = startAddingAt - metrics.breadcrumbRowHeight;
|
302
|
+
result = Math.min(1, (startAddingAt - scrollRemaining) / distanceAddingOver);
|
303
|
+
}
|
304
|
+
}
|
305
|
+
|
306
|
+
setPageHeaderStyles(function (prev) {
|
307
|
+
return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, "--".concat(blockClass, "--background-opacity"), result));
|
308
|
+
});
|
309
|
+
}, [actionBarItems, withoutBackground, breadcrumbs, headerRef, metrics.breadcrumbRowHeight, metrics.headerHeight, navigation, scrollYValue, hasCollapseHeaderToggle, tags]);
|
310
|
+
useEffect(function () {
|
311
|
+
// only has toggle if requested and withoutBackground is unset/falsy
|
312
|
+
// NOTE: prop-types isRequired.if for the expand and collapse
|
313
|
+
// icon descriptions depends on the this.
|
314
|
+
setHasCollapseButton(hasCollapseHeaderToggle && !withoutBackground);
|
315
|
+
}, [withoutBackground, hasCollapseHeaderToggle]);
|
316
|
+
useEffect(function () {
|
317
|
+
// Determine if space is needed in the breadcrumb for a collapse button
|
318
|
+
setSpaceForCollapseButton(hasCollapseButton && !(navigation || tags) && metrics.headerHeight);
|
319
|
+
}, [hasCollapseButton, navigation, tags, metrics.headerHeight]);
|
320
|
+
|
321
|
+
var nextToTabsCheck = function nextToTabsCheck() {
|
322
|
+
/* istanbul ignore next */
|
323
|
+
return disableBreadcrumbScroll && !actionBarItems && scrollYValue + metrics.headerTopValue >= 0;
|
324
|
+
};
|
325
|
+
|
326
|
+
useEffect(function () {
|
327
|
+
if (typeof collapseHeader === 'boolean') {
|
328
|
+
utilSetCollapsed(collapseHeader, metrics.headerOffset, metrics.headerTopValue);
|
329
|
+
}
|
330
|
+
}, [collapseHeader, metrics.headerOffset, metrics.headerTopValue]);
|
331
|
+
useResizeDetector({
|
332
|
+
onResize: handleResizeActionBarColumn,
|
333
|
+
targetRef: sizingContainerRef,
|
334
|
+
handleWidth: true
|
335
|
+
});
|
336
|
+
useResizeDetector({
|
337
|
+
onResize: handleResize,
|
338
|
+
targetRef: headerRef,
|
339
|
+
handleHeight: true
|
340
|
+
}); // Determine what form of title to display in the breadcrumb
|
341
|
+
|
342
|
+
var breadcrumbItemForTitle = utilGetBreadcrumbItemForTitle(blockClass, collapseTitle, title);
|
343
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("div", {
|
344
|
+
className: "".concat(blockClass, "--offset-top-measuring-element"),
|
345
|
+
ref: offsetTopMeasuringRef
|
346
|
+
}), /*#__PURE__*/React.createElement("section", _extends({}, rest, {
|
347
|
+
className: cx([blockClass, "".concat(blockClass, "--no-margins-below-row"), className, (_ref5 = {}, _defineProperty(_ref5, "".concat(blockClass, "--has-navigation"), navigation || tags), _defineProperty(_ref5, "".concat(blockClass, "--has-navigation-tags-only"), !navigation && tags), _ref5)]),
|
348
|
+
style: pageHeaderStyles,
|
349
|
+
ref: headerRef
|
350
|
+
}, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(Grid, {
|
351
|
+
fullWidth: fullWidthGrid === true || fullWidthGrid === 'xl',
|
352
|
+
narrow: narrowGrid,
|
353
|
+
className: cx(_defineProperty({}, "".concat(blockClass, "--width--xl"), fullWidthGrid === 'xl'))
|
354
|
+
}, /*#__PURE__*/React.createElement("div", {
|
355
|
+
className: "".concat(blockClass, "__non-navigation-row-content")
|
356
|
+
}, hasBreadcrumbRow ? /*#__PURE__*/React.createElement(Row, {
|
357
|
+
className: cx("".concat(blockClass, "__breadcrumb-row"), (_cx2 = {}, _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--next-to-tabs"), nextToTabsCheck()), _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--has-breadcrumbs"), breadcrumbs), _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--has-action-bar"), hasActionBar), _defineProperty(_cx2, "".concat(blockClass, "__has-page-actions-without-action-bar"), !hasActionBar && pageActions), _cx2))
|
358
|
+
}, /*#__PURE__*/React.createElement("div", {
|
359
|
+
className: "".concat(blockClass, "__breadcrumb-row--container")
|
360
|
+
}, /*#__PURE__*/React.createElement(Column, {
|
361
|
+
className: cx("".concat(blockClass, "__breadcrumb-column"), _defineProperty({}, "".concat(blockClass, "__breadcrumb-column--background"), !!breadcrumbs || hasActionBar))
|
362
|
+
}, breadcrumbs ? /*#__PURE__*/React.createElement(BreadcrumbWithOverflow, {
|
363
|
+
className: "".concat(blockClass, "__breadcrumb"),
|
364
|
+
noTrailingSlash: !!title,
|
365
|
+
overflowAriaLabel: breadcrumbOverflowAriaLabel,
|
366
|
+
breadcrumbs: breadcrumbs ? breadcrumbItemForTitle ? breadcrumbs.concat(breadcrumbItemForTitle) : breadcrumbs : null
|
367
|
+
}) : null), /*#__PURE__*/React.createElement(Column, {
|
368
|
+
className: cx(["".concat(blockClass, "__action-bar-column ").concat(blockClass, "__action-bar-column--background"), (_ref6 = {}, _defineProperty(_ref6, "".concat(blockClass, "__action-bar-column--has-page-actions"), pageActions), _defineProperty(_ref6, "".concat(blockClass, "__action-bar-column--influenced-by-collapse-button"), spaceForCollapseButton), _ref6)])
|
369
|
+
}, /*#__PURE__*/React.createElement("div", {
|
370
|
+
className: "".concat(blockClass, "__action-bar-column-content"),
|
371
|
+
ref: sizingContainerRef
|
372
|
+
}, hasActionBar ?
|
373
|
+
/*#__PURE__*/
|
374
|
+
// Investigate the responsive behavior or this and the title also fix the ActionBar Item and PageAction story css
|
375
|
+
React.createElement(React.Fragment, null, thePageActions(true, pageActionsInBreadcrumbRow), /*#__PURE__*/React.createElement(ActionBar, {
|
376
|
+
menuOptionsClass: cx(actionBarMenuOptionsClass, "".concat(blockClass, "__action-bar-menu-options")),
|
377
|
+
overflowAriaLabel: actionBarOverflowAriaLabel,
|
378
|
+
actions: actionBarItems,
|
379
|
+
className: "".concat(blockClass, "__action-bar"),
|
380
|
+
onWidthChange: handleActionBarWidthChange,
|
381
|
+
rightAlign: true
|
382
|
+
})) : null)))) : null, !collapseTitle && (title || pageActions) ? /*#__PURE__*/React.createElement(Row, {
|
383
|
+
className: cx("".concat(blockClass, "__title-row"), (_cx4 = {}, _defineProperty(_cx4, "".concat(blockClass, "__title-row--no-breadcrumb-row"), !hasBreadcrumbRow), _defineProperty(_cx4, "".concat(blockClass, "__title-row--under-action-bar"), hasActionBar), _defineProperty(_cx4, "".concat(blockClass, "__title-row--has-page-actions"), !!pageActions), _defineProperty(_cx4, "".concat(blockClass, "__title-row--sticky"), !!pageActions && !actionBarItems && hasBreadcrumbRow), _cx4))
|
384
|
+
}, /*#__PURE__*/React.createElement(Column, {
|
385
|
+
className: "".concat(blockClass, "__title-column")
|
386
|
+
}, title ? /*#__PURE__*/React.createElement(PageHeaderTitle, {
|
387
|
+
blockClass: blockClass,
|
388
|
+
hasBreadcrumbRow: hasBreadcrumbRow,
|
389
|
+
title: title
|
390
|
+
}) : null), thePageActions(false, pageActionsInBreadcrumbRow)) : null, subtitle ? /*#__PURE__*/React.createElement(Row, {
|
391
|
+
className: "".concat(blockClass, "__subtitle-row")
|
392
|
+
}, /*#__PURE__*/React.createElement(Column, {
|
393
|
+
className: "".concat(blockClass, "__subtitle")
|
394
|
+
}, subtitle)) : null, children ? /*#__PURE__*/React.createElement(Row, {
|
395
|
+
className: "".concat(blockClass, "__available-row")
|
396
|
+
}, /*#__PURE__*/React.createElement(Column, {
|
397
|
+
className: "".concat(blockClass, "__available-column")
|
398
|
+
}, children)) : null, (breadcrumbs || actionBarItems || title || pageActions || children || subtitle) && /*#__PURE__*/React.createElement("div", {
|
399
|
+
className: cx(["".concat(blockClass, "__last-row-buffer"), _defineProperty({}, "".concat(blockClass, "__last-row-buffer--active"), lastRowBufferActive)])
|
400
|
+
}), // this navigation row scrolls under the breadcrumb if there is one
|
401
|
+
tags && !navigation ? /*#__PURE__*/React.createElement(Row, {
|
402
|
+
className: cx("".concat(blockClass, "__navigation-row"), _defineProperty({}, "".concat(blockClass, "__navigation-row--has-tags"), tags))
|
403
|
+
}, /*#__PURE__*/React.createElement(Column, {
|
404
|
+
className: cx("".concat(blockClass, "__navigation-tags"), _defineProperty({}, "".concat(blockClass, "__navigation-tags--tags-only"), !navigation))
|
405
|
+
}, /*#__PURE__*/React.createElement(TagSet, {
|
406
|
+
overflowAlign: "start",
|
407
|
+
allTagsModalSearchLabel: allTagsModalSearchLabel,
|
408
|
+
allTagsModalSearchPlaceholderText: allTagsModalSearchPlaceholderText,
|
409
|
+
allTagsModalTitle: allTagsModalTitle,
|
410
|
+
showAllTagsLabel: showAllTagsLabel,
|
411
|
+
tags: tags,
|
412
|
+
overflowClassName: "".concat(blockClass, "__navigation-tags-overflow")
|
413
|
+
}))) : null), // this navigation pushes the breadcrumb off or settles underneath it depending on disableBreadcrumbScroll
|
414
|
+
navigation ? /*#__PURE__*/React.createElement(Row, {
|
415
|
+
className: cx("".concat(blockClass, "__navigation-row"), (_cx7 = {}, _defineProperty(_cx7, "".concat(blockClass, "__navigation-row--spacing-above-06"), !!navigation), _defineProperty(_cx7, "".concat(blockClass, "__navigation-row--has-tags"), tags), _cx7))
|
416
|
+
}, /*#__PURE__*/React.createElement(Column, {
|
417
|
+
className: "".concat(blockClass, "__navigation-tabs")
|
418
|
+
}, navigation), tags ? /*#__PURE__*/React.createElement(Column, {
|
419
|
+
className: cx("".concat(blockClass, "__navigation-tags"), _defineProperty({}, "".concat(blockClass, "__navigation-tags--tags-only"), !navigation))
|
420
|
+
}, /*#__PURE__*/React.createElement(TagSet, {
|
421
|
+
overflowAlign: "end",
|
422
|
+
allTagsModalSearchLabel: allTagsModalSearchLabel,
|
423
|
+
allTagsModalSearchPlaceholderText: allTagsModalSearchPlaceholderText,
|
424
|
+
allTagsModalTitle: allTagsModalTitle,
|
425
|
+
showAllTagsLabel: showAllTagsLabel,
|
426
|
+
tags: tags,
|
427
|
+
overflowClassName: "".concat(blockClass, "__navigation-tags-overflow")
|
428
|
+
})) : null) : null), hasCollapseButton ? /*#__PURE__*/React.createElement(Button, {
|
429
|
+
className: cx("".concat(blockClass, "__collapse-expand-toggle"), _defineProperty({}, "".concat(blockClass, "__collapse-expand-toggle--collapsed"), fullyCollapsed)),
|
430
|
+
hasIconOnly: true,
|
431
|
+
iconDescription:
|
432
|
+
/* istanbul ignore next */
|
433
|
+
fullyCollapsed ? expandHeaderIconDescription : collapseHeaderIconDescription,
|
434
|
+
kind: "ghost",
|
435
|
+
onClick: handleCollapseToggle,
|
436
|
+
renderIcon: ChevronUp16,
|
437
|
+
size: "field",
|
438
|
+
tooltipPosition: "bottom",
|
439
|
+
tooltipAlignment: "end",
|
440
|
+
type: "button"
|
441
|
+
}) : null));
|
442
|
+
|
443
|
+
function thePageActions(isBreadcrumbRow, inBreadcrumbRow) {
|
444
|
+
if (pageActions) {
|
445
|
+
var _pageActions$content;
|
446
|
+
|
447
|
+
var _Tag = isBreadcrumbRow ? 'div' : Column; // Only report size change of version action bar is rendered as part of the breadcrumb row.
|
448
|
+
// and when there is an actionBar
|
449
|
+
|
450
|
+
|
451
|
+
var handleWidthChange = isBreadcrumbRow && hasBreadcrumbRow ? handlePageActionWidthChange : function () {};
|
452
|
+
return /*#__PURE__*/React.createElement(_Tag, {
|
453
|
+
className: cx("".concat(blockClass, "__page-actions"), _defineProperty({}, "".concat(blockClass, "__page-actions--in-breadcrumb"), inBreadcrumbRow))
|
454
|
+
}, /*#__PURE__*/React.createElement("div", {
|
455
|
+
className: cx("".concat(blockClass, "__page-actions-content"))
|
456
|
+
}, (_pageActions$content = pageActions.content) !== null && _pageActions$content !== void 0 ? _pageActions$content : /*#__PURE__*/React.createElement(ButtonSetWithOverflow, {
|
457
|
+
classname: "".concat(blockClass, "__button-set-with-overflow"),
|
458
|
+
menuOptionsClass: cx(pageActionsMenuOptionsClass, "".concat(blockClass, "__button-set-menu-options")),
|
459
|
+
onWidthChange: handleWidthChange,
|
460
|
+
buttons: pageActions,
|
461
|
+
buttonSetOverflowLabel: pageActionsOverflowLabel,
|
462
|
+
rightAlign: true
|
463
|
+
})));
|
464
|
+
}
|
465
|
+
}
|
466
|
+
}); // Return a placeholder if not released and not enabled by feature flag
|
467
|
+
|
468
|
+
PageHeader = pkg.checkComponentEnabled(PageHeader, componentName); // copied from carbon-components-react/src/components/Tag/Tag.js for DocGen
|
469
|
+
|
470
|
+
var TYPES = {
|
471
|
+
red: 'Red',
|
472
|
+
magenta: 'Magenta',
|
473
|
+
purple: 'Purple',
|
474
|
+
blue: 'Blue',
|
475
|
+
cyan: 'Cyan',
|
476
|
+
teal: 'Teal',
|
477
|
+
green: 'Green',
|
478
|
+
gray: 'Gray',
|
479
|
+
'cool-gray': 'Cool-Gray',
|
480
|
+
'warm-gray': 'Warm-Gray',
|
481
|
+
'high-contrast': 'High-Contrast'
|
482
|
+
};
|
483
|
+
var tagTypes = Object.keys(TYPES);
|
484
|
+
export var deprecatedProps = {
|
485
|
+
/**
|
486
|
+
* **Deprecated** see property `withoutBackground`
|
487
|
+
*/
|
488
|
+
hasBackgroundAlways: deprecateProp(PropTypes.bool, 'Property replaced by `withoutBackground`')
|
489
|
+
};
|
490
|
+
PageHeader.propTypes = _objectSpread({
|
491
|
+
/**
|
492
|
+
* Specifies the action bar items which are the final items in the row top of the PageHeader.
|
493
|
+
* Each item is specified as an object with the properties of a Carbon Button in icon only form.
|
494
|
+
* Button kind, size, tooltipPosition, tooltipAlignment and type are ignored.
|
495
|
+
*/
|
496
|
+
actionBarItems: PropTypes.arrayOf(PropTypes.shape(_objectSpread(_objectSpread({}, prepareProps(Button.propTypes, ['kind', 'size', 'tooltipPosition', 'tooltipAlignment'])), {}, {
|
497
|
+
iconDescription: PropTypes.string.isRequired,
|
498
|
+
onClick: Button.propTypes.onClick,
|
499
|
+
renderIcon: Button.propTypes.renderIcon.isRequired
|
500
|
+
}))),
|
501
|
+
|
502
|
+
/**
|
503
|
+
* class name applied to the action bar overflow options
|
504
|
+
*/
|
505
|
+
actionBarMenuOptionsClass: PropTypes.string,
|
506
|
+
|
507
|
+
/**
|
508
|
+
* When there is insufficient space for all actionBarItems to be displayed this
|
509
|
+
* aria label is used for the action bar overflow menu
|
510
|
+
*
|
511
|
+
* NOTE: This prop is required if actionBarItems are supplied
|
512
|
+
*/
|
513
|
+
actionBarOverflowAriaLabel: PropTypes.string.isRequired.if(function (_ref8) {
|
514
|
+
var actionBarItems = _ref8.actionBarItems;
|
515
|
+
return actionBarItems && actionBarItems.length > 0;
|
516
|
+
}),
|
517
|
+
|
518
|
+
/**
|
519
|
+
* When tags are supplied there may not be sufficient space to display all of the tags. This results in an overflow
|
520
|
+
* menu being shown. If in the overflow menu there is still insufficient space this label is used in a dialog showing
|
521
|
+
* all tags.
|
522
|
+
*
|
523
|
+
* **Note: Required if more than 10 tags**
|
524
|
+
*/
|
525
|
+
allTagsModalSearchLabel: string_required_if_more_than_10_tags,
|
526
|
+
|
527
|
+
/**
|
528
|
+
* When tags are supplied there may not be sufficient space to display all of the tags. This results in an overflow
|
529
|
+
* menu being shown. If in the overflow menu there is still insufficient space this placeholder is used in a dialog
|
530
|
+
* showing all tags.
|
531
|
+
*
|
532
|
+
* **Note: Required if more than 10 tags**
|
533
|
+
*/
|
534
|
+
allTagsModalSearchPlaceholderText: string_required_if_more_than_10_tags,
|
535
|
+
|
536
|
+
/**
|
537
|
+
* When tags are supplied there may not be sufficient space to display all of the tags. This results in an overflow
|
538
|
+
* menu being shown. If in the overflow menu there is still insufficient space this title is used in a dialog showing
|
539
|
+
* all tags.
|
540
|
+
*
|
541
|
+
* **Note: Required if more than 10 tags**
|
542
|
+
*/
|
543
|
+
allTagsModalTitle: string_required_if_more_than_10_tags,
|
544
|
+
|
545
|
+
/**
|
546
|
+
* If the user supplies breadcrumbs then this property is required.
|
547
|
+
* It is used in an overflow menu when there is insufficient space to display all breadcrumbs inline.
|
548
|
+
*/
|
549
|
+
breadcrumbOverflowAriaLabel: PropTypes.string.isRequired.if(function (_ref9) {
|
550
|
+
var breadcrumbs = _ref9.breadcrumbs;
|
551
|
+
return breadcrumbs && breadcrumbs.length > 0;
|
552
|
+
}),
|
553
|
+
|
554
|
+
/**
|
555
|
+
* Specifies the breadcrumb components to be shown in the breadcrumb area of
|
556
|
+
* the page header. Each item is specified as an object with optional fields
|
557
|
+
* 'label' to supply the breadcrumb label, 'href' to supply the link location,
|
558
|
+
* and 'isCurrentPage' to specify whether this breadcrumb component represents
|
559
|
+
* the current page. Each item should also include a unique 'key' field to
|
560
|
+
* enable efficient rendering, and if the label is not a string then a 'title'
|
561
|
+
* field is required to provide a text alternative for display. Any other
|
562
|
+
* fields in the object will be passed through to the breadcrumb element as
|
563
|
+
* HTML attributes.
|
564
|
+
*/
|
565
|
+
breadcrumbs: PropTypes.arrayOf(PropTypes.shape({
|
566
|
+
/**
|
567
|
+
* Optional string representing the link location for the BreadcrumbItem
|
568
|
+
*/
|
569
|
+
href: PropTypes.string,
|
570
|
+
|
571
|
+
/**
|
572
|
+
* Provide if this breadcrumb item represents the current page
|
573
|
+
*/
|
574
|
+
isCurrentPage: PropTypes.bool,
|
575
|
+
|
576
|
+
/**
|
577
|
+
* Key required to render array efficiently
|
578
|
+
*/
|
579
|
+
key: PropTypes.string.isRequired,
|
580
|
+
|
581
|
+
/**
|
582
|
+
* Pass in content that will be inside of the BreadcrumbItem
|
583
|
+
*/
|
584
|
+
label: PropTypes.node,
|
585
|
+
|
586
|
+
/**
|
587
|
+
* A text version of the `label` for display, required if `label` is not a string.
|
588
|
+
*/
|
589
|
+
title: PropTypes.string.isRequired.if(function (_ref10) {
|
590
|
+
var label = _ref10.label;
|
591
|
+
return typeof label !== 'string';
|
592
|
+
})
|
593
|
+
})),
|
594
|
+
|
595
|
+
/**
|
596
|
+
* A zone for placing high-level, client content above the page tabs.
|
597
|
+
* Accepts arbitrary renderable content as a React node. Optional.
|
598
|
+
*/
|
599
|
+
children: PropTypes.node,
|
600
|
+
|
601
|
+
/**
|
602
|
+
* Specifies class(es) to be applied to the top-level PageHeader node.
|
603
|
+
* Optional.
|
604
|
+
*/
|
605
|
+
className: PropTypes.string,
|
606
|
+
|
607
|
+
/**
|
608
|
+
* The header can as a whole be collapsed, expanded or somewhere in between.
|
609
|
+
* This setting controls the initial value, but also takes effect on change
|
610
|
+
*
|
611
|
+
* NOTE: The header is collapsed by setting the scroll position to hide part of the header.
|
612
|
+
* Collapsing has no effect if there is insufficient content to scroll.
|
613
|
+
*/
|
614
|
+
collapseHeader: PropTypes.bool,
|
615
|
+
|
616
|
+
/**
|
617
|
+
* If `hasCollapseHeaderToggle` is set and `withoutBackground` is unset/falsy then assistive text is
|
618
|
+
* required for both the expend and collapse states of the button component used.
|
619
|
+
*/
|
620
|
+
collapseHeaderIconDescription: PropTypes.string.isRequired.if(function (_ref11) {
|
621
|
+
var withoutBackground = _ref11.withoutBackground,
|
622
|
+
hasCollapseHeaderToggle = _ref11.hasCollapseHeaderToggle;
|
623
|
+
return !withoutBackground && hasCollapseHeaderToggle;
|
624
|
+
}),
|
625
|
+
|
626
|
+
/**
|
627
|
+
* The title row typically starts below the breadcrumb row. This option
|
628
|
+
* preCollapses it into the breadcrumb row.
|
629
|
+
*/
|
630
|
+
collapseTitle: PropTypes.bool,
|
631
|
+
|
632
|
+
/**
|
633
|
+
* Standard behavior scrolls the breadcrumb off to leave just tabs. This
|
634
|
+
* option preserves vertical space for both the breadcrumb and tabs if they're supplied.
|
635
|
+
*/
|
636
|
+
disableBreadcrumbScroll: PropTypes.bool,
|
637
|
+
|
638
|
+
/**
|
639
|
+
* If `hasCollapseHeaderToggle` is set and `withoutBackground` is unset/falsy then assistive text is
|
640
|
+
* required for both the expend and collapse states of the button component used.
|
641
|
+
*/
|
642
|
+
expandHeaderIconDescription: PropTypes.string.isRequired.if(function (_ref12) {
|
643
|
+
var withoutBackground = _ref12.withoutBackground,
|
644
|
+
hasCollapseHeaderToggle = _ref12.hasCollapseHeaderToggle;
|
645
|
+
return !withoutBackground && hasCollapseHeaderToggle;
|
646
|
+
}),
|
647
|
+
|
648
|
+
/**
|
649
|
+
* The PageHeader is hosted in a Carbon grid, this value is passed through to the Carbon grid fullWidth prop.
|
650
|
+
* 'xl' is used to override the grid width setting. Can be used with narrowGrid: true to get the largest size.
|
651
|
+
*/
|
652
|
+
fullWidthGrid: PropTypes.oneOfType([PropTypes.bool, PropTypes.oneOf(['xl'])]),
|
653
|
+
|
654
|
+
/**
|
655
|
+
* Adds a button as the last element of the bottom row which collapses and expands the header.
|
656
|
+
*
|
657
|
+
* NOTE: The header is collapsed by setting the scroll position to hide part of the header.
|
658
|
+
* Collapsing has no effect if there is insufficient content to scroll.
|
659
|
+
*/
|
660
|
+
hasCollapseHeaderToggle: PropTypes.bool,
|
661
|
+
|
662
|
+
/**
|
663
|
+
* The PageHeader is hosted in a Carbon grid, this value is passed through to the Carbon grid narrow prop
|
664
|
+
*/
|
665
|
+
narrowGrid: PropTypes.bool,
|
666
|
+
|
667
|
+
/**
|
668
|
+
* Content for the navigation area in the PageHeader. Should
|
669
|
+
* be a React element that is normally a Carbon Tabs component. Optional.
|
670
|
+
*/
|
671
|
+
navigation: PropTypes.element,
|
672
|
+
// Supports Tabs
|
673
|
+
|
674
|
+
/**
|
675
|
+
* Specifies the primary page actions which are placed at the same level in the page as the title.
|
676
|
+
*
|
677
|
+
* Either a set of actions, each specified as an object with the properties of a Carbon Button plus:
|
678
|
+
*
|
679
|
+
* - label: node
|
680
|
+
*
|
681
|
+
* Or a single object
|
682
|
+
*
|
683
|
+
* - content: content to be rendered. NOTE: must be capable of restricting itself to the space provided. This 2.5rem height ($spacing-08)
|
684
|
+
* and the width not used by action bar items when scrolled into toolbar.
|
685
|
+
* - minWidth: smallest number of pixel width the content would like. NOTE: This is not guaranteed and may be less on small viewports.
|
686
|
+
* - maxWidth: maximum number of pixels the content will grow to
|
687
|
+
* Carbon Button API https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
|
688
|
+
*/
|
689
|
+
pageActions: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.shape(_objectSpread(_objectSpread({}, Button.propTypes), {}, {
|
690
|
+
key: PropTypes.string.isRequired,
|
691
|
+
kind: Button.propTypes.kind,
|
692
|
+
label: PropTypes.node,
|
693
|
+
onClick: PropTypes.func
|
694
|
+
}))), PropTypes.shape({
|
695
|
+
/**
|
696
|
+
* minWidth should not be more than 180
|
697
|
+
* The content is expected to adjust itself to fit in
|
698
|
+
*/
|
699
|
+
content: PropTypes.node.isRequired,
|
700
|
+
minWidth: PropTypes.number.isRequired,
|
701
|
+
maxWidth: PropTypes.number.isRequired
|
702
|
+
})]),
|
703
|
+
|
704
|
+
/**
|
705
|
+
* class name applied to the page actions overflow options
|
706
|
+
*/
|
707
|
+
pageActionsMenuOptionsClass: PropTypes.string,
|
708
|
+
|
709
|
+
/**
|
710
|
+
* When there is insufficient space to display all of hte page actions inline a dropdown button menu is shown,
|
711
|
+
* containing the page actions. This label is used as the display content of the dropdown button menu.
|
712
|
+
*
|
713
|
+
* NOTE: This prop is required if pageActions are supplied
|
714
|
+
*/
|
715
|
+
pageActionsOverflowLabel: PropTypes.node.isRequired.if(function (_ref13) {
|
716
|
+
var pageActions = _ref13.pageActions;
|
717
|
+
return pageActions && pageActions.length > 0 && !pageActions.content;
|
718
|
+
}),
|
719
|
+
|
720
|
+
/**
|
721
|
+
* When tags are supplied there may not be sufficient space to display all of the tags. This results in an overflow
|
722
|
+
* menu being shown. If in the overflow menu there is still insufficient space this label is used to offer a
|
723
|
+
* "View all tags" option.
|
724
|
+
*
|
725
|
+
* **Note: Required if more than 10 tags**
|
726
|
+
*/
|
727
|
+
showAllTagsLabel: string_required_if_more_than_10_tags,
|
728
|
+
|
729
|
+
/**
|
730
|
+
* Sitting just below the title is this optional subtitle that provides additional context to
|
731
|
+
* identify the current page.
|
732
|
+
*/
|
733
|
+
subtitle: PropTypes.string,
|
734
|
+
|
735
|
+
/**
|
736
|
+
* An array of tags to be shown as the final content in the PageHeader.
|
737
|
+
*
|
738
|
+
* Each tag is specified as an object with the following properties
|
739
|
+
* **label**\* (required) to supply the tag content, and properties of the the Carbon Tag component,
|
740
|
+
* such as **type**, **disabled**, **ref**, **className** , and any other Tag props.
|
741
|
+
*
|
742
|
+
* NOTE: **filter** is not supported. Any remaining fields in the object will be passed through to the HTML element
|
743
|
+
* as HTML attributes.
|
744
|
+
*
|
745
|
+
* See https://react.carbondesignsystem.com/?path=/docs/components-tag--default
|
746
|
+
*/
|
747
|
+
tags: PropTypes.arrayOf(PropTypes.shape(_objectSpread(_objectSpread({}, prepareProps(Tag.propTypes, 'filter')), {}, {
|
748
|
+
label: PropTypes.string.isRequired,
|
749
|
+
// we duplicate this prop to improve the DocGen
|
750
|
+
type: PropTypes.oneOf(tagTypes)
|
751
|
+
}))),
|
752
|
+
|
753
|
+
/**
|
754
|
+
* An optional page title supplied as a string or object with the following attributes: text, icon, loading
|
755
|
+
*
|
756
|
+
* Can be supplied either as:
|
757
|
+
* - String
|
758
|
+
* - Object containing
|
759
|
+
* - text: title string
|
760
|
+
* - icon: optional icon
|
761
|
+
* - loading: boolean shows loading indicator if true
|
762
|
+
* - Object containing user defined contents. These must fit within the area defined for the title in both main part of the header and the breadcrumb.
|
763
|
+
* - content: title or name of current location shown in main part of page header
|
764
|
+
* - breadcrumbContent: version of content used in the breadcrumb on scroll. If not supplied
|
765
|
+
* - asText: String based representation of the title
|
766
|
+
*/
|
767
|
+
title: PropTypes.oneOfType([PropTypes.shape({
|
768
|
+
// Update docgen if changed
|
769
|
+
text: PropTypes.string.isRequired,
|
770
|
+
icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
|
771
|
+
loading: PropTypes.bool // Update docgen if changed
|
772
|
+
|
773
|
+
}), PropTypes.string, PropTypes.shape({
|
774
|
+
content: PropTypes.node.isRequired,
|
775
|
+
breadcrumbContent: PropTypes.node,
|
776
|
+
asText: PropTypes.string.isRequired
|
777
|
+
})]),
|
778
|
+
|
779
|
+
/**
|
780
|
+
* Specifies if the PageHeader should appear without a background color, and defaults to the preferred `false` (a background color is shown).
|
781
|
+
* Note that when `true` some parts of the header still gain a background if and when they stick to the top of the PageHeader on scroll.
|
782
|
+
*/
|
783
|
+
withoutBackground: PropTypes.bool
|
784
|
+
}, deprecatedProps);
|
785
|
+
PageHeader.defaultProps = {
|
786
|
+
fullWidthGrid: false,
|
787
|
+
narrowGrid: false
|
788
|
+
};
|
789
|
+
PageHeader.displayName = componentName;
|