From d01c40c55b539043f406a05f41d968c80e469525 Mon Sep 17 00:00:00 2001 From: Mert Sincan Date: Wed, 23 Oct 2024 21:34:53 +0100 Subject: [PATCH] Update index.json --- apps/showcase/doc/common/apidoc/index.json | 280 ++++++++++++++++++++- 1 file changed, 279 insertions(+), 1 deletion(-) diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json index c8ffda559..241069a20 100644 --- a/apps/showcase/doc/common/apidoc/index.json +++ b/apps/showcase/doc/common/apidoc/index.json @@ -119,6 +119,154 @@ ], "methods": [] }, + "FormResolverOptions": { + "description": "Resolver options for Form component.", + "relatedProp": "", + "props": [ + { + "name": "values", + "optional": false, + "readonly": false, + "type": "Record", + "default": "", + "description": "The values of the form fields." + }, + { + "name": "names", + "optional": false, + "readonly": false, + "type": "undefined | string[]", + "default": "", + "description": "The names of the form fields." + } + ], + "methods": [] + }, + "FormSubmitEvent": { + "description": "Submit events", + "relatedProp": "", + "props": [ + { + "name": "originalEvent", + "optional": false, + "readonly": false, + "type": "Event", + "default": "", + "description": "The original DOM event." + }, + { + "name": "values", + "optional": false, + "readonly": false, + "type": "Record", + "default": "", + "description": "The form values." + }, + { + "name": "states", + "optional": false, + "readonly": false, + "type": "Record", + "default": "", + "description": "The form state." + }, + { + "name": "valid", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the form is valid." + }, + { + "name": "errors", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "The form errors." + }, + { + "name": "reset", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "methods": [] + }, + "FormFieldState": { + "description": "The state of a form field.", + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "The value of the form field." + }, + { + "name": "touched", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the form field has been touched." + }, + { + "name": "dirty", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the form field has been modified." + }, + { + "name": "pristine", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the form field has not been modified." + }, + { + "name": "valid", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the form field is valid." + }, + { + "name": "invalid", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "", + "description": "Whether the form field is invalid." + }, + { + "name": "error", + "optional": false, + "readonly": false, + "type": "any", + "default": "", + "description": "The first error message of the form field." + }, + { + "name": "errors", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "", + "description": "All error messages of the form field." + } + ], + "methods": [] + }, "FormProps": { "description": "Defines valid properties in Form component.", "relatedProp": "", @@ -253,6 +401,18 @@ "description": "Custom passthrough attributes for each DOM elements", "props": [] }, + "FormResolverOptions": { + "description": "Resolver options for Form component.", + "props": [] + }, + "FormSubmitEvent": { + "description": "Submit events", + "props": [] + }, + "FormFieldState": { + "description": "The state of a form field.", + "props": [] + }, "FormProps": { "description": "Defines valid properties in Form component.", "props": [] @@ -331,6 +491,68 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "useFormFieldState": { + "relatedProp": "", + "props": [ + { + "name": "value", + "optional": false, + "readonly": false, + "type": "any", + "default": "" + }, + { + "name": "touched", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "" + }, + { + "name": "dirty", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "" + }, + { + "name": "pristine", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "" + }, + { + "name": "valid", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "" + }, + { + "name": "invalid", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "" + }, + { + "name": "error", + "optional": false, + "readonly": false, + "type": "any", + "default": "" + }, + { + "name": "errors", + "optional": false, + "readonly": false, + "type": "any[]", + "default": "" + } + ], + "methods": [] + }, "useFormReturn": { "relatedProp": "", "props": [ @@ -373,7 +595,27 @@ "name": "states", "optional": false, "readonly": false, - "type": "any", + "type": "Record", + "default": "" + } + ], + "methods": [] + }, + "useFormResolverOptions": { + "relatedProp": "", + "props": [ + { + "name": "values", + "optional": false, + "readonly": false, + "type": "Record", + "default": "" + }, + { + "name": "names", + "optional": false, + "readonly": false, + "type": "undefined | string[]", "default": "" } ], @@ -432,9 +674,15 @@ "tokens": { "description": "Define design tokens used by the component.", "values": { + "useFormFieldState": { + "props": [] + }, "useFormReturn": { "props": [] }, + "useFormResolverOptions": { + "props": [] + }, "useFormOptions": { "props": [] } @@ -34042,6 +34290,14 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, { "name": "slotChar", "optional": true, @@ -34227,6 +34483,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "focus", "parameters": [ @@ -34591,6 +34860,15 @@ "readonly": false, "type": "number", "default": "", + "description": "Current value state as a number.", + "deprecated": "since 4.2.0. Use 'd_value' instead." + }, + { + "name": "d_value", + "optional": false, + "readonly": false, + "type": "number", + "default": "", "description": "Current value state as a number." }, {