@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.
- package/data/component-props/Accordion.json +14 -15
- package/data/component-props/Alert.json +2 -44
- package/data/component-props/Autocomplete.json +14 -32
- package/data/component-props/Banner.json +11 -12
- package/data/component-props/Button.json +17 -82
- package/data/component-props/ButtonDropdown.json +26 -0
- package/data/component-props/ButtonIcon.json +4 -60
- package/data/component-props/ButtonToggle.json +2 -66
- package/data/component-props/Callout.json +11 -65
- package/data/component-props/CellBasic.json +28 -56
- package/data/component-props/CellComponent.json +4 -32
- package/data/component-props/CellHeader.json +13 -49
- package/data/component-props/ComplexFilter.json +24 -4
- package/data/component-props/ContentCard.json +66 -2
- package/data/component-props/Dialog.json +26 -0
- package/data/component-props/Dropdown.json +29 -67
- package/data/component-props/DropdownMenu.json +16 -56
- package/data/component-props/HeatmapChart.json +6 -87
- package/data/component-props/Icon.json +3 -8
- package/data/component-props/InputCheckbox.json +5 -53
- package/data/component-props/InputDropdown.json +11 -33
- package/data/component-props/InputRadio.json +5 -53
- package/data/component-props/InputSearch.json +6 -70
- package/data/component-props/InputSlider.json +21 -35
- package/data/component-props/InputText.json +7 -63
- package/data/component-props/InputToggle.json +5 -54
- package/data/component-props/Link.json +18 -0
- package/data/component-props/LoadingIndicator.json +1 -2
- package/data/component-props/MenuItem.json +11 -41
- package/data/component-props/MenuSelect.json +4 -67
- package/data/component-props/NavigationFooter.json +0 -8
- package/data/component-props/NavigationHeader.json +14 -65
- package/data/component-props/NavigationJumpTo.json +0 -40
- package/data/component-props/Notification.json +14 -58
- package/data/component-props/Pagination.json +8 -33
- package/data/component-props/Panel.json +4 -54
- package/data/component-props/SegmentedControl.json +0 -55
- package/data/component-props/TableRow.json +10 -38
- package/data/component-props/Tabs.json +18 -0
- package/data/component-props/Tag.json +10 -56
- package/data/component-props/TagFilter.json +0 -47
- package/data/component-props/Tooltip.json +12 -61
- package/data/component-props/TooltipCondensed.json +18 -0
- package/data/component-props/TooltipTable.json +0 -4
- package/data/zeroheight-exports/Accordion.md +167 -125
- package/data/zeroheight-exports/Banner.md +71 -48
- package/data/zeroheight-exports/Borders.md +72 -73
- package/data/zeroheight-exports/Buttons.md +375 -330
- package/data/zeroheight-exports/Callout.md +138 -116
- package/data/zeroheight-exports/Colors.md +254 -255
- package/data/zeroheight-exports/Content-Card.md +36 -37
- package/data/zeroheight-exports/Contributing-to-SDS.md +34 -35
- package/data/zeroheight-exports/Control-Inputs.md +289 -234
- package/data/zeroheight-exports/Corners.md +63 -64
- package/data/zeroheight-exports/Cover-page.md +0 -1
- package/data/zeroheight-exports/Dialog.md +237 -179
- package/data/zeroheight-exports/Downloads.md +10 -11
- package/data/zeroheight-exports/Drop-Shadows.md +40 -41
- package/data/zeroheight-exports/Dropdown-Input.md +158 -127
- package/data/zeroheight-exports/Dropdown-Menu.md +814 -718
- package/data/zeroheight-exports/Element-Status-Tracker.md +191 -192
- package/data/zeroheight-exports/Field-Inputs.md +149 -130
- package/data/zeroheight-exports/Filters.md +114 -94
- package/data/zeroheight-exports/Getting-Started.md +112 -249
- package/data/zeroheight-exports/Hero.md +43 -37
- package/data/zeroheight-exports/Icons.md +205 -206
- package/data/zeroheight-exports/Intent.md +6 -7
- package/data/zeroheight-exports/Introduction-to-Bases.md +8 -9
- package/data/zeroheight-exports/Introduction-to-Cells.md +11 -12
- package/data/zeroheight-exports/Introduction-to-DNA.md +8 -9
- package/data/zeroheight-exports/Introduction-to-Genes.md +8 -9
- package/data/zeroheight-exports/Introduction.md +52 -53
- package/data/zeroheight-exports/Link.md +50 -37
- package/data/zeroheight-exports/Lists.md +78 -63
- package/data/zeroheight-exports/Loading-Indicator.md +7 -8
- package/data/zeroheight-exports/Navigation.md +163 -142
- package/data/zeroheight-exports/Notification.md +132 -102
- package/data/zeroheight-exports/Panel.md +231 -115
- package/data/zeroheight-exports/Responsive-Design.md +35 -32
- package/data/zeroheight-exports/Search-Input.md +9 -10
- package/data/zeroheight-exports/Search.md +87 -104
- package/data/zeroheight-exports/Segmented-Control.md +68 -45
- package/data/zeroheight-exports/Spacing.md +210 -211
- package/data/zeroheight-exports/Table.md +414 -302
- package/data/zeroheight-exports/Tabs.md +126 -98
- package/data/zeroheight-exports/Tags.md +148 -118
- package/data/zeroheight-exports/Text-Link.md +32 -33
- package/data/zeroheight-exports/Theming.md +48 -29
- package/data/zeroheight-exports/Tooltips.md +253 -237
- package/data/zeroheight-exports/Typography.md +463 -464
- package/dist/stdio.js +44 -132
- package/package.json +3 -4
- package/data/component-props/Chip.json +0 -73
- package/data/component-props/List.json +0 -43
- package/data/component-props/Menu.json +0 -48
- package/data/component-props/Table.json +0 -26
- package/data/component-props-storybook/Accordion-storybook.json +0 -45
- package/data/component-props-storybook/Alert-storybook.json +0 -30
- package/data/component-props-storybook/Autocomplete-storybook.json +0 -67
- package/data/component-props-storybook/Banner-storybook.json +0 -78
- package/data/component-props-storybook/Button-storybook.json +0 -115
- package/data/component-props-storybook/ButtonDropdown-storybook.json +0 -73
- package/data/component-props-storybook/ButtonIcon-storybook.json +0 -60
- package/data/component-props-storybook/ButtonToggle-storybook.json +0 -68
- package/data/component-props-storybook/Callout-storybook.json +0 -90
- package/data/component-props-storybook/CellBasic-storybook.json +0 -138
- package/data/component-props-storybook/CellComponent-storybook.json +0 -48
- package/data/component-props-storybook/CellHeader-storybook.json +0 -71
- package/data/component-props-storybook/Chip-storybook.json +0 -26
- package/data/component-props-storybook/ComplexFilter-storybook.json +0 -60
- package/data/component-props-storybook/ContentCard-storybook.json +0 -175
- package/data/component-props-storybook/Dialog-storybook.json +0 -56
- package/data/component-props-storybook/Dropdown-storybook.json +0 -93
- package/data/component-props-storybook/DropdownMenu-storybook.json +0 -73
- package/data/component-props-storybook/HeatmapChart-storybook.json +0 -55
- package/data/component-props-storybook/Icon-storybook.json +0 -75
- package/data/component-props-storybook/InputCheckbox-storybook.json +0 -57
- package/data/component-props-storybook/InputDropdown-storybook.json +0 -80
- package/data/component-props-storybook/InputRadio-storybook.json +0 -56
- package/data/component-props-storybook/InputSearch-storybook.json +0 -55
- package/data/component-props-storybook/InputSlider-storybook.json +0 -55
- package/data/component-props-storybook/InputText-storybook.json +0 -59
- package/data/component-props-storybook/InputToggle-storybook.json +0 -42
- package/data/component-props-storybook/Link-storybook.json +0 -50
- package/data/component-props-storybook/List-storybook.json +0 -26
- package/data/component-props-storybook/LoadingIndicator-storybook.json +0 -34
- package/data/component-props-storybook/Menu-storybook.json +0 -26
- package/data/component-props-storybook/MenuItem-storybook.json +0 -74
- package/data/component-props-storybook/MenuSelect-storybook.json +0 -38
- package/data/component-props-storybook/NavigationFooter-storybook.json +0 -67
- package/data/component-props-storybook/NavigationHeader-storybook.json +0 -115
- package/data/component-props-storybook/NavigationJumpTo-storybook.json +0 -41
- package/data/component-props-storybook/Notification-storybook.json +0 -89
- package/data/component-props-storybook/Pagination-storybook.json +0 -50
- package/data/component-props-storybook/Panel-storybook.json +0 -52
- package/data/component-props-storybook/SegmentedControl-storybook.json +0 -30
- package/data/component-props-storybook/Table-storybook.json +0 -26
- package/data/component-props-storybook/TableHeader-storybook.json +0 -26
- package/data/component-props-storybook/TableRow-storybook.json +0 -62
- package/data/component-props-storybook/Tabs-storybook.json +0 -45
- package/data/component-props-storybook/Tag-storybook.json +0 -78
- package/data/component-props-storybook/TagFilter-storybook.json +0 -30
- package/data/component-props-storybook/Tooltip-storybook.json +0 -85
- package/data/component-props-storybook/TooltipCondensed-storybook.json +0 -38
- package/data/component-props-storybook/TooltipTable-storybook.json +0 -47
|
@@ -6,8 +6,8 @@ Links are interactive elements that, when clicked, navigate the user away from t
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
|
10
|
-
| --- |
|
|
9
|
+
| | In Figma | | | Meets Accessibility | | | In Code |
|
|
10
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
|
|
11
11
|
|
|
12
12
|
### Link Variants
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ Though visually similar to Button – Minimal, Links navigate the user away from
|
|
|
17
17
|
|
|
18
18
|
Links come in two sizes: fontXs and fontS to align with SDS' most common body copy font sizes.
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
> **Note:** When including an inline Link in your Figma designs, styles must be manually applied as there is no way to save the Link style in Figma as a text style. Use the Link Figma component for links that are not inline.
|
|
21
21
|
|
|
22
22
|
---
|
|
23
23
|
|
|
@@ -34,7 +34,7 @@ Default
|
|
|
34
34
|
Use Link – Default only when the Link is placed on `surface-primary`, `surface-secondary`, or `surface-tertiary` backgrounds to ensure there is enough contrast to pass visual accessibility standards, otherwise use Link – Dashed.
|
|
35
35
|
|
|
36
36
|
| Default | Hover | Pressed |
|
|
37
|
-
|
|
|
37
|
+
| ------- | ----- | ------- |
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -45,14 +45,14 @@ Use Link – Dashed when the Link is placed on a background where the Link – D
|
|
|
45
45
|
See Borders section for Link Underline details.
|
|
46
46
|
|
|
47
47
|
| Default | Hover | Pressed |
|
|
48
|
-
|
|
|
48
|
+
| ------- | ----- | ------- |
|
|
49
49
|
|
|
50
50
|
#### Color Rules
|
|
51
51
|
|
|
52
52
|
The color of Link – Dashed and its underline should match the color of the text used in the paragraph it is placed within.
|
|
53
53
|
|
|
54
54
|
| Primary Text | Secondary Text | On-fill Text |
|
|
55
|
-
|
|
|
55
|
+
| ------------ | -------------- | ------------ |
|
|
56
56
|
|
|
57
57
|
---
|
|
58
58
|
|
|
@@ -60,11 +60,11 @@ The color of Link – Dashed and its underline should match the color of the tex
|
|
|
60
60
|
|
|
61
61
|
These rules establish how much margin should exist between and around elements.
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
> **Note:** The underline for Link – Dashed is spaced lower than the default text-decoration underline.
|
|
64
64
|
|
|
65
65
|
## Code
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
> **Note:** The code examples below must install dependencies before displaying and may take extra time to load
|
|
68
68
|
|
|
69
69
|
## Link
|
|
70
70
|
|
|
@@ -74,17 +74,17 @@ The component's source code in the SDS codebase can be found here.
|
|
|
74
74
|
|
|
75
75
|
### MUI Documentation
|
|
76
76
|
|
|
77
|
-
Documentation for the underlying MUI component can be found here. There are no differences between the SDS and MUI component.
|
|
77
|
+
Documentation for the underlying MUI component can be found here. There are no differences between the SDS and MUI component.
|
|
78
78
|
|
|
79
79
|
### Props
|
|
80
80
|
|
|
81
81
|
Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
|
|
82
82
|
|
|
83
|
-
| Name
|
|
84
|
-
|
|
|
85
|
-
| `sdsStyle`
|
|
86
|
-
| `sdsSize`
|
|
87
|
-
| `fontWeight` | `"normal"`
|
|
83
|
+
| Name | Type | Default | Description |
|
|
84
|
+
| ------------ | ------------- | --------- | ----------- | --------------------------------------------------------------------------------------------------- |
|
|
85
|
+
| `sdsStyle` | `"default"` ` | "dashed"` | `"default"` | The style of underline corresponding to the `text-decoration` CSS property. Default is `underline`. |
|
|
86
|
+
| `sdsSize` | `"xs" | "s"` | `"xs"` | The font size of the `Link` component |
|
|
87
|
+
| `fontWeight` | `"normal"` ` | "bold"` | `"normal"` | The font weight of the `Link` component. |
|
|
88
88
|
|
|
89
89
|
### Code examples
|
|
90
90
|
|
|
@@ -117,13 +117,11 @@ h1 {
|
|
|
117
117
|
|
|
118
118
|
```json
|
|
119
119
|
{
|
|
120
|
-
"include": [
|
|
121
|
-
"./**/*"
|
|
122
|
-
],
|
|
120
|
+
"include": ["./**/*"],
|
|
123
121
|
"compilerOptions": {
|
|
124
122
|
"strict": true,
|
|
125
123
|
"esModuleInterop": true,
|
|
126
|
-
"lib": [
|
|
124
|
+
"lib": ["dom", "es2015"],
|
|
127
125
|
"jsx": "react-jsx"
|
|
128
126
|
}
|
|
129
127
|
}
|
|
@@ -138,9 +136,7 @@ import "./styles.css";
|
|
|
138
136
|
function App() {
|
|
139
137
|
return (
|
|
140
138
|
<div className="app">
|
|
141
|
-
<Link href="#">
|
|
142
|
-
Science Design System
|
|
143
|
-
</Link>
|
|
139
|
+
<Link href="#">Science Design System</Link>
|
|
144
140
|
</div>
|
|
145
141
|
);
|
|
146
142
|
}
|
|
@@ -185,13 +181,12 @@ root.render(
|
|
|
185
181
|
<RootApp />
|
|
186
182
|
</React.StrictMode>
|
|
187
183
|
);
|
|
188
|
-
|
|
189
184
|
```
|
|
190
185
|
|
|
191
186
|
**/public/index.html**
|
|
192
187
|
|
|
193
188
|
```html
|
|
194
|
-
<!
|
|
189
|
+
<!doctype html>
|
|
195
190
|
<html lang="en">
|
|
196
191
|
<head>
|
|
197
192
|
<meta charset="UTF-8" />
|
|
@@ -212,13 +207,24 @@ root.render(
|
|
|
212
207
|
<div id="root"></div>
|
|
213
208
|
</body>
|
|
214
209
|
</html>
|
|
215
|
-
|
|
216
210
|
```
|
|
217
211
|
|
|
218
212
|
**/package.json**
|
|
219
213
|
|
|
220
214
|
```json
|
|
221
|
-
{
|
|
215
|
+
{
|
|
216
|
+
"dependencies": {
|
|
217
|
+
"react": "^18.0.0",
|
|
218
|
+
"react-dom": "^18.0.0",
|
|
219
|
+
"react-scripts": "^4.0.0"
|
|
220
|
+
},
|
|
221
|
+
"devDependencies": {
|
|
222
|
+
"@types/react": "^18.0.0",
|
|
223
|
+
"@types/react-dom": "^18.0.0",
|
|
224
|
+
"typescript": "^4.0.0"
|
|
225
|
+
},
|
|
226
|
+
"main": "/index.tsx"
|
|
227
|
+
}
|
|
222
228
|
```
|
|
223
229
|
|
|
224
230
|
---
|
|
@@ -252,13 +258,11 @@ h1 {
|
|
|
252
258
|
|
|
253
259
|
```json
|
|
254
260
|
{
|
|
255
|
-
"include": [
|
|
256
|
-
"./**/*"
|
|
257
|
-
],
|
|
261
|
+
"include": ["./**/*"],
|
|
258
262
|
"compilerOptions": {
|
|
259
263
|
"strict": true,
|
|
260
264
|
"esModuleInterop": true,
|
|
261
|
-
"lib": [
|
|
265
|
+
"lib": ["dom", "es2015"],
|
|
262
266
|
"jsx": "react-jsx"
|
|
263
267
|
}
|
|
264
268
|
}
|
|
@@ -273,13 +277,13 @@ import "./styles.css";
|
|
|
273
277
|
|
|
274
278
|
function App() {
|
|
275
279
|
const theme = useTheme();
|
|
276
|
-
const semanticColors = getSemanticColors({theme});
|
|
277
|
-
|
|
280
|
+
const semanticColors = getSemanticColors({ theme });
|
|
281
|
+
|
|
278
282
|
const StyledParagraph = styled("p")`
|
|
279
283
|
background-color: ${semanticColors?.accent?.surfacePrimary};
|
|
280
284
|
padding: 10px;
|
|
281
285
|
`;
|
|
282
|
-
|
|
286
|
+
|
|
283
287
|
return (
|
|
284
288
|
<div className="app">
|
|
285
289
|
<StyledParagraph>
|
|
@@ -333,13 +337,12 @@ root.render(
|
|
|
333
337
|
<RootApp />
|
|
334
338
|
</React.StrictMode>
|
|
335
339
|
);
|
|
336
|
-
|
|
337
340
|
```
|
|
338
341
|
|
|
339
342
|
**/public/index.html**
|
|
340
343
|
|
|
341
344
|
```html
|
|
342
|
-
<!
|
|
345
|
+
<!doctype html>
|
|
343
346
|
<html lang="en">
|
|
344
347
|
<head>
|
|
345
348
|
<meta charset="UTF-8" />
|
|
@@ -360,14 +363,24 @@ root.render(
|
|
|
360
363
|
<div id="root"></div>
|
|
361
364
|
</body>
|
|
362
365
|
</html>
|
|
363
|
-
|
|
364
366
|
```
|
|
365
367
|
|
|
366
368
|
**/package.json**
|
|
367
369
|
|
|
368
370
|
```json
|
|
369
|
-
{
|
|
371
|
+
{
|
|
372
|
+
"dependencies": {
|
|
373
|
+
"react": "^18.0.0",
|
|
374
|
+
"react-dom": "^18.0.0",
|
|
375
|
+
"react-scripts": "^4.0.0"
|
|
376
|
+
},
|
|
377
|
+
"devDependencies": {
|
|
378
|
+
"@types/react": "^18.0.0",
|
|
379
|
+
"@types/react-dom": "^18.0.0",
|
|
380
|
+
"typescript": "^4.0.0"
|
|
381
|
+
},
|
|
382
|
+
"main": "/index.tsx"
|
|
383
|
+
}
|
|
370
384
|
```
|
|
371
385
|
|
|
372
386
|
---
|
|
373
|
-
|
|
@@ -6,29 +6,29 @@ Utilizing a list to present information makes it easier to digest or act upon wh
|
|
|
6
6
|
|
|
7
7
|
## List Variants
|
|
8
8
|
|
|
9
|
-
| There are two types of Lists—Unordered Lists where the order of content does not matter and Ordered Lists which communicate a specific sequence for the content. Use a Header with either list type to help provide context to the content presented in the list.
|
|
10
|
-
|
|
|
9
|
+
| There are two types of Lists—Unordered Lists where the order of content does not matter and Ordered Lists which communicate a specific sequence for the content. Use a Header with either list type to help provide context to the content presented in the list. Follow the usage criteria accompanying each variant as a guide for selecting the correct List for any given use case. | | **Jump to variant:** Unordered Ordered |
|
|
10
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------- |
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
14
|
## Lists
|
|
15
15
|
|
|
16
|
-
|
|
|
17
|
-
| --- |
|
|
16
|
+
| | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
|
|
17
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
|
|
18
18
|
|
|
19
19
|
### Unordered List
|
|
20
20
|
|
|
21
21
|
Use when the order of the list's content does not matter.
|
|
22
22
|
|
|
23
23
|
| **bodyM** | **bodyS** | **bodyXs** | **bodyXxs** |
|
|
24
|
-
|
|
|
24
|
+
| --------- | --------- | ---------- | ----------- |
|
|
25
25
|
|
|
26
26
|
### Ordered List
|
|
27
27
|
|
|
28
28
|
Use when the list's content needs to be presented in a specific order or sequence.
|
|
29
29
|
|
|
30
30
|
| **bodyM** | **bodyS** | **bodyXs** | **bodyXxs** |
|
|
31
|
-
|
|
|
31
|
+
| --------- | --------- | ---------- | ----------- |
|
|
32
32
|
|
|
33
33
|
---
|
|
34
34
|
|
|
@@ -37,7 +37,7 @@ Use when the list's content needs to be presented in a specific order or sequenc
|
|
|
37
37
|
Spacing between List Items changes based on the font mixin size used. See the table below for spacing reference.
|
|
38
38
|
|
|
39
39
|
| **bodyM** | **bodyS** | **bodyXs** | **bodyXxs** |
|
|
40
|
-
|
|
|
40
|
+
| --------- | --------- | ---------- | ----------- |
|
|
41
41
|
|
|
42
42
|
---
|
|
43
43
|
|
|
@@ -45,12 +45,12 @@ Spacing between List Items changes based on the font mixin size used. See the ta
|
|
|
45
45
|
|
|
46
46
|
## List Component
|
|
47
47
|
|
|
48
|
-
| Below you will find an interactive Storybook iframe for Lists.
|
|
49
|
-
|
|
|
48
|
+
| Below you will find an interactive Storybook iframe for Lists. 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:** List |
|
|
49
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------- |
|
|
50
50
|
|
|
51
51
|
---
|
|
52
52
|
|
|
53
|
-
>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.
|
|
53
|
+
> 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.
|
|
54
54
|
|
|
55
55
|
### List
|
|
56
56
|
|
|
@@ -64,31 +64,31 @@ Utilizing a list to present information makes it easier to digest or act upon wh
|
|
|
64
64
|
|
|
65
65
|
## List Variants
|
|
66
66
|
|
|
67
|
-
| There are two types of Lists—Unordered Lists where the order of content does not matter and Ordered Lists which communicate a specific sequence for the content. Use a Header with either list type to help provide context to the content presented in the list.
|
|
68
|
-
|
|
|
67
|
+
| There are two types of Lists—Unordered Lists where the order of content does not matter and Ordered Lists which communicate a specific sequence for the content. Use a Header with either list type to help provide context to the content presented in the list. Follow the usage criteria accompanying each variant as a guide for selecting the correct List for any given use case. | | **Jump to variant:** Unordered Ordered |
|
|
68
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------- |
|
|
69
69
|
|
|
70
70
|
---
|
|
71
71
|
|
|
72
72
|
## Lists
|
|
73
73
|
|
|
74
|
-
|
|
|
75
|
-
| --- |
|
|
74
|
+
| | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
|
|
75
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
|
|
76
76
|
|
|
77
77
|
### Unordered List
|
|
78
78
|
|
|
79
79
|
Use when the order of the list's content does not matter.
|
|
80
80
|
|
|
81
81
|
| **fontBodyL** | **fontBodyM** | **fontBodyS** | **fontBodyXs** | **fontBodyXxs** | **fontBodyXxxs** |
|
|
82
|
-
|
|
|
82
|
+
| ------------- | ------------- | ------------- | -------------- | --------------- | ---------------- |
|
|
83
|
+
|
|
83
84
|
|
|
84
|
-
|
|
85
85
|
|
|
86
86
|
### Ordered List
|
|
87
87
|
|
|
88
88
|
Use when the list's content needs to be presented in a specific order or sequence.
|
|
89
89
|
|
|
90
90
|
| **fontBodyL** | **fontBodyM** | **fontBodyS** | **fontBodyXs** | **fontBodyXxs** | **fontBodyXxxs** |
|
|
91
|
-
|
|
|
91
|
+
| ------------- | ------------- | ------------- | -------------- | --------------- | ---------------- |
|
|
92
92
|
|
|
93
93
|
---
|
|
94
94
|
|
|
@@ -97,7 +97,7 @@ Use when the list's content needs to be presented in a specific order or sequenc
|
|
|
97
97
|
Spacing between List Items changes based on the font mixin size used. See the table below for spacing reference.
|
|
98
98
|
|
|
99
99
|
| **fontBodyL** | **fontBodyM** | **fontBodyS** | **fontBodyXs** | **fontBodyXxs** | **fontBodyXxxs** |
|
|
100
|
-
|
|
|
100
|
+
| ------------- | ------------- | ------------- | -------------- | --------------- | ---------------- |
|
|
101
101
|
|
|
102
102
|
---
|
|
103
103
|
|
|
@@ -105,12 +105,12 @@ Spacing between List Items changes based on the font mixin size used. See the ta
|
|
|
105
105
|
|
|
106
106
|
## List Component
|
|
107
107
|
|
|
108
|
-
| Below you will find an interactive Storybook iframe for Lists.
|
|
109
|
-
|
|
|
108
|
+
| Below you will find an interactive Storybook iframe for Lists. 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:** List |
|
|
109
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------- |
|
|
110
110
|
|
|
111
111
|
---
|
|
112
112
|
|
|
113
|
-
>This component appears as it is in the default SDS codebase. Once imported into the CZ GEN EPI codebase, use a theme file to enable the CZ GEN EPI visual appearance customization.
|
|
113
|
+
> This component appears as it is in the default SDS codebase. Once imported into the CZ GEN EPI codebase, use a theme file to enable the CZ GEN EPI visual appearance customization.
|
|
114
114
|
|
|
115
115
|
### List
|
|
116
116
|
|
|
@@ -124,31 +124,31 @@ Utilizing a list to present information makes it easier to digest or act upon wh
|
|
|
124
124
|
|
|
125
125
|
## List Variants
|
|
126
126
|
|
|
127
|
-
| There are two types of Lists—Unordered Lists where the order of content does not matter and Ordered Lists which communicate a specific sequence for the content. Use a Header with either list type to help provide context to the content presented in the list.
|
|
128
|
-
|
|
|
127
|
+
| There are two types of Lists—Unordered Lists where the order of content does not matter and Ordered Lists which communicate a specific sequence for the content. Use a Header with either list type to help provide context to the content presented in the list. Follow the usage criteria accompanying each variant as a guide for selecting the correct List for any given use case. | | **Jump to variant:** Unordered Ordered |
|
|
128
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------- |
|
|
129
129
|
|
|
130
130
|
---
|
|
131
131
|
|
|
132
132
|
## Lists
|
|
133
133
|
|
|
134
|
-
|
|
|
135
|
-
| --- |
|
|
134
|
+
| | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
|
|
135
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
|
|
136
136
|
|
|
137
137
|
### Unordered List
|
|
138
138
|
|
|
139
139
|
Use when the order of the list's content does not matter.
|
|
140
140
|
|
|
141
141
|
| **fontBodyL** | **fontBodyM** | **fontBodyS** | **fontBodyXs** | **fontBodyXxs** | **fontBodyXxxs** |
|
|
142
|
-
|
|
|
142
|
+
| ------------- | ------------- | ------------- | -------------- | --------------- | ---------------- |
|
|
143
|
+
|
|
143
144
|
|
|
144
|
-
|
|
145
145
|
|
|
146
146
|
### Ordered List
|
|
147
147
|
|
|
148
148
|
Use when the list's content needs to be presented in a specific order or sequence.
|
|
149
149
|
|
|
150
150
|
| **fontBodyL** | **fontBodyM** | **fontBodyS** | **fontBodyXs** | **fontBodyXxs** | **fontBodyXxxs** |
|
|
151
|
-
|
|
|
151
|
+
| ------------- | ------------- | ------------- | -------------- | --------------- | ---------------- |
|
|
152
152
|
|
|
153
153
|
---
|
|
154
154
|
|
|
@@ -157,7 +157,7 @@ Use when the list's content needs to be presented in a specific order or sequenc
|
|
|
157
157
|
Spacing between List Items changes based on the font mixin size used. See the table below for spacing reference.
|
|
158
158
|
|
|
159
159
|
| **fontBodyL** | **fontBodyM** | **fontBodyS** | **fontBodyXs** | **fontBodyXxs** | **fontBodyXxxs** |
|
|
160
|
-
|
|
|
160
|
+
| ------------- | ------------- | ------------- | -------------- | --------------- | ---------------- |
|
|
161
161
|
|
|
162
162
|
---
|
|
163
163
|
|
|
@@ -165,8 +165,8 @@ Spacing between List Items changes based on the font mixin size used. See the ta
|
|
|
165
165
|
|
|
166
166
|
## List Component
|
|
167
167
|
|
|
168
|
-
| Below you will find an interactive Storybook iframe for Lists.
|
|
169
|
-
|
|
|
168
|
+
| Below you will find an interactive Storybook iframe for Lists. 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:** List |
|
|
169
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------- |
|
|
170
170
|
|
|
171
171
|
---
|
|
172
172
|
|
|
@@ -182,8 +182,8 @@ Utilizing a list to present information makes it easier to digest or act upon wh
|
|
|
182
182
|
|
|
183
183
|
## Overview
|
|
184
184
|
|
|
185
|
-
|
|
|
186
|
-
| --- |
|
|
185
|
+
| | In Figma | | | Meets Accessibility | | | In Code |
|
|
186
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
|
|
187
187
|
|
|
188
188
|
### List Variants
|
|
189
189
|
|
|
@@ -204,7 +204,7 @@ Default
|
|
|
204
204
|
Use when the list's content needs to be presented in a specific order or sequence.
|
|
205
205
|
|
|
206
206
|
| fontBodyL | fontBodyM | fontBodyS | fontBodyXs | fontBodyXxs | fontBodyXxxs |
|
|
207
|
-
|
|
|
207
|
+
| --------- | --------- | --------- | ---------- | ----------- | ------------ |
|
|
208
208
|
|
|
209
209
|
---
|
|
210
210
|
|
|
@@ -213,7 +213,7 @@ Use when the list's content needs to be presented in a specific order or sequenc
|
|
|
213
213
|
Use when the order of the list's content does not matter.
|
|
214
214
|
|
|
215
215
|
| fontBodyL | fontBodyM | fontBodyS | fontBodyXs | fontBodyXxs | fontBodyXxxs |
|
|
216
|
-
|
|
|
216
|
+
| --------- | --------- | --------- | ---------- | ----------- | ------------ |
|
|
217
217
|
|
|
218
218
|
---
|
|
219
219
|
|
|
@@ -222,11 +222,11 @@ Use when the order of the list's content does not matter.
|
|
|
222
222
|
Spacing between List Items changes based on the font size used. See the table below for spacing reference.
|
|
223
223
|
|
|
224
224
|
| fontBodyL | fontBodyM | fontBodyS | fontBodyXs | fontBodyXxs | fontBodyXxxs |
|
|
225
|
-
|
|
|
225
|
+
| --------- | --------- | --------- | ---------- | ----------- | ------------ |
|
|
226
226
|
|
|
227
227
|
## Code
|
|
228
228
|
|
|
229
|
-
|
|
229
|
+
> **Note:** The code examples below must install dependencies before displaying and may take extra time to load
|
|
230
230
|
|
|
231
231
|
## List
|
|
232
232
|
|
|
@@ -238,10 +238,10 @@ The component's source code in the SDS codebase can be found here.
|
|
|
238
238
|
|
|
239
239
|
Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
|
|
240
240
|
|
|
241
|
-
| Name
|
|
242
|
-
|
|
|
243
|
-
| `marginBottom` | `"xxxs"`
|
|
244
|
-
| `ordered`
|
|
241
|
+
| Name | Type | Default | Description |
|
|
242
|
+
| -------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ---- | ----- | -------------------------------------------------------------------------------------------- |
|
|
243
|
+
| `marginBottom` | `"xxxs"` ` | "xxs"` ` | "xs"` ` | "s"` ` | "m"` ` | "l"` | `"s"` | Determines the bottom margin size for the list, controlling its spacing from other elements. |
|
|
244
|
+
| `ordered` | `boolean` | `false` | Specifies the type of list component to render. When set to `true`, the list will be an ordered `"ol"` tag, while `false` will render an unordered `"ul"` tag. |
|
|
245
245
|
|
|
246
246
|
## ListItem
|
|
247
247
|
|
|
@@ -253,11 +253,11 @@ The component's source code in the SDS codebase can be found here.
|
|
|
253
253
|
|
|
254
254
|
Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
|
|
255
255
|
|
|
256
|
-
| Name
|
|
257
|
-
|
|
|
258
|
-
| `fontSize`
|
|
259
|
-
| `marginBottom` | `"s"`
|
|
260
|
-
| `ordered`
|
|
256
|
+
| Name | Type | Default | Description |
|
|
257
|
+
| -------------- | ---------- | -------- | ---------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------- | ---- | ----- | ------------------------------------------------------------------- |
|
|
258
|
+
| `fontSize` | `"xxxs"` ` | "xxs"` ` | "xs"` ` | "s"` ` | "m"` ` | "l"` | `"s"` | Sets the font size for the list items, influencing their text size. |
|
|
259
|
+
| `marginBottom` | `"s"` ` | "xs"` ` | "xxs"` | `"xs"` | Controls the bottom margin size for the list items, affecting the spacing between list items. |
|
|
260
|
+
| `ordered` | `boolean` | `false` | Specifies the style and spacings of the list item components based on the parent list element. |
|
|
261
261
|
|
|
262
262
|
### Code examples
|
|
263
263
|
|
|
@@ -290,13 +290,11 @@ h1 {
|
|
|
290
290
|
|
|
291
291
|
```json
|
|
292
292
|
{
|
|
293
|
-
"include": [
|
|
294
|
-
"./**/*"
|
|
295
|
-
],
|
|
293
|
+
"include": ["./**/*"],
|
|
296
294
|
"compilerOptions": {
|
|
297
295
|
"strict": true,
|
|
298
296
|
"esModuleInterop": true,
|
|
299
|
-
"lib": [
|
|
297
|
+
"lib": ["dom", "es2015"],
|
|
300
298
|
"jsx": "react-jsx"
|
|
301
299
|
}
|
|
302
300
|
}
|
|
@@ -375,13 +373,12 @@ root.render(
|
|
|
375
373
|
<RootApp />
|
|
376
374
|
</React.StrictMode>
|
|
377
375
|
);
|
|
378
|
-
|
|
379
376
|
```
|
|
380
377
|
|
|
381
378
|
**/public/index.html**
|
|
382
379
|
|
|
383
380
|
```html
|
|
384
|
-
<!
|
|
381
|
+
<!doctype html>
|
|
385
382
|
<html lang="en">
|
|
386
383
|
<head>
|
|
387
384
|
<meta charset="UTF-8" />
|
|
@@ -402,13 +399,24 @@ root.render(
|
|
|
402
399
|
<div id="root"></div>
|
|
403
400
|
</body>
|
|
404
401
|
</html>
|
|
405
|
-
|
|
406
402
|
```
|
|
407
403
|
|
|
408
404
|
**/package.json**
|
|
409
405
|
|
|
410
406
|
```json
|
|
411
|
-
{
|
|
407
|
+
{
|
|
408
|
+
"dependencies": {
|
|
409
|
+
"react": "^18.0.0",
|
|
410
|
+
"react-dom": "^18.0.0",
|
|
411
|
+
"react-scripts": "^4.0.0"
|
|
412
|
+
},
|
|
413
|
+
"devDependencies": {
|
|
414
|
+
"@types/react": "^18.0.0",
|
|
415
|
+
"@types/react-dom": "^18.0.0",
|
|
416
|
+
"typescript": "^4.0.0"
|
|
417
|
+
},
|
|
418
|
+
"main": "/index.tsx"
|
|
419
|
+
}
|
|
412
420
|
```
|
|
413
421
|
|
|
414
422
|
---
|
|
@@ -442,13 +450,11 @@ h1 {
|
|
|
442
450
|
|
|
443
451
|
```json
|
|
444
452
|
{
|
|
445
|
-
"include": [
|
|
446
|
-
"./**/*"
|
|
447
|
-
],
|
|
453
|
+
"include": ["./**/*"],
|
|
448
454
|
"compilerOptions": {
|
|
449
455
|
"strict": true,
|
|
450
456
|
"esModuleInterop": true,
|
|
451
|
-
"lib": [
|
|
457
|
+
"lib": ["dom", "es2015"],
|
|
452
458
|
"jsx": "react-jsx"
|
|
453
459
|
}
|
|
454
460
|
}
|
|
@@ -577,13 +583,12 @@ root.render(
|
|
|
577
583
|
<RootApp />
|
|
578
584
|
</React.StrictMode>
|
|
579
585
|
);
|
|
580
|
-
|
|
581
586
|
```
|
|
582
587
|
|
|
583
588
|
**/public/index.html**
|
|
584
589
|
|
|
585
590
|
```html
|
|
586
|
-
<!
|
|
591
|
+
<!doctype html>
|
|
587
592
|
<html lang="en">
|
|
588
593
|
<head>
|
|
589
594
|
<meta charset="UTF-8" />
|
|
@@ -604,14 +609,24 @@ root.render(
|
|
|
604
609
|
<div id="root"></div>
|
|
605
610
|
</body>
|
|
606
611
|
</html>
|
|
607
|
-
|
|
608
612
|
```
|
|
609
613
|
|
|
610
614
|
**/package.json**
|
|
611
615
|
|
|
612
616
|
```json
|
|
613
|
-
{
|
|
617
|
+
{
|
|
618
|
+
"dependencies": {
|
|
619
|
+
"react": "^18.0.0",
|
|
620
|
+
"react-dom": "^18.0.0",
|
|
621
|
+
"react-scripts": "^4.0.0"
|
|
622
|
+
},
|
|
623
|
+
"devDependencies": {
|
|
624
|
+
"@types/react": "^18.0.0",
|
|
625
|
+
"@types/react-dom": "^18.0.0",
|
|
626
|
+
"typescript": "^4.0.0"
|
|
627
|
+
},
|
|
628
|
+
"main": "/index.tsx"
|
|
629
|
+
}
|
|
614
630
|
```
|
|
615
631
|
|
|
616
632
|
---
|
|
617
|
-
|
|
@@ -4,10 +4,10 @@ Loading Indicators provide feedback to users that an action is still completing,
|
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
|
|
|
8
|
-
| --- |
|
|
7
|
+
| | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
|
|
8
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
|
|
9
9
|
|
|
10
|
-
Used in napari hub and napari.org to indicate when on-page components are loading. The Loading Indicator features a looping animation to signal to the user that an action is happening and to wait while it completes.
|
|
10
|
+
Used in napari hub and napari.org to indicate when on-page components are loading. The Loading Indicator features a looping animation to signal to the user that an action is happening and to wait while it completes.
|
|
11
11
|
|
|
12
12
|
Note: icon spins.
|
|
13
13
|
|
|
@@ -17,22 +17,21 @@ Note: icon spins.
|
|
|
17
17
|
|
|
18
18
|
These rules establish how much margin should exist between and around elements.
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
|
|
21
21
|
|
|
22
22
|
## Code
|
|
23
23
|
|
|
24
24
|
## Loading Indicator Component
|
|
25
25
|
|
|
26
|
-
| Below you will find an interactive Storybook iframe for the Loading Indicator.
|
|
27
|
-
|
|
|
26
|
+
| Below you will find an interactive Storybook iframe for the Loading Indicator. 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:** LoadingIndicator |
|
|
27
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------------------- |
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
>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.
|
|
31
|
+
> 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.
|
|
32
32
|
|
|
33
33
|
### LoadingIndicator
|
|
34
34
|
|
|
35
35
|
Storybook
|
|
36
36
|
|
|
37
|
-
|
|
38
37
|
|