@nypl/design-system-react-components 1.0.3 → 1.0.6
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 +64 -0
- package/README.md +171 -133
- package/dist/__tests__/mediaMatchMock.d.ts +79 -0
- package/dist/components/Accordion/Accordion.d.ts +2 -2
- package/dist/components/Breadcrumbs/Breadcrumbs.d.ts +2 -2
- package/dist/components/Button/Button.d.ts +4 -2
- package/dist/components/ButtonGroup/ButtonGroup.d.ts +4 -2
- package/dist/components/Card/Card.d.ts +7 -3
- package/dist/components/Checkbox/Checkbox.d.ts +1 -1
- package/dist/components/CheckboxGroup/CheckboxGroup.d.ts +2 -2
- package/dist/components/ComponentWrapper/ComponentWrapper.d.ts +4 -2
- package/dist/components/Fieldset/Fieldset.d.ts +3 -1
- package/dist/components/Form/Form.d.ts +4 -2
- package/dist/components/Grid/SimpleGrid.d.ts +4 -2
- package/dist/components/Heading/Heading.d.ts +10 -2
- package/dist/components/HelperErrorText/HelperErrorText.d.ts +2 -2
- package/dist/components/Hero/Hero.d.ts +4 -2
- package/dist/components/HorizontalRule/HorizontalRule.d.ts +2 -2
- package/dist/components/Icons/Icon.d.ts +5 -3
- package/dist/components/Icons/IconSvgs.d.ts +23 -0
- package/dist/components/Image/Image.d.ts +6 -2
- package/dist/components/Label/Label.d.ts +4 -2
- package/dist/components/Link/Link.d.ts +2 -2
- package/dist/components/List/List.d.ts +4 -2
- package/dist/components/Logo/Logo.d.ts +5 -3
- package/dist/components/Logo/LogoSvgs.d.ts +1 -0
- package/dist/components/Modal/Modal.d.ts +4 -2
- package/dist/components/Notification/Notification.d.ts +1 -1
- package/dist/components/Pagination/Pagination.d.ts +2 -2
- package/dist/components/ProgressIndicator/ProgressIndicator.d.ts +2 -2
- package/dist/components/Radio/Radio.d.ts +1 -1
- package/dist/components/RadioGroup/RadioGroup.d.ts +2 -2
- package/dist/components/SearchBar/SearchBar.d.ts +2 -2
- package/dist/components/SkeletonLoader/SkeletonLoader.d.ts +4 -2
- package/dist/components/SkipNavigation/SkipNavigation.d.ts +4 -2
- package/dist/components/Slider/Slider.d.ts +4 -2
- package/dist/components/StatusBadge/StatusBadge.d.ts +4 -2
- package/dist/components/StructuredContent/StructuredContent.d.ts +4 -2
- package/dist/components/StyleGuide/ColorCard.d.ts +25 -7
- package/dist/components/Table/Table.d.ts +4 -2
- package/dist/components/Tabs/Tabs.d.ts +4 -2
- package/dist/components/Template/Template.d.ts +7 -3
- package/dist/components/Text/Text.d.ts +10 -2
- package/dist/components/TextInput/TextInput.d.ts +1 -1
- package/dist/components/Toggle/Toggle.d.ts +1 -1
- package/dist/components/VideoPlayer/VideoPlayer.d.ts +4 -2
- package/dist/design-system-react-components.cjs.development.js +2929 -1863
- 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 +2839 -1805
- package/dist/design-system-react-components.esm.js.map +1 -1
- package/dist/hooks/__tests__/useNYPLBreakpoints.test.d.ts +1 -0
- package/dist/hooks/useCarouselStyles.d.ts +1 -1
- package/dist/hooks/useNYPLBreakpoints.d.ts +13 -0
- package/dist/index.d.ts +3 -1
- package/dist/resources.scss +0 -4
- package/dist/styles.css +3 -2
- package/dist/theme/components/breadcrumb.d.ts +3 -3
- package/dist/theme/components/button.d.ts +7 -2
- package/dist/theme/components/card.d.ts +4 -4
- package/dist/theme/components/checkbox.d.ts +3 -3
- package/dist/theme/components/customTable.d.ts +43 -43
- package/dist/theme/components/datePicker.d.ts +1 -0
- package/dist/theme/components/global.d.ts +6 -3
- package/dist/theme/components/globalMixins.d.ts +1 -4
- package/dist/theme/components/heading.d.ts +35 -31
- package/dist/theme/components/hero.d.ts +30 -40
- package/dist/theme/components/horizontalRule.d.ts +2 -2
- package/dist/theme/components/icon.d.ts +4762 -4762
- package/dist/theme/components/image.d.ts +60 -42
- package/dist/theme/components/list.d.ts +11 -11
- package/dist/theme/components/notification.d.ts +4 -4
- package/dist/theme/components/radio.d.ts +5 -2
- package/dist/theme/components/searchBar.d.ts +6 -0
- package/dist/theme/components/select.d.ts +6 -2
- package/dist/theme/components/skeletonLoader.d.ts +1 -1
- package/dist/theme/components/slider.d.ts +6 -6
- package/dist/theme/components/structuredContent.d.ts +33 -33
- package/dist/theme/components/tabs.d.ts +9 -9
- package/dist/theme/components/template.d.ts +7 -7
- package/dist/theme/components/text.d.ts +5 -1
- package/dist/theme/components/textInput.d.ts +4 -0
- package/dist/theme/components/toggle.d.ts +2 -2
- package/dist/theme/provider.d.ts +2 -1
- package/package.json +17 -17
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type GridGaps = "grid.xxs" | "grid.xs" | "grid.s" | "grid.m" | "grid.l" | "grid.xl" | "grid.xxl";
|
|
3
3
|
export interface SimpleGridProps {
|
|
4
4
|
/** Additional class name. */
|
|
@@ -13,5 +13,7 @@ export interface SimpleGridProps {
|
|
|
13
13
|
/** ID that other components can cross reference for accessibility purposes */
|
|
14
14
|
id?: string;
|
|
15
15
|
}
|
|
16
|
-
export declare const SimpleGrid: import("@chakra-ui/react").ChakraComponent<
|
|
16
|
+
export declare const SimpleGrid: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SimpleGridProps & {
|
|
17
|
+
children?: React.ReactNode;
|
|
18
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
17
19
|
export default SimpleGrid;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type HeadingSizes = "primary" | "secondary" | "tertiary" | "callout";
|
|
3
3
|
export declare type HeadingLevels = "one" | "two" | "three" | "four" | "five" | "six";
|
|
4
4
|
export interface HeadingProps {
|
|
@@ -6,6 +6,12 @@ export interface HeadingProps {
|
|
|
6
6
|
className?: string;
|
|
7
7
|
/** Optional ID that other components can cross reference for accessibility purposes */
|
|
8
8
|
id?: string;
|
|
9
|
+
/** Optional prop used to show capitalized text */
|
|
10
|
+
isCapitalized?: boolean;
|
|
11
|
+
/** Optional prop used to show upper case text */
|
|
12
|
+
isUppercase?: boolean;
|
|
13
|
+
/** Optional prop used to show lower case text */
|
|
14
|
+
isLowercase?: boolean;
|
|
9
15
|
/** Optional number 1-6 used to create the `<h*>` tag; if prop is not passed,
|
|
10
16
|
* `Heading` will default to `<h2>` */
|
|
11
17
|
level?: HeadingLevels;
|
|
@@ -23,5 +29,7 @@ export interface HeadingProps {
|
|
|
23
29
|
/** Optional className for the URL when the `url` prop is passed */
|
|
24
30
|
urlClass?: string;
|
|
25
31
|
}
|
|
26
|
-
export declare const Heading: import("@chakra-ui/react").ChakraComponent<
|
|
32
|
+
export declare const Heading: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HeadingProps & {
|
|
33
|
+
children?: React.ReactNode;
|
|
34
|
+
} & React.RefAttributes<HTMLHeadingElement>>, {}>;
|
|
27
35
|
export default Heading;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type AriaLiveValues = "assertive" | "off" | "polite";
|
|
3
3
|
export declare type HelperErrorTextType = string | JSX.Element;
|
|
4
4
|
interface HelperErrorTextProps {
|
|
@@ -25,5 +25,5 @@ interface HelperErrorTextProps {
|
|
|
25
25
|
/**
|
|
26
26
|
* Helper or error text for forms components.
|
|
27
27
|
*/
|
|
28
|
-
export declare const HelperErrorText: import("@chakra-ui/react").ChakraComponent<
|
|
28
|
+
export declare const HelperErrorText: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HelperErrorTextProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
29
29
|
export default HelperErrorText;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { ComponentImageProps } from "../Image/Image";
|
|
3
3
|
export declare type HeroTypes = "primary" | "secondary" | "secondaryBooksAndMore" | "secondaryLocations" | "secondaryResearch" | "secondaryWhatsOn" | "tertiary" | "campaign" | "fiftyFifty";
|
|
4
4
|
export declare const heroSecondaryTypes: string[];
|
|
@@ -36,5 +36,7 @@ export interface HeroProps {
|
|
|
36
36
|
* underneath the heading element. */
|
|
37
37
|
subHeaderText?: string | JSX.Element;
|
|
38
38
|
}
|
|
39
|
-
export declare const Hero: import("@chakra-ui/react").ChakraComponent<
|
|
39
|
+
export declare const Hero: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HeroProps & {
|
|
40
|
+
children?: React.ReactNode;
|
|
41
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
40
42
|
export default Hero;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import React from "react";
|
|
2
2
|
export interface HorizontalRuleProps {
|
|
3
3
|
/** Optional alignment value to align the horizontal rule to one side or the
|
|
4
4
|
* other when the width is less than 100%. If omitted, the horizontal rule
|
|
@@ -7,5 +7,5 @@ export interface HorizontalRuleProps {
|
|
|
7
7
|
/** ClassName you can add in addition to `horizontal-rule` */
|
|
8
8
|
className?: string;
|
|
9
9
|
}
|
|
10
|
-
export declare const HorizontalRule: import("@chakra-ui/react").ChakraComponent<
|
|
10
|
+
export declare const HorizontalRule: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<HorizontalRuleProps & React.RefAttributes<HTMLDivElement & HTMLHRElement>>, {}>;
|
|
11
11
|
export default HorizontalRule;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type IconAlign = "left" | "right" | "none";
|
|
3
3
|
export declare type IconColors = "ui.black" | "ui.white" | "brand.primary" | "brand.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";
|
|
4
|
-
export declare type IconNames = "accessibilityFull" | "accessibilityPartial" | "actionCheckCircle" | "actionHelpDefault" | "actionHelpOutline" | "actionLaunch" | "alertNotificationImportant" | "arrow" | "check" | "clock" | "close" | "download" | "errorFilled" | "errorOutline" | "fileTypeAudio" | "fileTypeDoc" | "fileTypeGenericDoc" | "fileTypeImage" | "fileTypePdf" | "fileTypeSpreadsheet" | "fileTypeVideo" | "headset" | "minus" | "plus" | "search" | "speakerNotes" | "utilityAccountFilled" | "utilityAccountUnfilled" | "utilityHamburger" | "utilitySearch";
|
|
4
|
+
export declare type IconNames = "accessibilityFull" | "accessibilityPartial" | "actionCheckCircle" | "actionCheckCircleFilled" | "actionExit" | "actionHelpDefault" | "actionHelpOutline" | "actionLaunch" | "actionPower" | "actionRegistration" | "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" | "minus" | "plus" | "search" | "socialFacebook" | "socialInstagram" | "socialTumblr" | "socialTwitter" | "socialYoutube" | "speakerNotes" | "utilityAccountFilled" | "utilityAccountUnfilled" | "utilityHamburger" | "utilitySearch";
|
|
5
5
|
export declare type IconRotationTypes = "rotate0" | "rotate90" | "rotate180" | "rotate270";
|
|
6
6
|
export declare type IconSizes = "default" | "small" | "medium" | "large" | "xlarge" | "xxlarge" | "xxxlarge";
|
|
7
7
|
export declare type IconTypes = "default" | "breadcrumbs";
|
|
@@ -33,5 +33,7 @@ export interface IconProps {
|
|
|
33
33
|
/**
|
|
34
34
|
* Renders SVG-based icons.
|
|
35
35
|
*/
|
|
36
|
-
export declare const Icon: import("@chakra-ui/react").ChakraComponent<
|
|
36
|
+
export declare const Icon: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<IconProps & {
|
|
37
|
+
children?: React.ReactNode;
|
|
38
|
+
} & React.RefAttributes<HTMLDivElement & SVGSVGElement>>, {}>;
|
|
37
39
|
export default Icon;
|
|
@@ -2,14 +2,25 @@ declare const _default: {
|
|
|
2
2
|
accessibilityFull: string;
|
|
3
3
|
accessibilityPartial: string;
|
|
4
4
|
actionCheckCircle: string;
|
|
5
|
+
actionCheckCircleFilled: string;
|
|
6
|
+
actionExit: string;
|
|
5
7
|
actionHelpDefault: string;
|
|
6
8
|
actionHelpOutline: string;
|
|
7
9
|
actionLaunch: string;
|
|
10
|
+
actionPower: string;
|
|
11
|
+
actionRegistration: string;
|
|
12
|
+
actionSettings: string;
|
|
8
13
|
alertNotificationImportant: string;
|
|
14
|
+
alertWarningFilled: string;
|
|
15
|
+
alertWarningOutline: string;
|
|
9
16
|
arrow: string;
|
|
17
|
+
building: string;
|
|
10
18
|
check: string;
|
|
11
19
|
clock: string;
|
|
12
20
|
close: string;
|
|
21
|
+
decorativeEnvelope: string;
|
|
22
|
+
decorativeLibraryCard: string;
|
|
23
|
+
decorativeShoppingBag: string;
|
|
13
24
|
download: string;
|
|
14
25
|
errorFilled: string;
|
|
15
26
|
errorOutline: string;
|
|
@@ -21,9 +32,21 @@ declare const _default: {
|
|
|
21
32
|
fileTypeSpreadsheet: string;
|
|
22
33
|
fileTypeVideo: string;
|
|
23
34
|
headset: string;
|
|
35
|
+
legacyAccountFilled: string;
|
|
36
|
+
legacyAccountUnfilled: string;
|
|
37
|
+
legacySocialFacebook: string;
|
|
38
|
+
legacySocialInstagram: string;
|
|
39
|
+
legacySocialTwitter: string;
|
|
40
|
+
legacySocialYoutube: string;
|
|
41
|
+
locator: string;
|
|
24
42
|
minus: string;
|
|
25
43
|
plus: string;
|
|
26
44
|
search: string;
|
|
45
|
+
socialFacebook: string;
|
|
46
|
+
socialInstagram: string;
|
|
47
|
+
socialTumblr: string;
|
|
48
|
+
socialTwitter: string;
|
|
49
|
+
socialYoutube: string;
|
|
27
50
|
speakerNotes: string;
|
|
28
51
|
utilityAccountFilled: string;
|
|
29
52
|
utilityAccountUnfilled: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type ImageRatios = "fourByThree" | "oneByTwo" | "original" | "sixteenByNine" | "square" | "threeByFour" | "threeByTwo" | "twoByOne";
|
|
3
3
|
export declare type ImageSizes = "default" | "xxsmall" | "xsmall" | "small" | "medium" | "large";
|
|
4
4
|
export declare type ImageTypes = "default" | "circle";
|
|
@@ -15,6 +15,8 @@ export interface ComponentImageProps {
|
|
|
15
15
|
component?: JSX.Element;
|
|
16
16
|
/** Optional value to render as a credit for the internal `Image` component. */
|
|
17
17
|
credit?: string;
|
|
18
|
+
/** Flag to set the internal `Image` component to `isLazy` mode. */
|
|
19
|
+
isLazy?: boolean;
|
|
18
20
|
/** Optional value to control the size of the internal `Image` component.
|
|
19
21
|
* Defaults to `ImageSizes.Default`. */
|
|
20
22
|
size?: ImageSizes;
|
|
@@ -54,8 +56,10 @@ export interface ImageProps extends ImageWrapperProps {
|
|
|
54
56
|
credit?: string;
|
|
55
57
|
/** Optional value for the image type */
|
|
56
58
|
imageType?: ImageTypes;
|
|
59
|
+
/** Flag to set the internal `Image` component to `isLazy` mode. */
|
|
60
|
+
isLazy?: boolean;
|
|
57
61
|
/** The src attribute is required, and contains the path to the image you want to embed. */
|
|
58
62
|
src?: string;
|
|
59
63
|
}
|
|
60
|
-
export declare const Image: import("@chakra-ui/react").ChakraComponent<
|
|
64
|
+
export declare const Image: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<ImageProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
61
65
|
export default Image;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
interface LabelProps {
|
|
3
3
|
/** Additional CSS class name to render in the `label` element. */
|
|
4
4
|
className?: string;
|
|
@@ -16,5 +16,7 @@ interface LabelProps {
|
|
|
16
16
|
/**
|
|
17
17
|
* A label for form inputs. It should never be used alone.
|
|
18
18
|
*/
|
|
19
|
-
export declare const Label: import("@chakra-ui/react").ChakraComponent<
|
|
19
|
+
export declare const Label: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LabelProps & {
|
|
20
|
+
children?: React.ReactNode;
|
|
21
|
+
} & React.RefAttributes<HTMLDivElement & HTMLLabelElement>>, {}>;
|
|
20
22
|
export default Label;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type LinkTypes = "action" | "backwards" | "button" | "default" | "external" | "forwards";
|
|
3
3
|
export interface LinkProps {
|
|
4
4
|
/** Any child node passed to the component. */
|
|
@@ -16,5 +16,5 @@ export interface LinkProps {
|
|
|
16
16
|
* A component that uses an `href` prop or a child anchor element, to create
|
|
17
17
|
* an anchor element with added styling and conventions.
|
|
18
18
|
*/
|
|
19
|
-
export declare const Link: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement>>, {}>;
|
|
19
|
+
export declare const Link: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLDivElement & HTMLAnchorElement>>, {}>;
|
|
20
20
|
export default Link;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type ListTypes = "ol" | "ul" | "dl";
|
|
3
3
|
interface DescriptionProps {
|
|
4
4
|
term: string;
|
|
@@ -31,5 +31,7 @@ export interface ListProps {
|
|
|
31
31
|
* and `dd` elements based on the `type` prop. Note that the `title` prop will
|
|
32
32
|
* only display for the `Description` list type.
|
|
33
33
|
*/
|
|
34
|
-
export declare const List: import("@chakra-ui/react").ChakraComponent<
|
|
34
|
+
export declare const List: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<ListProps & {
|
|
35
|
+
children?: React.ReactNode;
|
|
36
|
+
} & React.RefAttributes<HTMLDivElement & HTMLUListElement & HTMLOListElement>>, {}>;
|
|
35
37
|
export default List;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import
|
|
2
|
-
export declare type LogoNames = "appleAppStoreBlack" | "appleAppStoreWhite" | "bplBlack" | "bplWhite" | "cleverBadgeColor" | "cleverColor" | "cleverWhite" | "firstbookColor" | "firstbookColorNegative" | "googlePlayBlack" | "lpaBlack" | "lpaColor" | "lpaWhite" | "mlnBlack" | "mlnWhite" | "nyplFullBlack" | "nyplFullWhite" | "nyplLionBlack" | "nyplLionWhite" | "nyplTextBlack" | "nyplTextWhite" | "openebooksColor" | "openebooksNegative" | "openebooksWithTextColor" | "openebooksWithTextNegative" | "qplAltBlack" | "qplAltWhite" | "qplBlack" | "qplColor" | "qplWhite" | "reservoirIconColor" | "reservoirVerticalColor" | "schomburgBlack" | "schomburgCircleBlack" | "schomburgCircleColor" | "schomburgCircleWhite" | "schomburgColor" | "schomburgWhite" | "simplyeBlack" | "simplyeWhite" | "simplyeColor" | "snflBlack" | "snflWhite" | "treasuresColor" | "treasuresColorNegative";
|
|
1
|
+
import React from "react";
|
|
2
|
+
export declare type LogoNames = "appleAppStoreBlack" | "appleAppStoreWhite" | "bplBlack" | "bplWhite" | "cleverBadgeColor" | "cleverColor" | "cleverWhite" | "firstbookColor" | "firstbookColorNegative" | "googlePlayBlack" | "lpaBlack" | "lpaColor" | "lpaWhite" | "mlnBlack" | "mlnColor" | "mlnWhite" | "nyplFullBlack" | "nyplFullWhite" | "nyplLionBlack" | "nyplLionWhite" | "nyplTextBlack" | "nyplTextWhite" | "openebooksColor" | "openebooksNegative" | "openebooksWithTextColor" | "openebooksWithTextNegative" | "qplAltBlack" | "qplAltWhite" | "qplBlack" | "qplColor" | "qplWhite" | "reservoirIconColor" | "reservoirVerticalColor" | "schomburgBlack" | "schomburgCircleBlack" | "schomburgCircleColor" | "schomburgCircleWhite" | "schomburgColor" | "schomburgWhite" | "simplyeBlack" | "simplyeWhite" | "simplyeColor" | "snflBlack" | "snflWhite" | "treasuresColor" | "treasuresColorNegative";
|
|
3
3
|
export declare type LogoSizes = "default" | "xxsmall" | "xsmall" | "small" | "medium" | "large";
|
|
4
4
|
export interface LogoProps {
|
|
5
5
|
/** Optional className that will be added to the parent element */
|
|
@@ -22,5 +22,7 @@ export interface LogoProps {
|
|
|
22
22
|
* The `Logo` component renders SVG-based logos and color variants that are
|
|
23
23
|
* commonly used by the New York Public Library.
|
|
24
24
|
*/
|
|
25
|
-
export declare const Logo: import("@chakra-ui/react").ChakraComponent<
|
|
25
|
+
export declare const Logo: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<LogoProps & {
|
|
26
|
+
children?: React.ReactNode;
|
|
27
|
+
} & React.RefAttributes<HTMLDivElement & SVGSVGElement>>, {}>;
|
|
26
28
|
export default Logo;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
interface BaseModalProps {
|
|
3
3
|
bodyContent?: string | JSX.Element;
|
|
4
4
|
closeButtonLabel?: string;
|
|
@@ -19,7 +19,9 @@ export interface ModalProps {
|
|
|
19
19
|
* internal `Modal` component. Note that props to update the internal `Modal`
|
|
20
20
|
* component are passed through to the `modalProps` prop.
|
|
21
21
|
*/
|
|
22
|
-
export declare const ModalTrigger: import("@chakra-ui/react").ChakraComponent<
|
|
22
|
+
export declare const ModalTrigger: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<ModalProps & {
|
|
23
|
+
children?: React.ReactNode;
|
|
24
|
+
} & React.RefAttributes<HTMLButtonElement>>, {}>;
|
|
23
25
|
/**
|
|
24
26
|
* This hook function can be used to render the `Modal` component with a custom
|
|
25
27
|
* open button(s) and optional custom close button(s). You must render your own
|
|
@@ -46,5 +46,5 @@ export declare const NotificationContent: import("@chakra-ui/react").ChakraCompo
|
|
|
46
46
|
* Component used to present users with three different levels of notifications:
|
|
47
47
|
* standard, announcement, and warning.
|
|
48
48
|
*/
|
|
49
|
-
export declare const Notification: import("@chakra-ui/react").ChakraComponent<
|
|
49
|
+
export declare const Notification: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<NotificationProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
50
50
|
export default Notification;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import React from "react";
|
|
2
2
|
export interface PaginationProps {
|
|
3
3
|
/** Additional className. */
|
|
4
4
|
className?: string;
|
|
@@ -23,5 +23,5 @@ export interface PaginationProps {
|
|
|
23
23
|
/**
|
|
24
24
|
* A component that provides a navigational list of page items.
|
|
25
25
|
*/
|
|
26
|
-
export declare const Pagination: import("@chakra-ui/react").ChakraComponent<
|
|
26
|
+
export declare const Pagination: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<PaginationProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
27
27
|
export default Pagination;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type ProgressIndicatorSizes = "default" | "small";
|
|
3
3
|
export declare type ProgressIndicatorTypes = "circular" | "linear";
|
|
4
4
|
export interface ProgressIndicatorProps {
|
|
@@ -26,5 +26,5 @@ export interface ProgressIndicatorProps {
|
|
|
26
26
|
* time to complete or consists of multiple steps. Examples include downloading,
|
|
27
27
|
* uploading, or processing.
|
|
28
28
|
*/
|
|
29
|
-
export declare const ProgressIndicator: import("@chakra-ui/react").ChakraComponent<
|
|
29
|
+
export declare const ProgressIndicator: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<ProgressIndicatorProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
30
30
|
export default ProgressIndicator;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
3
|
import { LayoutTypes } from "../../helpers/types";
|
|
4
4
|
export interface RadioGroupProps {
|
|
@@ -47,5 +47,5 @@ export interface RadioGroupProps {
|
|
|
47
47
|
*/
|
|
48
48
|
export declare const RadioGroup: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<RadioGroupProps & {
|
|
49
49
|
children?: React.ReactNode;
|
|
50
|
-
} & React.RefAttributes<
|
|
50
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
51
51
|
export default RadioGroup;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
3
|
interface BaseProps {
|
|
4
4
|
labelText: string;
|
|
@@ -57,5 +57,5 @@ export interface SearchBarProps {
|
|
|
57
57
|
* Renders a wrapper `form` element to be used with `Select` (optional),
|
|
58
58
|
* `Input`, and `Button` components together.
|
|
59
59
|
*/
|
|
60
|
-
export declare const SearchBar: import("@chakra-ui/react").ChakraComponent<
|
|
60
|
+
export declare const SearchBar: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SearchBarProps & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
61
61
|
export default SearchBar;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { LayoutTypes } from "../../helpers/types";
|
|
3
3
|
export declare type SkeletonLoaderImageRatios = "landscape" | "portrait" | "square";
|
|
4
4
|
export interface SkeletonLoaderProps {
|
|
@@ -35,5 +35,7 @@ export interface SkeletonLoaderProps {
|
|
|
35
35
|
* The `SkeletonLoader` component renders a placeholder to be used while
|
|
36
36
|
* dynamic content is loading.
|
|
37
37
|
*/
|
|
38
|
-
export declare const SkeletonLoader: import("@chakra-ui/react").ChakraComponent<
|
|
38
|
+
export declare const SkeletonLoader: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SkeletonLoaderProps & {
|
|
39
|
+
children?: React.ReactNode;
|
|
40
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
39
41
|
export default SkeletonLoader;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
interface SkipNavigationProps {
|
|
3
3
|
/** Additional CSS class name to render in the `nav` element. */
|
|
4
4
|
className?: string;
|
|
@@ -13,5 +13,7 @@ interface SkipNavigationProps {
|
|
|
13
13
|
* the `#mainContent` id, and the second link points to accessibility information
|
|
14
14
|
* on NYPL.org. These links are visually hidden but can be read by screenreaders.
|
|
15
15
|
*/
|
|
16
|
-
export declare const SkipNavigation: import("@chakra-ui/react").ChakraComponent<
|
|
16
|
+
export declare const SkipNavigation: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SkipNavigationProps & {
|
|
17
|
+
children?: React.ReactNode;
|
|
18
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
17
19
|
export default SkipNavigation;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
3
|
export interface SliderProps {
|
|
4
4
|
/** Additional class name for the Slider component. */
|
|
@@ -55,5 +55,7 @@ export interface SliderProps {
|
|
|
55
55
|
* with a min and max value. The value(s) can be updated through the slider
|
|
56
56
|
* thumb(s) or through the text input(s) elements.
|
|
57
57
|
*/
|
|
58
|
-
export declare const Slider: import("@chakra-ui/react").ChakraComponent<
|
|
58
|
+
export declare const Slider: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SliderProps & {
|
|
59
|
+
children?: React.ReactNode;
|
|
60
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
59
61
|
export default Slider;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type StatusBadgeTypes = "low" | "medium" | "high";
|
|
3
3
|
export interface StatusBadgeProps {
|
|
4
4
|
/** Additional class for the component */
|
|
@@ -12,5 +12,7 @@ export interface StatusBadgeProps {
|
|
|
12
12
|
* The `StatusBadge` component is used to display a visual badge for three
|
|
13
13
|
* different status levels.
|
|
14
14
|
*/
|
|
15
|
-
export declare const StatusBadge: import("@chakra-ui/react").ChakraComponent<
|
|
15
|
+
export declare const StatusBadge: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<StatusBadgeProps & {
|
|
16
|
+
children?: React.ReactNode;
|
|
17
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
16
18
|
export default StatusBadge;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { ComponentImageProps } from "../Image/Image";
|
|
3
3
|
export declare type StructuredContentImagePosition = "left" | "right" | "center";
|
|
4
4
|
interface StructuredContentImageProps extends ComponentImageProps {
|
|
@@ -24,5 +24,7 @@ export interface StructuredContentProps {
|
|
|
24
24
|
* The `StructuredContent` component that displays a heading, callout content,
|
|
25
25
|
* an image, and body content. All are optional except for body content.
|
|
26
26
|
*/
|
|
27
|
-
export declare const StructuredContent: import("@chakra-ui/react").ChakraComponent<
|
|
27
|
+
export declare const StructuredContent: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<StructuredContentProps & {
|
|
28
|
+
children?: React.ReactNode;
|
|
29
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
28
30
|
export default StructuredContent;
|
|
@@ -1,12 +1,30 @@
|
|
|
1
1
|
import * as React from "react";
|
|
2
2
|
export interface ColorCardProps {
|
|
3
|
-
/** backgroundColor of the color card */
|
|
3
|
+
/** The backgroundColor of the color card. */
|
|
4
4
|
backgroundColor: string;
|
|
5
|
-
/** name of
|
|
5
|
+
/** The name of a color's javascript theme object. */
|
|
6
6
|
colorName: string;
|
|
7
|
+
/** The name of the color that the current color is based on. */
|
|
8
|
+
colorSource: string;
|
|
9
|
+
/** Contrast and WCAG compliance data related to the color black when used
|
|
10
|
+
* with the current color. */
|
|
11
|
+
dataBlack: string[];
|
|
12
|
+
/** Contrast and WCAG compliance data related to the color white when used
|
|
13
|
+
* with the current color. */
|
|
14
|
+
dataWhite: string[];
|
|
15
|
+
/** The color to use for text in the color card. */
|
|
16
|
+
textColor: string;
|
|
7
17
|
}
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
18
|
+
export interface DataTableProps {
|
|
19
|
+
/** Contrast and WCAG compliance data related to the color black when used
|
|
20
|
+
* with the current color. */
|
|
21
|
+
dataBlack: string[];
|
|
22
|
+
/** Contrast and WCAG compliance data related to the color white when used
|
|
23
|
+
* with the current color. */
|
|
24
|
+
dataWhite: string[];
|
|
25
|
+
/** color to use for text in color card */
|
|
26
|
+
textColor: string;
|
|
27
|
+
}
|
|
28
|
+
export declare const DataTable: (props: React.PropsWithChildren<DataTableProps>) => JSX.Element;
|
|
29
|
+
export declare const ColorCard: (props: React.PropsWithChildren<ColorCardProps>) => JSX.Element;
|
|
30
|
+
export default ColorCard;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export interface TableProps {
|
|
3
3
|
/** Additional class name for the `Table` component. */
|
|
4
4
|
className?: string;
|
|
@@ -26,5 +26,7 @@ export interface TableProps {
|
|
|
26
26
|
* Basic `Table` component used to organize and display tabular data in
|
|
27
27
|
* rows and columns.
|
|
28
28
|
*/
|
|
29
|
-
export declare const Table: import("@chakra-ui/react").ChakraComponent<
|
|
29
|
+
export declare const Table: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<TableProps & {
|
|
30
|
+
children?: React.ReactNode;
|
|
31
|
+
} & React.RefAttributes<HTMLTableElement>>, {}>;
|
|
30
32
|
export default Table;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Tab, TabList, TabPanels, TabPanel } from "@chakra-ui/react";
|
|
2
|
-
import
|
|
2
|
+
import React from "react";
|
|
3
3
|
export interface TabsDataProps {
|
|
4
4
|
label: string;
|
|
5
5
|
content: string | React.ReactNode;
|
|
@@ -21,6 +21,8 @@ export interface TabsProps {
|
|
|
21
21
|
* Renders Chakra's `Tab` component with specific variants, props,
|
|
22
22
|
* and controlled styling.
|
|
23
23
|
*/
|
|
24
|
-
export declare const Tabs: import("@chakra-ui/react").ChakraComponent<
|
|
24
|
+
export declare const Tabs: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<TabsProps & {
|
|
25
|
+
children?: React.ReactNode;
|
|
26
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
25
27
|
export { TabList, Tab, TabPanels, TabPanel };
|
|
26
28
|
export default Tabs;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export interface TemplateProps {
|
|
3
3
|
}
|
|
4
4
|
export interface TemplateHeaderProps {
|
|
@@ -45,7 +45,9 @@ export interface TemplateAppContainerProps extends TemplateFooterProps, Template
|
|
|
45
45
|
* The main top-level parent component that wraps all template-related
|
|
46
46
|
* components.
|
|
47
47
|
*/
|
|
48
|
-
declare const Template: import("@chakra-ui/react").ChakraComponent<
|
|
48
|
+
declare const Template: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<TemplateProps & {
|
|
49
|
+
children?: React.ReactNode;
|
|
50
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
49
51
|
/**
|
|
50
52
|
* This optional component renders its children from edge-to-edge and should
|
|
51
53
|
* be used for alerts or notifications that are typically site-wide. This must
|
|
@@ -121,6 +123,8 @@ declare const TemplateFooter: ({ children, renderFooterElement, }: React.PropsWi
|
|
|
121
123
|
* be rendered. For example, if you want to render content in the
|
|
122
124
|
* `TemplateContentPrimary` section, then pass it as a prop to `contentPrimary`.
|
|
123
125
|
*/
|
|
124
|
-
export declare const TemplateAppContainer: import("@chakra-ui/react").ChakraComponent<
|
|
126
|
+
export declare const TemplateAppContainer: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<TemplateAppContainerProps & {
|
|
127
|
+
children?: React.ReactNode;
|
|
128
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
125
129
|
export { Template, TemplateAboveHeader, TemplateHeader, TemplateBreakout, TemplateContent, TemplateContentTop, TemplateContentPrimary, TemplateContentSidebar, TemplateFooter, };
|
|
126
130
|
export default TemplateAppContainer;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
export declare type TextSizes = "default" | "caption" | "tag" | "mini";
|
|
3
3
|
export interface TextProps {
|
|
4
4
|
/** Additional class name to render in the `Text` component. */
|
|
@@ -7,10 +7,18 @@ export interface TextProps {
|
|
|
7
7
|
isBold?: boolean;
|
|
8
8
|
/** Optional prop used to show itlicized text */
|
|
9
9
|
isItalic?: boolean;
|
|
10
|
+
/** Optional prop used to show capitalized text */
|
|
11
|
+
isCapitalized?: boolean;
|
|
12
|
+
/** Optional prop used to show upper case text */
|
|
13
|
+
isUppercase?: boolean;
|
|
14
|
+
/** Optional prop used to show lower case text */
|
|
15
|
+
isLowercase?: boolean;
|
|
10
16
|
/** Optional prop used to remove default spacing */
|
|
11
17
|
noSpace?: boolean;
|
|
12
18
|
/** Optional prop to control the text styling */
|
|
13
19
|
size?: TextSizes;
|
|
14
20
|
}
|
|
15
|
-
export declare const Text: import("@chakra-ui/react").ChakraComponent<
|
|
21
|
+
export declare const Text: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<TextProps & {
|
|
22
|
+
children?: React.ReactNode;
|
|
23
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
16
24
|
export default Text;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
3
|
export declare type TextInputTypes = "email" | "hidden" | "number" | "password" | "text" | "textarea" | "tel" | "url";
|
|
4
4
|
export declare const TextInputFormats: {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import React from "react";
|
|
2
2
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
3
3
|
export declare type VideoPlayerTypes = "vimeo" | "youtube";
|
|
4
4
|
export declare type VideoPlayerAspectRatios = "fourByThree" | "sixteenByNine" | "square";
|
|
@@ -34,5 +34,7 @@ export interface VideoPlayerProps {
|
|
|
34
34
|
/** Required. Used to specify which video service is being used. */
|
|
35
35
|
videoType?: VideoPlayerTypes;
|
|
36
36
|
}
|
|
37
|
-
export declare const VideoPlayer: import("@chakra-ui/react").ChakraComponent<
|
|
37
|
+
export declare const VideoPlayer: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<VideoPlayerProps & {
|
|
38
|
+
children?: React.ReactNode;
|
|
39
|
+
} & React.RefAttributes<HTMLDivElement>>, {}>;
|
|
38
40
|
export default VideoPlayer;
|