Overview:
FormKit is a library that provides PrimeVue based FormKit Inputs for using FormKit with the PrimeVue UI Framework. The main focus of this project is to offer configuration-based forms with validation, with the ability to use the same pattern for data output from schema using PrimeOutputs.
Features:
- PrimeVue Nuxt Module: Integration of PrimeVue Nuxt Module for seamless usage.
- AutoImport of PrimeVue Form Components: Simplified process with automatic importing of PrimeVue Form Components.
- Schema Helper Functions: Functions like
useFormKitSchema
anduseInputEditorSchema
simplify usage of elements and component schema generation. - Basic and Extended Styling: Includes basic styling like setting width to 100% and error color variable, as well as extended styling options for further customization.
- Grid Demo and Samples: Provided grid styling demo, along with samples for common tasks like using the Repeater composable or creating forms visually.
Installation:
To install FormKit with PrimeVue, follow these steps:
- Add PrimeVue Nuxt Module, FormKit Nuxt Module, and i18n Nuxt Module to your project.
- Include the default configuration for FormKit with PrimeVue components, which can be disabled if necessary.
- Utilize the provided Basic Styling by including the formkit-primevue.scss or corresponding css file.
- For extended styling, take advantage of the features provided by FormKit, such as outerClass and innerClass styling.
- Use Schema Helper Functions like
useFormKitSchema
anduseInputEditorSchema
for simplified usage. - Explore the various samples available for common tasks and utilize the demo applications provided for a better understanding.
Summary:
FormKit is a powerful tool that leverages PrimeVue components to streamline the creation of configuration-based forms with validation. By offering a range of styling options, schema helper functions, and demo applications, FormKit simplifies the process of building dynamic forms within the PrimeVue UI Framework.