@nypl/design-system-react-components 4.0.0-alpha-rc → 4.0.0-alpha-rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/design-system-react-components.cjs +37 -37
- package/dist/design-system-react-components.js +4389 -4410
- package/dist/src/components/Accordion/Accordion.d.ts +4 -3
- package/dist/src/components/Banner/Banner.d.ts +2 -2
- package/dist/src/components/Breadcrumbs/Breadcrumbs.d.ts +4 -4
- package/dist/src/components/Button/Button.d.ts +5 -4
- package/dist/src/components/Hero/Hero.d.ts +7 -7
- package/dist/src/components/Icons/Icon.d.ts +3 -3
- package/dist/src/components/Icons/iconVariables.d.ts +1 -1
- package/dist/src/components/Link/Link.d.ts +3 -3
- package/dist/src/components/List/List.d.ts +5 -5
- package/dist/src/components/Modal/Modal.d.ts +3 -3
- package/dist/src/components/Notification/Notification.d.ts +3 -3
- package/dist/src/components/Select/Select.d.ts +4 -4
- package/dist/src/components/StatusBadge/StatusBadge.d.ts +2 -2
- package/dist/src/components/Table/Table.d.ts +0 -6
- package/dist/src/components/TagSet/TagSet.d.ts +1 -1
- package/dist/src/components/TagSet/TagSetExplore.d.ts +1 -1
- package/dist/src/components/TagSet/TagSetFilter.d.ts +1 -1
- package/dist/src/components/TextInput/TextInput.d.ts +1 -1
- package/dist/src/index.d.ts +12 -12
- package/dist/src/theme/components/notification.d.ts +3 -3
- package/dist/src/theme/components/notificationContent.d.ts +3 -3
- package/dist/src/theme/components/notificationHeading.d.ts +3 -3
- package/dist/src/theme/components/structuredContent.d.ts +0 -1
- package/dist/src/theme/components/table.d.ts +7 -13
- package/package.json +1 -1
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export
|
|
3
|
+
export declare const accordionVariantsArray: readonly ["default", "warning", "error"];
|
|
4
|
+
export type AccordionVariants = typeof accordionVariantsArray[number];
|
|
4
5
|
export interface AccordionDataProps {
|
|
5
|
-
|
|
6
|
+
variant?: AccordionVariants;
|
|
6
7
|
ariaLabel?: string;
|
|
7
8
|
/** Ref to the DOM element of the AccordionButton. */
|
|
8
9
|
buttonInteractionRef?: any;
|
|
@@ -10,7 +11,7 @@ export interface AccordionDataProps {
|
|
|
10
11
|
panel: string | React.ReactNode;
|
|
11
12
|
}
|
|
12
13
|
export interface AccordionProps extends Omit<BoxProps, "onChange"> {
|
|
13
|
-
/** Array of data to display, and an optional
|
|
14
|
+
/** Array of data to display, and an optional variant */
|
|
14
15
|
accordionData: AccordionDataProps[];
|
|
15
16
|
/** ID that other components can cross reference for accessibility purposes */
|
|
16
17
|
id?: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { messageVariantsArray, bgColorsArray, highlightColorsArray } from "../../theme/sharedTypes";
|
|
4
|
-
export type
|
|
4
|
+
export type BannerVariants = typeof messageVariantsArray[number];
|
|
5
5
|
export type BannerBgColors = typeof bgColorsArray[number];
|
|
6
6
|
export type BannerHighlightColors = typeof highlightColorsArray[number];
|
|
7
7
|
export interface BannerProps extends Omit<BoxProps, "content"> {
|
|
@@ -25,7 +25,7 @@ export interface BannerProps extends Omit<BoxProps, "content"> {
|
|
|
25
25
|
* (closed) by a user. */
|
|
26
26
|
isDismissible?: boolean;
|
|
27
27
|
/** Used to control the component's semantic coloring and iconography. */
|
|
28
|
-
|
|
28
|
+
variant?: BannerVariants;
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
31
|
* The `Banner` component is a non-modal semantic dialog used to communicate a
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
3
|
+
export declare const breadcrumbVariantsArray: readonly ["blogs", "booksAndMore", "brand", "connect", "digitalCollections", "education", "locations", "research", "whatsOn"];
|
|
4
|
+
export type BreadcrumbsVariants = typeof breadcrumbVariantsArray[number];
|
|
5
5
|
export interface BreadcrumbsDataProps {
|
|
6
6
|
url: string;
|
|
7
7
|
text: string | React.ReactNode;
|
|
@@ -10,8 +10,8 @@ export interface BreadcrumbsDataProps {
|
|
|
10
10
|
export interface BreadcrumbProps extends BoxProps {
|
|
11
11
|
/** Breadcrumb links as an array */
|
|
12
12
|
breadcrumbsData: BreadcrumbsDataProps[];
|
|
13
|
-
/** Used to control how the `
|
|
14
|
-
|
|
13
|
+
/** Used to control how the `Breadcrumbs` component will be rendered. */
|
|
14
|
+
variant?: BreadcrumbsVariants;
|
|
15
15
|
/** ID that other components can cross reference for accessibility purposes */
|
|
16
16
|
id?: string;
|
|
17
17
|
/** Custom Link component for apps with internal routing, defaults to BreadcrumbLink if not passed */
|
|
@@ -2,13 +2,14 @@ import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
|
2
2
|
import { sizesArray } from "../../theme/sharedTypes";
|
|
3
3
|
import React, { ButtonHTMLAttributes } from "react";
|
|
4
4
|
export declare const buttonElementTypeArray: readonly ["submit", "button", "reset"];
|
|
5
|
-
export declare const
|
|
5
|
+
export declare const buttonSizesArray: readonly ["small", "medium", "large"];
|
|
6
|
+
export declare const buttonVariantsArray: readonly ["primary", "secondary", "text", "callout", "pill", "noBrand"];
|
|
6
7
|
export type ButtonElementType = typeof buttonElementTypeArray[number];
|
|
8
|
+
export type ButtonVariants = typeof buttonVariantsArray[number];
|
|
7
9
|
export type ButtonSizes = typeof sizesArray[number];
|
|
8
|
-
export type ButtonTypes = typeof buttonTypesArray[number];
|
|
9
10
|
export interface ButtonProps extends Pick<BoxProps, keyof ChakraProps>, Omit<ButtonHTMLAttributes<HTMLButtonElement>, "color"> {
|
|
10
|
-
/** The button variation to render based on the `
|
|
11
|
-
|
|
11
|
+
/** The button variation to render based on the `ButtonVariants` type. */
|
|
12
|
+
variant?: ButtonVariants;
|
|
12
13
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
13
14
|
id: string;
|
|
14
15
|
/** Adds 'disabled' property to the button. */
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { ComponentImageProps } from "../Image/Image";
|
|
4
|
-
export declare const
|
|
5
|
-
export type
|
|
4
|
+
export declare const heroVariantsArray: readonly ["primary", "tertiary", "campaign"];
|
|
5
|
+
export type HeroVariants = typeof heroVariantsArray[number];
|
|
6
6
|
export interface HeroImageProps extends Omit<BoxProps, "onError">, Pick<ComponentImageProps, "alt" | "fallbackSrc" | "id" | "src" | "onError" | "component"> {
|
|
7
7
|
}
|
|
8
8
|
export interface HeroProps {
|
|
@@ -13,21 +13,21 @@ export interface HeroProps {
|
|
|
13
13
|
*/
|
|
14
14
|
backdropBackgroundColor?: string;
|
|
15
15
|
/** Optional hex color value used to override the default background
|
|
16
|
-
* color for a given `Hero`
|
|
17
|
-
* Note: not all `Hero`
|
|
16
|
+
* color for a given `Hero` variant.
|
|
17
|
+
* Note: not all `Hero` variants utilize this prop. */
|
|
18
18
|
backgroundColor?: string;
|
|
19
19
|
/** Optional path to an image that will be used as a background image for the
|
|
20
20
|
* `Hero` component.
|
|
21
|
-
* Note: not all `Hero`
|
|
21
|
+
* Note: not all `Hero` variants utilize this prop. */
|
|
22
22
|
backgroundImageSrc?: string;
|
|
23
23
|
/** Optional hex color value used to override the default text color for a
|
|
24
24
|
* given `Hero` variation.
|
|
25
|
-
* Note: not all `Hero`
|
|
25
|
+
* Note: not all `Hero` variants utilize this prop. */
|
|
26
26
|
foregroundColor?: string;
|
|
27
27
|
/** Optional heading element. */
|
|
28
28
|
heading?: JSX.Element;
|
|
29
29
|
/** Used to control how the `Hero` component will be rendered. */
|
|
30
|
-
|
|
30
|
+
variant?: HeroVariants;
|
|
31
31
|
/** ID that other components can cross reference for accessibility purposes. */
|
|
32
32
|
id?: string;
|
|
33
33
|
/** Object used to create and render the `Image` component. You can pass `component`
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { BoxProps, ChakraProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
import { iconAlignArray, iconColorsArray, iconNamesArray, iconRotationsArray, iconSizesArray,
|
|
3
|
+
import { iconAlignArray, iconColorsArray, iconNamesArray, iconRotationsArray, iconSizesArray, iconVariantsArray } from "./iconVariables";
|
|
4
4
|
export type IconAlign = typeof iconAlignArray[number];
|
|
5
5
|
export type IconColors = typeof iconColorsArray[number];
|
|
6
6
|
export type IconNames = typeof iconNamesArray[number];
|
|
7
7
|
export type IconRotations = typeof iconRotationsArray[number];
|
|
8
8
|
export type IconSizes = typeof iconSizesArray[number];
|
|
9
|
-
export type
|
|
9
|
+
export type IconVariants = typeof iconVariantsArray[number];
|
|
10
10
|
export interface IconProps extends Pick<BoxProps, "className" | keyof ChakraProps> {
|
|
11
11
|
/** Aligns the icon. */
|
|
12
12
|
align?: IconAlign;
|
|
@@ -28,7 +28,7 @@ export interface IconProps extends Pick<BoxProps, "className" | keyof ChakraProp
|
|
|
28
28
|
* visible but is needed for screenreaders to describe the graphic. */
|
|
29
29
|
title?: string;
|
|
30
30
|
/** FOR INTERNAL DS USE ONLY: the icon variant to display. */
|
|
31
|
-
|
|
31
|
+
variant?: IconVariants;
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
34
|
* Renders SVG-based icons.
|
|
@@ -3,4 +3,4 @@ export declare const iconColorsArray: readonly ["currentColor", "transparent", "
|
|
|
3
3
|
export declare const iconNamesArray: readonly ["accessibilityFull", "accessibilityPartial", "actionCheckCircle", "actionCheckCircleFilled", "actionDelete", "actionExit", "actionHelpDefault", "actionHelpOutline", "actionHome", "actionIdentity", "actionIdentityFilled", "actionLaunch", "actionLightbulb", "actionLockClosed", "actionPayment", "actionPower", "actionRegistration", "actionSearch", "actionSettings", "alertNotificationImportant", "alertWarningFilled", "alertWarningOutline", "arrow", "building", "check", "clock", "close", "communicationCall", "communicationChatBubble", "communicationEmail", "contentFilterList", "decorativeBookBroken", "decorativeEnvelope", "decorativeLibraryCard", "decorativeShoppingBag", "download", "editorMode", "errorFilled", "errorOutline", "fileTypeAudio", "fileTypeDoc", "fileTypeGenericDoc", "fileTypeImage", "fileTypePdf", "fileTypeSpreadsheet", "fileTypeVideo", "headset", "legacyAccountFilled", "legacyAccountUnfilled", "legacySocialFacebook", "legacySocialInstagram", "legacySocialTwitter", "legacySocialYoutube", "locator", "mapsPlace", "minus", "moonCrescent", "navigationMoreVert", "navigationSubdirectoryArrowLeft", "navigationSubdirectoryArrowRight", "plus", "search", "socialFacebook", "socialInstagram", "socialPinterest", "socialSoundCloud", "socialSpotify", "socialTikTok", "socialTumblr", "socialTwitter", "socialVimeo", "socialX", "socialYoutube", "speakerNotes", "sunFull", "utilityAccountFilled", "utilityAccountUnfilled", "utilityCheck", "utilityHamburger", "utilitySearch"];
|
|
4
4
|
export declare const iconRotationsArray: readonly ["rotate0", "rotate90", "rotate180", "rotate270"];
|
|
5
5
|
export declare const iconSizesArray: readonly ["default", "xsmall", "small", "medium", "large", "xlarge", "xxlarge", "xxxlarge", "xxxxlarge", "xxxxxlarge", "2xlarge", "3xlarge", "4xlarge", "5xlarge"];
|
|
6
|
-
export declare const
|
|
6
|
+
export declare const iconVariantsArray: readonly ["default", "breadcrumbs"];
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
2
|
import React, { AnchorHTMLAttributes } from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
3
|
+
export declare const linkVariantsArray: readonly ["action", "backwards", "buttonPrimary", "buttonSecondary", "buttonPill", "buttonCallout", "buttonNoBrand", "buttonDisabled", "default", "external", "forwards", "standalone"];
|
|
4
|
+
export type LinkVariants = typeof linkVariantsArray[number];
|
|
5
5
|
export interface LinkProps extends Pick<BoxProps, "as" | keyof ChakraProps>, Omit<AnchorHTMLAttributes<HTMLAnchorElement>, "color"> {
|
|
6
6
|
/** Used to include or remove visited state styles. Default is true. */
|
|
7
7
|
hasVisitedState?: boolean;
|
|
@@ -15,7 +15,7 @@ export interface LinkProps extends Pick<BoxProps, "as" | keyof ChakraProps>, Omi
|
|
|
15
15
|
screenreaderOnlyText?: string;
|
|
16
16
|
/** Controls the link's styles based on the value: action, backwards, default,
|
|
17
17
|
* external, forwards, standalone, and all "button" types. */
|
|
18
|
-
|
|
18
|
+
variant?: LinkVariants;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* A component that renders an anchor element with added styling
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
3
|
+
export declare const listVariantsArray: readonly ["ol", "ul", "dl"];
|
|
4
|
+
export type ListVariants = typeof listVariantsArray[number];
|
|
5
5
|
export interface DescriptionProps {
|
|
6
6
|
term: string;
|
|
7
7
|
description: string | JSX.Element;
|
|
@@ -27,7 +27,7 @@ export interface ListProps extends Omit<BoxProps, "title"> {
|
|
|
27
27
|
* to Description Lists and will render above the list. */
|
|
28
28
|
title?: string | JSX.Element;
|
|
29
29
|
/** The type of list: "ol", "ul", or "dl". "ul" by default. */
|
|
30
|
-
|
|
30
|
+
variant: ListVariants;
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
33
|
* A component that renders list item `li` elements or description item `dt`
|
|
@@ -39,9 +39,9 @@ export declare const List: ChakraComponent<React.ForwardRefExoticComponent<React
|
|
|
39
39
|
* Checks for `li` elements and consoles a warning if the
|
|
40
40
|
* children are different HTML elements.
|
|
41
41
|
*/
|
|
42
|
-
export declare const checkListChildrenError: ({ children,
|
|
42
|
+
export declare const checkListChildrenError: ({ children, variant, componentName, }: {
|
|
43
43
|
children: React.ReactNode;
|
|
44
|
-
|
|
44
|
+
variant?: ListVariants;
|
|
45
45
|
componentName?: string;
|
|
46
46
|
}) => void;
|
|
47
47
|
export default List;
|
|
@@ -16,7 +16,7 @@ export interface ConfirmationModalProps {
|
|
|
16
16
|
onCancel: () => void;
|
|
17
17
|
onConfirm: () => void;
|
|
18
18
|
/** The `Modal` variant to render. */
|
|
19
|
-
|
|
19
|
+
variant: "confirmation";
|
|
20
20
|
/** The label for the close button. This prop is used for the
|
|
21
21
|
* "cancel" button in the confirmation variant. */
|
|
22
22
|
closeButtonLabel?: string;
|
|
@@ -27,7 +27,7 @@ export interface DefaultModalProps {
|
|
|
27
27
|
closeButtonLabel?: string;
|
|
28
28
|
onClose?: () => void;
|
|
29
29
|
/** The `Modal` variant to render. */
|
|
30
|
-
|
|
30
|
+
variant: "default";
|
|
31
31
|
/** The label for the confirm button. This prop is not used
|
|
32
32
|
* in the default variant. */
|
|
33
33
|
confirmButtonLabel?: never;
|
|
@@ -45,7 +45,7 @@ export interface ModalProps {
|
|
|
45
45
|
* `bodyContent`, `headingText`, `isOpen`, and the modal type props. */
|
|
46
46
|
modalProps: BaseModalProps;
|
|
47
47
|
}
|
|
48
|
-
export declare function
|
|
48
|
+
export declare function isDefaultVariant(variant: BaseModalProps["variant"]): variant is "default";
|
|
49
49
|
export declare const BaseModal: ChakraComponent<React.FunctionComponent<BaseModalProps>, BaseModalProps>;
|
|
50
50
|
/**
|
|
51
51
|
* The `ModalTrigger` component renders a button that you click to open the
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export declare const
|
|
4
|
-
export type
|
|
3
|
+
export declare const notificationVariantsArray: readonly ["standard", "announcement", "warning"];
|
|
4
|
+
export type NotificationVariants = typeof notificationVariantsArray[number];
|
|
5
5
|
interface BaseProps {
|
|
6
6
|
/** Optional prop to control text alignment in `NotificationContent` */
|
|
7
7
|
alignText?: boolean;
|
|
@@ -18,7 +18,7 @@ interface BaseProps {
|
|
|
18
18
|
notificationHeading?: string | JSX.Element;
|
|
19
19
|
/** Optional prop to control the coloring of the `Notification` text and the
|
|
20
20
|
* visibility of an applicable icon. */
|
|
21
|
-
|
|
21
|
+
variant?: NotificationVariants;
|
|
22
22
|
/** Prop to display the `Notification` icon. Defaults to `true`. */
|
|
23
23
|
showIcon?: boolean;
|
|
24
24
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent, ChakraProps } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
|
|
4
|
-
export declare const
|
|
5
|
-
export declare const labelPositionsArray:
|
|
6
|
-
export type
|
|
4
|
+
export declare const selectVariantsArray: readonly ["default", "searchbar"];
|
|
5
|
+
export declare const labelPositionsArray: readonly ["default", "inline"];
|
|
6
|
+
export type SelectVariants = typeof selectVariantsArray[number];
|
|
7
7
|
export type LabelPositions = typeof labelPositionsArray[number];
|
|
8
8
|
export interface SelectProps extends Pick<BoxProps, keyof ChakraProps>, Omit<React.SelectHTMLAttributes<HTMLSelectElement>, "color"> {
|
|
9
9
|
/** The initial value of an uncontrolled component */
|
|
@@ -35,7 +35,7 @@ export interface SelectProps extends Pick<BoxProps, keyof ChakraProps>, Omit<Rea
|
|
|
35
35
|
* Note: Parenthesis will be added automatically by the component */
|
|
36
36
|
requiredLabelText?: string;
|
|
37
37
|
/** The variant to display. */
|
|
38
|
-
|
|
38
|
+
variant?: SelectVariants;
|
|
39
39
|
/** Offers the ability to hide the helper/invalid text. */
|
|
40
40
|
showHelperInvalidText?: boolean;
|
|
41
41
|
/** Offers the ability to show the select's label onscreen or hide it. Refer
|
|
@@ -2,12 +2,12 @@ import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
|
2
2
|
import React from "react";
|
|
3
3
|
import { messageVariantsArray } from "../../theme/sharedTypes";
|
|
4
4
|
export declare const statusBadgeFontSizeArray: readonly ["desktop.body.body1", "desktop.body.body2", "desktop.caption"];
|
|
5
|
-
export type
|
|
5
|
+
export type StatusBadgeVariants = typeof messageVariantsArray[number];
|
|
6
6
|
export interface StatusBadgeProps extends BoxProps {
|
|
7
7
|
/** ID that other components can cross reference for accessibility purposes */
|
|
8
8
|
id?: string;
|
|
9
9
|
/** Semantic type of the status badge. */
|
|
10
|
-
|
|
10
|
+
variant?: StatusBadgeVariants;
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* The `StatusBadge` component is a label that indicates status or importance.
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import { BoxProps, ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
-
export declare const tableBodyTextSizesArray: readonly ["body1", "body2", "caption"];
|
|
4
|
-
export type TableBodyTextSizes = typeof tableBodyTextSizesArray[number];
|
|
5
3
|
export interface TableProps extends BoxProps {
|
|
6
4
|
/** Array of string values used to populate the `Table` column headers.
|
|
7
5
|
* For improved accessibility, column headers are required. */
|
|
@@ -14,10 +12,6 @@ export interface TableProps extends BoxProps {
|
|
|
14
12
|
* Any style can be passed, but the most common use would be to pass "width"
|
|
15
13
|
* and "maxWidth" to set custom column widths. */
|
|
16
14
|
columnStyles?: object[];
|
|
17
|
-
/** The size of the table body text. */
|
|
18
|
-
tableTextSize?: TableBodyTextSizes;
|
|
19
|
-
/** ID that other components can cross reference for accessibility purposes. */
|
|
20
|
-
id?: string;
|
|
21
15
|
/** If true, horizontal scrolling will be enabled for the table content. */
|
|
22
16
|
isScrollable?: boolean;
|
|
23
17
|
/** If true, a border will be displayed between each row in the `Table`
|
|
@@ -8,7 +8,7 @@ export interface BaseTagSetProps extends BoxProps {
|
|
|
8
8
|
}
|
|
9
9
|
export type TagSetTypeProps = TagSetFilterProps | TagSetExploreProps;
|
|
10
10
|
export type TagSetProps = BaseTagSetProps & TagSetTypeProps;
|
|
11
|
-
export declare function
|
|
11
|
+
export declare function isFilterVariant(variant: TagSetProps["variant"]): variant is "filter";
|
|
12
12
|
/**
|
|
13
13
|
* The `TagSet` component renders a group of individual tags which have two
|
|
14
14
|
* variants: "explore" and "filter". The "explore" tags are meant to be used for
|
|
@@ -21,7 +21,7 @@ export interface TagSetExploreProps {
|
|
|
21
21
|
/** The array of data to display as tags. */
|
|
22
22
|
tagSetData: TagSetExploreDataProps[];
|
|
23
23
|
/** The `TagSet` variant to render; "filter" by default. */
|
|
24
|
-
|
|
24
|
+
variant: "explore";
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
27
|
* The "explore" `TagSet` variant will always display the tags passed as data.
|
|
@@ -20,7 +20,7 @@ export interface TagSetFilterProps {
|
|
|
20
20
|
/** The array of data to display as tags. */
|
|
21
21
|
tagSetData: TagSetFilterDataProps[];
|
|
22
22
|
/** The `TagSet` variant to render; "filter" by default. */
|
|
23
|
-
|
|
23
|
+
variant: "filter";
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* The "filter" `TagSet` variant will display tags that can be removed when
|
|
@@ -59,7 +59,7 @@ export interface InputProps extends TextInputPropsWithHTML {
|
|
|
59
59
|
* True by default. */
|
|
60
60
|
showRequiredLabel?: boolean;
|
|
61
61
|
/** FOR INTERNAL DS USE ONLY: the input variant to display. */
|
|
62
|
-
|
|
62
|
+
textInputVariant?: TextInputVariants;
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
65
|
* The type used for `ref`s. We want to extend both `input` and `textarea`
|
package/dist/src/index.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
export { Box, Center, chakra, Circle, ColorModeScript, cookieStorageManager, cookieStorageManagerSSR, FocusLock, Flex, Grid, GridItem, HStack, localStorageManager, Spacer, Square, Stack, useColorMode, useColorModeValue, useStyleConfig, useMediaQuery, useMultiStyleConfig, VStack, } from "@chakra-ui/react";
|
|
2
2
|
export { default as DSProvider } from "./theme/provider";
|
|
3
3
|
export { default as Accordion } from "./components/Accordion/Accordion";
|
|
4
|
-
export type {
|
|
4
|
+
export type { AccordionVariants, AccordionDataProps, } from "./components/Accordion/Accordion";
|
|
5
5
|
export { default as AlphabetFilter } from "./components/AlphabetFilter/AlphabetFilter";
|
|
6
6
|
export type { AlphabetFilterProps } from "./components/AlphabetFilter/AlphabetFilter";
|
|
7
7
|
export { default as AudioPlayer } from "./components/AudioPlayer/AudioPlayer";
|
|
8
8
|
export type { AudioType, AudioPlayerProps, } from "./components/AudioPlayer/AudioPlayer";
|
|
9
9
|
export { default as Banner } from "./components/Banner/Banner";
|
|
10
|
-
export type {
|
|
10
|
+
export type { BannerVariants, BannerBgColors, BannerHighlightColors, BannerProps, } from "./components/Banner/Banner";
|
|
11
11
|
export { default as Breadcrumbs } from "./components/Breadcrumbs/Breadcrumbs";
|
|
12
|
-
export type {
|
|
12
|
+
export type { BreadcrumbsVariants, BreadcrumbProps, BreadcrumbsDataProps, } from "./components/Breadcrumbs/Breadcrumbs";
|
|
13
13
|
export { default as Button } from "./components/Button/Button";
|
|
14
|
-
export type { ButtonElementType, ButtonProps, ButtonSizes,
|
|
14
|
+
export type { ButtonElementType, ButtonProps, ButtonSizes, ButtonVariants, } from "./components/Button/Button";
|
|
15
15
|
export { default as ButtonGroup } from "./components/ButtonGroup/ButtonGroup";
|
|
16
16
|
export type { ButtonGroupProps } from "./components/ButtonGroup/ButtonGroup";
|
|
17
17
|
export { default as Card, CardActions, CardContent, CardHeading, } from "./components/Card/Card";
|
|
@@ -40,20 +40,20 @@ export type { HeadingLevels, HeadingProps, HeadingSizes, } from "./components/He
|
|
|
40
40
|
export { default as HelperErrorText } from "./components/HelperErrorText/HelperErrorText";
|
|
41
41
|
export type { HelperErrorTextProps } from "./components/HelperErrorText/HelperErrorText";
|
|
42
42
|
export { default as Hero } from "./components/Hero/Hero";
|
|
43
|
-
export type { HeroProps,
|
|
43
|
+
export type { HeroProps, HeroVariants } from "./components/Hero/Hero";
|
|
44
44
|
export { default as HorizontalRule } from "./components/HorizontalRule/HorizontalRule";
|
|
45
45
|
export type { HorizontalRuleProps } from "./components/HorizontalRule/HorizontalRule";
|
|
46
46
|
export { default as Icon } from "./components/Icons/Icon";
|
|
47
|
-
export type { IconAlign, IconColors, IconNames, IconRotations, IconSizes,
|
|
47
|
+
export type { IconAlign, IconColors, IconNames, IconRotations, IconSizes, IconVariants, IconProps, } from "./components/Icons/Icon";
|
|
48
48
|
export { default as Image } from "./components/Image/Image";
|
|
49
49
|
export type { ComponentImageProps, ImageProps, ImageRatios, ImageSizes, ImageTypes, } from "./components/Image/Image";
|
|
50
50
|
export { default as Label } from "./components/Label/Label";
|
|
51
51
|
export type { LabelProps } from "./components/Label/Label";
|
|
52
52
|
export type { DimensionTypes, LayoutTypes, SectionTypes, } from "./helpers/types";
|
|
53
53
|
export { default as Link } from "./components/Link/Link";
|
|
54
|
-
export type { LinkProps,
|
|
54
|
+
export type { LinkProps, LinkVariants } from "./components/Link/Link";
|
|
55
55
|
export { default as List } from "./components/List/List";
|
|
56
|
-
export type { DescriptionProps, ListProps,
|
|
56
|
+
export type { DescriptionProps, ListProps, ListVariants, } from "./components/List/List";
|
|
57
57
|
export { default as Logo } from "./components/Logo/Logo";
|
|
58
58
|
export type { LogoNames, LogoProps, LogoSizes } from "./components/Logo/Logo";
|
|
59
59
|
export { default as MatchMedia } from "../src/__tests__/mediaMatchMock";
|
|
@@ -68,7 +68,7 @@ export type { MultiSelectGroupProps } from "./components/MultiSelectGroup/MultiS
|
|
|
68
68
|
export { default as NewsletterSignup } from "./components/NewsletterSignup/NewsletterSignup";
|
|
69
69
|
export type { HighlightColorTypes, NewsletterSignupProps, NewsletterSignupViewType, } from "./components/NewsletterSignup/NewsletterSignup";
|
|
70
70
|
export { default as Notification } from "./components/Notification/Notification";
|
|
71
|
-
export type { NotificationProps,
|
|
71
|
+
export type { NotificationProps, NotificationVariants, } from "./components/Notification/Notification";
|
|
72
72
|
export { default as Pagination } from "./components/Pagination/Pagination";
|
|
73
73
|
export type { PaginationProps } from "./components/Pagination/Pagination";
|
|
74
74
|
export { default as ProgressIndicator } from "./components/ProgressIndicator/ProgressIndicator";
|
|
@@ -80,7 +80,7 @@ export type { RadioGroupProps } from "./components/RadioGroup/RadioGroup";
|
|
|
80
80
|
export { default as SearchBar } from "./components/SearchBar/SearchBar";
|
|
81
81
|
export type { SearchBarProps } from "./components/SearchBar/SearchBar";
|
|
82
82
|
export { default as Select } from "./components/Select/Select";
|
|
83
|
-
export type { LabelPositions, SelectProps,
|
|
83
|
+
export type { LabelPositions, SelectProps, SelectVariants, } from "./components/Select/Select";
|
|
84
84
|
export { default as SimpleGrid } from "./components/Grid/SimpleGrid";
|
|
85
85
|
export type { GridGaps, SimpleGridProps } from "./components/Grid/SimpleGrid";
|
|
86
86
|
export { default as SkeletonLoader } from "./components/SkeletonLoader/SkeletonLoader";
|
|
@@ -92,14 +92,14 @@ export type { SliderProps } from "./components/Slider/Slider";
|
|
|
92
92
|
export { default as SocialMediaLinks } from "./components/SocialMediaLinks/SocialMediaLinks";
|
|
93
93
|
export type { SocialMediaLinkDataProps } from "./components/SocialMediaLinks/SocialMediaLinks";
|
|
94
94
|
export { default as StatusBadge } from "./components/StatusBadge/StatusBadge";
|
|
95
|
-
export type { StatusBadgeProps,
|
|
95
|
+
export type { StatusBadgeProps, StatusBadgeVariants, } from "./components/StatusBadge/StatusBadge";
|
|
96
96
|
export { default as StructuredContent } from "./components/StructuredContent/StructuredContent";
|
|
97
97
|
export type { StructuredContentImagePosition, StructuredContentProps, } from "./components/StructuredContent/StructuredContent";
|
|
98
98
|
export { default as StyledList } from "./components/StyledList/StyledList";
|
|
99
99
|
export type { StyledListProps, StyledListTextSizes, } from "./components/StyledList/StyledList";
|
|
100
100
|
export { default as SubNav, SubNavButton, SubNavLink, } from "./components/SubNav/SubNav";
|
|
101
101
|
export { default as Table } from "./components/Table/Table";
|
|
102
|
-
export type {
|
|
102
|
+
export type { TableProps } from "./components/Table/Table";
|
|
103
103
|
export { default as Tabs, TabList, Tab, TabPanels, TabPanel, } from "./components/Tabs/Tabs";
|
|
104
104
|
export type { TabsDataProps, TabsProps } from "./components/Tabs/Tabs";
|
|
105
105
|
export { default as TagSet } from "./components/TagSet/TagSet";
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { NotificationVariants } from "../../components/Notification/Notification";
|
|
2
2
|
import { StyleFunctionProps } from "@chakra-ui/system";
|
|
3
3
|
interface NotificationBaseStyle extends StyleFunctionProps {
|
|
4
4
|
isCentered: boolean;
|
|
5
5
|
notificationHeading: string;
|
|
6
|
-
|
|
6
|
+
variant: NotificationVariants;
|
|
7
7
|
showIcon: boolean;
|
|
8
8
|
}
|
|
9
9
|
declare const Notification: {
|
|
10
|
-
baseStyle?: ({ isCentered, notificationHeading,
|
|
10
|
+
baseStyle?: ({ isCentered, notificationHeading, variant }: NotificationBaseStyle) => {
|
|
11
11
|
bg: string;
|
|
12
12
|
display: string;
|
|
13
13
|
fontSize: string;
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { NotificationVariants } from "../../components/Notification/Notification";
|
|
2
2
|
import { StyleFunctionProps } from "@chakra-ui/system";
|
|
3
3
|
interface NotificationContentBaseStyle extends StyleFunctionProps {
|
|
4
4
|
alignText: boolean;
|
|
5
5
|
isCentered: boolean;
|
|
6
6
|
notificationHeading: string;
|
|
7
|
-
|
|
7
|
+
variant: NotificationVariants;
|
|
8
8
|
showIcon: boolean;
|
|
9
9
|
}
|
|
10
10
|
declare const NotificationContent: {
|
|
11
|
-
baseStyle?: ({ isCentered, notificationHeading,
|
|
11
|
+
baseStyle?: ({ isCentered, notificationHeading, variant, showIcon, }: NotificationContentBaseStyle) => {
|
|
12
12
|
display: string;
|
|
13
13
|
justifyContent: string;
|
|
14
14
|
content: {
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { NotificationVariants } from "../../components/Notification/Notification";
|
|
2
2
|
import { StyleFunctionProps } from "@chakra-ui/system";
|
|
3
3
|
interface NotificationHeadingBaseStyle extends StyleFunctionProps {
|
|
4
4
|
icon: boolean;
|
|
5
5
|
isCentered: boolean;
|
|
6
|
-
|
|
6
|
+
variant: NotificationVariants;
|
|
7
7
|
}
|
|
8
8
|
declare const NotificationHeading: {
|
|
9
|
-
baseStyle?: ({ icon, isCentered,
|
|
9
|
+
baseStyle?: ({ icon, isCentered, variant }: NotificationHeadingBaseStyle) => {
|
|
10
10
|
display: string;
|
|
11
11
|
flexDirection: string;
|
|
12
12
|
m: string;
|
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
import { StyleFunctionProps } from "@chakra-ui/system";
|
|
2
|
-
import { TableBodyTextSizes } from "../../components/Table/Table";
|
|
3
2
|
interface BaseStyleProps extends StyleFunctionProps {
|
|
4
3
|
columnHeadersBackgroundColor?: string;
|
|
5
4
|
columnHeadersTextColor?: string;
|
|
6
|
-
tableTextSize?: TableBodyTextSizes;
|
|
7
5
|
isScrollable?: boolean;
|
|
8
6
|
showRowDividers?: boolean;
|
|
9
7
|
useRowHeaders?: boolean;
|
|
@@ -57,7 +55,7 @@ export declare const baseTRStyles: (columnHeadersBackgroundColor?: string, isScr
|
|
|
57
55
|
borderColor: string;
|
|
58
56
|
};
|
|
59
57
|
};
|
|
60
|
-
export declare const baseCellStyles: (columnHeadersBackgroundColor?: string, columnHeadersTextColor?: string,
|
|
58
|
+
export declare const baseCellStyles: (columnHeadersBackgroundColor?: string, columnHeadersTextColor?: string, isScrollable?: boolean, showRowDividers?: boolean) => {
|
|
61
59
|
border: string;
|
|
62
60
|
borderBottom: string;
|
|
63
61
|
borderColor: string;
|
|
@@ -65,7 +63,6 @@ export declare const baseCellStyles: (columnHeadersBackgroundColor?: string, col
|
|
|
65
63
|
base: string;
|
|
66
64
|
md: string;
|
|
67
65
|
};
|
|
68
|
-
fontSize: any;
|
|
69
66
|
gap: string;
|
|
70
67
|
letterSpacing: string;
|
|
71
68
|
lineHeight: number;
|
|
@@ -113,7 +110,7 @@ export declare const baseCellStyles: (columnHeadersBackgroundColor?: string, col
|
|
|
113
110
|
};
|
|
114
111
|
};
|
|
115
112
|
};
|
|
116
|
-
export declare const baseTHStyles: (columnHeadersBackgroundColor?: string, columnHeadersTextColor?: string,
|
|
113
|
+
export declare const baseTHStyles: (columnHeadersBackgroundColor?: string, columnHeadersTextColor?: string, isScrollable?: boolean, showRowDividers?: boolean, useRowHeaders?: boolean) => {
|
|
117
114
|
color: string;
|
|
118
115
|
fontWeight: string;
|
|
119
116
|
fontSize: string;
|
|
@@ -189,7 +186,7 @@ export declare const baseTHStyles: (columnHeadersBackgroundColor?: string, colum
|
|
|
189
186
|
};
|
|
190
187
|
};
|
|
191
188
|
};
|
|
192
|
-
export declare const baseTDStyles: (columnHeadersBackgroundColor?: string, columnHeadersTextColor?: string,
|
|
189
|
+
export declare const baseTDStyles: (columnHeadersBackgroundColor?: string, columnHeadersTextColor?: string, isScrollable?: boolean, showRowDividers?: boolean) => {
|
|
193
190
|
_last: {
|
|
194
191
|
borderBottom: string | {
|
|
195
192
|
base: number;
|
|
@@ -203,7 +200,6 @@ export declare const baseTDStyles: (columnHeadersBackgroundColor?: string, colum
|
|
|
203
200
|
base: string;
|
|
204
201
|
md: string;
|
|
205
202
|
};
|
|
206
|
-
fontSize: any;
|
|
207
203
|
gap: string;
|
|
208
204
|
letterSpacing: string;
|
|
209
205
|
lineHeight: number;
|
|
@@ -247,7 +243,7 @@ export declare const baseTDStyles: (columnHeadersBackgroundColor?: string, colum
|
|
|
247
243
|
};
|
|
248
244
|
};
|
|
249
245
|
};
|
|
250
|
-
export declare const baseStyle: ({ columnHeadersBackgroundColor, columnHeadersTextColor,
|
|
246
|
+
export declare const baseStyle: ({ columnHeadersBackgroundColor, columnHeadersTextColor, isScrollable, showRowDividers, useRowHeaders, }: BaseStyleProps) => {
|
|
251
247
|
base: {
|
|
252
248
|
overflow: string;
|
|
253
249
|
maxWidth: string;
|
|
@@ -280,7 +276,6 @@ export declare const baseStyle: ({ columnHeadersBackgroundColor, columnHeadersTe
|
|
|
280
276
|
};
|
|
281
277
|
color: string;
|
|
282
278
|
fontWeight: string;
|
|
283
|
-
fontSize: any;
|
|
284
279
|
textTransform: string;
|
|
285
280
|
verticalAlign: string;
|
|
286
281
|
_dark: {
|
|
@@ -297,6 +292,7 @@ export declare const baseStyle: ({ columnHeadersBackgroundColor, columnHeadersTe
|
|
|
297
292
|
md: "table-header-group";
|
|
298
293
|
};
|
|
299
294
|
th: {
|
|
295
|
+
fontSize: string;
|
|
300
296
|
_first: {
|
|
301
297
|
backgroundColor: string;
|
|
302
298
|
_dark: {
|
|
@@ -424,7 +420,6 @@ export declare const baseStyle: ({ columnHeadersBackgroundColor, columnHeadersTe
|
|
|
424
420
|
base: string;
|
|
425
421
|
md: string;
|
|
426
422
|
};
|
|
427
|
-
fontSize: any;
|
|
428
423
|
gap: string;
|
|
429
424
|
letterSpacing: string;
|
|
430
425
|
lineHeight: number;
|
|
@@ -489,7 +484,7 @@ export declare const baseStyle: ({ columnHeadersBackgroundColor, columnHeadersTe
|
|
|
489
484
|
};
|
|
490
485
|
};
|
|
491
486
|
declare const CustomTable: {
|
|
492
|
-
baseStyle?: ({ columnHeadersBackgroundColor, columnHeadersTextColor,
|
|
487
|
+
baseStyle?: ({ columnHeadersBackgroundColor, columnHeadersTextColor, isScrollable, showRowDividers, useRowHeaders, }: BaseStyleProps) => {
|
|
493
488
|
base: {
|
|
494
489
|
overflow: string;
|
|
495
490
|
maxWidth: string;
|
|
@@ -522,7 +517,6 @@ declare const CustomTable: {
|
|
|
522
517
|
};
|
|
523
518
|
color: string;
|
|
524
519
|
fontWeight: string;
|
|
525
|
-
fontSize: any;
|
|
526
520
|
textTransform: string;
|
|
527
521
|
verticalAlign: string;
|
|
528
522
|
_dark: {
|
|
@@ -539,6 +533,7 @@ declare const CustomTable: {
|
|
|
539
533
|
md: "table-header-group";
|
|
540
534
|
};
|
|
541
535
|
th: {
|
|
536
|
+
fontSize: string;
|
|
542
537
|
_first: {
|
|
543
538
|
backgroundColor: string;
|
|
544
539
|
_dark: {
|
|
@@ -666,7 +661,6 @@ declare const CustomTable: {
|
|
|
666
661
|
base: string;
|
|
667
662
|
md: string;
|
|
668
663
|
};
|
|
669
|
-
fontSize: any;
|
|
670
664
|
gap: string;
|
|
671
665
|
letterSpacing: string;
|
|
672
666
|
lineHeight: number;
|