@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,15 +6,15 @@ Tooltips are used throughout the UI and appear whenever users hover over element
|
|
|
6
6
|
|
|
7
7
|
## Tooltip Variants
|
|
8
8
|
|
|
9
|
-
| Tooltips are always used in conjunction with other elements when there is a need to clarify the element's function further, provide instructions, or display additional details to the user. The variant used depends on the element it is tied to and the area in the UI in which it is located.
|
|
10
|
-
|
|
|
9
|
+
| Tooltips are always used in conjunction with other elements when there is a need to clarify the element's function further, provide instructions, or display additional details to the user. The variant used depends on the element it is tied to and the area in the UI in which it is located. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tooltip for any given use case. | | **Jump to variant:** Tooltip Condensed |
|
|
10
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------- |
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
14
|
## Tooltip
|
|
15
15
|
|
|
16
|
-
|
|
|
17
|
-
| --- |
|
|
16
|
+
| | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
|
|
17
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
|
|
18
18
|
|
|
19
19
|
Use to display supplementary information such as definitions, instructions, or expanded details for elements, such as in combination with Tags to provide definitions of the parameter on the Tag.
|
|
20
20
|
|
|
@@ -49,23 +49,23 @@ The `placement` prop indicates from which direction the Tooltip will appear on h
|
|
|
49
49
|
The Tooltip is positioned relative to the on-screen element as opposed to relative to the user's cursor.
|
|
50
50
|
|
|
51
51
|
| **Bottom-start** | **Bottom** | **Bottom-End** |
|
|
52
|
-
|
|
|
52
|
+
| ---------------- | ---------- | -------------- |
|
|
53
53
|
|
|
54
54
|
| **Left-start** | **Left** | **Left-end** |
|
|
55
|
-
|
|
|
55
|
+
| -------------- | -------- | ------------ |
|
|
56
56
|
|
|
57
57
|
| **Right-start** | **Right** | **Right-end** |
|
|
58
|
-
|
|
|
58
|
+
| --------------- | --------- | ------------- |
|
|
59
59
|
|
|
60
60
|
| **Top-Start** | **Top** | **Top-end** |
|
|
61
|
-
|
|
|
61
|
+
| ------------- | ------- | ----------- |
|
|
62
62
|
|
|
63
63
|
---
|
|
64
64
|
|
|
65
65
|
## Condensed Tooltip
|
|
66
66
|
|
|
67
|
-
|
|
|
68
|
-
| --- |
|
|
67
|
+
| | In Figma | | | Meets Accessibility | | | In napari hub + .org Codebases |
|
|
68
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------------------------------ |
|
|
69
69
|
|
|
70
70
|
Use to display smaller bits of text, not full sentences or descriptions, similar to a label, but only viewable on hover. Most often used in Charts, Tables, and Data Visualizations (documentation coming soon).
|
|
71
71
|
|
|
@@ -87,12 +87,12 @@ These rules establish how much margin should exist between and around elements.
|
|
|
87
87
|
|
|
88
88
|
## Dropdown Input Component
|
|
89
89
|
|
|
90
|
-
| Below you will find an interactive Storybook iframe for Tooltips.
|
|
91
|
-
|
|
|
90
|
+
| Below you will find an interactive Storybook iframe for Tooltips. 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:** Tooltip TooltipCondensed |
|
|
91
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------------------- |
|
|
92
92
|
|
|
93
93
|
---
|
|
94
94
|
|
|
95
|
-
>These components appear as they are in the default SDS codebase. Once imported into the napari hub or napari.org codebases, use a theme file to enable the napari visual appearance customization.
|
|
95
|
+
> These components appear as they are in the default SDS codebase. Once imported into the napari hub or napari.org codebases, use a theme file to enable the napari visual appearance customization.
|
|
96
96
|
|
|
97
97
|
### Tooltip
|
|
98
98
|
|
|
@@ -112,8 +112,8 @@ Tooltips are used throughout the UI and appear whenever users hover over element
|
|
|
112
112
|
|
|
113
113
|
## Tooltip Variants
|
|
114
114
|
|
|
115
|
-
| Tooltips are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element it is tied to and the area in the UI in which it is located.
|
|
116
|
-
|
|
|
115
|
+
| Tooltips are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element it is tied to and the area in the UI in which it is located. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tooltip for any given use case. | | **Jump to variant:** Dark Light Condensed Table |
|
|
116
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------------------- |
|
|
117
117
|
|
|
118
118
|
### Visual Preview
|
|
119
119
|
|
|
@@ -123,8 +123,8 @@ Use the links below to jump to information on a specific Tooltip variant:
|
|
|
123
123
|
|
|
124
124
|
## Tooltip
|
|
125
125
|
|
|
126
|
-
|
|
|
127
|
-
| --- |
|
|
126
|
+
| | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
|
|
127
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
|
|
128
128
|
|
|
129
129
|
### Dark Tooltip
|
|
130
130
|
|
|
@@ -140,9 +140,9 @@ Click on each state below to enter inspect view and get details on its code attr
|
|
|
140
140
|
|
|
141
141
|
---
|
|
142
142
|
|
|
143
|
-
|
|
144
143
|
|
|
145
|
-
|
|
144
|
+
|
|
145
|
+
|
|
146
146
|
|
|
147
147
|
### Light Tooltip
|
|
148
148
|
|
|
@@ -154,7 +154,7 @@ The Tooltip is positioned relative to the on-screen element as opposed to relati
|
|
|
154
154
|
|
|
155
155
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
|
|
156
156
|
|
|
157
|
-
|
|
157
|
+
|
|
158
158
|
|
|
159
159
|
---
|
|
160
160
|
|
|
@@ -173,23 +173,23 @@ The `placement` prop indicates from which direction the Tooltip will appear on h
|
|
|
173
173
|
The Tooltip is positioned relative to the on-screen element as opposed to relative to the user's cursor.
|
|
174
174
|
|
|
175
175
|
| **Bottom-start** | **Bottom** | **Bottom-End** |
|
|
176
|
-
|
|
|
176
|
+
| ---------------- | ---------- | -------------- |
|
|
177
177
|
|
|
178
178
|
| **Left-start** | **Left** | **Left-end** |
|
|
179
|
-
|
|
|
179
|
+
| -------------- | -------- | ------------ |
|
|
180
180
|
|
|
181
181
|
| **Right-start** | **Right** | **Right-end** |
|
|
182
|
-
|
|
|
182
|
+
| --------------- | --------- | ------------- |
|
|
183
183
|
|
|
184
184
|
| **Top-Start** | **Top** | **Top-end** |
|
|
185
|
-
|
|
|
185
|
+
| ------------- | ------- | ----------- |
|
|
186
186
|
|
|
187
187
|
---
|
|
188
188
|
|
|
189
189
|
## Condensed Tooltip
|
|
190
190
|
|
|
191
|
-
|
|
|
192
|
-
| --- |
|
|
191
|
+
| | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
|
|
192
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
|
|
193
193
|
|
|
194
194
|
Use to display smaller bits of text, not full sentences or descriptions, similar to a label, but only viewable on hover. Most often used in Charts, Tables, and Data Visualizations.
|
|
195
195
|
|
|
@@ -203,7 +203,7 @@ Click on each state below to enter inspect view and get details on its code attr
|
|
|
203
203
|
|
|
204
204
|
---
|
|
205
205
|
|
|
206
|
-
|
|
206
|
+
|
|
207
207
|
|
|
208
208
|
---
|
|
209
209
|
|
|
@@ -215,8 +215,8 @@ These rules establish how much margin should exist between and around elements.
|
|
|
215
215
|
|
|
216
216
|
## Table Tooltip
|
|
217
217
|
|
|
218
|
-
|
|
|
219
|
-
| --- |
|
|
218
|
+
| | In Figma | | | Meets Accessibility | | | In CZ GEN EPI Codebase |
|
|
219
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ---------------------- |
|
|
220
220
|
|
|
221
221
|
Used in CZ GEN EPI to display complex, dense information that would benefit from being shown in a table format such as additional data or context connected to datasets in Charts, Tables, and Data Visualizations.
|
|
222
222
|
|
|
@@ -242,56 +242,56 @@ Use the following configuration for the `[array]` passed into the `data` prop:
|
|
|
242
242
|
data = [
|
|
243
243
|
{
|
|
244
244
|
// section with a header
|
|
245
|
-
dataRows: [
|
|
245
|
+
dataRows: [
|
|
246
246
|
{
|
|
247
|
-
label: "Label",
|
|
247
|
+
label: "Label",
|
|
248
248
|
value: "Item",
|
|
249
|
-
},
|
|
249
|
+
},
|
|
250
250
|
{
|
|
251
|
-
label: "Label",
|
|
251
|
+
label: "Label",
|
|
252
252
|
value: "Item",
|
|
253
|
-
},
|
|
253
|
+
},
|
|
254
254
|
{
|
|
255
|
-
label: "Label",
|
|
255
|
+
label: "Label",
|
|
256
256
|
value: "Item",
|
|
257
|
-
}
|
|
257
|
+
},
|
|
258
258
|
],
|
|
259
259
|
label: "Section One", // optional
|
|
260
260
|
},
|
|
261
261
|
{
|
|
262
262
|
// section with no header
|
|
263
|
-
dataRows: [
|
|
263
|
+
dataRows: [
|
|
264
264
|
{
|
|
265
|
-
label: "Label",
|
|
265
|
+
label: "Label",
|
|
266
266
|
value: "Item",
|
|
267
|
-
},
|
|
267
|
+
},
|
|
268
268
|
{
|
|
269
|
-
label: "Label",
|
|
269
|
+
label: "Label",
|
|
270
270
|
value: "Item",
|
|
271
|
-
},
|
|
271
|
+
},
|
|
272
272
|
{
|
|
273
|
-
label: "Label",
|
|
273
|
+
label: "Label",
|
|
274
274
|
value: "Item",
|
|
275
|
-
}
|
|
276
|
-
],
|
|
275
|
+
},
|
|
276
|
+
],
|
|
277
277
|
},
|
|
278
|
-
|
|
278
|
+
{
|
|
279
279
|
// disabled section with no header
|
|
280
|
-
dataRows: [
|
|
280
|
+
dataRows: [
|
|
281
281
|
{
|
|
282
|
-
label: "Label",
|
|
282
|
+
label: "Label",
|
|
283
283
|
value: "Item",
|
|
284
|
-
},
|
|
284
|
+
},
|
|
285
285
|
{
|
|
286
|
-
label: "Label",
|
|
286
|
+
label: "Label",
|
|
287
287
|
value: "Item",
|
|
288
|
-
},
|
|
288
|
+
},
|
|
289
289
|
{
|
|
290
|
-
label: "Label",
|
|
290
|
+
label: "Label",
|
|
291
291
|
value: "Item",
|
|
292
|
-
}
|
|
293
|
-
],
|
|
294
|
-
|
|
292
|
+
},
|
|
293
|
+
],
|
|
294
|
+
disabled: true,
|
|
295
295
|
},
|
|
296
296
|
];
|
|
297
297
|
```
|
|
@@ -306,12 +306,12 @@ These rules establish how much margin should exist between and around elements.
|
|
|
306
306
|
|
|
307
307
|
## Dropdown Input Component
|
|
308
308
|
|
|
309
|
-
| Below you will find an interactive Storybook iframe for Tooltips.
|
|
310
|
-
|
|
|
309
|
+
| Below you will find an interactive Storybook iframe for Tooltips. 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:** Tooltip TooltipCondensed TooltipTable |
|
|
310
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------ |
|
|
311
311
|
|
|
312
312
|
---
|
|
313
313
|
|
|
314
|
-
>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.
|
|
314
|
+
> 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.
|
|
315
315
|
|
|
316
316
|
### Tooltip
|
|
317
317
|
|
|
@@ -337,8 +337,8 @@ Tooltips are used throughout the UI and appear whenever users hover over element
|
|
|
337
337
|
|
|
338
338
|
## Tooltip Variants
|
|
339
339
|
|
|
340
|
-
| Tooltips are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element it is tied to and the area in the UI in which it is located.
|
|
341
|
-
|
|
|
340
|
+
| Tooltips are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element it is tied to and the area in the UI in which it is located. Follow the usage criteria accompanying each variant as a guide for selecting the correct Tooltip for any given use case. | | **Jump to variant:** Dark Light Condensed Table |
|
|
341
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------------------------------------------- |
|
|
342
342
|
|
|
343
343
|
### Visual Preview
|
|
344
344
|
|
|
@@ -348,8 +348,8 @@ Use the links below to jump to information on a specific Tooltip variant:
|
|
|
348
348
|
|
|
349
349
|
## Tooltip
|
|
350
350
|
|
|
351
|
-
|
|
|
352
|
-
| --- |
|
|
351
|
+
| | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
|
|
352
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
|
|
353
353
|
|
|
354
354
|
### Dark Tooltip
|
|
355
355
|
|
|
@@ -363,11 +363,11 @@ The Tooltip is positioned relative to the on-screen element as opposed to relati
|
|
|
363
363
|
|
|
364
364
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
|
|
365
365
|
|
|
366
|
-
|
|
366
|
+
|
|
367
367
|
|
|
368
368
|
---
|
|
369
369
|
|
|
370
|
-
|
|
370
|
+
|
|
371
371
|
|
|
372
372
|
### Light Tooltip
|
|
373
373
|
|
|
@@ -379,7 +379,7 @@ The Tooltip is positioned relative to the on-screen element as opposed to relati
|
|
|
379
379
|
|
|
380
380
|
Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
|
|
381
381
|
|
|
382
|
-
|
|
382
|
+
|
|
383
383
|
|
|
384
384
|
---
|
|
385
385
|
|
|
@@ -398,23 +398,23 @@ The `placement` prop indicates from which direction the Tooltip will appear on h
|
|
|
398
398
|
The Tooltip is positioned relative to the on-screen element as opposed to relative to the user's cursor.
|
|
399
399
|
|
|
400
400
|
| **Bottom-start** | **Bottom** | **Bottom-End** |
|
|
401
|
-
|
|
|
401
|
+
| ---------------- | ---------- | -------------- |
|
|
402
402
|
|
|
403
403
|
| **Left-start** | **Left** | **Left-end** |
|
|
404
|
-
|
|
|
404
|
+
| -------------- | -------- | ------------ |
|
|
405
405
|
|
|
406
406
|
| **Right-start** | **Right** | **Right-end** |
|
|
407
|
-
|
|
|
407
|
+
| --------------- | --------- | ------------- |
|
|
408
408
|
|
|
409
409
|
| **Top-Start** | **Top** | **Top-end** |
|
|
410
|
-
|
|
|
410
|
+
| ------------- | ------- | ----------- |
|
|
411
411
|
|
|
412
412
|
---
|
|
413
413
|
|
|
414
414
|
## Condensed Tooltip
|
|
415
415
|
|
|
416
|
-
|
|
|
417
|
-
| --- |
|
|
416
|
+
| | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
|
|
417
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
|
|
418
418
|
|
|
419
419
|
Use to display smaller bits of text, not full sentences or descriptions, similar to a label, but only viewable on hover. Most often used in Charts, Tables, and Data Visualizations.
|
|
420
420
|
|
|
@@ -438,10 +438,10 @@ These rules establish how much margin should exist between and around elements.
|
|
|
438
438
|
|
|
439
439
|
## Table Tooltip
|
|
440
440
|
|
|
441
|
-
|
|
|
442
|
-
| --- |
|
|
441
|
+
| | In Figma | | | Meets Accessibility | | | In CZ ID Codebase |
|
|
442
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ----------------- |
|
|
443
443
|
|
|
444
|
-
Used in CZ ID to display complex, dense information that would benefit from being shown in a table format such as additional data or context connected to datasets in Charts, Tables, and Data Visualizations.
|
|
444
|
+
Used in CZ ID to display complex, dense information that would benefit from being shown in a table format such as additional data or context connected to datasets in Charts, Tables, and Data Visualizations.
|
|
445
445
|
|
|
446
446
|
The content in the Table Tooltip is determined by the `[array]` passed into the `data` prop. The `[array]` will determine optional section headers, whether a section is disabled or not, as well as each content row's label and item value. There can be as many sections and content rows per section as needed. See the Data Format section below for details about configuring the `[array]`.
|
|
447
447
|
|
|
@@ -465,56 +465,56 @@ Use the following configuration for the `[array]` passed into the `data` prop:
|
|
|
465
465
|
data = [
|
|
466
466
|
{
|
|
467
467
|
// section with a header
|
|
468
|
-
dataRows: [
|
|
468
|
+
dataRows: [
|
|
469
469
|
{
|
|
470
|
-
label: "Label",
|
|
470
|
+
label: "Label",
|
|
471
471
|
value: "Item",
|
|
472
|
-
},
|
|
472
|
+
},
|
|
473
473
|
{
|
|
474
|
-
label: "Label",
|
|
474
|
+
label: "Label",
|
|
475
475
|
value: "Item",
|
|
476
|
-
},
|
|
476
|
+
},
|
|
477
477
|
{
|
|
478
|
-
label: "Label",
|
|
478
|
+
label: "Label",
|
|
479
479
|
value: "Item",
|
|
480
|
-
}
|
|
480
|
+
},
|
|
481
481
|
],
|
|
482
482
|
label: "Section One", // optional
|
|
483
483
|
},
|
|
484
484
|
{
|
|
485
485
|
// section with no header
|
|
486
|
-
dataRows: [
|
|
486
|
+
dataRows: [
|
|
487
487
|
{
|
|
488
|
-
label: "Label",
|
|
488
|
+
label: "Label",
|
|
489
489
|
value: "Item",
|
|
490
|
-
},
|
|
490
|
+
},
|
|
491
491
|
{
|
|
492
|
-
label: "Label",
|
|
492
|
+
label: "Label",
|
|
493
493
|
value: "Item",
|
|
494
|
-
},
|
|
494
|
+
},
|
|
495
495
|
{
|
|
496
|
-
label: "Label",
|
|
496
|
+
label: "Label",
|
|
497
497
|
value: "Item",
|
|
498
|
-
}
|
|
499
|
-
],
|
|
498
|
+
},
|
|
499
|
+
],
|
|
500
500
|
},
|
|
501
|
-
|
|
501
|
+
{
|
|
502
502
|
// disabled section with no header
|
|
503
|
-
dataRows: [
|
|
503
|
+
dataRows: [
|
|
504
504
|
{
|
|
505
|
-
label: "Label",
|
|
505
|
+
label: "Label",
|
|
506
506
|
value: "Item",
|
|
507
|
-
},
|
|
507
|
+
},
|
|
508
508
|
{
|
|
509
|
-
label: "Label",
|
|
509
|
+
label: "Label",
|
|
510
510
|
value: "Item",
|
|
511
|
-
},
|
|
511
|
+
},
|
|
512
512
|
{
|
|
513
|
-
label: "Label",
|
|
513
|
+
label: "Label",
|
|
514
514
|
value: "Item",
|
|
515
|
-
}
|
|
516
|
-
],
|
|
517
|
-
|
|
515
|
+
},
|
|
516
|
+
],
|
|
517
|
+
disabled: true,
|
|
518
518
|
},
|
|
519
519
|
];
|
|
520
520
|
```
|
|
@@ -529,8 +529,8 @@ These rules establish how much margin should exist between and around elements.
|
|
|
529
529
|
|
|
530
530
|
## Dropdown Input Component
|
|
531
531
|
|
|
532
|
-
| Below you will find an interactive Storybook iframe for Tooltips.
|
|
533
|
-
|
|
|
532
|
+
| Below you will find an interactive Storybook iframe for Tooltips. 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:** Tooltip TooltipCondensed TooltipTable |
|
|
533
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------ |
|
|
534
534
|
|
|
535
535
|
---
|
|
536
536
|
|
|
@@ -550,7 +550,7 @@ Storybook
|
|
|
550
550
|
|
|
551
551
|
Storybook
|
|
552
552
|
|
|
553
|
-
|
|
553
|
+
|
|
554
554
|
|
|
555
555
|
---
|
|
556
556
|
|
|
@@ -560,8 +560,8 @@ Tooltips are used throughout the UI and appear whenever users hover over element
|
|
|
560
560
|
|
|
561
561
|
## Tooltip Components
|
|
562
562
|
|
|
563
|
-
| Tooltips are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element that triggers it and where it's located in the interface. |
|
|
564
|
-
|
|
|
563
|
+
| Tooltips are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element that triggers it and where it's located in the interface. | | **Jump to variant:** Tooltip Condensed Tooltip Table Tooltip |
|
|
564
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------ |
|
|
565
565
|
|
|
566
566
|
### Visual Preview
|
|
567
567
|
|
|
@@ -569,8 +569,8 @@ Tooltips are used throughout the UI and appear whenever users hover over element
|
|
|
569
569
|
|
|
570
570
|
## Tooltip
|
|
571
571
|
|
|
572
|
-
|
|
|
573
|
-
| --- |
|
|
572
|
+
| | In Figma | | | Meets Accessibility | | | In Code |
|
|
573
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
|
|
574
574
|
|
|
575
575
|
### Tooltip Types
|
|
576
576
|
|
|
@@ -595,7 +595,7 @@ Use in conjunction with action UI elements like Buttons or Segmented Control to
|
|
|
595
595
|
A subtitle may be added to communicate additional details, like instructions for using the element connected to the Tooltip.
|
|
596
596
|
|
|
597
597
|
| Default | Default (inverted) | Default + Subtitle | Default + Subtitle (inverted) |
|
|
598
|
-
|
|
|
598
|
+
| ------- | ------------------ | ------------------ | ----------------------------- |
|
|
599
599
|
|
|
600
600
|
---
|
|
601
601
|
|
|
@@ -604,7 +604,7 @@ A subtitle may be added to communicate additional details, like instructions for
|
|
|
604
604
|
Use to display supplementary information like definitions, instructions, or expanded details which require more space for text. The width can be increased up to `550px`.
|
|
605
605
|
|
|
606
606
|
| Default | Default (inverted) |
|
|
607
|
-
|
|
|
607
|
+
| ------- | ------------------ |
|
|
608
608
|
|
|
609
609
|
---
|
|
610
610
|
|
|
@@ -619,23 +619,23 @@ The Tooltip and its triggering element have a standard margin between them.
|
|
|
619
619
|
A Tooltip appears in one of twelve positions relative to the element it is tied to. For example, a position of `bottom` will appear **below** the trigger element.
|
|
620
620
|
|
|
621
621
|
| Bottom-start | Bottom | Bottom-end |
|
|
622
|
-
|
|
|
622
|
+
| ------------ | ------ | ---------- |
|
|
623
623
|
|
|
624
624
|
| Left-start | Left | Left-end |
|
|
625
|
-
|
|
|
625
|
+
| ---------- | ---- | -------- |
|
|
626
626
|
|
|
627
627
|
| Right-start | Right | Right-end |
|
|
628
|
-
|
|
|
628
|
+
| ----------- | ----- | --------- |
|
|
629
629
|
|
|
630
630
|
| Top-start | Top | Top-end |
|
|
631
|
-
|
|
|
631
|
+
| --------- | --- | ------- |
|
|
632
632
|
|
|
633
633
|
---
|
|
634
634
|
|
|
635
635
|
## Condensed Tooltip
|
|
636
636
|
|
|
637
|
-
|
|
|
638
|
-
| --- |
|
|
637
|
+
| | In Figma | | | Meets Accessibility | | | In Code |
|
|
638
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
|
|
639
639
|
|
|
640
640
|
### Live Instance
|
|
641
641
|
|
|
@@ -654,7 +654,7 @@ The Condensed Tooltip is positioned relative to the user's cursor rather than it
|
|
|
654
654
|
The Condensed Tooltip can optionally be displayed using an inverted color scheme for better contrast on certain backgrounds.
|
|
655
655
|
|
|
656
656
|
| Default | Default (inverted) | Default + Indicator | Default + Indicator (inverted) |
|
|
657
|
-
|
|
|
657
|
+
| ------- | ------------------ | ------------------- | ------------------------------ |
|
|
658
658
|
|
|
659
659
|
---
|
|
660
660
|
|
|
@@ -666,8 +666,8 @@ The Condensed Tooltip and its triggering element have a standard margin between
|
|
|
666
666
|
|
|
667
667
|
## Table Tooltip
|
|
668
668
|
|
|
669
|
-
|
|
|
670
|
-
| --- |
|
|
669
|
+
| | In Figma | | | Meets Accessibility | | | In Code |
|
|
670
|
+
| --- | -------- | --- | --- | ------------------- | --- | --- | ------- |
|
|
671
671
|
|
|
672
672
|
### Live Instance
|
|
673
673
|
|
|
@@ -686,7 +686,7 @@ By default, Item values are aligned right but can be aligned left.
|
|
|
686
686
|
The Table Tooltip is positioned relative to the user's cursor rather than its triggering element
|
|
687
687
|
|
|
688
688
|
| 1 Section | 1 Section + Section Headers | 2 Sections + Section Headers |
|
|
689
|
-
|
|
|
689
|
+
| --------- | --------------------------- | ---------------------------- |
|
|
690
690
|
|
|
691
691
|
---
|
|
692
692
|
|
|
@@ -698,12 +698,12 @@ The Table Tooltip and its triggering element have a standard margin between them
|
|
|
698
698
|
|
|
699
699
|
## Tooltip Components
|
|
700
700
|
|
|
701
|
-
| `Tooltips` are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element that triggers it and where it's located in the interface. |
|
|
702
|
-
|
|
|
701
|
+
| `Tooltips` are always used in conjunction with other elements when there is a need to further clarify the element's function, provide instructions, or display additional details to the user. The variant used depends on the element that triggers it and where it's located in the interface. | | **Jump to variant:** Tooltip TooltipCondensed TooltipTable |
|
|
702
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | ---------------------------------------------------------- |
|
|
703
703
|
|
|
704
704
|
### Visual Preview
|
|
705
705
|
|
|
706
|
-
|
|
706
|
+
> **Note:** The code examples below must install dependencies before displaying and may take extra time to load
|
|
707
707
|
|
|
708
708
|
---
|
|
709
709
|
|
|
@@ -717,10 +717,10 @@ The component's source code in the SDS codebase can be found here.
|
|
|
717
717
|
|
|
718
718
|
The SDS `Tooltip` component has a number of preset options in addition to, or that modify, the MUI options:
|
|
719
719
|
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
720
|
+
- **`sdsStyle`** **:** This prop takes either `light` (the default if not specified), or `dark`. Each of these "unlocks" additional options for other props; see below bullets:
|
|
721
|
+
- **`width`\*\***:\*\* SDS `Tooltip`'s `width` prop accepts `"default"`(unsurprisingly, the default!) which limits the maximum width to 250px. Additionally, only if `sdsStyle="light"` then it also accepts a value of `"wide"`, which translates to a maximum width of 550px. Compare these string options to MUI's `width` prop, which takes a number for the width in pixels.
|
|
722
|
+
- **`subtitle`\*\***:\*\* This SDS-specific prop is only available for dark-styled `Tooltips` (`sdsStyle="dark"`) . It takes a string value that displays below the text set by the `title` prop.
|
|
723
|
+
- **`arrowOffset`\*\***:\*\* This SDS-only prop takes a negative or positive value equivalent to the number of pixels by which to move the arrow (if `arrow={true}`) either left or right, respectively. It is possible though for this to move the arrow outside of the `Tooltip` edge itself, so be aware of the `width` setting as well as the length of text within the `Tooltip`.
|
|
724
724
|
|
|
725
725
|
### MUI Documentation
|
|
726
726
|
|
|
@@ -730,15 +730,15 @@ Documentation for the underlying MUI component can be found here.
|
|
|
730
730
|
|
|
731
731
|
Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
|
|
732
732
|
|
|
733
|
-
| Name
|
|
734
|
-
|
|
|
735
|
-
| `arrow`
|
|
736
|
-
| `arrowOffset` | `number`
|
|
737
|
-
| `placement`
|
|
738
|
-
| `sdsStyle`
|
|
739
|
-
| `subtitle`
|
|
740
|
-
| `title`
|
|
741
|
-
| `width`
|
|
733
|
+
| Name | Type | Default | Description |
|
|
734
|
+
| ------------- | ------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ---------- | -------------- | ----------------- | ----------- | --------------- | --------------- | --------- | ---------- | ---------- | ------------------ |
|
|
735
|
+
| `arrow` | `boolean` | `false` | If `true`, adds an arrow to the tooltip. |
|
|
736
|
+
| `arrowOffset` | `number` | `0` | ArrowOffset changes the position of the tooltip arrow and can be any numeric value within `[-120, 120]`. Exceeding the tooltip width removes the arrow. |
|
|
737
|
+
| `placement` | `"bottom-start"` ` | "bottom"` ` | "bottom-end"` ` | "left-start"` ` | "left"` ` | "left-end"` ` | "right-start"` ` | "right"` ` | "right-end"` ` | "top-start"` ` | "top"` ` | "top-end"` | `"bottom"` | Tooltip placement. |
|
|
738
|
+
| `sdsStyle` | `"light" | "dark"` | `"light"` | Style of the component. |
|
|
739
|
+
| `subtitle` | `string` | `-` | Tooltip subtitle text. |
|
|
740
|
+
| `title` | `Node` | `-` | Tooltip title. Zero-length titles string, undefined, null and false are never displayed. |
|
|
741
|
+
| `width` | `"default" | "wide"` | `"default"` | If set to `wide`, the tooltip is wider. |
|
|
742
742
|
|
|
743
743
|
### Code examples
|
|
744
744
|
|
|
@@ -773,13 +773,11 @@ h1 {
|
|
|
773
773
|
|
|
774
774
|
```json
|
|
775
775
|
{
|
|
776
|
-
"include": [
|
|
777
|
-
"./**/*"
|
|
778
|
-
],
|
|
776
|
+
"include": ["./**/*"],
|
|
779
777
|
"compilerOptions": {
|
|
780
778
|
"strict": true,
|
|
781
779
|
"esModuleInterop": true,
|
|
782
|
-
"lib": [
|
|
780
|
+
"lib": ["dom", "es2015"],
|
|
783
781
|
"jsx": "react-jsx"
|
|
784
782
|
}
|
|
785
783
|
}
|
|
@@ -794,17 +792,13 @@ import "./styles.css";
|
|
|
794
792
|
function App() {
|
|
795
793
|
return (
|
|
796
794
|
<div className="app">
|
|
797
|
-
<Tooltip
|
|
798
|
-
arrow
|
|
795
|
+
<Tooltip
|
|
796
|
+
arrow
|
|
799
797
|
sdsStyle="dark"
|
|
800
|
-
subtitle="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla facilisi."
|
|
801
|
-
title="Tooltip title"
|
|
798
|
+
subtitle="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla facilisi."
|
|
799
|
+
title="Tooltip title"
|
|
802
800
|
>
|
|
803
|
-
<ButtonIcon
|
|
804
|
-
sdsType="secondary"
|
|
805
|
-
sdsSize="large"
|
|
806
|
-
sdsIcon="InfoCircle"
|
|
807
|
-
/>
|
|
801
|
+
<ButtonIcon sdsType="secondary" sdsSize="large" sdsIcon="InfoCircle" />
|
|
808
802
|
</Tooltip>
|
|
809
803
|
</div>
|
|
810
804
|
);
|
|
@@ -850,13 +844,12 @@ root.render(
|
|
|
850
844
|
<RootApp />
|
|
851
845
|
</React.StrictMode>
|
|
852
846
|
);
|
|
853
|
-
|
|
854
847
|
```
|
|
855
848
|
|
|
856
849
|
**/public/index.html**
|
|
857
850
|
|
|
858
851
|
```html
|
|
859
|
-
<!
|
|
852
|
+
<!doctype html>
|
|
860
853
|
<html lang="en">
|
|
861
854
|
<head>
|
|
862
855
|
<meta charset="UTF-8" />
|
|
@@ -877,18 +870,29 @@ root.render(
|
|
|
877
870
|
<div id="root"></div>
|
|
878
871
|
</body>
|
|
879
872
|
</html>
|
|
880
|
-
|
|
881
873
|
```
|
|
882
874
|
|
|
883
875
|
**/package.json**
|
|
884
876
|
|
|
885
877
|
```json
|
|
886
|
-
{
|
|
878
|
+
{
|
|
879
|
+
"dependencies": {
|
|
880
|
+
"react": "^18.0.0",
|
|
881
|
+
"react-dom": "^18.0.0",
|
|
882
|
+
"react-scripts": "^4.0.0"
|
|
883
|
+
},
|
|
884
|
+
"devDependencies": {
|
|
885
|
+
"@types/react": "^18.0.0",
|
|
886
|
+
"@types/react-dom": "^18.0.0",
|
|
887
|
+
"typescript": "^4.0.0"
|
|
888
|
+
},
|
|
889
|
+
"main": "/index.tsx"
|
|
890
|
+
}
|
|
887
891
|
```
|
|
888
892
|
|
|
889
893
|
---
|
|
890
894
|
|
|
891
|
-
#### **Tooltip – Light**
|
|
895
|
+
#### **Tooltip – Light**
|
|
892
896
|
|
|
893
897
|
This example showcases a light-themed `Tooltip`.
|
|
894
898
|
|
|
@@ -921,13 +925,11 @@ h1 {
|
|
|
921
925
|
|
|
922
926
|
```json
|
|
923
927
|
{
|
|
924
|
-
"include": [
|
|
925
|
-
"./**/*"
|
|
926
|
-
],
|
|
928
|
+
"include": ["./**/*"],
|
|
927
929
|
"compilerOptions": {
|
|
928
930
|
"strict": true,
|
|
929
931
|
"esModuleInterop": true,
|
|
930
|
-
"lib": [
|
|
932
|
+
"lib": ["dom", "es2015"],
|
|
931
933
|
"jsx": "react-jsx"
|
|
932
934
|
}
|
|
933
935
|
}
|
|
@@ -942,15 +944,11 @@ import "./styles.css";
|
|
|
942
944
|
function App() {
|
|
943
945
|
return (
|
|
944
946
|
<div className="app">
|
|
945
|
-
<Tooltip
|
|
946
|
-
arrow
|
|
947
|
-
title="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla facilisi."
|
|
947
|
+
<Tooltip
|
|
948
|
+
arrow
|
|
949
|
+
title="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla facilisi."
|
|
948
950
|
>
|
|
949
|
-
<ButtonIcon
|
|
950
|
-
sdsType="secondary"
|
|
951
|
-
sdsSize="large"
|
|
952
|
-
sdsIcon="InfoCircle"
|
|
953
|
-
/>
|
|
951
|
+
<ButtonIcon sdsType="secondary" sdsSize="large" sdsIcon="InfoCircle" />
|
|
954
952
|
</Tooltip>
|
|
955
953
|
</div>
|
|
956
954
|
);
|
|
@@ -996,13 +994,12 @@ root.render(
|
|
|
996
994
|
<RootApp />
|
|
997
995
|
</React.StrictMode>
|
|
998
996
|
);
|
|
999
|
-
|
|
1000
997
|
```
|
|
1001
998
|
|
|
1002
999
|
**/public/index.html**
|
|
1003
1000
|
|
|
1004
1001
|
```html
|
|
1005
|
-
<!
|
|
1002
|
+
<!doctype html>
|
|
1006
1003
|
<html lang="en">
|
|
1007
1004
|
<head>
|
|
1008
1005
|
<meta charset="UTF-8" />
|
|
@@ -1023,13 +1020,24 @@ root.render(
|
|
|
1023
1020
|
<div id="root"></div>
|
|
1024
1021
|
</body>
|
|
1025
1022
|
</html>
|
|
1026
|
-
|
|
1027
1023
|
```
|
|
1028
1024
|
|
|
1029
1025
|
**/package.json**
|
|
1030
1026
|
|
|
1031
1027
|
```json
|
|
1032
|
-
{
|
|
1028
|
+
{
|
|
1029
|
+
"dependencies": {
|
|
1030
|
+
"react": "^18.0.0",
|
|
1031
|
+
"react-dom": "^18.0.0",
|
|
1032
|
+
"react-scripts": "^4.0.0"
|
|
1033
|
+
},
|
|
1034
|
+
"devDependencies": {
|
|
1035
|
+
"@types/react": "^18.0.0",
|
|
1036
|
+
"@types/react-dom": "^18.0.0",
|
|
1037
|
+
"typescript": "^4.0.0"
|
|
1038
|
+
},
|
|
1039
|
+
"main": "/index.tsx"
|
|
1040
|
+
}
|
|
1033
1041
|
```
|
|
1034
1042
|
|
|
1035
1043
|
---
|
|
@@ -1038,11 +1046,11 @@ root.render(
|
|
|
1038
1046
|
|
|
1039
1047
|
This example demonstrates how to add a tooltip to a disabled component, commonly a button.
|
|
1040
1048
|
|
|
1041
|
-
|
|
1049
|
+
> **Note for Tooltips on** **`Disabled`** **elements**
|
|
1042
1050
|
>
|
|
1043
|
-
>If the tooltip wraps a disabled component, please make sure to wrap the children in a `<span>` tag.
|
|
1051
|
+
> If the tooltip wraps a disabled component, please make sure to wrap the children in a `<span>` tag.
|
|
1044
1052
|
>
|
|
1045
|
-
>https://mui.com/components/tooltips/#disabled-elements
|
|
1053
|
+
> https://mui.com/components/tooltips/#disabled-elements
|
|
1046
1054
|
|
|
1047
1055
|
**/styles.css**
|
|
1048
1056
|
|
|
@@ -1073,13 +1081,11 @@ h1 {
|
|
|
1073
1081
|
|
|
1074
1082
|
```json
|
|
1075
1083
|
{
|
|
1076
|
-
"include": [
|
|
1077
|
-
"./**/*"
|
|
1078
|
-
],
|
|
1084
|
+
"include": ["./**/*"],
|
|
1079
1085
|
"compilerOptions": {
|
|
1080
1086
|
"strict": true,
|
|
1081
1087
|
"esModuleInterop": true,
|
|
1082
|
-
"lib": [
|
|
1088
|
+
"lib": ["dom", "es2015"],
|
|
1083
1089
|
"jsx": "react-jsx"
|
|
1084
1090
|
}
|
|
1085
1091
|
}
|
|
@@ -1094,10 +1100,7 @@ import "./styles.css";
|
|
|
1094
1100
|
function App() {
|
|
1095
1101
|
return (
|
|
1096
1102
|
<div className="app">
|
|
1097
|
-
<Tooltip
|
|
1098
|
-
arrow
|
|
1099
|
-
title="This Button is disabled!"
|
|
1100
|
-
>
|
|
1103
|
+
<Tooltip arrow title="This Button is disabled!">
|
|
1101
1104
|
<span>
|
|
1102
1105
|
<ButtonIcon
|
|
1103
1106
|
sdsType="secondary"
|
|
@@ -1151,13 +1154,12 @@ root.render(
|
|
|
1151
1154
|
<RootApp />
|
|
1152
1155
|
</React.StrictMode>
|
|
1153
1156
|
);
|
|
1154
|
-
|
|
1155
1157
|
```
|
|
1156
1158
|
|
|
1157
1159
|
**/public/index.html**
|
|
1158
1160
|
|
|
1159
1161
|
```html
|
|
1160
|
-
<!
|
|
1162
|
+
<!doctype html>
|
|
1161
1163
|
<html lang="en">
|
|
1162
1164
|
<head>
|
|
1163
1165
|
<meta charset="UTF-8" />
|
|
@@ -1178,13 +1180,24 @@ root.render(
|
|
|
1178
1180
|
<div id="root"></div>
|
|
1179
1181
|
</body>
|
|
1180
1182
|
</html>
|
|
1181
|
-
|
|
1182
1183
|
```
|
|
1183
1184
|
|
|
1184
1185
|
**/package.json**
|
|
1185
1186
|
|
|
1186
1187
|
```json
|
|
1187
|
-
{
|
|
1188
|
+
{
|
|
1189
|
+
"dependencies": {
|
|
1190
|
+
"react": "^18.0.0",
|
|
1191
|
+
"react-dom": "^18.0.0",
|
|
1192
|
+
"react-scripts": "^4.0.0"
|
|
1193
|
+
},
|
|
1194
|
+
"devDependencies": {
|
|
1195
|
+
"@types/react": "^18.0.0",
|
|
1196
|
+
"@types/react-dom": "^18.0.0",
|
|
1197
|
+
"typescript": "^4.0.0"
|
|
1198
|
+
},
|
|
1199
|
+
"main": "/index.tsx"
|
|
1200
|
+
}
|
|
1188
1201
|
```
|
|
1189
1202
|
|
|
1190
1203
|
---
|
|
@@ -1199,11 +1212,11 @@ The component's source code in the SDS codebase can be found here.
|
|
|
1199
1212
|
|
|
1200
1213
|
### SDS vs MUI
|
|
1201
1214
|
|
|
1202
|
-
Like the regular SDS `Tooltip` component, the `TooltipCondensed` component is built on MUI's `Tooltip` component, and has its own SDS-specific props and options (which are different from SDS's `Tooltip`
|
|
1215
|
+
Like the regular SDS `Tooltip` component, the `TooltipCondensed` component is built on MUI's `Tooltip` component, and has its own SDS-specific props and options (which are different from SDS's `Tooltip` component's SDS-only options):
|
|
1203
1216
|
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1217
|
+
- **`indicator`\*\***:\*\* This boolean prop determines whether or not the `Tooltip` text should be preceded by a colored dot.
|
|
1218
|
+
- **`indicatorColor`\*\***:\*\* Sets the color of the `indicator`, if included.
|
|
1219
|
+
- **`followCursor`\*\***:\*\* Additionally, `TooltipCondensed` has the `followCursor` behavior, and setting the `followCursor` prop to `false` has no effect.
|
|
1207
1220
|
|
|
1208
1221
|
### MUI Documentation
|
|
1209
1222
|
|
|
@@ -1213,11 +1226,11 @@ Documentation for the underlying MUI component can be found here.
|
|
|
1213
1226
|
|
|
1214
1227
|
Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
|
|
1215
1228
|
|
|
1216
|
-
| Name
|
|
1217
|
-
|
|
|
1218
|
-
| `indicator`
|
|
1219
|
-
| `indicatorColor` | `color`
|
|
1220
|
-
| `title`
|
|
1229
|
+
| Name | Type | Default | Description |
|
|
1230
|
+
| ---------------- | --------- | ------- | ------------------------------------------------------------------------------------------------- |
|
|
1231
|
+
| `indicator` | `boolean` | `false` | This boolean prop determines whether or not the Tooltip text should be preceded by a colored dot. |
|
|
1232
|
+
| `indicatorColor` | `color` | `-` | Sets the color of the indicator, if included. |
|
|
1233
|
+
| `title` | `Node` | `-` | Tooltip title. Zero-length titles string, undefined, null and false are never displayed. |
|
|
1221
1234
|
|
|
1222
1235
|
### Code examples
|
|
1223
1236
|
|
|
@@ -1254,13 +1267,11 @@ h1 {
|
|
|
1254
1267
|
|
|
1255
1268
|
```json
|
|
1256
1269
|
{
|
|
1257
|
-
"include": [
|
|
1258
|
-
"./**/*"
|
|
1259
|
-
],
|
|
1270
|
+
"include": ["./**/*"],
|
|
1260
1271
|
"compilerOptions": {
|
|
1261
1272
|
"strict": true,
|
|
1262
1273
|
"esModuleInterop": true,
|
|
1263
|
-
"lib": [
|
|
1274
|
+
"lib": ["dom", "es2015"],
|
|
1264
1275
|
"jsx": "react-jsx"
|
|
1265
1276
|
}
|
|
1266
1277
|
}
|
|
@@ -1275,16 +1286,12 @@ import "./styles.css";
|
|
|
1275
1286
|
function App() {
|
|
1276
1287
|
return (
|
|
1277
1288
|
<div className="app">
|
|
1278
|
-
<TooltipCondensed
|
|
1289
|
+
<TooltipCondensed
|
|
1279
1290
|
indicator
|
|
1280
1291
|
indicatorColor="DodgerBlue"
|
|
1281
|
-
title="Tooltip title"
|
|
1292
|
+
title="Tooltip title"
|
|
1282
1293
|
>
|
|
1283
|
-
<ButtonIcon
|
|
1284
|
-
sdsType="secondary"
|
|
1285
|
-
sdsSize="large"
|
|
1286
|
-
sdsIcon="InfoCircle"
|
|
1287
|
-
/>
|
|
1294
|
+
<ButtonIcon sdsType="secondary" sdsSize="large" sdsIcon="InfoCircle" />
|
|
1288
1295
|
</TooltipCondensed>
|
|
1289
1296
|
</div>
|
|
1290
1297
|
);
|
|
@@ -1330,13 +1337,12 @@ root.render(
|
|
|
1330
1337
|
<RootApp />
|
|
1331
1338
|
</React.StrictMode>
|
|
1332
1339
|
);
|
|
1333
|
-
|
|
1334
1340
|
```
|
|
1335
1341
|
|
|
1336
1342
|
**/public/index.html**
|
|
1337
1343
|
|
|
1338
1344
|
```html
|
|
1339
|
-
<!
|
|
1345
|
+
<!doctype html>
|
|
1340
1346
|
<html lang="en">
|
|
1341
1347
|
<head>
|
|
1342
1348
|
<meta charset="UTF-8" />
|
|
@@ -1357,13 +1363,24 @@ root.render(
|
|
|
1357
1363
|
<div id="root"></div>
|
|
1358
1364
|
</body>
|
|
1359
1365
|
</html>
|
|
1360
|
-
|
|
1361
1366
|
```
|
|
1362
1367
|
|
|
1363
1368
|
**/package.json**
|
|
1364
1369
|
|
|
1365
1370
|
```json
|
|
1366
|
-
{
|
|
1371
|
+
{
|
|
1372
|
+
"dependencies": {
|
|
1373
|
+
"react": "^18.0.0",
|
|
1374
|
+
"react-dom": "^18.0.0",
|
|
1375
|
+
"react-scripts": "^4.0.0"
|
|
1376
|
+
},
|
|
1377
|
+
"devDependencies": {
|
|
1378
|
+
"@types/react": "^18.0.0",
|
|
1379
|
+
"@types/react-dom": "^18.0.0",
|
|
1380
|
+
"typescript": "^4.0.0"
|
|
1381
|
+
},
|
|
1382
|
+
"main": "/index.tsx"
|
|
1383
|
+
}
|
|
1367
1384
|
```
|
|
1368
1385
|
|
|
1369
1386
|
---
|
|
@@ -1380,9 +1397,9 @@ The component's source code in the SDS codebase can be found here.
|
|
|
1380
1397
|
|
|
1381
1398
|
The SDS `TooltipTable` is built off of the MUI `Tooltip` component, but it has a built-in way to add tabular data:
|
|
1382
1399
|
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1400
|
+
- **`data`\*\***:\*\* This prop takes an array of objects to be formatted within the `TooltipTable` with two columns, one for `label` and one for `value`.
|
|
1401
|
+
- **`itemAlign`\*\***:\*\* This prop specific to SDS positions the `value` contents of each row either the `right` or `left` of their column.
|
|
1402
|
+
- **`contentAlert`\*\***:\*\* This SDS-specific prop takes a value of `String` (a message), `Element` (such as a link), or `None` (the default).
|
|
1386
1403
|
|
|
1387
1404
|
### MUI Documentation
|
|
1388
1405
|
|
|
@@ -1392,11 +1409,11 @@ Documentation for the underlying MUI component can be found here.
|
|
|
1392
1409
|
|
|
1393
1410
|
Any custom SDS props and MUI props required for implementation are found on the table below. See the MUI documentation for additional optional props.
|
|
1394
1411
|
|
|
1395
|
-
| Name
|
|
1396
|
-
|
|
|
1397
|
-
| `contentAlert` | `string
|
|
1398
|
-
| `data`
|
|
1399
|
-
| `itemAlign`
|
|
1412
|
+
| Name | Type | Default | Description |
|
|
1413
|
+
| -------------- | ------------------------------------------------------------------------- | ---------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
1414
|
+
| `contentAlert` | `string | JSX.Element` | `-` | This SDS-specific prop takes a value of String (a message), Element (such as a link), or None (the default) |
|
|
1415
|
+
| `data` | `Array<{` `label?: string;` `dataRows: {` `label: string;` `value: string | number;` `}[];` `disabled?: boolean;` `}>` | `-` | This prop takes an array of objects to be formatted within the TooltipTable with two columns, one for label and one for value. |
|
|
1416
|
+
| `itemAlign` | `"left" | "right"` | `"right"` | This prop specific to SDS positions the value contents of each row either the `right` or `left` of their column. |
|
|
1400
1417
|
|
|
1401
1418
|
### Code examples
|
|
1402
1419
|
|
|
@@ -1431,13 +1448,11 @@ h1 {
|
|
|
1431
1448
|
|
|
1432
1449
|
```json
|
|
1433
1450
|
{
|
|
1434
|
-
"include": [
|
|
1435
|
-
"./**/*"
|
|
1436
|
-
],
|
|
1451
|
+
"include": ["./**/*"],
|
|
1437
1452
|
"compilerOptions": {
|
|
1438
1453
|
"strict": true,
|
|
1439
1454
|
"esModuleInterop": true,
|
|
1440
|
-
"lib": [
|
|
1455
|
+
"lib": ["dom", "es2015"],
|
|
1441
1456
|
"jsx": "react-jsx"
|
|
1442
1457
|
}
|
|
1443
1458
|
}
|
|
@@ -1459,26 +1474,18 @@ function App() {
|
|
|
1459
1474
|
label: "Section 1",
|
|
1460
1475
|
},
|
|
1461
1476
|
{
|
|
1462
|
-
dataRows: [
|
|
1463
|
-
{ label: "Third", value: 3 },
|
|
1464
|
-
],
|
|
1477
|
+
dataRows: [{ label: "Third", value: 3 }],
|
|
1465
1478
|
label: "Section 2",
|
|
1466
|
-
}
|
|
1479
|
+
},
|
|
1467
1480
|
];
|
|
1468
1481
|
return (
|
|
1469
1482
|
<div className="app">
|
|
1470
|
-
<Tooltip
|
|
1471
|
-
arrow
|
|
1472
|
-
title={
|
|
1473
|
-
<TooltipTable itemAlign="right" data={data} />
|
|
1474
|
-
}
|
|
1483
|
+
<Tooltip
|
|
1484
|
+
arrow
|
|
1485
|
+
title={<TooltipTable itemAlign="right" data={data} />}
|
|
1475
1486
|
placement="right-end"
|
|
1476
1487
|
>
|
|
1477
|
-
<ButtonIcon
|
|
1478
|
-
sdsType="secondary"
|
|
1479
|
-
sdsSize="large"
|
|
1480
|
-
sdsIcon="InfoCircle"
|
|
1481
|
-
/>
|
|
1488
|
+
<ButtonIcon sdsType="secondary" sdsSize="large" sdsIcon="InfoCircle" />
|
|
1482
1489
|
</Tooltip>
|
|
1483
1490
|
</div>
|
|
1484
1491
|
);
|
|
@@ -1524,13 +1531,12 @@ root.render(
|
|
|
1524
1531
|
<RootApp />
|
|
1525
1532
|
</React.StrictMode>
|
|
1526
1533
|
);
|
|
1527
|
-
|
|
1528
1534
|
```
|
|
1529
1535
|
|
|
1530
1536
|
**/public/index.html**
|
|
1531
1537
|
|
|
1532
1538
|
```html
|
|
1533
|
-
<!
|
|
1539
|
+
<!doctype html>
|
|
1534
1540
|
<html lang="en">
|
|
1535
1541
|
<head>
|
|
1536
1542
|
<meta charset="UTF-8" />
|
|
@@ -1551,14 +1557,24 @@ root.render(
|
|
|
1551
1557
|
<div id="root"></div>
|
|
1552
1558
|
</body>
|
|
1553
1559
|
</html>
|
|
1554
|
-
|
|
1555
1560
|
```
|
|
1556
1561
|
|
|
1557
1562
|
**/package.json**
|
|
1558
1563
|
|
|
1559
1564
|
```json
|
|
1560
|
-
{
|
|
1565
|
+
{
|
|
1566
|
+
"dependencies": {
|
|
1567
|
+
"react": "^18.0.0",
|
|
1568
|
+
"react-dom": "^18.0.0",
|
|
1569
|
+
"react-scripts": "^4.0.0"
|
|
1570
|
+
},
|
|
1571
|
+
"devDependencies": {
|
|
1572
|
+
"@types/react": "^18.0.0",
|
|
1573
|
+
"@types/react-dom": "^18.0.0",
|
|
1574
|
+
"typescript": "^4.0.0"
|
|
1575
|
+
},
|
|
1576
|
+
"main": "/index.tsx"
|
|
1577
|
+
}
|
|
1561
1578
|
```
|
|
1562
1579
|
|
|
1563
1580
|
---
|
|
1564
|
-
|