@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,24 +6,24 @@ Field Inputs are elements that allow users to type within them, providing an are
6
6
 
7
7
  ## Field Input Variants
8
8
 
9
- | There are two Field Input variants available for designers to use—Search Inputs allow users to enter text to perform a search and Text Inputs provide a free-form space for users to type in information as needed. Follow the usage criteria accompanying each variant as a guide for selecting the correct Text Input for any given use case. | | **Jump to variant:** Rounded Search Square Search Text |
10
- | --- | --- | --- |
9
+ | There are two Field Input variants available for designers to use—Search Inputs allow users to enter text to perform a search and Text Inputs provide a free-form space for users to type in information as needed. Follow the usage criteria accompanying each variant as a guide for selecting the correct Text Input for any given use case. | | **Jump to variant:** Rounded Search Square Search Text |
10
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------ |
11
11
 
12
12
  ---
13
13
 
14
14
  ## Rounded Search Input
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
  Used in CZ GEN EPI for top-level searches and when searching within Tables.
20
20
 
21
21
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
22
22
 
23
23
  | **Default** | **Hover** | **Focus** | **Disabled** |
24
- | --- | --- | --- | --- |
24
+ | ----------- | --------- | --------- | ------------ |
25
+
25
26
 
26
-  
27
27
 
28
28
  ### Rounded Search Input Intent States
29
29
 
@@ -36,7 +36,7 @@ Use `intent: error` to communicate when a user has entered an incorrect or incom
36
36
  Use `intent: warning` to communicate when a user needs to be alerted that their search needs attention.
37
37
 
38
38
  | **Default** | **Error** | **Warning** |
39
- | --- | --- | --- |
39
+ | ----------- | --------- | ----------- |
40
40
 
41
41
  ---
42
42
 
@@ -44,23 +44,23 @@ Use `intent: warning` to communicate when a user needs to be alerted that their
44
44
 
45
45
  These rules establish how much margin should exist between and around elements.
46
46
 
47
-  
47
+
48
48
 
49
49
  ---
50
50
 
51
51
  ## Square Search Input
52
52
 
53
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
54
- | --- | --- | --- | --- | --- | --- | --- | --- |
53
+ | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
54
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
55
55
 
56
56
  Used in CZ GEN EPI for searches constrained to the element the Input is placed within such as Dropdown Menus or Forms.
57
57
 
58
58
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
59
59
 
60
60
  | **Default** | **Hover** | **Focus** | **Disabled** |
61
- | --- | --- | --- | --- |
61
+ | ----------- | --------- | --------- | ------------ |
62
+
62
63
 
63
-  
64
64
 
65
65
  ### Square Search Input Intent States
66
66
 
@@ -73,7 +73,7 @@ Use `intent: error` to communicate when a user has entered an incorrect or incom
73
73
  Use `intent: warning` to communicate when a user needs to be alerted that their search needs attention.
74
74
 
75
75
  | **Default** | **Error** | **Warning** |
76
- | --- | --- | --- |
76
+ | ----------- | --------- | ----------- |
77
77
 
78
78
  ---
79
79
 
@@ -81,14 +81,14 @@ Use `intent: warning` to communicate when a user needs to be alerted that their
81
81
 
82
82
  These rules establish how much margin should exist between and around elements.
83
83
 
84
-  
84
+
85
85
 
86
86
  ---
87
87
 
88
88
  ## Text Input
89
89
 
90
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
91
- | --- | --- | --- | --- | --- | --- | --- | --- |
90
+ | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
91
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
92
92
 
93
93
  ### Text Field Input
94
94
 
@@ -97,9 +97,9 @@ The Text Field Input is meant to fit one line of text and should be only used wh
97
97
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
98
98
 
99
99
  | **Default** | **Hover** | **Focus** | **Disabled** |
100
- | --- | --- | --- | --- |
100
+ | ----------- | --------- | --------- | ------------ |
101
+
101
102
 
102
-  
103
103
 
104
104
  ### Text Area Input
105
105
 
@@ -112,9 +112,9 @@ It can be set to accept a specific number of characters in case there is a need
112
112
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
113
113
 
114
114
  | **Default** | **Hover** | **Focus** | **Disabled** |
115
- | --- | --- | --- | --- |
115
+ | ----------- | --------- | --------- | ------------ |
116
+
116
117
 
117
-  
118
118
 
119
119
  ### Text Input Intent States
120
120
 
@@ -127,7 +127,7 @@ Use `intent: error` to communicate when a user has entered an incorrect or incom
127
127
  Use `intent: warning` to communicate when a user needs to be alerted that the content they've input needs attention.
128
128
 
129
129
  | **Default** | **Error** | **Warning** |
130
- | --- | --- | --- |
130
+ | ----------- | --------- | ----------- |
131
131
 
132
132
  ---
133
133
 
@@ -141,12 +141,12 @@ These rules establish how much margin should exist between and around elements.
141
141
 
142
142
  ## Field Input Components
143
143
 
144
- | Below you will find an interactive Storybook iframe for Field Inputs. 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:** InputSearch InputText |
145
- | --- | --- | --- |
144
+ | Below you will find an interactive Storybook iframe for Field Inputs. 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:** InputSearch InputText |
145
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------------- |
146
146
 
147
147
  ---
148
148
 
149
- >These components appear as they are 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.
149
+ > These components appear as they are 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.
150
150
 
151
151
  ### InputSearch
152
152
 
@@ -166,24 +166,24 @@ Field Inputs are elements that allow users to type within them, providing an are
166
166
 
167
167
  ## Field Input Variants
168
168
 
169
- | There are two Field Input variants available for designers to use—Search Inputs allow users to enter text to perform a search and Text Inputs provide a free-form space for users to type in information as needed. Follow the usage criteria accompanying each variant as a guide for selecting the correct Text Input for any given use case. | | **Jump to variant:** Rounded Search Square Search Text |
170
- | --- | --- | --- |
169
+ | There are two Field Input variants available for designers to use—Search Inputs allow users to enter text to perform a search and Text Inputs provide a free-form space for users to type in information as needed. Follow the usage criteria accompanying each variant as a guide for selecting the correct Text Input for any given use case. | | **Jump to variant:** Rounded Search Square Search Text |
170
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------ |
171
171
 
172
172
  ---
173
173
 
174
174
  ## Rounded Search Input
175
175
 
176
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
177
- | --- | --- | --- | --- | --- | --- | --- | --- |
176
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
177
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
178
178
 
179
179
  Used in CZ ID for top-level searches and when searching within Tables.
180
180
 
181
181
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
182
182
 
183
183
  | **Default** | **Hover** | **Focus** | **Disabled** |
184
- | --- | --- | --- | --- |
184
+ | ----------- | --------- | --------- | ------------ |
185
+
185
186
 
186
-  
187
187
 
188
188
  ### Rounded Search Input Intent States
189
189
 
@@ -196,7 +196,7 @@ Use `intent: error` to communicate when a user has entered an incorrect or incom
196
196
  Use `intent: warning` to communicate when a user needs to be alerted that their search needs attention.
197
197
 
198
198
  | **Default** | **Error** | **Warning** |
199
- | --- | --- | --- |
199
+ | ----------- | --------- | ----------- |
200
200
 
201
201
  ---
202
202
 
@@ -208,17 +208,17 @@ These rules establish how much margin should exist between and around elements.
208
208
 
209
209
  ## Square Search Input
210
210
 
211
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
212
- | --- | --- | --- | --- | --- | --- | --- | --- |
211
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
212
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
213
213
 
214
214
  Used in CZ ID for searches constrained to the element the Input is placed within such as Dropdown Menus or Forms.
215
215
 
216
216
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
217
217
 
218
218
  | **Default** | **Hover** | **Focus** | **Disabled** |
219
- | --- | --- | --- | --- |
219
+ | ----------- | --------- | --------- | ------------ |
220
+
220
221
 
221
-  
222
222
 
223
223
  ### Square Search Input Intent States
224
224
 
@@ -231,7 +231,7 @@ Use `intent: error` to communicate when a user has entered an incorrect or incom
231
231
  Use `intent: warning` to communicate when a user needs to be alerted that their search needs attention.
232
232
 
233
233
  | **Default** | **Error** | **Warning** |
234
- | --- | --- | --- |
234
+ | ----------- | --------- | ----------- |
235
235
 
236
236
  ---
237
237
 
@@ -243,8 +243,8 @@ These rules establish how much margin should exist between and around elements.
243
243
 
244
244
  ## Text Input
245
245
 
246
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
247
- | --- | --- | --- | --- | --- | --- | --- | --- |
246
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
247
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
248
248
 
249
249
  ### Text Field Input
250
250
 
@@ -253,9 +253,9 @@ The Text Field Input is meant to fit one line of text and should be only used wh
253
253
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
254
254
 
255
255
  | **Default** | **Hover** | **Focus** | **Disabled** |
256
- | --- | --- | --- | --- |
256
+ | ----------- | --------- | --------- | ------------ |
257
+
257
258
 
258
-  
259
259
 
260
260
  ### Text Area Input
261
261
 
@@ -268,9 +268,9 @@ It can be set to accept a specific number of characters in case there is a need
268
268
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
269
269
 
270
270
  | **Default** | **Hover** | **Focus** | **Disabled** |
271
- | --- | --- | --- | --- |
271
+ | ----------- | --------- | --------- | ------------ |
272
+
272
273
 
273
-  
274
274
 
275
275
  ### Text Input Intent States
276
276
 
@@ -283,7 +283,7 @@ Use `intent: error` to communicate when a user has entered an incorrect or incom
283
283
  Use `intent: warning` to communicate when a user needs to be alerted that the content they've input needs attention.
284
284
 
285
285
  | **Default** | **Error** | **Warning** |
286
- | --- | --- | --- |
286
+ | ----------- | --------- | ----------- |
287
287
 
288
288
  ---
289
289
 
@@ -297,8 +297,8 @@ These rules establish how much margin should exist between and around elements.
297
297
 
298
298
  ## Field Input Components
299
299
 
300
- | Below you will find an interactive Storybook iframe for Field Inputs. 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:** InputSearch InputText |
301
- | --- | --- | --- |
300
+ | Below you will find an interactive Storybook iframe for Field Inputs. 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:** InputSearch InputText |
301
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------------- |
302
302
 
303
303
  ---
304
304
 
@@ -320,8 +320,8 @@ Field Inputs are elements that allow users to type within them, providing an are
320
320
 
321
321
  ## Field Input Components
322
322
 
323
- | There are two Field Input components available to use—Search Inputs allow users to enter text to perform a search and Text Inputs provide a free-form space for users to type in information as needed. | | **Jump to variant:** Search Input Text Input |
324
- | --- | --- | --- |
323
+ | There are two Field Input components available to use—Search Inputs allow users to enter text to perform a search and Text Inputs provide a free-form space for users to type in information as needed. | | **Jump to variant:** Search Input Text Input |
324
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------------- |
325
325
 
326
326
  ### Visual Preview
327
327
 
@@ -329,8 +329,8 @@ Field Inputs are elements that allow users to type within them, providing an are
329
329
 
330
330
  ## Search Input
331
331
 
332
- | | In Figma | | | Meets Accessibility | | | In Code |
333
- | --- | --- | --- | --- | --- | --- | --- | --- |
332
+ | | In Figma | | | Meets Accessibility | | | In Code |
333
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
334
334
 
335
335
  ### Search Input Styles
336
336
 
@@ -351,7 +351,7 @@ Use Search Input – Rounded as part of top-level or primary application searche
351
351
  After users enter text into the Search field, an `XmarkCircle` icon appears; if clicked the field is reset to default.
352
352
 
353
353
  | Default | Hover | Focus | Default (user input) | Disabled |
354
- | --- | --- | --- | --- | --- |
354
+ | ------- | ----- | ----- | -------------------- | -------- |
355
355
 
356
356
  ---
357
357
 
@@ -362,7 +362,7 @@ Use Search Input – Square for searches constrained to the element the Input is
362
362
  After users enter text into the Search field, an `XmarkCircle` icon appears; if clicked the field is reset to default.
363
363
 
364
364
  | Default | Hover | Focus | Default (user input) | Disabled |
365
- | --- | --- | --- | --- | --- |
365
+ | ------- | ----- | ----- | -------------------- | -------- |
366
366
 
367
367
  ---
368
368
 
@@ -381,14 +381,14 @@ Optionally, Intent Messages can be displayed to further communicate why a Negati
381
381
  Each intent is demonstrated below using the Rounded variant for reference. Regardless of variant, the colors used are the same:
382
382
 
383
383
  | Default | Negative | Negative + Intent Message | Notice | Notice + Intent Message |
384
- | --- | --- | --- | --- | --- |
384
+ | ------- | -------- | ------------------------- | ------ | ----------------------- |
385
385
 
386
386
  ---
387
387
 
388
388
  ## Text Input
389
389
 
390
- | | In Figma | | | Meets Accessibility | | | In Code |
391
- | --- | --- | --- | --- | --- | --- | --- | --- |
390
+ | | In Figma | | | Meets Accessibility | | | In Code |
391
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
392
392
 
393
393
  ### Text Input Types
394
394
 
@@ -404,10 +404,10 @@ Default
404
404
 
405
405
  ### Text Input – Field
406
406
 
407
- Text Input – Field is designed to fit one line of text and should be only used when there is a limited amount or a single line's worth of content intended for the user to input.
407
+ Text Input – Field is designed to fit one line of text and should be only used when there is a limited amount or a single line's worth of content intended for the user to input.
408
408
 
409
409
  | Default | Hover | Focus | Default (user input) | Disabled |
410
- | --- | --- | --- | --- | --- |
410
+ | ------- | ----- | ----- | -------------------- | -------- |
411
411
 
412
412
  ---
413
413
 
@@ -420,7 +420,7 @@ It includes a handle in the bottom right corner that the user can grab and drag
420
420
  It can be set to accept a specific number of characters in case there is a need to limit how much content the user can enter.
421
421
 
422
422
  | Default | Hover | Focus | Default (user input) | Disabled |
423
- | --- | --- | --- | --- | --- |
423
+ | ------- | ----- | ----- | -------------------- | -------- |
424
424
 
425
425
  ---
426
426
 
@@ -436,19 +436,19 @@ Use Default to communicate that the user has yet to enter a response or the resp
436
436
 
437
437
  Optionally, Intent Messages can be displayed to further communicate why a Negative, Notice, or Positive intent was triggered. For more information see Intents.
438
438
 
439
- | Default | Negative | Negative + Intent Message | Notice | Notice + Intent Message | Positive | Positive + Intent Message |
440
- | :---: | :---: | --- | :---: | --- | :---: | --- |
439
+ | Default | Negative | Negative + Intent Message | Notice | Notice + Intent Message | Positive | Positive + Intent Message |
440
+ | :-----: | :------: | ------------------------- | :----: | ----------------------- | :------: | ------------------------- |
441
441
 
442
442
  ## Code
443
443
 
444
444
  ## Control Input Components
445
445
 
446
- | There are two Field Input components available to use—`InputSearch` allows users to enter text to perform a search and `InputText` provide a free-form space for users to type in information as needed. | | **Jump to component:** InputSearch InputText |
447
- | --- | --- | --- |
446
+ | There are two Field Input components available to use—`InputSearch` allows users to enter text to perform a search and `InputText` provide a free-form space for users to type in information as needed. | | **Jump to component:** InputSearch InputText |
447
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------------- |
448
448
 
449
449
  ### Visual Preview
450
450
 
451
- >**Note:** The code examples below must install dependencies before displaying and may take extra time to load
451
+ > **Note:** The code examples below must install dependencies before displaying and may take extra time to load
452
452
 
453
453
  ---
454
454
 
@@ -460,41 +460,41 @@ The component's source code in the SDS codebase can be found here.
460
460
 
461
461
  ### SDS vs MUI
462
462
 
463
- SDS's `InputSearch` is built on MUI's `TextField` component, with `type="search"`. It also has the SDS "search" icon automatically included, aligned to the right end of the field.
463
+ SDS's `InputSearch` is built on MUI's `TextField` component, with `type="search"`. It also has the SDS "search" icon automatically included, aligned to the right end of the field.
464
464
 
465
- The following props are available to MUI's `TextField` component, but do not work the same way (or at all) for SDS's `InputSearch` component:
465
+ The following props are available to MUI's `TextField` component, but do not work the same way (or at all) for SDS's `InputSearch` component:
466
466
 
467
- * **`variants`****:** SDS's `InputSearch` component is not set up to support values for this prop (aside from `outlined`, `InputSearch` default), and using other values available to MUI (`filled`, `standard`) may result in unreliable outputs
468
- * **`size`****:** SDS's `InputSearch` component is not set up to support values for this prop (aside from `small`, `InputText`'s default), and using other values available to MUI (`medium`, `large`) may not have reliable outputs
469
- * **`required`****:** SDS's `InputSearch` does not render the expected asterisk (*) following the label when this prop is `true`
470
- * **`select`****:** SDS's `InputSearch` is not set up to support this boolean prop
471
- * **`hiddenLabel`****:** The `label` ("Search", by default) for SDS's component is included within the search field, not outside of it, and the MUI `hiddenLabel` prop will not hide the label
467
+ - **`variants`\*\***:\*\* SDS's `InputSearch` component is not set up to support values for this prop (aside from `outlined`, `InputSearch` default), and using other values available to MUI (`filled`, `standard`) may result in unreliable outputs
468
+ - **`size`\*\***:\*\* SDS's `InputSearch` component is not set up to support values for this prop (aside from `small`, `InputText`'s default), and using other values available to MUI (`medium`, `large`) may not have reliable outputs
469
+ - **`required`\*\***:\*_ SDS's `InputSearch` does not render the expected asterisk (_) following the label when this prop is `true`
470
+ - **`select`\*\***:\*\* SDS's `InputSearch` is not set up to support this boolean prop
471
+ - **`hiddenLabel`\*\***:\*\* The `label` ("Search", by default) for SDS's component is included within the search field, not outside of it, and the MUI `hiddenLabel` prop will not hide the label
472
472
 
473
473
  The following functionality is available to both MUI's `TextField` component and SDS's `InputText` component, but SDS uses different prop names, shown below:
474
474
 
475
- * **`intent`****:** This prop is the way you can set colors for SDS's `InputText`, based on its error state. It takes `default` (default, gray), `error`, or `warning` as values. The related MUI-color-setting prop, `color`, has no effect for `InputText` in SDS.
475
+ - **`intent`\*\***:\*\* This prop is the way you can set colors for SDS's `InputText`, based on its error state. It takes `default` (default, gray), `error`, or `warning` as values. The related MUI-color-setting prop, `color`, has no effect for `InputText` in SDS.
476
476
 
477
477
  SDS's `InputSearch` has an additional `sdsStyle` prop to help with setting SDS-specific styles, which takes `square` (default) or `rounded` as values.
478
478
 
479
479
  ### MUI Documentation
480
480
 
481
- Documentation for the underlying MUI `TextField` component can be found here.
481
+ Documentation for the underlying MUI `TextField` component can be found here.
482
482
 
483
483
  ### Props
484
484
 
485
485
  Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
486
486
 
487
- | Name | Type | Default | Description |
488
- | --- | --- | --- | --- |
489
- | `disabled` | `boolean` | `false` | When set to `true`, the component becomes disabled and cannot be interacted with. |
490
- | `handleSubmit` | `func` | `function(value: string) => void` | This function is called when the Search icon is clicked, allowing user to handle the search operation. |
491
- | `id` | `string` | `-` | Specifies the unique `id` for the input element, needed for accessibility. |
492
- | `intent` | `"default"` `| "negative"` `| "notice"` `| "positive"` | `"default"` | Alters the border color and visual intent of the search input. |
493
- | `label` | `string` | `-` | Although hidden, this `label` is provided for accessibility purposes. |
494
- | `onChange` | `func` | `function(event: React.ChangeEvent) => void` | Defines the action to be taken when the input value changes. |
495
- | `placeholder` | `string` | `"Search"` | Sets the `placeholder` text displayed within the input element. |
496
- | `sdsStyle` | `"rounded"` `| "square"` | `"square"` | Determines the visual style of the component, with options for `rounded` or `square` design. |
497
- | `value` | `string` | `-` | The value of the `input` element, required for a controlled component. |
487
+ | Name | Type | Default | Description |
488
+ | -------------- | ------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------- |
489
+ | `disabled` | `boolean` | `false` | When set to `true`, the component becomes disabled and cannot be interacted with. |
490
+ | `handleSubmit` | `func` | `function(value: string) => void` | This function is called when the Search icon is clicked, allowing user to handle the search operation. |
491
+ | `id` | `string` | `-` | Specifies the unique `id` for the input element, needed for accessibility. |
492
+ | `intent` | `"default"` ` | "negative"` ` | "notice"` ` | "positive"` | `"default"` | Alters the border color and visual intent of the search input. |
493
+ | `label` | `string` | `-` | Although hidden, this `label` is provided for accessibility purposes. |
494
+ | `onChange` | `func` | `function(event: React.ChangeEvent) => void` | Defines the action to be taken when the input value changes. |
495
+ | `placeholder` | `string` | `"Search"` | Sets the `placeholder` text displayed within the input element. |
496
+ | `sdsStyle` | `"rounded"` ` | "square"` | `"square"` | Determines the visual style of the component, with options for `rounded` or `square` design. |
497
+ | `value` | `string` | `-` | The value of the `input` element, required for a controlled component. |
498
498
 
499
499
  ### Code examples
500
500
 
@@ -527,13 +527,11 @@ h1 {
527
527
 
528
528
  ```json
529
529
  {
530
- "include": [
531
- "./**/*"
532
- ],
530
+ "include": ["./**/*"],
533
531
  "compilerOptions": {
534
532
  "strict": true,
535
533
  "esModuleInterop": true,
536
- "lib": [ "dom", "es2015" ],
534
+ "lib": ["dom", "es2015"],
537
535
  "jsx": "react-jsx"
538
536
  }
539
537
  }
@@ -550,11 +548,7 @@ function App() {
550
548
  return (
551
549
  <div className="app">
552
550
  <Box sx={{ width: 300 }}>
553
- <InputSearch
554
- id="search-input"
555
- label="search"
556
- placeholder="Search"
557
- />
551
+ <InputSearch id="search-input" label="search" placeholder="Search" />
558
552
  </Box>
559
553
  </div>
560
554
  );
@@ -600,13 +594,12 @@ root.render(
600
594
  <RootApp />
601
595
  </React.StrictMode>
602
596
  );
603
-
604
597
  ```
605
598
 
606
599
  **/public/index.html**
607
600
 
608
601
  ```html
609
- <!DOCTYPE html>
602
+ <!doctype html>
610
603
  <html lang="en">
611
604
  <head>
612
605
  <meta charset="UTF-8" />
@@ -627,13 +620,24 @@ root.render(
627
620
  <div id="root"></div>
628
621
  </body>
629
622
  </html>
630
-
631
623
  ```
632
624
 
633
625
  **/package.json**
634
626
 
635
627
  ```json
636
- {"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"}
628
+ {
629
+ "dependencies": {
630
+ "react": "^18.0.0",
631
+ "react-dom": "^18.0.0",
632
+ "react-scripts": "^4.0.0"
633
+ },
634
+ "devDependencies": {
635
+ "@types/react": "^18.0.0",
636
+ "@types/react-dom": "^18.0.0",
637
+ "typescript": "^4.0.0"
638
+ },
639
+ "main": "/index.tsx"
640
+ }
637
641
  ```
638
642
 
639
643
  ---
@@ -650,16 +654,16 @@ The component's source code in the SDS codebase can be found here.
650
654
 
651
655
  Like SDS's `InputSearch` (which is also built upon the same MUI component), the following props and options do not work the same way (or at all) for SDS's `InputText` component even though they are available to MUI's `TextField` component.
652
656
 
653
- * **`variants`****:** SDS's `InputText` component is not set up to support values for this prop (aside from `outlined`, `InputText`'s default), and using other values available to MUI (`filled`, `standard`) may result in unreliable outputs
654
- * **`size`****:** SDS's `InputText` component is not set up to support values for this prop (aside from `small`, `InputText`'s default), and using other values available to MUI (`medium`, `large`) may not have reliable outputs
655
- * **`required`****:** SDS's `InputText` does not render the expected asterisk (*) following the label when this prop is `true`
656
- * **`select`****:** SDS's `InputText` is not set up to support this boolean prop
657
+ - **`variants`\*\***:\*\* SDS's `InputText` component is not set up to support values for this prop (aside from `outlined`, `InputText`'s default), and using other values available to MUI (`filled`, `standard`) may result in unreliable outputs
658
+ - **`size`\*\***:\*\* SDS's `InputText` component is not set up to support values for this prop (aside from `small`, `InputText`'s default), and using other values available to MUI (`medium`, `large`) may not have reliable outputs
659
+ - **`required`\*\***:\*_ SDS's `InputText` does not render the expected asterisk (_) following the label when this prop is `true`
660
+ - **`select`\*\***:\*\* SDS's `InputText` is not set up to support this boolean prop
657
661
 
658
662
  The following functionality is available to both MUI's `TextField` component and SDS's `InputText` component, but SDS uses different prop names, shown below:
659
663
 
660
- * **`sdsType`****:** This is the SDS-equivalent of MUI's boolean `multiline` prop, and takes `textField` (default) or `textArea` as values
661
- * **`hideLabel`****:** This is the SDS-equivalent of the `hiddenLabel` prop used in MUI; both are boolean with the default not including them (value of `false`)
662
- * **`intent`****:** This prop is the way you can set colors for SDS's `InputText`, based on its error state. It takes `default` (default, gray), `error`, or `warning` as values. The related MUI-color-setting prop, `color`, has no effect for `InputText` in SDS.
664
+ - **`sdsType`\*\***:\*\* This is the SDS-equivalent of MUI's boolean `multiline` prop, and takes `textField` (default) or `textArea` as values
665
+ - **`hideLabel`\*\***:\*\* This is the SDS-equivalent of the `hiddenLabel` prop used in MUI; both are boolean with the default not including them (value of `false`)
666
+ - **`intent`\*\***:\*\* This prop is the way you can set colors for SDS's `InputText`, based on its error state. It takes `default` (default, gray), `error`, or `warning` as values. The related MUI-color-setting prop, `color`, has no effect for `InputText` in SDS.
663
667
 
664
668
  ### MUI Documentation
665
669
 
@@ -669,15 +673,15 @@ Documentation for the underlying MUI `TextField`component can be found here.
669
673
 
670
674
  Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
671
675
 
672
- | Name | Type | Default | Description |
673
- | --- | --- | --- | --- |
674
- | `disabled` | `boolean` | `false` | When set to `true`, the component becomes disabled and cannot be interacted with. |
675
- | `hideLabel` | `boolean` | `false` | If `true`, the label is hidden.  |
676
- | `id` | `string` | `-` | Specifies the unique `id` for the input element, needed for accessibility. |
677
- | `intent` | `"default"` `| "negative"` `| "notice"` `| "positive"` | `"default"` | Alters the border color and visual intent of the search input. |
678
- | `label` | `string` | `-` | The `label` for the input element. |
679
- | `placeholder` | `string` | `-` | Sets the `placeholder` text displayed within the input element. |
680
- | `sdsType` | `"textField"` `| "textArea"` | `"textField"` | Defines the type of component to render, with options for a text input or text area. |
676
+ | Name | Type | Default | Description |
677
+ | ------------- | --------------- | ------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------- | -------------------------------------------------------------- |
678
+ | `disabled` | `boolean` | `false` | When set to `true`, the component becomes disabled and cannot be interacted with. |
679
+ | `hideLabel` | `boolean` | `false` | If `true`, the label is hidden.  |
680
+ | `id` | `string` | `-` | Specifies the unique `id` for the input element, needed for accessibility. |
681
+ | `intent` | `"default"` ` | "negative"` ` | "notice"` ` | "positive"` | `"default"` | Alters the border color and visual intent of the search input. |
682
+ | `label` | `string` | `-` | The `label` for the input element. |
683
+ | `placeholder` | `string` | `-` | Sets the `placeholder` text displayed within the input element. |
684
+ | `sdsType` | `"textField"` ` | "textArea"` | `"textField"` | Defines the type of component to render, with options for a text input or text area. |
681
685
 
682
686
  ### Code examples
683
687
 
@@ -710,13 +714,11 @@ h1 {
710
714
 
711
715
  ```json
712
716
  {
713
- "include": [
714
- "./**/*"
715
- ],
717
+ "include": ["./**/*"],
716
718
  "compilerOptions": {
717
719
  "strict": true,
718
720
  "esModuleInterop": true,
719
- "lib": [ "dom", "es2015" ],
721
+ "lib": ["dom", "es2015"],
720
722
  "jsx": "react-jsx"
721
723
  }
722
724
  }
@@ -726,7 +728,7 @@ h1 {
726
728
 
727
729
  ```tsx
728
730
  import { InputText } from "@czi-sds/components";
729
- import { Box } from "@mui/material";
731
+ import { Box } from "@mui/material";
730
732
  import "./styles.css";
731
733
 
732
734
  function App() {
@@ -784,13 +786,12 @@ root.render(
784
786
  <RootApp />
785
787
  </React.StrictMode>
786
788
  );
787
-
788
789
  ```
789
790
 
790
791
  **/public/index.html**
791
792
 
792
793
  ```html
793
- <!DOCTYPE html>
794
+ <!doctype html>
794
795
  <html lang="en">
795
796
  <head>
796
797
  <meta charset="UTF-8" />
@@ -811,13 +812,24 @@ root.render(
811
812
  <div id="root"></div>
812
813
  </body>
813
814
  </html>
814
-
815
815
  ```
816
816
 
817
817
  **/package.json**
818
818
 
819
819
  ```json
820
- {"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"}
820
+ {
821
+ "dependencies": {
822
+ "react": "^18.0.0",
823
+ "react-dom": "^18.0.0",
824
+ "react-scripts": "^4.0.0"
825
+ },
826
+ "devDependencies": {
827
+ "@types/react": "^18.0.0",
828
+ "@types/react-dom": "^18.0.0",
829
+ "typescript": "^4.0.0"
830
+ },
831
+ "main": "/index.tsx"
832
+ }
821
833
  ```
822
834
 
823
835
  ---
@@ -851,13 +863,11 @@ h1 {
851
863
 
852
864
  ```json
853
865
  {
854
- "include": [
855
- "./**/*"
856
- ],
866
+ "include": ["./**/*"],
857
867
  "compilerOptions": {
858
868
  "strict": true,
859
869
  "esModuleInterop": true,
860
- "lib": [ "dom", "es2015" ],
870
+ "lib": ["dom", "es2015"],
861
871
  "jsx": "react-jsx"
862
872
  }
863
873
  }
@@ -867,7 +877,7 @@ h1 {
867
877
 
868
878
  ```tsx
869
879
  import { InputText } from "@czi-sds/components";
870
- import { Box } from "@mui/material";
880
+ import { Box } from "@mui/material";
871
881
  import "./styles.css";
872
882
 
873
883
  function App() {
@@ -925,13 +935,12 @@ root.render(
925
935
  <RootApp />
926
936
  </React.StrictMode>
927
937
  );
928
-
929
938
  ```
930
939
 
931
940
  **/public/index.html**
932
941
 
933
942
  ```html
934
- <!DOCTYPE html>
943
+ <!doctype html>
935
944
  <html lang="en">
936
945
  <head>
937
946
  <meta charset="UTF-8" />
@@ -952,14 +961,24 @@ root.render(
952
961
  <div id="root"></div>
953
962
  </body>
954
963
  </html>
955
-
956
964
  ```
957
965
 
958
966
  **/package.json**
959
967
 
960
968
  ```json
961
- {"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"}
969
+ {
970
+ "dependencies": {
971
+ "react": "^18.0.0",
972
+ "react-dom": "^18.0.0",
973
+ "react-scripts": "^4.0.0"
974
+ },
975
+ "devDependencies": {
976
+ "@types/react": "^18.0.0",
977
+ "@types/react-dom": "^18.0.0",
978
+ "typescript": "^4.0.0"
979
+ },
980
+ "main": "/index.tsx"
981
+ }
962
982
  ```
963
983
 
964
984
  ---
965
-