pull/6697/head
tugcekucukoglu 2024-10-31 16:59:53 +03:00
commit 051baf8384
1 changed files with 72 additions and 746 deletions

View File

@ -1,694 +1,4 @@
{ {
"form": {
"description": "Form provides validation functionality and manages form state.\n\n[Live Demo](https://www.primevue.org/form/)",
"components": {
"default": {
"description": "Form provides validation functionality and manages form state.",
"methods": {
"description": "Defines methods that can be accessed by the component's reference.",
"values": []
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"PassThroughOptions": {
"relatedProp": "",
"props": [
{
"name": "mergeSections",
"optional": true,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "mergeProps",
"optional": true,
"readonly": false,
"type": "PassThroughMergePropsType",
"default": ""
}
],
"methods": []
},
"FormPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "instance",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines instance."
},
{
"name": "props",
"optional": false,
"readonly": false,
"type": "FormProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "attrs",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines valid attributes."
},
{
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"default": "",
"description": "Defines parent options."
},
{
"name": "global",
"optional": false,
"readonly": false,
"type": "undefined | object",
"default": "",
"description": "Defines passthrough(pt) options in global config."
}
],
"methods": []
},
"FormPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"relatedProp": "FormProps.pt",
"props": [
{
"name": "root",
"optional": true,
"readonly": false,
"type": "FormPassThroughOptionType",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
{
"name": "hooks",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "Used to manage all lifecycle hooks."
}
],
"methods": []
},
"FormPassThroughAttributes": {
"description": "Custom passthrough attributes for each DOM elements",
"relatedProp": "",
"props": [
{
"name": "[key: string]",
"optional": false,
"readonly": false,
"type": "any"
}
],
"methods": []
},
"FormResolverOptions": {
"description": "Resolver options for Form component.",
"relatedProp": "",
"props": [
{
"name": "values",
"optional": false,
"readonly": false,
"type": "Record<string, any>",
"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<string, any>",
"default": "",
"description": "The form values."
},
{
"name": "states",
"optional": false,
"readonly": false,
"type": "Record<string, FormFieldState>",
"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": "false",
"description": "Whether the form field has been touched."
},
{
"name": "dirty",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "Whether the form field has been modified."
},
{
"name": "pristine",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether the form field has not been modified."
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "true",
"description": "Whether the form field is valid."
},
{
"name": "invalid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": "false",
"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": "",
"props": [
{
"name": "resolver",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "initialValues",
"optional": true,
"readonly": false,
"type": "Record<string, any>",
"default": "",
"description": "The initial values for the form fields."
},
{
"name": "validateOnValueUpdate",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "true",
"description": "Whether to validate the form fields when the values change."
},
{
"name": "validateOnBlur",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "false",
"description": "Whether to validate the form fields when they lose focus (on blur)."
},
{
"name": "validateOnMount",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "false",
"description": "Whether to validate the form fields immediately after the form is mounted."
},
{
"name": "validateOnSubmit",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": "true",
"description": "Whether to validate the form fields when the form is submitted."
},
{
"name": "dt",
"optional": true,
"readonly": false,
"type": "any",
"default": "",
"description": "It generates scoped CSS variables using design tokens for the component."
},
{
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough<FormPassThroughOptions>",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
{
"name": "ptOptions",
"optional": true,
"readonly": false,
"type": "PassThroughOptions",
"default": "",
"description": "Used to configure passthrough(pt) options of the component."
},
{
"name": "unstyled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When enabled, it removes component related styles in the core."
}
],
"methods": []
},
"FormSlots": {
"description": "Defines valid slots in Form component.",
"relatedProp": "",
"props": [
{
"name": "default",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
},
"FormEmitsOptions": {
"description": "Defines valid emits in Form component.",
"relatedProp": "",
"props": [
{
"name": "submit",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
}
],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"PassThroughOptions": {
"props": []
},
"FormPassThroughMethodOptions": {
"description": "Custom passthrough(pt) option method.",
"props": []
},
"FormPassThroughOptions": {
"description": "Custom passthrough(pt) options.",
"props": []
},
"FormPassThroughAttributes": {
"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": []
},
"FormSlots": {
"description": "Defines valid slots in Form component.",
"props": []
},
"FormEmitsOptions": {
"description": "Defines valid emits in Form component.",
"props": []
}
}
},
"types": {
"description": "Defines the custom types used by the module.",
"values": {
"PassThroughMergePropsType": {
"values": "(args: any) => undefined | boolean | undefined",
"description": "From primevue/passthrough/index.d.ts"
},
"FormPassThroughOptionType": {
"values": "FormPassThroughAttributes | (options: FormPassThroughMethodOptions) => undefined | string | null | undefined"
},
"FormEmits": {
"values": "EmitFn<FormEmitsOptions>"
}
}
}
},
"formstyle": {
"description": "[Live Demo](https://www.primevue.org/form/)",
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"FormStyle": {
"relatedProp": "",
"props": [],
"methods": [],
"extendedTypes": "default"
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"FormStyle": {
"props": []
}
}
}
},
"form/src/resolvers": {},
"form/src/useform": {
"functions": {
"description": "Defines the custom functions used by the module.",
"values": {
"useForm": {
"name": "useForm",
"parameters": [
{
"name": "options",
"type": "useFormOptions"
}
],
"returnType": "useFormReturn"
}
}
},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"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": [
{
"name": "defineField",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "handleSubmit",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "validate",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "reset",
"optional": false,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "valid",
"optional": false,
"readonly": false,
"type": "boolean",
"default": ""
},
{
"name": "states",
"optional": false,
"readonly": false,
"type": "Record<string, useFormFieldState>",
"default": ""
}
],
"methods": []
},
"useFormResolverOptions": {
"relatedProp": "",
"props": [
{
"name": "values",
"optional": false,
"readonly": false,
"type": "Record<string, any>",
"default": ""
},
{
"name": "names",
"optional": false,
"readonly": false,
"type": "undefined | string[]",
"default": ""
}
],
"methods": []
},
"useFormOptions": {
"relatedProp": "",
"props": [
{
"name": "resolver",
"optional": true,
"readonly": false,
"type": "Function",
"default": ""
},
{
"name": "initialValues",
"optional": true,
"readonly": false,
"type": "Record<string, any>",
"default": ""
},
{
"name": "validateOnValueUpdate",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
},
{
"name": "validateOnBlur",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
},
{
"name": "validateOnMount",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
},
{
"name": "validateOnSubmit",
"optional": true,
"readonly": false,
"type": "boolean | string[]",
"default": ""
}
],
"methods": []
}
}
},
"tokens": {
"description": "Define design tokens used by the component.",
"values": {
"useFormFieldState": {
"props": []
},
"useFormReturn": {
"props": []
},
"useFormResolverOptions": {
"props": []
},
"useFormOptions": {
"props": []
}
}
}
},
"accordion": { "accordion": {
"description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)", "description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)",
"components": { "components": {
@ -69917,54 +69227,6 @@
"default": "20rem", "default": "20rem",
"description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value." "description": "Height of the viewport, a scrollbar is defined if height of list exceeds this value."
}, },
{
"name": "placeholder",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Label to display when there are no selections."
},
{
"name": "size",
"optional": true,
"readonly": false,
"type": "\"small\" | \"large\"",
"default": "",
"description": "Defines the size of the component."
},
{
"name": "invalid",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, it specifies that the component should have invalid state style."
},
{
"name": "disabled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, it specifies that the component should be disabled."
},
{
"name": "variant",
"optional": true,
"readonly": false,
"type": "\"outlined\" | \"filled\"",
"default": "outlined",
"description": "Specifies the input variant of the component."
},
{
"name": "tabindex",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Index of the element in tabbing order."
},
{ {
"name": "selectionMode", "name": "selectionMode",
"optional": true, "optional": true,
@ -69989,14 +69251,6 @@
"default": "body", "default": "body",
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached." "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
}, },
{
"name": "emptyMessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "No available options",
"description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration."
},
{ {
"name": "display", "name": "display",
"optional": true, "optional": true,
@ -70005,6 +69259,22 @@
"default": "comma", "default": "comma",
"description": "Defines how the selected items are displayed." "description": "Defines how the selected items are displayed."
}, },
{
"name": "selectedItemsLabel",
"optional": true,
"readonly": false,
"type": "string",
"default": "null",
"description": "Label to display after exceeding max selected labels."
},
{
"name": "maxSelectedLabels",
"optional": true,
"readonly": false,
"type": "number",
"default": "",
"description": "Decides how many selected item labels to show at most."
},
{ {
"name": "metaKeySelection", "name": "metaKeySelection",
"optional": true, "optional": true,
@ -70077,6 +69347,62 @@
"default": "", "default": "",
"description": "Locale to use in filtering. The default locale is the host environment's current locale." "description": "Locale to use in filtering. The default locale is the host environment's current locale."
}, },
{
"name": "emptyMessage",
"optional": true,
"readonly": false,
"type": "string",
"default": "No available options",
"description": "Text to display when there are no options available. Defaults to value from PrimeVue locale configuration."
},
{
"name": "placeholder",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Label to display when there are no selections."
},
{
"name": "size",
"optional": true,
"readonly": false,
"type": "\"small\" | \"large\"",
"default": "",
"description": "Defines the size of the component."
},
{
"name": "invalid",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, it specifies that the component should have invalid state style."
},
{
"name": "disabled",
"optional": true,
"readonly": false,
"type": "boolean",
"default": "false",
"description": "When present, it specifies that the component should be disabled."
},
{
"name": "variant",
"optional": true,
"readonly": false,
"type": "\"outlined\" | \"filled\"",
"default": "outlined",
"description": "Specifies the input variant of the component."
},
{
"name": "tabindex",
"optional": true,
"readonly": false,
"type": "string",
"default": "",
"description": "Index of the element in tabbing order."
},
{ {
"name": "inputId", "name": "inputId",
"optional": true, "optional": true,