common-intellisense
Version:
310 lines (309 loc) • 13.6 kB
JSON
[
{
"name": "Tooltip.Root",
"props": {
"openDelay": {
"value": "",
"default": "700",
"type": "number",
"description": "The amount of time in milliseconds to delay opening the tooltip when hovering over the trigger.",
"description_zh": "The amount of time in milliseconds to delay opening the tooltip when hovering over the trigger."
},
"closeDelay": {
"value": "",
"default": "300",
"type": "number",
"description": "The amount of time in milliseconds to delay closing the tooltip when the mouse leaves the trigger.",
"description_zh": "The amount of time in milliseconds to delay closing the tooltip when the mouse leaves the trigger."
},
"closeOnEscape": {
"value": "",
"default": "true",
"type": "boolean",
"description": "Whether or not to close the tooltip when pressing the escape key.",
"description_zh": "Whether or not to close the tooltip when pressing the escape key."
},
"closeOnPointerDown": {
"value": "",
"default": "true",
"type": "boolean",
"description": "Whether or not to close the tooltip when clicking outside of the tooltip.",
"description_zh": "Whether or not to close the tooltip when clicking outside of the tooltip."
},
"disableHoverableContent": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether or not to disable the hoverable content. This is useful when the content contains interactive elements.",
"description_zh": "Whether or not to disable the hoverable content. This is useful when the content contains interactive elements."
},
"group": {
"value": "",
"default": "_",
"type": "string",
"description": "The group the tooltip belongs to.",
"description_zh": "The group the tooltip belongs to."
},
"open": {
"value": "",
"default": "false",
"type": "boolean",
"description": "The open state of the tooltip component.",
"description_zh": "The open state of the tooltip component."
},
"onOpenChange": {
"value": "",
"default": "_",
"type": "function",
"description": "A callback that fires when the open state changes.",
"description_zh": "A callback that fires when the open state changes."
},
"portal": {
"value": "",
"default": "_",
"type": "union",
"description": "Where to render the tooltip when it is open. Defaults to the body. Can be disabled by passing null",
"description_zh": "Where to render the tooltip when it is open. Defaults to the body. Can be disabled by passing null"
}
},
"description": "The root component containing the parts of the tooltip.",
"link": "https://www.bits-ui.com/docs/components/tooltip",
"link_zh": "https://www.bits-ui.com/docs/components/tooltip",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "ids",
"description": "The ids of the elements within the component, useful when you don't necessarily want to provide a custom ID, but still want access to the ID being assigned (if any). ",
"description_zh": "The ids of the elements within the component, useful when you don't necessarily want to provide a custom ID, but still want access to the ID being assigned (if any). "
}
],
"filename": "TooltipRoot"
},
{
"name": "Tooltip.Trigger",
"props": {
"asChild": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether to use render delegation with this component or not.",
"description_zh": "Whether to use render delegation with this component or not."
},
"el": {
"value": "",
"default": "_",
"type": "HTMLButtonElement",
"description": "The underlying DOM element being rendered. You can bind to this to programatically interact with the element.",
"description_zh": "The underlying DOM element being rendered. You can bind to this to programatically interact with the element."
}
},
"description": "A component which triggers the opening and closing of the tooltip on hover or focus.",
"link": "https://www.bits-ui.com/docs/components/tooltip",
"link_zh": "https://www.bits-ui.com/docs/components/tooltip",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "builder",
"description": "The builder attributes and actions to apply to the element if using the asChild prop with delegation. ",
"description_zh": "The builder attributes and actions to apply to the element if using the asChild prop with delegation. "
}
],
"filename": "TooltipTrigger"
},
{
"name": "Tooltip.Content",
"props": {
"transition": {
"value": "",
"default": "_",
"type": "function",
"description": "A Svelte transition function to use when transitioning the content in and out.",
"description_zh": "A Svelte transition function to use when transitioning the content in and out."
},
"transitionConfig": {
"value": "",
"default": "_",
"type": "TransitionConfig",
"description": "The configuration to apply to the transition.",
"description_zh": "The configuration to apply to the transition."
},
"inTransition": {
"value": "",
"default": "_",
"type": "function",
"description": "A Svelte transition function to use when transitioning the content in and out.",
"description_zh": "A Svelte transition function to use when transitioning the content in and out."
},
"inTransitionConfig": {
"value": "",
"default": "_",
"type": "TransitionConfig",
"description": "The configuration to apply to the transition.",
"description_zh": "The configuration to apply to the transition."
},
"outTransition": {
"value": "",
"default": "_",
"type": "function",
"description": "A Svelte transition function to use when transitioning the content in and out.",
"description_zh": "A Svelte transition function to use when transitioning the content in and out."
},
"outTransitionConfig": {
"value": "",
"default": "_",
"type": "TransitionConfig",
"description": "The configuration to apply to the transition.",
"description_zh": "The configuration to apply to the transition."
},
"side": {
"value": "",
"default": "_",
"type": "enum",
"description": "The preferred side of the anchor to render against when open. Will be reversed when collisions occur. Floating UI reference.",
"description_zh": "The preferred side of the anchor to render against when open. Will be reversed when collisions occur. Floating UI reference."
},
"sideOffset": {
"value": "",
"default": "0",
"type": "number",
"description": "The amount of offset to apply to the menu's position on the x-axis. Floating UI reference.",
"description_zh": "The amount of offset to apply to the menu's position on the x-axis. Floating UI reference."
},
"align": {
"value": "",
"default": "_",
"type": "enum",
"description": "The preferred alignment of the anchor to render against when open. Floating UI reference.",
"description_zh": "The preferred alignment of the anchor to render against when open. Floating UI reference."
},
"alignOffset": {
"value": "",
"default": "0",
"type": "number",
"description": "An offset in pixels from the 'start' or 'end' alignment options. Floating UI reference.",
"description_zh": "An offset in pixels from the 'start' or 'end' alignment options. Floating UI reference."
},
"avoidCollisions": {
"value": "",
"default": "true",
"type": "boolean",
"description": "When true, overrides the side and align options to prevent collisions with the boundary edges. Floating UI reference.",
"description_zh": "When true, overrides the side and align options to prevent collisions with the boundary edges. Floating UI reference."
},
"collisionBoundary": {
"value": "",
"default": "_",
"type": "union",
"description": "A boundary element or array of elements to check for collisions against. Floating UI reference.",
"description_zh": "A boundary element or array of elements to check for collisions against. Floating UI reference."
},
"collisionPadding": {
"value": "",
"default": "0",
"type": "number",
"description": "The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision. Floating UI reference.",
"description_zh": "The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision. Floating UI reference."
},
"fitViewport": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether the floating element should be constrained to the viewport. Floating UI reference.",
"description_zh": "Whether the floating element should be constrained to the viewport. Floating UI reference."
},
"sameWidth": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether the content should be the same width as the trigger. Floating UI reference.",
"description_zh": "Whether the content should be the same width as the trigger. Floating UI reference."
},
"strategy": {
"value": "",
"default": "absolute",
"type": "enum",
"description": "The positioning strategy to use for the floating element. Floating UI reference.",
"description_zh": "The positioning strategy to use for the floating element. Floating UI reference."
},
"overlap": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether the floating element can overlap the reference element. Floating UI reference.",
"description_zh": "Whether the floating element can overlap the reference element. Floating UI reference."
},
"asChild": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether to use render delegation with this component or not.",
"description_zh": "Whether to use render delegation with this component or not."
},
"el": {
"value": "",
"default": "_",
"type": "HTMLDivElement",
"description": "The underlying DOM element being rendered. You can bind to this to programatically interact with the element.",
"description_zh": "The underlying DOM element being rendered. You can bind to this to programatically interact with the element."
}
},
"description": "The contents of the tooltip which are displayed when the tooltip is open.",
"link": "https://www.bits-ui.com/docs/components/tooltip",
"link_zh": "https://www.bits-ui.com/docs/components/tooltip",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "builder",
"description": "The builder attributes and actions to apply to the element if using the asChild prop with delegation. ",
"description_zh": "The builder attributes and actions to apply to the element if using the asChild prop with delegation. "
}
],
"filename": "TooltipContent"
},
{
"name": "Tooltip.Arrow",
"props": {
"size": {
"value": "",
"default": "8",
"type": "number",
"description": "The height and width of the arrow in pixels.",
"description_zh": "The height and width of the arrow in pixels."
},
"asChild": {
"value": "",
"default": "false",
"type": "boolean",
"description": "Whether to use render delegation with this component or not.",
"description_zh": "Whether to use render delegation with this component or not."
},
"el": {
"value": "",
"default": "_",
"type": "HTMLDivElement",
"description": "The underlying DOM element being rendered. You can bind to this to programatically interact with the element.",
"description_zh": "The underlying DOM element being rendered. You can bind to this to programatically interact with the element."
}
},
"description": "An optional arrow element which points to the trigger when the tooltip is open.",
"link": "https://www.bits-ui.com/docs/components/tooltip",
"link_zh": "https://www.bits-ui.com/docs/components/tooltip",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "builder",
"description": "The builder attributes and actions to apply to the element if using the asChild prop with delegation. ",
"description_zh": "The builder attributes and actions to apply to the element if using the asChild prop with delegation. "
}
],
"filename": "TooltipArrow"
}
]