Update API doc

pull/3938/head
GitHub Actions Bot 2023-05-07 20:38:03 +00:00
parent 133c543eab
commit d7e016958b
1 changed files with 302 additions and 0 deletions

View File

@ -15007,6 +15007,34 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"DropdownPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "DropdownProps",
"default": ""
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "DropdownState",
"default": ""
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "DropdownContext",
"default": ""
}
],
"methods": []
},
"DropdownChangeEvent": {
"description": "Custom change event.",
"relatedProp": "DropdownEmits.change",
@ -15053,6 +15081,264 @@
],
"methods": []
},
"DropdownPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "DropdownProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the root's DOM element."
},
{
"name": "input",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the input's DOM element."
},
{
"name": "clearIcon",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the clear icon's DOM element."
},
{
"name": "trigger",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the trigger' DOM element."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the loading icon's DOM element."
},
{
"name": "panel",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the panel's DOM element."
},
{
"name": "header",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the header's DOM element."
},
{
"name": "filterContainer",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the filter container's DOM element."
},
{
"name": "filterInput",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the filter input's DOM element."
},
{
"name": "filterIcon",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the filter icon's DOM element."
},
{
"name": "wrapper",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the wrapper's DOM element."
},
{
"name": "virtualScroller",
"optional": true,
"readonly": false,
"type": "VirtualScrollerPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the VirtualScroller component."
},
{
"name": "list",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the list's DOM element."
},
{
"name": "itemGroup",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the item group's DOM element."
},
{
"name": "item",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the item's DOM element."
},
{
"name": "emptyMessage",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the emptyMessage's DOM element."
},
{
"name": "hiddenFirstFocusableEl",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the hidden first focusable element's DOM element."
},
{
"name": "hiddenFilterResult",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the hidden filter result's DOM element."
},
{
"name": "hiddenSelectedMessage",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the hidden selected message's DOM element."
},
{
"name": "hiddenLastFocusableEl",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptionType",
"default": "",
"description": "Uses to pass attributes to the hidden last focusable element's DOM element."
}
],
"methods": []
},
"DropdownPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"DropdownState": {
"description": "Defines current inline state in Dropdown component.",
"relatedProp": "",
"props": [
{
"name": "id",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current id state as a string."
},
{
"name": "focused",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current focused state as a boolean."
},
{
"name": "focusedOptionIndex",
"optional": false,
"readonly": false,
"type": "number",
"default": "",
"description": "Current focused item index as a number."
},
{
"name": "filterValue",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Current filter value state as a string."
},
{
"name": "overlayVisible",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current overlay visible state as a boolean."
}
],
"methods": []
},
"DropdownContext": {
"description": "Defines current options in Dropdown component.",
"relatedProp": "",
"props": [
{
"name": "selected",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current selection state of the item as a boolean."
},
{
"name": "focused",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current focus state of the item as a boolean."
},
{
"name": "disabled",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Current disabled state of the item as a boolean."
}
],
"methods": []
},
"DropdownProps": {
"description": "Defines valid properties in Dropdown component.",
"relatedProp": "",
@ -15429,6 +15715,14 @@
"type": "string",
"default": "",
"description": "Identifier of the underlying input element."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "DropdownPassThroughOptions",
"default": "",
"description": "Uses to pass attributes to DOM elements inside the component."
}
],
"methods": []
@ -15692,6 +15986,14 @@
]
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"DropdownPassThroughOptionType": {
"values": "DropdownPassThroughAttributes | (options: DropdownPassThroughMethodOptions) => DropdownPassThroughAttributes | null | undefined"
}
}
}
},
"dynamicdialog": {