Skip to content
This repository was archived by the owner on Oct 30, 2023. It is now read-only.

Commit 62f6180

Browse files
committed
docs(Configuration): Provide some additional Info
1 parent aa91a44 commit 62f6180

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

docs/config/index.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,26 @@ Available Configuration options are:
44

55
<<< @/../src/module.ts#options
66

7+
## Options
8+
9+
| Option | Default | Config Section | Comment |
10+
|---------------|:-------:|:--------------------------------------|:--------------------------------------------|
11+
| config | | [Primevue](#primevue-configuration) | PrimeVue Config |
12+
| components | | [Component](#component-configuration) | Finetuning of used PrimeVue components |
13+
| useFormkit | true | [Formkit](#component-configuration) | Force to include components used by Formkit |
14+
| quiet | false | | Show module logs on startup |
15+
| includeDemo | true | | Include Demo Components |
16+
17+
718
## Default Configuration
819

920
If no configuration provided, this module work totally fine.
1021

11-
Nearly all PrimeVue components imported, formkit components imported global (except Editor because of some SSR problems).
22+
Nearly all PrimeVue components are imported (except Editor because of some SSR problems).
1223

13-
Default PrimeVueConfiguration is used (ripple:true).
24+
Default PrimeVueConfiguration is used with (ripple:true).
1425

15-
If fintuning needed, see information below.
26+
If fintuning is needed, see information below.
1627

1728
## Primevue Configuration
1829

docs/guide/formkit.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
# About Formkit Integration
22

3+
FormKit equips developers to build their forms 10x faster by simplifying form structure, generation, validation, theming, submission, error handling, and more.
4+
5+
In combination with PrimeVue it is an excellent choice for form validation.
6+
## Formkit - Primevue
7+
8+
Helper classes for using [Formkit](https://formkit.com/) with the [PrimeVue UI Framework](https://www.primefaces.org/primevue/#/)
9+
10+
### Usages
11+
12+
A Nuxt 3 Module (PrimeVue and Formkit bundled) under [nuxt-primevue](https://github.com/sfxcode/nuxt-primevue)
13+
14+
[Nuxt 3 PrimeVue Starter](https://github.com/sfxcode/nuxt3-primevue-starter) and [Vite PrimeVue Starter](https://github.com/sfxcode/vite-primevue-starter) with Formkit support available
15+
316

417
## Supported Inputs
518

619
Inputs are used in schema with **prime** as prefix and the **input name** as suffix.
720

821
::: warning
9-
Used inputs must be imported global (default), because of using in the startup phase.
22+
Used inputs used by FormKit must be imported global (default), because of using them in the startup phase.
1023
:::
1124

1225

docs/guide/primevue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Following **services** are automatically enabled by this module:
1616
* ConfirmationService
1717
* ToastService
1818

19-
**Components** are available based on your module configuration.
19+
**Components** are available based on your [module configuration](../config/#component-configuration).
2020

2121
## Usage in Application
2222

0 commit comments

Comments
 (0)