@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
@@ -4,8 +4,8 @@ Tags are used to help with categorization on plugin pages or in conjunction with
4
4
 
5
5
  ## Overview
6
6
 
7
- | There are two Tag component types—standard Tags and Filter Tags. Tags are used to label the attributes of each plugin, helping users identify relevant plugins to use in their workflows whereas Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to the list of plugins. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tag for any given use case. | | **Jump to variant:** Tag Filter Tag |
8
- | --- | --- | --- |
7
+ | There are two Tag component types—standard Tags and Filter Tags. Tags are used to label the attributes of each plugin, helping users identify relevant plugins to use in their workflows whereas Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to the list of plugins. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tag for any given use case. | | **Jump to variant:** Tag Filter Tag |
8
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------- |
9
9
 
10
10
  ### Visual Preview
11
11
 
@@ -15,8 +15,8 @@ Use the links below to jump to information on a specific Tag:
15
15
 
16
16
  ## Tag
17
17
 
18
- | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
19
- | --- | --- | --- | --- | --- | --- | --- | --- |
18
+ | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
19
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
20
20
 
21
21
  Tags are used to label the attributes of each plugin; these attributes are able to be filtered on using the Filter component. On the plugin list page, when a given parameter is filtered on, any matching attributes will appear as `active` Tags at the bottom of each plugin card. Additional attributes will continue to be displayed as `inactive` Tags. Users can click on any `inactive` Tag to add it as a Filter parameter.
22
22
 
@@ -27,7 +27,7 @@ The InfoCircle icons within each Tag can be hovered over to display a Tooltip th
27
27
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
28
28
 
29
29
  | **Default (Inactive)** | **Default (Active)** | **Hover** | **Pressed** |
30
- | --- | --- | --- | --- |
30
+ | ---------------------- | -------------------- | --------- | ----------- |
31
31
 
32
32
  ---
33
33
 
@@ -39,15 +39,15 @@ These rules establish how much margin should exist between and around elements.
39
39
 
40
40
  ## Filter Tag
41
41
 
42
- | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
43
- | --- | --- | --- | --- | --- | --- | --- | --- |
42
+ | | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
43
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
44
44
 
45
45
  On the left-side filter panel on the plugin list page, Filter Tags appear underneath each Filter Dropdown Input to communicate that the plugin list is being filtered on the parameter indicated on the Tag. Users can click on the Xmark icon on the tag to remove that parameter from the group of filters being applied.
46
46
 
47
47
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
48
48
 
49
49
  | **Default** | **Hover** | **Pressed** |
50
- | --- | --- | --- |
50
+ | ----------- | --------- | ----------- |
51
51
 
52
52
  ---
53
53
 
@@ -59,12 +59,12 @@ These rules establish how much margin should exist between and around elements.
59
59
 
60
60
  ## Tag Components
61
61
 
62
- | Below you will find interactive Storybook iframes for each component within the Tags 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:** Tag TagFilter |
63
- | --- | --- | --- |
62
+ | Below you will find interactive Storybook iframes for each component within the Tags 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:** Tag TagFilter |
63
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------ |
64
64
 
65
65
  ---
66
66
 
67
- >This component appears as it is 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.
67
+ > This component appears as it is 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.
68
68
 
69
69
  ### Tag
70
70
 
@@ -84,15 +84,15 @@ Tags are used to label the status of certain elements or in conjunction with fil
84
84
 
85
85
  ## Tag Variants
86
86
 
87
- | There are two primary Tag variants—Filter Tags and standard Tags. Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to a given dataset. Standard Tags are used throughout the UI whenever there's a need to label an element or communicate a status associated with it. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tag for any given use case. | | **Jump to variant:** Filter Rounded |
88
- | --- | --- | --- |
87
+ | There are two primary Tag variants—Filter Tags and standard Tags. Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to a given dataset. Standard Tags are used throughout the UI whenever there's a need to label an element or communicate a status associated with it. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tag for any given use case. | | **Jump to variant:** Filter Rounded |
88
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------- |
89
89
 
90
90
  ---
91
91
 
92
92
  ## Filter Tag
93
93
 
94
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
95
- | --- | --- | --- | --- | --- | --- | --- | --- |
94
+ | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
95
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
96
96
 
97
97
  ### Filter Tag
98
98
 
@@ -101,7 +101,7 @@ Used in conjunction with Filters to communicate that the dataset is being filter
101
101
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
102
102
 
103
103
  | **Default** | **Hover** | **Pressed** |
104
- | --- | --- | --- |
104
+ | ----------- | --------- | ----------- |
105
105
 
106
106
  ---
107
107
 
@@ -113,8 +113,8 @@ These rules establish how much margin should exist between and around elements.
113
113
 
114
114
  ## Rounded Tag
115
115
 
116
- | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
117
- | --- | --- | --- | --- | --- | --- | --- | --- |
116
+ | | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
117
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
118
118
 
119
119
  ### Secondary Rounded Tag
120
120
 
@@ -123,10 +123,10 @@ Used in CZ GEN EPI without an icon to display the status of a sample within tabl
123
123
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
124
124
 
125
125
  | **Default** | **Hover** | **Pressed** |
126
- | --- | --- | --- |
126
+ | ----------- | --------- | ----------- |
127
127
 
128
128
  | **Default + Icon** | **Hover** | **Pressed** |
129
- | --- | --- | --- |
129
+ | ------------------ | --------- | ----------- |
130
130
 
131
131
  ---
132
132
 
@@ -143,21 +143,21 @@ There are four different intents that Tags can communicate—Info, Error, Succes
143
143
  The Info variant is used when the information being communicated is neutral in nature and is meant to draw the user's attention to the element it is placed beside, providing additional context or details. The Error, Success, and Warning variants are meant to be used to communicate the status of the element, feature, or process they are placed beside.
144
144
 
145
145
  | **Error** | **Info** |
146
- | --- | --- |
146
+ | --------- | -------- |
147
147
 
148
148
  | **Success** | **Warning** |
149
- | --- | --- |
149
+ | ----------- | ----------- |
150
150
 
151
151
  ## Code
152
152
 
153
153
  ## Tag Components
154
154
 
155
- | Below you will find interactive Storybook iframes for each component within the Tags 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:** TagFilter Tag |
156
- | --- | --- | --- |
155
+ | Below you will find interactive Storybook iframes for each component within the Tags 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:** TagFilter Tag |
156
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------ |
157
157
 
158
158
  ---
159
159
 
160
- >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.
160
+ > 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.
161
161
 
162
162
  ### TagFilter
163
163
 
@@ -177,22 +177,22 @@ Tags are used to label the status of certain elements or in conjunction with fil
177
177
 
178
178
  ## Tag Variants
179
179
 
180
- | There are two primary Tag variants—Filter Tags and standard Tags. Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to a given dataset. Standard Tags come in two styles, Rounded and Square, and can be used throughout the UI whenever there's a need to label an element or communicate a status associated with it. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tag for any given use case. | | **Jump to variant:** Filter Rounded Square |
181
- | --- | --- | --- |
180
+ | There are two primary Tag variants—Filter Tags and standard Tags. Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to a given dataset. Standard Tags come in two styles, Rounded and Square, and can be used throughout the UI whenever there's a need to label an element or communicate a status associated with it. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tag for any given use case. | | **Jump to variant:** Filter Rounded Square |
181
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------ |
182
182
 
183
183
  ---
184
184
 
185
185
  ## Filter Tag
186
186
 
187
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
188
- | --- | --- | --- | --- | --- | --- | --- | --- |
187
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
188
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
189
189
 
190
190
  Used in conjunction with Filters to communicate that the dataset is being filtered on the parameter indicated in the Tag. Users click on the Filter Tag to remove that parameter from the group of filters being applied.
191
191
 
192
192
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
193
193
 
194
194
  | **Default** | **Hover** | **Pressed** |
195
- | --- | --- | --- |
195
+ | ----------- | --------- | ----------- |
196
196
 
197
197
  ---
198
198
 
@@ -204,8 +204,8 @@ These rules establish how much margin should exist between and around elements.
204
204
 
205
205
  ## Rounded Tag
206
206
 
207
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
208
- | --- | --- | --- | --- | --- | --- | --- | --- |
207
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
208
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
209
209
 
210
210
  Secondary Tag option for a primary label.
211
211
 
@@ -214,10 +214,10 @@ Used in CZ ID without an icon to display the status of a sample within a Table.
214
214
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
215
215
 
216
216
  | **Default** | **Hover** | **Pressed** |
217
- | --- | --- | --- |
217
+ | ----------- | --------- | ----------- |
218
218
 
219
219
  | **Default + Icon** | **Hover** | **Pressed** |
220
- | --- | --- | --- |
220
+ | ------------------ | --------- | ----------- |
221
221
 
222
222
  ---
223
223
 
@@ -229,8 +229,8 @@ These rules establish how much margin should exist between and around elements.
229
229
 
230
230
  ## Square Tag
231
231
 
232
- | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
233
- | --- | --- | --- | --- | --- | --- | --- | --- |
232
+ | | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
233
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
234
234
 
235
235
  Alternate Tag shape for a label.
236
236
 
@@ -239,7 +239,7 @@ Used within CZ ID to label taxons as pathogenic.
239
239
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
240
240
 
241
241
  | **Default** | **Hover** | **Pressed** |
242
- | --- | --- | --- |
242
+ | ----------- | --------- | ----------- |
243
243
 
244
244
  ---
245
245
 
@@ -251,8 +251,8 @@ These rules establish how much margin should exist between and around elements.
251
251
 
252
252
  ## Tag Components
253
253
 
254
- | Below you will find interactive Storybook iframes for each component within the Tags 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:** TagFilter Tag |
255
- | --- | --- | --- |
254
+ | Below you will find interactive Storybook iframes for each component within the Tags 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:** TagFilter Tag |
255
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------ |
256
256
 
257
257
  ---
258
258
 
@@ -266,7 +266,7 @@ Storybook
266
266
 
267
267
  Storybook
268
268
 
269
-  
269
+
270
270
 
271
271
  ---
272
272
 
@@ -276,8 +276,8 @@ Tags are used to label the status of certain elements or in conjunction with fil
276
276
 
277
277
  ## Tag Components
278
278
 
279
- | There are two types of Tags—standard and filter. Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to a given dataset. Standard Tags come in two styles, Rounded and Square, and can be used throughout the UI whenever there's a need to label an element or communicate a status associated with it. | | **Jump to variant:** Tag Filter Tag |
280
- | --- | --- | --- |
279
+ | There are two types of Tags—standard and filter. Filter Tags are used in conjunction with the Filter component to indicate which filters have been applied to a given dataset. Standard Tags come in two styles, Rounded and Square, and can be used throughout the UI whenever there's a need to label an element or communicate a status associated with it. | | **Jump to variant:** Tag Filter Tag |
280
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------- |
281
281
 
282
282
  ### Visual Preview
283
283
 
@@ -285,8 +285,8 @@ Tags are used to label the status of certain elements or in conjunction with fil
285
285
 
286
286
  ## Tag
287
287
 
288
- | | In Figma | | | Meets Accessibility | | | In Code |
289
- | --- | --- | --- | --- | --- | --- | --- | --- |
288
+ | | In Figma | | | Meets Accessibility | | | In Code |
289
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
290
290
 
291
291
  ### Tag Styles
292
292
 
@@ -310,19 +310,19 @@ Tag – Rounded is the default style used across applications, however if an alt
310
310
 
311
311
  Use Tag – Primary in conjunction with the primary or most important content. Include an icon when needing to provide additional context to users of what content the Tag is connected to.
312
312
 
313
- >**Note:** An icon must be included when using the large variant.
313
+ > **Note:** An icon must be included when using the large variant.
314
314
 
315
315
  | Default | Hover | Pressed |
316
- | --- | --- | --- |
316
+ | ------- | ----- | ------- |
317
317
 
318
318
  #### Secondary
319
319
 
320
320
  Use Tag – Secondary in conjunction with secondary or less important content. Include an icon when needing to provide additional context to users of what content the Tag is connected to.
321
321
 
322
- >**Note:** An icon must be included when using the large variant.
322
+ > **Note:** An icon must be included when using the large variant.
323
323
 
324
324
  | Default | Hover | Pressed |
325
- | --- | --- | --- |
325
+ | ------- | ----- | ------- |
326
326
 
327
327
  ---
328
328
 
@@ -334,19 +334,19 @@ Tag – Square is to be used when an alternate Tag style is needed as determined
334
334
 
335
335
  Use Tag – Primary in conjunction with the primary or most important content. Include an icon when needing to provide additional context to users of what content the Tag is connected to.
336
336
 
337
- >**Note:** An icon must be included when using the large variant.
337
+ > **Note:** An icon must be included when using the large variant.
338
338
 
339
339
  | Default | Hover | Pressed |
340
- | --- | --- | --- |
340
+ | ------- | ----- | ------- |
341
341
 
342
342
  #### Secondary
343
343
 
344
344
  Use Tag – Secondary in conjunction with secondary or less important content. Include an icon when needing to provide additional context to users of what content the Tag is connected to.
345
345
 
346
- >**Note:** An icon must be included when using the large variant.
346
+ > **Note:** An icon must be included when using the large variant.
347
347
 
348
348
  | Default | Hover | Pressed |
349
- | --- | --- | --- |
349
+ | ------- | ----- | ------- |
350
350
 
351
351
  ---
352
352
 
@@ -365,19 +365,19 @@ Each intent is demonstrated below using the default state of the rounded variant
365
365
  #### Primary
366
366
 
367
367
  | Beta | Info | Negative | None | Notice | Positive |
368
- | --- | --- | --- | --- | --- | --- |
368
+ | ---- | ---- | -------- | ---- | ------ | -------- |
369
369
 
370
370
  #### Secondary
371
371
 
372
372
  | Beta | Info | Negative | None | Notice | Positive |
373
- | --- | --- | --- | --- | --- | --- |
373
+ | ---- | ---- | -------- | ---- | ------ | -------- |
374
374
 
375
375
  ---
376
376
 
377
377
  ## Filter Tag
378
378
 
379
- | | In Figma | | | Meets Accessibility | | | In Code |
380
- | --- | --- | --- | --- | --- | --- | --- | --- |
379
+ | | In Figma | | | Meets Accessibility | | | In Code |
380
+ | --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
381
381
 
382
382
  ### Live Instance
383
383
 
@@ -392,7 +392,7 @@ Default
392
392
  Used Filter Tag in conjunction with Filters to communicate that the dataset is being filtered on the parameter indicated on the Filter Tag. Users click on the `Xmark` icon to remove that parameter from the group of filters being applied.
393
393
 
394
394
  | Default | Hover | Pressed |
395
- | --- | --- | --- |
395
+ | ------- | ----- | ------- |
396
396
 
397
397
  ---
398
398
 
@@ -404,12 +404,12 @@ These rules establish how much margin should exist between and around elements.
404
404
 
405
405
  ## Tag Components
406
406
 
407
- | There are two types of `Tags`—standard and filter. `TagFilter` is used in conjunction with the `Filter` component to indicate which filters have been applied to a given dataset. `Tag` comes in two styles, Rounded and Square, and can be used throughout the UI whenever there's a need to label an element or communicate a status associated with it. | | **Jump to variant:** Tag TagFilter |
408
- | --- | --- | --- |
407
+ | There are two types of `Tags`—standard and filter. `TagFilter` is used in conjunction with the `Filter` component to indicate which filters have been applied to a given dataset. `Tag` comes in two styles, Rounded and Square, and can be used throughout the UI whenever there's a need to label an element or communicate a status associated with it. | | **Jump to variant:** Tag TagFilter |
408
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ---------------------------------- |
409
409
 
410
410
  ### Visual Preview
411
411
 
412
- >**Note:** The code examples below must install dependencies before displaying and may take extra time to load
412
+ > **Note:** The code examples below must install dependencies before displaying and may take extra time to load
413
413
 
414
414
  ---
415
415
 
@@ -423,9 +423,9 @@ The component's source code in the SDS codebase can be found here.
423
423
 
424
424
  The SDS `Tag` component is built on top of MUI's `Chip` component, though SDS is currently set up with distinct `Tag` and `TagFilter` components. The former is clickable but not deletable (whereas MUI's `Chip` can be either, both, or neither). Additionally, SDS's `Tag` component has a couple of props to help display SDS-specific visual properties:
425
425
 
426
- * **`sdsStyle`****:** This prop allows you specify whether the `Tag` should be `rounded` (default) or `square`.
427
- * **`sdsType`****:** This prop takes values of `primary` (default) or `secondary`.
428
- * **`size`****:** This prop is not available to SDS's `Tag`; instead its size changes automatically based on whether it is accommodating an icon via the `icon` prop or not.
426
+ - **`sdsStyle`\*\***:\*\* This prop allows you specify whether the `Tag` should be `rounded` (default) or `square`.
427
+ - **`sdsType`\*\***:\*\* This prop takes values of `primary` (default) or `secondary`.
428
+ - **`size`\*\***:\*\* This prop is not available to SDS's `Tag`; instead its size changes automatically based on whether it is accommodating an icon via the `icon` prop or not.
429
429
 
430
430
  ### MUI Documentation
431
431
 
@@ -435,17 +435,19 @@ Documentation for the underlying MUI component can be found here.
435
435
 
436
436
  Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
437
437
 
438
- | Name | Type | Default | Description |
439
- | --- | --- | --- | --- |
440
- | `hover` | `bool` | `-` | If `true`, the component changes color when hovered over. |
441
- | `label` | `string` | `-` | The label of the Tag. |
442
- | `sdsType` | `"primary"` `| "secondary"` | `primary` | The `primary` variant has a `400` background color and white text color. The `secondary` variant has a `100` background color and `500` text color. |
443
- | `sdsStyle` | `"square"` `| "rounded"` | `rounded` | The shape of the component. |
444
- | `sdsSize` | `"s" | "l"` | `"s"` | The size of the Tag component. The large-size tag must include an icon. |
445
- | `color` | `| "beta"` `| "info"` `| "negative"` `| "notice"` `| "positive"` `| [string, string]` `| [string, string, string]` | `-` | You have the flexibility to define the color of the component in two ways: 1. Choose from the available theme colors, such as `primary`, `info`, and more. 2. Customize the colors using one of the following syntax options:
438
+ | Name | Type | Default | Description |
439
+ | ---------- | ------------- | ------------ | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------- | ------------------- | ------------------------- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
440
+ | `hover` | `bool` | `-` | If `true`, the component changes color when hovered over. |
441
+ | `label` | `string` | `-` | The label of the Tag. |
442
+ | `sdsType` | `"primary"` ` | "secondary"` | `primary` | The `primary` variant has a `400` background color and white text color. The `secondary` variant has a `100` background color and `500` text color. |
443
+ | `sdsStyle` | `"square"` ` | "rounded"` | `rounded` | The shape of the component. |
444
+ | `sdsSize` | `"s" | "l"` | `"s"` | The size of the Tag component. The large-size tag must include an icon. |
445
+ | `color` | ` | "beta"` ` | "info"` ` | "negative"` ` | "notice"` ` | "positive"` ` | [string, string]` ` | [string, string, string]` | `-` | You have the flexibility to define the color of the component in two ways: 1. Choose from the available theme colors, such as `primary`, `info`, and more. 2. Customize the colors using one of the following syntax options: |
446
+
446
447
  1. [`label and icon color`, `background color`]
447
448
  2. [`label color`, `background color`, `icon color`] |
448
- | `icon` | `JSX.Element` | `-` | The icon that appears on the leading edge of the component. |
449
+
450
+ | `icon` | `JSX.Element` | `-` | The icon that appears on the leading edge of the component. |
449
451
 
450
452
  ### Code examples
451
453
 
@@ -478,13 +480,11 @@ h1 {
478
480
 
479
481
  ```json
480
482
  {
481
- "include": [
482
- "./**/*"
483
- ],
483
+ "include": ["./**/*"],
484
484
  "compilerOptions": {
485
485
  "strict": true,
486
486
  "esModuleInterop": true,
487
- "lib": [ "dom", "es2015" ],
487
+ "lib": ["dom", "es2015"],
488
488
  "jsx": "react-jsx"
489
489
  }
490
490
  }
@@ -499,7 +499,7 @@ import "./styles.css";
499
499
  function App() {
500
500
  return (
501
501
  <div className="app">
502
- <Tag label="Science Design System"/>
502
+ <Tag label="Science Design System" />
503
503
  </div>
504
504
  );
505
505
  }
@@ -544,13 +544,12 @@ root.render(
544
544
  <RootApp />
545
545
  </React.StrictMode>
546
546
  );
547
-
548
547
  ```
549
548
 
550
549
  **/public/index.html**
551
550
 
552
551
  ```html
553
- <!DOCTYPE html>
552
+ <!doctype html>
554
553
  <html lang="en">
555
554
  <head>
556
555
  <meta charset="UTF-8" />
@@ -571,13 +570,24 @@ root.render(
571
570
  <div id="root"></div>
572
571
  </body>
573
572
  </html>
574
-
575
573
  ```
576
574
 
577
575
  **/package.json**
578
576
 
579
577
  ```json
580
- {"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"}
578
+ {
579
+ "dependencies": {
580
+ "react": "^18.0.0",
581
+ "react-dom": "^18.0.0",
582
+ "react-scripts": "^4.0.0"
583
+ },
584
+ "devDependencies": {
585
+ "@types/react": "^18.0.0",
586
+ "@types/react-dom": "^18.0.0",
587
+ "typescript": "^4.0.0"
588
+ },
589
+ "main": "/index.tsx"
590
+ }
581
591
  ```
582
592
 
583
593
  ---
@@ -611,13 +621,11 @@ h1 {
611
621
 
612
622
  ```json
613
623
  {
614
- "include": [
615
- "./**/*"
616
- ],
624
+ "include": ["./**/*"],
617
625
  "compilerOptions": {
618
626
  "strict": true,
619
627
  "esModuleInterop": true,
620
- "lib": [ "dom", "es2015" ],
628
+ "lib": ["dom", "es2015"],
621
629
  "jsx": "react-jsx"
622
630
  }
623
631
  }
@@ -632,8 +640,8 @@ import "./styles.css";
632
640
  function App() {
633
641
  return (
634
642
  <div className="app">
635
- <Tag
636
- label="Virus"
643
+ <Tag
644
+ label="Virus"
637
645
  icon={<Icon sdsSize="l" sdsIcon="Virus" />}
638
646
  sdsStyle="rounded"
639
647
  color="negative"
@@ -683,13 +691,12 @@ root.render(
683
691
  <RootApp />
684
692
  </React.StrictMode>
685
693
  );
686
-
687
694
  ```
688
695
 
689
696
  **/public/index.html**
690
697
 
691
698
  ```html
692
- <!DOCTYPE html>
699
+ <!doctype html>
693
700
  <html lang="en">
694
701
  <head>
695
702
  <meta charset="UTF-8" />
@@ -710,13 +717,24 @@ root.render(
710
717
  <div id="root"></div>
711
718
  </body>
712
719
  </html>
713
-
714
720
  ```
715
721
 
716
722
  **/package.json**
717
723
 
718
724
  ```json
719
- {"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"}
725
+ {
726
+ "dependencies": {
727
+ "react": "^18.0.0",
728
+ "react-dom": "^18.0.0",
729
+ "react-scripts": "^4.0.0"
730
+ },
731
+ "devDependencies": {
732
+ "@types/react": "^18.0.0",
733
+ "@types/react-dom": "^18.0.0",
734
+ "typescript": "^4.0.0"
735
+ },
736
+ "main": "/index.tsx"
737
+ }
720
738
  ```
721
739
 
722
740
  ---
@@ -750,13 +768,11 @@ h1 {
750
768
 
751
769
  ```json
752
770
  {
753
- "include": [
754
- "./**/*"
755
- ],
771
+ "include": ["./**/*"],
756
772
  "compilerOptions": {
757
773
  "strict": true,
758
774
  "esModuleInterop": true,
759
- "lib": [ "dom", "es2015" ],
775
+ "lib": ["dom", "es2015"],
760
776
  "jsx": "react-jsx"
761
777
  }
762
778
  }
@@ -771,8 +787,8 @@ import "./styles.css";
771
787
  function App() {
772
788
  return (
773
789
  <div className="app">
774
- <Tag
775
- label="Star"
790
+ <Tag
791
+ label="Star"
776
792
  icon={<Icon sdsSize="l" sdsIcon="Star" />}
777
793
  color={["yellow", "#f23", "orange"]}
778
794
  sdsStyle="rounded"
@@ -822,13 +838,12 @@ root.render(
822
838
  <RootApp />
823
839
  </React.StrictMode>
824
840
  );
825
-
826
841
  ```
827
842
 
828
843
  **/public/index.html**
829
844
 
830
845
  ```html
831
- <!DOCTYPE html>
846
+ <!doctype html>
832
847
  <html lang="en">
833
848
  <head>
834
849
  <meta charset="UTF-8" />
@@ -849,13 +864,24 @@ root.render(
849
864
  <div id="root"></div>
850
865
  </body>
851
866
  </html>
852
-
853
867
  ```
854
868
 
855
869
  **/package.json**
856
870
 
857
871
  ```json
858
- {"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"}
872
+ {
873
+ "dependencies": {
874
+ "react": "^18.0.0",
875
+ "react-dom": "^18.0.0",
876
+ "react-scripts": "^4.0.0"
877
+ },
878
+ "devDependencies": {
879
+ "@types/react": "^18.0.0",
880
+ "@types/react-dom": "^18.0.0",
881
+ "typescript": "^4.0.0"
882
+ },
883
+ "main": "/index.tsx"
884
+ }
859
885
  ```
860
886
 
861
887
  ---
@@ -880,10 +906,10 @@ Documentation for the underlying MUI component can be found here.
880
906
 
881
907
  Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
882
908
 
883
- | Name | Type | Default | Description |
884
- | --- | --- | --- | --- |
885
- | `label` | `string` | `-` | The content of the component. |
886
- | `onDelete` | `func` | `-` | Callback fired when the delete icon is clicked. If set, the delete icon will be shown. |
909
+ | Name | Type | Default | Description |
910
+ | ---------- | -------- | ------- | -------------------------------------------------------------------------------------- |
911
+ | `label` | `string` | `-` | The content of the component. |
912
+ | `onDelete` | `func` | `-` | Callback fired when the delete icon is clicked. If set, the delete icon will be shown. |
887
913
 
888
914
  ### Code examples
889
915
 
@@ -916,13 +942,11 @@ h1 {
916
942
 
917
943
  ```json
918
944
  {
919
- "include": [
920
- "./**/*"
921
- ],
945
+ "include": ["./**/*"],
922
946
  "compilerOptions": {
923
947
  "strict": true,
924
948
  "esModuleInterop": true,
925
- "lib": [ "dom", "es2015" ],
949
+ "lib": ["dom", "es2015"],
926
950
  "jsx": "react-jsx"
927
951
  }
928
952
  }
@@ -937,10 +961,7 @@ import "./styles.css";
937
961
  function App() {
938
962
  return (
939
963
  <div className="app">
940
- <TagFilter
941
- label="Science Design System"
942
- onDelete={() => {}}
943
- />
964
+ <TagFilter label="Science Design System" onDelete={() => {}} />
944
965
  </div>
945
966
  );
946
967
  }
@@ -985,13 +1006,12 @@ root.render(
985
1006
  <RootApp />
986
1007
  </React.StrictMode>
987
1008
  );
988
-
989
1009
  ```
990
1010
 
991
1011
  **/public/index.html**
992
1012
 
993
1013
  ```html
994
- <!DOCTYPE html>
1014
+ <!doctype html>
995
1015
  <html lang="en">
996
1016
  <head>
997
1017
  <meta charset="UTF-8" />
@@ -1012,14 +1032,24 @@ root.render(
1012
1032
  <div id="root"></div>
1013
1033
  </body>
1014
1034
  </html>
1015
-
1016
1035
  ```
1017
1036
 
1018
1037
  **/package.json**
1019
1038
 
1020
1039
  ```json
1021
- {"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"}
1040
+ {
1041
+ "dependencies": {
1042
+ "react": "^18.0.0",
1043
+ "react-dom": "^18.0.0",
1044
+ "react-scripts": "^4.0.0"
1045
+ },
1046
+ "devDependencies": {
1047
+ "@types/react": "^18.0.0",
1048
+ "@types/react-dom": "^18.0.0",
1049
+ "typescript": "^4.0.0"
1050
+ },
1051
+ "main": "/index.tsx"
1052
+ }
1022
1053
  ```
1023
1054
 
1024
1055
  ---
1025
-