@czi-sds/mcp 0.16.0 → 0.18.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/README.md +2 -1
- package/data/component-docs/Accordion.md +291 -0
- package/data/component-docs/Autocomplete.md +525 -0
- package/data/component-docs/Banner.md +231 -0
- package/data/component-docs/Button.md +224 -0
- package/data/component-docs/ButtonDropdown.md +256 -0
- package/data/component-docs/ButtonGroup.md +320 -0
- package/data/component-docs/ButtonToggle.md +397 -0
- package/data/component-docs/Callout.md +268 -0
- package/data/component-docs/CellBasic.md +122 -0
- package/data/component-docs/CellComponent.md +63 -0
- package/data/component-docs/CellHeader.md +128 -0
- package/data/component-docs/ComplexFilter.md +294 -0
- package/data/component-docs/ContentCard.md +406 -0
- package/data/component-docs/Dialog.md +651 -0
- package/data/component-docs/Dropdown.md +155 -0
- package/data/component-docs/DropdownMenu.md +949 -0
- package/data/component-docs/HeatmapChart.md +782 -0
- package/data/component-docs/Hero.md +363 -0
- package/data/component-docs/Icon.md +283 -0
- package/data/component-docs/InputCheckbox.md +205 -0
- package/data/component-docs/InputDropdown.md +482 -0
- package/data/component-docs/InputRadio.md +173 -0
- package/data/component-docs/InputSearch.md +81 -0
- package/data/component-docs/InputSlider.md +189 -0
- package/data/component-docs/InputText.md +110 -0
- package/data/component-docs/InputToggle.md +141 -0
- package/data/component-docs/IntentMessage.md +293 -0
- package/data/component-docs/Legend.md +442 -0
- package/data/component-docs/Link.md +23 -0
- package/data/component-docs/List.md +300 -0
- package/data/component-docs/LoadingIndicator.md +198 -0
- package/data/component-docs/Menu.md +298 -0
- package/data/component-docs/MenuItem.md +100 -0
- package/data/component-docs/NavigationFooter.md +165 -0
- package/data/component-docs/NavigationHeader.md +500 -0
- package/data/component-docs/NavigationJumpTo.md +414 -0
- package/data/component-docs/Notification.md +288 -0
- package/data/component-docs/Pagination.md +67 -0
- package/data/component-docs/Panel.md +636 -0
- package/data/component-docs/Popover.md +448 -0
- package/data/component-docs/PreComposedTable.md +2947 -0
- package/data/component-docs/ProteinStructureViewer.md +1044 -0
- package/data/component-docs/SegmentedControl.md +396 -0
- package/data/component-docs/StackedBarChart.md +475 -0
- package/data/component-docs/Table.md +2000 -0
- package/data/component-docs/TableHeader.md +53 -0
- package/data/component-docs/TableRow.md +74 -0
- package/data/component-docs/Tabs.md +455 -0
- package/data/component-docs/Tag.md +647 -0
- package/data/component-docs/TagFilter.md +131 -0
- package/data/component-docs/Tooltip.md +561 -0
- package/data/component-docs/TooltipCondensed.md +203 -0
- package/data/component-docs/TooltipTable.md +145 -0
- package/data/component-docs/index.json +267 -0
- package/data/component-list.json +2 -5
- package/data/component-props/Accordion.json +31 -11
- package/data/component-props/Alert.json +3 -3
- package/data/component-props/Autocomplete.json +150 -15
- package/data/component-props/Banner.json +31 -17
- package/data/component-props/Button.json +45 -20
- package/data/component-props/ButtonDropdown.json +36 -17
- package/data/component-props/ButtonDropdownLegacy.json +11 -11
- package/data/component-props/ButtonGroup.json +32 -11
- package/data/component-props/ButtonIcon.json +10 -10
- package/data/component-props/ButtonLegacy.json +19 -19
- package/data/component-props/ButtonToggle.json +32 -19
- package/data/component-props/ButtonToggleLegacy.json +11 -11
- package/data/component-props/Callout.json +58 -17
- package/data/component-props/CellBasic.json +94 -41
- package/data/component-props/CellComponent.json +23 -7
- package/data/component-props/CellHeader.json +62 -19
- package/data/component-props/ComplexFilter.json +52 -21
- package/data/component-props/ContentCard.json +70 -47
- package/data/component-props/Dialog.json +47 -14
- package/data/component-props/Dropdown.json +68 -31
- package/data/component-props/DropdownMenu.json +128 -23
- package/data/component-props/HeatmapChart.json +88 -12
- package/data/component-props/Hero.json +80 -39
- package/data/component-props/Icon.json +20 -9
- package/data/component-props/InputCheckbox.json +36 -14
- package/data/component-props/InputDropdown.json +75 -27
- package/data/component-props/InputRadio.json +31 -13
- package/data/component-props/InputSearch.json +41 -18
- package/data/component-props/InputSlider.json +46 -19
- package/data/component-props/InputText.json +26 -19
- package/data/component-props/InputToggle.json +26 -9
- package/data/component-props/IntentMessage.json +38 -9
- package/data/component-props/Link.json +13 -7
- package/data/component-props/LoadingIndicator.json +11 -3
- package/data/component-props/MenuItem.json +38 -19
- package/data/component-props/MenuSelect.json +8 -8
- package/data/component-props/NavigationFooter.json +49 -19
- package/data/component-props/NavigationHeader.json +150 -37
- package/data/component-props/NavigationJumpTo.json +33 -7
- package/data/component-props/Notification.json +39 -21
- package/data/component-props/Pagination.json +39 -11
- package/data/component-props/Panel.json +62 -9
- package/data/component-props/Popover.json +80 -7
- package/data/component-props/PreComposedTable.json +99 -27
- package/data/component-props/ProteinStructureViewer.json +117 -0
- package/data/component-props/SegmentedControl.json +42 -3
- package/data/component-props/StackedBarChart.json +116 -42
- package/data/component-props/TableRow.json +38 -19
- package/data/component-props/Tabs.json +66 -9
- package/data/component-props/Tag.json +34 -17
- package/data/component-props/TagFilter.json +10 -3
- package/data/component-props/Tooltip.json +49 -18
- package/data/component-props/TooltipCondensed.json +18 -9
- package/data/component-props/TooltipTable.json +17 -7
- package/data/resources/{zeroheight-rules.md → documentation-rules.md} +43 -30
- package/data/resources/figma-rules.md +2 -2
- package/data/tailwind.json +20 -14
- package/dist/stdio.js +112 -208
- package/package.json +9 -5
- package/data/component-props/ButtonDropdownV2.json +0 -34
- package/data/component-props/ButtonNew.json +0 -47
- package/data/component-props/ButtonToggleV2.json +0 -44
- package/data/component-props/ButtonV2.json +0 -43
- package/data/zeroheight-cache.json +0 -10259
- package/data/zeroheight-exports/Accordion.md +0 -774
- package/data/zeroheight-exports/Banner.md +0 -691
- package/data/zeroheight-exports/Borders.md +0 -117
- package/data/zeroheight-exports/Buttons.md +0 -1854
- package/data/zeroheight-exports/Callout.md +0 -931
- package/data/zeroheight-exports/Colors.md +0 -1755
- package/data/zeroheight-exports/Content-Card.md +0 -309
- package/data/zeroheight-exports/Contributing-to-SDS.md +0 -98
- package/data/zeroheight-exports/Control-Inputs.md +0 -2818
- package/data/zeroheight-exports/Corners.md +0 -104
- package/data/zeroheight-exports/Cover-page.md +0 -3
- package/data/zeroheight-exports/Dialog.md +0 -1367
- package/data/zeroheight-exports/Downloads.md +0 -236
- package/data/zeroheight-exports/Drop-Shadows.md +0 -79
- package/data/zeroheight-exports/Dropdown-Input.md +0 -1776
- package/data/zeroheight-exports/Dropdown-Menus.md +0 -913
- package/data/zeroheight-exports/Element-Status-Tracker.md +0 -267
- package/data/zeroheight-exports/Field-Inputs.md +0 -1405
- package/data/zeroheight-exports/Filters.md +0 -1111
- package/data/zeroheight-exports/Getting-Started.md +0 -1157
- package/data/zeroheight-exports/Hero.md +0 -414
- package/data/zeroheight-exports/Icons.md +0 -2067
- package/data/zeroheight-exports/Intent.md +0 -86
- package/data/zeroheight-exports/Introduction-to-Bases.md +0 -35
- package/data/zeroheight-exports/Introduction-to-Cells.md +0 -35
- package/data/zeroheight-exports/Introduction-to-DNA.md +0 -35
- package/data/zeroheight-exports/Introduction-to-Genes.md +0 -35
- package/data/zeroheight-exports/Introduction.md +0 -115
- package/data/zeroheight-exports/Link.md +0 -432
- package/data/zeroheight-exports/Lists.md +0 -986
- package/data/zeroheight-exports/Loading-Indicator.md +0 -41
- package/data/zeroheight-exports/Navigation.md +0 -1190
- package/data/zeroheight-exports/Notification.md +0 -1038
- package/data/zeroheight-exports/Panel.md +0 -1030
- package/data/zeroheight-exports/README.md +0 -122
- package/data/zeroheight-exports/Responsive-Design.md +0 -330
- package/data/zeroheight-exports/Search-Input.md +0 -91
- package/data/zeroheight-exports/Search.md +0 -822
- package/data/zeroheight-exports/Segmented-Control.md +0 -609
- package/data/zeroheight-exports/Spacing.md +0 -297
- package/data/zeroheight-exports/Table.md +0 -5345
- package/data/zeroheight-exports/Tabs.md +0 -1324
- package/data/zeroheight-exports/Tags.md +0 -1545
- package/data/zeroheight-exports/Text-Link.md +0 -268
- package/data/zeroheight-exports/Theming.md +0 -362
- package/data/zeroheight-exports/Tooltips.md +0 -2015
- package/data/zeroheight-exports/Typography.md +0 -800
|
@@ -2,41 +2,60 @@
|
|
|
2
2
|
"MenuItem": {
|
|
3
3
|
"props": {
|
|
4
4
|
"column": {
|
|
5
|
-
"
|
|
6
|
-
"isRequired": false
|
|
5
|
+
"description": "The column prop determines the content displayed in the right column of the menu item. This content can be customized to provide additional information or context for the menu item.",
|
|
6
|
+
"isRequired": false,
|
|
7
|
+
"type": "ReactNode"
|
|
7
8
|
},
|
|
8
9
|
"disabled": {
|
|
9
|
-
"
|
|
10
|
-
"isRequired": false,
|
|
10
|
+
"defaultValue": false,
|
|
11
11
|
"description": "If `true`, the component is disabled.",
|
|
12
|
-
"
|
|
12
|
+
"isRequired": false,
|
|
13
|
+
"type": "boolean"
|
|
13
14
|
},
|
|
14
15
|
"icon": {
|
|
15
|
-
"
|
|
16
|
-
"isRequired": false
|
|
16
|
+
"description": "The icon shown at the start of the item, either the name of an SDS icon or an element of your own. Only icons that come in a small size can be named here.",
|
|
17
|
+
"isRequired": false,
|
|
18
|
+
"type": "IconName | ReactElement"
|
|
17
19
|
},
|
|
18
20
|
"isMultiSelect": {
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
+
"defaultValue": false,
|
|
22
|
+
"description": "When true, designates that the menu item supports multi-select functionality.",
|
|
23
|
+
"isRequired": false,
|
|
24
|
+
"type": "boolean"
|
|
21
25
|
},
|
|
22
26
|
"sdsIconProps": {
|
|
23
|
-
"
|
|
24
|
-
"isRequired": false
|
|
27
|
+
"description": "Enables you to pass additional props to customize the SDS icon within the menu item.",
|
|
28
|
+
"isRequired": false,
|
|
29
|
+
"type": "function"
|
|
25
30
|
},
|
|
26
31
|
"sdsStyle": {
|
|
27
|
-
"
|
|
28
|
-
"
|
|
32
|
+
"defaultValue": "determinate",
|
|
33
|
+
"description": "Determines the style of the menu item, whether it is determinate or indeterminate.",
|
|
34
|
+
"isRequired": false,
|
|
35
|
+
"type": "\"indeterminate\" | \"determinate\""
|
|
29
36
|
},
|
|
30
37
|
"sdsType": {
|
|
31
|
-
"
|
|
32
|
-
"
|
|
38
|
+
"defaultValue": "default",
|
|
39
|
+
"description": "An \"action\" item leaves out the selection mark at its start, for a menu whose items run a command rather than choose a value.",
|
|
40
|
+
"isRequired": false,
|
|
41
|
+
"type": "\"action\" | \"default\""
|
|
33
42
|
},
|
|
34
43
|
"selected": {
|
|
35
|
-
"
|
|
36
|
-
"isRequired": false,
|
|
44
|
+
"defaultValue": false,
|
|
37
45
|
"description": "If `true`, the component is selected.",
|
|
38
|
-
"
|
|
46
|
+
"isRequired": false,
|
|
47
|
+
"type": "boolean"
|
|
48
|
+
},
|
|
49
|
+
"children": {
|
|
50
|
+
"description": "The content of the component.",
|
|
51
|
+
"isRequired": false,
|
|
52
|
+
"type": "ReactNode"
|
|
53
|
+
},
|
|
54
|
+
"sdsIcon": {
|
|
55
|
+
"description": "@deprecated Use `icon` instead.\n(masoudmanson): This prop is deprecated and will be removed in the next major version.\nPlease replace instances of `sdsIcon` with `icon`.",
|
|
56
|
+
"isRequired": false,
|
|
57
|
+
"type": "IconName | ReactElement"
|
|
39
58
|
}
|
|
40
59
|
}
|
|
41
60
|
}
|
|
42
|
-
}
|
|
61
|
+
}
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
"MenuSelect": {
|
|
3
3
|
"props": {
|
|
4
4
|
"keepSearchOnSelect": {
|
|
5
|
-
"
|
|
6
|
-
"
|
|
5
|
+
"isRequired": false,
|
|
6
|
+
"type": "boolean"
|
|
7
7
|
},
|
|
8
8
|
"multiple": {
|
|
9
|
-
"
|
|
10
|
-
"isRequired": false,
|
|
9
|
+
"defaultValue": false,
|
|
11
10
|
"description": "If `true`, `value` must be an array and the menu will support multiple selections.",
|
|
12
|
-
"
|
|
11
|
+
"isRequired": false,
|
|
12
|
+
"type": "boolean"
|
|
13
13
|
},
|
|
14
14
|
"search": {
|
|
15
|
-
"
|
|
16
|
-
"
|
|
15
|
+
"isRequired": false,
|
|
16
|
+
"type": "boolean"
|
|
17
17
|
}
|
|
18
18
|
}
|
|
19
19
|
}
|
|
20
|
-
}
|
|
20
|
+
}
|
|
@@ -2,42 +2,72 @@
|
|
|
2
2
|
"NavigationFooter": {
|
|
3
3
|
"props": {
|
|
4
4
|
"backgroundAppearance": {
|
|
5
|
-
"
|
|
5
|
+
"defaultValue": "matchBackground",
|
|
6
|
+
"description": "\"dark\" puts the footer on a dark surface and inverts its text and dividers, in light mode only.",
|
|
6
7
|
"isRequired": false,
|
|
7
|
-
"
|
|
8
|
+
"type": "\"matchBackground\" | \"dark\""
|
|
8
9
|
},
|
|
9
10
|
"images": {
|
|
10
|
-
"
|
|
11
|
-
"isRequired": false
|
|
11
|
+
"description": "An array of images displayed in the footer. Each item includes an image, optional link URL, and component.",
|
|
12
|
+
"isRequired": false,
|
|
13
|
+
"type": "FooterImage[]"
|
|
12
14
|
},
|
|
13
15
|
"logo": {
|
|
14
|
-
"
|
|
15
|
-
"isRequired": false
|
|
16
|
+
"description": "The logo displayed in the footer. Can be any valid React node such as an image, icon, or SVG.",
|
|
17
|
+
"isRequired": false,
|
|
18
|
+
"type": "ReactNode"
|
|
16
19
|
},
|
|
17
20
|
"logoUrl": {
|
|
18
|
-
"
|
|
19
|
-
"isRequired": false
|
|
21
|
+
"description": "If provided, clicking the logo will navigate to this URL.",
|
|
22
|
+
"isRequired": false,
|
|
23
|
+
"type": "string"
|
|
20
24
|
},
|
|
21
25
|
"navItems": {
|
|
22
|
-
"
|
|
23
|
-
"isRequired": false
|
|
26
|
+
"description": "The prominent links on the top row, next to the logo. They are headings, not body text, and get no dividers.",
|
|
27
|
+
"isRequired": false,
|
|
28
|
+
"type": "NavigationFooterNavItem[]"
|
|
24
29
|
},
|
|
25
30
|
"navLinks": {
|
|
26
|
-
"
|
|
27
|
-
"isRequired": false
|
|
31
|
+
"description": "The smaller links on the bottom row, drawn in one line with dividers between them.",
|
|
32
|
+
"isRequired": false,
|
|
33
|
+
"type": "NavigationFooterNavItem[]"
|
|
28
34
|
},
|
|
29
35
|
"tag": {
|
|
30
|
-
"
|
|
31
|
-
"isRequired": false
|
|
36
|
+
"description": "A small label displayed next to the title.",
|
|
37
|
+
"isRequired": false,
|
|
38
|
+
"type": "string"
|
|
32
39
|
},
|
|
33
40
|
"tagColor": {
|
|
34
|
-
"
|
|
35
|
-
"isRequired": false
|
|
41
|
+
"description": "The Tag's color. A tuple sets the label, background, and icon colors by hand.",
|
|
42
|
+
"isRequired": false,
|
|
43
|
+
"type": "\"info\" | \"negative\" | \"notice\" | \"positive\" | \"neutral\" | \"beta\" | [string, string] | [string, string, string]"
|
|
36
44
|
},
|
|
37
45
|
"title": {
|
|
38
|
-
"
|
|
39
|
-
"isRequired": false
|
|
46
|
+
"description": "The main title displayed in the footer.",
|
|
47
|
+
"isRequired": false,
|
|
48
|
+
"type": "string"
|
|
49
|
+
},
|
|
50
|
+
"logoComponent": {
|
|
51
|
+
"defaultValue": "a",
|
|
52
|
+
"description": "Specifies the component to use for the logo link. Defaults to an anchor tag.",
|
|
53
|
+
"isRequired": false,
|
|
54
|
+
"type": "\"symbol\" | \"object\" | \"style\" | \"button\" | \"div\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"big\" | \"blockquote\" | \"body\" | \"br\" | \"canvas\" | \"caption\" | \"center\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"head\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"link\" | \"main\" | \"map\" | \"mark\" | \"menu\" | \"menuitem\" | \"meta\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"search\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"small\" | \"source\" | \"span\" | \"strong\" | \"sub\" | \"summary\" | \"sup\" | \"table\" | \"template\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"title\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"desc\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"filter\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"set\" | \"stop\" | \"switch\" | \"text\" | \"textPath\" | \"tspan\" | \"use\" | \"view\" | ComponentClass<any, any> | FunctionComponent<any>"
|
|
55
|
+
},
|
|
56
|
+
"logoLinkProps": {
|
|
57
|
+
"description": "Additional props passed to the logo link component.",
|
|
58
|
+
"isRequired": false,
|
|
59
|
+
"type": "Record<string, unknown>"
|
|
60
|
+
},
|
|
61
|
+
"image": {
|
|
62
|
+
"description": "The image element to be displayed. Can be an icon, image, SVG, or any ReactNode.",
|
|
63
|
+
"isRequired": false,
|
|
64
|
+
"type": "ReactNode"
|
|
65
|
+
},
|
|
66
|
+
"label": {
|
|
67
|
+
"description": "The text label displayed for the navigation item.",
|
|
68
|
+
"isRequired": false,
|
|
69
|
+
"type": "string"
|
|
40
70
|
}
|
|
41
71
|
}
|
|
42
72
|
}
|
|
43
|
-
}
|
|
73
|
+
}
|
|
@@ -2,77 +2,190 @@
|
|
|
2
2
|
"NavigationHeader": {
|
|
3
3
|
"props": {
|
|
4
4
|
"buttons": {
|
|
5
|
-
"
|
|
6
|
-
"isRequired": false
|
|
5
|
+
"description": "Actions at the right end of the bar. Prop objects render as SDS Buttons; elements are cloned with the header's appearance applied. An icon-only button gets an aria-label from its child, and in the narrow layout every button goes full width and closes the drawer when clicked.",
|
|
6
|
+
"isRequired": false,
|
|
7
|
+
"type": "ReactNode"
|
|
7
8
|
},
|
|
8
9
|
"menuProps": {
|
|
9
|
-
"
|
|
10
|
-
"
|
|
10
|
+
"defaultValue": "{ disableScrollLock: true, disablePortal: true }",
|
|
11
|
+
"description": "Props for the dropdown menus. Passing this replaces the default object rather than merging with it.",
|
|
12
|
+
"isRequired": false,
|
|
13
|
+
"type": "Partial<MenuProps>"
|
|
11
14
|
},
|
|
12
15
|
"backgroundAppearance": {
|
|
13
|
-
"
|
|
14
|
-
"
|
|
16
|
+
"defaultValue": "matchBackground",
|
|
17
|
+
"description": "\"dark\" puts the header on a dark surface and inverts its contents. It only changes anything in light mode.",
|
|
18
|
+
"isRequired": false,
|
|
19
|
+
"type": "\"matchBackground\" | \"dark\""
|
|
15
20
|
},
|
|
16
21
|
"logo": {
|
|
17
|
-
"
|
|
18
|
-
"isRequired": false
|
|
22
|
+
"description": "The logo displayed in the header. Can be an image, icon, svg or any ReactNode.",
|
|
23
|
+
"isRequired": false,
|
|
24
|
+
"type": "ReactNode"
|
|
19
25
|
},
|
|
20
26
|
"logoLinkComponent": {
|
|
21
|
-
"
|
|
22
|
-
"
|
|
27
|
+
"defaultValue": "a",
|
|
28
|
+
"description": "Specifies the component to use for the logo link.",
|
|
29
|
+
"isRequired": false,
|
|
30
|
+
"type": "\"symbol\" | \"object\" | \"style\" | \"button\" | \"div\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"big\" | \"blockquote\" | \"body\" | \"br\" | \"canvas\" | \"caption\" | \"center\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"head\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"link\" | \"main\" | \"map\" | \"mark\" | \"menu\" | \"menuitem\" | \"meta\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"search\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"small\" | \"source\" | \"span\" | \"strong\" | \"sub\" | \"summary\" | \"sup\" | \"table\" | \"template\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"title\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"desc\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"filter\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"set\" | \"stop\" | \"switch\" | \"text\" | \"textPath\" | \"tspan\" | \"use\" | \"view\" | ComponentClass<any, any> | FunctionComponent<any>"
|
|
23
31
|
},
|
|
24
32
|
"logoUrl": {
|
|
25
|
-
"
|
|
26
|
-
"isRequired": false
|
|
33
|
+
"description": "URL for the logo link. If provided, clicking the logo navigates to this URL.",
|
|
34
|
+
"isRequired": false,
|
|
35
|
+
"type": "string"
|
|
27
36
|
},
|
|
28
37
|
"isSticky": {
|
|
29
|
-
"
|
|
30
|
-
"
|
|
38
|
+
"defaultValue": true,
|
|
39
|
+
"description": "Whether the header sticks to the top on scroll. Ignored when sdsStyle is \"drawer\", which is always sticky, and best left alone alongside topComponentSlot.",
|
|
40
|
+
"isRequired": false,
|
|
41
|
+
"type": "boolean"
|
|
31
42
|
},
|
|
32
43
|
"topComponentSlot": {
|
|
33
|
-
"
|
|
34
|
-
"isRequired": false
|
|
44
|
+
"description": "Content rendered above the header, such as a Banner. The header measures it and offsets its own sticky top to match.",
|
|
45
|
+
"isRequired": false,
|
|
46
|
+
"type": "ReactNode"
|
|
35
47
|
},
|
|
36
48
|
"primaryNavItems": {
|
|
37
|
-
"
|
|
38
|
-
"isRequired": false
|
|
49
|
+
"description": "List of items for the primary navigation section.",
|
|
50
|
+
"isRequired": false,
|
|
51
|
+
"type": "NavigationHeaderPrimaryNavItem<string>[]"
|
|
39
52
|
},
|
|
40
53
|
"primaryNavPosition": {
|
|
41
|
-
"
|
|
42
|
-
"
|
|
54
|
+
"defaultValue": "left",
|
|
55
|
+
"description": "Position of the primaryNavItems list. If set to \"left\", the items appear to the left of the search bar. If set to \"right\", they are positioned next to the secondaryNavItems on the right.",
|
|
56
|
+
"isRequired": false,
|
|
57
|
+
"type": "\"left\" | \"right\""
|
|
43
58
|
},
|
|
44
59
|
"sdsStyle": {
|
|
45
|
-
"
|
|
46
|
-
"
|
|
60
|
+
"defaultValue": "dropdown",
|
|
61
|
+
"description": "How dropdown nav items open, and which parts of their data are used. See the comparison above.",
|
|
62
|
+
"isRequired": false,
|
|
63
|
+
"type": "\"dropdown\" | \"drawer\""
|
|
47
64
|
},
|
|
48
65
|
"scrollElevation": {
|
|
49
|
-
"
|
|
50
|
-
"
|
|
66
|
+
"defaultValue": true,
|
|
67
|
+
"description": "Controls whether a shadow is shown under the Nav when scrolling.",
|
|
68
|
+
"isRequired": false,
|
|
69
|
+
"type": "boolean"
|
|
51
70
|
},
|
|
52
71
|
"searchProps": {
|
|
53
|
-
"
|
|
54
|
-
"isRequired": false
|
|
72
|
+
"description": "Props passed to the search input component.",
|
|
73
|
+
"isRequired": false,
|
|
74
|
+
"type": "Partial<OutlinedTextFieldProps & AccessibleInputSearchProps & InputSearchExtraProps> | Partial<StandardTextFieldProps & AccessibleInputSearchProps & InputSearchExtraProps> | Partial<FilledTextFieldProps & AccessibleInputSearchProps & InputSearchExtraProps>"
|
|
55
75
|
},
|
|
56
76
|
"secondaryNavItems": {
|
|
57
|
-
"
|
|
58
|
-
"isRequired": false
|
|
77
|
+
"description": "List of items for the secondary navigation section.",
|
|
78
|
+
"isRequired": false,
|
|
79
|
+
"type": "NavigationHeaderSecondaryNavItem<string>[]"
|
|
59
80
|
},
|
|
60
81
|
"showSearch": {
|
|
61
|
-
"
|
|
62
|
-
"
|
|
82
|
+
"defaultValue": true,
|
|
83
|
+
"description": "Whether to display the search input in the header.",
|
|
84
|
+
"isRequired": false,
|
|
85
|
+
"type": "boolean"
|
|
63
86
|
},
|
|
64
87
|
"tag": {
|
|
65
|
-
"
|
|
66
|
-
"isRequired": false
|
|
88
|
+
"description": "A small label displayed next to the title.",
|
|
89
|
+
"isRequired": false,
|
|
90
|
+
"type": "string"
|
|
67
91
|
},
|
|
68
92
|
"tagColor": {
|
|
69
|
-
"
|
|
70
|
-
"
|
|
93
|
+
"defaultValue": "neutral",
|
|
94
|
+
"description": "The color of the tag label.",
|
|
95
|
+
"isRequired": false,
|
|
96
|
+
"type": "\"info\" | \"negative\" | \"notice\" | \"positive\" | \"neutral\" | \"beta\" | [string, string] | [string, string, string]"
|
|
71
97
|
},
|
|
72
98
|
"title": {
|
|
73
|
-
"
|
|
74
|
-
"isRequired": false
|
|
99
|
+
"description": "The main title displayed in the header.",
|
|
100
|
+
"isRequired": false,
|
|
101
|
+
"type": "string"
|
|
102
|
+
},
|
|
103
|
+
"activePrimaryNavKey": {
|
|
104
|
+
"description": "The key of the active primary item. Optional, since the header tracks this itself; when given, it overrides the internal value.",
|
|
105
|
+
"isRequired": false,
|
|
106
|
+
"type": "string"
|
|
107
|
+
},
|
|
108
|
+
"setActivePrimaryNavKey": {
|
|
109
|
+
"description": "Called when a primary item becomes active. The header updates its internal key as well, so this is a notification rather than the only way the value changes.",
|
|
110
|
+
"isRequired": false,
|
|
111
|
+
"type": "(key: string) => void"
|
|
112
|
+
},
|
|
113
|
+
"drawerOpen": {
|
|
114
|
+
"description": "Controls the narrow layout's drawer. Leave both this and setDrawerOpen out to let the hamburger manage it.",
|
|
115
|
+
"isRequired": false,
|
|
116
|
+
"type": "boolean"
|
|
117
|
+
},
|
|
118
|
+
"setDrawerOpen": {
|
|
119
|
+
"description": "Replaces the drawer's internal state update, so it has to be paired with drawerOpen or the drawer stops opening.",
|
|
120
|
+
"isRequired": false,
|
|
121
|
+
"type": "(open: boolean) => void"
|
|
122
|
+
},
|
|
123
|
+
"onDrawerStyleNavItemHover": {
|
|
124
|
+
"description": "(item: NavigationHeaderPrimaryNavItem<T> | NavigationHeaderSecondaryNavItem) => void. Called with the hovered primary or secondary item while sdsStyle is \"drawer\". Useful for prefetching what the panel will show.",
|
|
125
|
+
"isRequired": false,
|
|
126
|
+
"type": "(item: NavigationHeaderPrimaryNavItem<string> | NavigationHeaderSecondaryNavItem<string>) => void"
|
|
127
|
+
},
|
|
128
|
+
"logoLinkProps": {
|
|
129
|
+
"description": "Props to pass to the logo link component.",
|
|
130
|
+
"isRequired": false,
|
|
131
|
+
"type": "LinkProps"
|
|
132
|
+
},
|
|
133
|
+
"label": {
|
|
134
|
+
"description": "The row's text.",
|
|
135
|
+
"isRequired": false,
|
|
136
|
+
"type": "ReactNode"
|
|
137
|
+
},
|
|
138
|
+
"details": {
|
|
139
|
+
"description": "A caption under the label, drawn only when sdsStyle is \"drawer\". In dropdown style it lands on the element as an attribute and shows nothing.",
|
|
140
|
+
"isRequired": false,
|
|
141
|
+
"type": "string"
|
|
142
|
+
},
|
|
143
|
+
"icon": {
|
|
144
|
+
"description": "An icon for the row, drawn only when sdsStyle is \"drawer\". A named icon renders at 24px when the row has details and 16px when it does not, so the name has to offer that size.",
|
|
145
|
+
"isRequired": false,
|
|
146
|
+
"type": "keyof IconNameToSizes | ReactElement"
|
|
147
|
+
},
|
|
148
|
+
"section": {
|
|
149
|
+
"description": "Groups rows under a heading. Rows are grouped by this value in the order the sections first appear.",
|
|
150
|
+
"isRequired": false,
|
|
151
|
+
"type": "string"
|
|
152
|
+
},
|
|
153
|
+
"onClick": {
|
|
154
|
+
"description": "Runs on click, then the menu closes.",
|
|
155
|
+
"isRequired": false,
|
|
156
|
+
"type": "function"
|
|
157
|
+
},
|
|
158
|
+
"href": {
|
|
159
|
+
"description": "Turns the row into a link to this URL.",
|
|
160
|
+
"isRequired": false,
|
|
161
|
+
"type": "string"
|
|
162
|
+
},
|
|
163
|
+
"component": {
|
|
164
|
+
"description": "What the link renders as, for routing through something other than an anchor.",
|
|
165
|
+
"isRequired": false,
|
|
166
|
+
"type": "\"symbol\" | \"object\" | \"style\" | \"button\" | \"div\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"big\" | \"blockquote\" | \"body\" | \"br\" | \"canvas\" | \"caption\" | \"center\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"head\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"link\" | \"main\" | \"map\" | \"mark\" | \"menu\" | \"menuitem\" | \"meta\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"search\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"small\" | \"source\" | \"span\" | \"strong\" | \"sub\" | \"summary\" | \"sup\" | \"table\" | \"template\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"title\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"desc\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"filter\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"set\" | \"stop\" | \"switch\" | \"text\" | \"textPath\" | \"tspan\" | \"use\" | \"view\" | ComponentClass<any, any> | FunctionComponent<any>"
|
|
167
|
+
},
|
|
168
|
+
"target": {
|
|
169
|
+
"description": "Where the link opens, for example \"_blank\".",
|
|
170
|
+
"isRequired": false,
|
|
171
|
+
"type": "string"
|
|
172
|
+
},
|
|
173
|
+
"rel": {
|
|
174
|
+
"description": "The link's relationship to the target, for example \"noreferrer\".",
|
|
175
|
+
"isRequired": false,
|
|
176
|
+
"type": "string"
|
|
177
|
+
},
|
|
178
|
+
"actions": {
|
|
179
|
+
"description": "Links rendered under the section, for example a \"Browse all\". Each takes label plus href, onClick, component, target, and rel.",
|
|
180
|
+
"isRequired": false,
|
|
181
|
+
"type": "ActionItem[]"
|
|
182
|
+
},
|
|
183
|
+
"colSpan": {
|
|
184
|
+
"defaultValue": 1,
|
|
185
|
+
"description": "How many columns of the panel this section occupies.",
|
|
186
|
+
"isRequired": false,
|
|
187
|
+
"type": "number"
|
|
75
188
|
}
|
|
76
189
|
}
|
|
77
190
|
}
|
|
78
|
-
}
|
|
191
|
+
}
|
|
@@ -2,17 +2,43 @@
|
|
|
2
2
|
"NavigationJumpTo": {
|
|
3
3
|
"props": {
|
|
4
4
|
"items": {
|
|
5
|
-
"
|
|
6
|
-
"
|
|
5
|
+
"defaultValue": "- (required)",
|
|
6
|
+
"description": "The sections to list. See the shape below.",
|
|
7
|
+
"isRequired": true,
|
|
8
|
+
"type": "Item[]"
|
|
7
9
|
},
|
|
8
10
|
"offsetTop": {
|
|
9
|
-
"
|
|
10
|
-
"
|
|
11
|
+
"defaultValue": 0,
|
|
12
|
+
"description": "How many pixels above a section the highlight should switch to it, which is what you want when a sticky header covers the top of the page. Any non-zero value also switches clicks to window scrolling by element id.",
|
|
13
|
+
"isRequired": false,
|
|
14
|
+
"type": "number"
|
|
11
15
|
},
|
|
12
16
|
"width": {
|
|
13
|
-
"
|
|
14
|
-
"
|
|
17
|
+
"defaultValue": "100%",
|
|
18
|
+
"description": "The width of the strip and of every item in it. Long titles wrap rather than truncate.",
|
|
19
|
+
"isRequired": false,
|
|
20
|
+
"type": "string | number | string & {}"
|
|
21
|
+
},
|
|
22
|
+
"onChange": {
|
|
23
|
+
"description": "(value: number, event?: React.SyntheticEvent, type?: \"click\" | \"scroll\") => void. Called when the highlighted item changes, with its index and what caused the change. For a scroll the event is synthesized, not a real DOM event.",
|
|
24
|
+
"isRequired": false,
|
|
25
|
+
"type": "(value: number, event?: SyntheticEvent<Element, Event> | undefined, type?: \"scroll\" | \"click\" | undefined) => void"
|
|
26
|
+
},
|
|
27
|
+
"title": {
|
|
28
|
+
"description": "The item's label. It is also kebab-cased into the tab's id, so keep titles distinct.",
|
|
29
|
+
"isRequired": false,
|
|
30
|
+
"type": "string"
|
|
31
|
+
},
|
|
32
|
+
"elementRef": {
|
|
33
|
+
"description": "A ref on the section this item points at. The component observes and scrolls whatever the ref holds.",
|
|
34
|
+
"isRequired": false,
|
|
35
|
+
"type": "MutableRefObject<HTMLElement | null>"
|
|
36
|
+
},
|
|
37
|
+
"subItems": {
|
|
38
|
+
"description": "Indented children, one level only. Sub-items cannot nest sub-items of their own.",
|
|
39
|
+
"isRequired": false,
|
|
40
|
+
"type": "{ title, elementRef }[]"
|
|
15
41
|
}
|
|
16
42
|
}
|
|
17
43
|
}
|
|
18
|
-
}
|
|
44
|
+
}
|
|
@@ -2,44 +2,62 @@
|
|
|
2
2
|
"Notification": {
|
|
3
3
|
"props": {
|
|
4
4
|
"autoDismiss": {
|
|
5
|
-
"
|
|
6
|
-
"isRequired": false
|
|
5
|
+
"description": "Dismisses the Notification on a timer. A number sets the delay in milliseconds, and true uses 8000. Leave it unset to keep the Notification visible until it is dismissed another way.",
|
|
6
|
+
"isRequired": false,
|
|
7
|
+
"type": "number | false | true"
|
|
7
8
|
},
|
|
8
9
|
"buttonOnClick": {
|
|
9
|
-
"
|
|
10
|
-
"isRequired": false
|
|
10
|
+
"description": "Callback fired when the action button is clicked. Passing it is what renders the button, and the Notification does nothing else in response, so dismissing it is up to this handler.",
|
|
11
|
+
"isRequired": false,
|
|
12
|
+
"type": "(event: SyntheticEvent<Element, Event>) => void"
|
|
11
13
|
},
|
|
12
14
|
"buttonPosition": {
|
|
13
|
-
"
|
|
14
|
-
"
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
"type": "\"false\" | \"true\"",
|
|
18
|
-
"isRequired": false
|
|
15
|
+
"defaultValue": "right",
|
|
16
|
+
"description": "Which side of the Notification the action button sits on.",
|
|
17
|
+
"isRequired": false,
|
|
18
|
+
"type": "\"left\" | \"right\""
|
|
19
19
|
},
|
|
20
20
|
"icon": {
|
|
21
|
-
"
|
|
21
|
+
"description": "Override the icon displayed before the children.\nUnless provided, the icon is mapped to the value of the `severity` prop.\nSet to `false` to remove the `icon`.",
|
|
22
22
|
"isRequired": false,
|
|
23
|
-
"
|
|
23
|
+
"type": "ReactNode"
|
|
24
24
|
},
|
|
25
25
|
"intent": {
|
|
26
|
-
"
|
|
27
|
-
"isRequired": true
|
|
26
|
+
"description": "Required. Sets both the color of the component and the icon it defaults to.",
|
|
27
|
+
"isRequired": true,
|
|
28
|
+
"type": "\"info\" | \"accent\" | \"negative\" | \"notice\" | \"positive\""
|
|
28
29
|
},
|
|
29
30
|
"onClose": {
|
|
30
|
-
"
|
|
31
|
+
"description": "Callback fired when the component requests to be closed.\nWhen provided and no `action` prop is set, a close icon button is displayed that triggers the callback when clicked.\n@param event The event source of the callback.",
|
|
31
32
|
"isRequired": false,
|
|
32
|
-
"
|
|
33
|
+
"type": "(event: SyntheticEvent<Element, Event>) => void"
|
|
33
34
|
},
|
|
34
35
|
"sdsIconProps": {
|
|
35
|
-
"
|
|
36
|
-
"isRequired": false
|
|
36
|
+
"description": "Props forwarded to the Icon component when icon is given as a name.",
|
|
37
|
+
"isRequired": false,
|
|
38
|
+
"type": "Partial<IconProps>"
|
|
37
39
|
},
|
|
38
40
|
"slideDirection": {
|
|
39
|
-
"
|
|
41
|
+
"defaultValue": "left",
|
|
42
|
+
"description": "Required. The side the Notification slides in from and back out towards. The component falls back to \"left\", but the prop is not optional, so pass it explicitly.",
|
|
43
|
+
"isRequired": false,
|
|
44
|
+
"type": "\"left\" | \"right\""
|
|
45
|
+
},
|
|
46
|
+
"children": {
|
|
47
|
+
"description": "The content of the component.",
|
|
48
|
+
"isRequired": false,
|
|
49
|
+
"type": "ReactNode"
|
|
50
|
+
},
|
|
51
|
+
"dismissed": {
|
|
52
|
+
"description": "Hides the Notification when set to true. Changing it back to false brings the Notification back, which is how a dismissed Notification is restored.",
|
|
53
|
+
"isRequired": false,
|
|
54
|
+
"type": "boolean"
|
|
55
|
+
},
|
|
56
|
+
"buttonText": {
|
|
57
|
+
"description": "The label of the action button shown beneath the content. It only renders alongside buttonOnClick.",
|
|
40
58
|
"isRequired": false,
|
|
41
|
-
"
|
|
59
|
+
"type": "string"
|
|
42
60
|
}
|
|
43
61
|
}
|
|
44
62
|
}
|
|
45
|
-
}
|
|
63
|
+
}
|