@czi-sds/mcp 0.3.0 → 0.4.0

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 (145) hide show
  1. package/data/component-props/Accordion.json +14 -15
  2. package/data/component-props/Alert.json +2 -44
  3. package/data/component-props/Autocomplete.json +14 -32
  4. package/data/component-props/Banner.json +11 -12
  5. package/data/component-props/Button.json +17 -82
  6. package/data/component-props/ButtonDropdown.json +26 -0
  7. package/data/component-props/ButtonIcon.json +4 -60
  8. package/data/component-props/ButtonToggle.json +2 -66
  9. package/data/component-props/Callout.json +11 -65
  10. package/data/component-props/CellBasic.json +28 -56
  11. package/data/component-props/CellComponent.json +4 -32
  12. package/data/component-props/CellHeader.json +13 -49
  13. package/data/component-props/ComplexFilter.json +24 -4
  14. package/data/component-props/ContentCard.json +66 -2
  15. package/data/component-props/Dialog.json +26 -0
  16. package/data/component-props/Dropdown.json +29 -67
  17. package/data/component-props/DropdownMenu.json +16 -56
  18. package/data/component-props/HeatmapChart.json +6 -87
  19. package/data/component-props/Icon.json +3 -8
  20. package/data/component-props/InputCheckbox.json +5 -53
  21. package/data/component-props/InputDropdown.json +11 -33
  22. package/data/component-props/InputRadio.json +5 -53
  23. package/data/component-props/InputSearch.json +6 -70
  24. package/data/component-props/InputSlider.json +21 -35
  25. package/data/component-props/InputText.json +7 -63
  26. package/data/component-props/InputToggle.json +5 -54
  27. package/data/component-props/Link.json +18 -0
  28. package/data/component-props/LoadingIndicator.json +1 -2
  29. package/data/component-props/MenuItem.json +11 -41
  30. package/data/component-props/MenuSelect.json +4 -67
  31. package/data/component-props/NavigationFooter.json +0 -8
  32. package/data/component-props/NavigationHeader.json +14 -65
  33. package/data/component-props/NavigationJumpTo.json +0 -40
  34. package/data/component-props/Notification.json +14 -58
  35. package/data/component-props/Pagination.json +8 -33
  36. package/data/component-props/Panel.json +4 -54
  37. package/data/component-props/SegmentedControl.json +0 -55
  38. package/data/component-props/TableRow.json +10 -38
  39. package/data/component-props/Tabs.json +18 -0
  40. package/data/component-props/Tag.json +10 -56
  41. package/data/component-props/TagFilter.json +0 -47
  42. package/data/component-props/Tooltip.json +12 -61
  43. package/data/component-props/TooltipCondensed.json +18 -0
  44. package/data/component-props/TooltipTable.json +0 -4
  45. package/data/zeroheight-exports/Accordion.md +167 -125
  46. package/data/zeroheight-exports/Banner.md +71 -48
  47. package/data/zeroheight-exports/Borders.md +72 -73
  48. package/data/zeroheight-exports/Buttons.md +375 -330
  49. package/data/zeroheight-exports/Callout.md +138 -116
  50. package/data/zeroheight-exports/Colors.md +254 -255
  51. package/data/zeroheight-exports/Content-Card.md +36 -37
  52. package/data/zeroheight-exports/Contributing-to-SDS.md +34 -35
  53. package/data/zeroheight-exports/Control-Inputs.md +289 -234
  54. package/data/zeroheight-exports/Corners.md +63 -64
  55. package/data/zeroheight-exports/Cover-page.md +0 -1
  56. package/data/zeroheight-exports/Dialog.md +237 -179
  57. package/data/zeroheight-exports/Downloads.md +10 -11
  58. package/data/zeroheight-exports/Drop-Shadows.md +40 -41
  59. package/data/zeroheight-exports/Dropdown-Input.md +158 -127
  60. package/data/zeroheight-exports/Dropdown-Menu.md +814 -718
  61. package/data/zeroheight-exports/Element-Status-Tracker.md +191 -192
  62. package/data/zeroheight-exports/Field-Inputs.md +149 -130
  63. package/data/zeroheight-exports/Filters.md +114 -94
  64. package/data/zeroheight-exports/Getting-Started.md +112 -249
  65. package/data/zeroheight-exports/Hero.md +43 -37
  66. package/data/zeroheight-exports/Icons.md +205 -206
  67. package/data/zeroheight-exports/Intent.md +6 -7
  68. package/data/zeroheight-exports/Introduction-to-Bases.md +8 -9
  69. package/data/zeroheight-exports/Introduction-to-Cells.md +11 -12
  70. package/data/zeroheight-exports/Introduction-to-DNA.md +8 -9
  71. package/data/zeroheight-exports/Introduction-to-Genes.md +8 -9
  72. package/data/zeroheight-exports/Introduction.md +52 -53
  73. package/data/zeroheight-exports/Link.md +50 -37
  74. package/data/zeroheight-exports/Lists.md +78 -63
  75. package/data/zeroheight-exports/Loading-Indicator.md +7 -8
  76. package/data/zeroheight-exports/Navigation.md +163 -142
  77. package/data/zeroheight-exports/Notification.md +132 -102
  78. package/data/zeroheight-exports/Panel.md +231 -115
  79. package/data/zeroheight-exports/Responsive-Design.md +35 -32
  80. package/data/zeroheight-exports/Search-Input.md +9 -10
  81. package/data/zeroheight-exports/Search.md +87 -104
  82. package/data/zeroheight-exports/Segmented-Control.md +68 -45
  83. package/data/zeroheight-exports/Spacing.md +210 -211
  84. package/data/zeroheight-exports/Table.md +414 -302
  85. package/data/zeroheight-exports/Tabs.md +126 -98
  86. package/data/zeroheight-exports/Tags.md +148 -118
  87. package/data/zeroheight-exports/Text-Link.md +32 -33
  88. package/data/zeroheight-exports/Theming.md +48 -29
  89. package/data/zeroheight-exports/Tooltips.md +253 -237
  90. package/data/zeroheight-exports/Typography.md +463 -464
  91. package/dist/stdio.js +44 -132
  92. package/package.json +3 -4
  93. package/data/component-props/Chip.json +0 -73
  94. package/data/component-props/List.json +0 -43
  95. package/data/component-props/Menu.json +0 -48
  96. package/data/component-props/Table.json +0 -26
  97. package/data/component-props-storybook/Accordion-storybook.json +0 -45
  98. package/data/component-props-storybook/Alert-storybook.json +0 -30
  99. package/data/component-props-storybook/Autocomplete-storybook.json +0 -67
  100. package/data/component-props-storybook/Banner-storybook.json +0 -78
  101. package/data/component-props-storybook/Button-storybook.json +0 -115
  102. package/data/component-props-storybook/ButtonDropdown-storybook.json +0 -73
  103. package/data/component-props-storybook/ButtonIcon-storybook.json +0 -60
  104. package/data/component-props-storybook/ButtonToggle-storybook.json +0 -68
  105. package/data/component-props-storybook/Callout-storybook.json +0 -90
  106. package/data/component-props-storybook/CellBasic-storybook.json +0 -138
  107. package/data/component-props-storybook/CellComponent-storybook.json +0 -48
  108. package/data/component-props-storybook/CellHeader-storybook.json +0 -71
  109. package/data/component-props-storybook/Chip-storybook.json +0 -26
  110. package/data/component-props-storybook/ComplexFilter-storybook.json +0 -60
  111. package/data/component-props-storybook/ContentCard-storybook.json +0 -175
  112. package/data/component-props-storybook/Dialog-storybook.json +0 -56
  113. package/data/component-props-storybook/Dropdown-storybook.json +0 -93
  114. package/data/component-props-storybook/DropdownMenu-storybook.json +0 -73
  115. package/data/component-props-storybook/HeatmapChart-storybook.json +0 -55
  116. package/data/component-props-storybook/Icon-storybook.json +0 -75
  117. package/data/component-props-storybook/InputCheckbox-storybook.json +0 -57
  118. package/data/component-props-storybook/InputDropdown-storybook.json +0 -80
  119. package/data/component-props-storybook/InputRadio-storybook.json +0 -56
  120. package/data/component-props-storybook/InputSearch-storybook.json +0 -55
  121. package/data/component-props-storybook/InputSlider-storybook.json +0 -55
  122. package/data/component-props-storybook/InputText-storybook.json +0 -59
  123. package/data/component-props-storybook/InputToggle-storybook.json +0 -42
  124. package/data/component-props-storybook/Link-storybook.json +0 -50
  125. package/data/component-props-storybook/List-storybook.json +0 -26
  126. package/data/component-props-storybook/LoadingIndicator-storybook.json +0 -34
  127. package/data/component-props-storybook/Menu-storybook.json +0 -26
  128. package/data/component-props-storybook/MenuItem-storybook.json +0 -74
  129. package/data/component-props-storybook/MenuSelect-storybook.json +0 -38
  130. package/data/component-props-storybook/NavigationFooter-storybook.json +0 -67
  131. package/data/component-props-storybook/NavigationHeader-storybook.json +0 -115
  132. package/data/component-props-storybook/NavigationJumpTo-storybook.json +0 -41
  133. package/data/component-props-storybook/Notification-storybook.json +0 -89
  134. package/data/component-props-storybook/Pagination-storybook.json +0 -50
  135. package/data/component-props-storybook/Panel-storybook.json +0 -52
  136. package/data/component-props-storybook/SegmentedControl-storybook.json +0 -30
  137. package/data/component-props-storybook/Table-storybook.json +0 -26
  138. package/data/component-props-storybook/TableHeader-storybook.json +0 -26
  139. package/data/component-props-storybook/TableRow-storybook.json +0 -62
  140. package/data/component-props-storybook/Tabs-storybook.json +0 -45
  141. package/data/component-props-storybook/Tag-storybook.json +0 -78
  142. package/data/component-props-storybook/TagFilter-storybook.json +0 -30
  143. package/data/component-props-storybook/Tooltip-storybook.json +0 -85
  144. package/data/component-props-storybook/TooltipCondensed-storybook.json +0 -38
  145. package/data/component-props-storybook/TooltipTable-storybook.json +0 -47
@@ -6,15 +6,15 @@ Callouts are used within the flow of the page to highlight information to the us
6
6
 
7
7
  ## Callout Variants
8
8
 
9
- | Callouts come in three different variants for designers to use depending on the type of information they need to display and whether they want the user to have the ability to manually dismiss them or not. All Callout variants can be set to automatically dismiss after a designated period of time (8 seconds by default). Callouts appear within the flow of the page as opposed to Notifications which appear outside of the page's flow on top of other elements. They span the full width of the `<div>` they are placed within. Follow the usage criteria accompanying each variant as a guide for selecting the correct Callout for any given use case. | | **Jump to variant:** Persistent Dismissible Expandable Intent Variations |
10
- | --- | --- | --- |
9
+ | Callouts come in three different variants for designers to use depending on the type of information they need to display and whether they want the user to have the ability to manually dismiss them or not. All Callout variants can be set to automatically dismiss after a designated period of time (8 seconds by default). Callouts appear within the flow of the page as opposed to Notifications which appear outside of the page's flow on top of other elements. They span the full width of the `<div>` they are placed within. Follow the usage criteria accompanying each variant as a guide for selecting the correct Callout for any given use case. | | **Jump to variant:** Persistent Dismissible Expandable Intent Variations |
10
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ------------------------------------------------------------------------ |
11
11
 
12
12
  ---
13
13
 
14
14
  ## Callout
15
15
 
16
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
17
- | --- | --- | --- | --- | --- | --- | --- | --- |
16
+ | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
17
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
18
18
 
19
19
  ### Persistent Callout
20
20
 
@@ -26,7 +26,7 @@ An additional block of text can be added in addition to the Callout's title if m
26
26
 
27
27
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
28
28
 
29
-  
29
+
30
30
 
31
31
  ---
32
32
 
@@ -52,7 +52,7 @@ Additional content, whether more text or relevant components, can be included in
52
52
 
53
53
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
54
54
 
55
-  
55
+
56
56
 
57
57
  ---
58
58
 
@@ -73,27 +73,27 @@ There are four different intents that all Callout variants can communicate—Inf
73
73
  Each intent is demonstrated below using the Persistent Callout for reference. Regardless of variant, the colors and icons used are the same:
74
74
 
75
75
  | **Error** | **Info** |
76
- | --- | --- |
76
+ | --------- | -------- |
77
77
 
78
78
  | **Success** | **Warning** |
79
- | --- | --- |
79
+ | ----------- | ----------- |
80
80
 
81
81
  ## Code
82
82
 
83
83
  ## Callout Component
84
84
 
85
- | Below you will find an interactive Storybook iframe for Callouts. Tabs within each iframe provide a different set of tools: The Controls tab allows you to see and adjust all available props. The Actions tab shows you data displayed by event handler arguments. | | **Jump to component:** Callout |
86
- | --- | --- | --- |
85
+ | Below you will find an interactive Storybook iframe for Callouts. Tabs within each iframe provide a different set of tools: The Controls tab allows you to see and adjust all available props. The Actions tab shows you data displayed by event handler arguments. | | **Jump to component:** Callout |
86
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------ |
87
87
 
88
88
  ---
89
89
 
90
- >This component appears as it is in the default SDS codebase. Once imported into the CZ GEN EPI codebase, use a theme file to enable the CZ GEN EPI visual appearance customization.
90
+ > This component appears as it is in the default SDS codebase. Once imported into the CZ GEN EPI codebase, use a theme file to enable the CZ GEN EPI visual appearance customization.
91
91
 
92
92
  ### Callout
93
93
 
94
94
  Storybook
95
95
 
96
-  
96
+
97
97
 
98
98
  ---
99
99
 
@@ -103,15 +103,15 @@ Callouts are used within the flow of the page to highlight information to the us
103
103
 
104
104
  ## Callout Variants
105
105
 
106
- | Callouts come in three different variants for designers to use depending on the type of information they need to display and whether they want the user to have the ability to manually dismiss them or not. All Callout variants can be set to automatically dismiss after a designated period of time (8 seconds by default). Callouts appear within the flow of the page as opposed to Notifications which appear outside of the page's flow on top of other elements. They span the full width of the `<div>` they are placed within. Follow the usage criteria accompanying each variant as a guide for selecting the correct Callout for any given use case. | | **Jump to variant:** Persistent Dismissible Expandable Intent Variations |
107
- | --- | --- | --- |
106
+ | Callouts come in three different variants for designers to use depending on the type of information they need to display and whether they want the user to have the ability to manually dismiss them or not. All Callout variants can be set to automatically dismiss after a designated period of time (8 seconds by default). Callouts appear within the flow of the page as opposed to Notifications which appear outside of the page's flow on top of other elements. They span the full width of the `<div>` they are placed within. Follow the usage criteria accompanying each variant as a guide for selecting the correct Callout for any given use case. | | **Jump to variant:** Persistent Dismissible Expandable Intent Variations |
107
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ------------------------------------------------------------------------ |
108
108
 
109
109
  ---
110
110
 
111
111
  ## Callout
112
112
 
113
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
114
- | --- | --- | --- | --- | --- | --- | --- | --- |
113
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
114
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
115
115
 
116
116
  ### Persistent Callout
117
117
 
@@ -123,11 +123,11 @@ An additional block of text can be added in addition to the Callout's title if m
123
123
 
124
124
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
125
125
 
126
-  
126
+
127
127
 
128
128
  ---
129
129
 
130
-  
130
+
131
131
 
132
132
  ### Dismissible Callout
133
133
 
@@ -151,7 +151,7 @@ Additional content, whether more text or relevant components, can be included in
151
151
 
152
152
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
153
153
 
154
-  
154
+
155
155
 
156
156
  ---
157
157
 
@@ -174,17 +174,17 @@ There are four different intents that all Callout variants can communicate—Inf
174
174
  Each intent is demonstrated below using the Persistent Callout for reference. Regardless of variant, the colors and icons used are the same:
175
175
 
176
176
  | **Error** | **Info** |
177
- | --- | --- |
177
+ | --------- | -------- |
178
178
 
179
179
  | **Success** | **Warning** |
180
- | --- | --- |
180
+ | ----------- | ----------- |
181
181
 
182
182
  ## Code
183
183
 
184
184
  ## Callout Component
185
185
 
186
- | Below you will find an interactive Storybook iframe for Callouts. Tabs within each iframe provide a different set of tools: The Controls tab allows you to see and adjust all available props. The Actions tab shows you data displayed by event handler arguments. | | **Jump to component:** Callout |
187
- | --- | --- | --- |
186
+ | Below you will find an interactive Storybook iframe for Callouts. Tabs within each iframe provide a different set of tools: The Controls tab allows you to see and adjust all available props. The Actions tab shows you data displayed by event handler arguments. | | **Jump to component:** Callout |
187
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------ |
188
188
 
189
189
  ---
190
190
 
@@ -200,8 +200,8 @@ Callouts are used within the flow of the page to highlight information to the us
200
200
 
201
201
  ## Overview
202
202
 
203
- | | In Figma | | | Meets Accessibility | | | In Code |
204
- | --- | --- | --- | --- | --- | --- | --- | --- |
203
+ | | In Figma | | | Meets Accessibility | | | In Code |
204
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
205
205
 
206
206
  ### Callout Variants
207
207
 
@@ -224,7 +224,7 @@ Default
224
224
  Use Callout – Persistent when communicating information that should remain on the screen and can't be manually dismissed by the user. Additional text may be displayed below the Callout's title.
225
225
 
226
226
  | Default | Default + Alert Text |
227
- | --- | --- |
227
+ | ------- | -------------------- |
228
228
 
229
229
  ---
230
230
 
@@ -233,7 +233,7 @@ Use Callout – Persistent when communicating information that should remain on
233
233
  Use when communicating information that doesn't need to remain on the screen and, therefore, may be dismissed by the user. Additional text may be displayed below the Callout's title.
234
234
 
235
235
  | Default | Default + Alert Text |
236
- | --- | --- |
236
+ | ------- | -------------------- |
237
237
 
238
238
  ---
239
239
 
@@ -242,7 +242,7 @@ Use when communicating information that doesn't need to remain on the screen and
242
242
  Use when communicating a lot of information that may be useful, but isn't strictly necessary for the user to see, since the additional content may be hidden by the Accordion. Additional text may be displayed below the Callout's title, outside of the accordion. This Callout variant remains on the screen and can't be manually dismissed by the user.
243
243
 
244
244
  | Collapsed | Collapsed + Alert Text | Expanded + Content Module | Expanded + Alert Text + Content Module |
245
- | --- | --- | --- | --- |
245
+ | --------- | ---------------------- | ------------------------- | -------------------------------------- |
246
246
 
247
247
  ---
248
248
 
@@ -259,11 +259,11 @@ There are four different intents that Callouts can communicate: Info, Negative,
259
259
  Each intent is demonstrated below using the Persistent variant for reference. Regardless of variant, the colors and icons used are the same.
260
260
 
261
261
  | Info | Negative | Notice | Positive |
262
- | --- | --- | --- | --- |
262
+ | ---- | -------- | ------ | -------- |
263
263
 
264
264
  ## Code
265
265
 
266
- >**Note:** The code examples below must install dependencies before displaying and may take extra time to load
266
+ > **Note:** The code examples below must install dependencies before displaying and may take extra time to load
267
267
 
268
268
  ## Callout
269
269
 
@@ -273,19 +273,19 @@ The component's source code in the SDS codebase can be found here.
273
273
 
274
274
  ### SDS vs MUI
275
275
 
276
- The SDS `Callout` component is built upon the MUI `Alert` component (as is the SDS `Notification` component), but there are some important differences:
276
+ The SDS `Callout` component is built upon the MUI `Alert` component (as is the SDS `Notification` component), but there are some important differences:
277
277
 
278
- * **Color:** SDS's `Callout` component has its own `intent` prop designed for setting both the color and default icon, and takes the values of `"info"`, `"error"`, `"success"`, or `"warning"`. MUI's `Alert` instead uses the `severity` prop for this purpose (`severity` can also be used for SDS's `Notification`, and will take the same values as `intent`; this is not recommended)
279
- * **Titles:** SDS's `Callout` uses the `CalloutTitle` in place of the `AlertTitle` used by MUI's `Alert` to wrap title text. It is a stylized version of `AlertTitle`, and can be imported with `import { CalloutTitle } from "@czi-sds/components"`
280
- * **Expanding and closing:** SDS's `Callout` introduces a prop called `expandable` that, when `true`, allows any additional text (beyond the title text) to be visible or hidden by toggling a chevron (automatically added) in the top right of the callout (`expandable` should ideally only be used if there *is* in fact text in addition to the title text; otherwise the chevron will still appear but will not do anything functional because there will be no extra text to reveal). If the ability to close the Callout is desired, pass a callback function to `onClose`, and SDS will automatically render a close button. SDS uses MUI's Alert `action` prop under the hood, in case there is a need to further override the behavior
281
- * **Transitions:** SDS's `Callout` uses the `Grow` transition component by default
282
- * **Icons:** Like with MUI's `Alert`, SDS's `Callout` also shows an icon to the left of the title text. This can be changed manually (it also changes automatically based on the `intent` setting; see first bullet). The format for setting the `icon` prop for SDS's `Notification` is slightly different than for MUI, in that it invokes the `Icon` component:
278
+ - **Color:** SDS's `Callout` component has its own `intent` prop designed for setting both the color and default icon, and takes the values of `"info"`, `"error"`, `"success"`, or `"warning"`. MUI's `Alert` instead uses the `severity` prop for this purpose (`severity` can also be used for SDS's `Notification`, and will take the same values as `intent`; this is not recommended)
279
+ - **Titles:** SDS's `Callout` uses the `CalloutTitle` in place of the `AlertTitle` used by MUI's `Alert` to wrap title text. It is a stylized version of `AlertTitle`, and can be imported with `import { CalloutTitle } from "@czi-sds/components"`
280
+ - **Expanding and closing:** SDS's `Callout` introduces a prop called `expandable` that, when `true`, allows any additional text (beyond the title text) to be visible or hidden by toggling a chevron (automatically added) in the top right of the callout (`expandable` should ideally only be used if there _is_ in fact text in addition to the title text; otherwise the chevron will still appear but will not do anything functional because there will be no extra text to reveal). If the ability to close the Callout is desired, pass a callback function to `onClose`, and SDS will automatically render a close button. SDS uses MUI's Alert `action` prop under the hood, in case there is a need to further override the behavior
281
+ - **Transitions:** SDS's `Callout` uses the `Grow` transition component by default
282
+ - **Icons:** Like with MUI's `Alert`, SDS's `Callout` also shows an icon to the left of the title text. This can be changed manually (it also changes automatically based on the `intent` setting; see first bullet). The format for setting the `icon` prop for SDS's `Notification` is slightly different than for MUI, in that it invokes the `Icon` component:
283
283
 
284
- `icon={<Icon sdsSize="l" sdsIcon="download" sdsType="static" />`
284
+ `icon={<Icon sdsSize="l" sdsIcon="download" sdsType="static" />`
285
285
 
286
- Additionally, setting `icon={false}` has no effect, and `iconMapping` does not work to change icons associated to `intent` or `severity`.
286
+ Additionally, setting `icon={false}` has no effect, and `iconMapping` does not work to change icons associated to `intent` or `severity`.
287
287
 
288
- * **Variants:** The `variant` prop is not available for SDS's `Callout` component.
288
+ - **Variants:** The `variant` prop is not available for SDS's `Callout` component.
289
289
 
290
290
  ### MUI Documentation
291
291
 
@@ -295,18 +295,18 @@ Documentation for the underlying MUI `Alert` component can be found here.
295
295
 
296
296
  Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
297
297
 
298
- | Name | Type | Default | Description |
299
- | --- | --- | --- | --- |
300
- | `autoDismiss` | `bool` | `false` | Control the automatic dismissal behavior of `Callouts`. Specify a numeric value in milliseconds to set the duration after which the callout will automatically disappear. Alternatively, set `autoDismiss` to `false` to keep the callout visible until manually dismissed. |
301
- | `intent` | `"info"` `| "negative"` `| "positive"` `| "notice"` | `-` | The color of the component. |
302
- | `icon` | `ReactNode` | `-` | Icon displayed to the left of the `Callout` title. |
303
- | `onClose` | `func` | `function(event: React.SyntheticEvent) => void` | Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked. |
304
- | `title` | `string` | `-` | Callout title |
305
- | `hideTitle` | `boolean` | `false` | If set to `true`, Hides the Callout title |
306
- | `body` | `string` | `-` | Callout body |
307
- | `hideBody` | `boolean` | `false` | If set to `true`, Hides the Callout body |
308
- | `children` | `ReactNode` | `-` | Extra content to show in the component slot section of the Callout |
309
- | `sdsStyle` | `| "persistent"``| "expandable"``| "dismissible"` | `"persistent"` | Defines the style of the Callout:  - "persistent": Cannot be closed.  - "expandable": Includes a chevron icon to toggle extra content visibility.  - "dismissible": Includes an “x” icon for manual dismissal. |
298
+ | Name | Type | Default | Description |
299
+ | ------------- | ----------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
300
+ | `autoDismiss` | `bool` | `false` | Control the automatic dismissal behavior of `Callouts`. Specify a numeric value in milliseconds to set the duration after which the callout will automatically disappear. Alternatively, set `autoDismiss` to `false` to keep the callout visible until manually dismissed. |
301
+ | `intent` | `"info"` ` | "negative"` ` | "positive"` ` | "notice"` | `-` | The color of the component. |
302
+ | `icon` | `ReactNode` | `-` | Icon displayed to the left of the `Callout` title. |
303
+ | `onClose` | `func` | `function(event: React.SyntheticEvent) => void` | Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked. |
304
+ | `title` | `string` | `-` | Callout title |
305
+ | `hideTitle` | `boolean` | `false` | If set to `true`, Hides the Callout title |
306
+ | `body` | `string` | `-` | Callout body |
307
+ | `hideBody` | `boolean` | `false` | If set to `true`, Hides the Callout body |
308
+ | `children` | `ReactNode` | `-` | Extra content to show in the component slot section of the Callout |
309
+ | `sdsStyle` | ` | "persistent"`` | "expandable"`` | "dismissible"` | `"persistent"` | Defines the style of the Callout:  - "persistent": Cannot be closed.  - "expandable": Includes a chevron icon to toggle extra content visibility.  - "dismissible": Includes an “x” icon for manual dismissal. |
310
310
 
311
311
  ### Code examples
312
312
 
@@ -339,13 +339,11 @@ h1 {
339
339
 
340
340
  ```json
341
341
  {
342
- "include": [
343
- "./**/*"
344
- ],
342
+ "include": ["./**/*"],
345
343
  "compilerOptions": {
346
344
  "strict": true,
347
345
  "esModuleInterop": true,
348
- "lib": [ "dom", "es2015" ],
346
+ "lib": ["dom", "es2015"],
349
347
  "jsx": "react-jsx"
350
348
  }
351
349
  }
@@ -355,20 +353,19 @@ h1 {
355
353
 
356
354
  ```tsx
357
355
  // Most minimal Callout (just has the basic requirements)
358
-
356
+
359
357
  import { Callout, CalloutTitle } from "@czi-sds/components";
360
358
  import "./styles.css";
361
359
 
362
360
  function App() {
363
361
  return (
364
362
  <div className="app">
365
- <Callout
366
- intent="info"
367
- >
363
+ <Callout intent="info">
368
364
  <CalloutTitle>Callout box</CalloutTitle>
369
- The Callout Box component is a versatile UI element designed to draw attention to important
370
- information or messages within your interface. With its clean and elegant design, the
371
- Callout Box helps highlight key content, alerts, or contextual details.
365
+ The Callout Box component is a versatile UI element designed to draw
366
+ attention to important information or messages within your interface.
367
+ With its clean and elegant design, the Callout Box helps highlight key
368
+ content, alerts, or contextual details.
372
369
  </Callout>
373
370
  </div>
374
371
  );
@@ -414,13 +411,12 @@ root.render(
414
411
  <RootApp />
415
412
  </React.StrictMode>
416
413
  );
417
-
418
414
  ```
419
415
 
420
416
  **/public/index.html**
421
417
 
422
418
  ```html
423
- <!DOCTYPE html>
419
+ <!doctype html>
424
420
  <html lang="en">
425
421
  <head>
426
422
  <meta charset="UTF-8" />
@@ -441,20 +437,31 @@ root.render(
441
437
  <div id="root"></div>
442
438
  </body>
443
439
  </html>
444
-
445
440
  ```
446
441
 
447
442
  **/package.json**
448
443
 
449
444
  ```json
450
- {"dependencies":{"react":"^18.0.0","react-dom":"^18.0.0","react-scripts":"^4.0.0"},"devDependencies":{"@types/react":"^18.0.0","@types/react-dom":"^18.0.0","typescript":"^4.0.0"},"main":"/index.tsx"}
445
+ {
446
+ "dependencies": {
447
+ "react": "^18.0.0",
448
+ "react-dom": "^18.0.0",
449
+ "react-scripts": "^4.0.0"
450
+ },
451
+ "devDependencies": {
452
+ "@types/react": "^18.0.0",
453
+ "@types/react-dom": "^18.0.0",
454
+ "typescript": "^4.0.0"
455
+ },
456
+ "main": "/index.tsx"
457
+ }
451
458
  ```
452
459
 
453
460
  ---
454
461
 
455
462
  #### Expandable Callout
456
463
 
457
- The Expandable `Callout` component provides an interactive and space-efficient way to present information. By default, it displays a brief summary, however, users can expand it to reveal more detailed content, similar to an accordion. This feature is particularly useful for sharing additional context or insights while keeping the initial interface clutter-free.
464
+ The Expandable `Callout` component provides an interactive and space-efficient way to present information. By default, it displays a brief summary, however, users can expand it to reveal more detailed content, similar to an accordion. This feature is particularly useful for sharing additional context or insights while keeping the initial interface clutter-free.
458
465
 
459
466
  **/styles.css**
460
467
 
@@ -481,13 +488,11 @@ h1 {
481
488
 
482
489
  ```json
483
490
  {
484
- "include": [
485
- "./**/*"
486
- ],
491
+ "include": ["./**/*"],
487
492
  "compilerOptions": {
488
493
  "strict": true,
489
494
  "esModuleInterop": true,
490
- "lib": [ "dom", "es2015" ],
495
+ "lib": ["dom", "es2015"],
491
496
  "jsx": "react-jsx"
492
497
  }
493
498
  }
@@ -497,23 +502,21 @@ h1 {
497
502
 
498
503
  ```tsx
499
504
  // Expandable Callout
500
-
505
+
501
506
  import { Callout, CalloutTitle } from "@czi-sds/components";
502
507
  import "./styles.css";
503
508
 
504
509
  function App() {
505
510
  return (
506
511
  <div className="app">
507
- <Callout
508
- intent="notice"
509
- expandable
510
- >
512
+ <Callout intent="notice" expandable>
511
513
  <CalloutTitle>Attention Required</CalloutTitle>
512
- The Warning Callout serves as a visual alert to draw immediate attention to critical
513
- information that requires action or consideration. Its distinct appearance, coupled
514
- with the "Attention Required" message, signals urgency and prompts users to take
515
- appropriate steps. Use this component strategically to ensure vital messages are
516
- noticed promptly and acted upon, enhancing user awareness and responsiveness.
514
+ The Warning Callout serves as a visual alert to draw immediate attention
515
+ to critical information that requires action or consideration. Its
516
+ distinct appearance, coupled with the "Attention Required" message,
517
+ signals urgency and prompts users to take appropriate steps. Use this
518
+ component strategically to ensure vital messages are noticed promptly
519
+ and acted upon, enhancing user awareness and responsiveness.
517
520
  </Callout>
518
521
  </div>
519
522
  );
@@ -559,13 +562,12 @@ root.render(
559
562
  <RootApp />
560
563
  </React.StrictMode>
561
564
  );
562
-
563
565
  ```
564
566
 
565
567
  **/public/index.html**
566
568
 
567
569
  ```html
568
- <!DOCTYPE html>
570
+ <!doctype html>
569
571
  <html lang="en">
570
572
  <head>
571
573
  <meta charset="UTF-8" />
@@ -586,20 +588,31 @@ root.render(
586
588
  <div id="root"></div>
587
589
  </body>
588
590
  </html>
589
-
590
591
  ```
591
592
 
592
593
  **/package.json**
593
594
 
594
595
  ```json
595
- {"dependencies":{"react":"^18.0.0","react-dom":"^18.0.0","react-scripts":"^4.0.0"},"devDependencies":{"@types/react":"^18.0.0","@types/react-dom":"^18.0.0","typescript":"^4.0.0"},"main":"/index.tsx"}
596
+ {
597
+ "dependencies": {
598
+ "react": "^18.0.0",
599
+ "react-dom": "^18.0.0",
600
+ "react-scripts": "^4.0.0"
601
+ },
602
+ "devDependencies": {
603
+ "@types/react": "^18.0.0",
604
+ "@types/react-dom": "^18.0.0",
605
+ "typescript": "^4.0.0"
606
+ },
607
+ "main": "/index.tsx"
608
+ }
596
609
  ```
597
610
 
598
611
  ---
599
612
 
600
613
  #### Dismissible Callout
601
614
 
602
- The dismissible `Callout` variant provides users with the ability to dismiss it at their convenience. It includes a close button located in the top right corner, offering a familiar interaction pattern for users to remove the `Callout` from view. Moreover, the `onClose` prop allows developers to define custom actions that are triggered when the `Callout` is closed.
615
+ The dismissible `Callout` variant provides users with the ability to dismiss it at their convenience. It includes a close button located in the top right corner, offering a familiar interaction pattern for users to remove the `Callout` from view. Moreover, the `onClose` prop allows developers to define custom actions that are triggered when the `Callout` is closed.
603
616
 
604
617
  **/styles.css**
605
618
 
@@ -626,13 +639,11 @@ h1 {
626
639
 
627
640
  ```json
628
641
  {
629
- "include": [
630
- "./**/*"
631
- ],
642
+ "include": ["./**/*"],
632
643
  "compilerOptions": {
633
644
  "strict": true,
634
645
  "esModuleInterop": true,
635
- "lib": [ "dom", "es2015" ],
646
+ "lib": ["dom", "es2015"],
636
647
  "jsx": "react-jsx"
637
648
  }
638
649
  }
@@ -642,7 +653,7 @@ h1 {
642
653
 
643
654
  ```tsx
644
655
  // Closable Callout
645
-
656
+
646
657
  import { useState } from "react";
647
658
  import { Callout, CalloutTitle, Button } from "@czi-sds/components";
648
659
  import "./styles.css";
@@ -650,28 +661,30 @@ import "./styles.css";
650
661
  function App() {
651
662
  const [dismissed, setDismissed] = useState(false);
652
663
  const handleClick = () => {
653
- setDismissed(prev => !prev);
654
- }
664
+ setDismissed((prev) => !prev);
665
+ };
655
666
  return (
656
667
  <div className="app">
657
- {
658
- !dismissed ?
659
- <Callout
660
- intent="negative"
661
- dismissed={dismissed}
662
- onClose={() => {
663
- console.log("Callout closed!");
664
- setDismissed(true);
665
- }}
666
- >
667
- <CalloutTitle>An Error Occurred</CalloutTitle>
668
- The Error Callout is a crucial component for communicating critical errors or issues
669
- to users. With its distinct appearance and the message "An Error Occurred," it
670
- ensures that users are immediately informed about unexpected situations that
671
- require attention.
672
- </Callout> :
673
- <Button onClick={handleClick} sdsType="primary" sdsStyle="rounded">Reset Callout</Button>
674
- }
668
+ {!dismissed ? (
669
+ <Callout
670
+ intent="negative"
671
+ dismissed={dismissed}
672
+ onClose={() => {
673
+ console.log("Callout closed!");
674
+ setDismissed(true);
675
+ }}
676
+ >
677
+ <CalloutTitle>An Error Occurred</CalloutTitle>
678
+ The Error Callout is a crucial component for communicating critical
679
+ errors or issues to users. With its distinct appearance and the
680
+ message "An Error Occurred," it ensures that users are immediately
681
+ informed about unexpected situations that require attention.
682
+ </Callout>
683
+ ) : (
684
+ <Button onClick={handleClick} sdsType="primary" sdsStyle="rounded">
685
+ Reset Callout
686
+ </Button>
687
+ )}
675
688
  </div>
676
689
  );
677
690
  }
@@ -716,13 +729,12 @@ root.render(
716
729
  <RootApp />
717
730
  </React.StrictMode>
718
731
  );
719
-
720
732
  ```
721
733
 
722
734
  **/public/index.html**
723
735
 
724
736
  ```html
725
- <!DOCTYPE html>
737
+ <!doctype html>
726
738
  <html lang="en">
727
739
  <head>
728
740
  <meta charset="UTF-8" />
@@ -743,14 +755,24 @@ root.render(
743
755
  <div id="root"></div>
744
756
  </body>
745
757
  </html>
746
-
747
758
  ```
748
759
 
749
760
  **/package.json**
750
761
 
751
762
  ```json
752
- {"dependencies":{"react":"^18.0.0","react-dom":"^18.0.0","react-scripts":"^4.0.0"},"devDependencies":{"@types/react":"^18.0.0","@types/react-dom":"^18.0.0","typescript":"^4.0.0"},"main":"/index.tsx"}
763
+ {
764
+ "dependencies": {
765
+ "react": "^18.0.0",
766
+ "react-dom": "^18.0.0",
767
+ "react-scripts": "^4.0.0"
768
+ },
769
+ "devDependencies": {
770
+ "@types/react": "^18.0.0",
771
+ "@types/react-dom": "^18.0.0",
772
+ "typescript": "^4.0.0"
773
+ },
774
+ "main": "/index.tsx"
775
+ }
753
776
  ```
754
777
 
755
778
  ---
756
-