@spark-ui/dropdown
Version:
Displays a list of options for the user to pick from—triggered by a button. Differs from Select in that it offers multiple select and its list is not native.
1,730 lines • 98.1 kB
JSON
{
"Dropdown": {
"tags": {},
"description": "",
"displayName": "Dropdown",
"methods": [],
"props": {
"open": {
"defaultValue": null,
"description": "The controlled open state of the select. Must be used in conjunction with `onOpenChange`.",
"name": "open",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"onOpenChange": {
"defaultValue": null,
"description": "Event handler called when the open state of the select changes.",
"name": "onOpenChange",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "(isOpen: boolean) => void"
}
},
"defaultOpen": {
"defaultValue": null,
"description": "The open state of the select when it is initially rendered. Use when you do not need to control its open state.",
"name": "defaultOpen",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"state": {
"defaultValue": null,
"description": "Use `state` prop to assign a specific state to the dropdown, choosing from: `error`, `alert` and `success`. By doing so, the outline styles will be updated.",
"name": "state",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"error\" | \"alert\" | \"success\"",
"value": [
{
"value": "\"error\""
},
{
"value": "\"alert\""
},
{
"value": "\"success\""
}
]
}
},
"disabled": {
"defaultValue": null,
"description": "When true, prevents the user from interacting with the dropdown.",
"name": "disabled",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"readOnly": {
"defaultValue": null,
"description": "Sets the dropdown as interactive or not.",
"name": "readOnly",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"multiple": {
"defaultValue": {
"value": false
},
"description": "Prop 'multiple' indicating whether multiple values are allowed.",
"name": "multiple",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"defaultValue": {
"defaultValue": null,
"description": "The value of the select when initially rendered. Use when you do not need to control the state of the select.",
"name": "defaultValue",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "string | string[]"
}
},
"value": {
"defaultValue": null,
"description": "The controlled value of the select. Should be used in conjunction with `onValueChange`.",
"name": "value",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "string | string[]"
}
},
"onValueChange": {
"defaultValue": null,
"description": "Event handler called when the value changes.",
"name": "onValueChange",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "((value: string) => void) | ((value: string[]) => void)"
}
}
}
},
"DropdownProvider": {
"tags": {},
"description": "",
"displayName": "DropdownProvider",
"methods": [],
"props": {
"open": {
"defaultValue": null,
"description": "The controlled open state of the select. Must be used in conjunction with `onOpenChange`.",
"name": "open",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"onOpenChange": {
"defaultValue": null,
"description": "Event handler called when the open state of the select changes.",
"name": "onOpenChange",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "(isOpen: boolean) => void"
}
},
"defaultOpen": {
"defaultValue": null,
"description": "The open state of the select when it is initially rendered. Use when you do not need to control its open state.",
"name": "defaultOpen",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"state": {
"defaultValue": null,
"description": "Use `state` prop to assign a specific state to the dropdown, choosing from: `error`, `alert` and `success`. By doing so, the outline styles will be updated.",
"name": "state",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"error\" | \"alert\" | \"success\"",
"value": [
{
"value": "\"error\""
},
{
"value": "\"alert\""
},
{
"value": "\"success\""
}
]
}
},
"disabled": {
"defaultValue": null,
"description": "When true, prevents the user from interacting with the dropdown.",
"name": "disabled",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"readOnly": {
"defaultValue": null,
"description": "Sets the dropdown as interactive or not.",
"name": "readOnly",
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"multiple": {
"defaultValue": {
"value": false
},
"description": "Prop 'multiple' indicating whether multiple values are allowed.",
"name": "multiple",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"defaultValue": {
"defaultValue": null,
"description": "The value of the select when initially rendered. Use when you do not need to control the state of the select.",
"name": "defaultValue",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "string | string[]"
}
},
"value": {
"defaultValue": null,
"description": "The controlled value of the select. Should be used in conjunction with `onValueChange`.",
"name": "value",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "string | string[]"
}
},
"onValueChange": {
"defaultValue": null,
"description": "Event handler called when the value changes.",
"name": "onValueChange",
"parent": {
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsSingle"
},
{
"fileName": "dropdown/src/DropdownContext.tsx",
"name": "DropdownPropsMultiple"
}
],
"required": false,
"type": {
"name": "((value: string) => void) | ((value: string[]) => void)"
}
}
}
},
"Dropdown.Divider": {
"tags": {},
"description": "",
"displayName": "Dropdown.Divider",
"methods": [],
"props": {
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownDivider.tsx",
"name": "DividerProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownDivider.tsx",
"name": "DividerProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownDivider.tsx",
"name": "DividerProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownDivider.tsx",
"name": "DividerProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLDivElement>"
}
}
}
},
"Dropdown.Group": {
"tags": {},
"description": "",
"displayName": "Dropdown.Group",
"methods": [],
"props": {
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownGroup.tsx",
"name": "GroupProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownGroup.tsx",
"name": "GroupProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownGroup.tsx",
"name": "GroupProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownGroup.tsx",
"name": "GroupProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLDivElement>"
}
}
}
},
"Dropdown.Item": {
"tags": {},
"description": "",
"displayName": "Dropdown.Item",
"methods": [],
"props": {
"disabled": {
"defaultValue": {
"value": false
},
"description": "",
"name": "disabled",
"parent": {
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"value": {
"defaultValue": null,
"description": "",
"name": "value",
"parent": {
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
}
],
"required": true,
"type": {
"name": "string"
}
},
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItem.tsx",
"name": "ItemProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLLIElement>"
}
}
}
},
"DropdownItemProvider": {
"tags": {},
"description": "",
"displayName": "DropdownItemProvider",
"methods": [],
"props": {
"value": {
"defaultValue": null,
"description": "",
"name": "value",
"declarations": [
{
"fileName": "dropdown/src/DropdownItemContext.tsx",
"name": "TypeLiteral"
}
],
"required": true,
"type": {
"name": "string"
}
},
"disabled": {
"defaultValue": {
"value": false
},
"description": "",
"name": "disabled",
"declarations": [
{
"fileName": "dropdown/src/DropdownItemContext.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
}
}
},
"Dropdown.ItemIndicator": {
"tags": {},
"description": "",
"displayName": "Dropdown.ItemIndicator",
"methods": [],
"props": {
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownItemIndicator.tsx",
"name": "ItemIndicatorProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItemIndicator.tsx",
"name": "ItemIndicatorProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"label": {
"defaultValue": null,
"description": "",
"name": "label",
"parent": {
"fileName": "dropdown/src/DropdownItemIndicator.tsx",
"name": "ItemIndicatorProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItemIndicator.tsx",
"name": "ItemIndicatorProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownItemIndicator.tsx",
"name": "ItemIndicatorProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItemIndicator.tsx",
"name": "ItemIndicatorProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLSpanElement>"
}
}
}
},
"Dropdown.ItemText": {
"tags": {},
"description": "",
"displayName": "Dropdown.ItemText",
"methods": [],
"props": {
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownItemText.tsx",
"name": "ItemTextProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItemText.tsx",
"name": "ItemTextProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLSpanElement>"
}
}
}
},
"Dropdown.Items": {
"tags": {},
"description": "BUGFIX\n\n1. The !pointer-events-auto class is needed to prevent a bug\n which cannot be reproduced when running Storybook locally,\n in scenarios such as when a Dropdown is nested within a Dialog,\n the \"props\" object, containing styles computed by Radix\n may erroneously contain \"pointerEvents = 'none'\", while the Dropdown is open,\n making it impossible to select a value using a pointer device",
"displayName": "Dropdown.Items",
"methods": [],
"props": {
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownItems.tsx",
"name": "ItemsProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItems.tsx",
"name": "ItemsProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownItems.tsx",
"name": "ItemsProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownItems.tsx",
"name": "ItemsProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLUListElement>"
}
}
}
},
"DropdownGroupProvider": {
"tags": {},
"description": "",
"displayName": "DropdownGroupProvider",
"methods": [],
"props": {}
},
"Dropdown.Label": {
"tags": {},
"description": "",
"displayName": "Dropdown.Label",
"methods": [],
"props": {
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownLabel.tsx",
"name": "LabelProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownLabel.tsx",
"name": "LabelProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownLabel.tsx",
"name": "LabelProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownLabel.tsx",
"name": "LabelProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLDivElement>"
}
}
}
},
"Dropdown.LeadingIcon": {
"tags": {},
"description": "",
"displayName": "Dropdown.LeadingIcon",
"methods": [],
"props": {}
},
"Dropdown.Popover": {
"tags": {},
"description": "",
"displayName": "Dropdown.Popover",
"methods": [],
"props": {
"forceMount": {
"defaultValue": null,
"description": "Used to force mounting when more control is needed. Useful when\ncontrolling animation with React animation libraries.",
"name": "forceMount",
"parent": {
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverContentProps"
}
],
"required": false,
"type": {
"name": "true"
}
},
"asChild": {
"defaultValue": null,
"description": "",
"name": "asChild",
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-accordion/node_modules/@radix-ui/react-primitive/dist/index.d.ts",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"side": {
"defaultValue": null,
"description": "",
"name": "side",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"top\" | \"right\" | \"bottom\" | \"left\"",
"value": [
{
"value": "\"top\""
},
{
"value": "\"right\""
},
{
"value": "\"bottom\""
},
{
"value": "\"left\""
}
]
}
},
"sideOffset": {
"defaultValue": {
"value": 4
},
"description": "",
"name": "sideOffset",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"align": {
"defaultValue": null,
"description": "",
"name": "align",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"center\" | \"start\" | \"end\"",
"value": [
{
"value": "\"center\""
},
{
"value": "\"start\""
},
{
"value": "\"end\""
}
]
}
},
"alignOffset": {
"defaultValue": null,
"description": "",
"name": "alignOffset",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"arrowPadding": {
"defaultValue": null,
"description": "",
"name": "arrowPadding",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"avoidCollisions": {
"defaultValue": null,
"description": "",
"name": "avoidCollisions",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"collisionBoundary": {
"defaultValue": null,
"description": "",
"name": "collisionBoundary",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "Element | Element[]"
}
},
"collisionPadding": {
"defaultValue": null,
"description": "",
"name": "collisionPadding",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "number | Partial<Record<\"top\" | \"right\" | \"bottom\" | \"left\", number>>"
}
},
"sticky": {
"defaultValue": null,
"description": "",
"name": "sticky",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"partial\" | \"always\"",
"value": [
{
"value": "\"partial\""
},
{
"value": "\"always\""
}
]
}
},
"hideWhenDetached": {
"defaultValue": null,
"description": "",
"name": "hideWhenDetached",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"updatePositionStrategy": {
"defaultValue": null,
"description": "",
"name": "updatePositionStrategy",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-menu/node_modules/@radix-ui/react-popper/dist/index.d.ts",
"name": "PopperContentProps"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"always\" | \"optimized\"",
"value": [
{
"value": "\"always\""
},
{
"value": "\"optimized\""
}
]
}
},
"onEscapeKeyDown": {
"defaultValue": null,
"description": "Event handler called when the escape key is down.\nCan be prevented.",
"name": "onEscapeKeyDown",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
}
],
"required": false,
"type": {
"name": "(event: KeyboardEvent) => void"
}
},
"onPointerDownOutside": {
"defaultValue": null,
"description": "Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`.\nCan be prevented.",
"name": "onPointerDownOutside",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
}
],
"required": false,
"type": {
"name": "(event: PointerDownOutsideEvent) => void"
}
},
"onFocusOutside": {
"defaultValue": null,
"description": "Event handler called when the focus moves outside of the `DismissableLayer`.\nCan be prevented.",
"name": "onFocusOutside",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
}
],
"required": false,
"type": {
"name": "(event: FocusOutsideEvent) => void"
}
},
"onInteractOutside": {
"defaultValue": null,
"description": "Event handler called when an interaction happens outside the `DismissableLayer`.\nSpecifically, when a `pointerdown` event happens outside or focus moves outside of it.\nCan be prevented.",
"name": "onInteractOutside",
"parent": {
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/@radix-ui/react-alert-dialog/node_modules/@radix-ui/react-dismissable-layer/dist/index.d.ts",
"name": "DismissableLayerProps"
}
],
"required": false,
"type": {
"name": "(event: PointerDownOutsideEvent | FocusOutsideEvent) => void"
}
},
"onOpenAutoFocus": {
"defaultValue": null,
"description": "Event handler called when auto-focusing on open.\nCan be prevented.",
"name": "onOpenAutoFocus",
"parent": {
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverContentImplProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverContentImplProps"
}
],
"required": false,
"type": {
"name": "(event: Event) => void"
}
},
"onCloseAutoFocus": {
"defaultValue": null,
"description": "Event handler called when auto-focusing on close.\nCan be prevented.",
"name": "onCloseAutoFocus",
"parent": {
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverContentImplProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverContentImplProps"
}
],
"required": false,
"type": {
"name": "(event: Event) => void"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"declarations": [
{
"fileName": "components/popover/dist/PopoverContent.d.ts",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "Ref<HTMLDivElement>"
}
}
}
},
"Dropdown.Portal": {
"tags": {},
"description": "",
"displayName": "Dropdown.Portal",
"methods": [],
"props": {
"container": {
"defaultValue": null,
"description": "Specify a container element to portal the content into.",
"name": "container",
"parent": {
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverPortalProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverPortalProps"
}
],
"required": false,
"type": {
"name": "Element | DocumentFragment"
}
},
"forceMount": {
"defaultValue": null,
"description": "Used to force mounting when more control is needed. Useful when\ncontrolling animation with React animation libraries.",
"name": "forceMount",
"parent": {
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverPortalProps"
},
"declarations": [
{
"fileName": "spark-web/node_modules/radix-ui/node_modules/@radix-ui/react-popover/dist/index.d.ts",
"name": "PopoverPortalProps"
}
],
"required": false,
"type": {
"name": "true"
}
}
}
},
"Dropdown.Trigger": {
"tags": {},
"description": "",
"displayName": "Dropdown.Trigger",
"methods": [],
"props": {
"aria-label": {
"defaultValue": null,
"description": "",
"name": "aria-label",
"parent": {
"fileName": "dropdown/src/DropdownTrigger.tsx",
"name": "TriggerProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownTrigger.tsx",
"name": "TriggerProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownTrigger.tsx",
"name": "TriggerProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownTrigger.tsx",
"name": "TriggerProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownTrigger.tsx",
"name": "TriggerProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownTrigger.tsx",
"name": "TriggerProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLButtonElement>"
}
}
}
},
"Dropdown.Value": {
"tags": {},
"description": "",
"displayName": "Dropdown.Value",
"methods": [],
"props": {
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"parent": {
"fileName": "dropdown/src/DropdownValue.tsx",
"name": "ValueProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownValue.tsx",
"name": "ValueProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"placeholder": {
"defaultValue": null,
"description": "",
"name": "placeholder",
"parent": {
"fileName": "dropdown/src/DropdownValue.tsx",
"name": "ValueProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownValue.tsx",
"name": "ValueProps"
}
],
"required": true,
"type": {
"name": "string"
}
},
"ref": {
"defaultValue": null,
"description": "",
"name": "ref",
"parent": {
"fileName": "dropdown/src/DropdownValue.tsx",
"name": "ValueProps"
},
"declarations": [
{
"fileName": "dropdown/src/DropdownValue.tsx",
"name": "ValueProps"
}
],
"required": false,
"type": {
"name": "Ref<HTMLSpanElement>"
}
}
}
},
"useDropdown": {
"tags": {},
"description": "This hook abstract the complexity of using downshift with both single and multiple selection.",
"displayName": "useDropdown",
"methods": [],
"props": {
"itemsMap": {
"defaultValue": null,
"description": "",
"name": "itemsMap",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "ItemsMap"
}
},
"value": {
"defaultValue": null,
"description": "",
"name": "value",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "string | string[]"
}
},
"defaultValue": {
"defaultValue": null,
"description": "",
"name": "defaultValue",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "string | string[]"
}
},
"onValueChange": {
"defaultValue": null,
"description": "",
"name": "onValueChange",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "((value: string) => void) | ((value: string[]) => void)"
}
},
"open": {
"defaultValue": null,
"description": "",
"name": "open",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "boolean"
}
},
"onOpenChange": {
"defaultValue": null,
"description": "",
"name": "onOpenChange",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "(isOpen: boolean) => void"
}
},
"defaultOpen": {
"defaultValue": null,
"description": "",
"name": "defaultOpen",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "boolean"
}
},
"multiple": {
"defaultValue": null,
"description": "",
"name": "multiple",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "boolean"
}
},
"id": {
"defaultValue": null,
"description": "",
"name": "id",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "string"
}
},
"labelId": {
"defaultValue": null,
"description": "",
"name": "labelId",
"parent": {
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
},
"declarations": [
{
"fileName": "dropdown/src/useDropdown.ts",
"name": "DownshiftProps"
}
],
"required": true,
"type": {
"name": "string"
}
}
}
},
"getItemText": {
"tags": {},
"description": "If Dropdown.Item children:\n- is a string, then the string is used.\n- is JSX markup, then we look for Dropdown.ItemText to get its string value.",
"displayName": "getItemText",
"methods": [],
"props": {}
},
"getItemsFromChildren": {
"tags": {},
"description": "",
"displayName": "getItemsFromChildren",
"methods": [],
"props": {
"toString": {
"defaultValue": {},
"description": "Returns a string representation of a string.\nReturns a string representation of an object.\n@param radix Specifies a radix for converting numeric values to strings. This value is only used for numbers.\n@param radix Specifies a radix for converting numeric values to strings.",
"name": "toString",
"parent": {
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
},
"declarations": [
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
},
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "Number"
},
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es2020.bigint.d.ts",
"name": "BigInt"
},
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "Object"
}
],
"required": false,
"type": {
"name": "(() => string) | ((radix?: number) => string) | ((radix?: number) => string) | (() => string)"
}
},
"charAt": {
"defaultValue": null,
"description": "Returns the character at the specified index.\n@param pos The zero-based index of the desired character.",
"name": "charAt",
"parent": {
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
},
"declarations": [
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
}
],
"required": true,
"type": {
"name": "(pos: number) => string"
}
},
"charCodeAt": {
"defaultValue": null,
"description": "Returns the Unicode value of the character at the specified location.\n@param index The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.",
"name": "charCodeAt",
"parent": {
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
},
"declarations": [
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
}
],
"required": true,
"type": {
"name": "(index: number) => number"
}
},
"concat": {
"defaultValue": null,
"description": "Returns a string that contains the concatenation of two or more strings.\n@param strings The strings to append to the end of the string.",
"name": "concat",
"parent": {
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
},
"declarations": [
{
"fileName": "spark-web/node_modules/typescript/lib/lib.es5.d.ts",
"name": "String"
}
],
"required": true,
"type": {
"name": "(...strings: string[]) => string"
}
},
"indexOf": {
"defaultValue": null,
"description": "Returns the position of the first occurrence of a substring.\n@param searchString The substring to search for in the string\n@par