@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
|
@@ -4,8 +4,8 @@ Text Links are interactive elements that, when clicked, navigate the user away f
|
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
|
|
|
8
|
-
| --- |
|
|
7
|
+
| | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
|
|
8
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
|
|
9
9
|
|
|
10
10
|
Use Text Links to navigate the user away from the page they are currently viewing to another page or screen. They can be used inline or separate from a paragraph of text. There are four Text Link sizes available—`bodyM`, `bodyS`, `bodyXs`, `bodyXxs`—each corresponding to the four sizes of body copy available in the napari hub and napari.org codebases.
|
|
11
11
|
|
|
@@ -14,7 +14,7 @@ Note: Designers, when including an inline Text Link in your design, styles must
|
|
|
14
14
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
|
|
15
15
|
|
|
16
16
|
| **bodyM** | **bodyS** | **bodyXs** | **bodyXxs** |
|
|
17
|
-
|
|
|
17
|
+
| --------- | --------- | ---------- | ----------- |
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|
|
@@ -22,26 +22,26 @@ Click on each state below to enter inspect view and get details on its code attr
|
|
|
22
22
|
|
|
23
23
|
These rules establish how much margin should exist between and around elements.
|
|
24
24
|
|
|
25
|
-
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
|
|
27
|
+
|
|
28
28
|
|
|
29
29
|
## Code
|
|
30
30
|
|
|
31
31
|
## Text Link Component
|
|
32
32
|
|
|
33
|
-
| Below you will find an interactive Storybook iframe for Text Links.
|
|
34
|
-
|
|
|
33
|
+
| Below you will find an interactive Storybook iframe for Text Links. 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:** Link |
|
|
34
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------- |
|
|
35
35
|
|
|
36
36
|
---
|
|
37
37
|
|
|
38
|
-
>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.
|
|
38
|
+
> 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.
|
|
39
39
|
|
|
40
40
|
### Link
|
|
41
41
|
|
|
42
42
|
Storybook
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
|
|
45
45
|
|
|
46
46
|
---
|
|
47
47
|
|
|
@@ -51,15 +51,15 @@ Text Links are interactive elements that, when clicked, navigate the user away f
|
|
|
51
51
|
|
|
52
52
|
## Text Link Variants
|
|
53
53
|
|
|
54
|
-
| There are two Text Link variants available for designers to use depending on the background on top of which they are placed and whether that background provides enough contrast for the Default Text Link to be seen. Text links can be used inline or separate from a paragraph of text.
|
|
55
|
-
|
|
|
54
|
+
| There are two Text Link variants available for designers to use depending on the background on top of which they are placed and whether that background provides enough contrast for the Default Text Link to be seen. Text links can be used inline or separate from a paragraph of text. Though visually similar to Minimal Buttons, Text Links navigate the user away from the page they are currently viewing to another page. This is in contrast to Minimal Buttons, which keep the user on the same page and facilitate on-screen actions such as opening Dialogs or indicating less-emphasized actions. Note: Designers, when including an inline Text Link in your design, styles must be manually applied as there is no way to save the Text Link style in Figma as a text style. You may use the Text Link Figma component for links that are not inline. Follow the usage criteria accompanying each variant as a guide for selecting the correct Text Link for any given use case. | | **Jump to variant:** Default Dashed |
|
|
55
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ----------------------------------- |
|
|
56
56
|
|
|
57
57
|
---
|
|
58
58
|
|
|
59
59
|
## Text Link
|
|
60
60
|
|
|
61
|
-
|
|
|
62
|
-
| --- |
|
|
61
|
+
| | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
|
|
62
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
|
|
63
63
|
|
|
64
64
|
### Default Text Link
|
|
65
65
|
|
|
@@ -68,9 +68,9 @@ Use the Default Text Link when the Text Link is placed on `white`, `gray100`, or
|
|
|
68
68
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
|
|
69
69
|
|
|
70
70
|
| **Default** | **Hover** | **Pressed** |
|
|
71
|
-
|
|
|
71
|
+
| ----------- | --------- | ----------- |
|
|
72
|
+
|
|
72
73
|
|
|
73
|
-
|
|
74
74
|
|
|
75
75
|
### Dashed Text Link
|
|
76
76
|
|
|
@@ -79,14 +79,14 @@ Use the Dashed Text Link when the Text Link is placed on a background where the
|
|
|
79
79
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses. See Borders section for Link Underline details.
|
|
80
80
|
|
|
81
81
|
| **Default** | **Hover** | **Pressed** |
|
|
82
|
-
|
|
|
82
|
+
| ----------- | --------- | ----------- |
|
|
83
83
|
|
|
84
84
|
### Dashed Text Link Color Examples
|
|
85
85
|
|
|
86
86
|
See below for visual examples of how the Dashed Text Link should be used in different colors depending on the color of the background it is placed upon.
|
|
87
87
|
|
|
88
88
|
| **Black Text** | **Gray500 Text** | **White Text** |
|
|
89
|
-
|
|
|
89
|
+
| -------------- | ---------------- | -------------- |
|
|
90
90
|
|
|
91
91
|
---
|
|
92
92
|
|
|
@@ -96,18 +96,18 @@ These rules establish how much margin should exist between and around elements.
|
|
|
96
96
|
|
|
97
97
|
Note: Default Text Links fall in line with the rest of the text in the paragraph it is part of. Dashed Text Links are spaced lower than a default underline text-decoration.
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
|
|
100
100
|
|
|
101
101
|
## Code
|
|
102
102
|
|
|
103
103
|
## Text Link Component
|
|
104
104
|
|
|
105
|
-
| Below you will find an interactive Storybook iframe for Text Links.
|
|
106
|
-
|
|
|
105
|
+
| Below you will find an interactive Storybook iframe for Text Links. 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:** Link |
|
|
106
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------- |
|
|
107
107
|
|
|
108
108
|
---
|
|
109
109
|
|
|
110
|
-
>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.
|
|
110
|
+
> 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.
|
|
111
111
|
|
|
112
112
|
### Link
|
|
113
113
|
|
|
@@ -121,15 +121,15 @@ Text Links are interactive elements that, when clicked, navigate the user away f
|
|
|
121
121
|
|
|
122
122
|
## Text Link Variants
|
|
123
123
|
|
|
124
|
-
| There are two Text Link variants available for designers to use depending on the background on top of which they are placed and whether that background provides enough contrast for the Default Text Link to be seen. Text links can be used inline or separate from a paragraph of text.
|
|
125
|
-
|
|
|
124
|
+
| There are two Text Link variants available for designers to use depending on the background on top of which they are placed and whether that background provides enough contrast for the Default Text Link to be seen. Text links can be used inline or separate from a paragraph of text. Though visually similar to Minimal Buttons, Text Links navigate the user away from the page they are currently viewing to another page. This is in contrast to Minimal Buttons, which keep the user on the same page and facilitate on-screen actions such as opening Dialogs or indicating less-emphasized actions. Note: Designers, when including an inline Text Link in your design, styles must be manually applied as there is no way to save the Text Link style in Figma as a text style. You may use the Text Link Figma component for links that are not inline. Follow the usage criteria accompanying each variant as a guide for selecting the correct Text Link for any given use case. | | **Jump to variant:** Default Dashed |
|
|
125
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ----------------------------------- |
|
|
126
126
|
|
|
127
127
|
---
|
|
128
128
|
|
|
129
129
|
## Text Link
|
|
130
130
|
|
|
131
|
-
|
|
|
132
|
-
| --- |
|
|
131
|
+
| | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
|
|
132
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
|
|
133
133
|
|
|
134
134
|
### Default Text Link
|
|
135
135
|
|
|
@@ -138,9 +138,9 @@ Use the Default Text Link when the Text Link is placed on `white`, `gray100`, or
|
|
|
138
138
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
|
|
139
139
|
|
|
140
140
|
| **Default** | **Hover** | **Pressed** |
|
|
141
|
-
|
|
|
141
|
+
| ----------- | --------- | ----------- |
|
|
142
|
+
|
|
142
143
|
|
|
143
|
-
|
|
144
144
|
|
|
145
145
|
### Dashed Text Link
|
|
146
146
|
|
|
@@ -149,16 +149,16 @@ Use the Dashed Text Link when the Text Link is placed on a background where the
|
|
|
149
149
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses. See Borders section for Link Underline details.
|
|
150
150
|
|
|
151
151
|
| **Default** | **Hover** | **Pressed** |
|
|
152
|
-
|
|
|
152
|
+
| ----------- | --------- | ----------- |
|
|
153
|
+
|
|
153
154
|
|
|
154
|
-
|
|
155
155
|
|
|
156
156
|
### Dashed Text Link Color Examples
|
|
157
157
|
|
|
158
158
|
See below for visual examples of how the Dashed Text Link should be used in different colors depending on the color of the background it is placed upon.
|
|
159
159
|
|
|
160
160
|
| **Black Text** | **Gray500 Text** | **White Text** |
|
|
161
|
-
|
|
|
161
|
+
| -------------- | ---------------- | -------------- |
|
|
162
162
|
|
|
163
163
|
---
|
|
164
164
|
|
|
@@ -172,8 +172,8 @@ Note: Default Text Links fall in line with the rest of the text in the paragraph
|
|
|
172
172
|
|
|
173
173
|
## Text Link Component
|
|
174
174
|
|
|
175
|
-
| Below you will find an interactive Storybook iframe for Text Links.
|
|
176
|
-
|
|
|
175
|
+
| Below you will find an interactive Storybook iframe for Text Links. 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:** Link |
|
|
176
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------- |
|
|
177
177
|
|
|
178
178
|
---
|
|
179
179
|
|
|
@@ -181,5 +181,4 @@ Note: Default Text Links fall in line with the rest of the text in the paragraph
|
|
|
181
181
|
|
|
182
182
|
Storybook
|
|
183
183
|
|
|
184
|
-
|
|
185
184
|
|
|
@@ -8,19 +8,19 @@ Themes enable visual changes to be made across the UI, affecting all elements in
|
|
|
8
8
|
|
|
9
9
|
SDS supports both Light and Dark Mode and they can be implemented to allow users to toggle between them or set either as the application's primary color mode. Every primitive color variable has a Dark Mode equivalent and each semantic color variable has a Dark Mode primitive mapped to it; for specific hex codes and primitive color mappings, see the Semantic Colors and Primitive Colors documentation.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> **Note:** the semantic color variable mappings in the Bases color set are not always one-to-one between Light and Dark Modes, see Differences in Light Mode vs Dark Mode for more details.
|
|
12
12
|
|
|
13
13
|
### Color Indexes
|
|
14
14
|
|
|
15
|
-
The color indexes used in SDS primitive color names (e.g., `gray100`, `gray200`, etc.) refer to the level of contrast of that color against the background it is viewed upon. As a result, primitive colors have a different appearance between Light and Dark Mode, but they have a consistent
|
|
15
|
+
The color indexes used in SDS primitive color names (e.g., `gray100`, `gray200`, etc.) refer to the level of contrast of that color against the background it is viewed upon. As a result, primitive colors have a different appearance between Light and Dark Mode, but they have a consistent _functional_ appearance relative to their backgrounds. This is why `gray100` in Light Mode is a light gray color, whereas `gray100` in Dark Mode is a dark gray color—both have low contrasts when viewed in relation to their corresponding background colors.
|
|
16
16
|
|
|
17
17
|
| Light Mode | Dark Mode |
|
|
18
|
-
|
|
|
18
|
+
| :--------: | :-------: |
|
|
19
19
|
|
|
20
20
|
In most cases, each semantic variable will have the same primitive value mapped to it regardless of the mode of that primitive value. For example, the semantic variable `Base.text-primary` has `gray900` mapped to it; in Light Mode `gray900` = `#000000`(black), but in Dark Mode `gray900` = `#ffffff` (white). This means that in both modes primary text is highly visible against the background it is placed on top of, whether a light background in Light Mode or a dark background in Dark Mode.
|
|
21
21
|
|
|
22
22
|
| Light Mode | Dark Mode |
|
|
23
|
-
|
|
|
23
|
+
| :--------: | :-------: |
|
|
24
24
|
|
|
25
25
|
### Differences in Light Mode vs Dark Mode
|
|
26
26
|
|
|
@@ -29,7 +29,7 @@ The only instances where the primitive variables mapped to semantic variables di
|
|
|
29
29
|
In Dark Mode, `background-primary` is `gray75` (not quite pure black which has poor visual accessibility when used across large areas) and `surface` and `fill-primary` are both `gray100` (shades of dark gray that are visible when viewed on top of `gray75` backgrounds). One of the main reasons for this is that drop shadows can't be leveraged in Dark Mode to separate layers in the same way that they can be in Light Mode since shadows are not nearly as visible when viewed on dark backgrounds.
|
|
30
30
|
|
|
31
31
|
| Light Mode | Dark Mode |
|
|
32
|
-
|
|
|
32
|
+
| :--------: | :-------: |
|
|
33
33
|
|
|
34
34
|
### Inverted Style
|
|
35
35
|
|
|
@@ -38,7 +38,7 @@ There are a few components (Header Navigation, Footer Navigation, Tooltip, and C
|
|
|
38
38
|
See the individual component pages for more details and visual examples.
|
|
39
39
|
|
|
40
40
|
| Default (Light Mode) | Inverted (Light Mode) |
|
|
41
|
-
|
|
|
41
|
+
| :------------------: | :-------------------: |
|
|
42
42
|
|
|
43
43
|
## Code
|
|
44
44
|
|
|
@@ -46,11 +46,11 @@ See the individual component pages for more details and visual examples.
|
|
|
46
46
|
|
|
47
47
|
SDS supports both Light and Dark Mode and they can be implemented to allow users to toggle between them or set either as the application's primary color mode. Every primitive color variable has a Dark Mode equivalent and each semantic color variable has a Dark Mode primitive mapped to it; for specific hex codes and primitive color mappings, see the Semantic Colors and Primitive Colors documentation.
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
> **Note:** the semantic color variable mappings in the Bases color set are not always one-to-one between Light and Dark Modes, see Differences in Light Mode vs Dark Mode for more details.
|
|
50
50
|
|
|
51
51
|
### Dark Mode by Default
|
|
52
52
|
|
|
53
|
-
You can make your application use Dark Mode as the default theme—regardless of the user's preference—by passing `'dark'` to the `Theme` helper.
|
|
53
|
+
You can make your application use Dark Mode as the default theme—regardless of the user's preference—by passing `'dark'` to the `Theme` helper.
|
|
54
54
|
|
|
55
55
|
Adding `<CssBaseline />` inside of the `<ThemeProvider>` component will also enable dark mode for the app's background.
|
|
56
56
|
|
|
@@ -79,13 +79,11 @@ h1 {
|
|
|
79
79
|
|
|
80
80
|
```json
|
|
81
81
|
{
|
|
82
|
-
"include": [
|
|
83
|
-
"./**/*"
|
|
84
|
-
],
|
|
82
|
+
"include": ["./**/*"],
|
|
85
83
|
"compilerOptions": {
|
|
86
84
|
"strict": true,
|
|
87
85
|
"esModuleInterop": true,
|
|
88
|
-
"lib": [
|
|
86
|
+
"lib": ["dom", "es2015"],
|
|
89
87
|
"jsx": "react-jsx"
|
|
90
88
|
}
|
|
91
89
|
}
|
|
@@ -100,7 +98,9 @@ import "./styles.css";
|
|
|
100
98
|
function App() {
|
|
101
99
|
return (
|
|
102
100
|
<div className="app">
|
|
103
|
-
<Button sdsType="primary" sdsStyle="square">
|
|
101
|
+
<Button sdsType="primary" sdsStyle="square">
|
|
102
|
+
Label
|
|
103
|
+
</Button>
|
|
104
104
|
</div>
|
|
105
105
|
);
|
|
106
106
|
}
|
|
@@ -126,8 +126,8 @@ const root = createRoot(container!);
|
|
|
126
126
|
root.render(
|
|
127
127
|
<React.StrictMode>
|
|
128
128
|
<StyledEngineProvider injectFirst>
|
|
129
|
-
<ThemeProvider theme={Theme(
|
|
130
|
-
<EmotionThemeProvider theme={Theme(
|
|
129
|
+
<ThemeProvider theme={Theme("dark")}>
|
|
130
|
+
<EmotionThemeProvider theme={Theme("dark")}>
|
|
131
131
|
<CssBaseline />
|
|
132
132
|
<App />
|
|
133
133
|
</EmotionThemeProvider>
|
|
@@ -135,13 +135,12 @@ root.render(
|
|
|
135
135
|
</StyledEngineProvider>
|
|
136
136
|
</React.StrictMode>
|
|
137
137
|
);
|
|
138
|
-
|
|
139
138
|
```
|
|
140
139
|
|
|
141
140
|
**/public/index.html**
|
|
142
141
|
|
|
143
142
|
```html
|
|
144
|
-
<!
|
|
143
|
+
<!doctype html>
|
|
145
144
|
<html lang="en">
|
|
146
145
|
<head>
|
|
147
146
|
<meta charset="UTF-8" />
|
|
@@ -162,13 +161,24 @@ root.render(
|
|
|
162
161
|
<div id="root"></div>
|
|
163
162
|
</body>
|
|
164
163
|
</html>
|
|
165
|
-
|
|
166
164
|
```
|
|
167
165
|
|
|
168
166
|
**/package.json**
|
|
169
167
|
|
|
170
168
|
```json
|
|
171
|
-
{
|
|
169
|
+
{
|
|
170
|
+
"dependencies": {
|
|
171
|
+
"react": "^18.0.0",
|
|
172
|
+
"react-dom": "^18.0.0",
|
|
173
|
+
"react-scripts": "^4.0.0"
|
|
174
|
+
},
|
|
175
|
+
"devDependencies": {
|
|
176
|
+
"@types/react": "^18.0.0",
|
|
177
|
+
"@types/react-dom": "^18.0.0",
|
|
178
|
+
"typescript": "^4.0.0"
|
|
179
|
+
},
|
|
180
|
+
"main": "/index.tsx"
|
|
181
|
+
}
|
|
172
182
|
```
|
|
173
183
|
|
|
174
184
|
---
|
|
@@ -206,13 +216,11 @@ h1 {
|
|
|
206
216
|
|
|
207
217
|
```json
|
|
208
218
|
{
|
|
209
|
-
"include": [
|
|
210
|
-
"./**/*"
|
|
211
|
-
],
|
|
219
|
+
"include": ["./**/*"],
|
|
212
220
|
"compilerOptions": {
|
|
213
221
|
"strict": true,
|
|
214
222
|
"esModuleInterop": true,
|
|
215
|
-
"lib": [
|
|
223
|
+
"lib": ["dom", "es2015"],
|
|
216
224
|
"jsx": "react-jsx"
|
|
217
225
|
}
|
|
218
226
|
}
|
|
@@ -227,7 +235,9 @@ import "./styles.css";
|
|
|
227
235
|
function App() {
|
|
228
236
|
return (
|
|
229
237
|
<div className="app">
|
|
230
|
-
<Button sdsType="primary" sdsStyle="square">
|
|
238
|
+
<Button sdsType="primary" sdsStyle="square">
|
|
239
|
+
Label
|
|
240
|
+
</Button>
|
|
231
241
|
</div>
|
|
232
242
|
);
|
|
233
243
|
}
|
|
@@ -273,13 +283,12 @@ root.render(
|
|
|
273
283
|
<RootApp />
|
|
274
284
|
</React.StrictMode>
|
|
275
285
|
);
|
|
276
|
-
|
|
277
286
|
```
|
|
278
287
|
|
|
279
288
|
**/public/index.html**
|
|
280
289
|
|
|
281
290
|
```html
|
|
282
|
-
<!
|
|
291
|
+
<!doctype html>
|
|
283
292
|
<html lang="en">
|
|
284
293
|
<head>
|
|
285
294
|
<meta charset="UTF-8" />
|
|
@@ -300,14 +309,24 @@ root.render(
|
|
|
300
309
|
<div id="root"></div>
|
|
301
310
|
</body>
|
|
302
311
|
</html>
|
|
303
|
-
|
|
304
312
|
```
|
|
305
313
|
|
|
306
314
|
**/package.json**
|
|
307
315
|
|
|
308
316
|
```json
|
|
309
|
-
{
|
|
317
|
+
{
|
|
318
|
+
"dependencies": {
|
|
319
|
+
"react": "^18.0.0",
|
|
320
|
+
"react-dom": "^18.0.0",
|
|
321
|
+
"react-scripts": "^4.0.0"
|
|
322
|
+
},
|
|
323
|
+
"devDependencies": {
|
|
324
|
+
"@types/react": "^18.0.0",
|
|
325
|
+
"@types/react-dom": "^18.0.0",
|
|
326
|
+
"typescript": "^4.0.0"
|
|
327
|
+
},
|
|
328
|
+
"main": "/index.tsx"
|
|
329
|
+
}
|
|
310
330
|
```
|
|
311
331
|
|
|
312
332
|
---
|
|
313
|
-
|