@czi-sds/mcp 0.16.0 → 0.17.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 (164) hide show
  1. package/README.md +2 -1
  2. package/data/component-docs/Accordion.md +291 -0
  3. package/data/component-docs/Autocomplete.md +525 -0
  4. package/data/component-docs/Banner.md +231 -0
  5. package/data/component-docs/Button.md +224 -0
  6. package/data/component-docs/ButtonDropdown.md +256 -0
  7. package/data/component-docs/ButtonGroup.md +320 -0
  8. package/data/component-docs/ButtonToggle.md +397 -0
  9. package/data/component-docs/Callout.md +268 -0
  10. package/data/component-docs/CellBasic.md +122 -0
  11. package/data/component-docs/CellComponent.md +63 -0
  12. package/data/component-docs/CellHeader.md +128 -0
  13. package/data/component-docs/ComplexFilter.md +294 -0
  14. package/data/component-docs/ContentCard.md +406 -0
  15. package/data/component-docs/Dialog.md +651 -0
  16. package/data/component-docs/Dropdown.md +155 -0
  17. package/data/component-docs/DropdownMenu.md +949 -0
  18. package/data/component-docs/HeatmapChart.md +782 -0
  19. package/data/component-docs/Hero.md +363 -0
  20. package/data/component-docs/Icon.md +283 -0
  21. package/data/component-docs/InputCheckbox.md +205 -0
  22. package/data/component-docs/InputDropdown.md +482 -0
  23. package/data/component-docs/InputRadio.md +173 -0
  24. package/data/component-docs/InputSearch.md +81 -0
  25. package/data/component-docs/InputSlider.md +189 -0
  26. package/data/component-docs/InputText.md +110 -0
  27. package/data/component-docs/InputToggle.md +141 -0
  28. package/data/component-docs/IntentMessage.md +293 -0
  29. package/data/component-docs/Legend.md +442 -0
  30. package/data/component-docs/Link.md +23 -0
  31. package/data/component-docs/List.md +300 -0
  32. package/data/component-docs/LoadingIndicator.md +198 -0
  33. package/data/component-docs/Menu.md +298 -0
  34. package/data/component-docs/MenuItem.md +100 -0
  35. package/data/component-docs/NavigationFooter.md +165 -0
  36. package/data/component-docs/NavigationHeader.md +500 -0
  37. package/data/component-docs/NavigationJumpTo.md +414 -0
  38. package/data/component-docs/Notification.md +288 -0
  39. package/data/component-docs/Pagination.md +67 -0
  40. package/data/component-docs/Panel.md +636 -0
  41. package/data/component-docs/Popover.md +448 -0
  42. package/data/component-docs/PreComposedTable.md +2947 -0
  43. package/data/component-docs/SegmentedControl.md +396 -0
  44. package/data/component-docs/StackedBarChart.md +475 -0
  45. package/data/component-docs/Table.md +2000 -0
  46. package/data/component-docs/TableHeader.md +53 -0
  47. package/data/component-docs/TableRow.md +74 -0
  48. package/data/component-docs/Tabs.md +455 -0
  49. package/data/component-docs/Tag.md +647 -0
  50. package/data/component-docs/TagFilter.md +131 -0
  51. package/data/component-docs/Tooltip.md +561 -0
  52. package/data/component-docs/TooltipCondensed.md +203 -0
  53. package/data/component-docs/TooltipTable.md +145 -0
  54. package/data/component-docs/index.json +262 -0
  55. package/data/component-list.json +2 -5
  56. package/data/component-props/Accordion.json +31 -11
  57. package/data/component-props/Alert.json +3 -3
  58. package/data/component-props/Autocomplete.json +150 -15
  59. package/data/component-props/Banner.json +31 -17
  60. package/data/component-props/Button.json +45 -20
  61. package/data/component-props/ButtonDropdown.json +36 -17
  62. package/data/component-props/ButtonDropdownLegacy.json +11 -11
  63. package/data/component-props/ButtonGroup.json +32 -11
  64. package/data/component-props/ButtonIcon.json +10 -10
  65. package/data/component-props/ButtonLegacy.json +19 -19
  66. package/data/component-props/ButtonToggle.json +32 -19
  67. package/data/component-props/ButtonToggleLegacy.json +11 -11
  68. package/data/component-props/Callout.json +58 -17
  69. package/data/component-props/CellBasic.json +94 -41
  70. package/data/component-props/CellComponent.json +23 -7
  71. package/data/component-props/CellHeader.json +62 -19
  72. package/data/component-props/ComplexFilter.json +52 -21
  73. package/data/component-props/ContentCard.json +70 -47
  74. package/data/component-props/Dialog.json +47 -14
  75. package/data/component-props/Dropdown.json +68 -31
  76. package/data/component-props/DropdownMenu.json +128 -23
  77. package/data/component-props/HeatmapChart.json +88 -12
  78. package/data/component-props/Hero.json +80 -39
  79. package/data/component-props/Icon.json +20 -9
  80. package/data/component-props/InputCheckbox.json +36 -14
  81. package/data/component-props/InputDropdown.json +75 -27
  82. package/data/component-props/InputRadio.json +31 -13
  83. package/data/component-props/InputSearch.json +41 -18
  84. package/data/component-props/InputSlider.json +46 -19
  85. package/data/component-props/InputText.json +26 -19
  86. package/data/component-props/InputToggle.json +26 -9
  87. package/data/component-props/IntentMessage.json +38 -9
  88. package/data/component-props/Link.json +13 -7
  89. package/data/component-props/LoadingIndicator.json +11 -3
  90. package/data/component-props/MenuItem.json +38 -19
  91. package/data/component-props/MenuSelect.json +8 -8
  92. package/data/component-props/NavigationFooter.json +49 -19
  93. package/data/component-props/NavigationHeader.json +150 -37
  94. package/data/component-props/NavigationJumpTo.json +33 -7
  95. package/data/component-props/Notification.json +39 -21
  96. package/data/component-props/Pagination.json +39 -11
  97. package/data/component-props/Panel.json +62 -9
  98. package/data/component-props/Popover.json +80 -7
  99. package/data/component-props/PreComposedTable.json +99 -27
  100. package/data/component-props/SegmentedControl.json +42 -3
  101. package/data/component-props/StackedBarChart.json +116 -42
  102. package/data/component-props/TableRow.json +38 -19
  103. package/data/component-props/Tabs.json +66 -9
  104. package/data/component-props/Tag.json +34 -17
  105. package/data/component-props/TagFilter.json +10 -3
  106. package/data/component-props/Tooltip.json +49 -18
  107. package/data/component-props/TooltipCondensed.json +18 -9
  108. package/data/component-props/TooltipTable.json +17 -7
  109. package/data/resources/{zeroheight-rules.md → documentation-rules.md} +43 -30
  110. package/data/resources/figma-rules.md +2 -2
  111. package/dist/stdio.js +112 -208
  112. package/package.json +9 -5
  113. package/data/component-props/ButtonDropdownV2.json +0 -34
  114. package/data/component-props/ButtonNew.json +0 -47
  115. package/data/component-props/ButtonToggleV2.json +0 -44
  116. package/data/component-props/ButtonV2.json +0 -43
  117. package/data/zeroheight-cache.json +0 -10259
  118. package/data/zeroheight-exports/Accordion.md +0 -774
  119. package/data/zeroheight-exports/Banner.md +0 -691
  120. package/data/zeroheight-exports/Borders.md +0 -117
  121. package/data/zeroheight-exports/Buttons.md +0 -1854
  122. package/data/zeroheight-exports/Callout.md +0 -931
  123. package/data/zeroheight-exports/Colors.md +0 -1755
  124. package/data/zeroheight-exports/Content-Card.md +0 -309
  125. package/data/zeroheight-exports/Contributing-to-SDS.md +0 -98
  126. package/data/zeroheight-exports/Control-Inputs.md +0 -2818
  127. package/data/zeroheight-exports/Corners.md +0 -104
  128. package/data/zeroheight-exports/Cover-page.md +0 -3
  129. package/data/zeroheight-exports/Dialog.md +0 -1367
  130. package/data/zeroheight-exports/Downloads.md +0 -236
  131. package/data/zeroheight-exports/Drop-Shadows.md +0 -79
  132. package/data/zeroheight-exports/Dropdown-Input.md +0 -1776
  133. package/data/zeroheight-exports/Dropdown-Menus.md +0 -913
  134. package/data/zeroheight-exports/Element-Status-Tracker.md +0 -267
  135. package/data/zeroheight-exports/Field-Inputs.md +0 -1405
  136. package/data/zeroheight-exports/Filters.md +0 -1111
  137. package/data/zeroheight-exports/Getting-Started.md +0 -1157
  138. package/data/zeroheight-exports/Hero.md +0 -414
  139. package/data/zeroheight-exports/Icons.md +0 -2067
  140. package/data/zeroheight-exports/Intent.md +0 -86
  141. package/data/zeroheight-exports/Introduction-to-Bases.md +0 -35
  142. package/data/zeroheight-exports/Introduction-to-Cells.md +0 -35
  143. package/data/zeroheight-exports/Introduction-to-DNA.md +0 -35
  144. package/data/zeroheight-exports/Introduction-to-Genes.md +0 -35
  145. package/data/zeroheight-exports/Introduction.md +0 -115
  146. package/data/zeroheight-exports/Link.md +0 -432
  147. package/data/zeroheight-exports/Lists.md +0 -986
  148. package/data/zeroheight-exports/Loading-Indicator.md +0 -41
  149. package/data/zeroheight-exports/Navigation.md +0 -1190
  150. package/data/zeroheight-exports/Notification.md +0 -1038
  151. package/data/zeroheight-exports/Panel.md +0 -1030
  152. package/data/zeroheight-exports/README.md +0 -122
  153. package/data/zeroheight-exports/Responsive-Design.md +0 -330
  154. package/data/zeroheight-exports/Search-Input.md +0 -91
  155. package/data/zeroheight-exports/Search.md +0 -822
  156. package/data/zeroheight-exports/Segmented-Control.md +0 -609
  157. package/data/zeroheight-exports/Spacing.md +0 -297
  158. package/data/zeroheight-exports/Table.md +0 -5345
  159. package/data/zeroheight-exports/Tabs.md +0 -1324
  160. package/data/zeroheight-exports/Tags.md +0 -1545
  161. package/data/zeroheight-exports/Text-Link.md +0 -268
  162. package/data/zeroheight-exports/Theming.md +0 -362
  163. package/data/zeroheight-exports/Tooltips.md +0 -2015
  164. package/data/zeroheight-exports/Typography.md +0 -800
@@ -1,1854 +0,0 @@
1
- # Buttons
2
-
3
- Buttons are one of the primary ways users interact with and provide input to the product's UI, serving as the main elements to solicit user action.
4
-
5
- ## Overview
6
-
7
- ## Button Variants
8
-
9
- | There are a range of Button variants available for designers to use in their layouts depending on the amount of emphasis the Button needs to have, its location in the UI, and whether it is existing alone or alongside other Buttons. Follow the usage criteria accompanying each variant as a guide for selecting the correct Button for any given use case. | | **Jump to variant:** Square Copy Icon |
10
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------- |
11
-
12
- ### Visual Preview
13
-
14
- Use the links below to jump to information on a specific Button variant:
15
-
16
- **Button**
17
-
18
- ---
19
-
20
- **Button**
21
-
22
- ---
23
-
24
- **ButtonIcon**
25
-
26
- ---
27
-
28
- ---
29
-
30
- ## Square Button
31
-
32
- | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
33
- | --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
34
-
35
- ### Large Primary Square Button
36
-
37
- Use for primary or emphasized actions.
38
-
39
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
40
-
41
- | **Default** | **Hover** | **Pressed** | **Disabled** |
42
- | ----------- | --------- | ----------- | ------------ |
43
-
44
- **Button**
45
-
46
- ---
47
-
48
- **Button**
49
-
50
- ---
51
-
52
- **Button**
53
-
54
- ---
55
-
56
- **Button**
57
-
58
- ---
59
-
60
- ### Small Primary Square Button
61
-
62
- Use for actions that are lower importance or don't require as much emphasis on the page such as actions taken in the page footer.
63
-
64
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
65
-
66
- | **Default** | **Hover** | **Pressed** | **Disabled** |
67
- | ----------- | --------- | ----------- | ------------ |
68
-
69
- **Button**
70
-
71
- ---
72
-
73
- **Button**
74
-
75
- ---
76
-
77
- **Button**
78
-
79
- ---
80
-
81
- **Button**
82
-
83
- ---
84
-
85
- ### Secondary Square Button
86
-
87
- Use for a secondary action, or deemphasized Button. Often paired with primary Button.
88
-
89
- Note: there is no small secondary square Button.
90
-
91
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
92
-
93
- | **Default** | **Hover** | **Pressed** | **Disabled** |
94
- | ----------- | --------- | ----------- | ------------ |
95
-
96
- **Button**
97
-
98
- ---
99
-
100
- **Button**
101
-
102
- ---
103
-
104
- **Button**
105
-
106
- ---
107
-
108
- **Button**
109
-
110
- ---
111
-
112
- ---
113
-
114
- ### Square Button Spacing
115
-
116
- These rules establish how much margin should exist between and around elements.
117
-
118
- **Square Button spacing**
119
-
120
- ---
121
-
122
- ---
123
-
124
- ## Copy Button
125
-
126
- | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
127
- | --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
128
-
129
- Used inline within body copy when providing instructions to users that involve copying content. Any content that would need to be easily accessible by the user can be tied to the Copy Button. When clicked, the content tied to it is copied to the user's clipboard.
130
-
131
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
132
-
133
- | **Default** | **Hover** | **Pressed** | **Disabled** |
134
- | ----------- | --------- | ----------- | ------------ |
135
-
136
- **Button**
137
-
138
- ---
139
-
140
- **Button**
141
-
142
- ---
143
-
144
- **Button**
145
-
146
- ---
147
-
148
- **Button**
149
-
150
- ---
151
-
152
- ---
153
-
154
- ### Copy Button Spacing
155
-
156
- These rules establish how much margin should exist between and around elements.
157
-
158
- **Copy Button spacing**
159
-
160
- ---
161
-
162
- ---
163
-
164
- ## Icon Button
165
-
166
- | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebase |
167
- | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------------------- |
168
-
169
- ### Large Icon Button
170
-
171
- The Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon).
172
-
173
- Use the Icon Button size that is most appropriate for the design it is being used in.
174
-
175
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
176
-
177
- | **Default** | **Hover** | **Pressed** |
178
- | ----------- | --------- | ----------- |
179
-
180
- **ButtonIcon**
181
-
182
- ---
183
-
184
- **ButtonIcon**
185
-
186
- ---
187
-
188
- **ButtonIcon**
189
-
190
- ---
191
-
192
- ### Medium Icon Button
193
-
194
- The Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon).
195
-
196
- Use the Icon Button size that is most appropriate for the design it is being used in.
197
-
198
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
199
-
200
- | **Default** | **Hover** | **Pressed** |
201
- | ----------- | --------- | ----------- |
202
-
203
- **ButtonIcon**
204
-
205
- ---
206
-
207
- **ButtonIcon**
208
-
209
- ---
210
-
211
- **ButtonIcon**
212
-
213
- ---
214
-
215
- ### Small Icon Button
216
-
217
- The Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon).
218
-
219
- Use the Icon Button size that is most appropriate for the design it is being used in.
220
-
221
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
222
-
223
- | **Default** | **Hover** | **Pressed** |
224
- | ----------- | --------- | ----------- |
225
-
226
- **ButtonIcon**
227
-
228
- ---
229
-
230
- **ButtonIcon**
231
-
232
- ---
233
-
234
- **ButtonIcon**
235
-
236
- ---
237
-
238
- ---
239
-
240
- ### Icon Button Spacing
241
-
242
- These rules establish how much margin should exist between and around elements.
243
-
244
- **Icon Button spacing**
245
-
246
- ---
247
-
248
- ## Code
249
-
250
- ## Button Components
251
-
252
- | Below you will find interactive Storybook iframes for each component within the Button element group. 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:** Button ButtonIcon |
253
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ---------------------------------------- |
254
-
255
- ---
256
-
257
- > These components appear as they are in the default SDS codebase. Once imported into the napari hub or napari.org codebases, use a theme file to enable the napari visual appearance customization.
258
-
259
- ### Button
260
-
261
- Storybook
262
-
263
- ---
264
-
265
- ### ButtonIcon 
266
-
267
- Storybook
268
-
269
- ---
270
-
271
- Buttons are one of the primary ways users interact with and provide input to the product's UI, serving as the main elements to solicit user action.
272
-
273
- ## Overview
274
-
275
- ## Button Variants
276
-
277
- | There are a range of Button variants available for designers to use in their layouts depending on the amount of emphasis the Button needs to have, its location in the UI, and whether it is existing alone or alongside other Buttons. Follow the usage criteria accompanying each variant as a guide for selecting the correct Button for any given use case. | | **Jump to variant:** Rounded Square Minimal Icon Rounded Dropdown Square Dropdown |
278
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------------------------------------------------------------- |
279
-
280
- ### Visual Preview
281
-
282
- Use the links below to jump to information on a specific Button variant:
283
-
284
- **Button**
285
-
286
- ---
287
-
288
- **Button**
289
-
290
- ---
291
-
292
- **Button**
293
-
294
- ---
295
-
296
- **ButtonIcon**
297
-
298
- ---
299
-
300
- **ButtonDropdown**
301
-
302
- ---
303
-
304
- **ButtonDropdown**
305
-
306
- ---
307
-
308
- ---
309
-
310
- ## Rounded Button
311
-
312
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
313
- | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
314
-
315
- ### Primary Rounded Button
316
-
317
- General use for a primary or emphasized action.
318
-
319
- Include an icon when needing to provide additional context to users of what action the Button has.
320
-
321
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
322
-
323
- | **Default** | **Hover** | **Pressed** | **Disabled** |
324
- | ----------- | --------- | ----------- | ------------ |
325
-
326
- **Button**
327
-
328
- ---
329
-
330
- **Button**
331
-
332
- ---
333
-
334
- **Button**
335
-
336
- ---
337
-
338
- **Button**
339
-
340
- ---
341
-
342
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
343
- | ------------------ | --------- | ----------- | ------------ |
344
-
345
- **Button**
346
-
347
- ---
348
-
349
- **Button**
350
-
351
- ---
352
-
353
- **Button**
354
-
355
- ---
356
-
357
- **Button**
358
-
359
- ---
360
-
361
- ### Secondary Rounded Button
362
-
363
- Use for a secondary action, or deemphasized Button. Often paired with primary Button.
364
-
365
- Include an icon when needing to provide additional context to users of what action the Button has.
366
-
367
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
368
-
369
- | **Default** | **Hover** | **Pressed** | **Disabled** |
370
- | ----------- | --------- | ----------- | ------------ |
371
-
372
- **Button**
373
-
374
- ---
375
-
376
- **Button**
377
-
378
- ---
379
-
380
- **Button**
381
-
382
- ---
383
-
384
- **Button**
385
-
386
- ---
387
-
388
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
389
- | ------------------ | --------- | ----------- | ------------ |
390
-
391
- **Button**
392
-
393
- ---
394
-
395
- **Button**
396
-
397
- ---
398
-
399
- **Button**
400
-
401
- ---
402
-
403
- **Button**
404
-
405
- ---
406
-
407
- ### Error Rounded Button
408
-
409
- Use the error Button when the outcome of the user clicking the button will result in something being removed or deleted.
410
-
411
- Include an icon when needing to provide additional context to users of what action the Button has.
412
-
413
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
414
-
415
- | **Default** | **Hover** | **Pressed** | **Disabled** |
416
- | ----------- | --------- | ----------- | ------------ |
417
-
418
- **Button**
419
-
420
- ---
421
-
422
- **Button**
423
-
424
- ---
425
-
426
- **Button**
427
-
428
- ---
429
-
430
- **Button**
431
-
432
- ---
433
-
434
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
435
- | ------------------ | --------- | ----------- | ------------ |
436
-
437
- **Button**
438
-
439
- ---
440
-
441
- **Button**
442
-
443
- ---
444
-
445
- **Button**
446
-
447
- ---
448
-
449
- **Button**
450
-
451
- ---
452
-
453
- ---
454
-
455
- ### Rounded Button Spacing
456
-
457
- These rules establish how much margin should exist between and around elements.
458
-
459
- **Rounded Button Spacing**
460
-
461
- ---
462
-
463
- ---
464
-
465
- ## Square Button
466
-
467
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
468
- | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
469
-
470
- ### Primary Square Button
471
-
472
- Used to complete primary actions within Forms and Dropdown Menus; paired with Text Inputs.
473
-
474
- Include an icon when needing to provide additional context to users of what action the Button has.
475
-
476
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
477
-
478
- | **Default** | **Hover** | **Pressed** | **Disabled** |
479
- | ----------- | --------- | ----------- | ------------ |
480
-
481
- **Button**
482
-
483
- ---
484
-
485
- **Button**
486
-
487
- ---
488
-
489
- **Button**
490
-
491
- ---
492
-
493
- **Button**
494
-
495
- ---
496
-
497
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
498
- | ------------------ | --------- | ----------- | ------------ |
499
-
500
- **Button**
501
-
502
- ---
503
-
504
- **Button**
505
-
506
- ---
507
-
508
- **Button**
509
-
510
- ---
511
-
512
- **Button**
513
-
514
- ---
515
-
516
- ### Secondary Square Button
517
-
518
- Used to complete secondary actions within Forms and Dropdown Menus; paired with Text Inputs.
519
-
520
- Include an icon when needing to provide additional context to users of what action the Button has.
521
-
522
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
523
-
524
- | **Default** | **Hover** | **Pressed** | **Disabled** |
525
- | ----------- | --------- | ----------- | ------------ |
526
-
527
- **Button**
528
-
529
- ---
530
-
531
- **Button**
532
-
533
- ---
534
-
535
- **Button**
536
-
537
- ---
538
-
539
- **Button**
540
-
541
- ---
542
-
543
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
544
- | ------------------ | --------- | ----------- | ------------ |
545
-
546
- **Button**
547
-
548
- ---
549
-
550
- **Button**
551
-
552
- ---
553
-
554
- **Button**
555
-
556
- ---
557
-
558
- **Button**
559
-
560
- ---
561
-
562
- ### Error Square Button
563
-
564
- Use the error Button when the outcome of the user clicking the button will result in something being removed or deleted.
565
-
566
- Include an icon when needing to provide additional context to users of what action the Button has.
567
-
568
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
569
-
570
- | **Default** | **Hover** | **Pressed** | **Disabled** |
571
- | ----------- | --------- | ----------- | ------------ |
572
-
573
- **Button**
574
-
575
- ---
576
-
577
- **Button**
578
-
579
- ---
580
-
581
- **Button**
582
-
583
- ---
584
-
585
- **Button**
586
-
587
- ---
588
-
589
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
590
- | ------------------ | --------- | ----------- | ------------ |
591
-
592
- **Button**
593
-
594
- ---
595
-
596
- **Button**
597
-
598
- ---
599
-
600
- **Button**
601
-
602
- ---
603
-
604
- **Button**
605
-
606
- ---
607
-
608
- ---
609
-
610
- ### Square Button Spacing
611
-
612
- These rules establish how much margin should exist between and around elements.
613
-
614
- **Square Button Spacing**
615
-
616
- ---
617
-
618
- ---
619
-
620
- ## Minimal Button
621
-
622
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
623
- | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
624
-
625
- ### Primary Minimal Button
626
-
627
- Text Buttons initiate actions that keep the user on the same page, such as opening or closing dialog windows or overlays. They should contain a maximum of 2-3 words.
628
-
629
- If a longer or inline call to action with a similar visual style is needed, a Text Link might be more appropriate. In addition to containing more words, Text Links navigate the user away from their current page to a new one, whereas Minimal Buttons keep users on the same page.
630
-
631
- Include an icon when needing to provide additional context to users of what action the Button has.
632
-
633
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
634
-
635
- | **Default** | **Hover** | **Pressed** | **Disabled** |
636
- | ----------- | --------- | ----------- | ------------ |
637
-
638
- **Button**
639
-
640
- ---
641
-
642
- **Button**
643
-
644
- ---
645
-
646
- **Button**
647
-
648
- ---
649
-
650
- **Button**
651
-
652
- ---
653
-
654
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
655
- | ------------------ | --------- | ----------- | ------------ |
656
-
657
- **Button**
658
-
659
- ---
660
-
661
- **Button**
662
-
663
- ---
664
-
665
- **Button**
666
-
667
- ---
668
-
669
- **Button**
670
-
671
- ---
672
-
673
- ### Secondary Minimal Button
674
-
675
- Use for a deemphasized action or when paired with a Primary Minimal Button.
676
-
677
- Note: only Primary Minimal Buttons can be paired with icons.
678
-
679
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
680
-
681
- | **Default** | **Hover** | **Pressed** | **Disabled** |
682
- | ----------- | --------- | ----------- | ------------ |
683
-
684
- **Button**
685
-
686
- ---
687
-
688
- **Button**
689
-
690
- ---
691
-
692
- **Button**
693
-
694
- ---
695
-
696
- **Button**
697
-
698
- ---
699
-
700
- ---
701
-
702
- ### Minimal Button Spacing
703
-
704
- These rules establish how much margin should exist between and around elements.
705
-
706
- **Text Button Spacing**
707
-
708
- ---
709
-
710
- ---
711
-
712
- ## Icon Button
713
-
714
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
715
- | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
716
-
717
- ### Large Primary Icon Button
718
-
719
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
720
-
721
- The Primary Icon Button should be used in places that require the user's primary attention or to emphasize a primary action.
722
-
723
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
724
-
725
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
726
-
727
- | **Default (Off)** | **Hover (Off)** | **Pressed** | **Default (On)** | **Hover (On)** | **Disabled** |
728
- | ----------------- | --------------- | ----------- | ---------------- | -------------- | ------------ |
729
-
730
- **ButtonIcon**
731
-
732
- ---
733
-
734
- **ButtonIcon**
735
-
736
- ---
737
-
738
- **ButtonIcon**
739
-
740
- ---
741
-
742
- **ButtonIcon**
743
-
744
- ---
745
-
746
- **ButtonIcon**
747
-
748
- ---
749
-
750
- **ButtonIcon**
751
-
752
- ---
753
-
754
- ### Small Primary Icon Button
755
-
756
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
757
-
758
- The Primary Icon Button should be used in places that require the user's primary attention or to emphasize a primary action.
759
-
760
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
761
-
762
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
763
-
764
- | **Default** | **Hover** | **Pressed** | **Disabled** |
765
- | ----------- | --------- | ----------- | ------------ |
766
-
767
- **ButtonIcon**
768
-
769
- ---
770
-
771
- **ButtonIcon**
772
-
773
- ---
774
-
775
- **ButtonIcon**
776
-
777
- ---
778
-
779
- **ButtonIcon**
780
-
781
- ---
782
-
783
- ### Large Secondary Icon Button
784
-
785
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
786
-
787
- The Secondary Icon Button should be used for deemphasized or secondary actions; often paired with the Primary Icon Button.
788
-
789
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
790
-
791
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
792
-
793
- | **Default (Off)** | **Hover (Off)** | **Default (On)** | **Hover (On)** | **Disabled** |
794
- | ----------------- | --------------- | ---------------- | -------------- | ------------ |
795
-
796
- **ButtonIcon**
797
-
798
- ---
799
-
800
- **ButtonIcon**
801
-
802
- ---
803
-
804
- **ButtonIcon**
805
-
806
- ---
807
-
808
- **ButtonIcon**
809
-
810
- ---
811
-
812
- **ButtonIcon**
813
-
814
- ---
815
-
816
- ### Small Secondary Icon Button
817
-
818
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
819
-
820
- The Secondary Icon Button should be used for deemphasized or secondary actions; often paired with the Primary Icon Button.
821
-
822
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
823
-
824
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
825
-
826
- | **Default (Off)** | **Hover (Off)** | **Default (On)** | **Hover (On)** | **Disabled** |
827
- | ----------------- | --------------- | ---------------- | -------------- | ------------ |
828
-
829
- **ButtonIcon**
830
-
831
- ---
832
-
833
- **ButtonIcon**
834
-
835
- ---
836
-
837
- **ButtonIcon**
838
-
839
- ---
840
-
841
- **ButtonIcon**
842
-
843
- ---
844
-
845
- **ButtonIcon**
846
-
847
- ---
848
-
849
- ### Large Tertiary Icon Button
850
-
851
- The Tertiary Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon). It is not usually paired with other Icon Buttons.
852
-
853
- Use the Tertiary Icon Button size that is most appropriate for the design it is being used in.
854
-
855
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
856
-
857
- | **Default** | **Hover** | **Pressed** |
858
- | ----------- | --------- | ----------- |
859
-
860
- **ButtonIcon**
861
-
862
- ---
863
-
864
- **ButtonIcon**
865
-
866
- ---
867
-
868
- **ButtonIcon**
869
-
870
- ---
871
-
872
- ### Medium Tertiary Icon Button
873
-
874
- The Tertiary Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon). It is not usually paired with other Icon Buttons.
875
-
876
- Use the Tertiary Icon Button size that is most appropriate for the design it is being used in.
877
-
878
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
879
-
880
- | **Default** | **Hover** | **Pressed** |
881
- | ----------- | --------- | ----------- |
882
-
883
- **ButtonIcon**
884
-
885
- ---
886
-
887
- **ButtonIcon**
888
-
889
- ---
890
-
891
- **ButtonIcon**
892
-
893
- ---
894
-
895
- ### Small Tertiary Icon Button
896
-
897
- The Tertiary Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon). It is not usually paired with other Icon Buttons.
898
-
899
- Use the Tertiary Icon Button size that is most appropriate for the design it is being used in.
900
-
901
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
902
-
903
- | **Default** | **Hover** | **Pressed** |
904
- | ----------- | --------- | ----------- |
905
-
906
- **ButtonIcon**
907
-
908
- ---
909
-
910
- **ButtonIcon**
911
-
912
- ---
913
-
914
- **ButtonIcon**
915
-
916
- ---
917
-
918
- ---
919
-
920
- ### Icon Button Spacing
921
-
922
- These rules establish how much margin should exist between and around elements.
923
-
924
- **Icon Button Spacing**
925
-
926
- ---
927
-
928
- ---
929
-
930
- ## Rounded Dropdown Button
931
-
932
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
933
- | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
934
-
935
- ### Primary Rounded Dropdown Button
936
-
937
- Use when there is a need to present the user with multiple options for actions that can be performed using a Button (generally in a similar context as Icon Buttons).
938
-
939
- The Primary Rounded Dropdown Button should be used in places that require the user's primary attention or to emphasize a primary action.
940
-
941
- The options are presented in a dropdown menu; use in conjunction with Dropdown Menu component.
942
-
943
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
944
-
945
- | **Default** | **Hover** | **Pressed** | **Disabled** |
946
- | ----------- | --------- | ----------- | ------------ |
947
-
948
- **ButtonDropdown**
949
-
950
- ---
951
-
952
- **ButtonDropdown**
953
-
954
- ---
955
-
956
- **ButtonDropdown**
957
-
958
- ---
959
-
960
- **ButtonDropdown**
961
-
962
- ---
963
-
964
- ### Secondary Rounded Dropdown Button
965
-
966
- Use for Header-level Actions with multiple result options (generally in same context as Icon Buttons).
967
-
968
- The options are presented in a dropdown menu; use in conjunction with Dropdown Menu component.
969
-
970
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
971
-
972
- | **Default** | **Hover** | **Pressed** | **Disabled** |
973
- | ----------- | --------- | ----------- | ------------ |
974
-
975
- **ButtonDropdown**
976
-
977
- ---
978
-
979
- **ButtonDropdown**
980
-
981
- ---
982
-
983
- **ButtonDropdown**
984
-
985
- ---
986
-
987
- **ButtonDropdown**
988
-
989
- ---
990
-
991
- ---
992
-
993
- ### Rounded Dropdown Button Spacing
994
-
995
- These rules establish how much margin should exist between and around elements.
996
-
997
- **Rounded Dropdown Button Spacing**
998
-
999
- ---
1000
-
1001
- ---
1002
-
1003
- ## Square Dropdown Button
1004
-
1005
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
1006
- | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
1007
-
1008
- ### Primary Square Dropdown Button
1009
-
1010
- Use when there is a need to present the user with multiple options for actions that can be performed using a Button (generally in a similar context as icon Buttons).
1011
-
1012
- The Primary Square Dropdown Button should be used in places that require the user's primary attention or to emphasize a primary action.
1013
-
1014
- The options are presented in a dropdown menu; use in conjunction with Dropdown Menu component.
1015
-
1016
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1017
-
1018
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1019
- | ----------- | --------- | ----------- | ------------ |
1020
-
1021
- **ButtonDropdown**
1022
-
1023
- ---
1024
-
1025
- **ButtonDropdown**
1026
-
1027
- ---
1028
-
1029
- **ButtonDropdown**
1030
-
1031
- ---
1032
-
1033
- **ButtonDropdown**
1034
-
1035
- ---
1036
-
1037
- ### Secondary Square Dropdown Button
1038
-
1039
- Use when there is a need to present the user with multiple options for actions that can be performed using a Button (generally in a similar context as icon Buttons).
1040
-
1041
- The Secondary Square Dropdown Button should be used for deemphasized or secondary actions
1042
-
1043
- The options are presented in a dropdown menu; use in conjunction with Dropdown Menu component.
1044
-
1045
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1046
-
1047
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1048
- | ----------- | --------- | ----------- | ------------ |
1049
-
1050
- **ButtonDropdown**
1051
-
1052
- ---
1053
-
1054
- **ButtonDropdown**
1055
-
1056
- ---
1057
-
1058
- **ButtonDropdown**
1059
-
1060
- ---
1061
-
1062
- **ButtonDropdown**
1063
-
1064
- ---
1065
-
1066
- ---
1067
-
1068
- ### Square Dropdown Button Spacing
1069
-
1070
- These rules establish how much margin should exist between and around elements.
1071
-
1072
- **Square Dropdown Button Spacing**
1073
-
1074
- ---
1075
-
1076
- ## Code
1077
-
1078
- ## Button Components
1079
-
1080
- | Below you will find interactive Storybook iframes for each component within the Button element group. 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:** Button ButtonIcon ButtonDropdown |
1081
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------- |
1082
-
1083
- ---
1084
-
1085
- > 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.
1086
-
1087
- ### Button
1088
-
1089
- Storybook
1090
-
1091
- ---
1092
-
1093
- ### ButtonIcon
1094
-
1095
- Storybook
1096
-
1097
- ---
1098
-
1099
- ### ButtonDropdown
1100
-
1101
- Storybook
1102
-
1103
- ---
1104
-
1105
- Buttons are one of the primary ways users interact with and provide input to the product's UI, serving as the main elements to solicit user action.
1106
-
1107
- ## Overview
1108
-
1109
- ## Button Variants
1110
-
1111
- | There are a range of Button variants available for designers to use in their layouts depending on the amount of emphasis the Button needs to have, its location in the UI, and whether it is existing alone or alongside other Buttons. Follow the usage criteria accompanying each variant as a guide for selecting the correct Button for any given use case. | | **Jump to variant:** Rounded Square Minimal Icon Rounded Dropdown |
1112
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------------------------------------- |
1113
-
1114
- ### Visual Preview
1115
-
1116
- Use the links below to jump to information on a specific Button variant:
1117
-
1118
- **Button**
1119
-
1120
- ---
1121
-
1122
- **Button**
1123
-
1124
- ---
1125
-
1126
- **Button**
1127
-
1128
- ---
1129
-
1130
- **ButtonIcon**
1131
-
1132
- ---
1133
-
1134
- **ButtonDropdown**
1135
-
1136
- ---
1137
-
1138
- ---
1139
-
1140
- ## Rounded Button
1141
-
1142
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
1143
- | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
1144
-
1145
- ### Primary Rounded Button
1146
-
1147
- General use for a primary or emphasized action.
1148
-
1149
- Include an icon when needing to provide additional context to users of what action the Button has.
1150
-
1151
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1152
-
1153
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1154
- | ----------- | --------- | ----------- | ------------ |
1155
-
1156
- **Button**
1157
-
1158
- ---
1159
-
1160
- **Button**
1161
-
1162
- ---
1163
-
1164
- **Button**
1165
-
1166
- ---
1167
-
1168
- **Button**
1169
-
1170
- ---
1171
-
1172
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1173
- | ------------------ | --------- | ----------- | ------------ |
1174
-
1175
- **Button**
1176
-
1177
- ---
1178
-
1179
- **Button**
1180
-
1181
- ---
1182
-
1183
- **Button**
1184
-
1185
- ---
1186
-
1187
- **Button**
1188
-
1189
- ---
1190
-
1191
- ### Secondary Rounded Button
1192
-
1193
- Use for a secondary action, or deemphasized Button. Often paired with primary Button.
1194
-
1195
- Include an icon when needing to provide additional context to users of what action the Button has.
1196
-
1197
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1198
-
1199
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1200
- | ----------- | --------- | ----------- | ------------ |
1201
-
1202
- **Button**
1203
-
1204
- ---
1205
-
1206
- **Button**
1207
-
1208
- ---
1209
-
1210
- **Button**
1211
-
1212
- ---
1213
-
1214
- **Button**
1215
-
1216
- ---
1217
-
1218
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1219
- | ------------------ | --------- | ----------- | ------------ |
1220
-
1221
- **Button**
1222
-
1223
- ---
1224
-
1225
- **Button**
1226
-
1227
- ---
1228
-
1229
- **Button**
1230
-
1231
- ---
1232
-
1233
- **Button**
1234
-
1235
- ---
1236
-
1237
- ### Error Rounded Button
1238
-
1239
- Use the error Button when the outcome of the user clicking the button will result in something being removed or deleted.
1240
-
1241
- Include an icon when needing to provide additional context to users of what action the Button has.
1242
-
1243
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1244
-
1245
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1246
- | ----------- | --------- | ----------- | ------------ |
1247
-
1248
- **Button**
1249
-
1250
- ---
1251
-
1252
- **Button**
1253
-
1254
- ---
1255
-
1256
- **Button**
1257
-
1258
- ---
1259
-
1260
- **Button**
1261
-
1262
- ---
1263
-
1264
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1265
- | ------------------ | --------- | ----------- | ------------ |
1266
-
1267
- **Button**
1268
-
1269
- ---
1270
-
1271
- **Button**
1272
-
1273
- ---
1274
-
1275
- **Button**
1276
-
1277
- ---
1278
-
1279
- **Button**
1280
-
1281
- ---
1282
-
1283
- ---
1284
-
1285
- ### Rounded Button Spacing
1286
-
1287
- These rules establish how much margin should exist between and around elements.
1288
-
1289
- **Rounded Button Spacing**
1290
-
1291
- ---
1292
-
1293
- ---
1294
-
1295
- ## Square Button
1296
-
1297
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
1298
- | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
1299
-
1300
- ### Primary Square Button
1301
-
1302
- Used to complete primary actions within Forms and Dropdown Menus; paired with Text Inputs.
1303
-
1304
- Include an icon when needing to provide additional context to users of what action the Button has.
1305
-
1306
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1307
-
1308
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1309
- | ----------- | --------- | ----------- | ------------ |
1310
-
1311
- **Button**
1312
-
1313
- ---
1314
-
1315
- **Button**
1316
-
1317
- ---
1318
-
1319
- **Button**
1320
-
1321
- ---
1322
-
1323
- **Button**
1324
-
1325
- ---
1326
-
1327
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1328
- | ------------------ | --------- | ----------- | ------------ |
1329
-
1330
- **Button**
1331
-
1332
- ---
1333
-
1334
- **Button**
1335
-
1336
- ---
1337
-
1338
- **Button**
1339
-
1340
- ---
1341
-
1342
- **Button**
1343
-
1344
- ---
1345
-
1346
- ### Secondary Square Button
1347
-
1348
- Used to complete secondary actions within Forms and Dropdown Menus; paired with Text Inputs.
1349
-
1350
- Include an icon when needing to provide additional context to users of what action the Button has.
1351
-
1352
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1353
-
1354
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1355
- | ----------- | --------- | ----------- | ------------ |
1356
-
1357
- **Button**
1358
-
1359
- ---
1360
-
1361
- **Button**
1362
-
1363
- ---
1364
-
1365
- **Button**
1366
-
1367
- ---
1368
-
1369
- **Button**
1370
-
1371
- ---
1372
-
1373
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1374
- | ------------------ | --------- | ----------- | ------------ |
1375
-
1376
- **Button**
1377
-
1378
- ---
1379
-
1380
- **Button**
1381
-
1382
- ---
1383
-
1384
- **Button**
1385
-
1386
- ---
1387
-
1388
- **Button**
1389
-
1390
- ---
1391
-
1392
- ### Error Square Button
1393
-
1394
- Use the error Button when the outcome of the user clicking the button will result in something being removed or deleted.
1395
-
1396
- Include an icon when needing to provide additional context to users of what action the Button has.
1397
-
1398
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1399
-
1400
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1401
- | ----------- | --------- | ----------- | ------------ |
1402
-
1403
- **Button**
1404
-
1405
- ---
1406
-
1407
- **Button**
1408
-
1409
- ---
1410
-
1411
- **Button**
1412
-
1413
- ---
1414
-
1415
- **Button**
1416
-
1417
- ---
1418
-
1419
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1420
- | ------------------ | --------- | ----------- | ------------ |
1421
-
1422
- **Button**
1423
-
1424
- ---
1425
-
1426
- **Button**
1427
-
1428
- ---
1429
-
1430
- **Button**
1431
-
1432
- ---
1433
-
1434
- **Button**
1435
-
1436
- ---
1437
-
1438
- ---
1439
-
1440
- ### Square Button Spacing
1441
-
1442
- These rules establish how much margin should exist between and around elements.
1443
-
1444
- **Square Button Spacing**
1445
-
1446
- ---
1447
-
1448
- ---
1449
-
1450
- ## Minimal Button
1451
-
1452
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
1453
- | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
1454
-
1455
- ### Primary Minimal Button
1456
-
1457
- Text Buttons initiate actions that keep the user on the same page, such as opening or closing dialog windows or overlays. They should contain a maximum of 2-3 words.
1458
-
1459
- If a longer or inline call to action with a similar visual style is needed, a Text Link might be more appropriate. In addition to containing more words, Text Links navigate the user away from their current page to a new one, whereas Minimal Buttons keep users on the same page.
1460
-
1461
- Include an icon when needing to provide additional context to users of what action the Button has.
1462
-
1463
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1464
-
1465
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1466
- | ----------- | --------- | ----------- | ------------ |
1467
-
1468
- **Button**
1469
-
1470
- ---
1471
-
1472
- **Button**
1473
-
1474
- ---
1475
-
1476
- **Button**
1477
-
1478
- ---
1479
-
1480
- **Button**
1481
-
1482
- ---
1483
-
1484
- | **Default + Icon** | **Hover** | **Pressed** | **Disabled** |
1485
- | ------------------ | --------- | ----------- | ------------ |
1486
-
1487
- **Button**
1488
-
1489
- ---
1490
-
1491
- **Button**
1492
-
1493
- ---
1494
-
1495
- **Button**
1496
-
1497
- ---
1498
-
1499
- **Button**
1500
-
1501
- ---
1502
-
1503
- ### Secondary Minimal Button
1504
-
1505
- Use for a deemphasized action or when paired with a Primary Minimal Button
1506
-
1507
- Note: only Primary Minimal Buttons can be paired with icons.
1508
-
1509
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1510
-
1511
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1512
- | ----------- | --------- | ----------- | ------------ |
1513
-
1514
- **Button**
1515
-
1516
- ---
1517
-
1518
- **Button**
1519
-
1520
- ---
1521
-
1522
- **Button**
1523
-
1524
- ---
1525
-
1526
- **Button**
1527
-
1528
- ---
1529
-
1530
- ---
1531
-
1532
- ### Minimal Button Spacing
1533
-
1534
- These rules establish how much margin should exist between and around elements.
1535
-
1536
- **Minimal Button Spacing**
1537
-
1538
- ---
1539
-
1540
- ---
1541
-
1542
- ## Icon Button
1543
-
1544
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
1545
- | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
1546
-
1547
- ### Large Primary Icon Button
1548
-
1549
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
1550
-
1551
- The Primary Icon Button should be used in places that require the user's primary attention or to emphasize a primary action.
1552
-
1553
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
1554
-
1555
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1556
-
1557
- | **Default (Off)** | **Hover (Off)** | **Pressed** | **Default (On)** | **Hover (On)** | **Disabled** |
1558
- | ----------------- | --------------- | ----------- | ---------------- | -------------- | ------------ |
1559
-
1560
- **ButtonIcon**
1561
-
1562
- ---
1563
-
1564
- **ButtonIcon**
1565
-
1566
- ---
1567
-
1568
- **ButtonIcon**
1569
-
1570
- ---
1571
-
1572
- **ButtonIcon**
1573
-
1574
- ---
1575
-
1576
- **ButtonIcon**
1577
-
1578
- ---
1579
-
1580
- **ButtonIcon**
1581
-
1582
- ---
1583
-
1584
- ### Small Primary Icon Button
1585
-
1586
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
1587
-
1588
- The Primary Icon Button should be used in places that require the user's primary attention or to emphasize a primary action.
1589
-
1590
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
1591
-
1592
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1593
-
1594
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1595
- | ----------- | --------- | ----------- | ------------ |
1596
-
1597
- **ButtonIcon**
1598
-
1599
- ---
1600
-
1601
- **ButtonIcon**
1602
-
1603
- ---
1604
-
1605
- **ButtonIcon**
1606
-
1607
- ---
1608
-
1609
- **ButtonIcon**
1610
-
1611
- ---
1612
-
1613
- ### Large Secondary Icon Button
1614
-
1615
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
1616
-
1617
- The Secondary Icon Button should be used for deemphasized or secondary actions; often paired with the Primary Icon Button.
1618
-
1619
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
1620
-
1621
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1622
-
1623
- | **Default (Off)** | **Hover (Off)** | **Default (On)** | **Hover (On)** | **Disabled** |
1624
- | ----------------- | --------------- | ---------------- | -------------- | ------------ |
1625
-
1626
- **ButtonIcon**
1627
-
1628
- ---
1629
-
1630
- **ButtonIcon**
1631
-
1632
- ---
1633
-
1634
- **ButtonIcon**
1635
-
1636
- ---
1637
-
1638
- **ButtonIcon**
1639
-
1640
- ---
1641
-
1642
- **ButtonIcon**
1643
-
1644
- ---
1645
-
1646
- ### Small Secondary Icon Button
1647
-
1648
- Use in instances where a standard sized Button won't fit or doesn't seem necessary such as in charts, tables, navigation bars, etc.
1649
-
1650
- The Secondary Icon Button should be used for deemphasized or secondary actions; often paired with the Primary Icon Button.
1651
-
1652
- Icon Buttons can be coupled with a Dropdown Menu when there are multiple options available to the user upon triggering the Button.
1653
-
1654
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1655
-
1656
- | **Default (Off)** | **Hover (Off)** | **Default (On)** | **Hover (On)** | **Disabled** |
1657
- | ----------------- | --------------- | ---------------- | -------------- | ------------ |
1658
-
1659
- **ButtonIcon**
1660
-
1661
- ---
1662
-
1663
- **ButtonIcon**
1664
-
1665
- ---
1666
-
1667
- **ButtonIcon**
1668
-
1669
- ---
1670
-
1671
- **ButtonIcon**
1672
-
1673
- ---
1674
-
1675
- **ButtonIcon**
1676
-
1677
- ---
1678
-
1679
- ### Large Tertiary Icon Button
1680
-
1681
- The Tertiary Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon). It is not usually paired with other Icon Buttons.
1682
-
1683
- Use the Tertiary Icon Button size that is most appropriate for the design it is being used in.
1684
-
1685
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1686
-
1687
- | **Default** | **Hover** | **Pressed** |
1688
- | ----------- | --------- | ----------- |
1689
-
1690
- **ButtonIcon**
1691
-
1692
- ---
1693
-
1694
- **ButtonIcon**
1695
-
1696
- ---
1697
-
1698
- **ButtonIcon**
1699
-
1700
- ---
1701
-
1702
- ### Medium Tertiary Icon Button
1703
-
1704
- The Tertiary Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon). It is not usually paired with other Icon Buttons.
1705
-
1706
- Use the Tertiary Icon Button size that is most appropriate for the design it is being used in.
1707
-
1708
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1709
-
1710
- | **Default** | **Hover** | **Pressed** |
1711
- | ----------- | --------- | ----------- |
1712
-
1713
- **ButtonIcon**
1714
-
1715
- ---
1716
-
1717
- **ButtonIcon**
1718
-
1719
- ---
1720
-
1721
- **ButtonIcon**
1722
-
1723
- ---
1724
-
1725
- ### Small Tertiary Icon Button
1726
-
1727
- The Tertiary Icon Button should be used for lowest level actions that are not a part of the user's main workflow, such as closing a Dialog or expanding an Accordion (documentation coming soon). It is not usually paired with other Icon Buttons.
1728
-
1729
- Use the Tertiary Icon Button size that is most appropriate for the design it is being used in.
1730
-
1731
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1732
-
1733
- | **Default** | **Hover** | **Pressed** |
1734
- | ----------- | --------- | ----------- |
1735
-
1736
- **ButtonIcon**
1737
-
1738
- ---
1739
-
1740
- **ButtonIcon**
1741
-
1742
- ---
1743
-
1744
- **ButtonIcon**
1745
-
1746
- ---
1747
-
1748
- ---
1749
-
1750
- ### Icon Button Spacing
1751
-
1752
- These rules establish how much margin should exist between and around elements.
1753
-
1754
- **Icon Button_Large Spacing**
1755
-
1756
- ---
1757
-
1758
- ---
1759
-
1760
- ## Rounded Dropdown Button
1761
-
1762
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
1763
- | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
1764
-
1765
- ### Primary Rounded Dropdown Button
1766
-
1767
- Use when there is a need to present the user with multiple options for actions that can be performed using a Button (generally in a similar context as Icon Buttons).
1768
-
1769
- The Primary Rounded Dropdown Button should be used in places that require the user's primary attention or to emphasize a primary action.
1770
-
1771
- The options are presented in a dropdown menu; use in conjunction with Dropdown Menu component.
1772
-
1773
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1774
-
1775
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1776
- | ----------- | --------- | ----------- | ------------ |
1777
-
1778
- **ButtonDropdown**
1779
-
1780
- ---
1781
-
1782
- **ButtonDropdown**
1783
-
1784
- ---
1785
-
1786
- **ButtonDropdown**
1787
-
1788
- ---
1789
-
1790
- **ButtonDropdown**
1791
-
1792
- ---
1793
-
1794
- ### Secondary Rounded Dropdown Button
1795
-
1796
- Use for Header-level Actions with multiple result options (generally in same context as Icon Buttons).
1797
-
1798
- The options are presented in a dropdown menu; use in conjunction with Dropdown Menu component.
1799
-
1800
- Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
1801
-
1802
- | **Default** | **Hover** | **Pressed** | **Disabled** |
1803
- | ----------- | --------- | ----------- | ------------ |
1804
-
1805
- **ButtonDropdown**
1806
-
1807
- ---
1808
-
1809
- **ButtonDropdown**
1810
-
1811
- ---
1812
-
1813
- **ButtonDropdown**
1814
-
1815
- ---
1816
-
1817
- **ButtonDropdown**
1818
-
1819
- ---
1820
-
1821
- ---
1822
-
1823
- ### Rounded Dropdown Button Spacing
1824
-
1825
- These rules establish how much margin should exist between and around elements.
1826
-
1827
- **Rounded Dropdown Button Spacing**
1828
-
1829
- ---
1830
-
1831
- ## Code
1832
-
1833
- ## Button Components
1834
-
1835
- | Below you will find interactive Storybook iframes for each component within the Button element group. 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:** Button ButtonIcon ButtonDropdown |
1836
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------- |
1837
-
1838
- ---
1839
-
1840
- ### Button
1841
-
1842
- Storybook
1843
-
1844
- ---
1845
-
1846
- ### ButtonIcon
1847
-
1848
- Storybook
1849
-
1850
- ---
1851
-
1852
- ### ButtonDropdown
1853
-
1854
- Storybook