diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 3390ff402..de785cf08 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -20913,6 +20913,34 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "ListboxPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "relatedProp": "", + "props": [ + { + "name": "props", + "optional": false, + "readonly": false, + "type": "ListboxProps", + "default": "" + }, + { + "name": "state", + "optional": false, + "readonly": false, + "type": "ListboxState", + "default": "" + }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "ListboxContext", + "default": "" + } + ], + "methods": [] + }, "ListboxChangeEvent": { "description": "Custom change event.", "relatedProp": "ListboxEmits.change", @@ -20959,6 +20987,216 @@ ], "methods": [] }, + "ListboxPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "ListboxProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the root's DOM element." + }, + { + "name": "header", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the header's DOM element." + }, + { + "name": "filterContainer", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the filter container's DOM element." + }, + { + "name": "filterInput", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the filter input's DOM element." + }, + { + "name": "filterIcon", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the filter icon's DOM element." + }, + { + "name": "wrapper", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "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": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the list's DOM element." + }, + { + "name": "itemGroup", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the item group's DOM element." + }, + { + "name": "item", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the item's DOM element." + }, + { + "name": "emptyMessage", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the emptyMessage's DOM element." + }, + { + "name": "hiddenFirstFocusableEl", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the hidden first focusable element's DOM element." + }, + { + "name": "hiddenFilterResult", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the hidden filter result's DOM element." + }, + { + "name": "hiddenSelectedMessage", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the hidden selected message's DOM element." + }, + { + "name": "hiddenLastFocusableEl", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptionType", + "default": "", + "description": "Uses to pass attributes to the hidden last focusable element's DOM element." + } + ], + "methods": [] + }, + "ListboxPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "ListboxState": { + "description": "Defines current inline state in Listbox 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": "filterValue", + "optional": false, + "readonly": false, + "type": "string", + "default": "", + "description": "Current filter value state as a string." + }, + { + "name": "focusedOptionIndex", + "optional": false, + "readonly": false, + "type": "number", + "default": "-1", + "description": "Current focused item index as a number." + } + ], + "methods": [] + }, + "ListboxContext": { + "description": "Defines current options in Listbox 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": [] + }, "ListboxProps": { "description": "Defines valid properties in Listbox component.", "relatedProp": "", @@ -21203,6 +21441,14 @@ "type": "string", "default": "", "description": "Identifier of the underlying input element." + }, + { + "name": "pt", + "optional": true, + "readonly": false, + "type": "ListboxPassThroughOptions", + "default": "", + "description": "Uses to pass attributes to DOM elements inside the component." } ], "methods": [] @@ -21383,6 +21629,14 @@ ] } } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "ListboxPassThroughOptionType": { + "values": "ListboxPassThroughAttributes | (options: ListboxPassThroughMethodOptions) => ListboxPassThroughAttributes | null | undefined" + } + } } }, "megamenu": {