@czi-sds/mcp 0.5.2 → 0.5.3
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/tailwind.json +25 -25
- package/data/zeroheight-cache.json +5065 -1
- package/data/zeroheight-exports/Accordion.md +81 -20
- package/data/zeroheight-exports/Banner.md +104 -10
- package/data/zeroheight-exports/Buttons.md +1029 -1454
- package/data/zeroheight-exports/Callout.md +174 -9
- package/data/zeroheight-exports/Colors.md +1164 -41
- package/data/zeroheight-exports/Content-Card.md +148 -0
- package/data/zeroheight-exports/Control-Inputs.md +778 -63
- package/data/zeroheight-exports/Corners.md +8 -15
- package/data/zeroheight-exports/Dialog.md +200 -12
- package/data/zeroheight-exports/Downloads.md +120 -0
- package/data/zeroheight-exports/Dropdown-Input.md +616 -12
- package/data/zeroheight-exports/Dropdown-Menus.md +1150 -0
- package/data/zeroheight-exports/Field-Inputs.md +450 -9
- package/data/zeroheight-exports/Filters.md +238 -9
- package/data/zeroheight-exports/Getting-Started.md +7 -3
- package/data/zeroheight-exports/Hero.md +152 -0
- package/data/zeroheight-exports/Icons.md +1854 -218
- package/data/zeroheight-exports/Intent.md +40 -0
- package/data/zeroheight-exports/Link.md +52 -6
- package/data/zeroheight-exports/Lists.md +364 -6
- package/data/zeroheight-exports/Loading-Indicator.md +8 -0
- package/data/zeroheight-exports/Navigation.md +328 -6
- package/data/zeroheight-exports/Notification.md +172 -12
- package/data/zeroheight-exports/Panel.md +72 -12
- package/data/zeroheight-exports/README.md +17 -19
- package/data/zeroheight-exports/Responsive-Design.md +52 -0
- package/data/zeroheight-exports/Search-Input.md +44 -0
- package/data/zeroheight-exports/Search.md +248 -0
- package/data/zeroheight-exports/Segmented-Control.md +34 -9
- package/data/zeroheight-exports/Table.md +468 -47
- package/data/zeroheight-exports/Tabs.md +542 -9
- package/data/zeroheight-exports/Tags.md +504 -12
- package/data/zeroheight-exports/Text-Link.md +100 -0
- package/data/zeroheight-exports/Theming.md +36 -6
- package/data/zeroheight-exports/Tooltips.md +466 -15
- package/data/zeroheight-exports/Typography.md +64 -32
- package/package.json +3 -3
- package/data/zeroheight-exports/Dropdown-Menu.md +0 -3883
|
@@ -14,26 +14,62 @@ Users can filter using any combination of Filter options presented to them—see
|
|
|
14
14
|
| **Closed** | **Open** | **Active** |
|
|
15
15
|
| ---------- | -------- | ---------- |
|
|
16
16
|
|
|
17
|
+
**Filter_Closed**
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
**Filter_Open**
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
**Filter_Active**
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
17
29
|
### Filter Variants
|
|
18
30
|
|
|
31
|
+
**Default**
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
**Default + Search**
|
|
38
|
+
|
|
19
39
|
---
|
|
20
40
|
|
|
21
41
|
### Filter Example
|
|
22
42
|
|
|
23
43
|
The example below shows Filters being used as part of the plugin search on napari hub.
|
|
24
44
|
|
|
45
|
+
**Filter_Example**
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
25
49
|
---
|
|
26
50
|
|
|
27
51
|
### Filter Spacing
|
|
28
52
|
|
|
29
53
|
These rules establish how much margin should exist between and around elements. Follow spacing rules for Dropdown Menus for spacing guidance for the Filter Input.
|
|
30
54
|
|
|
55
|
+
**Filter_Spacing**
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
31
59
|
---
|
|
32
60
|
|
|
33
61
|
## Filtering Logic
|
|
34
62
|
|
|
35
63
|
Filtering logic is handled at the product level; however, this section offers some suggestions for best practices to consider when establishing filtering logic.
|
|
36
64
|
|
|
65
|
+
**Between filter categories: use "AND"**
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
**Within filter categories: use "OR"**
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
37
73
|
## Code
|
|
38
74
|
|
|
39
75
|
## Filter Components
|
|
@@ -67,12 +103,40 @@ The Dropdown Menu that is activated when the Filter Label is clicked displays th
|
|
|
67
103
|
| **Closed** | **Open** | **Active** |
|
|
68
104
|
| ---------- | -------- | ---------- |
|
|
69
105
|
|
|
106
|
+
**Complex Filter_Closed**
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
**Complex Filter_Open**
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
**Complex Filter_Active**
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
70
118
|
### Filter Variants
|
|
71
119
|
|
|
120
|
+
**Single-select**
|
|
121
|
+
|
|
72
122
|
---
|
|
73
123
|
|
|
74
124
|
---
|
|
75
125
|
|
|
126
|
+
**Single-select + Search**
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
**Multi-select**
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
**Multi-select + Search**
|
|
139
|
+
|
|
76
140
|
---
|
|
77
141
|
|
|
78
142
|
|
|
@@ -81,18 +145,34 @@ The Dropdown Menu that is activated when the Filter Label is clicked displays th
|
|
|
81
145
|
|
|
82
146
|
The example below shows Complex Filters being used as part of a Basic Panel in CZ GEN EPI.
|
|
83
147
|
|
|
148
|
+
**Complex Filter_Example**
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
84
152
|
---
|
|
85
153
|
|
|
86
154
|
### Filter Spacing
|
|
87
155
|
|
|
88
156
|
These rules establish how much margin should exist between and around elements. Follow spacing rules for Dropdown Menus for spacing guidance for the Complex Filter Input.
|
|
89
157
|
|
|
158
|
+
**Complex Filter_Spacing**
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
90
162
|
---
|
|
91
163
|
|
|
92
164
|
## Filtering Logic
|
|
93
165
|
|
|
94
166
|
Filtering logic is handled at the product level, however, this section offers some suggestions for best practices to consider when establishing filtering logic.
|
|
95
167
|
|
|
168
|
+
**Between filter categories: use "AND"**
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
**Within filter categories: use "OR"**
|
|
175
|
+
|
|
96
176
|
---
|
|
97
177
|
|
|
98
178
|
## Code
|
|
@@ -130,14 +210,30 @@ Filters are used to narrow down large amounts of data based on specific criteria
|
|
|
130
210
|
|
|
131
211
|
Use the Simple Filter when there are only a few options to filter on or there are only a few filter categories needed for a given dataset. Simple Filters are comprised of a Filter Label combined with a Filter Input that is Single-select (Radio Lockup), Multi-select (Checkbox Lockup), or a Range (Slider) depending on the filtering needs of the dataset. In contrast to Complex Filters which keep filter options contained within a Dropdown Menu, Simple Filters have all of the options for each filter exposed in the UI and viewable by the user. Users can filter using any combination of Filter options presented to them—see the Filtering Logic section below for an overview of how applied Filters affect the dataset being filtered.
|
|
132
212
|
|
|
213
|
+
**Single-select**
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
**Multi-select**
|
|
220
|
+
|
|
133
221
|
---
|
|
134
222
|
|
|
135
223
|
---
|
|
136
224
|
|
|
225
|
+
**Range**
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
137
229
|
### Simple Filter Example
|
|
138
230
|
|
|
139
231
|
The example below shows Simple Filters being used as part of a Basic Panel in CZ ID.
|
|
140
232
|
|
|
233
|
+
**Simple Filter_Example**
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
141
237
|
|
|
142
238
|
|
|
143
239
|
---
|
|
@@ -146,6 +242,10 @@ The example below shows Simple Filters being used as part of a Basic Panel in CZ
|
|
|
146
242
|
|
|
147
243
|
These rules establish how much margin should exist between and around elements.
|
|
148
244
|
|
|
245
|
+
**Simple Filter Spacing**
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
149
249
|
---
|
|
150
250
|
|
|
151
251
|
## Complex Filter
|
|
@@ -160,14 +260,46 @@ The Dropdown Menu that is activated when the Filter Label is clicked displays th
|
|
|
160
260
|
| **Closed** | **Open** | **Active** |
|
|
161
261
|
| ---------- | -------- | ---------- |
|
|
162
262
|
|
|
263
|
+
**Complex Filter_Closed**
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
**Complex Filter_Open**
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
**Complex Filter_Active**
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
163
275
|
### Complex Filter Variants
|
|
164
276
|
|
|
277
|
+
**Single-select**
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
165
281
|
---
|
|
166
282
|
|
|
283
|
+
**Single-select + Search**
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
|
|
289
|
+
**Multi-select**
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
**Multi-select + Search**
|
|
296
|
+
|
|
167
297
|
---
|
|
168
298
|
|
|
169
299
|
---
|
|
170
300
|
|
|
301
|
+
**Range**
|
|
302
|
+
|
|
171
303
|
---
|
|
172
304
|
|
|
173
305
|
|
|
@@ -176,18 +308,34 @@ The Dropdown Menu that is activated when the Filter Label is clicked displays th
|
|
|
176
308
|
|
|
177
309
|
The example below shows Complex Filters being used as part of a Basic Panel in CZ ID.
|
|
178
310
|
|
|
311
|
+
**Complex Filter_Example**
|
|
312
|
+
|
|
313
|
+
---
|
|
314
|
+
|
|
179
315
|
---
|
|
180
316
|
|
|
181
317
|
### Complex Filter Spacing
|
|
182
318
|
|
|
183
319
|
These rules establish how much margin should exist between and around elements. Follow spacing rules for Dropdown Menus for spacing guidance for the Complex Filter Input.
|
|
184
320
|
|
|
321
|
+
**Complex Filter_Spacing**
|
|
322
|
+
|
|
323
|
+
---
|
|
324
|
+
|
|
185
325
|
---
|
|
186
326
|
|
|
187
327
|
## Filtering Logic
|
|
188
328
|
|
|
189
329
|
Filtering logic is handled at the product level, however, this section offers some suggestions for best practices to consider when establishing filtering logic.
|
|
190
330
|
|
|
331
|
+
**Between filter categories: use “AND”**
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
---
|
|
336
|
+
|
|
337
|
+
**Within filter category: use “OR”**
|
|
338
|
+
|
|
191
339
|
---
|
|
192
340
|
|
|
193
341
|
## Code
|
|
@@ -220,6 +368,14 @@ Filters are used to narrow down large amounts of data based on specific criteria
|
|
|
220
368
|
|
|
221
369
|
### Visual Preview
|
|
222
370
|
|
|
371
|
+
**Preview_Guidelines_Filter_Simple**
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
**Preview_Guidelines_Filter_Complex**
|
|
376
|
+
|
|
377
|
+
---
|
|
378
|
+
|
|
223
379
|
---
|
|
224
380
|
|
|
225
381
|
## Simple Filter
|
|
@@ -240,18 +396,38 @@ Use Simple Filter when there are only a few filter categories or a few options p
|
|
|
240
396
|
| Single-select | Multi-select | Range |
|
|
241
397
|
| ------------- | ------------ | ----- |
|
|
242
398
|
|
|
399
|
+
**Simple Filter_Single-select**
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
**Simple Filter_Multi-select**
|
|
404
|
+
|
|
405
|
+
---
|
|
406
|
+
|
|
407
|
+
**Simple Filter_Range**
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
243
411
|
---
|
|
244
412
|
|
|
245
413
|
### Simple Filter example
|
|
246
414
|
|
|
247
415
|
The example below shows Simple Filters being used as part of a Basic Panel (documentation to come) in CZ ID.
|
|
248
416
|
|
|
417
|
+
**Simple Filter_Example**
|
|
418
|
+
|
|
419
|
+
---
|
|
420
|
+
|
|
249
421
|
---
|
|
250
422
|
|
|
251
423
|
### Simple Filter Spacing
|
|
252
424
|
|
|
253
425
|
These rules establish how much margin should exist between and around elements.
|
|
254
426
|
|
|
427
|
+
**Simple Filter Spacing**
|
|
428
|
+
|
|
429
|
+
---
|
|
430
|
+
|
|
255
431
|
---
|
|
256
432
|
|
|
257
433
|
## Complex Filter
|
|
@@ -276,29 +452,77 @@ The Dropdown Menu triggered when the Dropdown Input is clicked can be Single-sel
|
|
|
276
452
|
| Single-select | Single-select + Search | Multi-select | Multi-select + Search | Range |
|
|
277
453
|
| ------------- | ---------------------- | ------------ | --------------------- | ----- |
|
|
278
454
|
|
|
455
|
+
**Complex Filter_Input_Single-select**
|
|
456
|
+
|
|
457
|
+
---
|
|
458
|
+
|
|
459
|
+
**Complex Filter_Input_Single-select + Search**
|
|
460
|
+
|
|
461
|
+
---
|
|
462
|
+
|
|
463
|
+
**Complex Filter_Input_Multi-select**
|
|
464
|
+
|
|
465
|
+
---
|
|
466
|
+
|
|
467
|
+
**Complex Filter_Input_Multi-select + Search**
|
|
468
|
+
|
|
469
|
+
---
|
|
470
|
+
|
|
471
|
+
**Complex Filter_Input_Range**
|
|
472
|
+
|
|
473
|
+
---
|
|
474
|
+
|
|
279
475
|
#### **Complex Filter states**
|
|
280
476
|
|
|
281
477
|
| Closed | Open | Active |
|
|
282
478
|
| ------ | ---- | ------ |
|
|
283
479
|
|
|
480
|
+
**Complex Filter_Closed**
|
|
481
|
+
|
|
482
|
+
---
|
|
483
|
+
|
|
484
|
+
**Complex Filter_Open**
|
|
485
|
+
|
|
486
|
+
---
|
|
487
|
+
|
|
488
|
+
**Complex Filter_Active**
|
|
489
|
+
|
|
490
|
+
---
|
|
491
|
+
|
|
284
492
|
---
|
|
285
493
|
|
|
286
494
|
### Complex Filter example
|
|
287
495
|
|
|
288
496
|
The example below shows Complex Filters being used as part of a Basic Panel (documentation to come) in CZ ID.
|
|
289
497
|
|
|
498
|
+
**Complex Filter_Example**
|
|
499
|
+
|
|
500
|
+
---
|
|
501
|
+
|
|
290
502
|
---
|
|
291
503
|
|
|
292
504
|
### Complex Filter Spacing
|
|
293
505
|
|
|
294
506
|
These rules establish how much margin should exist between and around elements. Follow spacing rules for Dropdown Menus for spacing guidance for the Complex Filter Input.
|
|
295
507
|
|
|
508
|
+
**Complex Filter_Spacing**
|
|
509
|
+
|
|
510
|
+
---
|
|
511
|
+
|
|
296
512
|
---
|
|
297
513
|
|
|
298
514
|
### Filtering Logic
|
|
299
515
|
|
|
300
516
|
Filtering logic is handled at the product level, however, this section offers some suggestions for best practices to consider when establishing filtering logic.
|
|
301
517
|
|
|
518
|
+
**Between filter categories: use "AND"**
|
|
519
|
+
|
|
520
|
+
---
|
|
521
|
+
|
|
522
|
+
**Within filter categories: use "OR"**
|
|
523
|
+
|
|
524
|
+
---
|
|
525
|
+
|
|
302
526
|
## Code
|
|
303
527
|
|
|
304
528
|
## Filter Components
|
|
@@ -308,6 +532,14 @@ Filtering logic is handled at the product level, however, this section offers so
|
|
|
308
532
|
|
|
309
533
|
### Visual Preview
|
|
310
534
|
|
|
535
|
+
**Preview_Code_Filter_Simple**
|
|
536
|
+
|
|
537
|
+
---
|
|
538
|
+
|
|
539
|
+
**Preview_Code_Filter_Complex**
|
|
540
|
+
|
|
541
|
+
---
|
|
542
|
+
|
|
311
543
|
> **Note:** The code examples below must install dependencies before displaying and may take extra time to load
|
|
312
544
|
|
|
313
545
|
---
|
|
@@ -484,15 +716,14 @@ root.render(
|
|
|
484
716
|
<head>
|
|
485
717
|
<meta charset="UTF-8" />
|
|
486
718
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
487
|
-
<title>Filters</title>
|
|
488
719
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
489
720
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
490
721
|
<link
|
|
491
|
-
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap"
|
|
722
|
+
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
|
|
492
723
|
rel="stylesheet"
|
|
493
724
|
/>
|
|
494
725
|
<link
|
|
495
|
-
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600&display=swap"
|
|
726
|
+
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&display=swap"
|
|
496
727
|
rel="stylesheet"
|
|
497
728
|
/>
|
|
498
729
|
</head>
|
|
@@ -666,15 +897,14 @@ root.render(
|
|
|
666
897
|
<head>
|
|
667
898
|
<meta charset="UTF-8" />
|
|
668
899
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
669
|
-
<title>Filters</title>
|
|
670
900
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
671
901
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
672
902
|
<link
|
|
673
|
-
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap"
|
|
903
|
+
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
|
|
674
904
|
rel="stylesheet"
|
|
675
905
|
/>
|
|
676
906
|
<link
|
|
677
|
-
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600&display=swap"
|
|
907
|
+
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&display=swap"
|
|
678
908
|
rel="stylesheet"
|
|
679
909
|
/>
|
|
680
910
|
</head>
|
|
@@ -849,15 +1079,14 @@ root.render(
|
|
|
849
1079
|
<head>
|
|
850
1080
|
<meta charset="UTF-8" />
|
|
851
1081
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
852
|
-
<title>Filters</title>
|
|
853
1082
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
854
1083
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
855
1084
|
<link
|
|
856
|
-
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap"
|
|
1085
|
+
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
|
|
857
1086
|
rel="stylesheet"
|
|
858
1087
|
/>
|
|
859
1088
|
<link
|
|
860
|
-
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600&display=swap"
|
|
1089
|
+
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&display=swap"
|
|
861
1090
|
rel="stylesheet"
|
|
862
1091
|
/>
|
|
863
1092
|
</head>
|
|
@@ -1113,10 +1113,14 @@ To use the default theme in your React application, complete the following:
|
|
|
1113
1113
|
```html
|
|
1114
1114
|
// installs the sds font from google fonts
|
|
1115
1115
|
|
|
1116
|
-
<link rel="preconnect" href="https://fonts.
|
|
1117
|
-
|
|
1116
|
+
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
1117
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
1118
1118
|
<link
|
|
1119
|
-
href="https://fonts.googleapis.com/css2?family=
|
|
1119
|
+
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
|
|
1120
|
+
rel="stylesheet"
|
|
1121
|
+
/>
|
|
1122
|
+
<link
|
|
1123
|
+
href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&display=swap"
|
|
1120
1124
|
rel="stylesheet"
|
|
1121
1125
|
/>
|
|
1122
1126
|
```
|
|
@@ -20,6 +20,18 @@ For example: if the screen is `1200px` wide, the width of the content area would
|
|
|
20
20
|
| Breakpoint: Large | Breakpoint: Medium | Breakpoint: Small |
|
|
21
21
|
| ----------------- | ------------------ | ----------------- |
|
|
22
22
|
|
|
23
|
+
**Preview_Guidelines_Hero_large**
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
**Preview_Guidelines_Hero_medium**
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
**Preview_Guidelines_Hero_small**
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
23
35
|
#### Background Fill Options
|
|
24
36
|
|
|
25
37
|
The Hero component background can be filled with any CSS color, including gradients, or any type of media such as images, videos, GIFs, etc.
|
|
@@ -27,6 +39,14 @@ The Hero component background can be filled with any CSS color, including gradie
|
|
|
27
39
|
| Color | Media |
|
|
28
40
|
| ----- | ----- |
|
|
29
41
|
|
|
42
|
+
**Hero_background_color**
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
**Hero_background_image**
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
30
50
|
#### Darkening Mask
|
|
31
51
|
|
|
32
52
|
The darkening mask is an overlay element used to subtly dim the Hero's background, thereby enhancing the visibility and focus on the overlay elements; the mask's opacity can be set by the team implementing it.
|
|
@@ -34,6 +54,14 @@ The darkening mask is an overlay element used to subtly dim the Hero's backgroun
|
|
|
34
54
|
| Disabled | Enabled |
|
|
35
55
|
| -------- | ------- |
|
|
36
56
|
|
|
57
|
+
**Hero_darkening mask_false**
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
**Hero_darkening mask_true**
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
37
65
|
#### Darkening Vignette
|
|
38
66
|
|
|
39
67
|
The darkening vignette is an overlay element positioned at the top of Hero that subtly fades from solid to transparent, smoothing the transition from the Header Navigation to the Hero background.
|
|
@@ -41,6 +69,14 @@ The darkening vignette is an overlay element positioned at the top of Hero that
|
|
|
41
69
|
| Disabled | Enabled |
|
|
42
70
|
| -------- | ------- |
|
|
43
71
|
|
|
72
|
+
**Hero_darkening vignette_false**
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
**Hero_darkening vignette_true**
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
44
80
|
#### Overlay Content Visibility
|
|
45
81
|
|
|
46
82
|
Overlay content elements (title text, caption text, and content slot) can be used or not depending on teams' needs; the examples below show one element hidden at a time to demonstrate, but any combination of elements can be used.
|
|
@@ -48,6 +84,22 @@ Overlay content elements (title text, caption text, and content slot) can be use
|
|
|
48
84
|
| All elements displayed | Title hidden | Caption hidden | Content slot hidden |
|
|
49
85
|
| ---------------------- | ------------ | -------------- | ------------------- |
|
|
50
86
|
|
|
87
|
+
**Hero_overlay content_options_all visible**
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
**Hero_overlay content_options_no title**
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
**Hero_overlay content_options_no caption**
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
**Hero_overlay content_options_no slot**
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
51
103
|
#### Text Alignment Options
|
|
52
104
|
|
|
53
105
|
Alignment settings apply to both title and caption text.
|
|
@@ -55,17 +107,65 @@ Alignment settings apply to both title and caption text.
|
|
|
55
107
|
| Left-aligned | Center-aligned | Right-aligned |
|
|
56
108
|
| ------------ | -------------- | ------------- |
|
|
57
109
|
|
|
110
|
+
**Hero_overlay text_alignment_left-aligned**
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
**Hero_overlay text_alignment_center-aligned**
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
**Hero_overlay text_alignment_right-aligned**
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
58
122
|
#### Overlay Content Position
|
|
59
123
|
|
|
60
124
|
| Top-left | Top | Top-right |
|
|
61
125
|
| -------- | --- | --------- |
|
|
62
126
|
|
|
127
|
+
**Hero_overlay content_position_top-left**
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
**Hero_overlay content_position_top**
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
**Hero_overlay content_position_top-right**
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
63
139
|
| Left | Center | Right |
|
|
64
140
|
| ---- | ------ | ----- |
|
|
65
141
|
|
|
142
|
+
**Hero_overlay content_position_left**
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
**Hero_overlay content_position_center**
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
**Hero_overlay content_position_right**
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
66
154
|
| Bottom-left | Bottom | Bottom-right |
|
|
67
155
|
| ----------- | ------ | ------------ |
|
|
68
156
|
|
|
157
|
+
**Hero_overlay content_position_bottom-left**
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
**Hero_overlay content_position_bottom**
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
**Hero_overlay content_position_bottom-right**
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
69
169
|
#### Overlay Media Options
|
|
70
170
|
|
|
71
171
|
In addition to overlay content, media (images, videos, GIFs, etc.) can be optionally overlayed on top of the Hero component's background; it can take whatever size or shape teams need.
|
|
@@ -73,17 +173,69 @@ In addition to overlay content, media (images, videos, GIFs, etc.) can be option
|
|
|
73
173
|
| Overlay media hidden | Overlay media displayed | Larger overlay media | Smaller overlay media |
|
|
74
174
|
| -------------------- | ----------------------- | -------------------- | --------------------- |
|
|
75
175
|
|
|
176
|
+
**Hero_overlay image_false**
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
**Hero_overlay image_true**
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
**Hero_overlay image_true_larger**
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
**Hero_overlay image_true_smaller**
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
76
192
|
#### Overlay Media Position
|
|
77
193
|
|
|
78
194
|
| Top-left | Top | Top-right |
|
|
79
195
|
| -------- | --- | --------- |
|
|
80
196
|
|
|
197
|
+
**Hero_overlay image_position_top-left**
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
**Hero_overlay image_position_top**
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
**Hero_overlay image_position_top-right**
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
81
209
|
| Left | Center | Right |
|
|
82
210
|
| ---- | ------ | ----- |
|
|
83
211
|
|
|
212
|
+
**Hero_overlay image_position_left**
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
**Hero_overlay image_position_center**
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
**Hero_overlay image_position_right**
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
84
224
|
| Bottom-left | Bottom | Bottom-right |
|
|
85
225
|
| ----------- | ------ | ------------ |
|
|
86
226
|
|
|
227
|
+
**Hero_overlay image_position_bottom-left**
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
**Hero_overlay image_position_bottom**
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
**Hero_overlay image_position_bottom-right**
|
|
236
|
+
|
|
237
|
+
---
|
|
238
|
+
|
|
87
239
|
## Code
|
|
88
240
|
|
|
89
241
|
> **Note:** Code details coming soon
|