@nypl/design-system-react-components 2.0.0 → 2.0.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/README.md +466 -17
- package/dist/design-system-react-components.cjs +528 -0
- package/dist/design-system-react-components.js +37569 -0
- package/dist/src/components/Accordion/Accordion.d.ts +29 -0
- package/dist/src/components/AlphabetFilter/AlphabetFilter.d.ts +23 -0
- package/dist/src/components/AudioPlayer/AudioPlayer.d.ts +43 -0
- package/dist/src/components/Breadcrumbs/Breadcrumbs.d.ts +24 -0
- package/dist/src/components/Button/Button.d.ts +35 -0
- package/dist/src/components/ButtonGroup/ButtonGroup.d.ts +25 -0
- package/dist/src/components/Card/Card.d.ts +55 -0
- package/dist/src/components/Checkbox/Checkbox.d.ts +47 -0
- package/dist/src/components/CheckboxGroup/CheckboxGroup.d.ts +51 -0
- package/dist/src/components/ComponentWrapper/ComponentWrapper.d.ts +31 -0
- package/dist/src/components/DatePicker/DatePicker.d.ts +82 -0
- package/dist/src/components/FeedbackBox/FeedbackBox.d.ts +64 -0
- package/dist/src/components/FeedbackBox/useFeedbackBoxReducer.d.ts +19 -0
- package/dist/src/components/Fieldset/Fieldset.d.ts +24 -0
- package/dist/src/components/Form/Form.d.ts +31 -0
- package/dist/src/components/Grid/SimpleGrid.d.ts +20 -0
- package/dist/src/components/Heading/Heading.d.ts +42 -0
- package/dist/src/components/HelperErrorText/HelperErrorText.d.ts +34 -0
- package/dist/src/components/Hero/Hero.d.ts +49 -0
- package/dist/src/components/HorizontalRule/HorizontalRule.d.ts +11 -0
- package/dist/src/components/Icons/Icon.d.ts +41 -0
- package/dist/src/components/Icons/IconSvgs.d.ts +196 -0
- package/dist/src/components/Icons/iconVariables.d.ts +6 -0
- package/dist/src/components/Image/Image.d.ts +68 -0
- package/dist/src/components/Label/Label.d.ts +25 -0
- package/dist/src/components/Link/Link.d.ts +32 -0
- package/dist/src/components/List/List.d.ts +43 -0
- package/dist/src/components/Logo/Logo.d.ts +29 -0
- package/dist/src/components/Logo/LogoSvgs.d.ts +166 -0
- package/dist/src/components/Logo/logoVariables.d.ts +2 -0
- package/dist/src/components/Modal/Modal.d.ts +35 -0
- package/dist/src/components/Notification/Notification.d.ts +52 -0
- package/dist/src/components/Pagination/Pagination.d.ts +27 -0
- package/dist/src/components/ProgressIndicator/ProgressIndicator.d.ts +32 -0
- package/dist/src/components/Radio/Radio.d.ts +43 -0
- package/dist/src/components/RadioGroup/RadioGroup.d.ts +51 -0
- package/dist/src/components/SearchBar/SearchBar.d.ts +58 -0
- package/dist/src/components/Select/Select.d.ts +59 -0
- package/dist/src/components/SkeletonLoader/SkeletonLoader.d.ts +42 -0
- package/dist/src/components/SkipNavigation/SkipNavigation.d.ts +19 -0
- package/dist/src/components/Slider/Slider.d.ts +65 -0
- package/dist/src/components/SocialMediaLinks/SocialMediaLinks.d.ts +42 -0
- package/dist/src/components/SocialMediaLinks/SocialMediaLinksUtils.d.ts +7 -0
- package/dist/src/components/StatusBadge/StatusBadge.d.ts +19 -0
- package/dist/src/components/StructuredContent/StructuredContent.d.ts +30 -0
- package/dist/src/components/StyleGuide/ColorCard.d.ts +348 -0
- package/dist/src/components/StyledList/StyledList.d.ts +26 -0
- package/dist/src/components/Table/Table.d.ts +32 -0
- package/dist/src/components/Tabs/Tabs.d.ts +28 -0
- package/dist/src/components/TagSet/TagSet.d.ts +24 -0
- package/dist/src/components/TagSet/TagSetExplore.d.ts +28 -0
- package/dist/src/components/TagSet/TagSetFilter.d.ts +25 -0
- package/dist/src/components/TagSet/TooltipWrapper.d.ts +9 -0
- package/dist/src/components/Template/Template.d.ts +140 -0
- package/dist/src/components/Text/Text.d.ts +27 -0
- package/dist/src/components/TextInput/TextInput.d.ts +89 -0
- package/dist/src/components/Toggle/Toggle.d.ts +43 -0
- package/dist/src/components/Tooltip/Tooltip.d.ts +17 -0
- package/dist/src/components/VideoPlayer/VideoPlayer.d.ts +42 -0
- package/dist/src/helpers/types.d.ts +2 -0
- package/dist/src/hooks/useCarouselStyles.d.ts +17 -0
- package/dist/src/hooks/useCloseDropDown.d.ts +7 -0
- package/dist/src/hooks/useNYPLBreakpoints.d.ts +13 -0
- package/dist/src/hooks/useNYPLTheme.d.ts +75 -0
- package/dist/src/hooks/useStateWithDependencies.d.ts +5 -0
- package/dist/src/hooks/useWindowSize.d.ts +10 -0
- package/dist/src/index.d.ts +83 -0
- package/dist/src/theme/components/accordion.d.ts +34 -0
- package/dist/src/theme/components/alphabetFilter.d.ts +40 -0
- package/dist/src/theme/components/audioPlayer.d.ts +16 -0
- package/dist/src/theme/components/breadcrumb.d.ts +158 -0
- package/dist/src/theme/components/button.d.ts +152 -0
- package/dist/src/theme/components/buttonGroup.d.ts +11 -0
- package/dist/src/theme/components/card.d.ts +485 -0
- package/dist/src/theme/components/checkbox.d.ts +178 -0
- package/dist/src/theme/components/checkboxGroup.d.ts +14 -0
- package/dist/src/theme/components/componentWrapper.d.ts +12 -0
- package/dist/src/theme/components/customTable.d.ts +739 -0
- package/dist/src/theme/components/datePicker.d.ts +17 -0
- package/dist/src/theme/components/feedbackBox.d.ts +100 -0
- package/dist/src/theme/components/fieldset.d.ts +24 -0
- package/dist/src/theme/components/filterBar.d.ts +46 -0
- package/dist/src/theme/components/global.d.ts +141 -0
- package/dist/src/theme/components/globalMixins.d.ts +40 -0
- package/dist/src/theme/components/heading.d.ts +372 -0
- package/dist/src/theme/components/helperErrorText.d.ts +18 -0
- package/dist/src/theme/components/hero.d.ts +639 -0
- package/dist/src/theme/components/horizontalRule.d.ts +18 -0
- package/dist/src/theme/components/icon.d.ts +62251 -0
- package/dist/src/theme/components/image.d.ts +754 -0
- package/dist/src/theme/components/label.d.ts +22 -0
- package/dist/src/theme/components/link.d.ts +152 -0
- package/dist/src/theme/components/list.d.ts +230 -0
- package/dist/src/theme/components/logo.d.ts +477 -0
- package/dist/src/theme/components/modal.d.ts +27 -0
- package/dist/src/theme/components/multiSelect.d.ts +29 -0
- package/dist/src/theme/components/multiSelectMenuButton.d.ts +99 -0
- package/dist/src/theme/components/notification.d.ts +137 -0
- package/dist/src/theme/components/pagination.d.ts +19 -0
- package/dist/src/theme/components/progressIndicator.d.ts +69 -0
- package/dist/src/theme/components/radio.d.ts +202 -0
- package/dist/src/theme/components/radioGroup.d.ts +14 -0
- package/dist/src/theme/components/searchBar.d.ts +34 -0
- package/dist/src/theme/components/select.d.ts +126 -0
- package/dist/src/theme/components/skeletonLoader.d.ts +105 -0
- package/dist/src/theme/components/skipNavigation.d.ts +28 -0
- package/dist/src/theme/components/slider.d.ts +78 -0
- package/dist/src/theme/components/socialmedialinks.d.ts +192 -0
- package/dist/src/theme/components/statusBadge.d.ts +37 -0
- package/dist/src/theme/components/structuredContent.d.ts +454 -0
- package/dist/src/theme/components/styledList.d.ts +51 -0
- package/dist/src/theme/components/tabs.d.ts +172 -0
- package/dist/src/theme/components/tagSet.d.ts +154 -0
- package/dist/src/theme/components/template.d.ts +98 -0
- package/dist/src/theme/components/text.d.ts +59 -0
- package/dist/src/theme/components/textInput.d.ts +360 -0
- package/dist/src/theme/components/toggle.d.ts +129 -0
- package/dist/src/theme/components/tooltip.d.ts +21 -0
- package/dist/src/theme/components/videoPlayer.d.ts +47 -0
- package/dist/src/theme/foundations/breakpoints.d.ts +23 -0
- package/dist/src/theme/foundations/colors.d.ts +3 -0
- package/dist/src/theme/foundations/global.d.ts +68 -0
- package/dist/src/theme/foundations/radii.d.ts +11 -0
- package/dist/src/theme/foundations/shadows.d.ts +4 -0
- package/dist/src/theme/foundations/spacing.d.ts +96 -0
- package/dist/src/theme/foundations/typography.d.ts +8 -0
- package/dist/src/theme/index.d.ts +20 -0
- package/dist/src/theme/internalChakraProvider.d.ts +67 -0
- package/dist/src/theme/provider.d.ts +4 -0
- package/dist/src/theme/types.d.ts +1 -0
- package/dist/src/utils/colorUtils.d.ts +5 -0
- package/dist/src/utils/interfaces.d.ts +5 -0
- package/dist/src/utils/utils.d.ts +41 -0
- package/dist/styles.css +1 -0
- package/package.json +129 -24
- package/CHANGELOG.md +0 -139
- package/dist/design-system-react-components.min.js +0 -23
- package/dist/design-system-react-components.min.js.map +0 -1
- package/lib/components/00-base/Container/Container.d.ts +0 -6
- package/lib/components/00-base/Container/Container.js +0 -19
- package/lib/components/00-base/Container/Modal.d.ts +0 -12
- package/lib/components/00-base/Container/Modal.js +0 -29
- package/lib/components/00-base/Container/Modal.stories.d.ts +0 -7
- package/lib/components/00-base/Container/Modal.stories.js +0 -20
- package/lib/components/00-base/Placeholder.d.ts +0 -10
- package/lib/components/00-base/Placeholder.js +0 -23
- package/lib/components/00-base/SectionName.d.ts +0 -4
- package/lib/components/00-base/SectionName.js +0 -16
- package/lib/components/01-atoms/Button/Button.d.ts +0 -52
- package/lib/components/01-atoms/Button/Button.js +0 -76
- package/lib/components/01-atoms/Button/Button.stories.d.ts +0 -14
- package/lib/components/01-atoms/Button/Button.stories.js +0 -33
- package/lib/components/01-atoms/Button/ButtonTypes.d.ts +0 -10
- package/lib/components/01-atoms/Button/ButtonTypes.js +0 -14
- package/lib/components/01-atoms/Forms/Checkbox.d.ts +0 -21
- package/lib/components/01-atoms/Forms/Checkbox.js +0 -27
- package/lib/components/01-atoms/Forms/Checkbox.stories.d.ts +0 -7
- package/lib/components/01-atoms/Forms/Checkbox.stories.js +0 -23
- package/lib/components/01-atoms/Forms/DateRangeForm.d.ts +0 -31
- package/lib/components/01-atoms/Forms/DateRangeForm.js +0 -27
- package/lib/components/01-atoms/Forms/DateRangeForm.stories.d.ts +0 -9
- package/lib/components/01-atoms/Forms/DateRangeForm.stories.js +0 -23
- package/lib/components/01-atoms/Forms/FormDropdown.d.ts +0 -22
- package/lib/components/01-atoms/Forms/FormDropdown.js +0 -64
- package/lib/components/01-atoms/Forms/FormDropdown.stories.d.ts +0 -8
- package/lib/components/01-atoms/Forms/FormDropdown.stories.js +0 -22
- package/lib/components/01-atoms/Forms/HelperErrorText.d.ts +0 -26
- package/lib/components/01-atoms/Forms/HelperErrorText.js +0 -29
- package/lib/components/01-atoms/Forms/HelperErrorText.stories.d.ts +0 -9
- package/lib/components/01-atoms/Forms/HelperErrorText.stories.js +0 -23
- package/lib/components/01-atoms/Forms/Input.d.ts +0 -47
- package/lib/components/01-atoms/Forms/Input.js +0 -39
- package/lib/components/01-atoms/Forms/Input.stories.d.ts +0 -10
- package/lib/components/01-atoms/Forms/Input.stories.js +0 -22
- package/lib/components/01-atoms/Forms/Label.d.ts +0 -19
- package/lib/components/01-atoms/Forms/Label.js +0 -22
- package/lib/components/01-atoms/Forms/Label.stories.d.ts +0 -7
- package/lib/components/01-atoms/Forms/Label.stories.js +0 -20
- package/lib/components/01-atoms/Forms/TextField.d.ts +0 -26
- package/lib/components/01-atoms/Forms/TextField.js +0 -36
- package/lib/components/01-atoms/Forms/TextField.stories.d.ts +0 -7
- package/lib/components/01-atoms/Forms/TextField.stories.js +0 -20
- package/lib/components/01-atoms/Images/Icons/Icon.d.ts +0 -14
- package/lib/components/01-atoms/Images/Icons/Icon.js +0 -38
- package/lib/components/01-atoms/Images/Image/Image.d.ts +0 -8
- package/lib/components/01-atoms/Images/Image/Image.js +0 -32
- package/lib/components/01-atoms/Images/Image/Image.stories.d.ts +0 -8
- package/lib/components/01-atoms/Images/Image/Image.stories.js +0 -24
- package/lib/components/01-atoms/Links/BasicLink.d.ts +0 -15
- package/lib/components/01-atoms/Links/BasicLink.js +0 -50
- package/lib/components/01-atoms/Links/BasicLink.stories.d.ts +0 -8
- package/lib/components/01-atoms/Links/BasicLink.stories.js +0 -21
- package/lib/components/01-atoms/Links/IconLink.d.ts +0 -13
- package/lib/components/01-atoms/Links/IconLink.js +0 -44
- package/lib/components/01-atoms/Links/IconLink.stories.d.ts +0 -10
- package/lib/components/01-atoms/Links/IconLink.stories.js +0 -24
- package/lib/components/01-atoms/Links/Link.d.ts +0 -13
- package/lib/components/01-atoms/Links/Link.js +0 -51
- package/lib/components/01-atoms/Links/UnderlineLink.d.ts +0 -11
- package/lib/components/01-atoms/Links/UnderlineLink.js +0 -29
- package/lib/components/01-atoms/Links/UnderlineLink.stories.d.ts +0 -8
- package/lib/components/01-atoms/Links/UnderlineLink.stories.js +0 -21
- package/lib/components/01-atoms/Text/Headings/Heading.d.ts +0 -16
- package/lib/components/01-atoms/Text/Headings/Heading.js +0 -40
- package/lib/components/01-atoms/Text/Headings/Heading.stories.d.ts +0 -12
- package/lib/components/01-atoms/Text/Headings/Heading.stories.js +0 -35
- package/lib/components/01-atoms/Text/Headings/RNSectionTitle.d.ts +0 -2
- package/lib/components/01-atoms/Text/Headings/RNSectionTitle.js +0 -18
- package/lib/components/01-atoms/Text/Headings/RNSectionTitle.stories.d.ts +0 -7
- package/lib/components/01-atoms/Text/Headings/RNSectionTitle.stories.js +0 -24
- package/lib/components/01-atoms/Text/Text/BodyText.d.ts +0 -12
- package/lib/components/01-atoms/Text/Text/BodyText.js +0 -73
- package/lib/components/01-atoms/Text/Text/BodyText.stories.d.ts +0 -14
- package/lib/components/01-atoms/Text/Text/BodyText.stories.js +0 -54
- package/lib/components/02-molecules/Cards/EditionCard.d.ts +0 -31
- package/lib/components/02-molecules/Cards/EditionCard.js +0 -51
- package/lib/components/02-molecules/Cards/EditionCard.stories.d.ts +0 -13
- package/lib/components/02-molecules/Cards/EditionCard.stories.js +0 -26
- package/lib/components/02-molecules/Cards/SearchResultItem.d.ts +0 -17
- package/lib/components/02-molecules/Cards/SearchResultItem.js +0 -40
- package/lib/components/02-molecules/Cards/SearchResultItem.stories.d.ts +0 -8
- package/lib/components/02-molecules/Cards/SearchResultItem.stories.js +0 -31
- package/lib/components/02-molecules/Dropdown/Dropdown.d.ts +0 -21
- package/lib/components/02-molecules/Dropdown/Dropdown.js +0 -55
- package/lib/components/02-molecules/Dropdown/Dropdown.stories.d.ts +0 -14
- package/lib/components/02-molecules/Dropdown/Dropdown.stories.js +0 -33
- package/lib/components/02-molecules/Headings/SectionTitle.d.ts +0 -17
- package/lib/components/02-molecules/Headings/SectionTitle.js +0 -42
- package/lib/components/02-molecules/Headings/SectionTitle.stories.d.ts +0 -8
- package/lib/components/02-molecules/Headings/SectionTitle.stories.js +0 -20
- package/lib/components/02-molecules/Menus/Breadcrumbs/Breadcrumbs.d.ts +0 -14
- package/lib/components/02-molecules/Menus/Breadcrumbs/Breadcrumbs.js +0 -51
- package/lib/components/02-molecules/Menus/Breadcrumbs/Breadcrumbs.stories.d.ts +0 -8
- package/lib/components/02-molecules/Menus/Breadcrumbs/Breadcrumbs.stories.js +0 -30
- package/lib/components/02-molecules/Menus/Pagination/Pagination.d.ts +0 -11
- package/lib/components/02-molecules/Menus/Pagination/Pagination.js +0 -57
- package/lib/components/02-molecules/Menus/Pagination/Pagination.stories.d.ts +0 -7
- package/lib/components/02-molecules/Menus/Pagination/Pagination.stories.js +0 -20
- package/lib/components/02-molecules/SearchBar/SearchBar.d.ts +0 -26
- package/lib/components/02-molecules/SearchBar/SearchBar.js +0 -69
- package/lib/components/02-molecules/SearchBar/SearchBar.stories.d.ts +0 -11
- package/lib/components/02-molecules/SearchBar/SearchBar.stories.js +0 -24
- package/lib/components/03-organisms/Accordion/Accordion.d.ts +0 -19
- package/lib/components/03-organisms/Accordion/Accordion.js +0 -41
- package/lib/components/03-organisms/Accordion/Accordion.stories.d.ts +0 -7
- package/lib/components/03-organisms/Accordion/Accordion.stories.js +0 -30
- package/lib/components/03-organisms/Headers/HeaderImgRight.d.ts +0 -12
- package/lib/components/03-organisms/Headers/HeaderImgRight.js +0 -32
- package/lib/components/03-organisms/Headers/HeaderImgRight.stories.d.ts +0 -7
- package/lib/components/03-organisms/Headers/HeaderImgRight.stories.js +0 -19
- package/lib/components/03-organisms/Headers/RNHeaderWithSearch.d.ts +0 -19
- package/lib/components/03-organisms/Headers/RNHeaderWithSearch.js +0 -27
- package/lib/components/03-organisms/Headers/RNHeaderWithSearch.stories.d.ts +0 -7
- package/lib/components/03-organisms/Headers/RNHeaderWithSearch.stories.js +0 -26
- package/lib/components/03-organisms/Hero/Hero.d.ts +0 -31
- package/lib/components/03-organisms/Hero/Hero.js +0 -62
- package/lib/components/03-organisms/Hero/Hero.stories.d.ts +0 -11
- package/lib/components/03-organisms/Hero/Hero.stories.js +0 -35
- package/lib/components/03-organisms/Hero/HeroTypes.d.ts +0 -6
- package/lib/components/03-organisms/Hero/HeroTypes.js +0 -9
- package/lib/components/03-organisms/List/UnorderedList.d.ts +0 -18
- package/lib/components/03-organisms/List/UnorderedList.js +0 -28
- package/lib/components/03-organisms/List/UnorderedList.stories.d.ts +0 -11
- package/lib/components/03-organisms/List/UnorderedList.stories.js +0 -73
- package/lib/components/03-organisms/SearchPromo/SearchPromo.d.ts +0 -22
- package/lib/components/03-organisms/SearchPromo/SearchPromo.js +0 -30
- package/lib/components/03-organisms/SearchPromo/SearchPromo.stories.d.ts +0 -8
- package/lib/components/03-organisms/SearchPromo/SearchPromo.stories.js +0 -28
- package/lib/helpers/hoc/WithOneChild.d.ts +0 -8
- package/lib/helpers/hoc/WithOneChild.js +0 -63
- package/lib/index.d.ts +0 -24
- package/lib/index.js +0 -51
- package/lib/utils/bem.d.ts +0 -1
- package/lib/utils/bem.js +0 -35
- package/tsd.d.ts +0 -4
- package/webpack.prod.js +0 -38
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
export declare const headingSizesArray: readonly ["display1", "heading1", "heading2", "heading3", "heading4", "heading5", "heading6", "primary", "secondary", "tertiary", "callout"];
|
|
3
|
+
export declare const headingLevelsArray: readonly ["h1", "h2", "h3", "h4", "h5", "h6", "one", "two", "three", "four", "five", "six"];
|
|
4
|
+
export type HeadingSizes = typeof headingSizesArray[number];
|
|
5
|
+
export type HeadingLevels = typeof headingLevelsArray[number];
|
|
6
|
+
export interface HeadingProps {
|
|
7
|
+
/** Optional className that appears in addition to `heading` */
|
|
8
|
+
className?: string;
|
|
9
|
+
/** Optional ID that other components can cross reference for accessibility
|
|
10
|
+
* purposes */
|
|
11
|
+
id?: string;
|
|
12
|
+
/** Optional prop used to show capitalized text */
|
|
13
|
+
isCapitalized?: boolean;
|
|
14
|
+
/** Optional prop used to show upper case text */
|
|
15
|
+
isUppercase?: boolean;
|
|
16
|
+
/** Optional prop used to show lower case text */
|
|
17
|
+
isLowercase?: boolean;
|
|
18
|
+
/** Optional number 1-6 used to create the `<h*>` tag; if prop is not passed,
|
|
19
|
+
* `Heading` will default to `<h2>` */
|
|
20
|
+
level?: HeadingLevels;
|
|
21
|
+
/** Optional prop used to remove default spacing */
|
|
22
|
+
noSpace?: boolean;
|
|
23
|
+
/** String to populate the overline element */
|
|
24
|
+
overline?: string;
|
|
25
|
+
/** Optional size used to override the default styles of the native HTML `<h>`
|
|
26
|
+
* elements */
|
|
27
|
+
size?: HeadingSizes;
|
|
28
|
+
/** String to populate the subtitle element */
|
|
29
|
+
subtitle?: string;
|
|
30
|
+
/** Inner text of the `<h*>` element */
|
|
31
|
+
text?: string;
|
|
32
|
+
/** Optional URL that header points to; when `url` prop is passed to
|
|
33
|
+
* `Heading`, a child `<a>` element is created and the heading text becomes an
|
|
34
|
+
* active link */
|
|
35
|
+
url?: string;
|
|
36
|
+
/** Optional className for the URL when the `url` prop is passed */
|
|
37
|
+
urlClass?: string;
|
|
38
|
+
}
|
|
39
|
+
export declare const Heading: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HeadingProps & {
|
|
40
|
+
children?: React.ReactNode;
|
|
41
|
+
} & React.RefAttributes<HTMLHeadingElement>>, {}>;
|
|
42
|
+
export default Heading;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
export type AriaLiveValues = "assertive" | "off" | "polite" | undefined;
|
|
3
|
+
export type HelperErrorTextType = string | JSX.Element;
|
|
4
|
+
interface HelperErrorTextProps {
|
|
5
|
+
/** Aria attribute. When true, assistive technologies will read the entire
|
|
6
|
+
* DOM element. When false, only changes (additionals or removals) will be
|
|
7
|
+
* read. True by default. */
|
|
8
|
+
ariaAtomic?: boolean;
|
|
9
|
+
/** Aria attribute used to handle live updates for the helper and error text.
|
|
10
|
+
* This indicates the priority of the text and when it should be presented to
|
|
11
|
+
* users using screen readers; "off" indicates that the content should not be
|
|
12
|
+
* presented, "polite" that it will be announced at the next available time
|
|
13
|
+
* slot, and "assertive" that it should be announced immediately. This is set
|
|
14
|
+
* to "polite" by default. */
|
|
15
|
+
ariaLive?: AriaLiveValues;
|
|
16
|
+
/** Additional className to add. */
|
|
17
|
+
className?: string;
|
|
18
|
+
/** Unique ID for accessibility purposes. */
|
|
19
|
+
id?: string;
|
|
20
|
+
/** Toggles between helper and invalid styling. */
|
|
21
|
+
isInvalid?: boolean;
|
|
22
|
+
/** Offers the ability to render or not render the content passed in
|
|
23
|
+
* the `text` prop; `true` by default. */
|
|
24
|
+
isRenderedText?: boolean;
|
|
25
|
+
/** The text to display. */
|
|
26
|
+
text: HelperErrorTextType;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Component that always renders a div even if the text content is not passed.
|
|
30
|
+
* This pattern guarantees accessibility guidelines are met if the text content
|
|
31
|
+
* is dynamically updated by the app or component that implements it.
|
|
32
|
+
*/
|
|
33
|
+
export declare const HelperErrorText: import("@chakra-ui/react").ChakraComponent<import("react").ForwardRefExoticComponent<HelperErrorTextProps & import("react").RefAttributes<HTMLDivElement>>, {}>;
|
|
34
|
+
export default HelperErrorText;
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ComponentImageProps } from "../Image/Image";
|
|
3
|
+
export declare const heroTypesArray: readonly ["primary", "secondary", "secondaryBooksAndMore", "secondaryLocations", "secondaryResearch", "secondaryWhatsOn", "tertiary", "campaign", "fiftyFifty"];
|
|
4
|
+
export type HeroTypes = typeof heroTypesArray[number];
|
|
5
|
+
export declare const heroSecondaryTypes: string[];
|
|
6
|
+
export interface HeroImageProps extends Pick<ComponentImageProps, "alt" | "src"> {
|
|
7
|
+
}
|
|
8
|
+
export interface HeroProps {
|
|
9
|
+
/**
|
|
10
|
+
* Optional background color for the backdrop only in the `campaign` variant.
|
|
11
|
+
* When both `backdropBackgroundColor` and `backgroundImageSrc` are passed,
|
|
12
|
+
* the `backgroundImageSrc` will take precedence.
|
|
13
|
+
*/
|
|
14
|
+
backdropBackgroundColor?: string;
|
|
15
|
+
/** Optional hex color value used to override the default background
|
|
16
|
+
* color for a given `Hero` variation.
|
|
17
|
+
* Note: not all `Hero` variations utilize this prop. */
|
|
18
|
+
backgroundColor?: string;
|
|
19
|
+
/** Optional path to an image that will be used as a background image for the
|
|
20
|
+
* `Hero` component.
|
|
21
|
+
* Note: not all `Hero` variations utilize this prop. */
|
|
22
|
+
backgroundImageSrc?: string;
|
|
23
|
+
/** Optional hex color value used to override the default text color for a
|
|
24
|
+
* given `Hero` variation.
|
|
25
|
+
* Note: not all `Hero` variations utilize this prop. */
|
|
26
|
+
foregroundColor?: string;
|
|
27
|
+
/** Optional heading element. */
|
|
28
|
+
heading?: JSX.Element;
|
|
29
|
+
/** Used to control how the `Hero` component will be rendered. */
|
|
30
|
+
heroType?: HeroTypes;
|
|
31
|
+
/** Object used to create and render the `Image` component. Note that only
|
|
32
|
+
* `src` and `alt` are the available attributes to pass. If `imageProps.alt`
|
|
33
|
+
* is left blank, a warning will be logged to the console and will cause
|
|
34
|
+
* accessibility issues. For `imageProps.src`, it will only work for the
|
|
35
|
+
* "secondary", "fiftyFifty" and "campaign" `Hero` types; Note: `imageProps.src`
|
|
36
|
+
* can only be used in conjunction with `backgroundImageSrc` for the "campaign"
|
|
37
|
+
* `Hero` type. Note: not all `Hero` variations utilize this prop. */
|
|
38
|
+
imageProps?: HeroImageProps;
|
|
39
|
+
/** Optional details area that contains location data.
|
|
40
|
+
* Note: not all `Hero` variations utilize this prop. */
|
|
41
|
+
locationDetails?: JSX.Element;
|
|
42
|
+
/** Optional string used for the subheader that displays
|
|
43
|
+
* underneath the heading element. */
|
|
44
|
+
subHeaderText?: string | JSX.Element;
|
|
45
|
+
}
|
|
46
|
+
export declare const Hero: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HeroProps & {
|
|
47
|
+
children?: React.ReactNode;
|
|
48
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
49
|
+
export default Hero;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
export interface HorizontalRuleProps {
|
|
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. */
|
|
6
|
+
align?: "left" | "right";
|
|
7
|
+
/** ClassName you can add in addition to `horizontal-rule` */
|
|
8
|
+
className?: string;
|
|
9
|
+
}
|
|
10
|
+
export declare const HorizontalRule: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HorizontalRuleProps & React.RefAttributes<HTMLDivElement & HTMLHRElement>>, {}>;
|
|
11
|
+
export default HorizontalRule;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { iconAlignArray, iconColorsArray, iconNamesArray, iconRotationsArray, iconSizesArray, iconTypesArray } from "./iconVariables";
|
|
3
|
+
export type IconAlign = typeof iconAlignArray[number];
|
|
4
|
+
export type IconColors = typeof iconColorsArray[number];
|
|
5
|
+
export type IconNames = typeof iconNamesArray[number];
|
|
6
|
+
export type IconRotations = typeof iconRotationsArray[number];
|
|
7
|
+
export type IconRotationTypes = typeof iconRotationsArray[number];
|
|
8
|
+
export type IconSizes = typeof iconSizesArray[number];
|
|
9
|
+
export type IconTypes = typeof iconTypesArray[number];
|
|
10
|
+
export interface IconProps {
|
|
11
|
+
/** Aligns the icon. */
|
|
12
|
+
align?: IconAlign;
|
|
13
|
+
/** Optional className that will be added to the parent element */
|
|
14
|
+
className?: string;
|
|
15
|
+
/** Overrides default icon color (black). */
|
|
16
|
+
color?: IconColors;
|
|
17
|
+
/** Icons designated as decorative will be ignored by screenreaders. True
|
|
18
|
+
* by default. */
|
|
19
|
+
decorative?: boolean;
|
|
20
|
+
/** Rotates the icon clockwise in increments of 90deg */
|
|
21
|
+
iconRotation?: IconRotations;
|
|
22
|
+
/** ID that other components can cross reference for accessibility purposes */
|
|
23
|
+
id?: string;
|
|
24
|
+
/** The name of the icon you want to use. */
|
|
25
|
+
name?: IconNames;
|
|
26
|
+
/** Sets the icon size. */
|
|
27
|
+
size?: IconSizes;
|
|
28
|
+
/** For accessibility purposes, the text passed in the `title` prop gets
|
|
29
|
+
* rendered in a `title` element in the SVG. This descriptive text is not
|
|
30
|
+
* visible but is needed for screenreaders to describe the graphic. */
|
|
31
|
+
title?: string;
|
|
32
|
+
/** FOR INTERNAL DS USE ONLY: the icon variant to display. */
|
|
33
|
+
type?: IconTypes;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Renders SVG-based icons.
|
|
37
|
+
*/
|
|
38
|
+
export declare const Icon: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<IconProps & {
|
|
39
|
+
children?: React.ReactNode;
|
|
40
|
+
} & React.RefAttributes<HTMLDivElement & SVGSVGElement>>, {}>;
|
|
41
|
+
export default Icon;
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
declare const _default: {
|
|
3
|
+
accessibilityFull: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
4
|
+
title?: string;
|
|
5
|
+
}>;
|
|
6
|
+
accessibilityPartial: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
7
|
+
title?: string;
|
|
8
|
+
}>;
|
|
9
|
+
actionCheckCircle: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
10
|
+
title?: string;
|
|
11
|
+
}>;
|
|
12
|
+
actionCheckCircleFilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
13
|
+
title?: string;
|
|
14
|
+
}>;
|
|
15
|
+
actionExit: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
16
|
+
title?: string;
|
|
17
|
+
}>;
|
|
18
|
+
actionHelpDefault: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
19
|
+
title?: string;
|
|
20
|
+
}>;
|
|
21
|
+
actionHelpOutline: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
22
|
+
title?: string;
|
|
23
|
+
}>;
|
|
24
|
+
actionIdentity: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
25
|
+
title?: string;
|
|
26
|
+
}>;
|
|
27
|
+
actionIdentityFilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
28
|
+
title?: string;
|
|
29
|
+
}>;
|
|
30
|
+
actionLaunch: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
31
|
+
title?: string;
|
|
32
|
+
}>;
|
|
33
|
+
actionPower: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
34
|
+
title?: string;
|
|
35
|
+
}>;
|
|
36
|
+
actionRegistration: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
37
|
+
title?: string;
|
|
38
|
+
}>;
|
|
39
|
+
actionSearch: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
40
|
+
title?: string;
|
|
41
|
+
}>;
|
|
42
|
+
actionSettings: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
43
|
+
title?: string;
|
|
44
|
+
}>;
|
|
45
|
+
alertNotificationImportant: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
46
|
+
title?: string;
|
|
47
|
+
}>;
|
|
48
|
+
alertWarningFilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
49
|
+
title?: string;
|
|
50
|
+
}>;
|
|
51
|
+
alertWarningOutline: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
52
|
+
title?: string;
|
|
53
|
+
}>;
|
|
54
|
+
arrow: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
55
|
+
title?: string;
|
|
56
|
+
}>;
|
|
57
|
+
building: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
58
|
+
title?: string;
|
|
59
|
+
}>;
|
|
60
|
+
check: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
61
|
+
title?: string;
|
|
62
|
+
}>;
|
|
63
|
+
clock: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
64
|
+
title?: string;
|
|
65
|
+
}>;
|
|
66
|
+
close: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
67
|
+
title?: string;
|
|
68
|
+
}>;
|
|
69
|
+
decorativeEnvelope: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
70
|
+
title?: string;
|
|
71
|
+
}>;
|
|
72
|
+
decorativeLibraryCard: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
73
|
+
title?: string;
|
|
74
|
+
}>;
|
|
75
|
+
decorativeShoppingBag: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
76
|
+
title?: string;
|
|
77
|
+
}>;
|
|
78
|
+
download: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
79
|
+
title?: string;
|
|
80
|
+
}>;
|
|
81
|
+
errorFilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
82
|
+
title?: string;
|
|
83
|
+
}>;
|
|
84
|
+
errorOutline: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
85
|
+
title?: string;
|
|
86
|
+
}>;
|
|
87
|
+
fileTypeAudio: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
88
|
+
title?: string;
|
|
89
|
+
}>;
|
|
90
|
+
fileTypeDoc: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
91
|
+
title?: string;
|
|
92
|
+
}>;
|
|
93
|
+
fileTypeGenericDoc: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
94
|
+
title?: string;
|
|
95
|
+
}>;
|
|
96
|
+
fileTypeImage: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
97
|
+
title?: string;
|
|
98
|
+
}>;
|
|
99
|
+
fileTypePdf: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
100
|
+
title?: string;
|
|
101
|
+
}>;
|
|
102
|
+
fileTypeSpreadsheet: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
103
|
+
title?: string;
|
|
104
|
+
}>;
|
|
105
|
+
fileTypeVideo: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
106
|
+
title?: string;
|
|
107
|
+
}>;
|
|
108
|
+
headset: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
109
|
+
title?: string;
|
|
110
|
+
}>;
|
|
111
|
+
legacyAccountFilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
112
|
+
title?: string;
|
|
113
|
+
}>;
|
|
114
|
+
legacyAccountUnfilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
115
|
+
title?: string;
|
|
116
|
+
}>;
|
|
117
|
+
legacySocialFacebook: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
118
|
+
title?: string;
|
|
119
|
+
}>;
|
|
120
|
+
legacySocialInstagram: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
121
|
+
title?: string;
|
|
122
|
+
}>;
|
|
123
|
+
legacySocialTwitter: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
124
|
+
title?: string;
|
|
125
|
+
}>;
|
|
126
|
+
legacySocialYoutube: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
127
|
+
title?: string;
|
|
128
|
+
}>;
|
|
129
|
+
locator: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
130
|
+
title?: string;
|
|
131
|
+
}>;
|
|
132
|
+
mapsPlace: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
133
|
+
title?: string;
|
|
134
|
+
}>;
|
|
135
|
+
minus: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
136
|
+
title?: string;
|
|
137
|
+
}>;
|
|
138
|
+
moonCrescent: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
139
|
+
title?: string;
|
|
140
|
+
}>;
|
|
141
|
+
plus: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
142
|
+
title?: string;
|
|
143
|
+
}>;
|
|
144
|
+
search: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
145
|
+
title?: string;
|
|
146
|
+
}>;
|
|
147
|
+
socialFacebook: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
148
|
+
title?: string;
|
|
149
|
+
}>;
|
|
150
|
+
socialInstagram: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
151
|
+
title?: string;
|
|
152
|
+
}>;
|
|
153
|
+
socialPinterest: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
154
|
+
title?: string;
|
|
155
|
+
}>;
|
|
156
|
+
socialSoundCloud: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
157
|
+
title?: string;
|
|
158
|
+
}>;
|
|
159
|
+
socialSpotify: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
160
|
+
title?: string;
|
|
161
|
+
}>;
|
|
162
|
+
socialTikTok: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
163
|
+
title?: string;
|
|
164
|
+
}>;
|
|
165
|
+
socialTumblr: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
166
|
+
title?: string;
|
|
167
|
+
}>;
|
|
168
|
+
socialTwitter: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
169
|
+
title?: string;
|
|
170
|
+
}>;
|
|
171
|
+
socialVimeo: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
172
|
+
title?: string;
|
|
173
|
+
}>;
|
|
174
|
+
socialYoutube: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
175
|
+
title?: string;
|
|
176
|
+
}>;
|
|
177
|
+
speakerNotes: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
178
|
+
title?: string;
|
|
179
|
+
}>;
|
|
180
|
+
sunFull: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
181
|
+
title?: string;
|
|
182
|
+
}>;
|
|
183
|
+
utilityAccountFilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
184
|
+
title?: string;
|
|
185
|
+
}>;
|
|
186
|
+
utilityAccountUnfilled: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
187
|
+
title?: string;
|
|
188
|
+
}>;
|
|
189
|
+
utilityHamburger: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
190
|
+
title?: string;
|
|
191
|
+
}>;
|
|
192
|
+
utilitySearch: import("react").FunctionComponent<import("react").SVGProps<SVGSVGElement> & {
|
|
193
|
+
title?: string;
|
|
194
|
+
}>;
|
|
195
|
+
};
|
|
196
|
+
export default _default;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const iconAlignArray: readonly ["left", "right", "none"];
|
|
2
|
+
export declare const iconColorsArray: readonly ["ui.black", "ui.white", "brand.primary", "brand.secondary", "ui.error.primary", "ui.error.secondary", "ui.status.primary", "ui.status.secondary", "ui.success.primary", "ui.success.secondary", "ui.warning.primary", "ui.warning.secondary", "section.blogs.primary", "section.blogs.secondary", "section.books-and-more.primary", "section.books-and-more.secondary", "section.education.primary", "section.education.secondary", "section.locations.primary", "section.locations.secondary", "section.research.primary", "section.research.secondary", "section.research-library.lpa", "section.research-library.schomburg", "section.research-library.schwartzman", "section.whats-on.primary", "section.whats-on.secondary", "dark.ui.error.primary", "dark.ui.error.secondary", "dark.ui.status.primary", "dark.ui.status.secondary", "dark.ui.success.primary", "dark.ui.success.secondary", "dark.ui.warning.primary", "dark.ui.warning.secondary"];
|
|
3
|
+
export declare const iconNamesArray: readonly ["accessibilityFull", "accessibilityPartial", "actionCheckCircle", "actionCheckCircleFilled", "actionExit", "actionHelpDefault", "actionHelpOutline", "actionIdentity", "actionIdentityFilled", "actionLaunch", "actionPower", "actionRegistration", "actionSearch", "actionSettings", "alertNotificationImportant", "alertWarningFilled", "alertWarningOutline", "arrow", "building", "check", "clock", "close", "decorativeEnvelope", "decorativeLibraryCard", "decorativeShoppingBag", "download", "errorFilled", "errorOutline", "fileTypeAudio", "fileTypeDoc", "fileTypeGenericDoc", "fileTypeImage", "fileTypePdf", "fileTypeSpreadsheet", "fileTypeVideo", "headset", "legacyAccountFilled", "legacyAccountUnfilled", "legacySocialFacebook", "legacySocialInstagram", "legacySocialTwitter", "legacySocialYoutube", "locator", "mapsPlace", "minus", "moonCrescent", "plus", "search", "socialFacebook", "socialInstagram", "socialPinterest", "socialSoundCloud", "socialSpotify", "socialTikTok", "socialTumblr", "socialTwitter", "socialVimeo", "socialYoutube", "speakerNotes", "sunFull", "utilityAccountFilled", "utilityAccountUnfilled", "utilityHamburger", "utilitySearch"];
|
|
4
|
+
export declare const iconRotationsArray: readonly ["rotate0", "rotate90", "rotate180", "rotate270"];
|
|
5
|
+
export declare const iconSizesArray: readonly ["default", "xsmall", "small", "medium", "large", "xlarge", "xxlarge", "xxxlarge"];
|
|
6
|
+
export declare const iconTypesArray: readonly ["default", "breadcrumbs"];
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import React, { ImgHTMLAttributes } from "react";
|
|
2
|
+
export declare const imageRatiosArray: readonly ["fourByThree", "oneByTwo", "original", "sixteenByNine", "square", "threeByFour", "threeByTwo", "twoByOne"];
|
|
3
|
+
export declare const imageSizesArray: readonly ["default", "xxxsmall", "xxsmall", "xsmall", "small", "medium", "large"];
|
|
4
|
+
export declare const imageTypesArray: readonly ["default", "circle"];
|
|
5
|
+
export type ImageRatios = typeof imageRatiosArray[number];
|
|
6
|
+
export type ImageSizes = typeof imageSizesArray[number];
|
|
7
|
+
export type ImageTypes = typeof imageTypesArray[number];
|
|
8
|
+
export interface ComponentImageProps extends Partial<HTMLImageElement> {
|
|
9
|
+
/** String value used to populate the `alt` attribute of the internal `Image`
|
|
10
|
+
* component's `img` element. @NOTE if an image is used, this value must be passed. */
|
|
11
|
+
alt?: string;
|
|
12
|
+
/** Optional value to control the aspect ratio of the internal `Image` component.
|
|
13
|
+
* Defaults to `ImageRatios.Square`. */
|
|
14
|
+
aspectRatio?: ImageRatios;
|
|
15
|
+
/** Optional value to render as a caption for the internal `Image` component. */
|
|
16
|
+
caption?: string;
|
|
17
|
+
/** Optional DOM element to use instead of the DS `Image` component. */
|
|
18
|
+
component?: JSX.Element;
|
|
19
|
+
/** Optional value to render as a credit for the internal `Image` component. */
|
|
20
|
+
credit?: string;
|
|
21
|
+
/** Flag to set the internal `Image` component to `isLazy` mode. */
|
|
22
|
+
isLazy?: boolean;
|
|
23
|
+
/** Optional value to control the size of the internal `Image` component.
|
|
24
|
+
* Defaults to `ImageSizes.Default`. */
|
|
25
|
+
size?: ImageSizes;
|
|
26
|
+
/** Optional value that contains the path to an image. If omitted, the internal
|
|
27
|
+
* DS `Image` component will not render. */
|
|
28
|
+
src?: string;
|
|
29
|
+
}
|
|
30
|
+
interface ImageWrapperProps {
|
|
31
|
+
/** Optionally pass in additional Chakra-based styles. */
|
|
32
|
+
additionalWrapperStyles?: {
|
|
33
|
+
[key: string]: any;
|
|
34
|
+
};
|
|
35
|
+
/** ClassName you can add in addition to 'image' */
|
|
36
|
+
className?: string;
|
|
37
|
+
/** Optional value to control the aspect ratio of the card image; default
|
|
38
|
+
* value is `"original"` */
|
|
39
|
+
aspectRatio?: ImageRatios;
|
|
40
|
+
/** Optional value to control the size of the image */
|
|
41
|
+
size?: ImageSizes;
|
|
42
|
+
}
|
|
43
|
+
export interface ImageProps extends ImageWrapperProps, ImgHTMLAttributes<HTMLImageElement> {
|
|
44
|
+
/** Optionally pass in additional Chakra-based styles only for the figure. */
|
|
45
|
+
additionalFigureStyles?: {
|
|
46
|
+
[key: string]: any;
|
|
47
|
+
};
|
|
48
|
+
/** Optionally pass in additional Chakra-based styles only for the image. */
|
|
49
|
+
additionalImageStyles?: {
|
|
50
|
+
[key: string]: any;
|
|
51
|
+
};
|
|
52
|
+
/** Alternate text description of the image */
|
|
53
|
+
alt?: string;
|
|
54
|
+
/** Adding will wrap the image in a <figure> */
|
|
55
|
+
caption?: string;
|
|
56
|
+
/** Custom image component */
|
|
57
|
+
component?: JSX.Element | null;
|
|
58
|
+
/** Adding will wrap the image in a <figure> */
|
|
59
|
+
credit?: string;
|
|
60
|
+
/** Optional value for the image type */
|
|
61
|
+
imageType?: ImageTypes;
|
|
62
|
+
/** Flag to set the internal `Image` component to `isLazy` mode. */
|
|
63
|
+
isLazy?: boolean;
|
|
64
|
+
/** The src attribute is required, and contains the path to the image you want to embed. */
|
|
65
|
+
src?: string;
|
|
66
|
+
}
|
|
67
|
+
export declare const Image: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<ImageProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
68
|
+
export default Image;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
interface LabelProps {
|
|
3
|
+
/** Additional CSS class name to render in the `label` element. */
|
|
4
|
+
className?: string;
|
|
5
|
+
/** The id of the html element that this `Label` is describing. */
|
|
6
|
+
htmlFor: string;
|
|
7
|
+
/** ID that other components can cross reference for accessibility purposes */
|
|
8
|
+
id?: string;
|
|
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;
|
|
15
|
+
/** Allows the '(Required)' text to be changed for language purposes
|
|
16
|
+
* Note: Parenthesis will be added automatically by the component */
|
|
17
|
+
requiredLabelText?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* A label for form inputs. It should never be used alone.
|
|
21
|
+
*/
|
|
22
|
+
export declare const Label: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LabelProps & {
|
|
23
|
+
children?: React.ReactNode;
|
|
24
|
+
} & React.RefAttributes<HTMLDivElement & HTMLLabelElement>>, {}>;
|
|
25
|
+
export default Label;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
export declare const linkTypesArray: readonly ["action", "backwards", "button", "buttonPrimary", "buttonSecondary", "buttonPill", "buttonCallout", "buttonNoBrand", "buttonDisabled", "default", "external", "forwards", "standalone"];
|
|
3
|
+
export type LinkTypes = typeof linkTypesArray[number];
|
|
4
|
+
export interface LinkProps {
|
|
5
|
+
/** Any child node passed to the component. */
|
|
6
|
+
children: React.ReactNode;
|
|
7
|
+
/** Additional class name to render in the `Link` component. */
|
|
8
|
+
className?: string;
|
|
9
|
+
/** The `href` attribute for the anchor element. */
|
|
10
|
+
href?: string;
|
|
11
|
+
/** ID used for accessibility purposes. */
|
|
12
|
+
id?: string;
|
|
13
|
+
/** Used to explicitly set the underline style for a text link. If true, link
|
|
14
|
+
* text will always be underlined; if false, link text will only show
|
|
15
|
+
* underline in hover state. */
|
|
16
|
+
isUnderlined?: boolean;
|
|
17
|
+
onClick?: (event: React.MouseEvent<HTMLDivElement | HTMLAnchorElement, MouseEvent>) => void;
|
|
18
|
+
rel?: string;
|
|
19
|
+
/** Visibly hidden text that will only be read by screenreaders. */
|
|
20
|
+
screenreaderOnlyText?: string;
|
|
21
|
+
/** Prop that sets the HTML attribute to target where the link should go. */
|
|
22
|
+
target?: "_blank" | "_parent" | "_self" | "_top";
|
|
23
|
+
/** Controls the link visuals: action, button, backwards, forwards,
|
|
24
|
+
* standalone, or default. */
|
|
25
|
+
type?: LinkTypes;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* A component that uses an `href` prop or a child anchor element, to create
|
|
29
|
+
* an anchor element with added styling and conventions.
|
|
30
|
+
*/
|
|
31
|
+
export declare const Link: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLDivElement & HTMLAnchorElement>>, {}>;
|
|
32
|
+
export default Link;
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
export declare const listTypesArray: readonly ["ol", "ul", "dl"];
|
|
3
|
+
export type ListTypes = typeof listTypesArray[number];
|
|
4
|
+
export interface DescriptionProps {
|
|
5
|
+
term: string;
|
|
6
|
+
description: string | JSX.Element;
|
|
7
|
+
}
|
|
8
|
+
export interface ListProps {
|
|
9
|
+
/** ClassName you can add in addition to 'list' */
|
|
10
|
+
className?: string;
|
|
11
|
+
/** ID that other components can cross reference for accessibility purposes */
|
|
12
|
+
id?: string;
|
|
13
|
+
/** Display the list in a row. */
|
|
14
|
+
inline?: boolean;
|
|
15
|
+
/** Data to render if children are not passed. For `listTypes` ordered `"ol"`
|
|
16
|
+
* and unordered `"ul"` `List` types, the data structure is an array of strings
|
|
17
|
+
* to renders as `li` items. For description `"dl"` `List` types, the data
|
|
18
|
+
* structure is an array of objects with `term` and `description` properties
|
|
19
|
+
* to render `dt` and `dd` elements, respectively.
|
|
20
|
+
*/
|
|
21
|
+
listItems?: (string | JSX.Element | DescriptionProps)[];
|
|
22
|
+
/** Remove list styling. */
|
|
23
|
+
noStyling?: boolean;
|
|
24
|
+
/** An optional title that will appear over the list. This prop only applies
|
|
25
|
+
* to Description Lists. */
|
|
26
|
+
title?: string;
|
|
27
|
+
/** The type of list: "ol", "ul", or "dl". "ul" by default. */
|
|
28
|
+
type: ListTypes;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* A component that renders list item `li` elements or description item `dt`
|
|
32
|
+
* and `dd` elements based on the `type` prop. Note that the `title` prop will
|
|
33
|
+
* only display for the `Description` list type.
|
|
34
|
+
*/
|
|
35
|
+
export declare const List: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<ListProps & {
|
|
36
|
+
children?: React.ReactNode;
|
|
37
|
+
} & React.RefAttributes<HTMLDivElement & HTMLUListElement & HTMLOListElement>>, {}>;
|
|
38
|
+
/**
|
|
39
|
+
* Checks for `li` elements and consoles a warning if the
|
|
40
|
+
* children are different HTML elements.
|
|
41
|
+
*/
|
|
42
|
+
export declare const checkListChildrenError: (children: React.ReactNode, listType?: string, componentName?: string) => void;
|
|
43
|
+
export default List;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { logoNamesArray, logoSizesArray } from "./logoVariables";
|
|
3
|
+
export type LogoNames = typeof logoNamesArray[number];
|
|
4
|
+
export type LogoSizes = typeof logoSizesArray[number];
|
|
5
|
+
export interface LogoProps {
|
|
6
|
+
/** Optional className that will be added to the parent element */
|
|
7
|
+
className?: string;
|
|
8
|
+
/** Logos designated as decorative will be ignored by screenreaders. False
|
|
9
|
+
* by default. */
|
|
10
|
+
decorative?: boolean;
|
|
11
|
+
/** ID that other components can cross reference for accessibility purposes */
|
|
12
|
+
id?: string;
|
|
13
|
+
/** The name of the logo you want to use. */
|
|
14
|
+
name?: LogoNames;
|
|
15
|
+
/** Sets the logo size. */
|
|
16
|
+
size?: LogoSizes;
|
|
17
|
+
/** For accessibility purposes, the text passed in the `title` prop gets
|
|
18
|
+
* rendered in a `title` element in the SVG. This descriptive text is not
|
|
19
|
+
* visible but is needed for screenreaders to describe the graphic. */
|
|
20
|
+
title?: string;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* The `Logo` component renders SVG-based logos and color variants that are
|
|
24
|
+
* commonly used by the New York Public Library.
|
|
25
|
+
*/
|
|
26
|
+
export declare const Logo: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LogoProps & {
|
|
27
|
+
children?: React.ReactNode;
|
|
28
|
+
} & React.RefAttributes<HTMLDivElement & SVGSVGElement>>, {}>;
|
|
29
|
+
export default Logo;
|