diff --git a/apps/showcase/assets/menu/menu.json b/apps/showcase/assets/menu/menu.json index e0f4040ee..d55245ba6 100644 --- a/apps/showcase/assets/menu/menu.json +++ b/apps/showcase/assets/menu/menu.json @@ -497,6 +497,12 @@ } ] }, + { + "name": "Forms", + "icon": "pi pi-check-circle", + "to": "/forms", + "badge": "NEW" + }, { "name": "Pass Through", "icon": "pi pi-directions", diff --git a/apps/showcase/components/doc/DocApiSection.vue b/apps/showcase/components/doc/DocApiSection.vue index 1341e1d2b..8db4629e3 100644 --- a/apps/showcase/components/doc/DocApiSection.vue +++ b/apps/showcase/components/doc/DocApiSection.vue @@ -69,7 +69,7 @@ export default { interfaces = this.findOtherInterfaces(values, docName); } - const types = APIDocs[moduleName]['types']; + const types = APIDocs[moduleName]?.['types']; const services = modelValues; // (TerminalService && ConfirmationService && ToastService) diff --git a/apps/showcase/components/doc/codeeditor/templates.js b/apps/showcase/components/doc/codeeditor/templates.js index f2f05c54e..b45b8897d 100644 --- a/apps/showcase/components/doc/codeeditor/templates.js +++ b/apps/showcase/components/doc/codeeditor/templates.js @@ -16,6 +16,7 @@ const core_dependencies = { primevue: pkg.version || PrimeVue.version || 'latest', '@primevue/themes': pkg.version || PrimeVue.version || 'latest', '@primevue/auto-import-resolver': pkg.version || PrimeVue.version || 'latest', + '@primevue/form': pkg.version || PrimeVue.version || 'latest', primeicons: app_dependencies['primeicons'] || 'latest', tailwindcss: app_dependencies['tailwindcss'] || 'latest', autoprefixer: app_dependencies['autoprefixer'] || 'latest', diff --git a/apps/showcase/components/landing/samples/CustomersApp.vue b/apps/showcase/components/landing/samples/CustomersApp.vue index f704cc66a..54083affb 100644 --- a/apps/showcase/components/landing/samples/CustomersApp.vue +++ b/apps/showcase/components/landing/samples/CustomersApp.vue @@ -248,7 +248,6 @@ export default { selectedRows: [] }; }, - methods: { displayPopover(event) { this.hidePopover(); diff --git a/apps/showcase/doc/autocomplete/FormsDoc.vue b/apps/showcase/doc/autocomplete/FormsDoc.vue new file mode 100644 index 000000000..d49f459a0 --- /dev/null +++ b/apps/showcase/doc/autocomplete/FormsDoc.vue @@ -0,0 +1,202 @@ + + + diff --git a/apps/showcase/doc/cascadeselect/FormsDoc.vue b/apps/showcase/doc/cascadeselect/FormsDoc.vue new file mode 100644 index 000000000..dd2963ea5 --- /dev/null +++ b/apps/showcase/doc/cascadeselect/FormsDoc.vue @@ -0,0 +1,366 @@ + + + diff --git a/apps/showcase/doc/checkbox/FormsDoc.vue b/apps/showcase/doc/checkbox/FormsDoc.vue new file mode 100644 index 000000000..ad517adf4 --- /dev/null +++ b/apps/showcase/doc/checkbox/FormsDoc.vue @@ -0,0 +1,204 @@ + + + diff --git a/apps/showcase/doc/colorpicker/FormsDoc.vue b/apps/showcase/doc/colorpicker/FormsDoc.vue new file mode 100644 index 000000000..71b66f478 --- /dev/null +++ b/apps/showcase/doc/colorpicker/FormsDoc.vue @@ -0,0 +1,130 @@ + + + diff --git a/apps/showcase/doc/common/apidoc/index.json b/apps/showcase/doc/common/apidoc/index.json index 231c56998..d590e087e 100644 --- a/apps/showcase/doc/common/apidoc/index.json +++ b/apps/showcase/doc/common/apidoc/index.json @@ -1,4 +1,694 @@ { + "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", + "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": "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", + "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", + "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" + } + } + } + }, + "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", + "default": "" + } + ], + "methods": [] + }, + "useFormResolverOptions": { + "relatedProp": "", + "props": [ + { + "name": "values", + "optional": false, + "readonly": false, + "type": "Record", + "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", + "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": { "description": "Accordion groups a collection of contents in tabs.\n\n[Live Demo](https://www.primevue.org/accordion/)", "components": { @@ -637,7 +1327,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "DIV", "description": "Use to change the HTML tag of root element." }, @@ -924,7 +1614,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "BUTTON", "description": "Use to change the HTML tag of root element." }, @@ -1225,7 +1915,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "DIV", "description": "Use to change the HTML tag of root element." }, @@ -2485,6 +3175,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "suggestions", "optional": true, @@ -2862,6 +3568,14 @@ "default": "", "description": "Identifier of the underlying input element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -3096,6 +3810,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -5659,7 +6386,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "BUTTON", "description": "Use to change the HTML tag of root element." }, @@ -8095,6 +8822,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "options", "optional": true, @@ -8418,6 +9161,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -8552,6 +9303,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -9397,6 +10161,14 @@ "default": "", "description": "Value binding of the checkbox." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, { "name": "name", "optional": true, @@ -9525,6 +10297,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -9629,6 +10409,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -9782,6 +10575,315 @@ } } }, + "checkboxgroup": { + "description": "CheckboxGroup is a component that groups multiple checkboxes, allowing users to select one or more options.\n\n[Live Demo](https://www.primevue.org/checkbox/)", + "components": { + "default": { + "description": "CheckboxGroup is a component that groups multiple checkboxes, allowing users to select one or more options.", + "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": { + "CheckboxGroupPassThroughMethodOptions": { + "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": "CheckboxGroupProps", + "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": [] + }, + "CheckboxGroupPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "undefined.FloatLabelProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "CheckboxGroupPassThroughOptionType", + "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": [] + }, + "CheckboxGroupPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "CheckboxGroupProps": { + "description": "Defines valid properties in CheckboxGroup component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Value binding of the checkboxes." + }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Default values of the checkboxes in uncontrolled mode." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the input elements." + }, + { + "name": "invalid", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should have invalid state style." + }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Used to set form control options." + }, + { + "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", + "default": "", + "description": "Used to pass attributes to DOM elements inside the component." + }, + { + "name": "ptOptions", + "optional": true, + "readonly": false, + "type": "any", + "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": [] + }, + "CheckboxGroupSlots": { + "description": "Defines valid slots in CheckboxGroup component.", + "relatedProp": "", + "props": [ + { + "name": "default", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "methods": [] + }, + "CheckboxGroupEmitsOptions": { + "description": "Defines valid emits in CheckboxGroup component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + } + ] + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "CheckboxGroupPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "props": [] + }, + "CheckboxGroupPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "props": [] + }, + "CheckboxGroupPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "props": [] + }, + "CheckboxGroupProps": { + "description": "Defines valid properties in CheckboxGroup component.", + "props": [] + }, + "CheckboxGroupSlots": { + "description": "Defines valid slots in CheckboxGroup component.", + "props": [] + }, + "CheckboxGroupEmitsOptions": { + "description": "Defines valid emits in CheckboxGroup component.", + "props": [] + } + } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "CheckboxGroupPassThroughOptionType": { + "values": "CheckboxGroupPassThroughAttributes | (options: CheckboxGroupPassThroughMethodOptions) => undefined | string | null | undefined" + }, + "CheckboxGroupEmits": { + "values": "EmitFn" + } + } + } + }, + "checkboxgroupstyle": { + "description": "CheckboxGroup is a component that groups multiple checkboxes, allowing users to select one or more options.\n\n[Live Demo](https://www.primevue.org/checkbox/)", + "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": { + "CheckboxGroupStyle": { + "relatedProp": "", + "props": [], + "methods": [], + "extendedTypes": "default" + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "CheckboxGroupStyle": { + "props": [] + } + } + }, + "enumerations": { + "values": { + "CheckboxGroupClasses": { + "members": [ + { + "name": "root", + "optional": false, + "readonly": false, + "value": "\"p-checkbox-group\"", + "description": "Class name of the root element" + } + ] + } + } + } + }, "chip": { "description": "Chip represents people using icons, labels and images.\n\n[Live Demo](https://www.primevue.org/chip)", "components": { @@ -10596,6 +11698,22 @@ "default": "ff0000", "description": "Initial color to display when value is not defined." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "inline", "optional": true, @@ -10612,6 +11730,14 @@ "default": "hex", "description": "Format to use in value binding, supported formats are 'hex', 'rgb' and 'hsb'." }, + { + "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, @@ -10677,6 +11803,14 @@ "default": "body", "description": "A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -10735,6 +11869,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -12919,6 +14066,13 @@ "type": "any", "default": "" }, + { + "name": "checkboxgroup", + "optional": true, + "readonly": false, + "type": "any", + "default": "" + }, { "name": "chip", "optional": true, @@ -13347,6 +14501,13 @@ "type": "any", "default": "" }, + { + "name": "radiobuttongroup", + "optional": true, + "readonly": false, + "type": "any", + "default": "" + }, { "name": "rating", "optional": true, @@ -20894,6 +22055,22 @@ "default": "null", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "null | Date | Date[] | (null | Date)[]", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "selectionMode", "optional": true, @@ -21238,14 +22415,6 @@ "default": "", "description": "Placeholder text for the input." }, - { - "name": "name", - "optional": true, - "readonly": false, - "type": "string", - "default": "", - "description": "Name of the element." - }, { "name": "appendTo", "optional": true, @@ -21358,6 +22527,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -21610,6 +22787,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "undefined | null | Date | Date[] | (null | Date)[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "input", "parameters": [ @@ -25533,6 +26723,22 @@ "default": "", "description": "Value of the content." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "placeholder", "optional": true, @@ -25549,6 +26755,14 @@ "default": "false", "description": "Whether to instantiate the editor to readonly mode." }, + { + "name": "invalid", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should have invalid state style." + }, { "name": "formats", "optional": true, @@ -25573,6 +26787,14 @@ "default": "", "description": "Modules configuration, see here for available options." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -25640,6 +26862,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": "text-change", "parameters": [ @@ -33055,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, @@ -33240,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": [ @@ -33604,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." }, { @@ -33671,6 +34936,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "format", "optional": true, @@ -33961,6 +35242,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -34071,6 +35360,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "input", "parameters": [ @@ -34477,6 +35779,22 @@ "default": "null", "description": "Specifies whether a inputotp should be checked or not." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "string | boolean", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "invalid", "optional": true, @@ -34541,6 +35859,14 @@ "default": "false", "description": "When present, it specifies that an input field is integer-only." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -34613,6 +35939,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -35034,6 +36373,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "size", "optional": true, @@ -35066,6 +36421,14 @@ "default": "null", "description": "Spans 100% width of the container when enabled." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -35125,6 +36488,19 @@ ], "returnType": "void", "description": "Emitted when the value changes." + }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "undefined | string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." } ] } @@ -35684,6 +37060,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "size", "optional": true, @@ -35692,6 +37084,14 @@ "default": "100", "description": "Size of the component in pixels." }, + { + "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, @@ -35803,6 +37203,14 @@ "default": "", "description": "Used to define a string that labels the element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -35855,19 +37263,34 @@ { "name": "value", "optional": false, - "type": "number" + "type": "number", + "description": "New value." } ], "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ { "name": "value", "optional": false, - "type": "number" + "type": "number", + "description": "New value" } ], "returnType": "void", @@ -36409,6 +37832,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "options", "optional": true, @@ -36681,6 +38120,14 @@ "default": "", "description": "Identifier of the underlying input element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -36844,6 +38291,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -41105,6 +42565,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "options", "optional": true, @@ -41515,6 +42991,14 @@ "default": "", "description": "Identifier of the underlying input element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -41783,6 +43267,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -46743,6 +48240,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "promptLabel", "optional": true, @@ -46999,6 +48512,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -47132,6 +48653,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": "change", "parameters": [ @@ -49764,6 +51298,14 @@ "default": "", "description": "Value binding of the checkbox." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, { "name": "name", "optional": true, @@ -49860,6 +51402,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -49941,6 +51491,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -50093,6 +51656,315 @@ } } }, + "radiobuttongroup": { + "description": "RadioButtonGroup is a component that groups multiple radio buttons, allowing users to select only one option from the group.\n\n[Live Demo](https://www.primevue.org/radiobutton/)", + "components": { + "default": { + "description": "RadioButtonGroup is a component that groups multiple radio buttons, allowing users to select only one option from the group.", + "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": { + "RadioButtonGroupPassThroughMethodOptions": { + "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": "RadioButtonGroupProps", + "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": [] + }, + "RadioButtonGroupPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "relatedProp": "RadioButtonGroupProps.pt", + "props": [ + { + "name": "root", + "optional": true, + "readonly": false, + "type": "RadioButtonGroupPassThroughOptionType", + "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": [] + }, + "RadioButtonGroupPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "relatedProp": "", + "props": [ + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "RadioButtonGroupProps": { + "description": "Defines valid properties in RadioButtonGroup component.", + "relatedProp": "", + "props": [ + { + "name": "modelValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Value binding of the radiobuttons." + }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Default values of the radiobuttons in uncontrolled mode." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "Name of the input elements." + }, + { + "name": "invalid", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "false", + "description": "When present, it specifies that the component should have invalid state style." + }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "Used to set form control options." + }, + { + "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", + "default": "", + "description": "Used to pass attributes to DOM elements inside the component." + }, + { + "name": "ptOptions", + "optional": true, + "readonly": false, + "type": "any", + "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": [] + }, + "RadioButtonGroupSlots": { + "description": "Defines valid slots in RadioButtonGroup component.", + "relatedProp": "", + "props": [ + { + "name": "default", + "optional": false, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "methods": [] + }, + "RadioButtonGroupEmitsOptions": { + "description": "Defines valid emits in RadioButtonGroup component.", + "relatedProp": "", + "props": [], + "methods": [ + { + "name": "update:modelValue", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes." + }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + } + ] + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "RadioButtonGroupPassThroughMethodOptions": { + "description": "Custom passthrough(pt) option method.", + "props": [] + }, + "RadioButtonGroupPassThroughOptions": { + "description": "Custom passthrough(pt) options.", + "props": [] + }, + "RadioButtonGroupPassThroughAttributes": { + "description": "Custom passthrough attributes for each DOM elements", + "props": [] + }, + "RadioButtonGroupProps": { + "description": "Defines valid properties in RadioButtonGroup component.", + "props": [] + }, + "RadioButtonGroupSlots": { + "description": "Defines valid slots in RadioButtonGroup component.", + "props": [] + }, + "RadioButtonGroupEmitsOptions": { + "description": "Defines valid emits in RadioButtonGroup component.", + "props": [] + } + } + }, + "types": { + "description": "Defines the custom types used by the module.", + "values": { + "RadioButtonGroupPassThroughOptionType": { + "values": "RadioButtonGroupPassThroughAttributes | (options: RadioButtonGroupPassThroughMethodOptions) => undefined | string | null | undefined" + }, + "RadioButtonGroupEmits": { + "values": "EmitFn" + } + } + } + }, + "radiobuttongroupstyle": { + "description": "RadioButtonGroup is a component that groups multiple radio buttons, allowing users to select only one option from the group.\n\n[Live Demo](https://www.primevue.org/radiobuttongroup/)", + "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": { + "RadioButtonGroupStyle": { + "relatedProp": "", + "props": [], + "methods": [], + "extendedTypes": "default" + } + } + }, + "tokens": { + "description": "Define design tokens used by the component.", + "values": { + "RadioButtonGroupStyle": { + "props": [] + } + } + }, + "enumerations": { + "values": { + "RadioButtonGroupClasses": { + "members": [ + { + "name": "root", + "optional": false, + "readonly": false, + "value": "\"p-radiobutton-group\"", + "description": "Class name of the root element" + } + ] + } + } + } + }, "rating": { "description": "Rating component is a star based selection input.\n\n[Live Demo](https://www.primevue.org/rating/)", "components": { @@ -50330,6 +52202,14 @@ "default": "", "description": "Value of the rating." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "number", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, { "name": "name", "optional": true, @@ -50338,6 +52218,14 @@ "default": "", "description": "Name of the element." }, + { + "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, @@ -50378,6 +52266,14 @@ "default": "", "description": "Icon for the off state." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -50464,6 +52360,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -52232,6 +54141,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "options", "optional": true, @@ -52661,6 +54586,14 @@ "default": "", "description": "Identifier of the underlying input element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -52876,6 +54809,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -53407,6 +55353,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "options", "optional": true, @@ -53487,6 +55449,14 @@ "default": "", "description": "Identifier of the underlying element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -53560,6 +55530,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -54296,6 +56279,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "number | number[]", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "min", "optional": true, @@ -54336,6 +56335,14 @@ "default": "false", "description": "When speficed, allows two boundary values to be picked." }, + { + "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, @@ -54368,6 +56375,14 @@ "default": "", "description": "Used to define a string that labels the element." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -54427,6 +56442,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "number | number[]", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -56841,7 +58869,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "BUTTON", "description": "Use to change the HTML tag of root element." }, @@ -57614,7 +59642,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "BUTTON", "description": "Use to change the HTML tag of root element." }, @@ -59086,7 +61114,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "BUTTON", "description": "Use to change the HTML tag of root element." }, @@ -60252,7 +62280,7 @@ "name": "as", "optional": true, "readonly": false, - "type": "string | Component", + "type": "string | Component", "default": "DIV", "description": "Use to change the HTML tag of root element." }, @@ -62179,6 +64207,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "Nullable", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "autoResize", "optional": true, @@ -62211,6 +64255,14 @@ "default": "null", "description": "Spans 100% width of the container when enabled." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -62265,7 +64317,21 @@ "default": "" } ], - "methods": [] + "methods": [ + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "string", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + } + ] } } }, @@ -64503,6 +66569,22 @@ "default": "false", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "boolean", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "onIcon", "optional": true, @@ -64583,6 +66665,14 @@ "default": "", "description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -64662,6 +66752,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -64948,6 +67051,22 @@ "default": "false", "description": "Specifies whether a toggleswitch should be checked or not." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "string | boolean", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "trueValue", "optional": true, @@ -65036,6 +67155,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -65131,6 +67258,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "boolean", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "change", "parameters": [ @@ -67456,6 +69596,22 @@ "default": "", "description": "Value of the component." }, + { + "name": "defaultValue", + "optional": true, + "readonly": false, + "type": "any", + "default": "", + "description": "The default value for the input when not controlled by `modelValue` ." + }, + { + "name": "name", + "optional": true, + "readonly": false, + "type": "string", + "default": "", + "description": "The name attribute for the element, typically used in form submissions." + }, { "name": "options", "optional": true, @@ -67688,6 +69844,14 @@ "default": "", "description": "Establishes a string value that labels the component." }, + { + "name": "formControl", + "optional": true, + "readonly": false, + "type": "Record", + "default": "", + "description": "Form control object, typically used for handling validation and form state." + }, { "name": "dt", "optional": true, @@ -67873,6 +70037,19 @@ "returnType": "void", "description": "Emitted when the value changes." }, + { + "name": "value-change", + "parameters": [ + { + "name": "value", + "optional": false, + "type": "any", + "description": "New value." + } + ], + "returnType": "void", + "description": "Emitted when the value changes in uncontrolled mode." + }, { "name": "update:expandedKeys", "parameters": [ diff --git a/apps/showcase/doc/datepicker/FormsDoc.vue b/apps/showcase/doc/datepicker/FormsDoc.vue new file mode 100644 index 000000000..4726e13c0 --- /dev/null +++ b/apps/showcase/doc/datepicker/FormsDoc.vue @@ -0,0 +1,148 @@ + + + diff --git a/apps/showcase/doc/editor/FormsDoc.vue b/apps/showcase/doc/editor/FormsDoc.vue new file mode 100644 index 000000000..fb16aab20 --- /dev/null +++ b/apps/showcase/doc/editor/FormsDoc.vue @@ -0,0 +1,130 @@ + + + diff --git a/apps/showcase/doc/forms/AccessibilityDoc.vue b/apps/showcase/doc/forms/AccessibilityDoc.vue new file mode 100644 index 000000000..ffa9ca937 --- /dev/null +++ b/apps/showcase/doc/forms/AccessibilityDoc.vue @@ -0,0 +1,9 @@ + diff --git a/apps/showcase/doc/forms/BasicDoc.vue b/apps/showcase/doc/forms/BasicDoc.vue new file mode 100644 index 000000000..140bf3b63 --- /dev/null +++ b/apps/showcase/doc/forms/BasicDoc.vue @@ -0,0 +1,151 @@ + + + diff --git a/apps/showcase/doc/forms/DynamicDoc.vue b/apps/showcase/doc/forms/DynamicDoc.vue new file mode 100644 index 000000000..c20181585 --- /dev/null +++ b/apps/showcase/doc/forms/DynamicDoc.vue @@ -0,0 +1,357 @@ + + + diff --git a/apps/showcase/doc/forms/ImportDoc.vue b/apps/showcase/doc/forms/ImportDoc.vue new file mode 100644 index 000000000..e6b51a67a --- /dev/null +++ b/apps/showcase/doc/forms/ImportDoc.vue @@ -0,0 +1,18 @@ + + + diff --git a/apps/showcase/doc/forms/RegisterDoc.vue b/apps/showcase/doc/forms/RegisterDoc.vue new file mode 100644 index 000000000..9838a8bbf --- /dev/null +++ b/apps/showcase/doc/forms/RegisterDoc.vue @@ -0,0 +1,159 @@ + + + + diff --git a/apps/showcase/doc/forms/ResolversDoc.vue b/apps/showcase/doc/forms/ResolversDoc.vue new file mode 100644 index 000000000..aaeee7961 --- /dev/null +++ b/apps/showcase/doc/forms/ResolversDoc.vue @@ -0,0 +1,347 @@ + + + diff --git a/apps/showcase/doc/forms/StatesDoc.vue b/apps/showcase/doc/forms/StatesDoc.vue new file mode 100644 index 000000000..5780eb8e8 --- /dev/null +++ b/apps/showcase/doc/forms/StatesDoc.vue @@ -0,0 +1,165 @@ + + + diff --git a/apps/showcase/doc/forms/SubmitDoc.vue b/apps/showcase/doc/forms/SubmitDoc.vue new file mode 100644 index 000000000..7a4a817b8 --- /dev/null +++ b/apps/showcase/doc/forms/SubmitDoc.vue @@ -0,0 +1,230 @@ + + + diff --git a/apps/showcase/doc/forms/ValidateOnDoc.vue b/apps/showcase/doc/forms/ValidateOnDoc.vue new file mode 100644 index 000000000..f48e52287 --- /dev/null +++ b/apps/showcase/doc/forms/ValidateOnDoc.vue @@ -0,0 +1,210 @@ + + + diff --git a/apps/showcase/doc/forms/dynamic/DynamicForm.vue b/apps/showcase/doc/forms/dynamic/DynamicForm.vue new file mode 100644 index 000000000..37325b71c --- /dev/null +++ b/apps/showcase/doc/forms/dynamic/DynamicForm.vue @@ -0,0 +1,46 @@ + + + diff --git a/apps/showcase/doc/forms/dynamic/DynamicFormControl.vue b/apps/showcase/doc/forms/dynamic/DynamicFormControl.vue new file mode 100644 index 000000000..02f7d84ed --- /dev/null +++ b/apps/showcase/doc/forms/dynamic/DynamicFormControl.vue @@ -0,0 +1,28 @@ + + + diff --git a/apps/showcase/doc/forms/dynamic/DynamicFormField.vue b/apps/showcase/doc/forms/dynamic/DynamicFormField.vue new file mode 100644 index 000000000..2746618ce --- /dev/null +++ b/apps/showcase/doc/forms/dynamic/DynamicFormField.vue @@ -0,0 +1,25 @@ + + + diff --git a/apps/showcase/doc/forms/dynamic/DynamicFormLabel.vue b/apps/showcase/doc/forms/dynamic/DynamicFormLabel.vue new file mode 100644 index 000000000..17ae2186a --- /dev/null +++ b/apps/showcase/doc/forms/dynamic/DynamicFormLabel.vue @@ -0,0 +1,13 @@ + + + diff --git a/apps/showcase/doc/forms/dynamic/DynamicFormMessage.vue b/apps/showcase/doc/forms/dynamic/DynamicFormMessage.vue new file mode 100644 index 000000000..118b931bc --- /dev/null +++ b/apps/showcase/doc/forms/dynamic/DynamicFormMessage.vue @@ -0,0 +1,32 @@ + + + diff --git a/apps/showcase/doc/forms/dynamic/DynamicFormSubmit.vue b/apps/showcase/doc/forms/dynamic/DynamicFormSubmit.vue new file mode 100644 index 000000000..a212395f3 --- /dev/null +++ b/apps/showcase/doc/forms/dynamic/DynamicFormSubmit.vue @@ -0,0 +1,18 @@ + + + diff --git a/apps/showcase/doc/forms/pt/PTViewer.vue b/apps/showcase/doc/forms/pt/PTViewer.vue new file mode 100644 index 000000000..ab78888fe --- /dev/null +++ b/apps/showcase/doc/forms/pt/PTViewer.vue @@ -0,0 +1,45 @@ + + + diff --git a/apps/showcase/doc/forms/pt/index.vue b/apps/showcase/doc/forms/pt/index.vue new file mode 100644 index 000000000..620ee4f5c --- /dev/null +++ b/apps/showcase/doc/forms/pt/index.vue @@ -0,0 +1,35 @@ + + + diff --git a/apps/showcase/doc/forms/theming/StyledDoc.vue b/apps/showcase/doc/forms/theming/StyledDoc.vue new file mode 100644 index 000000000..e09e42c80 --- /dev/null +++ b/apps/showcase/doc/forms/theming/StyledDoc.vue @@ -0,0 +1,5 @@ + diff --git a/apps/showcase/doc/forms/theming/index.vue b/apps/showcase/doc/forms/theming/index.vue new file mode 100644 index 000000000..6ced07c42 --- /dev/null +++ b/apps/showcase/doc/forms/theming/index.vue @@ -0,0 +1,27 @@ + + + diff --git a/apps/showcase/doc/imagecompare/pt/PTViewer.vue b/apps/showcase/doc/imagecompare/pt/PTViewer.vue index f4f60a89c..f5d190652 100644 --- a/apps/showcase/doc/imagecompare/pt/PTViewer.vue +++ b/apps/showcase/doc/imagecompare/pt/PTViewer.vue @@ -2,10 +2,10 @@ diff --git a/apps/showcase/doc/inputmask/BasicDoc.vue b/apps/showcase/doc/inputmask/BasicDoc.vue index aebe30225..0224cddc8 100644 --- a/apps/showcase/doc/inputmask/BasicDoc.vue +++ b/apps/showcase/doc/inputmask/BasicDoc.vue @@ -33,7 +33,6 @@ export default { } } <\/script> - `, composition: `