@nypl/design-system-react-components 3.6.3 → 4.0.0-alpha-rc2
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/dist/design-system-react-components.cjs +61 -64
- package/dist/design-system-react-components.js +36164 -37998
- package/dist/filteringStyleGuide/activeFiltersList.png +0 -0
- package/dist/filteringStyleGuide/exampleColumn.png +0 -0
- package/dist/filteringStyleGuide/examplePopup.png +0 -0
- package/dist/filteringStyleGuide/exampleRow.png +0 -0
- package/dist/filteringStyleGuide/filterBar.png +0 -0
- package/dist/filteringStyleGuide/focusClearingFilters.gif +0 -0
- package/dist/filteringStyleGuide/focusKeywordSearch.gif +0 -0
- package/dist/filteringStyleGuide/focusLiveFiltering.gif +0 -0
- package/dist/filteringStyleGuide/focusPagination.gif +0 -0
- package/dist/filteringStyleGuide/focusSorting.gif +0 -0
- package/dist/filteringStyleGuide/fullPageExample.png +0 -0
- package/dist/filteringStyleGuide/keywordSearchField.png +0 -0
- package/dist/filteringStyleGuide/paginationMenu.png +0 -0
- package/dist/filteringStyleGuide/resultsList.png +0 -0
- package/dist/filteringStyleGuide/sortingMenu.png +0 -0
- package/dist/filteringStyleGuide/totalResultsHeading.png +0 -0
- package/dist/responsiveGrid/breakpointRangeDesktop.png +0 -0
- package/dist/responsiveGrid/breakpointRangeMobileLarge.png +0 -0
- package/dist/responsiveGrid/breakpointRangeMobileSmall.png +0 -0
- package/dist/responsiveGrid/breakpointRangeTabletLarge.png +0 -0
- package/dist/responsiveGrid/breakpointRangeTabletSmall.png +0 -0
- package/dist/responsiveGrid/cardGridDesktop4Cols.png +0 -0
- package/dist/responsiveGrid/cardGridLargeMobile1Col.png +0 -0
- package/dist/responsiveGrid/cardGridLargeMobile2Cols.png +0 -0
- package/dist/responsiveGrid/cardGridSmallMobile1Col.png +0 -0
- package/dist/responsiveGrid/cardGridSmallTablet1Col.png +0 -0
- package/dist/responsiveGrid/cardGridSmallTablet3Cols.png +0 -0
- package/dist/responsiveGrid/cardGridSmallTablet3ColsSidebar.png +0 -0
- package/dist/responsiveGrid/gridColumns.png +0 -0
- package/dist/responsiveGrid/gridGutters.png +0 -0
- package/dist/responsiveGrid/gridMargins.png +0 -0
- package/dist/responsiveGrid/gridPerceivedColumns1.png +0 -0
- package/dist/responsiveGrid/gridPerceivedColumns2.png +0 -0
- package/dist/responsiveGrid/gridPerceivedColumns3.png +0 -0
- package/dist/responsiveGrid/gridPerceivedColumns4.png +0 -0
- package/dist/src/components/Accordion/Accordion.d.ts +6 -8
- package/dist/src/components/AlphabetFilter/AlphabetFilter.d.ts +2 -4
- package/dist/src/components/AudioPlayer/AudioPlayer.d.ts +2 -4
- package/dist/src/components/Banner/Banner.d.ts +7 -13
- package/dist/src/components/Breadcrumbs/Breadcrumbs.d.ts +7 -9
- package/dist/src/components/Button/Button.d.ts +9 -14
- package/dist/src/components/ButtonGroup/ButtonGroup.d.ts +2 -4
- package/dist/src/components/Card/Card.d.ts +2 -4
- package/dist/src/components/Checkbox/Checkbox.d.ts +3 -10
- package/dist/src/components/CheckboxGroup/CheckboxGroup.d.ts +2 -4
- package/dist/src/components/ComponentWrapper/ComponentWrapper.d.ts +2 -5
- package/dist/src/components/DatePicker/DatePicker.d.ts +2 -4
- package/dist/src/components/FeaturedContent/FeaturedContent.d.ts +3 -5
- package/dist/src/components/FeedbackBox/FeedbackBox.d.ts +2 -4
- package/dist/src/components/Fieldset/Fieldset.d.ts +2 -4
- package/dist/src/components/FilterBarInline/FilterBarInline.d.ts +2 -4
- package/dist/src/components/FilterBarPopup/FilterBarPopup.d.ts +2 -4
- package/dist/src/components/Form/Form.d.ts +4 -12
- package/dist/src/components/Grid/SimpleGrid.d.ts +2 -4
- package/dist/src/components/Heading/Heading.d.ts +4 -6
- package/dist/src/components/HelperErrorText/HelperErrorText.d.ts +2 -16
- package/dist/src/components/Hero/Hero.d.ts +13 -17
- package/dist/src/components/HorizontalRule/HorizontalRule.d.ts +2 -4
- package/dist/src/components/Icons/Icon.d.ts +5 -8
- package/dist/src/components/Icons/IconSvgs.d.ts +0 -3
- package/dist/src/components/Icons/iconVariables.d.ts +3 -3
- package/dist/src/components/Image/Image.d.ts +2 -10
- package/dist/src/components/Label/Label.d.ts +3 -7
- package/dist/src/components/Link/Link.d.ts +10 -18
- package/dist/src/components/List/List.d.ts +10 -8
- package/dist/src/components/Logo/Logo.d.ts +2 -4
- package/dist/src/components/Menu/Menu.d.ts +2 -4
- package/dist/src/components/Modal/Modal.d.ts +7 -6
- package/dist/src/components/MultiSelect/MultiSelect.d.ts +2 -2
- package/dist/src/components/MultiSelectGroup/MultiSelectGroup.d.ts +2 -4
- package/dist/src/components/NewsletterSignup/NewsletterSignup.d.ts +5 -8
- package/dist/src/components/Notification/Notification.d.ts +5 -11
- package/dist/src/components/Pagination/Pagination.d.ts +2 -4
- package/dist/src/components/ProgressIndicator/ProgressIndicator.d.ts +2 -4
- package/dist/src/components/Radio/Radio.d.ts +3 -9
- package/dist/src/components/RadioGroup/RadioGroup.d.ts +2 -4
- package/dist/src/components/SearchBar/SearchBar.d.ts +3 -11
- package/dist/src/components/Select/Select.d.ts +6 -16
- package/dist/src/components/SkeletonLoader/SkeletonLoader.d.ts +2 -4
- package/dist/src/components/SkipNavigation/SkipNavigation.d.ts +2 -4
- package/dist/src/components/Slider/Slider.d.ts +3 -5
- package/dist/src/components/SocialMediaLinks/SocialMediaLinks.d.ts +4 -6
- package/dist/src/components/StatusBadge/StatusBadge.d.ts +5 -12
- package/dist/src/components/StructuredContent/StructuredContent.d.ts +2 -4
- package/dist/src/components/StyledList/StyledList.d.ts +3 -7
- package/dist/src/components/SubNav/SubNav.d.ts +4 -8
- package/dist/src/components/Table/Table.d.ts +2 -10
- package/dist/src/components/Tabs/Tabs.d.ts +2 -2
- package/dist/src/components/TagSet/TagSet.d.ts +3 -5
- package/dist/src/components/TagSet/TagSetExplore.d.ts +1 -1
- package/dist/src/components/TagSet/TagSetFilter.d.ts +1 -1
- package/dist/src/components/Template/Template.d.ts +38 -117
- package/dist/src/components/Text/Text.d.ts +2 -6
- package/dist/src/components/TextInput/TextInput.d.ts +9 -32
- package/dist/src/components/Toggle/Toggle.d.ts +3 -8
- package/dist/src/components/Tooltip/Tooltip.d.ts +2 -6
- package/dist/src/components/VideoPlayer/VideoPlayer.d.ts +2 -4
- package/dist/src/hooks/useMultiSelect.d.ts +5 -1
- package/dist/src/hooks/useNYPLBreakpoints.d.ts +6 -1
- package/dist/src/hooks/useResponsiveSpacing.d.ts +23 -0
- package/dist/src/index.d.ts +16 -17
- package/dist/src/theme/components/breadcrumb.d.ts +1 -1
- package/dist/src/theme/components/button.d.ts +1 -4
- package/dist/src/theme/components/heading.d.ts +1 -125
- package/dist/src/theme/components/hero.d.ts +11 -11
- package/dist/src/theme/components/link.d.ts +1 -40
- package/dist/src/theme/components/newsletterSignup.d.ts +3 -3
- package/dist/src/theme/components/notification.d.ts +3 -6
- package/dist/src/theme/components/notificationContent.d.ts +3 -3
- package/dist/src/theme/components/notificationHeading.d.ts +3 -3
- package/dist/src/theme/components/progressIndicator.d.ts +1 -2
- package/dist/src/theme/components/slider.d.ts +8 -4
- package/dist/src/theme/components/statusBadge.d.ts +1 -14
- package/dist/src/theme/components/structuredContent.d.ts +1 -5
- package/dist/src/theme/components/{customTable.d.ts → table.d.ts} +7 -13
- package/dist/src/theme/components/template.d.ts +49 -125
- package/dist/src/theme/components/text.d.ts +1 -9
- package/dist/src/theme/foundations/breakpoints.d.ts +21 -8
- package/dist/src/theme/sharedTypes.d.ts +4 -0
- package/dist/src/utils/utils.d.ts +8 -1
- package/dist/styles.css +1 -1
- package/dist/template/templateBottom.png +0 -0
- package/dist/template/templateBreakout.png +0 -0
- package/dist/template/templateFluidColumns1.png +0 -0
- package/dist/template/templateFluidColumns2.png +0 -0
- package/dist/template/templateFluidColumns3.png +0 -0
- package/dist/template/templateFluidColumns4.png +0 -0
- package/dist/template/templateFullPageLayout.png +0 -0
- package/dist/template/templateMain.png +0 -0
- package/dist/template/templateMainNarrow.png +0 -0
- package/dist/template/templateMainWide.png +0 -0
- package/dist/template/templateSidebarLeft.png +0 -0
- package/dist/template/templateSidebarNone.png +0 -0
- package/dist/template/templateSidebarRight.png +0 -0
- package/dist/template/templateTop.png +0 -0
- package/package.json +1 -1
- package/dist/src/components/Header/Header.d.ts +0 -13
- package/dist/src/components/Header/components/HeaderLogin.d.ts +0 -12
- package/dist/src/components/Header/components/HeaderLoginButton.d.ts +0 -10
- package/dist/src/components/Header/components/HeaderLowerNav.d.ts +0 -6
- package/dist/src/components/Header/components/HeaderMobileIconNav.d.ts +0 -6
- package/dist/src/components/Header/components/HeaderMobileNav.d.ts +0 -6
- package/dist/src/components/Header/components/HeaderMobileNavButton.d.ts +0 -6
- package/dist/src/components/Header/components/HeaderSearchButton.d.ts +0 -9
- package/dist/src/components/Header/components/HeaderSearchForm.d.ts +0 -10
- package/dist/src/components/Header/components/HeaderSitewideAlerts.d.ts +0 -7
- package/dist/src/components/Header/components/HeaderUpperNav.d.ts +0 -7
- package/dist/src/components/Header/context/headerContext.d.ts +0 -13
- package/dist/src/components/Header/utils/encoreCatalogLogOutTimer.d.ts +0 -4
- package/dist/src/components/Header/utils/headerUtils.d.ts +0 -70
- package/dist/src/theme/components/header.d.ts +0 -100
- package/dist/src/theme/components/headerLogin.d.ts +0 -333
- package/dist/src/theme/components/headerLoginButton.d.ts +0 -72
- package/dist/src/theme/components/headerLowerNav.d.ts +0 -78
- package/dist/src/theme/components/headerMobileIconNav.d.ts +0 -28
- package/dist/src/theme/components/headerMobileNav.d.ts +0 -92
- package/dist/src/theme/components/headerMobileNavButton.d.ts +0 -36
- package/dist/src/theme/components/headerSearchButton.d.ts +0 -85
- package/dist/src/theme/components/headerSearchForm.d.ts +0 -185
- package/dist/src/theme/components/headerSitewideAlerts.d.ts +0 -43
- package/dist/src/theme/components/headerUpperNav.d.ts +0 -60
|
@@ -1,12 +1,10 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export interface HorizontalRuleProps {
|
|
3
|
+
export interface HorizontalRuleProps extends BoxProps {
|
|
4
4
|
/** Optional alignment value to align the horizontal rule to one side or the
|
|
5
5
|
* other when the width is less than 100%. If omitted, the horizontal rule
|
|
6
6
|
* will have a default center alignment. */
|
|
7
7
|
align?: "left" | "right";
|
|
8
|
-
/** ClassName you can add in addition to `horizontal-rule` */
|
|
9
|
-
className?: string;
|
|
10
8
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
11
9
|
id?: string;
|
|
12
10
|
}
|
|
@@ -1,18 +1,15 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
import { iconAlignArray, iconColorsArray, iconNamesArray, iconRotationsArray, iconSizesArray,
|
|
3
|
+
import { iconAlignArray, iconColorsArray, iconNamesArray, iconRotationsArray, iconSizesArray, iconVariantsArray } from "./iconVariables";
|
|
4
4
|
export type IconAlign = typeof iconAlignArray[number];
|
|
5
5
|
export type IconColors = typeof iconColorsArray[number];
|
|
6
6
|
export type IconNames = typeof iconNamesArray[number];
|
|
7
7
|
export type IconRotations = typeof iconRotationsArray[number];
|
|
8
|
-
export type IconRotationTypes = typeof iconRotationsArray[number];
|
|
9
8
|
export type IconSizes = typeof iconSizesArray[number];
|
|
10
|
-
export type
|
|
11
|
-
export interface IconProps {
|
|
9
|
+
export type IconVariants = typeof iconVariantsArray[number];
|
|
10
|
+
export interface IconProps extends Pick<BoxProps, "className" | keyof ChakraProps> {
|
|
12
11
|
/** Aligns the icon. */
|
|
13
12
|
align?: IconAlign;
|
|
14
|
-
/** Optional className that will be added to the parent element */
|
|
15
|
-
className?: string;
|
|
16
13
|
/** Overrides default icon color (black). */
|
|
17
14
|
color?: IconColors;
|
|
18
15
|
/** Icons designated as decorative will be ignored by screenreaders. True
|
|
@@ -31,7 +28,7 @@ export interface IconProps {
|
|
|
31
28
|
* visible but is needed for screenreaders to describe the graphic. */
|
|
32
29
|
title?: string;
|
|
33
30
|
/** FOR INTERNAL DS USE ONLY: the icon variant to display. */
|
|
34
|
-
|
|
31
|
+
variant?: IconVariants;
|
|
35
32
|
}
|
|
36
33
|
/**
|
|
37
34
|
* Renders SVG-based icons.
|
|
@@ -10,10 +10,8 @@ declare const _default: {
|
|
|
10
10
|
actionHome: any;
|
|
11
11
|
actionIdentity: any;
|
|
12
12
|
actionIdentityFilled: any;
|
|
13
|
-
actionInfo: any;
|
|
14
13
|
actionLaunch: any;
|
|
15
14
|
actionLightbulb: any;
|
|
16
|
-
actionList: any;
|
|
17
15
|
actionLockClosed: any;
|
|
18
16
|
actionPayment: any;
|
|
19
17
|
actionPower: any;
|
|
@@ -59,7 +57,6 @@ declare const _default: {
|
|
|
59
57
|
minus: any;
|
|
60
58
|
moonCrescent: any;
|
|
61
59
|
navigationMoreVert: any;
|
|
62
|
-
navigationApps: any;
|
|
63
60
|
navigationSubdirectoryArrowLeft: any;
|
|
64
61
|
navigationSubdirectoryArrowRight: any;
|
|
65
62
|
plus: any;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export declare const iconAlignArray: readonly ["left", "right", "none"];
|
|
2
|
-
export declare const iconColorsArray: readonly ["transparent", "ui.black", "ui.white", "ui.disabled.primary", "ui.disabled.secondary", "ui.error.primary", "ui.error.secondary", "ui.focus", "ui.link.primary", "ui.link.primary-05", "ui.link.primary-10", "ui.link.secondary", "ui.link.tertiary", "ui.status.primary", "ui.status.secondary", "ui.success.primary", "ui.success.secondary", "ui.test", "ui.warning.primary", "ui.warning.secondary", "ui.bg.default", "ui.bg.hover", "ui.bg.active", "ui.border.default", "ui.border.hover", "ui.typography.heading", "ui.typography.body", "ui.typography.inverse.heading", "ui.typography.inverse.body", "ui.gray.xxxx-dark", "ui.gray.xxx-dark", "ui.gray.xx-dark", "ui.gray.x-dark", "ui.gray.dark", "ui.gray.semi-dark", "ui.gray.medium", "ui.gray.semi-medium", "ui.gray.light-cool", "ui.gray.x-light-cool", "ui.gray.xx-light-cool", "ui.gray.light-warm", "ui.gray.x-light-warm", "brand.primary", "brand.secondary", "section.blogs.primary", "section.blogs.secondary", "section.books-and-more.primary", "section.books-and-more.secondary", "section.connect.primary", "section.connect.secondary", "section.education.primary", "section.education.secondary", "section.locations.primary", "section.locations.secondary", "section.research.primary", "section.research.secondary", "section.research-library.lpa", "section.research-library.schomburg", "section.research-library.schwarzman", "section.whats-on.primary", "section.whats-on.secondary", "dark.brand.primary", "dark.brand.secondary", "dark.section.blogs.primary", "dark.section.blogs.secondary", "dark.section.books-and-more.primary", "dark.section.books-and-more.secondary", "dark.section.connect.primary", "dark.section.connect.secondary", "dark.section.education.primary", "dark.section.education.secondary", "dark.section.locations.primary", "dark.section.locations.secondary", "dark.section.research.primary", "dark.section.research.secondary", "dark.section.research-library.primary", "dark.section.research-library.secondary", "dark.section.whats-on.primary", "dark.section.whats-on.secondary", "dark.ui.disabled.primary", "dark.ui.disabled.secondary", "dark.ui.error.primary", "dark.ui.error.secondary", "dark.ui.focus", "dark.ui.link.primary", "dark.ui.link.primary-05", "dark.ui.link.primary-10", "dark.ui.link.secondary", "dark.ui.link.tertiary", "dark.ui.status.primary", "dark.ui.status.secondary", "dark.ui.success.primary", "dark.ui.success.secondary", "dark.ui.test", "dark.ui.warning.secondary", "dark.ui.warning.primary", "dark.ui.bg.page", "dark.ui.bg.default", "dark.ui.bg.hover", "dark.ui.bg.active", "dark.ui.border.default", "dark.ui.border.hover", "dark.ui.typography.heading", "dark.ui.typography.body", "dark.ui.typography.inverse.heading", "dark.ui.typography.inverse.body"];
|
|
3
|
-
export declare const iconNamesArray: readonly ["accessibilityFull", "accessibilityPartial", "actionCheckCircle", "actionCheckCircleFilled", "actionDelete", "actionExit", "actionHelpDefault", "actionHelpOutline", "actionHome", "actionIdentity", "actionIdentityFilled", "
|
|
2
|
+
export declare const iconColorsArray: readonly ["currentColor", "transparent", "ui.black", "ui.white", "ui.disabled.primary", "ui.disabled.secondary", "ui.error.primary", "ui.error.secondary", "ui.focus", "ui.link.primary", "ui.link.primary-05", "ui.link.primary-10", "ui.link.secondary", "ui.link.tertiary", "ui.status.primary", "ui.status.secondary", "ui.success.primary", "ui.success.secondary", "ui.test", "ui.warning.primary", "ui.warning.secondary", "ui.bg.default", "ui.bg.hover", "ui.bg.active", "ui.border.default", "ui.border.hover", "ui.typography.heading", "ui.typography.body", "ui.typography.inverse.heading", "ui.typography.inverse.body", "ui.gray.xxxx-dark", "ui.gray.xxx-dark", "ui.gray.xx-dark", "ui.gray.x-dark", "ui.gray.dark", "ui.gray.semi-dark", "ui.gray.medium", "ui.gray.semi-medium", "ui.gray.light-cool", "ui.gray.x-light-cool", "ui.gray.xx-light-cool", "ui.gray.light-warm", "ui.gray.x-light-warm", "brand.primary", "brand.secondary", "section.blogs.primary", "section.blogs.secondary", "section.books-and-more.primary", "section.books-and-more.secondary", "section.connect.primary", "section.connect.secondary", "section.education.primary", "section.education.secondary", "section.locations.primary", "section.locations.secondary", "section.research.primary", "section.research.secondary", "section.research-library.lpa", "section.research-library.schomburg", "section.research-library.schwarzman", "section.whats-on.primary", "section.whats-on.secondary", "dark.brand.primary", "dark.brand.secondary", "dark.section.blogs.primary", "dark.section.blogs.secondary", "dark.section.books-and-more.primary", "dark.section.books-and-more.secondary", "dark.section.connect.primary", "dark.section.connect.secondary", "dark.section.education.primary", "dark.section.education.secondary", "dark.section.locations.primary", "dark.section.locations.secondary", "dark.section.research.primary", "dark.section.research.secondary", "dark.section.research-library.primary", "dark.section.research-library.secondary", "dark.section.whats-on.primary", "dark.section.whats-on.secondary", "dark.ui.disabled.primary", "dark.ui.disabled.secondary", "dark.ui.error.primary", "dark.ui.error.secondary", "dark.ui.focus", "dark.ui.link.primary", "dark.ui.link.primary-05", "dark.ui.link.primary-10", "dark.ui.link.secondary", "dark.ui.link.tertiary", "dark.ui.status.primary", "dark.ui.status.secondary", "dark.ui.success.primary", "dark.ui.success.secondary", "dark.ui.test", "dark.ui.warning.secondary", "dark.ui.warning.primary", "dark.ui.bg.page", "dark.ui.bg.default", "dark.ui.bg.hover", "dark.ui.bg.active", "dark.ui.border.default", "dark.ui.border.hover", "dark.ui.typography.heading", "dark.ui.typography.body", "dark.ui.typography.inverse.heading", "dark.ui.typography.inverse.body"];
|
|
3
|
+
export declare const iconNamesArray: readonly ["accessibilityFull", "accessibilityPartial", "actionCheckCircle", "actionCheckCircleFilled", "actionDelete", "actionExit", "actionHelpDefault", "actionHelpOutline", "actionHome", "actionIdentity", "actionIdentityFilled", "actionLaunch", "actionLightbulb", "actionLockClosed", "actionPayment", "actionPower", "actionRegistration", "actionSearch", "actionSettings", "alertNotificationImportant", "alertWarningFilled", "alertWarningOutline", "arrow", "building", "check", "clock", "close", "communicationCall", "communicationChatBubble", "communicationEmail", "contentFilterList", "decorativeBookBroken", "decorativeEnvelope", "decorativeLibraryCard", "decorativeShoppingBag", "download", "editorMode", "errorFilled", "errorOutline", "fileTypeAudio", "fileTypeDoc", "fileTypeGenericDoc", "fileTypeImage", "fileTypePdf", "fileTypeSpreadsheet", "fileTypeVideo", "headset", "legacyAccountFilled", "legacyAccountUnfilled", "legacySocialFacebook", "legacySocialInstagram", "legacySocialTwitter", "legacySocialYoutube", "locator", "mapsPlace", "minus", "moonCrescent", "navigationMoreVert", "navigationSubdirectoryArrowLeft", "navigationSubdirectoryArrowRight", "plus", "search", "socialFacebook", "socialInstagram", "socialPinterest", "socialSoundCloud", "socialSpotify", "socialTikTok", "socialTumblr", "socialTwitter", "socialVimeo", "socialX", "socialYoutube", "speakerNotes", "sunFull", "utilityAccountFilled", "utilityAccountUnfilled", "utilityCheck", "utilityHamburger", "utilitySearch"];
|
|
4
4
|
export declare const iconRotationsArray: readonly ["rotate0", "rotate90", "rotate180", "rotate270"];
|
|
5
5
|
export declare const iconSizesArray: readonly ["default", "xsmall", "small", "medium", "large", "xlarge", "xxlarge", "xxxlarge", "xxxxlarge", "xxxxxlarge", "2xlarge", "3xlarge", "4xlarge", "5xlarge"];
|
|
6
|
-
export declare const
|
|
6
|
+
export declare const iconVariantsArray: readonly ["default", "breadcrumbs"];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
2
|
import React, { ImgHTMLAttributes } from "react";
|
|
3
3
|
import { DimensionTypes } from "../../helpers/types";
|
|
4
4
|
export declare const imageRatiosArray: readonly ["fourByThree", "fourByOne", "twoByThree", "oneByTwo", "original", "sixteenByNine", "square", "threeByFour", "threeByTwo", "twoByOne"];
|
|
@@ -40,8 +40,6 @@ interface ImageWrapperProps {
|
|
|
40
40
|
additionalWrapperStyles?: {
|
|
41
41
|
[key: string]: any;
|
|
42
42
|
};
|
|
43
|
-
/** ClassName you can add in addition to 'image' */
|
|
44
|
-
className?: string;
|
|
45
43
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
46
44
|
id?: string;
|
|
47
45
|
/** Optional value to control the aspect ratio of the card image; default
|
|
@@ -52,7 +50,7 @@ interface ImageWrapperProps {
|
|
|
52
50
|
/** Sets the image size based on the width or height. Width by default. */
|
|
53
51
|
sizeBasedOn?: DimensionTypes;
|
|
54
52
|
}
|
|
55
|
-
export interface ImageProps extends ImageWrapperProps, ImgHTMLAttributes<HTMLImageElement> {
|
|
53
|
+
export interface ImageProps extends Pick<BoxProps, keyof ChakraProps>, ImageWrapperProps, Omit<ImgHTMLAttributes<HTMLImageElement>, "color" | "height" | "width"> {
|
|
56
54
|
/** Optionally pass in additional Chakra-based styles only for the figure. */
|
|
57
55
|
additionalFigureStyles?: {
|
|
58
56
|
[key: string]: any;
|
|
@@ -61,8 +59,6 @@ export interface ImageProps extends ImageWrapperProps, ImgHTMLAttributes<HTMLIma
|
|
|
61
59
|
additionalImageStyles?: {
|
|
62
60
|
[key: string]: any;
|
|
63
61
|
};
|
|
64
|
-
/** Alternate text description of the image */
|
|
65
|
-
alt?: string;
|
|
66
62
|
/** Optional value to control the aspect ratio of the card image; default
|
|
67
63
|
* value is `"original"` */
|
|
68
64
|
aspectRatio?: ImageRatios;
|
|
@@ -78,10 +74,6 @@ export interface ImageProps extends ImageWrapperProps, ImgHTMLAttributes<HTMLIma
|
|
|
78
74
|
imageType?: ImageTypes;
|
|
79
75
|
/** Flag to set the internal `Image` component to `isLazy` mode. */
|
|
80
76
|
isLazy?: boolean;
|
|
81
|
-
/** Additional action to perform in the `img`'s `onerror` attribute function. */
|
|
82
|
-
onError?: (event: React.SyntheticEvent<HTMLImageElement>) => void;
|
|
83
|
-
/** The src attribute is required, and contains the path to the image you want to embed. */
|
|
84
|
-
src?: string;
|
|
85
77
|
}
|
|
86
78
|
export declare const Image: ChakraComponent<React.ForwardRefExoticComponent<ImageProps & React.RefAttributes<HTMLDivElement>>, ImageProps>;
|
|
87
79
|
export default Image;
|
|
@@ -1,10 +1,6 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
2
|
-
import React from "react";
|
|
3
|
-
export interface LabelProps {
|
|
4
|
-
/** Additional CSS class name to render in the `label` element. */
|
|
5
|
-
className?: string;
|
|
6
|
-
/** The id of the html element that this `Label` is describing. */
|
|
7
|
-
htmlFor: string;
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
|
+
import React, { LabelHTMLAttributes } from "react";
|
|
3
|
+
export interface LabelProps extends Pick<BoxProps, keyof ChakraProps>, Omit<LabelHTMLAttributes<HTMLLabelElement>, "color"> {
|
|
8
4
|
/** ID that other components can cross reference for accessibility purposes */
|
|
9
5
|
id?: string;
|
|
10
6
|
/** Controls whether the label should be inline with the input it goes with.
|
|
@@ -1,33 +1,25 @@
|
|
|
1
|
-
import { ChakraComponent,
|
|
2
|
-
import React from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
5
|
-
export interface LinkProps extends
|
|
6
|
-
/** Additional class name to render in the `Link` component. */
|
|
7
|
-
className?: string;
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
|
+
import React, { AnchorHTMLAttributes } from "react";
|
|
3
|
+
export declare const linkVariantsArray: readonly ["action", "backwards", "buttonPrimary", "buttonSecondary", "buttonPill", "buttonCallout", "buttonNoBrand", "buttonDisabled", "default", "external", "forwards", "standalone"];
|
|
4
|
+
export type LinkVariants = typeof linkVariantsArray[number];
|
|
5
|
+
export interface LinkProps extends Pick<BoxProps, "as" | keyof ChakraProps>, Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "color"> {
|
|
8
6
|
/** Used to include or remove visited state styles. Default is true. */
|
|
9
7
|
hasVisitedState?: boolean;
|
|
10
|
-
/** The `href` attribute for the anchor element. */
|
|
11
|
-
href?: string;
|
|
12
8
|
/** ID used for accessibility purposes. */
|
|
13
9
|
id?: string;
|
|
14
10
|
/** Used to explicitly set the underline style for a text link. If true, link
|
|
15
11
|
* text will always be underlined; if false, link text will only show
|
|
16
12
|
* underline in hover state. */
|
|
17
13
|
isUnderlined?: boolean;
|
|
18
|
-
onClick?: (event: React.MouseEvent<HTMLDivElement | HTMLAnchorElement, MouseEvent>) => void;
|
|
19
|
-
rel?: string;
|
|
20
14
|
/** Visibly hidden text that will only be read by screenreaders. */
|
|
21
15
|
screenreaderOnlyText?: string;
|
|
22
|
-
/**
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
* standalone, or default. */
|
|
26
|
-
type?: LinkTypes;
|
|
16
|
+
/** Controls the link's styles based on the value: action, backwards, default,
|
|
17
|
+
* external, forwards, standalone, and all "button" types. */
|
|
18
|
+
variant?: LinkVariants;
|
|
27
19
|
}
|
|
28
20
|
/**
|
|
29
|
-
* A component that
|
|
30
|
-
*
|
|
21
|
+
* A component that renders an anchor element with added styling
|
|
22
|
+
* and conventions.
|
|
31
23
|
*/
|
|
32
24
|
export declare const Link: ChakraComponent<React.ForwardRefExoticComponent<React.PropsWithChildren<LinkProps> & React.RefAttributes<HTMLDivElement & HTMLAnchorElement>>, React.PropsWithChildren<LinkProps>>;
|
|
33
25
|
export default Link;
|
|
@@ -1,14 +1,12 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
3
|
+
export declare const listVariantsArray: readonly ["ol", "ul", "dl"];
|
|
4
|
+
export type ListVariants = typeof listVariantsArray[number];
|
|
5
5
|
export interface DescriptionProps {
|
|
6
6
|
term: string;
|
|
7
7
|
description: string | JSX.Element;
|
|
8
8
|
}
|
|
9
|
-
export interface ListProps {
|
|
10
|
-
/** ClassName you can add in addition to 'list' */
|
|
11
|
-
className?: string;
|
|
9
|
+
export interface ListProps extends Omit<BoxProps, "title"> {
|
|
12
10
|
/** ID that other components can cross reference for accessibility purposes */
|
|
13
11
|
id?: string;
|
|
14
12
|
/** Display the list in a row. */
|
|
@@ -29,7 +27,7 @@ export interface ListProps {
|
|
|
29
27
|
* to Description Lists and will render above the list. */
|
|
30
28
|
title?: string | JSX.Element;
|
|
31
29
|
/** The type of list: "ol", "ul", or "dl". "ul" by default. */
|
|
32
|
-
|
|
30
|
+
variant: ListVariants;
|
|
33
31
|
}
|
|
34
32
|
/**
|
|
35
33
|
* A component that renders list item `li` elements or description item `dt`
|
|
@@ -41,5 +39,9 @@ export declare const List: ChakraComponent<React.ForwardRefExoticComponent<React
|
|
|
41
39
|
* Checks for `li` elements and consoles a warning if the
|
|
42
40
|
* children are different HTML elements.
|
|
43
41
|
*/
|
|
44
|
-
export declare const checkListChildrenError: (children
|
|
42
|
+
export declare const checkListChildrenError: ({ children, variant, componentName, }: {
|
|
43
|
+
children: React.ReactNode;
|
|
44
|
+
variant?: ListVariants;
|
|
45
|
+
componentName?: string;
|
|
46
|
+
}) => void;
|
|
45
47
|
export default List;
|
|
@@ -1,12 +1,10 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { DimensionTypes } from "../../helpers/types";
|
|
4
4
|
import { logoNamesArray, logoSizesArray } from "./logoVariables";
|
|
5
5
|
export type LogoNames = typeof logoNamesArray[number];
|
|
6
6
|
export type LogoSizes = typeof logoSizesArray[number];
|
|
7
|
-
export interface LogoProps {
|
|
8
|
-
/** Optional className that will be added to the parent element */
|
|
9
|
-
className?: string;
|
|
7
|
+
export interface LogoProps extends Pick<BoxProps, "className" | keyof ChakraProps> {
|
|
10
8
|
/** Logos designated as decorative will be ignored by screenreaders. False
|
|
11
9
|
* by default. */
|
|
12
10
|
decorative?: boolean;
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import { IconNames } from "../Icons/Icon";
|
|
3
3
|
import React from "react";
|
|
4
4
|
import { SectionTypes } from "../../helpers/types";
|
|
5
|
-
export interface MenuProps {
|
|
6
|
-
/** Optional CSS class name that will be added to the component's parent element. */
|
|
7
|
-
className?: string;
|
|
5
|
+
export interface MenuProps extends BoxProps {
|
|
8
6
|
/** Optional ID string that other components can cross reference for accessibility purposes. */
|
|
9
7
|
id?: string;
|
|
10
8
|
/** Optional string used to identify and highlight an item when the menu opens. The value should
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export interface BaseProps {
|
|
3
|
+
export interface BaseProps extends Omit<BoxProps, "scrollBehavior"> {
|
|
4
4
|
/** The content to display in the modal body. */
|
|
5
5
|
bodyContent?: string | JSX.Element;
|
|
6
6
|
/** The text to display in the modal heading, can be a string or JSX Element. */
|
|
@@ -16,7 +16,7 @@ export interface ConfirmationModalProps {
|
|
|
16
16
|
onCancel: () => void;
|
|
17
17
|
onConfirm: () => void;
|
|
18
18
|
/** The `Modal` variant to render. */
|
|
19
|
-
|
|
19
|
+
variant: "confirmation";
|
|
20
20
|
/** The label for the close button. This prop is used for the
|
|
21
21
|
* "cancel" button in the confirmation variant. */
|
|
22
22
|
closeButtonLabel?: string;
|
|
@@ -27,7 +27,7 @@ export interface DefaultModalProps {
|
|
|
27
27
|
closeButtonLabel?: string;
|
|
28
28
|
onClose?: () => void;
|
|
29
29
|
/** The `Modal` variant to render. */
|
|
30
|
-
|
|
30
|
+
variant: "default";
|
|
31
31
|
/** The label for the confirm button. This prop is not used
|
|
32
32
|
* in the default variant. */
|
|
33
33
|
confirmButtonLabel?: never;
|
|
@@ -45,12 +45,13 @@ export interface ModalProps {
|
|
|
45
45
|
* `bodyContent`, `headingText`, `isOpen`, and the modal type props. */
|
|
46
46
|
modalProps: BaseModalProps;
|
|
47
47
|
}
|
|
48
|
-
export declare function
|
|
48
|
+
export declare function isDefaultVariant(variant: BaseModalProps["variant"]): variant is "default";
|
|
49
49
|
export declare const BaseModal: ChakraComponent<React.FunctionComponent<BaseModalProps>, BaseModalProps>;
|
|
50
50
|
/**
|
|
51
51
|
* The `ModalTrigger` component renders a button that you click to open the
|
|
52
52
|
* internal `Modal` component. Note that props to update the internal `Modal`
|
|
53
|
-
* component are passed through to the `modalProps` prop.
|
|
53
|
+
* component are passed through to the `modalProps` prop. In addition to the
|
|
54
|
+
* props below, you may pass `modalProps` any Chakra `Box` props.
|
|
54
55
|
*/
|
|
55
56
|
export declare const ModalTrigger: ChakraComponent<React.ForwardRefExoticComponent<React.PropsWithChildren<ModalProps> & React.RefAttributes<HTMLButtonElement>>, React.PropsWithChildren<ModalProps>>;
|
|
56
57
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
export interface MultiSelectItem {
|
|
4
4
|
id: string;
|
|
@@ -16,7 +16,7 @@ export interface SelectedItems {
|
|
|
16
16
|
items: string[];
|
|
17
17
|
};
|
|
18
18
|
}
|
|
19
|
-
export interface MultiSelectProps {
|
|
19
|
+
export interface MultiSelectProps extends BoxProps {
|
|
20
20
|
/** The button text rendered within the MultiSelect. */
|
|
21
21
|
buttonText: string;
|
|
22
22
|
/** Determines whether the component will toggle to the closed state
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { LayoutTypes } from "../../helpers/types";
|
|
4
4
|
import { MultiSelectWidths } from "../MultiSelect/MultiSelect";
|
|
5
|
-
export interface MultiSelectGroupProps {
|
|
6
|
-
/** Additional className to use. */
|
|
7
|
-
className?: string;
|
|
5
|
+
export interface MultiSelectGroupProps extends BoxProps {
|
|
8
6
|
/** The id of the MultiSelectGroup. */
|
|
9
7
|
id: string;
|
|
10
8
|
/** The label text rendered within the MultiSelectGroup. */
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export interface NewsletterSignupProps {
|
|
4
|
-
/** Additional class name to add. */
|
|
5
|
-
className?: string;
|
|
3
|
+
export interface NewsletterSignupProps extends Omit<BoxProps, "title"> {
|
|
6
4
|
/** Text displayed next to the confirmation icon after a successful email submission */
|
|
7
5
|
confirmationHeading: string;
|
|
8
6
|
/** Detail text for the confirmation view */
|
|
@@ -20,8 +18,7 @@ export interface NewsletterSignupProps {
|
|
|
20
18
|
id?: string;
|
|
21
19
|
/** Toggles the invalid state for the email field. */
|
|
22
20
|
isInvalidEmail?: boolean;
|
|
23
|
-
/** Value to determine the section color highlight.
|
|
24
|
-
*/
|
|
21
|
+
/** Value to determine the section color highlight. */
|
|
25
22
|
highlightColor?: HighlightColorTypes;
|
|
26
23
|
/** A handler function that will be called when the form is submitted. */
|
|
27
24
|
onSubmit: (event: React.FormEvent<any>) => void;
|
|
@@ -42,8 +39,8 @@ export interface NewsletterSignupProps {
|
|
|
42
39
|
/** Used to specify what is displayed in the component form/feedback area. */
|
|
43
40
|
view?: NewsletterSignupViewType;
|
|
44
41
|
}
|
|
45
|
-
export declare const
|
|
46
|
-
export type HighlightColorTypes = typeof
|
|
42
|
+
export declare const newsletterHighlightColorsArray: string[];
|
|
43
|
+
export type HighlightColorTypes = typeof newsletterHighlightColorsArray[number];
|
|
47
44
|
export type NewsletterSignupViewType = "form" | "submitting" | "confirmation" | "error";
|
|
48
45
|
/**
|
|
49
46
|
* The NewsletterSignup component provides a way for patrons to register for an
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
3
|
+
export declare const notificationVariantsArray: readonly ["standard", "announcement", "warning"];
|
|
4
|
+
export type NotificationVariants = typeof notificationVariantsArray[number];
|
|
5
5
|
interface BaseProps {
|
|
6
6
|
/** Optional prop to control text alignment in `NotificationContent` */
|
|
7
7
|
alignText?: boolean;
|
|
@@ -18,25 +18,19 @@ interface BaseProps {
|
|
|
18
18
|
notificationHeading?: string | JSX.Element;
|
|
19
19
|
/** Optional prop to control the coloring of the `Notification` text and the
|
|
20
20
|
* visibility of an applicable icon. */
|
|
21
|
-
|
|
21
|
+
variant?: NotificationVariants;
|
|
22
22
|
/** Prop to display the `Notification` icon. Defaults to `true`. */
|
|
23
23
|
showIcon?: boolean;
|
|
24
24
|
}
|
|
25
25
|
type NotificationHeadingProps = Omit<BasePropsWithoutAlignText, "showIcon">;
|
|
26
26
|
type NotificationContentProps = Omit<BaseProps, "icon">;
|
|
27
27
|
type BasePropsWithoutAlignText = Omit<BaseProps, "alignText">;
|
|
28
|
-
export interface NotificationProps extends BasePropsWithoutAlignText {
|
|
29
|
-
/** Label used to describe the `Notification`'s aside HTML element. */
|
|
30
|
-
ariaLabel?: string;
|
|
31
|
-
/** Additional `className` to add. */
|
|
32
|
-
className?: string;
|
|
28
|
+
export interface NotificationProps extends BasePropsWithoutAlignText, BoxProps {
|
|
33
29
|
/** Optional prop to control whether a `Notification` can be dismissed
|
|
34
30
|
* (closed) by a user. */
|
|
35
31
|
dismissible?: boolean;
|
|
36
32
|
/** Optional custom `Icon` that will override the default `Icon`. */
|
|
37
33
|
icon?: JSX.Element;
|
|
38
|
-
/** Optional prop to control the margin around the `Notification` component. */
|
|
39
|
-
noMargin?: boolean;
|
|
40
34
|
/** Content to be rendered in a `NotificationContent` component. */
|
|
41
35
|
notificationContent: string | JSX.Element;
|
|
42
36
|
}
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export interface PaginationProps {
|
|
4
|
-
/** Additional className. */
|
|
5
|
-
className?: string;
|
|
3
|
+
export interface PaginationProps extends BoxProps {
|
|
6
4
|
/** The currentPage can be used to programatically force the selected page to change
|
|
7
5
|
* without the user explicitly requesting it – for example, if the user should be
|
|
8
6
|
* brought back to the first page of a set of results after a new search. */
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
export declare const progressIndicatorSizesArray: readonly ["default", "small"];
|
|
4
4
|
export declare const progressIndicatorTypesArray: readonly ["circular", "linear"];
|
|
@@ -6,9 +6,7 @@ export declare const progressIndicatorLabelPlacementsArray: readonly ["bottom",
|
|
|
6
6
|
export type ProgressIndicatorSizes = typeof progressIndicatorSizesArray[number];
|
|
7
7
|
export type ProgressIndicatorTypes = typeof progressIndicatorTypesArray[number];
|
|
8
8
|
export type ProgressIndicatorLabelPlacements = typeof progressIndicatorLabelPlacementsArray[number];
|
|
9
|
-
interface BaseProgressIndicatorProps {
|
|
10
|
-
/** The darkMode prop is deprecated and should no longer be used. */
|
|
11
|
-
darkMode?: boolean;
|
|
9
|
+
interface BaseProgressIndicatorProps extends BoxProps {
|
|
12
10
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
13
11
|
id: string;
|
|
14
12
|
/** Whether the `ProgressIndicator` should be linear or circular. */
|
|
@@ -1,9 +1,7 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
2
|
-
import React from "react";
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
|
+
import React, { InputHTMLAttributes } from "react";
|
|
3
3
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
4
|
-
export interface RadioProps {
|
|
5
|
-
/** Additional class name. */
|
|
6
|
-
className?: string;
|
|
4
|
+
export interface RadioProps extends Pick<BoxProps, keyof ChakraProps>, Omit<InputHTMLAttributes<HTMLInputElement>, "color" | "height" | "width"> {
|
|
7
5
|
/** Optional string to populate the HelperErrorText for the standard state. */
|
|
8
6
|
helperText?: HelperErrorTextType;
|
|
9
7
|
/** ID that other components can cross reference for accessibility purposes */
|
|
@@ -28,10 +26,6 @@ export interface RadioProps {
|
|
|
28
26
|
* `<label>` element if `showlabel` is true, or an "aria-label" if `showLabel`
|
|
29
27
|
* is false. */
|
|
30
28
|
labelText: string | JSX.Element;
|
|
31
|
-
/** Used to reference the input element in forms. */
|
|
32
|
-
name?: string;
|
|
33
|
-
/** Should be passed along with `isChecked` for controlled components. */
|
|
34
|
-
onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
|
|
35
29
|
/** Offers the ability to hide the helper/invalid text. */
|
|
36
30
|
showHelperInvalidText?: boolean;
|
|
37
31
|
/** Offers the ability to show the radio's label onscreen or hide it. Refer
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
4
4
|
import { LayoutTypes } from "../../helpers/types";
|
|
5
|
-
export interface RadioGroupProps {
|
|
6
|
-
/** Additional class name. */
|
|
7
|
-
className?: string;
|
|
5
|
+
export interface RadioGroupProps extends Omit<BoxProps, "onChange"> {
|
|
8
6
|
/** Populates the initial value of the input */
|
|
9
7
|
defaultValue?: string;
|
|
10
8
|
/** Optional string to populate the HelperErrorText for standard state */
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
2
|
-
import React from "react";
|
|
1
|
+
import { ChakraComponent, ChakraProps, BoxProps } from "@chakra-ui/react";
|
|
2
|
+
import React, { FormHTMLAttributes } from "react";
|
|
3
3
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
4
4
|
import { SelectProps as InitialSelectProps } from "../Select/Select";
|
|
5
5
|
import { InputProps as InitialInputProps } from "../TextInput/TextInput";
|
|
@@ -11,13 +11,9 @@ export type SelectProps = Partial<Pick<InitialSelectProps, "id" | "labelText" |
|
|
|
11
11
|
optionsData: SelectOptionsProps[];
|
|
12
12
|
};
|
|
13
13
|
export type TextInputProps = Pick<InitialInputProps, "labelText" | "name"> & Partial<Pick<InitialInputProps, "defaultValue" | "id" | "isClearable" | "isClearableCallback" | "max" | "maxLength" | "min" | "onChange" | "pattern" | "placeholder" | "value">>;
|
|
14
|
-
export interface SearchBarProps {
|
|
15
|
-
/** Adds 'action' property to the `form` element. */
|
|
16
|
-
action?: string;
|
|
14
|
+
export interface SearchBarProps extends Pick<BoxProps, keyof ChakraProps>, Omit<FormHTMLAttributes<HTMLFormElement>, "color"> {
|
|
17
15
|
/** The onClick callback function for the `Button` component. */
|
|
18
16
|
buttonOnClick?: (event: React.MouseEvent | React.KeyboardEvent) => void;
|
|
19
|
-
/** A class name for the `form` element. */
|
|
20
|
-
className?: string;
|
|
21
17
|
/** Optional string for the SearchBar's description above the component. */
|
|
22
18
|
descriptionText?: string;
|
|
23
19
|
/** Optional string value used to set the text for a `Heading` component, or
|
|
@@ -39,13 +35,9 @@ export interface SearchBarProps {
|
|
|
39
35
|
isRequired?: boolean;
|
|
40
36
|
/** Populates the `aria-label` attribute on the form element. */
|
|
41
37
|
labelText: string;
|
|
42
|
-
/** Adds 'method' property to the `form` element. */
|
|
43
|
-
method?: string;
|
|
44
38
|
/** Sets the `Button` variant type to `noBrand` when true;
|
|
45
39
|
* false by default which sets the type to `primary`. */
|
|
46
40
|
noBrandButtonType?: boolean;
|
|
47
|
-
/** Handler function when the form is submitted. */
|
|
48
|
-
onSubmit: (event: React.FormEvent) => void;
|
|
49
41
|
/** Required props to render a `Select` element. */
|
|
50
42
|
selectProps?: SelectProps | undefined;
|
|
51
43
|
/** Custom input element to render instead of a `TextInput` element. */
|
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
4
|
-
export declare const
|
|
5
|
-
export declare const labelPositionsArray:
|
|
6
|
-
export type
|
|
4
|
+
export declare const selectVariantsArray: readonly ["default", "searchbar"];
|
|
5
|
+
export declare const labelPositionsArray: readonly ["default", "inline"];
|
|
6
|
+
export type SelectVariants = typeof selectVariantsArray[number];
|
|
7
7
|
export type LabelPositions = typeof labelPositionsArray[number];
|
|
8
|
-
export interface SelectProps extends React.SelectHTMLAttributes<HTMLSelectElement> {
|
|
9
|
-
/** A class name for the `div` parent element. */
|
|
10
|
-
className?: string;
|
|
8
|
+
export interface SelectProps extends Pick<BoxProps, keyof ChakraProps>, Omit<React.SelectHTMLAttributes<HTMLSelectElement>, "color"> {
|
|
11
9
|
/** The initial value of an uncontrolled component */
|
|
12
10
|
defaultValue?: string;
|
|
13
11
|
/** Optional string to populate the `HelperErrorText` for the standard state. */
|
|
@@ -31,18 +29,13 @@ export interface SelectProps extends React.SelectHTMLAttributes<HTMLSelectElemen
|
|
|
31
29
|
* populates an `aria-label` attribute on the select input if `showLabel` is
|
|
32
30
|
* set to `false`. */
|
|
33
31
|
labelText: string;
|
|
34
|
-
/** Used to reference the select element in forms. */
|
|
35
|
-
name: string;
|
|
36
|
-
/** The callback function to get the selected value.
|
|
37
|
-
* Should be passed along with `value` for controlled components. */
|
|
38
|
-
onChange?: (event: React.FormEvent) => void;
|
|
39
32
|
/** Placeholder text in the select element. */
|
|
40
33
|
placeholder?: string;
|
|
41
34
|
/** Allows the '(required)' text to be changed for language purposes
|
|
42
35
|
* Note: Parenthesis will be added automatically by the component */
|
|
43
36
|
requiredLabelText?: string;
|
|
44
37
|
/** The variant to display. */
|
|
45
|
-
|
|
38
|
+
variant?: SelectVariants;
|
|
46
39
|
/** Offers the ability to hide the helper/invalid text. */
|
|
47
40
|
showHelperInvalidText?: boolean;
|
|
48
41
|
/** Offers the ability to show the select's label onscreen or hide it. Refer
|
|
@@ -51,9 +44,6 @@ export interface SelectProps extends React.SelectHTMLAttributes<HTMLSelectElemen
|
|
|
51
44
|
/** Whether or not to display the "(required)" text in the label text.
|
|
52
45
|
* True by default. */
|
|
53
46
|
showRequiredLabel?: boolean;
|
|
54
|
-
/** The value of the selected option.
|
|
55
|
-
* Should be passed along with `onChange` for controlled components. */
|
|
56
|
-
value?: string;
|
|
57
47
|
}
|
|
58
48
|
/**
|
|
59
49
|
* Component that renders Chakra's `Select` component along with an accessible
|
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { LayoutTypes } from "../../helpers/types";
|
|
4
4
|
export declare const skeletonLoaderImageRatiosArray: readonly ["landscape", "portrait", "square"];
|
|
5
5
|
export type SkeletonLoaderImageRatios = typeof skeletonLoaderImageRatiosArray[number];
|
|
6
|
-
export interface SkeletonLoaderProps {
|
|
7
|
-
/** Additional class name for the Skeleton component. */
|
|
8
|
-
className?: string;
|
|
6
|
+
export interface SkeletonLoaderProps extends BoxProps {
|
|
9
7
|
/** Optional numeric value to control the number of lines for content
|
|
10
8
|
* placeholder; default value is `3`. */
|
|
11
9
|
contentSize?: number;
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
1
|
+
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export interface SkipNavigationProps {
|
|
4
|
-
/** Additional CSS class name to render in the `nav` element. */
|
|
5
|
-
className?: string;
|
|
3
|
+
export interface SkipNavigationProps extends BoxProps {
|
|
6
4
|
/** ID that other components can cross reference for accessibility purposes */
|
|
7
5
|
id?: string;
|
|
8
6
|
/** The anchor target for the main skip link. The default is "#mainContent". */
|
|
@@ -1,9 +1,7 @@
|
|
|
1
|
-
import { ChakraComponent } from "@chakra-ui/react";
|
|
2
|
-
import React from "react";
|
|
1
|
+
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
|
+
import React, { InputHTMLAttributes } from "react";
|
|
3
3
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
4
|
-
export interface SliderProps {
|
|
5
|
-
/** Additional class name for the Slider component. */
|
|
6
|
-
className?: string;
|
|
4
|
+
export interface SliderProps extends Pick<BoxProps, keyof ChakraProps>, Omit<InputHTMLAttributes<HTMLInputElement>, "color" | "defaultValue" | "height" | "onChange" | "value" | "width"> {
|
|
7
5
|
/** The initial value for the single `Slider` or an array of two number
|
|
8
6
|
* values for the `isRangeSlider` case. */
|
|
9
7
|
defaultValue?: number | number[];
|