"
+ },
+ {
+ "name": "as",
+ "type": "React.ElementType",
+ "defaultValue": "\"input\""
+ },
+ {
+ "name": "sx",
+ "type": "SystemStyleObject"
+ }
+ ],
+ "subcomponents": []
+ },
+ "timeline": {
+ "id": "timeline",
+ "name": "Timeline",
+ "status": "alpha",
+ "a11yReviewed": false,
+ "stories": [],
+ "props": [
+ {
+ "name": "clipSidebar",
+ "type": "boolean",
+ "description": "Hides the sidebar above the first Timeline.Item and below the last Timeline.Item."
+ },
+ {
+ "name": "sx",
+ "type": "SystemStyleObject"
+ }
+ ],
+ "subcomponents": [
+ {
+ "name": "Timeline.Item",
+ "props": [
{
- "name": "hidden",
- "type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
- "defaultValue": "false",
- "description": "Whether the pane is hidden."
+ "name": "condensed",
+ "type": "boolean",
+ "description": "Reduces vertical padding and removes background from an item's badge."
},
{
"name": "sx",
@@ -3938,26 +3735,26 @@
]
},
{
- "name": "SplitPageLayout.Footer",
+ "name": "Timeline.Badge",
"props": [
{
- "name": "padding",
- "type": "| 'none' | 'condensed' | 'normal'",
- "defaultValue": "'normal'",
- "description": "The amount of padding inside the footer."
- },
- {
- "name": "divider",
- "type": "| 'none' | 'line' | { narrow?: | 'none' | 'line' | 'filled' regular?: | 'none' | 'line' wide?: | 'none' | 'line' }",
- "defaultValue": "'line'",
- "description": ""
- },
+ "name": "sx",
+ "type": "SystemStyleObject"
+ }
+ ]
+ },
+ {
+ "name": "Timeline.Body",
+ "props": [
{
- "name": "hidden",
- "type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
- "defaultValue": "false",
- "description": "Whether the footer is hidden."
- },
+ "name": "sx",
+ "type": "SystemStyleObject"
+ }
+ ]
+ },
+ {
+ "name": "Timeline.Break",
+ "props": [
{
"name": "sx",
"type": "SystemStyleObject"
@@ -3966,6 +3763,77 @@
}
]
},
+ "toggle_switch": {
+ "id": "toggle_switch",
+ "name": "ToggleSwitch",
+ "status": "alpha",
+ "a11yReviewed": false,
+ "stories": [],
+ "props": [
+ {
+ "name": "aria-describedby",
+ "type": "string",
+ "defaultValue": "",
+ "description": "The id of the DOM node that describes the switch"
+ },
+ {
+ "name": "aria-labelledby",
+ "type": "string",
+ "defaultValue": "",
+ "required": true,
+ "description": "The id of the DOM node that labels the switch"
+ },
+ {
+ "name": "defaultChecked",
+ "type": "boolean",
+ "defaultValue": "",
+ "description": "Uncontrolled - whether the switch is turned on"
+ },
+ {
+ "name": "disabled",
+ "type": "boolean",
+ "defaultValue": "",
+ "description": "Whether the switch is ready for user input"
+ },
+ {
+ "name": "loading",
+ "type": "boolean",
+ "defaultValue": "",
+ "description": "Whether the switch's value is being calculated"
+ },
+ {
+ "name": "checked",
+ "type": "boolean",
+ "defaultValue": "",
+ "description": "Whether the switch is turned on"
+ },
+ {
+ "name": "onChange",
+ "type": "(on: boolean) => void",
+ "defaultValue": "",
+ "description": "The callback that is called when the switch is toggled on or off"
+ },
+ {
+ "name": "onClick",
+ "type": "(e: MouseEvent) => void",
+ "defaultValue": "",
+ "description": "The callback that is called when the switch is clicked"
+ },
+ {
+ "name": "size",
+ "type": "'small' | 'medium'",
+ "defaultValue": "'medium'",
+ "description": "Size of the switch"
+ },
+ {
+ "name": "statusLabelPosition",
+ "type": "'start' | 'end'",
+ "defaultValue": "'start'",
+ "description": "Whether the \"on\" and \"off\" labels should appear before or after the switch.
This should only be changed when the switch's alignment needs to be adjusted. For example: It needs to be left-aligned because the label appears above it and the caption appears below it.
"
+ }
+ ],
+ "subcomponents": []
+ },
"token": {
"id": "token",
"name": "Token",
@@ -4121,6 +3989,44 @@
}
]
},
+ "tooltip": {
+ "id": "tooltip",
+ "name": "Tooltip",
+ "status": "alpha",
+ "a11yReviewed": false,
+ "stories": [],
+ "props": [
+ {
+ "name": "align",
+ "type": "'left' | 'right'"
+ },
+ {
+ "name": "direction",
+ "type": "'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'nw'",
+ "description": "Sets where the tooltip renders in relation to the target."
+ },
+ {
+ "name": "noDelay",
+ "type": "boolean",
+ "description": "When set to `true`, tooltip appears without any delay."
+ },
+ {
+ "name": "aria-label",
+ "type": "string",
+ "description": "Text used in `aria-label` (for accessibility)"
+ },
+ {
+ "name": "wrap",
+ "type": "boolean",
+ "description": "Use `true` to allow text within tooltip to wrap."
+ },
+ {
+ "name": "sx",
+ "type": "SystemStyleObject"
+ }
+ ],
+ "subcomponents": []
+ },
"tree_view": {
"id": "tree_view",
"name": "TreeView",
@@ -4270,6 +4176,100 @@
}
]
},
+ "truncate": {
+ "id": "truncate",
+ "name": "Truncate",
+ "status": "alpha",
+ "a11yReviewed": false,
+ "stories": [],
+ "props": [
+ {
+ "name": "maxWidth",
+ "type": "number",
+ "defaultValue": "125",
+ "description": "Sets the max-width of the text."
+ },
+ {
+ "name": "inline",
+ "type": "boolean",
+ "defaultValue": "false",
+ "description": "Displays text as inline block and vertical aligns to the top."
+ },
+ {
+ "name": "expandable",
+ "type": "boolean",
+ "defaultValue": "false",
+ "description": "Allows the truncated text to be displayed on hover."
+ },
+ {
+ "name": "as",
+ "type": "React.ElementType",
+ "defaultValue": "'div'"
+ },
+ {
+ "name": "sx",
+ "type": "SystemStyleObject"
+ }
+ ],
+ "subcomponents": []
+ },
+ "underline_nav": {
+ "id": "underline_nav",
+ "name": "UnderlineNav",
+ "status": "alpha",
+ "a11yReviewed": false,
+ "stories": [],
+ "props": [
+ {
+ "name": "actions",
+ "type": "React.ReactNode",
+ "description": "Place another element, such as a button, to the opposite side of the navigation items."
+ },
+ {
+ "name": "align",
+ "type": "'right'",
+ "description": "Use `right` to have navigation items aligned right."
+ },
+ {
+ "name": "full",
+ "type": "boolean",
+ "description": "Used to make navigation fill the width of the container."
+ },
+ {
+ "name": "aria-label",
+ "type": "string",
+ "description": "Used to set the `aria-label` on the top level `