docs: add missing props to UI components (#13247)
This commit is contained in:
@@ -3,6 +3,57 @@
|
||||
"methods": [],
|
||||
"displayName": "Tooltip",
|
||||
"props": {
|
||||
"content": {
|
||||
"required": true,
|
||||
"tsType": {
|
||||
"name": "ReactReactNode",
|
||||
"raw": "React.ReactNode"
|
||||
},
|
||||
"description": "The content to display in the tooltip."
|
||||
},
|
||||
"onClick": {
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "ReactMouseEventHandler",
|
||||
"raw": "React.MouseEventHandler<HTMLButtonElement>",
|
||||
"elements": [
|
||||
{
|
||||
"name": "HTMLButtonElement"
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "A function that is triggered when the tooltip is clicked."
|
||||
},
|
||||
"side": {
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "union",
|
||||
"raw": "\"bottom\" | \"left\" | \"top\" | \"right\"",
|
||||
"elements": [
|
||||
{
|
||||
"name": "literal",
|
||||
"value": "\"bottom\""
|
||||
},
|
||||
{
|
||||
"name": "literal",
|
||||
"value": "\"left\""
|
||||
},
|
||||
{
|
||||
"name": "literal",
|
||||
"value": "\"top\""
|
||||
},
|
||||
{
|
||||
"name": "literal",
|
||||
"value": "\"right\""
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "The side to position the tooltip.\n\n",
|
||||
"defaultValue": {
|
||||
"value": "top",
|
||||
"computed": false
|
||||
}
|
||||
},
|
||||
"maxWidth": {
|
||||
"required": false,
|
||||
"tsType": {
|
||||
@@ -14,77 +65,59 @@
|
||||
"computed": false
|
||||
}
|
||||
},
|
||||
"aria-label": {
|
||||
"description": "A more descriptive label for accessibility purpose",
|
||||
"required": false,
|
||||
"sideOffset": {
|
||||
"defaultValue": {
|
||||
"value": "8",
|
||||
"computed": false
|
||||
},
|
||||
"description": "The distance in pixels between the tooltip and its trigger.",
|
||||
"tsType": {
|
||||
"name": "string"
|
||||
"name": "number"
|
||||
},
|
||||
"required": false
|
||||
},
|
||||
"children": {
|
||||
"description": "The element to trigger the tooltip."
|
||||
},
|
||||
"open": {
|
||||
"description": "Whether the tooltip is currently open.",
|
||||
"tsType": {
|
||||
"name": "boolean"
|
||||
}
|
||||
},
|
||||
"defaultOpen": {
|
||||
"description": "Whether the tooltip is open by default.",
|
||||
"tsType": {
|
||||
"name": "boolean"
|
||||
}
|
||||
},
|
||||
"onOpenChange": {
|
||||
"description": "A function that is called when the tooltip's open state changes.",
|
||||
"tsType": {
|
||||
"name": "signature",
|
||||
"type": "function",
|
||||
"raw": "(open: boolean) => void",
|
||||
"signature": {
|
||||
"arguments": [
|
||||
{
|
||||
"name": "open",
|
||||
"type": {
|
||||
"name": "boolean"
|
||||
},
|
||||
"rest": false
|
||||
}
|
||||
],
|
||||
"return": {
|
||||
"name": "void"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"delayDuration": {
|
||||
"description": "The duration from when the pointer enters the trigger until the tooltip gets opened. This will\noverride the prop with the same name passed to Provider.",
|
||||
"required": false,
|
||||
"description": "The time in milliseconds to delay the tooltip's appearance.",
|
||||
"tsType": {
|
||||
"name": "number"
|
||||
}
|
||||
},
|
||||
"forceMount": {
|
||||
"description": "Used to force mounting when more control is needed. Useful when\ncontrolling animation with React animation libraries.",
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "literal",
|
||||
"value": "true"
|
||||
}
|
||||
},
|
||||
"onEscapeKeyDown": {
|
||||
"description": "Event handler called when the escape key is down.\nCan be prevented.",
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "signature",
|
||||
"type": "function",
|
||||
"raw": "(event: KeyboardEvent) => void",
|
||||
"signature": {
|
||||
"arguments": [
|
||||
{
|
||||
"name": "event",
|
||||
"type": {
|
||||
"name": "KeyboardEvent",
|
||||
"elements": [],
|
||||
"raw": "KeyboardEvent"
|
||||
},
|
||||
"rest": false
|
||||
}
|
||||
],
|
||||
"return": {
|
||||
"name": "void"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"onPointerDownOutside": {
|
||||
"description": "Event handler called when the a `pointerdown` event happens outside of the `Tooltip`.\nCan be prevented.",
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "signature",
|
||||
"type": "function",
|
||||
"raw": "(event: PointerDownOutsideEvent) => void",
|
||||
"signature": {
|
||||
"arguments": [
|
||||
{
|
||||
"name": "event",
|
||||
"type": {
|
||||
"name": "PointerDownOutsideEvent",
|
||||
"elements": [],
|
||||
"raw": "PointerDownOutsideEvent"
|
||||
},
|
||||
"rest": false
|
||||
}
|
||||
],
|
||||
"return": {
|
||||
"name": "void"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"composes": [
|
||||
|
||||
Reference in New Issue
Block a user