Installation
Prerequisites
- Vue.js 3.x
- Optional: A UI framework like PrimeVue, Vuetify or Quasar if you want to use one of the presets
Installation
You can install Enforma using npm or yarn:
shell
npm i @encolajs/enformashell
yarn add @encolajs/enformashell
pnpm add @encolajs/enformaBasic Configuration
js
import { createApp } from 'vue'
import { EnformaPlugin } from '@encolajs/enforma'
// Register Enforma with Vue
app.use(EnformaPlugin, {
// Global configuration options
pt: {
// Pass-through props for styling components
wrapper: {
class: 'my-field-wrapper',
},
label: {
class: 'my-field-label',
},
input: {
class: 'my-field-input',
},
error: {
class: 'my-field-error',
},
},
})Adding a Preset
If you're using PrimeVue, Enforma provides a preset that integrates seamlessly with PrimeVue components.
Install PrimeVue First
bash
npm install primevueConfigure Enforma with PrimeVue Preset
js
import { usePrimeVuePreset } from '@encolajs/enforma/presets/primevue'
// initialization of the Enforma plugin goes here
usePrimeVuePreset()Next Steps
For more detailed information about configuring Enforma:
- See Configuration for a complete reference of all configuration options
- Learn about UI Presets to integrate with various UI libraries
