diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 2d5e19ff87..d35b9391a0 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -10900,28 +10900,20 @@ "description": "Used to pass attributes to the input's DOM element." }, { - "name": "icon", + "name": "box", "optional": true, "readonly": false, "type": "CheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the icon's DOM element." + "description": "Used to pass attributes to the box's DOM element." }, { - "name": "hiddenInputWrapper", - "optional": true, - "readonly": false, - "type": "CheckboxPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." - }, - { - "name": "hiddenInput", + "name": "icon", "optional": true, "readonly": false, "type": "CheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input's DOM element." + "description": "Used to pass attributes to the icon's DOM element." }, { "name": "hooks", @@ -11160,17 +11152,17 @@ "props": [], "methods": [ { - "name": "update:page", + "name": "update:modelValue", "parameters": [ { "name": "value", "optional": false, "type": "any", - "description": "New page value." + "description": "New value." } ], "returnType": "void", - "description": "Emitted when the page changes." + "description": "Emitted when the value changes." }, { "name": "change", @@ -12933,30 +12925,14 @@ "default": "", "description": "Used to pass attributes to the sort badge's DOM element." }, - { - "name": "headerCheckboxWrapper", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox wrapper's DOM element." - }, { "name": "headerCheckbox", "optional": true, "readonly": false, - "type": "ColumnPassThroughOptionType", + "type": "CheckboxPassThroughOptionType", "default": "", "description": "Used to pass attributes to the header checkbox's DOM element." }, - { - "name": "headerCheckboxIcon", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the header checkbox icon's DOM element." - }, { "name": "columnFilter", "optional": true, @@ -13166,53 +13142,21 @@ "description": "Used to pass attributes to the column title's DOM element." }, { - "name": "radiobuttonWrapper", + "name": "rowRadioButton", "optional": true, "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the radiobutton wrapper's DOM element." - }, - { - "name": "radiobutton", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", + "type": "RadioButtonPassThroughOptionType", "default": "", "description": "Used to pass attributes to the radiobutton's DOM element." }, { - "name": "radiobuttonIcon", + "name": "rowCheckbox", "optional": true, "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the radiobutton icon's DOM element." - }, - { - "name": "checkboxWrapper", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox wrapper's DOM element." - }, - { - "name": "checkbox", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", + "type": "CheckboxPassThroughOptionType", "default": "", "description": "Used to pass attributes to the checkbox's DOM element." }, - { - "name": "checkboxIcon", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox icon's DOM element." - }, { "name": "rowToggler", "optional": true, @@ -13293,38 +13237,6 @@ "default": "", "description": "Used to pass attributes to the body cell content's DOM element." }, - { - "name": "hiddenHeaderInputWrapper", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." - }, - { - "name": "hiddenHeaderInput", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden input's DOM element." - }, - { - "name": "hiddenInputWrapper", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." - }, - { - "name": "hiddenInput", - "optional": true, - "readonly": false, - "type": "ColumnPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden input's DOM element." - }, { "name": "hooks", "optional": true, @@ -30835,6 +30747,14 @@ "default": "", "description": "Defines current inline state." }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "InputSwitchContext", + "default": "", + "description": "Defines current options." + }, { "name": "attrs", "optional": false, @@ -30875,28 +30795,20 @@ "description": "Used to pass attributes to the root's DOM element." }, { - "name": "slider", - "optional": true, - "readonly": false, - "type": "InputSwitchPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the slider's DOM element." - }, - { - "name": "hiddenInputWrapper", + "name": "input", "optional": true, "readonly": false, "type": "InputSwitchPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." + "description": "Used to pass attributes to the input's DOM element." }, { - "name": "hiddenInput", + "name": "slider", "optional": true, "readonly": false, "type": "InputSwitchPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input's DOM element." + "description": "Used to pass attributes to the slider's DOM element." }, { "name": "hooks", @@ -30927,12 +30839,10 @@ "relatedProp": "", "props": [ { - "name": "focused", + "name": "[key: string]", "optional": false, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current focus state as a boolean." + "type": "any" } ], "methods": [] @@ -30973,6 +30883,22 @@ "default": "false", "description": "When present, it specifies that the component should be disabled." }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "When present, it specifies that an input field is read-only." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the element in tabbing order." + }, { "name": "inputId", "optional": true, @@ -31048,6 +30974,29 @@ ], "methods": [] }, + "InputSwitchContext": { + "description": "Defines current options in InputSwitch component.", + "relatedProp": "", + "props": [ + { + "name": "checked", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current checked 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": [] + }, "InputSwitchSlots": { "relatedProp": "", "props": [], @@ -31072,7 +31021,7 @@ "description": "Emitted when the value changes." }, { - "name": "click", + "name": "change", "parameters": [ { "name": "event", @@ -31082,10 +31031,10 @@ } ], "returnType": "void", - "description": "Callback to invoke on click." + "description": "Callback to invoke on value change." }, { - "name": "change", + "name": "focus", "parameters": [ { "name": "event", @@ -31095,20 +31044,20 @@ } ], "returnType": "void", - "description": "Callback to invoke on value change." + "description": "Callback to invoke when the component receives focus." }, { - "name": "input", + "name": "blur", "parameters": [ { - "name": "value", + "name": "event", "optional": false, - "type": "boolean", - "description": "New value." + "type": "Event", + "description": "Browser event." } ], "returnType": "void", - "description": "Callback to invoke on value change." + "description": "Callback to invoke when the component loses focus." } ] } @@ -35960,14 +35909,6 @@ "default": "", "description": "Used to pass attributes to the header's DOM element." }, - { - "name": "headerCheckboxContainer", - "optional": true, - "readonly": false, - "type": "MultiSelectPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the header checkbox container's DOM element." - }, { "name": "headerCheckbox", "optional": true, @@ -36057,28 +35998,12 @@ "description": "Used to pass attributes to the item's DOM element." }, { - "name": "checkboxContainer", + "name": "itemCheckbox", "optional": true, "readonly": false, "type": "MultiSelectPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the checkbox container's DOM element." - }, - { - "name": "checkbox", - "optional": true, - "readonly": false, - "type": "MultiSelectPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox's DOM element." - }, - { - "name": "checkboxIcon", - "optional": true, - "readonly": false, - "type": "MultiSelectPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox icon's DOM element." + "description": "Used to pass attributes to the item checkbox's DOM element." }, { "name": "option", @@ -36096,14 +36021,6 @@ "default": "", "description": "Used to pass attributes to the emptyMessage's DOM element." }, - { - "name": "hiddenInputWrapper", - "optional": true, - "readonly": false, - "type": "MultiSelectPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." - }, { "name": "hiddenInput", "optional": true, @@ -43107,6 +43024,14 @@ "default": "", "description": "Defines current inline state." }, + { + "name": "context", + "optional": false, + "readonly": false, + "type": "RadioButtonContext", + "default": "", + "description": "Defines current options." + }, { "name": "attrs", "optional": false, @@ -43155,28 +43080,20 @@ "description": "Used to pass attributes to the input's DOM element." }, { - "name": "icon", + "name": "box", "optional": true, "readonly": false, "type": "RadioButtonPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the icon's DOM element." + "description": "Used to pass attributes to the box's DOM element." }, { - "name": "hiddenInputWrapper", - "optional": true, - "readonly": false, - "type": "RadioButtonPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the hidden accessible DOM element wrapper." - }, - { - "name": "hiddenInput", + "name": "icon", "optional": true, "readonly": false, "type": "RadioButtonPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden accessible DOM element." + "description": "Used to pass attributes to the icon's DOM element." }, { "name": "hooks", @@ -43207,12 +43124,10 @@ "relatedProp": "", "props": [ { - "name": "focused", + "name": "[key: string]", "optional": false, "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current focused state as a boolean." + "type": "any" } ], "methods": [] @@ -43253,6 +43168,22 @@ "default": "false", "description": "When present, it specifies that the component should be disabled." }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "When present, it specifies that an input field is read-only." + }, + { + "name": "tabindex", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "Index of the element in tabbing order." + }, { "name": "inputId", "optional": true, @@ -43277,14 +43208,6 @@ "default": "", "description": "Style class of the input field." }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Used to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, { "name": "ariaLabelledby", "optional": true, @@ -43328,6 +43251,29 @@ ], "methods": [] }, + "RadioButtonContext": { + "description": "Defines current options in RadioButton component.", + "relatedProp": "", + "props": [ + { + "name": "checked", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "Current checked 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": [] + }, "RadioButtonSlots": { "relatedProp": "", "props": [], @@ -43352,7 +43298,7 @@ "description": "Emitted when the value changes." }, { - "name": "click", + "name": "change", "parameters": [ { "name": "event", @@ -43362,10 +43308,10 @@ } ], "returnType": "void", - "description": "Callback to invoke on radio button click." + "description": "Callback to invoke on radio button value change." }, { - "name": "change", + "name": "focus", "parameters": [ { "name": "event", @@ -43375,7 +43321,20 @@ } ], "returnType": "void", - "description": "Callback to invoke on radio button value change." + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." } ] } @@ -53038,36 +52997,28 @@ "description": "Used to pass attributes to the root's DOM element." }, { - "name": "icon", - "optional": true, - "readonly": false, - "type": "ToggleButtonPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the icon's DOM element." - }, - { - "name": "label", + "name": "input", "optional": true, "readonly": false, "type": "ToggleButtonPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the label's DOM element." + "description": "Used to pass attributes to the input's DOM element." }, { - "name": "hiddenInputWrapper", + "name": "icon", "optional": true, "readonly": false, "type": "ToggleButtonPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." + "description": "Used to pass attributes to the icon's DOM element." }, { - "name": "hiddenInput", + "name": "label", "optional": true, "readonly": false, "type": "ToggleButtonPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input's DOM element." + "description": "Used to pass attributes to the label's DOM element." }, { "name": "hooks", @@ -53098,12 +53049,10 @@ "relatedProp": "", "props": [ { - "name": "focused", + "name": "[key: string]", "optional": false, "readonly": false, - "type": "boolean", - "default": "", - "description": "Focused state as a boolean." + "type": "any" } ], "methods": [] @@ -53113,12 +53062,12 @@ "relatedProp": "", "props": [ { - "name": "focused", + "name": "active", "optional": false, "readonly": false, "type": "boolean", "default": "false", - "description": "Current focused state as a boolean." + "description": "Current highlighted state as a boolean." }, { "name": "disabled", @@ -53127,14 +53076,6 @@ "type": "boolean", "default": "false", "description": "Current disabled state as a boolean." - }, - { - "name": "highlighted", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current highlighted state as a boolean." } ], "methods": [] @@ -53201,6 +53142,14 @@ "default": "false", "description": "When present, it specifies that the element should be disabled." }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "When present, it specifies that an input field is read-only." + }, { "name": "tabindex", "optional": true, @@ -53233,14 +53182,6 @@ "default": "", "description": "Inline style of the input field." }, - { - "name": "inputProps", - "optional": true, - "readonly": false, - "type": "InputHTMLAttributes", - "default": "", - "description": "Used to pass all properties of the HTMLInputElement to the focusable input element inside the component." - }, { "name": "ariaLabelledby", "optional": true, @@ -54284,29 +54225,13 @@ "description": "Used to pass attributes to the toggler icon's DOM element." }, { - "name": "checkboxContainer", - "optional": true, - "readonly": false, - "type": "TreePassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox container's DOM element." - }, - { - "name": "checkbox", + "name": "nodeCheckbox", "optional": true, "readonly": false, "type": "TreePassThroughOptionType", "default": "", "description": "Used to pass attributes to the checkbox's DOM element." }, - { - "name": "checkboxIcon", - "optional": true, - "readonly": false, - "type": "TreePassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox icon's DOM element." - }, { "name": "nodeIcon", "optional": true, @@ -57324,52 +57249,44 @@ "description": "Used to pass attributes to the root's DOM element." }, { - "name": "checkbox", - "optional": true, - "readonly": false, - "type": "TriStateCheckboxPassThroughOptionType", - "default": "", - "description": "Used to pass attributes to the checkbox box's DOM element." - }, - { - "name": "checkIcon", + "name": "input", "optional": true, "readonly": false, "type": "TriStateCheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the check icon's DOM element." + "description": "Used to pass attributes to the input's DOM element." }, { - "name": "uncheckIcon", + "name": "box", "optional": true, "readonly": false, "type": "TriStateCheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the uncheck icon's DOM element." + "description": "Used to pass attributes to the box's DOM element." }, { - "name": "nullableIcon", + "name": "checkIcon", "optional": true, "readonly": false, "type": "TriStateCheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the nullable icon's DOM element." + "description": "Used to pass attributes to the check icon's DOM element." }, { - "name": "hiddenInputWrapper", + "name": "uncheckIcon", "optional": true, "readonly": false, "type": "TriStateCheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input wrapper's DOM element." + "description": "Used to pass attributes to the uncheck icon's DOM element." }, { - "name": "hiddenInput", + "name": "nullableIcon", "optional": true, "readonly": false, "type": "TriStateCheckboxPassThroughOptionType", "default": "", - "description": "Used to pass attributes to the hidden input's DOM element." + "description": "Used to pass attributes to the nullable icon's DOM element." }, { "name": "hiddenValueLabel", @@ -57408,12 +57325,10 @@ "relatedProp": "", "props": [ { - "name": "focused", + "name": "[key: string]", "optional": false, "readonly": false, - "type": "boolean", - "default": "", - "description": "Focused state as a boolean." + "type": "any" } ], "methods": [] @@ -57430,14 +57345,6 @@ "default": "false", "description": "Current active state as a boolean." }, - { - "name": "focused", - "optional": false, - "readonly": false, - "type": "boolean", - "default": "false", - "description": "Current focused state as a boolean." - }, { "name": "disabled", "optional": false, @@ -57469,6 +57376,14 @@ "default": "false", "description": "When present, it specifies that the component should be disabled." }, + { + "name": "readonly", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "When present, it specifies that an input field is read-only." + }, { "name": "tabindex", "optional": true, @@ -57486,13 +57401,20 @@ "description": "Identifier of the underlying input element." }, { - "name": "inputProps", + "name": "inputClass", "optional": true, "readonly": false, - "type": "InputHTMLAttributes", + "type": "object", "default": "", - "description": "Used to pass all properties of the HTMLInputElement to the focusable input element inside the component.", - "deprecated": "since v3.26.0. Use 'pt' property." + "description": "Style class of the input field." + }, + { + "name": "inputStyle", + "optional": true, + "readonly": false, + "type": "string | object", + "default": "", + "description": "Inline style of the input field." }, { "name": "ariaLabelledby", @@ -57600,6 +57522,45 @@ ], "returnType": "void", "description": "Emitted when the value changes." + }, + { + "name": "change", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke on value change." + }, + { + "name": "focus", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component receives focus." + }, + { + "name": "blur", + "parameters": [ + { + "name": "event", + "optional": false, + "type": "Event", + "description": "Browser event." + } + ], + "returnType": "void", + "description": "Callback to invoke when the component loses focus." } ] }