vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Update API doc

pull/5323/head
GitHub Actions Bot 2024-02-22 08:53:40 +00:00
parent 2d232f93bb
commit d05395dc54
1 changed files with 142 additions and 138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

280
doc/common/apidoc/index.json
View File

@ -31975,10 +31975,10 @@
} }
}, },
"inputotp": { "inputotp": {
"description": "InputSwitch is used to select a boolean value.\n\n[Live Demo](https://www.primevue.org/inputswitch/)", "description": "InputOtp is used to enter one time passwords.\n\n[Live Demo](https://www.primevue.org/inputotp/)",
"components": { "components": {
"default": { "default": {
"description": "InputSwitch is used to select a boolean value.", "description": "InputOtp is used to enter one time passwords.",
"methods": { "methods": {
"description": "Defines methods that can be accessed by the component's reference.", "description": "Defines methods that can be accessed by the component's reference.",
"values": [] "values": []
@ -31991,7 +31991,7 @@
"methodDescription": "Defines methods that can be accessed by the component's reference.", "methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.", "typeDescription": "Defines the custom types used by the module.",
"values": { "values": {
"InputSwitchPassThroughMethodOptions": { "InputOtpPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.", "description": "Custom passthrough(pt) option method.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
@ -32007,7 +32007,7 @@
"name": "props", "name": "props",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "InputSwitchProps", "type": "InputOtpProps",
"default": "", "default": "",
"description": "Defines valid properties." "description": "Defines valid properties."
}, },
@ -32015,18 +32015,10 @@
"name": "state", "name": "state",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "InputSwitchState", "type": "InputOtpState",
"default": "", "default": "",
"description": "Defines current inline state." "description": "Defines current inline state."
}, },
{
"name": "context",
"optional": false,
"readonly": false,
"type": "InputSwitchContext",
"default": "",
"description": "Defines current options."
},
{ {
"name": "attrs", "name": "attrs",
"optional": false, "optional": false,
@ -32035,14 +32027,6 @@
"default": "", "default": "",
"description": "Defines valid attributes." "description": "Defines valid attributes."
}, },
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{ {
"name": "global", "name": "global",
"optional": false, "optional": false,
@ -32054,15 +32038,38 @@
], ],
"methods": [] "methods": []
}, },
"InputSwitchPassThroughOptions": { "InputOtpSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "InputOtpProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "InputOtpState",
"default": "",
"description": "Defines current inline state."
}
],
"methods": []
},
"InputOtpPassThroughOptions": {
"description": "Custom passthrough(pt) options.", "description": "Custom passthrough(pt) options.",
"relatedProp": "InputSwitchProps.pt", "relatedProp": "InputOtpProps.pt",
"props": [ "props": [
{ {
"name": "root", "name": "root",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "InputSwitchPassThroughOptionType", "type": "InputOtpPassThroughOptionType",
"default": "", "default": "",
"description": "Used to pass attributes to the root's DOM element." "description": "Used to pass attributes to the root's DOM element."
}, },
@ -32070,17 +32077,9 @@
"name": "input", "name": "input",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "InputSwitchPassThroughOptionType", "type": "InputTextPassThroughOptions<InputOtpSharedPassThroughMethodOptions>",
"default": "", "default": "",
"description": "Used to pass attributes to the input's DOM element." "description": "Used to pass attributes to the InputText component."
},
{
"name": "slider",
"optional": true,
"readonly": false,
"type": "InputSwitchPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the slider's DOM element."
}, },
{ {
"name": "hooks", "name": "hooks",
@ -32093,7 +32092,7 @@
], ],
"methods": [] "methods": []
}, },
"InputSwitchPassThroughAttributes": { "InputOtpPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements", "description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
@ -32106,21 +32105,80 @@
], ],
"methods": [] "methods": []
}, },
"InputSwitchState": { "InputOtpState": {
"description": "Defines current inline state in InputSwitch component.", "description": "Defines current inline state in InputOtp component.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
{ {
"name": "[key: string]", "name": "tokens",
"optional": false, "optional": false,
"readonly": false, "readonly": false,
"type": "any" "type": "string[] | number[]",
"default": "",
"description": "Array of input tokens"
} }
], ],
"methods": [] "methods": []
}, },
"InputSwitchProps": { "InputOtpTemplateAttrsOptions": {
"description": "Defines valid properties in InputSwitch component.", "description": "InputOtp attr options",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "string",
"default": "",
"description": "Input token value"
}
],
"methods": []
},
"InputOtpTemplateEvents": {
"description": "InputOtp templating events",
"relatedProp": "",
"props": [
{
"name": "input",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "keydown",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "focus",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "blur",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "paste",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
},
"InputOtpProps": {
"description": "Defines valid properties in InputOtp component.",
"relatedProp": "", "relatedProp": "",
"props": [ "props": [
{ {
@ -32129,23 +32187,7 @@
"readonly": false, "readonly": false,
"type": "string | boolean", "type": "string | boolean",
"default": "false", "default": "false",
"description": "Specifies whether a inputswitch should be checked or not." "description": "Specifies whether a inputotp should be checked or not."
},
{
"name": "trueValue",
"optional": true,
"readonly": false,
"type": "any",
"default": "true",
"description": "Value in checked state."
},
{
"name": "falseValue",
"optional": true,
"readonly": false,
"type": "any",
"default": "false",
"description": "Value in unchecked state."
}, },
{ {
"name": "invalid", "name": "invalid",
@ -32168,9 +32210,17 @@
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "boolean", "type": "boolean",
"default": "", "default": "false",
"description": "When present, it specifies that an input field is read-only." "description": "When present, it specifies that an input field is read-only."
}, },
{
"name": "variant",
"optional": true,
"readonly": false,
"type": "\"filled\" | \"outlined\"",
"default": "outlined",
"description": "Specifies the input variant of the component."
},
{ {
"name": "tabindex", "name": "tabindex",
"optional": true, "optional": true,
@ -32180,50 +32230,34 @@
"description": "Index of the element in tabbing order." "description": "Index of the element in tabbing order."
}, },
{ {
"name": "inputId", "name": "length",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string", "type": "number",
"default": "", "default": "4",
"description": "Identifier of the underlying input element." "description": "Number of characters to initiate."
}, },
{ {
"name": "inputClass", "name": "mask",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "string | object", "type": "boolean",
"default": "", "default": "false",
"description": "Style class of the input field." "description": "Mask pattern."
}, },
{ {
"name": "inputStyle", "name": "integerOnly",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "object", "type": "boolean",
"default": "", "default": "false",
"description": "Inline style of the input field." "description": "When present, it specifies that an input field is integer-only."
},
{
"name": "ariaLabelledby",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
},
{
"name": "ariaLabel",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Establishes a string value that labels the component."
}, },
{ {
"name": "pt", "name": "pt",
"optional": true, "optional": true,
"readonly": false, "readonly": false,
"type": "PassThrough<InputSwitchPassThroughOptions>", "type": "PassThrough<InputOtpPassThroughOptions>",
"default": "", "default": "",
"description": "Used to pass attributes to DOM elements inside the component." "description": "Used to pass attributes to DOM elements inside the component."
}, },
@ -32246,36 +32280,27 @@
], ],
"methods": [] "methods": []
}, },
"InputSwitchContext": { "InputOtpSlots": {
"description": "Defines current options in InputSwitch component.", "description": "",
"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": "", "relatedProp": "",
"props": [], "props": [],
"methods": [] "methods": [
{
"name": "default",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t <span class=\"ml-3 doc-option-parameter-name\">events</span>: <span class=\"doc-option-parameter-type\">(<span class=\"doc-option-parameter-name\">index</span>: number) &rArr; InputOtpTemplateEvents</span>, <span class=\"doc-option-parameter-type\">// Events of the component</span>\n\t <span class=\"ml-3 doc-option-parameter-name\">attrs</span>: <span class=\"doc-option-parameter-type\">(<span class=\"doc-option-parameter-name\">index</span>: number) &rArr; InputOtpTemplateAttrsOptions</span>, <span class=\"doc-option-parameter-type\">// Attributes of the component</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">index</span>: <span class=\"doc-option-parameter-type\">number</span>, <span class=\"doc-option-parameter-type\">// Index of the input field</span>\n }"
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Default content slot."
}
]
}, },
"InputSwitchEmits": { "InputOtpEmits": {
"description": "Defines valid emits in InputSwitch component.", "description": "Defines valid emits in InputOtp component.",
"relatedProp": "", "relatedProp": "",
"props": [], "props": [],
"methods": [ "methods": [
@ -32338,8 +32363,8 @@
"types": { "types": {
"description": "Defines the custom types used by the module.", "description": "Defines the custom types used by the module.",
"values": { "values": {
"InputSwitchPassThroughOptionType": { "InputOtpPassThroughOptionType": {
"values": "InputSwitchPassThroughAttributes | (options: InputSwitchPassThroughMethodOptions) => undefined | string | null | undefined" "values": "InputOtpPassThroughAttributes | (options: InputOtpPassThroughMethodOptions) => undefined | string | null | undefined"
} }
} }
} }
@ -32440,14 +32465,6 @@
"default": "", "default": "",
"description": "Defines valid properties." "description": "Defines valid properties."
}, },
{
"name": "state",
"optional": false,
"readonly": false,
"type": "InputSwitchState",
"default": "",
"description": "Defines current inline state."
},
{ {
"name": "context", "name": "context",
"optional": false, "optional": false,
@ -32535,19 +32552,6 @@
], ],
"methods": [] "methods": []
}, },
"InputSwitchState": {
"description": "Defines current inline state in InputSwitch component.",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"InputSwitchProps": { "InputSwitchProps": {
"description": "Defines valid properties in InputSwitch component.", "description": "Defines valid properties in InputSwitch component.",
"relatedProp": "", "relatedProp": "",