@nypl/design-system-react-components 3.5.3 → 3.5.5-rc
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 +52 -52
- package/dist/design-system-react-components.js +13093 -12925
- package/dist/src/components/Icons/IconSvgs.d.ts +1 -0
- package/dist/src/components/Icons/iconVariables.d.ts +1 -1
- package/dist/src/components/Image/Image.d.ts +1 -1
- package/dist/src/components/StatusBadge/StatusBadge.d.ts +2 -3
- package/dist/src/components/TextInput/TextInput.d.ts +1 -1
- package/dist/src/theme/components/alphabetFilter.d.ts +0 -1
- package/dist/src/theme/components/breadcrumb.d.ts +4 -0
- package/dist/src/theme/components/card.d.ts +17 -71
- package/dist/src/theme/components/checkbox.d.ts +1 -2
- package/dist/src/theme/components/featuredContent.d.ts +1 -32
- package/dist/src/theme/components/feedbackBox.d.ts +1 -0
- package/dist/src/theme/components/fieldset.d.ts +3 -3
- package/dist/src/theme/components/hero.d.ts +12 -9
- package/dist/src/theme/components/image.d.ts +254 -0
- package/dist/src/theme/components/label.d.ts +3 -3
- package/dist/src/theme/components/menu.d.ts +15 -14
- package/dist/src/theme/components/modal.d.ts +21 -0
- package/dist/src/theme/components/searchBar.d.ts +4 -46
- package/dist/src/theme/components/statusBadge.d.ts +2 -2
- package/dist/src/utils/setContainerStyles.d.ts +11 -0
- package/dist/src/utils/utils.d.ts +2 -0
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export declare const iconAlignArray: readonly ["left", "right", "none"];
|
|
2
2
|
export declare const iconColorsArray: readonly ["transparent", "ui.black", "ui.white", "ui.disabled.primary", "ui.disabled.secondary", "ui.error.primary", "ui.error.secondary", "ui.focus", "ui.link.primary", "ui.link.primary-05", "ui.link.primary-10", "ui.link.secondary", "ui.link.tertiary", "ui.status.primary", "ui.status.secondary", "ui.success.primary", "ui.success.secondary", "ui.test", "ui.warning.primary", "ui.warning.secondary", "ui.bg.default", "ui.bg.hover", "ui.bg.active", "ui.border.default", "ui.border.hover", "ui.typography.heading", "ui.typography.body", "ui.typography.inverse.heading", "ui.typography.inverse.body", "ui.gray.xxxx-dark", "ui.gray.xxx-dark", "ui.gray.xx-dark", "ui.gray.x-dark", "ui.gray.dark", "ui.gray.semi-dark", "ui.gray.medium", "ui.gray.semi-medium", "ui.gray.light-cool", "ui.gray.x-light-cool", "ui.gray.xx-light-cool", "ui.gray.light-warm", "ui.gray.x-light-warm", "brand.primary", "brand.secondary", "section.blogs.primary", "section.blogs.secondary", "section.books-and-more.primary", "section.books-and-more.secondary", "section.connect.primary", "section.connect.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.schwarzman", "section.whats-on.primary", "section.whats-on.secondary", "dark.brand.primary", "dark.brand.secondary", "dark.section.blogs.primary", "dark.section.blogs.secondary", "dark.section.books-and-more.primary", "dark.section.books-and-more.secondary", "dark.section.connect.primary", "dark.section.connect.secondary", "dark.section.education.primary", "dark.section.education.secondary", "dark.section.locations.primary", "dark.section.locations.secondary", "dark.section.research.primary", "dark.section.research.secondary", "dark.section.research-library.primary", "dark.section.research-library.secondary", "dark.section.whats-on.primary", "dark.section.whats-on.secondary", "dark.ui.disabled.primary", "dark.ui.disabled.secondary", "dark.ui.error.primary", "dark.ui.error.secondary", "dark.ui.focus", "dark.ui.link.primary", "dark.ui.link.primary-05", "dark.ui.link.primary-10", "dark.ui.link.secondary", "dark.ui.link.tertiary", "dark.ui.status.primary", "dark.ui.status.secondary", "dark.ui.success.primary", "dark.ui.success.secondary", "dark.ui.test", "dark.ui.warning.secondary", "dark.ui.warning.primary", "dark.ui.bg.page", "dark.ui.bg.default", "dark.ui.bg.hover", "dark.ui.bg.active", "dark.ui.border.default", "dark.ui.border.hover", "dark.ui.typography.heading", "dark.ui.typography.body", "dark.ui.typography.inverse.heading", "dark.ui.typography.inverse.body"];
|
|
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", "plus", "search", "socialFacebook", "socialInstagram", "socialPinterest", "socialSoundCloud", "socialSpotify", "socialTikTok", "socialTumblr", "socialTwitter", "socialVimeo", "socialX", "socialYoutube", "speakerNotes", "sunFull", "utilityAccountFilled", "utilityAccountUnfilled", "utilityHamburger", "utilitySearch"];
|
|
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", "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
6
|
export declare const iconTypesArray: readonly ["default", "breadcrumbs"];
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React, { ImgHTMLAttributes } from "react";
|
|
3
3
|
import { DimensionTypes } from "../../helpers/types";
|
|
4
|
-
export declare const imageRatiosArray: readonly ["fourByThree", "oneByTwo", "original", "sixteenByNine", "square", "threeByFour", "threeByTwo", "twoByOne"];
|
|
4
|
+
export declare const imageRatiosArray: readonly ["fourByThree", "fourByOne", "twoByThree", "oneByTwo", "original", "sixteenByNine", "square", "threeByFour", "threeByTwo", "twoByOne"];
|
|
5
5
|
export declare const imageSizesArray: readonly ["default", "xxxsmall", "xxsmall", "xsmall", "small", "medium", "large"];
|
|
6
6
|
export declare const imageTypesArray: readonly ["default", "circle"];
|
|
7
7
|
export type ImageRatios = typeof imageRatiosArray[number];
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ChakraComponent } from "@chakra-ui/react";
|
|
2
2
|
import React from "react";
|
|
3
|
+
export declare const statusBadgeFontSizeArray: readonly ["desktop.body.body1", "desktop.body.body2", "desktop.caption"];
|
|
3
4
|
export declare const statusBadgeLevelArray: readonly ["low", "medium", "high"];
|
|
4
5
|
export type StatusBadgeLevels = typeof statusBadgeLevelArray[number];
|
|
5
6
|
export declare const statusBadgeTypeArray: readonly ["informative", "negative", "neutral", "positive", "recommendation", "warning", "low", "medium", "high"];
|
|
@@ -20,7 +21,5 @@ export interface StatusBadgeProps {
|
|
|
20
21
|
* It is used for bringing awareness to a specific element or feature and should
|
|
21
22
|
* provide quick recognition.
|
|
22
23
|
*/
|
|
23
|
-
export declare const StatusBadge: ChakraComponent<React.ForwardRefExoticComponent<StatusBadgeProps &
|
|
24
|
-
children?: React.ReactNode;
|
|
25
|
-
} & React.RefAttributes<HTMLDivElement>>, StatusBadgeProps>;
|
|
24
|
+
export declare const StatusBadge: ChakraComponent<React.ForwardRefExoticComponent<React.PropsWithChildren<StatusBadgeProps> & React.RefAttributes<HTMLDivElement>>, React.PropsWithChildren<StatusBadgeProps>>;
|
|
26
25
|
export default StatusBadge;
|
|
@@ -45,7 +45,7 @@ export interface InputProps extends React.InputHTMLAttributes<HTMLInputElement>
|
|
|
45
45
|
isRequired?: boolean;
|
|
46
46
|
/** Provides text for a `Label` component if `showLabel` is set to true;
|
|
47
47
|
* populates an `aria-label` attribute if `showLabel` is set to false. */
|
|
48
|
-
labelText: string;
|
|
48
|
+
labelText: string | JSX.Element;
|
|
49
49
|
/** The max number for a `number` TextInput type. */
|
|
50
50
|
max?: number;
|
|
51
51
|
/** The max length of the input field. This prop is for all input types
|
|
@@ -7,6 +7,7 @@ interface CardBaseStyleProps extends StyleFunctionProps {
|
|
|
7
7
|
isCentered: boolean;
|
|
8
8
|
layout: string;
|
|
9
9
|
mainActionLink: boolean;
|
|
10
|
+
imageSize: keyof typeof imageSizes;
|
|
10
11
|
}
|
|
11
12
|
interface CardImageBaseStyleProps extends StyleFunctionProps {
|
|
12
13
|
imageIsAtEnd: boolean;
|
|
@@ -51,13 +52,13 @@ declare const imageSizes: {
|
|
|
51
52
|
};
|
|
52
53
|
declare const _default: {
|
|
53
54
|
ReservoirCard: {
|
|
54
|
-
baseStyle?: ({ hasImage, imageIsAtEnd, isAlignedRightActions, isBordered, isCentered, layout, mainActionLink, }: CardBaseStyleProps) => {
|
|
55
|
+
baseStyle?: ({ hasImage, imageIsAtEnd, isAlignedRightActions, isBordered, isCentered, layout, mainActionLink, imageSize, }: CardBaseStyleProps) => {
|
|
55
56
|
base: {
|
|
57
|
+
width: string;
|
|
58
|
+
containerType: string;
|
|
59
|
+
};
|
|
60
|
+
wrapper: {
|
|
56
61
|
display: string;
|
|
57
|
-
flexFlow: {
|
|
58
|
-
base: string;
|
|
59
|
-
md: string;
|
|
60
|
-
};
|
|
61
62
|
maxWidth: string;
|
|
62
63
|
textAlign: string;
|
|
63
64
|
alignItems: string;
|
|
@@ -66,9 +67,9 @@ declare const _default: {
|
|
|
66
67
|
_dark: {
|
|
67
68
|
borderColor: string;
|
|
68
69
|
};
|
|
70
|
+
flexFlow: string;
|
|
69
71
|
} | {
|
|
70
72
|
display: string;
|
|
71
|
-
flexFlow: string;
|
|
72
73
|
maxWidth?: undefined;
|
|
73
74
|
textAlign: string;
|
|
74
75
|
alignItems: string;
|
|
@@ -77,63 +78,32 @@ declare const _default: {
|
|
|
77
78
|
_dark: {
|
|
78
79
|
borderColor: string;
|
|
79
80
|
};
|
|
81
|
+
flexFlow: string;
|
|
80
82
|
} | {
|
|
81
83
|
display: string;
|
|
82
|
-
flexFlow: {
|
|
83
|
-
base: string;
|
|
84
|
-
md: string;
|
|
85
|
-
};
|
|
86
84
|
maxWidth: string;
|
|
87
85
|
textAlign: string;
|
|
88
86
|
alignItems: string;
|
|
89
87
|
border?: undefined;
|
|
90
88
|
borderColor?: undefined;
|
|
91
89
|
_dark?: undefined;
|
|
90
|
+
flexFlow: string;
|
|
92
91
|
} | {
|
|
93
92
|
display: string;
|
|
94
|
-
flexFlow: string;
|
|
95
93
|
maxWidth?: undefined;
|
|
96
94
|
textAlign: string;
|
|
97
95
|
alignItems: string;
|
|
98
96
|
border?: undefined;
|
|
99
97
|
borderColor?: undefined;
|
|
100
98
|
_dark?: undefined;
|
|
99
|
+
flexFlow: string;
|
|
101
100
|
};
|
|
102
101
|
actions: {
|
|
103
|
-
flexShrink: {
|
|
104
|
-
base: string;
|
|
105
|
-
md: string;
|
|
106
|
-
};
|
|
107
|
-
marginStart: {
|
|
108
|
-
base: string;
|
|
109
|
-
md: string;
|
|
110
|
-
};
|
|
111
|
-
marginTop: {
|
|
112
|
-
base: string;
|
|
113
|
-
md: string;
|
|
114
|
-
};
|
|
115
|
-
maxWidth: {
|
|
116
|
-
base: string;
|
|
117
|
-
md: string;
|
|
118
|
-
};
|
|
119
102
|
width: string;
|
|
120
103
|
};
|
|
121
104
|
body: {
|
|
122
|
-
display: {
|
|
123
|
-
md: "block";
|
|
124
|
-
};
|
|
125
|
-
flexBasis: {
|
|
126
|
-
sm: string;
|
|
127
|
-
};
|
|
128
|
-
flexFlow: {
|
|
129
|
-
md: "row nowrap";
|
|
130
|
-
};
|
|
131
105
|
margin: any;
|
|
132
106
|
padding: any;
|
|
133
|
-
width: {
|
|
134
|
-
base: "100%";
|
|
135
|
-
md: "auto";
|
|
136
|
-
};
|
|
137
107
|
};
|
|
138
108
|
heading: {
|
|
139
109
|
marginBottom: string;
|
|
@@ -273,56 +243,32 @@ declare const _default: {
|
|
|
273
243
|
};
|
|
274
244
|
};
|
|
275
245
|
CardImage: {
|
|
276
|
-
baseStyle?: ({ imageIsAtEnd, isCentered, layout
|
|
277
|
-
flex: {
|
|
278
|
-
md: string;
|
|
279
|
-
};
|
|
280
|
-
maxWidth: {
|
|
281
|
-
base: string;
|
|
282
|
-
md: string;
|
|
283
|
-
};
|
|
246
|
+
baseStyle?: ({ imageIsAtEnd, isCentered, layout }: CardImageBaseStyleProps) => {
|
|
284
247
|
textAlign: string;
|
|
285
248
|
alignItems: string;
|
|
286
|
-
margin: {
|
|
287
|
-
base: string;
|
|
288
|
-
md: string;
|
|
289
|
-
};
|
|
290
|
-
width: {
|
|
291
|
-
base: string;
|
|
292
|
-
md: any;
|
|
293
|
-
};
|
|
294
249
|
marginBottom: string[];
|
|
250
|
+
width?: undefined;
|
|
295
251
|
marginTop: string;
|
|
296
252
|
order: string;
|
|
297
253
|
} | {
|
|
298
254
|
marginBottom: string;
|
|
299
255
|
width: string;
|
|
256
|
+
textAlign?: undefined;
|
|
257
|
+
alignItems?: undefined;
|
|
300
258
|
marginTop: string;
|
|
301
259
|
order: string;
|
|
302
260
|
} | {
|
|
303
|
-
flex: {
|
|
304
|
-
md: string;
|
|
305
|
-
};
|
|
306
|
-
maxWidth: {
|
|
307
|
-
base: string;
|
|
308
|
-
md: string;
|
|
309
|
-
};
|
|
310
261
|
textAlign: string;
|
|
311
262
|
alignItems: string;
|
|
312
|
-
margin: {
|
|
313
|
-
base: string;
|
|
314
|
-
md: string;
|
|
315
|
-
};
|
|
316
|
-
width: {
|
|
317
|
-
base: string;
|
|
318
|
-
md: any;
|
|
319
|
-
};
|
|
320
263
|
marginBottom: string[];
|
|
264
|
+
width?: undefined;
|
|
321
265
|
marginTop?: undefined;
|
|
322
266
|
order?: undefined;
|
|
323
267
|
} | {
|
|
324
268
|
marginBottom: string;
|
|
325
269
|
width: string;
|
|
270
|
+
textAlign?: undefined;
|
|
271
|
+
alignItems?: undefined;
|
|
326
272
|
marginTop?: undefined;
|
|
327
273
|
order?: undefined;
|
|
328
274
|
};
|
|
@@ -52,14 +52,13 @@ declare const Checkbox: {
|
|
|
52
52
|
border: string;
|
|
53
53
|
borderRadius: string;
|
|
54
54
|
borderColor: string;
|
|
55
|
-
|
|
55
|
+
bg: string;
|
|
56
56
|
color: string;
|
|
57
57
|
cursor: string;
|
|
58
58
|
outline: string;
|
|
59
59
|
transitionProperty: string;
|
|
60
60
|
transitionDuration: string;
|
|
61
61
|
_checked: {
|
|
62
|
-
bg: string;
|
|
63
62
|
borderColor: string;
|
|
64
63
|
color: string;
|
|
65
64
|
_hover: {
|
|
@@ -34,27 +34,13 @@ declare const FeaturedContent: {
|
|
|
34
34
|
};
|
|
35
35
|
wordWrap: string;
|
|
36
36
|
};
|
|
37
|
+
containerType: string;
|
|
37
38
|
};
|
|
38
39
|
wrapper: {
|
|
39
40
|
alignItems: string;
|
|
40
41
|
display: string;
|
|
41
|
-
flexDirection: {
|
|
42
|
-
base: "column-reverse";
|
|
43
|
-
md: "row-reverse";
|
|
44
|
-
} | {
|
|
45
|
-
base: "column";
|
|
46
|
-
md: "row";
|
|
47
|
-
};
|
|
48
42
|
maxWidth: string;
|
|
49
43
|
minHeight: string;
|
|
50
|
-
paddingLeft: {
|
|
51
|
-
base: any;
|
|
52
|
-
md: "s";
|
|
53
|
-
};
|
|
54
|
-
paddingRight: {
|
|
55
|
-
base: any;
|
|
56
|
-
md: "s";
|
|
57
|
-
};
|
|
58
44
|
marginY: string;
|
|
59
45
|
marginX: string;
|
|
60
46
|
padding: string;
|
|
@@ -66,27 +52,10 @@ declare const FeaturedContent: {
|
|
|
66
52
|
flexDirection: string;
|
|
67
53
|
justifyContent: string;
|
|
68
54
|
padding: string;
|
|
69
|
-
/** The `paddingLeft` attribute is used to adjust the spacing around the
|
|
70
|
-
* text when the image is positioned at the end. For aesthetic reasons,
|
|
71
|
-
* we opted to not adjust the spacing around the text when the image is
|
|
72
|
-
* positioned at the start.
|
|
73
|
-
* */
|
|
74
|
-
paddingStart: {
|
|
75
|
-
base: any;
|
|
76
|
-
md: number;
|
|
77
|
-
};
|
|
78
55
|
};
|
|
79
56
|
imgWrapper: {
|
|
80
57
|
backgroundPosition: string;
|
|
81
58
|
backgroundSize: string;
|
|
82
|
-
height: {
|
|
83
|
-
base: "320px";
|
|
84
|
-
md: "auto";
|
|
85
|
-
};
|
|
86
|
-
width: {
|
|
87
|
-
base: "100%";
|
|
88
|
-
md: string;
|
|
89
|
-
};
|
|
90
59
|
};
|
|
91
60
|
};
|
|
92
61
|
sizes?: {
|
|
@@ -7,6 +7,9 @@ declare const Fieldset: {
|
|
|
7
7
|
border: number;
|
|
8
8
|
padding: number;
|
|
9
9
|
legend: {
|
|
10
|
+
span: {
|
|
11
|
+
fontWeight: string;
|
|
12
|
+
};
|
|
10
13
|
_dark: {
|
|
11
14
|
color: string;
|
|
12
15
|
};
|
|
@@ -16,9 +19,6 @@ declare const Fieldset: {
|
|
|
16
19
|
fontWeight: string;
|
|
17
20
|
marginBottom: string;
|
|
18
21
|
width: string;
|
|
19
|
-
span: {
|
|
20
|
-
fontWeight: string;
|
|
21
|
-
};
|
|
22
22
|
};
|
|
23
23
|
};
|
|
24
24
|
sizes?: {
|
|
@@ -30,12 +30,18 @@ declare const Hero: {
|
|
|
30
30
|
md: string;
|
|
31
31
|
};
|
|
32
32
|
maxWidth: {
|
|
33
|
-
md: "
|
|
33
|
+
md: "860px";
|
|
34
|
+
};
|
|
35
|
+
padding: {
|
|
36
|
+
base: "inset.default";
|
|
37
|
+
lg: "inset.wide";
|
|
38
|
+
};
|
|
39
|
+
paddingEnd: {
|
|
40
|
+
lg: "inset.wide";
|
|
41
|
+
};
|
|
42
|
+
paddingStart: {
|
|
43
|
+
lg: "inset.wide";
|
|
34
44
|
};
|
|
35
|
-
paddingTop: string;
|
|
36
|
-
paddingBottom: string;
|
|
37
|
-
paddingEnd: string;
|
|
38
|
-
paddingStart: string;
|
|
39
45
|
a: {
|
|
40
46
|
color: string;
|
|
41
47
|
display: string;
|
|
@@ -662,10 +668,7 @@ declare const Hero: {
|
|
|
662
668
|
maxWidth: {
|
|
663
669
|
md: "960px";
|
|
664
670
|
};
|
|
665
|
-
padding:
|
|
666
|
-
base: "inset.default";
|
|
667
|
-
md: "inset.wide";
|
|
668
|
-
};
|
|
671
|
+
padding: string;
|
|
669
672
|
width: {
|
|
670
673
|
base: "100%";
|
|
671
674
|
lg: "50%";
|