@nypl/design-system-react-components 1.5.1 → 1.6.0-vite-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.
Files changed (201) hide show
  1. package/README.md +39 -39
  2. package/dist/design-system-react-components.cjs +279 -0
  3. package/dist/design-system-react-components.js +42759 -0
  4. package/dist/{components → src/components}/Accordion/Accordion.d.ts +29 -29
  5. package/dist/{components → src/components}/AlphabetFilter/AlphabetFilter.d.ts +23 -23
  6. package/dist/{components → src/components}/AudioPlayer/AudioPlayer.d.ts +43 -43
  7. package/dist/{components → src/components}/Breadcrumbs/Breadcrumbs.d.ts +18 -18
  8. package/dist/{components → src/components}/Button/Button.d.ts +30 -30
  9. package/dist/{components → src/components}/ButtonGroup/ButtonGroup.d.ts +24 -24
  10. package/dist/{components → src/components}/Card/Card.d.ts +55 -55
  11. package/dist/{components → src/components}/Checkbox/Checkbox.d.ts +47 -47
  12. package/dist/{components → src/components}/CheckboxGroup/CheckboxGroup.d.ts +51 -51
  13. package/dist/{components → src/components}/ComponentWrapper/ComponentWrapper.d.ts +31 -31
  14. package/dist/{components → src/components}/DatePicker/DatePicker.d.ts +81 -81
  15. package/dist/{components → src/components}/FeedbackBox/FeedbackBox.d.ts +63 -63
  16. package/dist/{components → src/components}/FeedbackBox/useFeedbackBoxReducer.d.ts +19 -19
  17. package/dist/{components → src/components}/Fieldset/Fieldset.d.ts +24 -24
  18. package/dist/{components → src/components}/FilterBar/FilterBar.d.ts +61 -111
  19. package/dist/{components → src/components}/Footer/Footer.d.ts +14 -14
  20. package/dist/{components → src/components}/Footer/footerLinks.d.ts +12 -12
  21. package/dist/{components → src/components}/Form/Form.d.ts +31 -31
  22. package/dist/{components → src/components}/Grid/SimpleGrid.d.ts +19 -19
  23. package/dist/{components → src/components}/Header/Header.d.ts +22 -22
  24. package/dist/{components → src/components}/Header/components/HeaderLogin.d.ts +12 -12
  25. package/dist/{components → src/components}/Header/components/HeaderLoginButton.d.ts +11 -11
  26. package/dist/{components → src/components}/Header/components/HeaderLowerNav.d.ts +7 -7
  27. package/dist/{components → src/components}/Header/components/HeaderMobileIconNav.d.ts +7 -7
  28. package/dist/{components → src/components}/Header/components/HeaderMobileNav.d.ts +7 -7
  29. package/dist/{components → src/components}/Header/components/HeaderMobileNavButton.d.ts +7 -7
  30. package/dist/{components → src/components}/Header/components/HeaderSearchButton.d.ts +10 -10
  31. package/dist/{components → src/components}/Header/components/HeaderSearchForm.d.ts +11 -11
  32. package/dist/{components → src/components}/Header/components/HeaderSitewideAlerts.d.ts +8 -8
  33. package/dist/{components → src/components}/Header/components/HeaderUpperNav.d.ts +8 -8
  34. package/dist/{components → src/components}/Header/context/headerContext.d.ts +13 -13
  35. package/dist/{components → src/components}/Header/utils/googleAnalyticsUtils.d.ts +16 -16
  36. package/dist/{components → src/components}/Header/utils/headerUtils.d.ts +94 -94
  37. package/dist/{components → src/components}/Heading/Heading.d.ts +35 -35
  38. package/dist/{components → src/components}/HelperErrorText/HelperErrorText.d.ts +34 -34
  39. package/dist/{components → src/components}/Hero/Hero.d.ts +42 -42
  40. package/dist/{components → src/components}/HorizontalRule/HorizontalRule.d.ts +11 -11
  41. package/dist/{components → src/components}/Icons/Icon.d.ts +41 -41
  42. package/dist/{components → src/components}/Icons/IconColors.d.ts +3 -3
  43. package/dist/{components → src/components}/Icons/IconNames.d.ts +3 -3
  44. package/dist/{components → src/components}/Icons/IconSvgs.d.ts +56 -56
  45. package/dist/{components → src/components}/Image/Image.d.ts +65 -65
  46. package/dist/{components → src/components}/Label/Label.d.ts +25 -25
  47. package/dist/{components → src/components}/Link/Link.d.ts +21 -21
  48. package/dist/{components → src/components}/List/List.d.ts +42 -42
  49. package/dist/{components → src/components}/Logo/Logo.d.ts +28 -28
  50. package/dist/{components → src/components}/Logo/LogoSvgs.d.ts +54 -52
  51. package/dist/{components → src/components}/Modal/Modal.d.ts +35 -35
  52. package/dist/{components → src/components}/MultiSelect/MultiSelect.d.ts +60 -78
  53. package/dist/{components → src/components}/MultiSelect/MultiSelectDialog.d.ts +8 -8
  54. package/dist/{components → src/components}/MultiSelect/MultiSelectListbox.d.ts +9 -9
  55. package/dist/{components → src/components}/MultiSelect/MultiSelectMenuButton.d.ts +27 -27
  56. package/dist/{components → src/components}/MultiSelectGroup/MultiSelectGroup.d.ts +26 -26
  57. package/dist/{components → src/components}/Notification/Notification.d.ts +51 -51
  58. package/dist/{components → src/components}/Pagination/Pagination.d.ts +27 -27
  59. package/dist/{components → src/components}/ProgressIndicator/ProgressIndicator.d.ts +30 -30
  60. package/dist/{components → src/components}/Radio/Radio.d.ts +43 -43
  61. package/dist/{components → src/components}/RadioGroup/RadioGroup.d.ts +51 -51
  62. package/dist/{components → src/components}/SearchBar/SearchBar.d.ts +58 -58
  63. package/dist/{components → src/components}/Select/Select.d.ts +57 -57
  64. package/dist/{components → src/components}/SkeletonLoader/SkeletonLoader.d.ts +41 -41
  65. package/dist/{components → src/components}/SkipNavigation/SkipNavigation.d.ts +19 -19
  66. package/dist/{components → src/components}/Slider/Slider.d.ts +65 -65
  67. package/dist/{components → src/components}/StatusBadge/StatusBadge.d.ts +18 -18
  68. package/dist/{components → src/components}/StructuredContent/StructuredContent.d.ts +30 -30
  69. package/dist/{components → src/components}/StyleGuide/ColorCard.d.ts +46 -46
  70. package/dist/{components → src/components}/StyledList/StyledList.d.ts +25 -25
  71. package/dist/{components → src/components}/Table/Table.d.ts +32 -32
  72. package/dist/{components → src/components}/Tabs/Tabs.d.ts +28 -28
  73. package/dist/{components → src/components}/TagSet/TagSet.d.ts +33 -32
  74. package/dist/{components → src/components}/TagSet/TagSetExplore.d.ts +27 -27
  75. package/dist/{components → src/components}/TagSet/TagSetFilter.d.ts +26 -26
  76. package/dist/{components → src/components}/Template/Template.d.ts +140 -140
  77. package/dist/{components → src/components}/Text/Text.d.ts +24 -24
  78. package/dist/{components → src/components}/TextInput/TextInput.d.ts +88 -88
  79. package/dist/{components → src/components}/Toggle/Toggle.d.ts +42 -42
  80. package/dist/{components → src/components}/Tooltip/Tooltip.d.ts +17 -17
  81. package/dist/{components → src/components}/VideoPlayer/VideoPlayer.d.ts +40 -40
  82. package/dist/src/helpers/types.d.ts +1 -0
  83. package/dist/{hooks → src/hooks}/useCarouselStyles.d.ts +17 -17
  84. package/dist/{hooks → src/hooks}/useCloseDropDown.d.ts +7 -6
  85. package/dist/{hooks → src/hooks}/useFilterBar.d.ts +21 -21
  86. package/dist/{hooks → src/hooks}/useMultiSelect.d.ts +15 -15
  87. package/dist/{hooks → src/hooks}/useNYPLBreakpoints.d.ts +13 -13
  88. package/dist/{hooks → src/hooks}/useNYPLTheme.d.ts +67 -67
  89. package/dist/{hooks → src/hooks}/useStateWithDependencies.d.ts +5 -5
  90. package/dist/{hooks → src/hooks}/useWindowSize.d.ts +10 -10
  91. package/dist/src/index.d.ts +90 -0
  92. package/dist/{theme → src/theme}/components/accordion.d.ts +34 -34
  93. package/dist/{theme → src/theme}/components/alphabetFilter.d.ts +33 -33
  94. package/dist/{theme → src/theme}/components/audioPlayer.d.ts +16 -16
  95. package/dist/{theme → src/theme}/components/breadcrumb.d.ts +151 -138
  96. package/dist/{theme → src/theme}/components/button.d.ts +113 -113
  97. package/dist/{theme → src/theme}/components/buttonGroup.d.ts +11 -11
  98. package/dist/{theme → src/theme}/components/card.d.ts +421 -421
  99. package/dist/{theme → src/theme}/components/checkbox.d.ts +178 -178
  100. package/dist/{theme → src/theme}/components/checkboxGroup.d.ts +14 -14
  101. package/dist/{theme → src/theme}/components/componentWrapper.d.ts +12 -12
  102. package/dist/{theme → src/theme}/components/customTable.d.ts +733 -733
  103. package/dist/{theme → src/theme}/components/datePicker.d.ts +17 -17
  104. package/dist/{theme → src/theme}/components/feedbackBox.d.ts +92 -85
  105. package/dist/{theme → src/theme}/components/fieldset.d.ts +23 -23
  106. package/dist/{theme → src/theme}/components/filterBar.d.ts +46 -46
  107. package/dist/{theme → src/theme}/components/footer.d.ts +244 -241
  108. package/dist/{theme → src/theme}/components/global.d.ts +140 -140
  109. package/dist/{theme → src/theme}/components/globalMixins.d.ts +40 -40
  110. package/dist/{theme → src/theme}/components/header/header.d.ts +72 -72
  111. package/dist/{theme → src/theme}/components/header/headerLogin.d.ts +327 -327
  112. package/dist/{theme → src/theme}/components/header/headerLoginButton.d.ts +69 -69
  113. package/dist/{theme → src/theme}/components/header/headerLowerNav.d.ts +70 -70
  114. package/dist/{theme → src/theme}/components/header/headerMobileIconNav.d.ts +28 -28
  115. package/dist/{theme → src/theme}/components/header/headerMobileNav.d.ts +86 -86
  116. package/dist/{theme → src/theme}/components/header/headerMobileNavButton.d.ts +34 -34
  117. package/dist/{theme → src/theme}/components/header/headerSearchButton.d.ts +83 -83
  118. package/dist/{theme → src/theme}/components/header/headerSearchForm.d.ts +183 -183
  119. package/dist/{theme → src/theme}/components/header/headerSitewideAlerts.d.ts +42 -42
  120. package/dist/{theme → src/theme}/components/header/headerUpperNav.d.ts +72 -72
  121. package/dist/{theme → src/theme}/components/heading.d.ts +173 -173
  122. package/dist/{theme → src/theme}/components/helperErrorText.d.ts +15 -15
  123. package/dist/{theme → src/theme}/components/hero.d.ts +628 -628
  124. package/dist/{theme → src/theme}/components/horizontalRule.d.ts +18 -18
  125. package/dist/{theme → src/theme}/components/icon.d.ts +62251 -62251
  126. package/dist/{theme → src/theme}/components/image.d.ts +662 -662
  127. package/dist/{theme → src/theme}/components/label.d.ts +21 -21
  128. package/dist/{theme → src/theme}/components/link.d.ts +106 -106
  129. package/dist/{theme → src/theme}/components/list.d.ts +228 -228
  130. package/dist/{theme → src/theme}/components/logo.d.ts +477 -477
  131. package/dist/{theme → src/theme}/components/modal.d.ts +21 -21
  132. package/dist/{theme → src/theme}/components/multiSelect.d.ts +29 -29
  133. package/dist/{theme → src/theme}/components/multiSelectMenuButton.d.ts +95 -95
  134. package/dist/{theme → src/theme}/components/notification.d.ts +136 -136
  135. package/dist/{theme → src/theme}/components/pagination.d.ts +16 -16
  136. package/dist/{theme → src/theme}/components/progressIndicator.d.ts +68 -68
  137. package/dist/{theme → src/theme}/components/radio.d.ts +202 -202
  138. package/dist/{theme → src/theme}/components/radioGroup.d.ts +14 -14
  139. package/dist/{theme → src/theme}/components/searchBar.d.ts +34 -34
  140. package/dist/{theme → src/theme}/components/select.d.ts +125 -125
  141. package/dist/{theme → src/theme}/components/skeletonLoader.d.ts +105 -105
  142. package/dist/{theme → src/theme}/components/skipNavigation.d.ts +28 -28
  143. package/dist/{theme → src/theme}/components/slider.d.ts +78 -78
  144. package/dist/{theme → src/theme}/components/statusBadge.d.ts +37 -37
  145. package/dist/{theme → src/theme}/components/structuredContent.d.ts +385 -385
  146. package/dist/{theme → src/theme}/components/styledList.d.ts +51 -51
  147. package/dist/{theme → src/theme}/components/tabs.d.ts +172 -172
  148. package/dist/{theme → src/theme}/components/tagSet.d.ts +154 -154
  149. package/dist/{theme → src/theme}/components/template.d.ts +86 -86
  150. package/dist/{theme → src/theme}/components/text.d.ts +30 -30
  151. package/dist/{theme → src/theme}/components/textInput.d.ts +349 -349
  152. package/dist/{theme → src/theme}/components/toggle.d.ts +129 -129
  153. package/dist/{theme → src/theme}/components/tooltip.d.ts +19 -19
  154. package/dist/{theme → src/theme}/components/videoPlayer.d.ts +47 -47
  155. package/dist/{theme → src/theme}/foundations/breakpoints.d.ts +23 -23
  156. package/dist/{theme → src/theme}/foundations/colors.d.ts +3 -3
  157. package/dist/{theme → src/theme}/foundations/global.d.ts +68 -68
  158. package/dist/{theme → src/theme}/foundations/radii.d.ts +11 -11
  159. package/dist/{theme → src/theme}/foundations/shadows.d.ts +4 -4
  160. package/dist/{theme → src/theme}/foundations/spacing.d.ts +96 -96
  161. package/dist/{theme → src/theme}/foundations/typography.d.ts +8 -8
  162. package/dist/{theme → src/theme}/index.d.ts +20 -20
  163. package/dist/{theme → src/theme}/provider.d.ts +4 -4
  164. package/dist/src/theme/types.d.ts +1 -0
  165. package/dist/{utils → src/utils}/interfaces.d.ts +5 -5
  166. package/dist/{utils → src/utils}/utils.d.ts +39 -39
  167. package/dist/style.css +1 -0
  168. package/package.json +52 -61
  169. package/CHANGELOG.md +0 -1861
  170. package/dist/__tests__/fileMock.d.ts +0 -4
  171. package/dist/__tests__/mediaMatchMock.d.ts +0 -79
  172. package/dist/__tests__/setup.d.ts +0 -2
  173. package/dist/__tests__/utils/utils.test.d.ts +0 -1
  174. package/dist/components/Autosuggest/Autosuggest.stories.d.ts +0 -4
  175. package/dist/components/FilterBar/FilterBar.stories.d.ts +0 -7
  176. package/dist/components/Header/utils/authApiMockResponse.d.ts +0 -49
  177. package/dist/components/Header/utils/encoreCatalogLogOutTimer.d.ts +0 -4
  178. package/dist/components/Header/utils/encoreCatalogLogOutTimer.test.d.ts +0 -1
  179. package/dist/components/Header/utils/googleAnalyticsUtils.test.d.ts +0 -1
  180. package/dist/components/Header/utils/headerUtils.test.d.ts +0 -1
  181. package/dist/components/Header/utils/sitewideAlertsMocks.d.ts +0 -98
  182. package/dist/components/MultiSelect/MultiSelect.stories.d.ts +0 -4
  183. package/dist/components/MultiSelectGroup/MultiSelectGroup.stories.d.ts +0 -4
  184. package/dist/components/Placeholder/Placeholder.d.ts +0 -10
  185. package/dist/design-system-react-components.cjs.development.js +0 -17917
  186. package/dist/design-system-react-components.cjs.development.js.map +0 -1
  187. package/dist/design-system-react-components.cjs.production.min.js +0 -2
  188. package/dist/design-system-react-components.cjs.production.min.js.map +0 -1
  189. package/dist/design-system-react-components.esm.js +0 -17716
  190. package/dist/design-system-react-components.esm.js.map +0 -1
  191. package/dist/helpers/types.d.ts +0 -1
  192. package/dist/hooks/__tests__/useCarouselStyles.test.d.ts +0 -1
  193. package/dist/hooks/__tests__/useFilterBar.test.d.ts +0 -1
  194. package/dist/hooks/__tests__/useMultiSelect.test.d.ts +0 -1
  195. package/dist/hooks/__tests__/useNYPLBreakpoints.test.d.ts +0 -1
  196. package/dist/index.d.ts +0 -65
  197. package/dist/index.js +0 -8
  198. package/dist/resources.scss +0 -382
  199. package/dist/styles.css +0 -4
  200. package/dist/theme/types.d.ts +0 -1
  201. package/dist/utils/componentCategories.d.ts +0 -1
@@ -1,111 +1,61 @@
1
- import React from "react";
2
- import { LayoutTypes } from "../../helpers/types";
3
- import { SelectedItems } from "../MultiSelect/MultiSelect";
4
- interface FilterBarCommonProps {
5
- children: React.ReactNode;
6
- /** The id of the MultiSelect. */
7
- id?: string;
8
- /** Determines on Mobile if filter modal overlay is open or closed */
9
- isOpen: boolean;
10
- /** Heading text of FilterBar */
11
- headingText: string;
12
- /** Renders the layout of the FilterBar child components in a row or column. */
13
- layout?: LayoutTypes;
14
- /** The selected items state (items that were checked by user). */
15
- selectedItems: SelectedItems;
16
- /** User for the global `Clear Filters` button. This button is always shown on mobile, optional on desktop */
17
- onClear: () => void;
18
- /** If passed, the global `Clear Filters` button will render on desktop and tablet */
19
- showClearAll?: boolean;
20
- /** Set width of `FilterBar` child components */
21
- filterWidth?: string;
22
- }
23
- /** Types related to an optional global submit button `Apply Filters` */
24
- declare type SubmitAllProps = {
25
- /** If passed the `Apply Filters` button will render on desktop and tablet */
26
- showSubmitAll?: false;
27
- /** Function for `Apply Filters` button, needs to be provided by the consuming app */
28
- onSubmit?: never;
29
- }
30
- /** onSubmit is required only if showSubmitAll is passed */
31
- | {
32
- showSubmitAll: true;
33
- onSubmit: () => void;
34
- };
35
- /** Types related to the Modal handling */
36
- declare type HandleModalProps = {
37
- /** If onToggle is passed as prop, it will open and close the filter modal on mobile */
38
- onToggle: () => void;
39
- /** onOpen and onClose will not be used in this scenario */
40
- onOpen?: never;
41
- onClose?: never;
42
- } | {
43
- /** If onToggle is omitted, onOpen and onClose should be provided instead */
44
- onToggle?: undefined;
45
- /** onOpen will open the filter modal on mobile */
46
- onOpen: () => void;
47
- /** onClose will close the filter modal on mobile */
48
- onClose: () => void;
49
- };
50
- export declare type FilterBarProps = FilterBarCommonProps & SubmitAllProps & HandleModalProps;
51
- /**
52
- * `FilterBar` is a wrapper component for filter components.
53
- * The DS considers the following components as filter components:
54
- * - `MultiSelectGroup`
55
- *
56
- * The wrapped components/ component groups can be displayed in a column or
57
- * in a row layout. `FilterBar` can render additional `Clear All` and a `Apply Filters` buttons. The two
58
- * _optional_ buttons are controlled by the `showClearAll`/ `onClear` or `showSubmitAll`/`onSubmit` props repectively.
59
- */
60
- export declare const FilterBar: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<(FilterBarCommonProps & {
61
- /** If passed the `Apply Filters` button will render on desktop and tablet */
62
- showSubmitAll?: false;
63
- /** Function for `Apply Filters` button, needs to be provided by the consuming app */
64
- onSubmit?: never;
65
- } & {
66
- /** If onToggle is passed as prop, it will open and close the filter modal on mobile */
67
- onToggle: () => void;
68
- /** onOpen and onClose will not be used in this scenario */
69
- onOpen?: never;
70
- onClose?: never;
71
- } & {
72
- children?: React.ReactNode;
73
- } & React.RefAttributes<HTMLDivElement>) | (FilterBarCommonProps & {
74
- /** If passed the `Apply Filters` button will render on desktop and tablet */
75
- showSubmitAll?: false;
76
- /** Function for `Apply Filters` button, needs to be provided by the consuming app */
77
- onSubmit?: never;
78
- } & {
79
- /** If onToggle is omitted, onOpen and onClose should be provided instead */
80
- onToggle?: undefined;
81
- /** onOpen will open the filter modal on mobile */
82
- onOpen: () => void;
83
- /** onClose will close the filter modal on mobile */
84
- onClose: () => void;
85
- } & {
86
- children?: React.ReactNode;
87
- } & React.RefAttributes<HTMLDivElement>) | (FilterBarCommonProps & {
88
- showSubmitAll: true;
89
- onSubmit: () => void;
90
- } & {
91
- /** If onToggle is passed as prop, it will open and close the filter modal on mobile */
92
- onToggle: () => void;
93
- /** onOpen and onClose will not be used in this scenario */
94
- onOpen?: never;
95
- onClose?: never;
96
- } & {
97
- children?: React.ReactNode;
98
- } & React.RefAttributes<HTMLDivElement>) | (FilterBarCommonProps & {
99
- showSubmitAll: true;
100
- onSubmit: () => void;
101
- } & {
102
- /** If onToggle is omitted, onOpen and onClose should be provided instead */
103
- onToggle?: undefined;
104
- /** onOpen will open the filter modal on mobile */
105
- onOpen: () => void;
106
- /** onClose will close the filter modal on mobile */
107
- onClose: () => void;
108
- } & {
109
- children?: React.ReactNode;
110
- } & React.RefAttributes<HTMLDivElement>)>, {}>;
111
- export default FilterBar;
1
+ import React from "react";
2
+ import { LayoutTypes } from "../../helpers/types";
3
+ import { SelectedItems } from "../MultiSelect/MultiSelect";
4
+ interface FilterBarCommonProps {
5
+ children: React.ReactNode;
6
+ /** The id of the MultiSelect. */
7
+ id?: string;
8
+ /** Determines on Mobile if filter modal overlay is open or closed */
9
+ isOpen: boolean;
10
+ /** Heading text of FilterBar */
11
+ headingText: string;
12
+ /** Renders the layout of the FilterBar child components in a row or column. */
13
+ layout?: LayoutTypes;
14
+ /** The selected items state (items that were checked by user). */
15
+ selectedItems: SelectedItems;
16
+ /** User for the global `Clear Filters` button. This button is always shown on mobile, optional on desktop */
17
+ onClear: () => void;
18
+ /** If passed, the global `Clear Filters` button will render on desktop and tablet */
19
+ showClearAll?: boolean;
20
+ /** Set width of `FilterBar` child components */
21
+ filterWidth?: string;
22
+ }
23
+ /** Types related to an optional global submit button `Apply Filters` */
24
+ type SubmitAllProps = {
25
+ /** If passed the `Apply Filters` button will render on desktop and tablet */
26
+ showSubmitAll?: false;
27
+ /** Function for `Apply Filters` button, needs to be provided by the consuming app */
28
+ onSubmit?: never;
29
+ }
30
+ /** onSubmit is required only if showSubmitAll is passed */
31
+ | {
32
+ showSubmitAll: true;
33
+ onSubmit: () => void;
34
+ };
35
+ /** Types related to the Modal handling */
36
+ type HandleModalProps = {
37
+ /** If onToggle is passed as prop, it will open and close the filter modal on mobile */
38
+ onToggle: () => void;
39
+ /** onOpen and onClose will not be used in this scenario */
40
+ onOpen?: never;
41
+ onClose?: never;
42
+ } | {
43
+ /** If onToggle is omitted, onOpen and onClose should be provided instead */
44
+ onToggle?: undefined;
45
+ /** onOpen will open the filter modal on mobile */
46
+ onOpen: () => void;
47
+ /** onClose will close the filter modal on mobile */
48
+ onClose: () => void;
49
+ };
50
+ export type FilterBarProps = FilterBarCommonProps & SubmitAllProps & HandleModalProps;
51
+ /**
52
+ * `FilterBar` is a wrapper component for filter components.
53
+ * The DS considers the following components as filter components:
54
+ * - `MultiSelectGroup`
55
+ *
56
+ * The wrapped components/ component groups can be displayed in a column or
57
+ * in a row layout. `FilterBar` can render additional `Clear All` and a `Apply Filters` buttons. The two
58
+ * _optional_ buttons are controlled by the `showClearAll`/ `onClear` or `showSubmitAll`/`onSubmit` props repectively.
59
+ */
60
+ export declare const FilterBar: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<React.PropsWithChildren<FilterBarProps> & React.RefAttributes<HTMLDivElement>>, {}>;
61
+ export default FilterBar;
@@ -1,14 +1,14 @@
1
- import React from "react";
2
- interface FooterProps {
3
- /** Additional class name to add. */
4
- className?: string;
5
- /** ID that other components can cross reference for accessibility purposes */
6
- id?: string;
7
- }
8
- /**
9
- * This `Footer` component renders the NYPL-branded footer elements such
10
- * as navigational NYPL.org links, social media links, copyright, and
11
- * NYPL building facade image.
12
- */
13
- export declare const Footer: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<FooterProps & React.RefAttributes<HTMLDivElement>>, {}>;
14
- export default Footer;
1
+ import React from "react";
2
+ interface FooterProps {
3
+ /** Additional class name to add. */
4
+ className?: string;
5
+ /** ID that other components can cross reference for accessibility purposes */
6
+ id?: string;
7
+ }
8
+ /**
9
+ * This `Footer` component renders the NYPL-branded footer elements such
10
+ * as navigational NYPL.org links, social media links, copyright, and
11
+ * NYPL building facade image.
12
+ */
13
+ export declare const Footer: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<FooterProps & React.RefAttributes<HTMLDivElement>>, {}>;
14
+ export default Footer;
@@ -1,12 +1,12 @@
1
- declare const link: {
2
- nyplLinks: {
3
- text: string;
4
- href: string;
5
- }[][];
6
- socialMedia: {
7
- href: string;
8
- iconName: string;
9
- title: string;
10
- }[];
11
- };
12
- export default link;
1
+ declare const link: {
2
+ nyplLinks: {
3
+ text: string;
4
+ href: string;
5
+ }[][];
6
+ socialMedia: {
7
+ href: string;
8
+ iconName: string;
9
+ title: string;
10
+ }[];
11
+ };
12
+ export default link;
@@ -1,31 +1,31 @@
1
- import React from "react";
2
- import { GridGaps } from "../Grid/SimpleGrid";
3
- interface FormBaseProps {
4
- /** className to be applied to FormRow, FormField, and Form */
5
- className?: string;
6
- /** Optional spacing size; if omitted, the default `large` (2rem / 32px)
7
- * spacing will be used; ```IMPORTANT: for general form layout, this prop
8
- * should not be used``` */
9
- gap?: GridGaps;
10
- /** ID that other components can cross reference (internal use) */
11
- id: string;
12
- }
13
- export interface FormChildProps extends Partial<FormBaseProps> {
14
- }
15
- export interface FormProps extends FormBaseProps {
16
- /** Optional form `action` attribute */
17
- action?: string;
18
- /** Optional form `method` attribute */
19
- method?: "get" | "post";
20
- /** Function to call for the `onSubmit` form event. */
21
- onSubmit?: (e: React.FormEvent<any>) => void;
22
- }
23
- /** FormRow child-component */
24
- export declare const FormRow: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<FormChildProps>) => JSX.Element, {}>;
25
- /** FormField child-component */
26
- export declare const FormField: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<FormChildProps>) => JSX.Element, {}>;
27
- /** Main Form component */
28
- export declare const Form: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<FormProps & {
29
- children?: React.ReactNode;
30
- } & React.RefAttributes<HTMLDivElement & HTMLFormElement>>, {}>;
31
- export default Form;
1
+ import React from "react";
2
+ import { GridGaps } from "../Grid/SimpleGrid";
3
+ interface FormBaseProps {
4
+ /** className to be applied to FormRow, FormField, and Form */
5
+ className?: string;
6
+ /** Optional spacing size; if omitted, the default `large` (2rem / 32px)
7
+ * spacing will be used; ```IMPORTANT: for general form layout, this prop
8
+ * should not be used``` */
9
+ gap?: GridGaps;
10
+ /** ID that other components can cross reference (internal use) */
11
+ id: string;
12
+ }
13
+ export interface FormChildProps extends Partial<FormBaseProps> {
14
+ }
15
+ export interface FormProps extends FormBaseProps {
16
+ /** Optional form `action` attribute */
17
+ action?: string;
18
+ /** Optional form `method` attribute */
19
+ method?: "get" | "post";
20
+ /** Function to call for the `onSubmit` form event. */
21
+ onSubmit?: (e: React.FormEvent<any>) => void;
22
+ }
23
+ /** FormRow child-component */
24
+ export declare const FormRow: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<FormChildProps>) => JSX.Element, {}>;
25
+ /** FormField child-component */
26
+ export declare const FormField: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<FormChildProps>) => JSX.Element, {}>;
27
+ /** Main Form component */
28
+ export declare const Form: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<FormProps & {
29
+ children?: React.ReactNode;
30
+ } & React.RefAttributes<HTMLDivElement & HTMLFormElement>>, {}>;
31
+ export default Form;
@@ -1,19 +1,19 @@
1
- import React from "react";
2
- export declare type GridGaps = "grid.xxs" | "grid.xs" | "grid.s" | "grid.m" | "grid.l" | "grid.xl" | "grid.xxl";
3
- export interface SimpleGridProps {
4
- /** Additional class name. */
5
- className?: string;
6
- /** Optional numeric value to override the default column count; the default
7
- * column count is 3. */
8
- columns?: number;
9
- /** Optional gap size; if omitted, the default `large` (2rem / 32px) spacing
10
- * will be used; `IMPORTANT: for standard grid layouts, this prop should
11
- * not be used.` */
12
- gap?: GridGaps;
13
- /** ID that other components can cross reference for accessibility purposes */
14
- id?: string;
15
- }
16
- export declare const SimpleGrid: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SimpleGridProps & {
17
- children?: React.ReactNode;
18
- } & React.RefAttributes<HTMLDivElement>>, {}>;
19
- export default SimpleGrid;
1
+ import React from "react";
2
+ export type GridGaps = "grid.xxs" | "grid.xs" | "grid.s" | "grid.m" | "grid.l" | "grid.xl" | "grid.xxl";
3
+ export interface SimpleGridProps {
4
+ /** Additional class name. */
5
+ className?: string;
6
+ /** Optional numeric value to override the default column count; the default
7
+ * column count is 3. */
8
+ columns?: number;
9
+ /** Optional gap size; if omitted, the default `large` (2rem / 32px) spacing
10
+ * will be used; `IMPORTANT: for standard grid layouts, this prop should
11
+ * not be used.` */
12
+ gap?: GridGaps;
13
+ /** ID that other components can cross reference for accessibility purposes */
14
+ id?: string;
15
+ }
16
+ export declare const SimpleGrid: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<SimpleGridProps & {
17
+ children?: React.ReactNode;
18
+ } & React.RefAttributes<HTMLDivElement>>, {}>;
19
+ export default SimpleGrid;
@@ -1,22 +1,22 @@
1
- /// <reference types="react" />
2
- export interface GAOptionProps {
3
- debug?: boolean;
4
- standardImplementation?: boolean;
5
- testMode?: boolean;
6
- titleCase?: boolean;
7
- }
8
- export interface HeaderProps {
9
- /** Whether to render sitewide alerts or not. True by default. */
10
- fetchSitewideAlerts?: boolean;
11
- /** Google Analytics options to override the default settings. */
12
- gaOptions?: GAOptionProps;
13
- /** Whether or not the `Header` is in production mode. True by default. */
14
- isProduction?: boolean;
15
- }
16
- /**
17
- * The NYPL `Header` component is the top-level component of the site. It
18
- * contains features for logging in, logging out, searching, and navigating
19
- * the NYPL.org site.
20
- */
21
- export declare const Header: import("@chakra-ui/react").ChakraComponent<({ fetchSitewideAlerts, gaOptions, isProduction, }: HeaderProps) => JSX.Element, {}>;
22
- export default Header;
1
+ /// <reference types="react" />
2
+ export interface GAOptionProps {
3
+ debug?: boolean;
4
+ standardImplementation?: boolean;
5
+ testMode?: boolean;
6
+ titleCase?: boolean;
7
+ }
8
+ export interface HeaderProps {
9
+ /** Whether to render sitewide alerts or not. True by default. */
10
+ fetchSitewideAlerts?: boolean;
11
+ /** Google Analytics options to override the default settings. */
12
+ gaOptions?: GAOptionProps;
13
+ /** Whether or not the `Header` is in production mode. True by default. */
14
+ isProduction?: boolean;
15
+ }
16
+ /**
17
+ * The NYPL `Header` component is the top-level component of the site. It
18
+ * contains features for logging in, logging out, searching, and navigating
19
+ * the NYPL.org site.
20
+ */
21
+ export declare const Header: import("@chakra-ui/react").ChakraComponent<({ fetchSitewideAlerts, gaOptions, isProduction, }: HeaderProps) => JSX.Element, {}>;
22
+ export default Header;
@@ -1,12 +1,12 @@
1
- import React from "react";
2
- export interface HeaderLoginProps {
3
- catalogRef?: React.RefObject<HTMLDivElement & HTMLAnchorElement>;
4
- isMobile?: boolean;
5
- }
6
- /**
7
- * The content of the login dropdown menu. Initially, this renders links to log
8
- * in and log out. When the patron is logged in, it will also display the patron's
9
- * name, links to the catalogs, and a log out link.
10
- */
11
- declare const HeaderLogin: import("@chakra-ui/react").ChakraComponent<({ catalogRef, isMobile }: HeaderLoginProps) => JSX.Element, {}>;
12
- export default HeaderLogin;
1
+ import React from "react";
2
+ export interface HeaderLoginProps {
3
+ catalogRef?: React.RefObject<HTMLDivElement & HTMLAnchorElement>;
4
+ isMobile?: boolean;
5
+ }
6
+ /**
7
+ * The content of the login dropdown menu. Initially, this renders links to log
8
+ * in and log out. When the patron is logged in, it will also display the patron's
9
+ * name, links to the catalogs, and a log out link.
10
+ */
11
+ declare const HeaderLogin: import("@chakra-ui/react").ChakraComponent<({ catalogRef, isMobile }: HeaderLoginProps) => JSX.Element, {}>;
12
+ export default HeaderLogin;
@@ -1,11 +1,11 @@
1
- /// <reference types="react" />
2
- export interface HeaderLoginButtonProps {
3
- isMobile?: boolean;
4
- }
5
- /**
6
- * This is the button that will render the login menu when it is clicked
7
- * and keep focus trapped within the menu. Its display text will be "Log In"
8
- * when the user is not logged in and "My Account" when the user is logged in.
9
- */
10
- declare const HeaderLoginButton: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderLoginButtonProps) => JSX.Element, {}>;
11
- export default HeaderLoginButton;
1
+ /// <reference types="react" />
2
+ export interface HeaderLoginButtonProps {
3
+ isMobile?: boolean;
4
+ }
5
+ /**
6
+ * This is the button that will render the login menu when it is clicked
7
+ * and keep focus trapped within the menu. Its display text will be "Log In"
8
+ * when the user is not logged in and "My Account" when the user is logged in.
9
+ */
10
+ declare const HeaderLoginButton: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderLoginButtonProps) => JSX.Element, {}>;
11
+ export default HeaderLoginButton;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
2
- /**
3
- * This component renders the navigational list of links used to
4
- * navigate to different landing pages on NYPL.org.
5
- */
6
- declare const HeaderLowerNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
- export default HeaderLowerNav;
1
+ /// <reference types="react" />
2
+ /**
3
+ * This component renders the navigational list of links used to
4
+ * navigate to different landing pages on NYPL.org.
5
+ */
6
+ declare const HeaderLowerNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
+ export default HeaderLowerNav;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
2
- /**
3
- * This component renders the mobile list of icon buttons for
4
- * logging in, searching, and navigating on NYPL.org.
5
- */
6
- declare const HeaderMobileIconNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
- export default HeaderMobileIconNav;
1
+ /// <reference types="react" />
2
+ /**
3
+ * This component renders the mobile list of icon buttons for
4
+ * logging in, searching, and navigating on NYPL.org.
5
+ */
6
+ declare const HeaderMobileIconNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
+ export default HeaderMobileIconNav;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
2
- /**
3
- * This component renders the navigational list of links used to navigate
4
- * NYPL.org for mobile devices.
5
- */
6
- declare const HeaderMobileNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
- export default HeaderMobileNav;
1
+ /// <reference types="react" />
2
+ /**
3
+ * This component renders the navigational list of links used to navigate
4
+ * NYPL.org for mobile devices.
5
+ */
6
+ declare const HeaderMobileNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
+ export default HeaderMobileNav;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
2
- /**
3
- * This is the button that will render the navigational list of links
4
- * when it is clicked and keep focus trapped within the menu.
5
- */
6
- declare const HeaderMobileNavButton: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
- export default HeaderMobileNavButton;
1
+ /// <reference types="react" />
2
+ /**
3
+ * This is the button that will render the navigational list of links
4
+ * when it is clicked and keep focus trapped within the menu.
5
+ */
6
+ declare const HeaderMobileNavButton: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
7
+ export default HeaderMobileNavButton;
@@ -1,10 +1,10 @@
1
- /// <reference types="react" />
2
- export interface HeaderSearchButtonProps {
3
- isMobile?: boolean;
4
- }
5
- /**
6
- * This is the button that will render the search form when it is clicked and
7
- * keep focus trapped within the menu.
8
- */
9
- declare const HeaderSearchButton: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderSearchButtonProps) => JSX.Element, {}>;
10
- export default HeaderSearchButton;
1
+ /// <reference types="react" />
2
+ export interface HeaderSearchButtonProps {
3
+ isMobile?: boolean;
4
+ }
5
+ /**
6
+ * This is the button that will render the search form when it is clicked and
7
+ * keep focus trapped within the menu.
8
+ */
9
+ declare const HeaderSearchButton: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderSearchButtonProps) => JSX.Element, {}>;
10
+ export default HeaderSearchButton;
@@ -1,11 +1,11 @@
1
- /// <reference types="react" />
2
- export interface HeaderSearchFormProps {
3
- isMobile?: boolean;
4
- }
5
- export declare type SearchOptionType = "circulatingCatalog" | "researchCatalog" | "website";
6
- /**
7
- * Displays the search form for the Header's search interface. On mobile, two
8
- * buttons are displayed and on desktop, two radio inputs are displayed.
9
- */
10
- declare const HeaderSearchForm: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderSearchFormProps) => JSX.Element, {}>;
11
- export default HeaderSearchForm;
1
+ /// <reference types="react" />
2
+ export interface HeaderSearchFormProps {
3
+ isMobile?: boolean;
4
+ }
5
+ export type SearchOptionType = "circulatingCatalog" | "researchCatalog" | "website";
6
+ /**
7
+ * Displays the search form for the Header's search interface. On mobile, two
8
+ * buttons are displayed and on desktop, two radio inputs are displayed.
9
+ */
10
+ declare const HeaderSearchForm: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderSearchFormProps) => JSX.Element, {}>;
11
+ export default HeaderSearchForm;
@@ -1,8 +1,8 @@
1
- /// <reference types="react" />
2
- /**
3
- * The HeaderSitewideAlerts component makes an API request to an NYPL API
4
- * endpoint to fetch NYPL sitewide alerts. While this component can be used in
5
- * isolation, it is already rendered in the DS Header component.
6
- */
7
- export declare const HeaderSitewideAlerts: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
8
- export default HeaderSitewideAlerts;
1
+ /// <reference types="react" />
2
+ /**
3
+ * The HeaderSitewideAlerts component makes an API request to an NYPL API
4
+ * endpoint to fetch NYPL sitewide alerts. While this component can be used in
5
+ * isolation, it is already rendered in the DS Header component.
6
+ */
7
+ export declare const HeaderSitewideAlerts: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
8
+ export default HeaderSitewideAlerts;
@@ -1,8 +1,8 @@
1
- /// <reference types="react" />
2
- /**
3
- * This renders the navigational list of links for logging in, subscribing
4
- * to the email service, going to the Locations page, getting a Library card,
5
- * donating, and shopping at NYPL.
6
- */
7
- declare const HeaderUpperNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
8
- export default HeaderUpperNav;
1
+ /// <reference types="react" />
2
+ /**
3
+ * This renders the navigational list of links for logging in, subscribing
4
+ * to the email service, going to the Locations page, getting a Library card,
5
+ * donating, and shopping at NYPL.
6
+ */
7
+ declare const HeaderUpperNav: import("@chakra-ui/react").ChakraComponent<() => JSX.Element, {}>;
8
+ export default HeaderUpperNav;
@@ -1,13 +1,13 @@
1
- import React from "react";
2
- /**
3
- * Context used for patron and production status data.
4
- */
5
- export declare const HeaderContext: React.Context<any>;
6
- /**
7
- * Context Provider used only in the Header component.
8
- */
9
- export declare const HeaderProvider: ({ children, isProduction, patronName, }: {
10
- children: any;
11
- isProduction?: boolean;
12
- patronName?: string;
13
- }) => JSX.Element;
1
+ import React from "react";
2
+ /**
3
+ * Context used for patron and production status data.
4
+ */
5
+ export declare const HeaderContext: React.Context<any>;
6
+ /**
7
+ * Context Provider used only in the Header component.
8
+ */
9
+ export declare const HeaderProvider: ({ children, isProduction, patronName, }: {
10
+ children: any;
11
+ isProduction?: boolean;
12
+ patronName?: string;
13
+ }) => JSX.Element;
@@ -1,16 +1,16 @@
1
- export declare const envConfig: {
2
- production: string;
3
- development: string;
4
- };
5
- export declare const gaConfig: {
6
- eventCategory: string;
7
- eventAction: string;
8
- customDimensions: {
9
- dimension1: string;
10
- dimension2: string;
11
- dimension4: string;
12
- dimension5: string;
13
- };
14
- };
15
- declare const gaUtils: any;
16
- export default gaUtils;
1
+ export declare const envConfig: {
2
+ production: string;
3
+ development: string;
4
+ };
5
+ export declare const gaConfig: {
6
+ eventCategory: string;
7
+ eventAction: string;
8
+ customDimensions: {
9
+ dimension1: string;
10
+ dimension2: string;
11
+ dimension4: string;
12
+ dimension5: string;
13
+ };
14
+ };
15
+ declare const gaUtils: any;
16
+ export default gaUtils;