@nypl/design-system-react-components 0.25.1 → 0.25.5
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 +118 -1
- package/README.md +98 -50
- package/dist/components/Breadcrumbs/Breadcrumbs.d.ts +4 -0
- package/dist/components/Button/Button.d.ts +13 -8
- package/dist/components/Button/ButtonTypes.d.ts +2 -1
- package/dist/components/Card/Card.d.ts +36 -52
- package/dist/components/Card/CardTypes.d.ts +0 -15
- package/dist/components/Checkbox/Checkbox.d.ts +17 -13
- package/dist/components/CheckboxGroup/CheckboxGroup.d.ts +4 -2
- package/dist/components/ComponentWrapper/ComponentWrapper.d.ts +15 -0
- package/dist/components/DatePicker/DatePicker.d.ts +36 -34
- package/dist/components/Fieldset/Fieldset.d.ts +25 -0
- package/dist/components/Heading/Heading.d.ts +4 -4
- package/dist/components/HelperErrorText/HelperErrorText.d.ts +17 -14
- package/dist/components/HorizontalRule/HorizontalRule.d.ts +10 -9
- package/dist/components/Icons/Icon.d.ts +8 -0
- package/dist/components/Icons/IconSvgs.d.ts +11 -0
- package/dist/components/Icons/IconTypes.d.ts +11 -0
- package/dist/components/Image/Image.d.ts +19 -9
- package/dist/components/Image/ImageTypes.d.ts +20 -0
- package/dist/components/Link/Link.d.ts +4 -0
- package/dist/components/List/List.d.ts +19 -14
- package/dist/components/Notification/Notification.d.ts +37 -16
- package/dist/components/Pagination/Pagination.d.ts +16 -13
- package/dist/components/Pagination/Pagination.stories.d.ts +2 -0
- package/dist/components/ProgressIndicator/ProgressIndicator.d.ts +29 -0
- package/dist/components/ProgressIndicator/ProgressIndicatorTypes.d.ts +8 -0
- package/dist/components/Radio/Radio.d.ts +2 -0
- package/dist/components/RadioGroup/RadioGroup.d.ts +4 -2
- package/dist/components/SearchBar/SearchBar.d.ts +3 -3
- package/dist/components/Select/Select.d.ts +2 -0
- package/dist/components/SkeletonLoader/SkeletonLoader.d.ts +18 -14
- package/dist/components/Slider/Slider.d.ts +57 -0
- package/dist/components/StyleGuide/ColorCard.d.ts +12 -0
- package/dist/components/Tabs/Tabs.d.ts +1 -1
- package/dist/components/TextInput/TextInput.d.ts +12 -0
- package/dist/components/VideoPlayer/VideoPlayer.d.ts +6 -8
- package/dist/components/VideoPlayer/VideoPlayerTypes.d.ts +2 -2
- package/dist/design-system-react-components.cjs.development.js +6131 -3715
- 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 +6124 -3699
- package/dist/design-system-react-components.esm.js.map +1 -1
- package/dist/hooks/tests/useCarouselStyles.test.d.ts +1 -0
- package/dist/hooks/useCarouselStyles.d.ts +16 -0
- package/dist/hooks/useNYPLTheme.d.ts +54 -0
- package/dist/hooks/useWindowSize.d.ts +10 -0
- package/dist/index.d.ts +13 -8
- package/dist/resources.scss +180 -170
- package/dist/styles.css +1 -1
- package/dist/theme/components/button.d.ts +22 -8
- package/dist/theme/components/card.d.ts +168 -0
- package/dist/theme/components/checkbox.d.ts +5 -1
- package/dist/theme/components/checkboxGroup.d.ts +12 -0
- package/dist/theme/components/componentWrapper.d.ts +11 -0
- package/dist/theme/components/datePicker.d.ts +16 -0
- package/dist/theme/components/fieldset.d.ts +27 -0
- package/dist/theme/components/global.d.ts +23 -13
- package/dist/theme/components/globalMixins.d.ts +9 -1
- package/dist/theme/components/heading.d.ts +5 -0
- package/dist/theme/components/helperErrorText.d.ts +10 -0
- package/dist/theme/components/hero.d.ts +1 -0
- package/dist/theme/components/horizontalRule.d.ts +14 -0
- package/dist/theme/components/image.d.ts +31 -0
- package/dist/theme/components/label.d.ts +5 -3
- package/dist/theme/components/link.d.ts +4 -0
- package/dist/theme/components/list.d.ts +89 -0
- package/dist/theme/components/notification.d.ts +75 -0
- package/dist/theme/components/pagination.d.ts +19 -0
- package/dist/theme/components/progressIndicator.d.ts +50 -0
- package/dist/theme/components/radioGroup.d.ts +12 -0
- package/dist/theme/components/select.d.ts +11 -2
- package/dist/theme/components/skeletonLoader.d.ts +98 -0
- package/dist/theme/components/slider.d.ts +51 -0
- package/dist/theme/components/tabs.d.ts +54 -3
- package/dist/theme/components/textInput.d.ts +8 -1
- package/dist/theme/components/videoPlayer.d.ts +40 -0
- package/dist/theme/foundations/breakpoints.d.ts +8 -8
- package/dist/theme/foundations/global.d.ts +6 -1
- package/dist/theme/foundations/radii.d.ts +5 -0
- package/dist/theme/foundations/spacing.d.ts +16 -16
- package/package.json +72 -83
- package/src/__tests__/setup.ts +2 -2
- package/src/components/Accordion/Accordion.stories.mdx +39 -44
- package/src/components/Autosuggest/Autosuggest.stories.mdx +3 -3
- package/src/components/Autosuggest/Autosuggest.stories.tsx +2 -1
- package/src/components/Autosuggest/_Autosuggest.scss +5 -5
- package/src/components/Breadcrumbs/Breadcrumbs.stories.mdx +14 -10
- package/src/components/Breadcrumbs/Breadcrumbs.test.tsx +23 -0
- package/src/components/Breadcrumbs/Breadcrumbs.tsx +5 -1
- package/src/components/Breadcrumbs/__snapshots__/Breadcrumbs.test.tsx.snap +199 -1
- package/src/components/Button/Button.stories.mdx +15 -10
- package/src/components/Button/Button.test.tsx +21 -7
- package/src/components/Button/Button.tsx +22 -34
- package/src/components/Button/ButtonTypes.tsx +1 -0
- package/src/components/Button/__snapshots__/Button.test.tsx.snap +41 -10
- package/src/components/Card/Card.stories.mdx +296 -259
- package/src/components/Card/Card.test.tsx +156 -84
- package/src/components/Card/Card.tsx +195 -145
- package/src/components/Card/CardTypes.tsx +0 -17
- package/src/components/Card/__snapshots__/Card.test.tsx.snap +410 -0
- package/src/components/CardEdition/CardEdition.stories.tsx +15 -47
- package/src/components/CardEdition/_CardEdition.scss +22 -23
- package/src/components/Chakra/Box.stories.mdx +15 -16
- package/src/components/Chakra/Center.stories.mdx +31 -16
- package/src/components/Chakra/Grid.stories.mdx +28 -15
- package/src/components/Chakra/Stack.stories.mdx +35 -18
- package/src/components/Checkbox/Checkbox.stories.mdx +33 -11
- package/src/components/Checkbox/Checkbox.test.tsx +47 -2
- package/src/components/Checkbox/Checkbox.tsx +39 -33
- package/src/components/Checkbox/__snapshots__/Checkbox.test.tsx.snap +90 -2
- package/src/components/CheckboxGroup/CheckboxGroup.stories.mdx +82 -2
- package/src/components/CheckboxGroup/CheckboxGroup.test.tsx +29 -2
- package/src/components/CheckboxGroup/CheckboxGroup.tsx +22 -18
- package/src/components/CheckboxGroup/__snapshots__/CheckboxGroup.test.tsx.snap +47 -81
- package/src/components/ComponentWrapper/ComponentWrapper.tsx +63 -0
- package/src/components/DatePicker/DatePicker.stories.mdx +163 -62
- package/src/components/DatePicker/DatePicker.test.tsx +264 -64
- package/src/components/DatePicker/DatePicker.tsx +159 -128
- package/src/components/DatePicker/_DatePicker.scss +33 -67
- package/src/components/DatePicker/__snapshots__/DatePicker.test.tsx.snap +818 -0
- package/src/components/Fieldset/Fieldset.stories.mdx +55 -0
- package/src/components/Fieldset/Fieldset.test.tsx +125 -0
- package/src/components/Fieldset/Fieldset.tsx +52 -0
- package/src/components/Fieldset/__snapshots__/Fieldset.test.tsx.snap +68 -0
- package/src/components/Form/Form.stories.mdx +24 -6
- package/src/components/Form/Form.test.tsx +1 -1
- package/src/components/Form/Form.tsx +1 -0
- package/src/components/Grid/SimpleGrid.stories.mdx +32 -39
- package/src/components/Grid/SimpleGrid.test.tsx +4 -4
- package/src/components/Heading/Heading.stories.mdx +3 -4
- package/src/components/Heading/Heading.tsx +5 -5
- package/src/components/HelperErrorText/HelperErrorText.stories.mdx +124 -0
- package/src/components/HelperErrorText/HelperErrorText.test.tsx +39 -44
- package/src/components/HelperErrorText/HelperErrorText.tsx +37 -39
- package/src/components/HelperErrorText/__snapshots__/HelperErrorText.test.tsx.snap +25 -0
- package/src/components/Hero/Hero.stories.mdx +12 -2
- package/src/components/Hero/Hero.tsx +1 -1
- package/src/components/Hero/HeroTypes.tsx +1 -0
- package/src/components/Hero/__snapshots__/Hero.test.tsx.snap +7 -7
- package/src/components/HorizontalRule/HorizontalRule.stories.mdx +8 -6
- package/src/components/HorizontalRule/HorizontalRule.test.tsx +33 -28
- package/src/components/HorizontalRule/HorizontalRule.tsx +27 -29
- package/src/components/HorizontalRule/__snapshots__/HorizontalRule.test.tsx.snap +27 -9
- package/src/components/Icons/Icon.stories.mdx +12 -4
- package/src/components/Icons/Icon.test.tsx +18 -0
- package/src/components/Icons/Icon.tsx +16 -1
- package/src/components/Icons/IconSvgs.tsx +22 -0
- package/src/components/Icons/IconTypes.tsx +11 -0
- package/src/components/Image/Image.stories.mdx +220 -0
- package/src/components/Image/Image.test.tsx +131 -29
- package/src/components/Image/Image.tsx +84 -56
- package/src/components/Image/ImageTypes.ts +22 -0
- package/src/components/Image/__snapshots__/Image.test.tsx.snap +190 -0
- package/src/components/Input/Input.stories.tsx +23 -67
- package/src/components/Input/Input.test.tsx +4 -4
- package/src/components/Input/_Input.scss +23 -14
- package/src/components/Link/Link.tsx +4 -1
- package/src/components/List/List.stories.mdx +124 -49
- package/src/components/List/List.test.tsx +142 -63
- package/src/components/List/List.tsx +89 -93
- package/src/components/List/__snapshots__/List.test.tsx.snap +109 -0
- package/src/components/Modal/Modal.stories.mdx +3 -3
- package/src/components/Modal/_Modal.scss +2 -2
- package/src/components/Notification/Notification.stories.mdx +109 -112
- package/src/components/Notification/Notification.test.tsx +99 -110
- package/src/components/Notification/Notification.tsx +156 -159
- package/src/components/Notification/__snapshots__/Notification.test.tsx.snap +159 -8
- package/src/components/Pagination/Pagination.stories.mdx +26 -27
- package/src/components/Pagination/Pagination.stories.tsx +11 -16
- package/src/components/Pagination/Pagination.test.tsx +276 -146
- package/src/components/Pagination/Pagination.tsx +174 -154
- package/src/components/Pagination/__snapshots__/Pagination.test.tsx.snap +285 -0
- package/src/components/ProgressIndicator/ProgressIndicator.stories.mdx +292 -0
- package/src/components/ProgressIndicator/ProgressIndicator.test.tsx +225 -0
- package/src/components/ProgressIndicator/ProgressIndicator.tsx +126 -0
- package/src/components/ProgressIndicator/ProgressIndicatorTypes.ts +8 -0
- package/src/components/ProgressIndicator/__snapshots__/ProgressIndicator.test.tsx.snap +357 -0
- package/src/components/Radio/Radio.test.tsx +20 -4
- package/src/components/Radio/Radio.tsx +6 -3
- package/src/components/Radio/__snapshots__/Radio.test.tsx.snap +3 -0
- package/src/components/RadioGroup/RadioGroup.stories.mdx +3 -4
- package/src/components/RadioGroup/RadioGroup.test.tsx +24 -1
- package/src/components/RadioGroup/RadioGroup.tsx +19 -19
- package/src/components/RadioGroup/__snapshots__/RadioGroup.test.tsx.snap +42 -72
- package/src/components/SearchBar/SearchBar.Test.tsx +20 -1
- package/src/components/SearchBar/SearchBar.stories.mdx +113 -8
- package/src/components/SearchBar/SearchBar.tsx +20 -10
- package/src/components/Select/Select.test.tsx +12 -0
- package/src/components/Select/Select.tsx +5 -2
- package/src/components/Select/SelectTypes.tsx +1 -0
- package/src/components/SkeletonLoader/SkeletonLoader.stories.mdx +28 -59
- package/src/components/SkeletonLoader/SkeletonLoader.test.tsx +97 -177
- package/src/components/SkeletonLoader/SkeletonLoader.tsx +74 -71
- package/src/components/SkeletonLoader/__snapshots__/SkeletonLoader.test.tsx.snap +739 -0
- package/src/components/Slider/Slider.stories.mdx +529 -0
- package/src/components/Slider/Slider.test.tsx +653 -0
- package/src/components/Slider/Slider.tsx +303 -0
- package/src/components/Slider/__snapshots__/Slider.test.tsx.snap +1946 -0
- package/src/components/StyleGuide/Bidirectionality.stories.mdx +1 -1
- package/src/components/StyleGuide/Breakpoints.stories.mdx +34 -10
- package/src/components/StyleGuide/Buttons.stories.mdx +89 -73
- package/src/components/StyleGuide/ColorCard.tsx +46 -0
- package/src/components/StyleGuide/Colors.stories.mdx +171 -311
- package/src/components/StyleGuide/DesignTokens.stories.mdx +170 -0
- package/src/components/StyleGuide/Forms.stories.mdx +9 -7
- package/src/components/StyleGuide/Iconography.stories.mdx +85 -91
- package/src/components/StyleGuide/Spacing.stories.mdx +31 -23
- package/src/components/StyleGuide/Typography.stories.mdx +202 -189
- package/src/components/StyleGuide/UIDocCard.tsx +1 -1
- package/src/components/Tabs/Tabs.stories.mdx +73 -11
- package/src/components/Tabs/Tabs.tsx +87 -64
- package/src/components/Template/Template.stories.mdx +25 -27
- package/src/components/TextInput/TextInput.stories.mdx +1 -1
- package/src/components/TextInput/TextInput.test.tsx +22 -2
- package/src/components/TextInput/TextInput.tsx +28 -8
- package/src/components/TextInput/TextInputTypes.tsx +2 -0
- package/src/components/VideoPlayer/VideoPlayer.stories.mdx +17 -4
- package/src/components/VideoPlayer/VideoPlayer.test.tsx +54 -53
- package/src/components/VideoPlayer/VideoPlayer.tsx +50 -51
- package/src/components/VideoPlayer/VideoPlayerTypes.tsx +2 -2
- package/src/components/VideoPlayer/__snapshots__/VideoPlayer.test.tsx.snap +91 -0
- package/src/docs/Chakra.stories.mdx +244 -63
- package/src/docs/Intro.stories.mdx +5 -2
- package/src/hooks/tests/useCarouselStyles.test.ts +140 -0
- package/src/hooks/tests/useNYPLTheme.test.tsx +36 -0
- package/src/hooks/useCarouselStyles.ts +34 -0
- package/src/hooks/useNYPLTheme.ts +67 -0
- package/src/hooks/useWindowSize.ts +40 -0
- package/src/index.ts +22 -19
- package/src/resources.scss +5 -5
- package/src/styles/base/{_02-breakpoints.scss → _01-breakpoints.scss} +9 -10
- package/src/styles/base/{_03-mixins.scss → _02-mixins.scss} +16 -5
- package/src/styles/base/{_04-base.scss → _03-base.scss} +7 -2
- package/src/styles/base/{_05-focus.scss → _04-focus.scss} +0 -15
- package/src/styles/base/_place-holder.scss +14 -3
- package/src/styles/{03-space → space}/_space-inline.scss +14 -14
- package/src/styles/{03-space → space}/_space-inset.scss +10 -10
- package/src/styles/space/_space-stack.scss +116 -0
- package/src/styles.scss +13 -60
- package/src/theme/components/button.ts +21 -15
- package/src/theme/components/card.ts +174 -0
- package/src/theme/components/checkbox.ts +8 -3
- package/src/theme/components/checkboxGroup.ts +8 -0
- package/src/theme/components/componentWrapper.ts +10 -0
- package/src/theme/components/datePicker.ts +17 -0
- package/src/theme/components/fieldset.ts +18 -0
- package/src/theme/components/global.ts +26 -15
- package/src/theme/components/globalMixins.ts +9 -1
- package/src/theme/components/heading.ts +10 -5
- package/src/theme/components/helperErrorText.ts +9 -0
- package/src/theme/components/hero.ts +4 -3
- package/src/theme/components/horizontalRule.ts +13 -0
- package/src/theme/components/icon.ts +9 -9
- package/src/theme/components/image.ts +116 -0
- package/src/theme/components/label.ts +3 -10
- package/src/theme/components/link.ts +5 -1
- package/src/theme/components/list.ts +73 -0
- package/src/theme/components/notification.ts +93 -0
- package/src/theme/components/pagination.ts +20 -0
- package/src/theme/components/progressIndicator.ts +62 -0
- package/src/theme/components/radio.ts +2 -2
- package/src/theme/components/radioGroup.ts +8 -0
- package/src/theme/components/select.ts +6 -3
- package/src/theme/components/skeletonLoader.ts +107 -0
- package/src/theme/components/slider.ts +79 -0
- package/src/theme/components/statusBadge.ts +1 -2
- package/src/theme/components/tabs.ts +49 -19
- package/src/theme/components/template.ts +8 -8
- package/src/theme/components/textInput.ts +5 -4
- package/src/theme/components/videoPlayer.ts +49 -0
- package/src/theme/foundations/breakpoints.ts +8 -8
- package/src/theme/foundations/global.ts +6 -1
- package/src/theme/foundations/radii.ts +6 -0
- package/src/theme/foundations/spacing.ts +24 -24
- package/src/theme/index.ts +41 -10
- package/src/utils/componentCategories.ts +4 -3
- package/dist/components/HelperErrorText/HelperErrorText.stories.d.ts +0 -16
- package/dist/components/Image/Image.stories.d.ts +0 -18
- package/dist/components/List/List.stories.d.ts +0 -7
- package/dist/theme/components/customCheckboxGroup.d.ts +0 -18
- package/dist/theme/components/customRadioGroup.d.ts +0 -18
- package/src/components/Button/_Button.scss +0 -32
- package/src/components/Card/_Card.scss +0 -308
- package/src/components/HelperErrorText/HelperErrorText.stories.tsx +0 -48
- package/src/components/HelperErrorText/_HelperErrorText.scss +0 -9
- package/src/components/HorizontalRule/_HorizontalRule.scss +0 -15
- package/src/components/Image/Image.stories.tsx +0 -54
- package/src/components/Image/_Image.scss +0 -38
- package/src/components/List/List.stories.tsx +0 -139
- package/src/components/List/_List.scss +0 -76
- package/src/components/Notification/_Notification.scss +0 -110
- package/src/components/Pagination/_Pagination.scss +0 -40
- package/src/components/SkeletonLoader/_SkeletonLoader.scss +0 -142
- package/src/components/VideoPlayer/_VideoPlayer.scss +0 -38
- package/src/styles/01-colors/_colors-brand.scss +0 -62
- package/src/styles/01-colors/_colors-utility.scss +0 -67
- package/src/styles/02-typography/_type-scale.css +0 -11
- package/src/styles/02-typography/_type-weight.css +0 -7
- package/src/styles/02-typography/_typefaces.css +0 -4
- package/src/styles/03-space/_space-stack.scss +0 -116
- package/src/styles/03-space/_space.css +0 -30
- package/src/styles/base/_card-grid.scss +0 -78
- package/src/styles/base/_typography.scss +0 -11
- package/src/theme/components/customCheckboxGroup.ts +0 -12
- package/src/theme/components/customRadioGroup.ts +0 -12
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import * as React from "react";
|
|
2
|
+
export interface ComponentWrapperProps {
|
|
3
|
+
/** The UI elements that will be wrapped by this component */
|
|
4
|
+
children: React.ReactNode;
|
|
5
|
+
/** Optional string to set the text for a video description */
|
|
6
|
+
descriptionText?: string;
|
|
7
|
+
/** Optional string to set the text for a `Heading` component */
|
|
8
|
+
headingText?: string;
|
|
9
|
+
/** Optional string to set the text for a `HelperErrorText` component */
|
|
10
|
+
helperText?: string;
|
|
11
|
+
/** ID that other components can cross reference for accessibility purposes */
|
|
12
|
+
id?: string;
|
|
13
|
+
}
|
|
14
|
+
declare function ComponentWrapper(props: React.PropsWithChildren<ComponentWrapperProps>): JSX.Element;
|
|
15
|
+
export default ComponentWrapper;
|
|
@@ -2,29 +2,36 @@ import React from "react";
|
|
|
2
2
|
import { DatePickerTypes } from "./DatePickerTypes";
|
|
3
3
|
import { TextInputRefType } from "../TextInput/TextInput";
|
|
4
4
|
interface FullDateType {
|
|
5
|
-
|
|
5
|
+
/** Date object that gets returned for the onChange
|
|
6
|
+
* function only for date ranges. */
|
|
6
7
|
endDate?: Date;
|
|
8
|
+
/** Date object that gets returned for the onChange function. */
|
|
9
|
+
startDate: Date;
|
|
7
10
|
}
|
|
8
11
|
interface DateRangeRowProps {
|
|
12
|
+
/** ID that other components can cross reference for accessibility purposes. */
|
|
13
|
+
id?: string;
|
|
9
14
|
/** Whether to render a single date input or two for a range of two dates. */
|
|
10
|
-
|
|
15
|
+
isDateRange?: boolean;
|
|
11
16
|
}
|
|
12
17
|
interface DatePickerWrapperProps extends DateRangeRowProps {
|
|
13
|
-
/**
|
|
14
|
-
|
|
18
|
+
/** Additional className. */
|
|
19
|
+
className?: string;
|
|
20
|
+
/** Adds the 'required' property to the input element(s). */
|
|
21
|
+
isRequired?: boolean;
|
|
15
22
|
/** Passed to the `TextInput` component to render a label associated with an input field. */
|
|
16
23
|
labelText: string;
|
|
17
24
|
/** Offers the ability to show the label onscreen or hide it. */
|
|
18
25
|
showLabel?: boolean;
|
|
19
|
-
/**
|
|
20
|
-
|
|
21
|
-
className?: string;
|
|
26
|
+
/** Whether or not to display the "Required"/"Optional" text in the label text. */
|
|
27
|
+
showOptReqLabel?: boolean;
|
|
22
28
|
}
|
|
23
29
|
export interface DatePickerProps extends DatePickerWrapperProps {
|
|
30
|
+
/** The date format to display. Defaults to "yyyy-MM-dd".
|
|
31
|
+
* Must be in ISO-8601 format. */
|
|
32
|
+
dateFormat?: string;
|
|
24
33
|
/** DatePicker date types that can be rendered. */
|
|
25
34
|
dateType?: DatePickerTypes;
|
|
26
|
-
/** The date format to display. Defaults to "yyyy-MM-dd". */
|
|
27
|
-
dateFormat?: string;
|
|
28
35
|
/** Populates the `HelperErrorText` component in this component. */
|
|
29
36
|
helperText?: string;
|
|
30
37
|
/** Populates the `HelperErrorText` component in the "From" `TextInput` component. */
|
|
@@ -34,43 +41,38 @@ export interface DatePickerProps extends DatePickerWrapperProps {
|
|
|
34
41
|
/** The initial date value. This must be in the mm/dd/yyyy format. */
|
|
35
42
|
initialDate?: string;
|
|
36
43
|
/** The initialTo date value used for date ranges.
|
|
37
|
-
* This must be in the mm/dd/yyyy format.
|
|
38
|
-
*/
|
|
44
|
+
* This must be in the mm/dd/yyyy format. */
|
|
39
45
|
initialDateTo?: string;
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
*/
|
|
43
|
-
minDate?: string;
|
|
44
|
-
/** The maximum date value that applies to both input fields.
|
|
45
|
-
* This must be in the mm/dd/yyyy format.
|
|
46
|
-
*/
|
|
47
|
-
maxDate?: string;
|
|
48
|
-
/** Populates the `HelperErrorText` error state for both "From" and "To" input components. */
|
|
46
|
+
/** Populates the `HelperErrorText` error state for both "From"
|
|
47
|
+
* and "To" input components. */
|
|
49
48
|
invalidText?: string;
|
|
50
|
-
/** Helper for modifiers array; adds 'isInvalid' styling. */
|
|
51
|
-
isInvalid?: boolean;
|
|
52
|
-
/** Adds the 'required' property to the input element(s). */
|
|
53
|
-
required?: boolean;
|
|
54
|
-
/** Whether or not to display the "Required"/"Optional" text in the label text. */
|
|
55
|
-
showOptReqLabel?: boolean;
|
|
56
49
|
/** Adds the 'disabled' property to the input element(s). */
|
|
57
50
|
isDisabled?: boolean;
|
|
58
|
-
/**
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
51
|
+
/** Adds 'isInvalid' styling. */
|
|
52
|
+
isInvalid?: boolean;
|
|
53
|
+
/** Adds the 'required' property to the input element(s). */
|
|
54
|
+
isRequired?: boolean;
|
|
55
|
+
/** The maximum date value that applies to both input fields.
|
|
56
|
+
* This must be in the mm/dd/yyyy format. */
|
|
57
|
+
maxDate?: string;
|
|
58
|
+
/** The minimum date value that applies to both input fields.
|
|
59
|
+
* This must be in the mm/dd/yyyy format. */
|
|
60
|
+
minDate?: string;
|
|
64
61
|
/** Value name for the single input field or the "From" input field in a date range. */
|
|
65
62
|
nameFrom?: string;
|
|
66
63
|
/** Value name for the "To" input field */
|
|
67
64
|
nameTo?: string;
|
|
68
|
-
/** An additional explicit React ref passed for a date range's "From" input field. */
|
|
69
|
-
refTo?: React.Ref<TextInputRefType>;
|
|
70
65
|
/** The action to perform on the `input`'s onChange function for both fields.
|
|
71
66
|
* This will return the data in an object with `startDate` and `endDate` keys.
|
|
72
67
|
*/
|
|
73
68
|
onChange?: (data: FullDateType) => void;
|
|
69
|
+
/** An additional explicit React ref passed for a date range's "To"
|
|
70
|
+
* input field. Note that the "From" input takes the initial "ref" value. */
|
|
71
|
+
refTo?: React.Ref<TextInputRefType>;
|
|
72
|
+
/** Offers the ability to hide the helper/invalid text. */
|
|
73
|
+
showHelperInvalidText?: boolean;
|
|
74
|
+
/** Whether or not to display the "Required"/"Optional" text in the label text. */
|
|
75
|
+
showOptReqLabel?: boolean;
|
|
74
76
|
}
|
|
75
77
|
/**
|
|
76
78
|
* Returns a single date input field or two date input fields for a date range.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
interface FieldsetProps {
|
|
3
|
+
/** Children to render. Typically form-related components are used. */
|
|
4
|
+
children: React.ReactNode;
|
|
5
|
+
/** Additional class name to add. */
|
|
6
|
+
className?: string;
|
|
7
|
+
/** ID that other components can cross reference for accessibility purposes */
|
|
8
|
+
id?: string;
|
|
9
|
+
/** Flag to show or hide the text in the `legend` element. False by default. */
|
|
10
|
+
isLegendHidden?: boolean;
|
|
11
|
+
/** Flag to render "Required" or "Optional" in the `legend`.
|
|
12
|
+
* False/"Optional" by default. */
|
|
13
|
+
isRequired?: boolean;
|
|
14
|
+
/** Text to display in the `legend` element. */
|
|
15
|
+
legendText?: string;
|
|
16
|
+
/** Flag to show or hide the "Required"/"Optional" text in the `legend`.
|
|
17
|
+
* True by default. */
|
|
18
|
+
optReqFlag?: boolean;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* A wrapper component that renders a `fieldset` element along with a `legend`
|
|
22
|
+
* element as its first child. Commonly used to wrap form components.
|
|
23
|
+
*/
|
|
24
|
+
declare const Fieldset: React.FC<FieldsetProps>;
|
|
25
|
+
export default Fieldset;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
import { HeadingDisplaySizes, HeadingLevels } from "./HeadingTypes";
|
|
3
3
|
export interface HeadingProps {
|
|
4
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
5
|
+
additionalStyles?: {
|
|
6
|
+
[key: string]: any;
|
|
7
|
+
};
|
|
4
8
|
/** Optional className that appears in addition to `heading` */
|
|
5
9
|
className?: string;
|
|
6
10
|
/** Optional size used to override the default styles of the semantic HTML `<h>` elements */
|
|
@@ -9,10 +13,6 @@ export interface HeadingProps {
|
|
|
9
13
|
id?: string;
|
|
10
14
|
/** Optional number 1-6 used to create the `<h*>` tag; if prop is not passed, `Heading` will default to `<h2>` */
|
|
11
15
|
level?: HeadingLevels;
|
|
12
|
-
/** Optionally pass in additional Chakra-based styles. */
|
|
13
|
-
sx?: {
|
|
14
|
-
[key: string]: any;
|
|
15
|
-
};
|
|
16
16
|
/** Inner text of the `<h*>` element */
|
|
17
17
|
text?: string;
|
|
18
18
|
/** Optional URL that header points to; when `url` prop is passed to `Heading`, a child `<a>` element is created and the heading text becomes an active link */
|
|
@@ -1,23 +1,26 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
|
+
export declare type AriaLiveValues = "assertive" | "off" | "polite";
|
|
2
3
|
interface HelperErrorTextProps {
|
|
3
|
-
/**
|
|
4
|
-
|
|
5
|
-
/** Added prop when HelperText is errored */
|
|
6
|
-
ariaAtomic?: boolean;
|
|
7
|
-
/** Additional attributes passed to <HelperErrorText> */
|
|
8
|
-
attributes?: {
|
|
4
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
5
|
+
additionalStyles?: {
|
|
9
6
|
[key: string]: any;
|
|
10
7
|
};
|
|
11
|
-
/**
|
|
8
|
+
/** Aria attribute. When true, assistive technologies will
|
|
9
|
+
* read the entire DOM element. When false, only changes (additionals or
|
|
10
|
+
* removals) will be read. True by default. */
|
|
11
|
+
ariaAtomic?: boolean;
|
|
12
|
+
/** Aria attribute only used in the invalid state to read error text. This
|
|
13
|
+
* indicates the priority of the text and when it should be presented to users
|
|
14
|
+
* using screen readers; "off" indicates that the content should not be presented,
|
|
15
|
+
* "polite" that it will be announced at the next available time slot, and
|
|
16
|
+
* "assertive" that it should be announced immediately. "polite" by default. */
|
|
17
|
+
ariaLive?: AriaLiveValues;
|
|
18
|
+
/** Additional className to add. */
|
|
12
19
|
className?: string;
|
|
13
|
-
/**
|
|
14
|
-
blockName?: string;
|
|
15
|
-
/** unique ID for helper */
|
|
20
|
+
/** Unique ID for accessibility purposes. */
|
|
16
21
|
id?: string;
|
|
17
|
-
/** Toggles between helper and
|
|
18
|
-
|
|
19
|
-
/** Modifiers array for use with BEM. See how to work with modifiers and BEM here: http://getbem.com/introduction/ */
|
|
20
|
-
modifiers?: string[];
|
|
22
|
+
/** Toggles between helper and invalid styling. */
|
|
23
|
+
isInvalid?: boolean;
|
|
21
24
|
}
|
|
22
25
|
/**
|
|
23
26
|
* Helper or Error text for forms
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
export interface HorizontalRuleProps {
|
|
3
|
-
/** Optional alignment value to align the horizontal rule to one side or the
|
|
3
|
+
/** Optional alignment value to align the horizontal rule to one side or the
|
|
4
|
+
* other when the width is less than 100%. If omitted, the horizontal rule
|
|
5
|
+
* will have a default center alignment. */
|
|
4
6
|
align?: "left" | "right";
|
|
5
|
-
/** Additional attributes passed to the horizontal rule */
|
|
6
|
-
attributes?: {
|
|
7
|
-
[key: string]: any;
|
|
8
|
-
};
|
|
9
7
|
/** ClassName you can add in addition to `horizontal-rule` */
|
|
10
8
|
className?: string;
|
|
11
|
-
/** Optional height value.
|
|
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. */
|
|
12
13
|
height?: string;
|
|
13
|
-
/**
|
|
14
|
-
|
|
15
|
-
|
|
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 "auto". */
|
|
16
17
|
width?: string;
|
|
17
18
|
}
|
|
18
19
|
export default function HorizontalRule(props: React.ComponentProps<"hr"> & HorizontalRuleProps): JSX.Element;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
import { IconAlign, IconColors, IconNames, IconRotationTypes, IconSizes, IconTypes, LogoNames } from "./IconTypes";
|
|
3
3
|
export interface IconProps {
|
|
4
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
5
|
+
additionalStyles?: {
|
|
6
|
+
[key: string]: any;
|
|
7
|
+
};
|
|
4
8
|
/** Aligns the icon. */
|
|
5
9
|
align?: IconAlign;
|
|
6
10
|
/** className that appears in addition to "icon" */
|
|
@@ -18,6 +22,10 @@ export interface IconProps {
|
|
|
18
22
|
name?: IconNames | LogoNames;
|
|
19
23
|
/** Sets the icon size. */
|
|
20
24
|
size?: IconSizes;
|
|
25
|
+
/** For accessibility purposes, the text passed in the `title` prop gets
|
|
26
|
+
* rendered in a `title` element in the SVG. This descriptive text is not
|
|
27
|
+
* visible but is needed for screenreaders to describe the graphic. */
|
|
28
|
+
title?: string;
|
|
21
29
|
/** Sets the icon variant type. */
|
|
22
30
|
type?: IconTypes;
|
|
23
31
|
}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
declare const _default: {
|
|
2
2
|
accessibility_full: string;
|
|
3
3
|
accessibility_partial: string;
|
|
4
|
+
action_check_circle: string;
|
|
5
|
+
action_help_default: string;
|
|
6
|
+
action_help_outline: string;
|
|
7
|
+
action_launch: string;
|
|
4
8
|
arrow: string;
|
|
5
9
|
brooklyn: string;
|
|
6
10
|
check: string;
|
|
@@ -9,6 +13,13 @@ declare const _default: {
|
|
|
9
13
|
download: string;
|
|
10
14
|
error_filled: string;
|
|
11
15
|
error_outline: string;
|
|
16
|
+
file_type_audio: string;
|
|
17
|
+
file_type_doc: string;
|
|
18
|
+
file_type_generic_doc: string;
|
|
19
|
+
file_type_image: string;
|
|
20
|
+
file_type_pdf: string;
|
|
21
|
+
file_type_spreadsheet: string;
|
|
22
|
+
file_type_video: string;
|
|
12
23
|
headset: string;
|
|
13
24
|
logo_brooklyn: string;
|
|
14
25
|
logo_nypl: string;
|
|
@@ -43,6 +43,10 @@ export declare enum IconSizes {
|
|
|
43
43
|
export declare enum IconNames {
|
|
44
44
|
AccessibilityFull = "accessibility_full",
|
|
45
45
|
AccessibilityPartial = "accessibility_partial",
|
|
46
|
+
ActionCheckCircle = "action_check_circle",
|
|
47
|
+
ActionHelpDefault = "action_help_default",
|
|
48
|
+
ActionHelpOutline = "action_help_outline",
|
|
49
|
+
ActionLaunch = "action_launch",
|
|
46
50
|
Arrow = "arrow",
|
|
47
51
|
Check = "check",
|
|
48
52
|
Clock = "clock",
|
|
@@ -50,6 +54,13 @@ export declare enum IconNames {
|
|
|
50
54
|
Download = "download",
|
|
51
55
|
ErrorFilled = "error_filled",
|
|
52
56
|
ErrorOutline = "error_outline",
|
|
57
|
+
FileTypeAudio = "file_type_audio",
|
|
58
|
+
FileTypeDoc = "file_type_doc",
|
|
59
|
+
FileTypeGenericDoc = "file_type_generic_doc",
|
|
60
|
+
FileTypeImage = "file_type_image",
|
|
61
|
+
FileTypePdf = "file_type_pdf",
|
|
62
|
+
FileTypeSpreadsheet = "file_type_spreadsheet",
|
|
63
|
+
FileTypeVideo = "file_type_video",
|
|
53
64
|
Headset = "headset",
|
|
54
65
|
Minus = "minus",
|
|
55
66
|
Plus = "plus",
|
|
@@ -1,22 +1,32 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
attributes?: {
|
|
2
|
+
import { ImageRatios, ImageSizes, ImageTypes } from "./ImageTypes";
|
|
3
|
+
interface ImageWrapperProps {
|
|
4
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
5
|
+
additionalStyles?: {
|
|
7
6
|
[key: string]: any;
|
|
8
7
|
};
|
|
9
|
-
/** BlockName for use with BEM. See how to work with modifiers and BEM here: http://getbem.com/introduction/ */
|
|
10
|
-
blockName?: string;
|
|
11
8
|
/** ClassName you can add in addition to 'image' */
|
|
12
9
|
className?: string;
|
|
10
|
+
/** Optional value to control the aspect ratio of the cartd image; default value is `square` */
|
|
11
|
+
imageAspectRatio?: ImageRatios;
|
|
12
|
+
/** Optional value to control the size of the image */
|
|
13
|
+
imageSize?: ImageSizes;
|
|
14
|
+
}
|
|
15
|
+
export interface ImageProps extends ImageWrapperProps {
|
|
16
|
+
/** Alternate text description of the image */
|
|
17
|
+
alt: string;
|
|
18
|
+
/** Custom image component */
|
|
19
|
+
component?: JSX.Element | null;
|
|
13
20
|
/** Adding will wrap the image in a <figure> */
|
|
14
21
|
imageCaption?: string;
|
|
15
22
|
/** Adding will wrap the image in a <figure> */
|
|
16
23
|
imageCredit?: string;
|
|
17
|
-
/**
|
|
18
|
-
|
|
24
|
+
/** Optional value to control the size of the image */
|
|
25
|
+
imageSize?: ImageSizes;
|
|
26
|
+
/** Optional value for the image type */
|
|
27
|
+
imageType?: ImageTypes;
|
|
19
28
|
/** The src attribute is required, and contains the path to the image you want to embed. */
|
|
20
29
|
src: string;
|
|
21
30
|
}
|
|
22
31
|
export default function Image(props: React.ComponentProps<"img"> & ImageProps): JSX.Element;
|
|
32
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export declare enum ImageRatios {
|
|
2
|
+
FourByThree = "fourByThree",
|
|
3
|
+
OneByTwo = "oneByTwo",
|
|
4
|
+
Original = "original",
|
|
5
|
+
SixteenByNine = "sixteenByNine",
|
|
6
|
+
Square = "square",
|
|
7
|
+
ThreeByFour = "threeByFour",
|
|
8
|
+
ThreeByTwo = "threeByTwo",
|
|
9
|
+
TwoByOne = "twoByOne"
|
|
10
|
+
}
|
|
11
|
+
export declare enum ImageSizes {
|
|
12
|
+
Default = "default",
|
|
13
|
+
Large = "large",
|
|
14
|
+
Medium = "medium",
|
|
15
|
+
Small = "small"
|
|
16
|
+
}
|
|
17
|
+
export declare enum ImageTypes {
|
|
18
|
+
Default = "default",
|
|
19
|
+
Circle = "circle"
|
|
20
|
+
}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
import { LinkTypes } from "./LinkTypes";
|
|
3
3
|
export interface LinkProps {
|
|
4
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
5
|
+
additionalStyles?: {
|
|
6
|
+
[key: string]: any;
|
|
7
|
+
};
|
|
4
8
|
/** Additional attributes, such as `rel=nofollow`, to pass to the `<a>` tag. */
|
|
5
9
|
attributes?: {
|
|
6
10
|
[key: string]: any;
|
|
@@ -5,30 +5,35 @@ interface DefinitionProps {
|
|
|
5
5
|
definition: string;
|
|
6
6
|
}
|
|
7
7
|
export interface ListProps {
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
9
|
+
additionalStyles?: {
|
|
10
|
+
[key: string]: any;
|
|
11
|
+
};
|
|
11
12
|
/** ClassName you can add in addition to 'list' */
|
|
12
13
|
className?: string;
|
|
13
14
|
/** ID that other components can cross reference for accessibility purposes */
|
|
14
15
|
id?: string;
|
|
15
|
-
/**
|
|
16
|
-
|
|
17
|
-
modifiers?: any[];
|
|
18
|
-
/** An optional title that will appear over the list. This prop only applies
|
|
19
|
-
* to Definition Lists. */
|
|
20
|
-
title?: string;
|
|
21
|
-
/** Ordered, Unordered, or Definition */
|
|
22
|
-
type: ListTypes;
|
|
16
|
+
/** Display the list in a row. */
|
|
17
|
+
inline?: boolean;
|
|
23
18
|
/** Data to render if children are not passed. For `ListTypes.Ordered` and
|
|
24
19
|
* `ListTypes.Unordered` `List` types, the data structure is an array of
|
|
25
20
|
* strings to renders as `li` items. For `ListTypes.Definition` `List` types,
|
|
26
21
|
* the data structure is an array of objects with `term` and `definition`
|
|
27
22
|
* properties to render `dt` and `dd` elements, respectively.
|
|
28
23
|
*/
|
|
29
|
-
listItems?: (string | DefinitionProps)[];
|
|
24
|
+
listItems?: (string | JSX.Element | DefinitionProps)[];
|
|
25
|
+
/** Remove list styling. */
|
|
26
|
+
noStyling?: boolean;
|
|
27
|
+
/** An optional title that will appear over the list. This prop only applies
|
|
28
|
+
* to Definition Lists. */
|
|
29
|
+
title?: string;
|
|
30
|
+
/** The type of list: Ordered, Unordered, or Definition. Unordered by default. */
|
|
31
|
+
type: ListTypes;
|
|
30
32
|
}
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
+
/**
|
|
34
|
+
* A component that renders list item `li` elements or definition item `dt`
|
|
35
|
+
* and `dd` elements based on the `type` prop. Note that the `title` prop will
|
|
36
|
+
* only display for the `Definition` list type.
|
|
37
|
+
*/
|
|
33
38
|
export default function List(props: React.PropsWithChildren<ListProps>): any;
|
|
34
39
|
export {};
|
|
@@ -1,25 +1,46 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { NotificationTypes } from "./NotificationTypes";
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
|
|
3
|
+
interface BaseProps {
|
|
4
|
+
/** Optional prop to control text alignment in `NotificationContent` */
|
|
5
|
+
alignText?: boolean;
|
|
6
6
|
/** Optional prop to control horizontal alignment of the `Notification` content */
|
|
7
7
|
centered?: boolean;
|
|
8
|
-
/** Optional `
|
|
8
|
+
/** Optional custom `Icon` that will override the default `Icon`. */
|
|
9
|
+
icon?: JSX.Element;
|
|
10
|
+
/** Optional prop to control the coloring of the `Notification` text and the
|
|
11
|
+
* visibility of an applicable icon. */
|
|
12
|
+
notificationType?: NotificationTypes;
|
|
13
|
+
}
|
|
14
|
+
declare type BasePropsWithoutAlignText = Omit<BaseProps, "alignText">;
|
|
15
|
+
declare type BasePropsWithoutCentered = Omit<BaseProps, "centered">;
|
|
16
|
+
export interface NotificationProps extends BasePropsWithoutAlignText {
|
|
17
|
+
/** Additional `className` to add. */
|
|
9
18
|
className?: string;
|
|
10
|
-
/** Optional prop to control whether a `Notification` can be dismissed
|
|
19
|
+
/** Optional prop to control whether a `Notification` can be dismissed
|
|
20
|
+
* (closed) by a user. */
|
|
11
21
|
dismissible?: boolean;
|
|
12
|
-
/** Optional custom `Icon` that will override the default `Icon
|
|
13
|
-
icon?:
|
|
14
|
-
/** ID that other components can cross reference for accessibility purposes */
|
|
22
|
+
/** Optional custom `Icon` that will override the default `Icon`. */
|
|
23
|
+
icon?: JSX.Element;
|
|
24
|
+
/** ID that other components can cross reference for accessibility purposes. */
|
|
15
25
|
id?: string;
|
|
16
|
-
/** Optional prop to control the margin around the `Notification` component */
|
|
26
|
+
/** Optional prop to control the margin around the `Notification` component. */
|
|
17
27
|
noMargin?: boolean;
|
|
18
|
-
/**
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
|
|
28
|
+
/** Content to be rendered in a `NotificationContent` component. */
|
|
29
|
+
notificationContent: string | JSX.Element;
|
|
30
|
+
/** Content to be rendered in a `NotificationHeading` component. */
|
|
31
|
+
notificationHeading?: string;
|
|
22
32
|
}
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
33
|
+
/**
|
|
34
|
+
* NotificationHeading child-component.
|
|
35
|
+
*/
|
|
36
|
+
export declare function NotificationHeading(props: React.PropsWithChildren<BasePropsWithoutAlignText>): JSX.Element;
|
|
37
|
+
/**
|
|
38
|
+
* NotificationContent child-component.
|
|
39
|
+
*/
|
|
40
|
+
export declare function NotificationContent(props: React.PropsWithChildren<BasePropsWithoutCentered>): JSX.Element;
|
|
41
|
+
/**
|
|
42
|
+
* Component used to present users with three different levels of notifications:
|
|
43
|
+
* standard, announcement, and warning.
|
|
44
|
+
*/
|
|
45
|
+
export default function Notification(props: NotificationProps): JSX.Element;
|
|
46
|
+
export {};
|
|
@@ -1,20 +1,23 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export interface PaginationProps {
|
|
3
|
-
/**
|
|
4
|
-
blockName?: string;
|
|
5
|
-
/** Additional className for use with BEM. See how to work with blockNames and BEM here: http://getbem.com/introduction/ */
|
|
3
|
+
/** Additional className. */
|
|
6
4
|
className?: string;
|
|
7
|
-
/**
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
5
|
+
/** The callback function that takes a page number and returns a string
|
|
6
|
+
* to use for a link's `href` attribute. This is used when the current
|
|
7
|
+
* page should refresh when navigating. */
|
|
8
|
+
getPageHref?: undefined | ((pageNumber: number) => string);
|
|
9
|
+
/** ID that other components can cross reference for accessibility purposes. */
|
|
10
|
+
id?: string;
|
|
11
11
|
/** The current page selected. */
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
|
|
15
|
-
/** The method to callback when an item is selected. Passes the selected page to the consuming app as an argument. */
|
|
12
|
+
initialPage: number;
|
|
13
|
+
/** The callback function called when an item is selected and the current
|
|
14
|
+
* page should not refresh. */
|
|
16
15
|
onPageChange?: (selected: number) => void;
|
|
16
|
+
/** The total number of pages. */
|
|
17
|
+
pageCount: number;
|
|
17
18
|
}
|
|
18
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* A component that provides a navigational list of page items.
|
|
21
|
+
*/
|
|
19
22
|
declare const Pagination: React.FC<PaginationProps>;
|
|
20
23
|
export default Pagination;
|
|
@@ -2,6 +2,8 @@ import { Story } from "@storybook/react/types-6-0";
|
|
|
2
2
|
import { PaginationProps } from "./Pagination";
|
|
3
3
|
/**
|
|
4
4
|
* PaginationGetPageHref will refresh the browser as a new page is selected.
|
|
5
|
+
* In this example, `getPageHref` creates the `href` attribute for each
|
|
6
|
+
* page URL.
|
|
5
7
|
*/
|
|
6
8
|
export declare const PaginationGetPageHref: Story<PaginationProps>;
|
|
7
9
|
/**
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ProgressIndicatorSizes, ProgressIndicatorTypes } from "./ProgressIndicatorTypes";
|
|
3
|
+
export interface ProgressIndicatorProps {
|
|
4
|
+
/** Flag to render the component in a dark background. */
|
|
5
|
+
darkMode?: boolean;
|
|
6
|
+
/** ID that other components can cross reference for accessibility purposes. */
|
|
7
|
+
id?: string;
|
|
8
|
+
/** Whether the `ProgressIndicator` should be linear or circular. */
|
|
9
|
+
indicatorType?: ProgressIndicatorTypes;
|
|
10
|
+
/** Whether the progress animation should display because the `value` prop is
|
|
11
|
+
* not known. When this is set to `true`, the `value` prop will be ignored. */
|
|
12
|
+
isIndeterminate?: boolean;
|
|
13
|
+
/** The text to display in an HTML `label` element. */
|
|
14
|
+
labelText: string;
|
|
15
|
+
/** Visually show or hide the label text. When set to `false`, then the label
|
|
16
|
+
* text will be added to the parent component as its `aria-label` attribute. */
|
|
17
|
+
showLabel?: boolean;
|
|
18
|
+
/** The size of the linear or circular progress. */
|
|
19
|
+
size?: ProgressIndicatorSizes;
|
|
20
|
+
/** A number between 0 to 100 that defines the progress' value. */
|
|
21
|
+
value?: number;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* A component that displays a progress status for any task that takes a long
|
|
25
|
+
* time to complete or consists of multiple steps. Examples include downloading,
|
|
26
|
+
* uploading, or processing.
|
|
27
|
+
*/
|
|
28
|
+
declare const ProgressIndicator: React.FC<ProgressIndicatorProps>;
|
|
29
|
+
export default ProgressIndicator;
|
|
@@ -32,6 +32,8 @@ export interface RadioProps {
|
|
|
32
32
|
name?: string;
|
|
33
33
|
/** Should be passed along with `isChecked` for controlled components. */
|
|
34
34
|
onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
|
|
35
|
+
/** Offers the ability to hide the helper/invalid text. */
|
|
36
|
+
showHelperInvalidText?: boolean;
|
|
35
37
|
/** Offers the ability to show the radio's label onscreen or hide it. Refer
|
|
36
38
|
* to the `labelText` property for more information. */
|
|
37
39
|
showLabel?: boolean;
|
|
@@ -7,12 +7,12 @@ export interface RadioGroupProps {
|
|
|
7
7
|
className?: string;
|
|
8
8
|
/** Populates the initial value of the input */
|
|
9
9
|
defaultValue?: string;
|
|
10
|
-
/** Optional string to populate the HelperErrorText for error state */
|
|
11
|
-
invalidText?: string;
|
|
12
10
|
/** Optional string to populate the HelperErrorText for standard state */
|
|
13
11
|
helperText?: string;
|
|
14
12
|
/** ID that other components can cross reference for accessibility purposes */
|
|
15
13
|
id?: string;
|
|
14
|
+
/** Optional string to populate the HelperErrorText for error state */
|
|
15
|
+
invalidText?: string;
|
|
16
16
|
/** Adds the 'disabled' prop to the input when true. */
|
|
17
17
|
isDisabled?: boolean;
|
|
18
18
|
/** Adds the 'aria-invalid' attribute to the input and
|
|
@@ -31,6 +31,8 @@ export interface RadioGroupProps {
|
|
|
31
31
|
onChange?: (value: string) => void;
|
|
32
32
|
/** Whether or not to display "Required"/"Optional" in the label text. */
|
|
33
33
|
optReqFlag?: boolean;
|
|
34
|
+
/** Offers the ability to hide the helper/invalid text. */
|
|
35
|
+
showHelperInvalidText?: boolean;
|
|
34
36
|
/** Offers the ability to show the group's legend onscreen or hide it. Refer
|
|
35
37
|
* to the `labelText` property for more information. */
|
|
36
38
|
showLabel?: boolean;
|