@nypl/design-system-react-components 0.25.12 → 0.26.1
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/CHANGELOG.md +131 -1
- package/README.md +10 -10
- package/dist/components/Accordion/Accordion.d.ts +6 -4
- package/dist/components/Accordion/AccordionTypes.d.ts +5 -0
- package/dist/components/Breadcrumbs/Breadcrumbs.d.ts +4 -4
- package/dist/components/Breadcrumbs/BreadcrumbsTypes.d.ts +1 -1
- package/dist/components/Button/Button.d.ts +2 -2
- package/dist/components/Card/Card.d.ts +22 -29
- package/dist/components/Checkbox/Checkbox.d.ts +3 -3
- package/dist/components/CheckboxGroup/CheckboxGroup.d.ts +9 -6
- package/dist/components/ComponentWrapper/ComponentWrapper.d.ts +1 -1
- package/dist/components/DatePicker/DatePicker.d.ts +5 -6
- package/dist/components/Fieldset/Fieldset.d.ts +5 -6
- package/dist/components/Form/Form.d.ts +6 -6
- package/dist/components/Grid/GridTypes.d.ts +7 -7
- package/dist/components/Grid/SimpleGrid.d.ts +1 -1
- package/dist/components/Heading/Heading.d.ts +5 -5
- package/dist/components/Heading/HeadingTypes.d.ts +1 -1
- package/dist/components/HelperErrorText/HelperErrorText.d.ts +9 -8
- package/dist/components/Hero/Hero.d.ts +9 -5
- package/dist/components/HorizontalRule/HorizontalRule.d.ts +2 -10
- package/dist/components/Icons/Icon.d.ts +2 -1
- package/dist/components/Icons/IconTypes.d.ts +1 -0
- package/dist/components/Image/Image.d.ts +27 -9
- package/dist/components/Image/ImageTypes.d.ts +4 -4
- package/dist/components/Label/Label.d.ts +7 -4
- package/dist/components/Link/Link.d.ts +1 -1
- package/dist/components/List/List.d.ts +11 -11
- package/dist/components/List/ListTypes.d.ts +1 -1
- package/dist/components/Logo/Logo.d.ts +2 -1
- package/dist/components/Logo/LogoSvgs.d.ts +2 -0
- package/dist/components/Logo/LogoTypes.d.ts +4 -2
- package/dist/components/Notification/Notification.d.ts +7 -7
- package/dist/components/Pagination/Pagination.d.ts +2 -2
- package/dist/components/ProgressIndicator/ProgressIndicator.d.ts +3 -3
- package/dist/components/Radio/Radio.d.ts +5 -7
- package/dist/components/RadioGroup/RadioGroup.d.ts +16 -8
- package/dist/components/SearchBar/SearchBar.d.ts +4 -4
- package/dist/components/Select/Select.d.ts +12 -8
- package/dist/components/Select/SelectTypes.d.ts +4 -0
- package/dist/components/SkeletonLoader/SkeletonLoader.d.ts +8 -6
- package/dist/components/SkeletonLoader/SkeletonLoaderTypes.d.ts +0 -4
- package/dist/components/Slider/Slider.d.ts +6 -4
- package/dist/components/StatusBadge/StatusBadge.d.ts +5 -1
- package/dist/components/StructuredContent/StructuredContent.d.ts +10 -23
- package/dist/components/Table/Table.d.ts +1 -1
- package/dist/components/Tabs/Tabs.d.ts +7 -6
- package/dist/components/Template/Template.d.ts +17 -8
- package/dist/components/Text/Text.d.ts +4 -4
- package/dist/components/Text/TextTypes.d.ts +1 -1
- package/dist/components/TextInput/TextInput.d.ts +7 -7
- package/dist/components/Toggle/Toggle.d.ts +8 -10
- package/dist/components/Toggle/{ToggleSizes.d.ts → ToggleTypes.d.ts} +1 -1
- package/dist/components/VideoPlayer/VideoPlayer.d.ts +2 -1
- package/dist/design-system-react-components.cjs.development.js +2075 -1468
- package/dist/design-system-react-components.cjs.development.js.map +1 -1
- package/dist/design-system-react-components.cjs.production.min.js +1 -1
- package/dist/design-system-react-components.cjs.production.min.js.map +1 -1
- package/dist/design-system-react-components.esm.js +2086 -1483
- package/dist/design-system-react-components.esm.js.map +1 -1
- package/dist/helpers/enums.d.ts +4 -0
- package/dist/hooks/useCarouselStyles.d.ts +3 -2
- package/dist/hooks/useNYPLTheme.d.ts +12 -0
- package/dist/index.d.ts +11 -9
- package/dist/styles.css +1 -1
- package/dist/theme/components/accordion.d.ts +7 -12
- package/dist/theme/components/breadcrumb.d.ts +3 -0
- package/dist/theme/components/button.d.ts +10 -2
- package/dist/theme/components/card.d.ts +44 -24
- package/dist/theme/components/checkbox.d.ts +6 -4
- package/dist/theme/components/checkboxGroup.d.ts +4 -2
- package/dist/theme/components/componentWrapper.d.ts +2 -2
- package/dist/theme/components/customTable.d.ts +84 -1
- package/dist/theme/components/fieldset.d.ts +4 -14
- package/dist/theme/components/global.d.ts +25 -18
- package/dist/theme/components/heading.d.ts +53 -0
- package/dist/theme/components/helperErrorText.d.ts +1 -0
- package/dist/theme/components/hero.d.ts +21 -15
- package/dist/theme/components/image.d.ts +1 -1
- package/dist/theme/components/label.d.ts +9 -10
- package/dist/theme/components/list.d.ts +99 -9
- package/dist/theme/components/notification.d.ts +4 -4
- package/dist/theme/components/pagination.d.ts +2 -5
- package/dist/theme/components/radio.d.ts +7 -4
- package/dist/theme/components/radioGroup.d.ts +4 -2
- package/dist/theme/components/select.d.ts +37 -5
- package/dist/theme/components/skeletonLoader.d.ts +2 -2
- package/dist/theme/components/slider.d.ts +6 -3
- package/dist/theme/components/structuredContent.d.ts +197 -0
- package/dist/theme/components/textInput.d.ts +18 -6
- package/dist/theme/components/toggle.d.ts +20 -5
- package/dist/theme/foundations/global.d.ts +2 -0
- package/dist/theme/foundations/radii.d.ts +1 -0
- package/dist/theme/foundations/spacing.d.ts +46 -43
- package/package.json +5 -6
- package/src/components/AccessibilityGuide/SkipNavigation.stories.mdx +34 -0
- package/src/components/Accordion/Accordion.stories.mdx +150 -66
- package/src/components/Accordion/Accordion.test.tsx +65 -17
- package/src/components/Accordion/Accordion.tsx +61 -27
- package/src/components/Accordion/AccordionTypes.tsx +5 -0
- package/src/components/Accordion/__snapshots__/Accordion.test.tsx.snap +505 -14
- package/src/components/Autosuggest/Autosuggest.stories.mdx +4 -3
- package/src/components/Breadcrumbs/Breadcrumbs.stories.mdx +37 -19
- package/src/components/Breadcrumbs/Breadcrumbs.test.tsx +57 -36
- package/src/components/Breadcrumbs/Breadcrumbs.tsx +14 -13
- package/src/components/Breadcrumbs/BreadcrumbsTypes.tsx +1 -1
- package/src/components/Breadcrumbs/__snapshots__/Breadcrumbs.test.tsx.snap +211 -12
- package/src/components/Button/Button.stories.mdx +87 -23
- package/src/components/Button/Button.test.tsx +25 -0
- package/src/components/Button/Button.tsx +18 -7
- package/src/components/Button/__snapshots__/Button.test.tsx.snap +27 -7
- package/src/components/Card/Card.stories.mdx +493 -329
- package/src/components/Card/Card.test.tsx +138 -18
- package/src/components/Card/Card.tsx +151 -85
- package/src/components/Card/__snapshots__/Card.test.tsx.snap +221 -101
- package/src/components/Chakra/Center.stories.mdx +2 -2
- package/src/components/Chakra/Grid.stories.mdx +4 -4
- package/src/components/Checkbox/Checkbox.stories.mdx +73 -9
- package/src/components/Checkbox/Checkbox.test.tsx +89 -10
- package/src/components/Checkbox/Checkbox.tsx +26 -16
- package/src/components/Checkbox/__snapshots__/Checkbox.test.tsx.snap +209 -6
- package/src/components/CheckboxGroup/CheckboxGroup.stories.mdx +135 -23
- package/src/components/CheckboxGroup/CheckboxGroup.test.tsx +216 -90
- package/src/components/CheckboxGroup/CheckboxGroup.tsx +39 -26
- package/src/components/CheckboxGroup/__snapshots__/CheckboxGroup.test.tsx.snap +493 -89
- package/src/components/ComponentWrapper/ComponentWrapper.test.tsx +12 -0
- package/src/components/ComponentWrapper/ComponentWrapper.tsx +39 -41
- package/src/components/ComponentWrapper/__snapshots__/ComponentWrapper.test.tsx.snap +47 -34
- package/src/components/DatePicker/DatePicker.stories.mdx +63 -27
- package/src/components/DatePicker/DatePicker.test.tsx +94 -15
- package/src/components/DatePicker/DatePicker.tsx +67 -58
- package/src/components/DatePicker/_DatePicker.scss +71 -13
- package/src/components/DatePicker/__snapshots__/DatePicker.test.tsx.snap +250 -206
- package/src/components/Fieldset/Fieldset.stories.mdx +33 -3
- package/src/components/Fieldset/Fieldset.test.tsx +58 -28
- package/src/components/Fieldset/Fieldset.tsx +35 -30
- package/src/components/Fieldset/__snapshots__/Fieldset.test.tsx.snap +40 -19
- package/src/components/Form/Form.stories.mdx +118 -47
- package/src/components/Form/Form.test.tsx +59 -16
- package/src/components/Form/Form.tsx +89 -65
- package/src/components/Form/__snapshots__/Form.test.tsx.snap +83 -5
- package/src/components/Grid/GridTypes.tsx +7 -7
- package/src/components/Grid/SimpleGrid.stories.mdx +87 -41
- package/src/components/Grid/SimpleGrid.test.tsx +24 -9
- package/src/components/Grid/SimpleGrid.tsx +29 -20
- package/src/components/Grid/__snapshots__/SimpleGrid.test.tsx.snap +16 -1
- package/src/components/Heading/Heading.stories.mdx +56 -25
- package/src/components/Heading/Heading.test.tsx +17 -7
- package/src/components/Heading/Heading.tsx +60 -58
- package/src/components/Heading/HeadingTypes.tsx +1 -1
- package/src/components/Heading/__snapshots__/Heading.test.tsx.snap +27 -8
- package/src/components/HelperErrorText/HelperErrorText.stories.mdx +64 -42
- package/src/components/HelperErrorText/HelperErrorText.test.tsx +15 -0
- package/src/components/HelperErrorText/HelperErrorText.tsx +40 -35
- package/src/components/HelperErrorText/__snapshots__/HelperErrorText.test.tsx.snap +35 -4
- package/src/components/Hero/Hero.stories.mdx +143 -113
- package/src/components/Hero/Hero.test.tsx +146 -58
- package/src/components/Hero/Hero.tsx +144 -112
- package/src/components/Hero/__snapshots__/Hero.test.tsx.snap +89 -17
- package/src/components/HorizontalRule/HorizontalRule.stories.mdx +26 -4
- package/src/components/HorizontalRule/HorizontalRule.test.tsx +9 -17
- package/src/components/HorizontalRule/HorizontalRule.tsx +9 -25
- package/src/components/HorizontalRule/__snapshots__/HorizontalRule.test.tsx.snap +18 -5
- package/src/components/Icons/Icon.stories.mdx +80 -23
- package/src/components/Icons/Icon.test.tsx +51 -2
- package/src/components/Icons/Icon.tsx +93 -71
- package/src/components/Icons/IconTypes.tsx +1 -0
- package/src/components/Icons/__snapshots__/Icon.test.tsx.snap +129 -0
- package/src/components/Image/Image.stories.mdx +160 -71
- package/src/components/Image/Image.test.tsx +40 -48
- package/src/components/Image/Image.tsx +80 -48
- package/src/components/Image/ImageTypes.ts +4 -4
- package/src/components/Image/__snapshots__/Image.test.tsx.snap +84 -21
- package/src/components/Label/Label.stories.mdx +42 -20
- package/src/components/Label/Label.test.tsx +42 -17
- package/src/components/Label/Label.tsx +22 -13
- package/src/components/Label/__snapshots__/Label.test.tsx.snap +19 -15
- package/src/components/Link/Link.stories.mdx +25 -1
- package/src/components/Link/Link.test.tsx +21 -0
- package/src/components/Link/Link.tsx +16 -9
- package/src/components/Link/__snapshots__/Link.test.tsx.snap +37 -11
- package/src/components/List/List.stories.mdx +75 -40
- package/src/components/List/List.test.tsx +73 -22
- package/src/components/List/List.tsx +44 -28
- package/src/components/List/ListTypes.tsx +1 -1
- package/src/components/List/__snapshots__/List.test.tsx.snap +110 -8
- package/src/components/Logo/Logo.stories.mdx +40 -16
- package/src/components/Logo/Logo.test.tsx +29 -2
- package/src/components/Logo/Logo.tsx +28 -11
- package/src/components/Logo/LogoSvgs.tsx +4 -0
- package/src/components/Logo/LogoTypes.tsx +3 -1
- package/src/components/Logo/__snapshots__/Logo.test.tsx.snap +73 -2
- package/src/components/Modal/Modal.stories.mdx +13 -0
- package/src/components/Notification/Notification.stories.mdx +29 -5
- package/src/components/Notification/Notification.test.tsx +23 -0
- package/src/components/Notification/Notification.tsx +53 -51
- package/src/components/Notification/__snapshots__/Notification.test.tsx.snap +158 -29
- package/src/components/Pagination/Pagination.stories.mdx +27 -6
- package/src/components/Pagination/Pagination.test.tsx +55 -2
- package/src/components/Pagination/Pagination.tsx +12 -9
- package/src/components/Pagination/__snapshots__/Pagination.test.tsx.snap +244 -27
- package/src/components/Placeholder/Placeholder.tsx +3 -1
- package/src/components/ProgressIndicator/ProgressIndicator.stories.mdx +76 -10
- package/src/components/ProgressIndicator/ProgressIndicator.test.tsx +87 -13
- package/src/components/ProgressIndicator/ProgressIndicator.tsx +20 -10
- package/src/components/ProgressIndicator/__snapshots__/ProgressIndicator.test.tsx.snap +101 -14
- package/src/components/Radio/Radio.stories.mdx +75 -11
- package/src/components/Radio/Radio.test.tsx +83 -9
- package/src/components/Radio/Radio.tsx +70 -62
- package/src/components/Radio/__snapshots__/Radio.test.tsx.snap +163 -5
- package/src/components/RadioGroup/RadioGroup.stories.mdx +293 -94
- package/src/components/RadioGroup/RadioGroup.test.tsx +193 -68
- package/src/components/RadioGroup/RadioGroup.tsx +110 -101
- package/src/components/RadioGroup/__snapshots__/RadioGroup.test.tsx.snap +1258 -902
- package/src/components/SearchBar/SearchBar.stories.mdx +101 -36
- package/src/components/SearchBar/{SearchBar.Test.tsx → SearchBar.test.tsx} +46 -4
- package/src/components/SearchBar/SearchBar.tsx +20 -11
- package/src/components/SearchBar/__snapshots__/SearchBar.test.tsx.snap +1039 -0
- package/src/components/Select/Select.stories.mdx +151 -62
- package/src/components/Select/Select.test.tsx +56 -44
- package/src/components/Select/Select.tsx +125 -104
- package/src/components/Select/SelectTypes.tsx +5 -0
- package/src/components/Select/__snapshots__/Select.test.tsx.snap +749 -409
- package/src/components/SkeletonLoader/SkeletonLoader.stories.mdx +53 -23
- package/src/components/SkeletonLoader/SkeletonLoader.test.tsx +14 -8
- package/src/components/SkeletonLoader/SkeletonLoader.tsx +80 -78
- package/src/components/SkeletonLoader/SkeletonLoaderTypes.tsx +0 -5
- package/src/components/SkeletonLoader/__snapshots__/SkeletonLoader.test.tsx.snap +169 -10
- package/src/components/Slider/Slider.stories.mdx +123 -41
- package/src/components/Slider/Slider.test.tsx +65 -17
- package/src/components/Slider/Slider.tsx +30 -23
- package/src/components/Slider/__snapshots__/Slider.test.tsx.snap +403 -226
- package/src/components/StatusBadge/StatusBadge.stories.mdx +19 -1
- package/src/components/StatusBadge/StatusBadge.test.tsx +19 -1
- package/src/components/StatusBadge/StatusBadge.tsx +25 -20
- package/src/components/StatusBadge/__snapshots__/StatusBadge.test.tsx.snap +22 -3
- package/src/components/StructuredContent/StructuredContent.stories.mdx +229 -61
- package/src/components/StructuredContent/StructuredContent.test.tsx +162 -101
- package/src/components/StructuredContent/StructuredContent.tsx +98 -103
- package/src/components/StructuredContent/__snapshots__/StructuredContent.test.tsx.snap +102 -17
- package/src/components/StyleGuide/Bidirectionality.stories.mdx +5 -5
- package/src/components/StyleGuide/Breakpoints.stories.mdx +6 -6
- package/src/components/StyleGuide/Buttons.stories.mdx +2 -12
- package/src/components/StyleGuide/ColorCard.tsx +4 -4
- package/src/components/StyleGuide/Colors.stories.mdx +1 -2
- package/src/components/StyleGuide/DesignTokens.stories.mdx +56 -26
- package/src/components/StyleGuide/Forms.stories.mdx +27 -12
- package/src/components/StyleGuide/Iconography.stories.mdx +2 -12
- package/src/components/StyleGuide/Spacing.stories.mdx +80 -41
- package/src/components/StyleGuide/Typography.stories.mdx +47 -33
- package/src/components/Table/Table.stories.mdx +38 -11
- package/src/components/Table/Table.test.tsx +16 -1
- package/src/components/Table/Table.tsx +10 -8
- package/src/components/Table/__snapshots__/Table.test.tsx.snap +408 -5
- package/src/components/Tabs/Tabs.stories.mdx +59 -10
- package/src/components/Tabs/Tabs.test.tsx +29 -11
- package/src/components/Tabs/Tabs.tsx +28 -21
- package/src/components/Tabs/__snapshots__/Tabs.test.tsx.snap +394 -5
- package/src/components/Template/Template.stories.mdx +73 -32
- package/src/components/Template/Template.test.tsx +68 -5
- package/src/components/Template/Template.tsx +89 -71
- package/src/components/Template/__snapshots__/Template.test.tsx.snap +195 -22
- package/src/components/Text/Text.stories.mdx +32 -15
- package/src/components/Text/Text.test.tsx +14 -11
- package/src/components/Text/Text.tsx +13 -16
- package/src/components/Text/TextTypes.tsx +1 -1
- package/src/components/Text/__snapshots__/Text.test.tsx.snap +21 -4
- package/src/components/TextInput/TextInput.stories.mdx +73 -27
- package/src/components/TextInput/TextInput.test.tsx +65 -50
- package/src/components/TextInput/TextInput.tsx +123 -115
- package/src/components/TextInput/__snapshots__/TextInput.test.tsx.snap +96 -73
- package/src/components/Toggle/Toggle.stories.mdx +74 -26
- package/src/components/Toggle/Toggle.test.tsx +41 -10
- package/src/components/Toggle/Toggle.tsx +29 -26
- package/src/components/Toggle/{ToggleSizes.tsx → ToggleTypes.tsx} +1 -1
- package/src/components/Toggle/__snapshots__/Toggle.test.tsx.snap +191 -4
- package/src/components/VideoPlayer/VideoPlayer.stories.mdx +52 -4
- package/src/components/VideoPlayer/VideoPlayer.test.tsx +41 -6
- package/src/components/VideoPlayer/VideoPlayer.tsx +134 -120
- package/src/components/VideoPlayer/__snapshots__/VideoPlayer.test.tsx.snap +81 -39
- package/src/docs/Chakra.stories.mdx +50 -9
- package/src/docs/Welcome.stories.mdx +168 -0
- package/src/{components/Card/CardTypes.tsx → helpers/enums.ts} +2 -2
- package/src/hooks/tests/useNYPLTheme.test.tsx +1 -1
- package/src/hooks/useCarouselStyles.stories.mdx +30 -0
- package/src/hooks/useCarouselStyles.ts +3 -2
- package/src/hooks/useNYPLTheme.stories.mdx +101 -0
- package/src/hooks/useNYPLTheme.ts +31 -7
- package/src/hooks/useWindowSize.stories.mdx +23 -0
- package/src/index.ts +11 -15
- package/src/styles/base/_place-holder.scss +1 -1
- package/src/theme/components/accordion.ts +7 -12
- package/src/theme/components/breadcrumb.ts +3 -0
- package/src/theme/components/button.ts +15 -7
- package/src/theme/components/card.ts +56 -36
- package/src/theme/components/checkbox.ts +10 -8
- package/src/theme/components/checkboxGroup.ts +4 -2
- package/src/theme/components/componentWrapper.ts +2 -2
- package/src/theme/components/customTable.ts +39 -31
- package/src/theme/components/fieldset.ts +1 -2
- package/src/theme/components/global.ts +29 -23
- package/src/theme/components/heading.ts +1 -1
- package/src/theme/components/helperErrorText.ts +1 -0
- package/src/theme/components/hero.ts +14 -16
- package/src/theme/components/icon.ts +5 -2
- package/src/theme/components/image.ts +1 -1
- package/src/theme/components/label.ts +4 -3
- package/src/theme/components/list.ts +73 -66
- package/src/theme/components/notification.ts +7 -7
- package/src/theme/components/pagination.ts +2 -5
- package/src/theme/components/progressIndicator.ts +3 -3
- package/src/theme/components/radio.ts +9 -9
- package/src/theme/components/radioGroup.ts +4 -2
- package/src/theme/components/select.ts +35 -16
- package/src/theme/components/skeletonLoader.ts +3 -3
- package/src/theme/components/slider.ts +8 -7
- package/src/theme/components/statusBadge.ts +2 -2
- package/src/theme/components/structuredContent.ts +66 -1
- package/src/theme/components/tabs.ts +2 -2
- package/src/theme/components/template.ts +9 -9
- package/src/theme/components/textInput.ts +13 -12
- package/src/theme/components/toggle.ts +43 -13
- package/src/theme/components/videoPlayer.ts +1 -1
- package/src/theme/foundations/colors.ts +1 -1
- package/src/theme/foundations/radii.ts +1 -0
- package/src/theme/foundations/spacing.ts +70 -22
- package/src/theme/foundations/typography.ts +2 -2
- package/src/utils/componentCategories.ts +28 -21
- package/dist/components/Card/CardTypes.d.ts +0 -4
- package/dist/components/CheckboxGroup/CheckboxGroupLayoutTypes.d.ts +0 -4
- package/dist/components/RadioGroup/RadioGroupLayoutTypes.d.ts +0 -4
- package/dist/components/SearchBar/SearchBar.Test.d.ts +0 -1
- package/dist/helpers/generateUUID.d.ts +0 -1
- package/src/components/CheckboxGroup/CheckboxGroupLayoutTypes.tsx +0 -4
- package/src/components/RadioGroup/RadioGroupLayoutTypes.tsx +0 -4
- package/src/docs/Intro.stories.mdx +0 -53
- package/src/helpers/generateUUID.tsx +0 -5
|
@@ -10,11 +10,12 @@ interface HelperErrorTextProps {
|
|
|
10
10
|
* read the entire DOM element. When false, only changes (additionals or
|
|
11
11
|
* removals) will be read. True by default. */
|
|
12
12
|
ariaAtomic?: boolean;
|
|
13
|
-
/** Aria attribute
|
|
14
|
-
* indicates the priority of the text and when it should be presented to
|
|
15
|
-
* using screen readers; "off" indicates that the content should not be
|
|
16
|
-
* "polite" that it will be announced at the next available time
|
|
17
|
-
* "assertive" that it should be announced immediately.
|
|
13
|
+
/** Aria attribute used in the invalid state to read error text by default.
|
|
14
|
+
* This indicates the priority of the text and when it should be presented to
|
|
15
|
+
* users using screen readers; "off" indicates that the content should not be
|
|
16
|
+
* presented, "polite" that it will be announced at the next available time
|
|
17
|
+
* slot, and "assertive" that it should be announced immediately. This is set
|
|
18
|
+
* to "off" by default and to "polite" by when `isInvalid` is true. */
|
|
18
19
|
ariaLive?: AriaLiveValues;
|
|
19
20
|
/** Additional className to add. */
|
|
20
21
|
className?: string;
|
|
@@ -26,7 +27,7 @@ interface HelperErrorTextProps {
|
|
|
26
27
|
text: HelperErrorTextType;
|
|
27
28
|
}
|
|
28
29
|
/**
|
|
29
|
-
* Helper or
|
|
30
|
+
* Helper or error text for forms components.
|
|
30
31
|
*/
|
|
31
|
-
export
|
|
32
|
-
export
|
|
32
|
+
export declare const HelperErrorText: import("@chakra-ui/react").ChakraComponent<({ additionalStyles, ariaAtomic, ariaLive, className, id, isInvalid, text, ...rest }: HelperErrorTextProps) => JSX.Element, {}>;
|
|
33
|
+
export default HelperErrorText;
|
|
@@ -17,11 +17,14 @@ export interface HeroProps {
|
|
|
17
17
|
heading?: JSX.Element;
|
|
18
18
|
/** Used to control how the `Hero` component will be rendered. */
|
|
19
19
|
heroType?: HeroTypes;
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
|
|
20
|
+
/** Text description of the image; to follow best practices for accessibility,
|
|
21
|
+
* this prop should not be left blank if `imageSrc` is passed. */
|
|
22
|
+
imageAlt?: string;
|
|
23
|
+
/** Optional `imageSrc` used for SECONDARY, FIFTYFIFTY and CAMPAIGN
|
|
24
|
+
* `Hero` types; Note: `imageSrc` can only be used in conjunction with
|
|
25
|
+
* `backgroundImageSrc` for the CAMPAIGN `Hero` type.
|
|
23
26
|
* Note: not all `Hero` variations utilize this prop. */
|
|
24
|
-
|
|
27
|
+
imageSrc?: string;
|
|
25
28
|
/** Optional details area that contains location data.
|
|
26
29
|
* Note: not all `Hero` variations utilize this prop. */
|
|
27
30
|
locationDetails?: JSX.Element;
|
|
@@ -29,4 +32,5 @@ export interface HeroProps {
|
|
|
29
32
|
* underneath the heading element. */
|
|
30
33
|
subHeaderText?: string | JSX.Element;
|
|
31
34
|
}
|
|
32
|
-
export
|
|
35
|
+
export declare const Hero: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<HeroProps>) => JSX.Element, {}>;
|
|
36
|
+
export default Hero;
|
|
@@ -6,14 +6,6 @@ export interface HorizontalRuleProps {
|
|
|
6
6
|
align?: "left" | "right";
|
|
7
7
|
/** ClassName you can add in addition to `horizontal-rule` */
|
|
8
8
|
className?: string;
|
|
9
|
-
/** Optional height value. This value should be entered with the same
|
|
10
|
-
* formatting as a CSS height attribute except for percent values (ex. `2`,
|
|
11
|
-
* `5px`, `1.5rem`). If this prop is omitted or a percent value is used, the
|
|
12
|
-
* horizontal rule will have a default height of 2px. */
|
|
13
|
-
height?: string;
|
|
14
|
-
/** Optional width value. This value should be entered with the same
|
|
15
|
-
* formatting as a CSS width attribute (ex. `50%`, `640px`, `20rem`). If
|
|
16
|
-
* omitted, the horizontal rule will have a default width of "100%". */
|
|
17
|
-
width?: string;
|
|
18
9
|
}
|
|
19
|
-
export
|
|
10
|
+
export declare const HorizontalRule: import("@chakra-ui/react").ChakraComponent<(props: HorizontalRuleProps) => JSX.Element, {}>;
|
|
11
|
+
export default HorizontalRule;
|
|
@@ -32,4 +32,5 @@ export interface IconProps {
|
|
|
32
32
|
/**
|
|
33
33
|
* Renders SVG-based icons.
|
|
34
34
|
*/
|
|
35
|
-
export
|
|
35
|
+
export declare const Icon: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<IconProps>) => JSX.Element, {}>;
|
|
36
|
+
export default Icon;
|
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { ImageRatios, ImageSizes, ImageTypes } from "./ImageTypes";
|
|
3
|
+
export interface ComponentImageProps {
|
|
4
|
+
/** String value used to populate the `alt` attribute of the internal `Image`
|
|
5
|
+
* component's `img` element. @NOTE if an image is used, this value must be passed. */
|
|
6
|
+
alt?: string;
|
|
7
|
+
/** Optional value to control the aspect ratio of the internal `Image` component.
|
|
8
|
+
* Defaults to `ImageRatios.Square`. */
|
|
9
|
+
aspectRatio?: ImageRatios;
|
|
10
|
+
/** Optional value to render as a caption for the internal `Image` component. */
|
|
11
|
+
caption?: string;
|
|
12
|
+
/** Optional DOM element to use instead of the DS `Image` component. */
|
|
13
|
+
component?: JSX.Element;
|
|
14
|
+
/** Optional value to render as a credit for the internal `Image` component. */
|
|
15
|
+
credit?: string;
|
|
16
|
+
/** Optional value to control the size of the internal `Image` component.
|
|
17
|
+
* Defaults to `ImageSizes.Medium`. */
|
|
18
|
+
size?: ImageSizes;
|
|
19
|
+
/** Optional value that contains the path to an image. If omitted, the internal
|
|
20
|
+
* DS `Image` component will not render. */
|
|
21
|
+
src?: string;
|
|
22
|
+
}
|
|
3
23
|
interface ImageWrapperProps {
|
|
4
24
|
/** Optionally pass in additional Chakra-based styles. */
|
|
5
25
|
additionalWrapperStyles?: {
|
|
@@ -8,9 +28,9 @@ interface ImageWrapperProps {
|
|
|
8
28
|
/** ClassName you can add in addition to 'image' */
|
|
9
29
|
className?: string;
|
|
10
30
|
/** Optional value to control the aspect ratio of the cartd image; default value is `square` */
|
|
11
|
-
|
|
31
|
+
aspectRatio?: ImageRatios;
|
|
12
32
|
/** Optional value to control the size of the image */
|
|
13
|
-
|
|
33
|
+
size?: ImageSizes;
|
|
14
34
|
}
|
|
15
35
|
export interface ImageProps extends ImageWrapperProps {
|
|
16
36
|
/** Optionally pass in additional Chakra-based styles only for the figure. */
|
|
@@ -23,18 +43,16 @@ export interface ImageProps extends ImageWrapperProps {
|
|
|
23
43
|
};
|
|
24
44
|
/** Alternate text description of the image */
|
|
25
45
|
alt: string;
|
|
46
|
+
/** Adding will wrap the image in a <figure> */
|
|
47
|
+
caption?: string;
|
|
26
48
|
/** Custom image component */
|
|
27
49
|
component?: JSX.Element | null;
|
|
28
50
|
/** Adding will wrap the image in a <figure> */
|
|
29
|
-
|
|
30
|
-
/** Adding will wrap the image in a <figure> */
|
|
31
|
-
imageCredit?: string;
|
|
32
|
-
/** Optional value to control the size of the image */
|
|
33
|
-
imageSize?: ImageSizes;
|
|
51
|
+
credit?: string;
|
|
34
52
|
/** Optional value for the image type */
|
|
35
53
|
imageType?: ImageTypes;
|
|
36
54
|
/** The src attribute is required, and contains the path to the image you want to embed. */
|
|
37
55
|
src: string;
|
|
38
56
|
}
|
|
39
|
-
export
|
|
40
|
-
export
|
|
57
|
+
export declare const Image: import("@chakra-ui/react").ChakraComponent<(props: ImageProps) => JSX.Element, {}>;
|
|
58
|
+
export default Image;
|
|
@@ -10,11 +10,11 @@ export declare enum ImageRatios {
|
|
|
10
10
|
}
|
|
11
11
|
export declare enum ImageSizes {
|
|
12
12
|
Default = "default",
|
|
13
|
-
|
|
14
|
-
Medium = "medium",
|
|
15
|
-
Small = "small",
|
|
13
|
+
ExtraExtraSmall = "xxsmall",
|
|
16
14
|
ExtraSmall = "xsmall",
|
|
17
|
-
|
|
15
|
+
Small = "small",
|
|
16
|
+
Medium = "medium",
|
|
17
|
+
Large = "large"
|
|
18
18
|
}
|
|
19
19
|
export declare enum ImageTypes {
|
|
20
20
|
Default = "default",
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
|
-
declare type optReqFlagType = "Required" | "Optional" | "" | undefined;
|
|
3
2
|
interface LabelProps {
|
|
4
3
|
/** Additional CSS class name to render in the `label` element. */
|
|
5
4
|
className?: string;
|
|
@@ -7,11 +6,15 @@ interface LabelProps {
|
|
|
7
6
|
htmlFor: string;
|
|
8
7
|
/** ID that other components can cross reference for accessibility purposes */
|
|
9
8
|
id?: string;
|
|
10
|
-
/**
|
|
11
|
-
|
|
9
|
+
/** Controls whether the label should be inline with the input it goes with.
|
|
10
|
+
* This prop should only be used internally. */
|
|
11
|
+
isInlined?: boolean;
|
|
12
|
+
/** Controls whether the "(Required)" text should be displayed alongside the
|
|
13
|
+
* label's text. False by default. */
|
|
14
|
+
isRequired?: boolean;
|
|
12
15
|
}
|
|
13
16
|
/**
|
|
14
17
|
* A label for form inputs. It should never be used alone.
|
|
15
18
|
*/
|
|
16
|
-
declare
|
|
19
|
+
export declare const Label: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<LabelProps>) => JSX.Element, {}>;
|
|
17
20
|
export default Label;
|
|
@@ -24,5 +24,5 @@ export interface LinkProps {
|
|
|
24
24
|
* A component that uses an `href` prop or a child anchor element, to create
|
|
25
25
|
* an anchor element with added styling and conventions.
|
|
26
26
|
*/
|
|
27
|
-
declare const Link: React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement
|
|
27
|
+
export declare const Link: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement>>, {}>;
|
|
28
28
|
export default Link;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
import { ListTypes } from "./ListTypes";
|
|
3
|
-
interface
|
|
3
|
+
interface DescriptionProps {
|
|
4
4
|
term: string;
|
|
5
|
-
|
|
5
|
+
description: string | JSX.Element;
|
|
6
6
|
}
|
|
7
7
|
export interface ListProps {
|
|
8
8
|
/** Optionally pass in additional Chakra-based styles. */
|
|
@@ -17,23 +17,23 @@ export interface ListProps {
|
|
|
17
17
|
inline?: boolean;
|
|
18
18
|
/** Data to render if children are not passed. For `ListTypes.Ordered` and
|
|
19
19
|
* `ListTypes.Unordered` `List` types, the data structure is an array of
|
|
20
|
-
* strings to renders as `li` items. For `ListTypes.
|
|
21
|
-
* the data structure is an array of objects with `term` and `
|
|
20
|
+
* strings to renders as `li` items. For `ListTypes.Description` `List` types,
|
|
21
|
+
* the data structure is an array of objects with `term` and `description`
|
|
22
22
|
* properties to render `dt` and `dd` elements, respectively.
|
|
23
23
|
*/
|
|
24
|
-
listItems?: (string | JSX.Element |
|
|
24
|
+
listItems?: (string | JSX.Element | DescriptionProps)[];
|
|
25
25
|
/** Remove list styling. */
|
|
26
26
|
noStyling?: boolean;
|
|
27
27
|
/** An optional title that will appear over the list. This prop only applies
|
|
28
|
-
* to
|
|
28
|
+
* to Description Lists. */
|
|
29
29
|
title?: string;
|
|
30
|
-
/** The type of list: Ordered, Unordered, or
|
|
30
|
+
/** The type of list: Ordered, Unordered, or Description. Unordered by default. */
|
|
31
31
|
type: ListTypes;
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
|
-
* A component that renders list item `li` elements or
|
|
34
|
+
* A component that renders list item `li` elements or description item `dt`
|
|
35
35
|
* and `dd` elements based on the `type` prop. Note that the `title` prop will
|
|
36
|
-
* only display for the `
|
|
36
|
+
* only display for the `Description` list type.
|
|
37
37
|
*/
|
|
38
|
-
export
|
|
39
|
-
export
|
|
38
|
+
export declare const List: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<ListProps>) => any, {}>;
|
|
39
|
+
export default List;
|
|
@@ -25,4 +25,5 @@ export interface LogoProps {
|
|
|
25
25
|
* The `Logo` component renders SVG-based logos and color variants that are
|
|
26
26
|
* commonly used by the New York Public Library.
|
|
27
27
|
*/
|
|
28
|
-
export
|
|
28
|
+
export declare const Logo: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<LogoProps>) => JSX.Element, {}>;
|
|
29
|
+
export default Logo;
|
|
@@ -23,6 +23,8 @@ declare const _default: {
|
|
|
23
23
|
logo_qpl_black: string;
|
|
24
24
|
logo_qpl_color: string;
|
|
25
25
|
logo_qpl_white: string;
|
|
26
|
+
logo_reservoir_icon_color: string;
|
|
27
|
+
logo_reservoir_vertical_color: string;
|
|
26
28
|
logo_schomburg_black: string;
|
|
27
29
|
logo_schomburg_circle_black: string;
|
|
28
30
|
logo_schomburg_circle_color: string;
|
|
@@ -4,12 +4,12 @@ export declare enum LogoColors {
|
|
|
4
4
|
UiWhite = "ui.white"
|
|
5
5
|
}
|
|
6
6
|
export declare enum LogoSizes {
|
|
7
|
+
Default = "default",
|
|
7
8
|
ExtraExtraSmall = "xxsmall",
|
|
8
9
|
ExtraSmall = "xsmall",
|
|
9
10
|
Small = "small",
|
|
10
11
|
Medium = "medium",
|
|
11
|
-
Large = "large"
|
|
12
|
-
Default = "default"
|
|
12
|
+
Large = "large"
|
|
13
13
|
}
|
|
14
14
|
export declare enum LogoNames {
|
|
15
15
|
BrooklynPublicLibraryBlack = "logo_bpl_black",
|
|
@@ -36,6 +36,8 @@ export declare enum LogoNames {
|
|
|
36
36
|
QueensPublicLibraryWhite = "logo_qpl_white",
|
|
37
37
|
QueensPublicLibraryAltBlack = "logo_qpl_alt_black",
|
|
38
38
|
QueensPublicLibraryAltWhite = "logo_qpl_alt_white",
|
|
39
|
+
ReservoirIconColor = "logo_reservoir_icon_color",
|
|
40
|
+
ReservoirVerticalColor = "logo_reservoir_vertical_color",
|
|
39
41
|
SchomburgColor = "logo_schomburg_color",
|
|
40
42
|
SchomburgBlack = "logo_schomburg_black",
|
|
41
43
|
SchomburgWhite = "logo_schomburg_white",
|
|
@@ -3,18 +3,18 @@ import { NotificationTypes } from "./NotificationTypes";
|
|
|
3
3
|
interface BaseProps {
|
|
4
4
|
/** Optional prop to control text alignment in `NotificationContent` */
|
|
5
5
|
alignText?: boolean;
|
|
6
|
-
/** Optional prop to control horizontal alignment of the `Notification` content */
|
|
7
|
-
centered?: boolean;
|
|
8
6
|
/** Optional custom `Icon` that will override the default `Icon`. */
|
|
9
7
|
icon?: JSX.Element;
|
|
10
8
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
11
9
|
id?: string;
|
|
10
|
+
/** Optional prop to control horizontal alignment of the `Notification` content */
|
|
11
|
+
isCentered?: boolean;
|
|
12
12
|
/** Optional prop to control the coloring of the `Notification` text and the
|
|
13
13
|
* visibility of an applicable icon. */
|
|
14
14
|
notificationType?: NotificationTypes;
|
|
15
15
|
}
|
|
16
16
|
declare type BasePropsWithoutAlignText = Omit<BaseProps, "alignText">;
|
|
17
|
-
declare type
|
|
17
|
+
declare type BasePropsWithoutIsCentered = Omit<BaseProps, "isCentered">;
|
|
18
18
|
export interface NotificationProps extends BasePropsWithoutAlignText {
|
|
19
19
|
/** Label used to describe the `Notification`'s aside HTML element. */
|
|
20
20
|
ariaLabel?: string;
|
|
@@ -37,14 +37,14 @@ export interface NotificationProps extends BasePropsWithoutAlignText {
|
|
|
37
37
|
/**
|
|
38
38
|
* NotificationHeading child-component.
|
|
39
39
|
*/
|
|
40
|
-
export declare
|
|
40
|
+
export declare const NotificationHeading: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<BasePropsWithoutAlignText>) => JSX.Element, {}>;
|
|
41
41
|
/**
|
|
42
42
|
* NotificationContent child-component.
|
|
43
43
|
*/
|
|
44
|
-
export declare
|
|
44
|
+
export declare const NotificationContent: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<BasePropsWithoutIsCentered>) => JSX.Element, {}>;
|
|
45
45
|
/**
|
|
46
46
|
* Component used to present users with three different levels of notifications:
|
|
47
47
|
* standard, announcement, and warning.
|
|
48
48
|
*/
|
|
49
|
-
export
|
|
50
|
-
export
|
|
49
|
+
export declare const Notification: import("@chakra-ui/react").ChakraComponent<(props: NotificationProps) => JSX.Element, {}>;
|
|
50
|
+
export default Notification;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
export interface PaginationProps {
|
|
3
3
|
/** Additional className. */
|
|
4
4
|
className?: string;
|
|
@@ -23,5 +23,5 @@ export interface PaginationProps {
|
|
|
23
23
|
/**
|
|
24
24
|
* A component that provides a navigational list of page items.
|
|
25
25
|
*/
|
|
26
|
-
declare const Pagination:
|
|
26
|
+
export declare const Pagination: import("@chakra-ui/react").ChakraComponent<(props: PaginationProps) => JSX.Element, {}>;
|
|
27
27
|
export default Pagination;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
import { ProgressIndicatorSizes, ProgressIndicatorTypes } from "./ProgressIndicatorTypes";
|
|
3
3
|
export interface ProgressIndicatorProps {
|
|
4
4
|
/** Flag to render the component in a dark background. */
|
|
5
5
|
darkMode?: boolean;
|
|
6
6
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
7
|
-
id
|
|
7
|
+
id: string;
|
|
8
8
|
/** Whether the `ProgressIndicator` should be linear or circular. */
|
|
9
9
|
indicatorType?: ProgressIndicatorTypes;
|
|
10
10
|
/** Whether the progress animation should display because the `value` prop is
|
|
@@ -25,5 +25,5 @@ export interface ProgressIndicatorProps {
|
|
|
25
25
|
* time to complete or consists of multiple steps. Examples include downloading,
|
|
26
26
|
* uploading, or processing.
|
|
27
27
|
*/
|
|
28
|
-
declare const ProgressIndicator:
|
|
28
|
+
export declare const ProgressIndicator: import("@chakra-ui/react").ChakraComponent<(props: ProgressIndicatorProps) => JSX.Element, {}>;
|
|
29
29
|
export default ProgressIndicator;
|
|
@@ -6,7 +6,7 @@ export interface RadioProps {
|
|
|
6
6
|
/** Optional string to populate the HelperErrorText for the standard state. */
|
|
7
7
|
helperText?: HelperErrorTextType;
|
|
8
8
|
/** ID that other components can cross reference for accessibility purposes */
|
|
9
|
-
id
|
|
9
|
+
id: string;
|
|
10
10
|
/** Optional string to populate the HelperErrorText for the error state
|
|
11
11
|
* when `isInvalid` is true.
|
|
12
12
|
*/
|
|
@@ -16,19 +16,17 @@ export interface RadioProps {
|
|
|
16
16
|
* Learn more about controlled and uncontrolled form fields: https://goshakkk.name/controlled-vs-uncontrolled-inputs-react/ */
|
|
17
17
|
isChecked?: boolean;
|
|
18
18
|
/** Adds the 'disabled' and `aria-disabled` attributes to the input when true.
|
|
19
|
-
* This also makes the text italic and color scheme gray.
|
|
20
|
-
*/
|
|
19
|
+
* This also makes the text italic and color scheme gray. */
|
|
21
20
|
isDisabled?: boolean;
|
|
22
21
|
/** Adds the 'aria-invalid' attribute to the input when true. This also makes
|
|
23
|
-
* the color theme "NYPL error" red for the button and text.
|
|
24
|
-
*/
|
|
22
|
+
* the color theme "NYPL error" red for the button and text. */
|
|
25
23
|
isInvalid?: boolean;
|
|
26
24
|
/** Adds the 'required' attribute to the input when true. */
|
|
27
25
|
isRequired?: boolean;
|
|
28
26
|
/** The radio button's label. This will serve as the text content for the
|
|
29
27
|
* `<label>` element if `showlabel` is true, or an "aria-label" if `showLabel`
|
|
30
28
|
* is false. */
|
|
31
|
-
labelText: string;
|
|
29
|
+
labelText: string | JSX.Element;
|
|
32
30
|
/** Used to reference the input element in forms. */
|
|
33
31
|
name?: string;
|
|
34
32
|
/** Should be passed along with `isChecked` for controlled components. */
|
|
@@ -41,5 +39,5 @@ export interface RadioProps {
|
|
|
41
39
|
/** Populates the value of the input. */
|
|
42
40
|
value?: string;
|
|
43
41
|
}
|
|
44
|
-
declare const Radio: React.ForwardRefExoticComponent<RadioProps & React.RefAttributes<HTMLInputElement
|
|
42
|
+
export declare const Radio: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<RadioProps & React.RefAttributes<HTMLInputElement>>, {}>;
|
|
45
43
|
export default Radio;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
|
-
import {
|
|
3
|
+
import { LayoutTypes } from "../../helpers/enums";
|
|
4
4
|
export interface RadioGroupProps {
|
|
5
5
|
/** Additional class name. */
|
|
6
6
|
className?: string;
|
|
@@ -9,11 +9,13 @@ export interface RadioGroupProps {
|
|
|
9
9
|
/** Optional string to populate the HelperErrorText for standard state */
|
|
10
10
|
helperText?: HelperErrorTextType;
|
|
11
11
|
/** ID that other components can cross reference for accessibility purposes */
|
|
12
|
-
id
|
|
12
|
+
id: string;
|
|
13
13
|
/** Optional string to populate the HelperErrorText for error state */
|
|
14
14
|
invalidText?: HelperErrorTextType;
|
|
15
15
|
/** Adds the 'disabled' prop to the input when true. */
|
|
16
16
|
isDisabled?: boolean;
|
|
17
|
+
/** Set's the `Radio`s' wrapper to be full width. */
|
|
18
|
+
isFullWidth?: boolean;
|
|
17
19
|
/** Adds the 'aria-invalid' attribute to the input and
|
|
18
20
|
* sets the error state when true. */
|
|
19
21
|
isInvalid?: boolean;
|
|
@@ -23,21 +25,27 @@ export interface RadioGroupProps {
|
|
|
23
25
|
* true, or an "aria-label" if `showLabel` is false. */
|
|
24
26
|
labelText: string;
|
|
25
27
|
/** Renders the Radio buttons in a row or column (default). */
|
|
26
|
-
layout?:
|
|
28
|
+
layout?: LayoutTypes;
|
|
27
29
|
/** The `name` prop indicates the form group for all the Radio children. */
|
|
28
30
|
name: string;
|
|
29
31
|
/** The action to perform on the `<input>`'s onChange function */
|
|
30
32
|
onChange?: (value: string) => void;
|
|
31
|
-
/** Whether or not to display "Required"/"Optional" in the label text. */
|
|
32
|
-
optReqFlag?: boolean;
|
|
33
33
|
/** Offers the ability to hide the helper/invalid text. */
|
|
34
34
|
showHelperInvalidText?: boolean;
|
|
35
35
|
/** Offers the ability to show the group's legend onscreen or hide it. Refer
|
|
36
36
|
* to the `labelText` property for more information. */
|
|
37
37
|
showLabel?: boolean;
|
|
38
|
+
/** Whether or not to display the "(Required)" text in the label text.
|
|
39
|
+
* True by default. */
|
|
40
|
+
showRequiredLabel?: boolean;
|
|
38
41
|
}
|
|
39
|
-
|
|
40
|
-
|
|
42
|
+
/**
|
|
43
|
+
* RadioGroup is a wrapper for DS `Radio` components that renders as a fieldset
|
|
44
|
+
* HTML element along with optional helper text. The `name` prop is essential
|
|
45
|
+
* for this form group element and is not needed for individual DS `Radio`
|
|
46
|
+
* components when `RadioGroup` is used.
|
|
47
|
+
*/
|
|
48
|
+
export declare const RadioGroup: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<RadioGroupProps & {
|
|
41
49
|
children?: React.ReactNode;
|
|
42
|
-
} & React.RefAttributes<HTMLInputElement
|
|
50
|
+
} & React.RefAttributes<HTMLInputElement>>, {}>;
|
|
43
51
|
export default RadioGroup;
|
|
@@ -4,13 +4,13 @@ interface BaseProps {
|
|
|
4
4
|
labelText: string;
|
|
5
5
|
name: string;
|
|
6
6
|
onChange?: (event: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
|
|
7
|
+
value?: string;
|
|
7
8
|
}
|
|
8
9
|
export interface SelectProps extends BaseProps {
|
|
9
10
|
optionsData: string[];
|
|
10
11
|
}
|
|
11
12
|
export interface TextInputProps extends BaseProps {
|
|
12
13
|
placeholder?: string;
|
|
13
|
-
value?: string;
|
|
14
14
|
}
|
|
15
15
|
export interface SearchBarProps {
|
|
16
16
|
/** Adds 'action' property to the `form` element. */
|
|
@@ -26,7 +26,7 @@ export interface SearchBarProps {
|
|
|
26
26
|
/** The text to display below the form in a `HelperErrorText` component. */
|
|
27
27
|
helperText?: HelperErrorTextType;
|
|
28
28
|
/** ID that other components can cross reference for accessibility purposes */
|
|
29
|
-
id
|
|
29
|
+
id: string;
|
|
30
30
|
/** Optional string to populate the `HelperErrorText` for the error state
|
|
31
31
|
* when `isInvalid` is true. */
|
|
32
32
|
invalidText?: HelperErrorTextType;
|
|
@@ -56,5 +56,5 @@ export interface SearchBarProps {
|
|
|
56
56
|
* Renders a wrapper `form` element to be used with `Select` (optional),
|
|
57
57
|
* `Input`, and `Button` components together.
|
|
58
58
|
*/
|
|
59
|
-
export
|
|
60
|
-
export
|
|
59
|
+
export declare const SearchBar: import("@chakra-ui/react").ChakraComponent<(props: SearchBarProps) => JSX.Element, {}>;
|
|
60
|
+
export default SearchBar;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
|
-
import { SelectTypes } from "./SelectTypes";
|
|
3
|
+
import { SelectTypes, LabelPositions } from "./SelectTypes";
|
|
4
4
|
export interface SelectProps {
|
|
5
5
|
/** Optionally pass in additional Chakra-based styles. */
|
|
6
6
|
additionalStyles?: {
|
|
@@ -11,7 +11,7 @@ export interface SelectProps {
|
|
|
11
11
|
/** Optional string to populate the `HelperErrorText` for the standard state. */
|
|
12
12
|
helperText?: HelperErrorTextType;
|
|
13
13
|
/** ID that other components can cross reference for accessibility purposes */
|
|
14
|
-
id
|
|
14
|
+
id: string;
|
|
15
15
|
/** Optional string to populate the `HelperErrorText` for the error state
|
|
16
16
|
* when `isInvalid` is true. */
|
|
17
17
|
invalidText?: HelperErrorTextType;
|
|
@@ -22,6 +22,9 @@ export interface SelectProps {
|
|
|
22
22
|
isInvalid?: boolean;
|
|
23
23
|
/** Adds the `required` and `aria-required` attributes to the input when true. */
|
|
24
24
|
isRequired?: boolean;
|
|
25
|
+
/** Optional value to render the label inline, rather than the default (on top)
|
|
26
|
+
* of the select element. */
|
|
27
|
+
labelPosition?: LabelPositions;
|
|
25
28
|
/** Provides text for a `Label` component if `showLabel` is set to `true`;
|
|
26
29
|
* populates an `aria-label` attribute on the select input if `showLabel` is
|
|
27
30
|
* set to `false`. */
|
|
@@ -33,15 +36,16 @@ export interface SelectProps {
|
|
|
33
36
|
onChange?: (event: React.FormEvent) => void;
|
|
34
37
|
/** Placeholder text in the select element. */
|
|
35
38
|
placeholder?: string;
|
|
39
|
+
/** The variant to display. */
|
|
40
|
+
selectType?: SelectTypes;
|
|
36
41
|
/** Offers the ability to hide the helper/invalid text. */
|
|
37
42
|
showHelperInvalidText?: boolean;
|
|
38
43
|
/** Offers the ability to show the select's label onscreen or hide it. Refer
|
|
39
44
|
* to the `labelText` property for more information. */
|
|
40
45
|
showLabel?: boolean;
|
|
41
|
-
/** Whether or not to display the "Required"
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
type?: SelectTypes;
|
|
46
|
+
/** Whether or not to display the "(Required)" text in the label text.
|
|
47
|
+
* True by default. */
|
|
48
|
+
showRequiredLabel?: boolean;
|
|
45
49
|
/** The value of the selected option.
|
|
46
50
|
* Should be passed along with `onChange` for controlled components. */
|
|
47
51
|
value?: string;
|
|
@@ -50,7 +54,7 @@ export interface SelectProps {
|
|
|
50
54
|
* Component that renders Chakra's `Select` component along with an accessible
|
|
51
55
|
* `Label` and optional `HelperErrorText` component.
|
|
52
56
|
*/
|
|
53
|
-
declare const Select: React.ForwardRefExoticComponent<SelectProps & {
|
|
57
|
+
export declare const Select: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SelectProps & {
|
|
54
58
|
children?: React.ReactNode;
|
|
55
|
-
} & React.RefAttributes<HTMLSelectElement
|
|
59
|
+
} & React.RefAttributes<HTMLSelectElement>>, {}>;
|
|
56
60
|
export default Select;
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
|
-
import { SkeletonLoaderImageRatios
|
|
2
|
+
import { SkeletonLoaderImageRatios } from "./SkeletonLoaderTypes";
|
|
3
|
+
import { LayoutTypes } from "../../helpers/enums";
|
|
3
4
|
export interface SkeletonLoaderProps {
|
|
4
|
-
/** Optional boolean value to control visibility of border around skeleton loader. */
|
|
5
|
-
border?: boolean;
|
|
6
5
|
/** Additional class name for the Skeleton component. */
|
|
7
6
|
className?: string;
|
|
8
7
|
/** Optional numeric value to control the number of lines for content
|
|
@@ -14,9 +13,11 @@ export interface SkeletonLoaderProps {
|
|
|
14
13
|
/** Optional value to control the aspect ratio of the image placeholder;
|
|
15
14
|
* default value is `SkeletonLoaderImageRatios.Square`. */
|
|
16
15
|
imageAspectRatio?: SkeletonLoaderImageRatios;
|
|
16
|
+
/** Optional boolean value to control visibility of border around skeleton loader. */
|
|
17
|
+
isBordered?: boolean;
|
|
17
18
|
/** Optional value to control the position of the image placeholder;
|
|
18
|
-
* default value is `
|
|
19
|
-
layout?:
|
|
19
|
+
* default value is `LayoutTypes.Column`. */
|
|
20
|
+
layout?: LayoutTypes;
|
|
20
21
|
/** Optional boolean value to control visibility of button placeholder. */
|
|
21
22
|
showButton?: boolean;
|
|
22
23
|
/** Optional boolean value to control visibility of content placeholder. */
|
|
@@ -34,4 +35,5 @@ export interface SkeletonLoaderProps {
|
|
|
34
35
|
* The `SkeletonLoader` component renders a placeholder to be used while
|
|
35
36
|
* dynamic content is loading.
|
|
36
37
|
*/
|
|
37
|
-
export
|
|
38
|
+
export declare const SkeletonLoader: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<SkeletonLoaderProps>) => JSX.Element, {}>;
|
|
39
|
+
export default SkeletonLoader;
|