Skip to content

Commit 774572f

Browse files
committed
docs(README): Add PrimeOutputs and some minor text changes
1 parent 7a6cd40 commit 774572f

File tree

1 file changed

+31
-16
lines changed

1 file changed

+31
-16
lines changed

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Formkit - Primevue
22

3-
PrimeVue based formkit inputs for using [FormKit](https://formkit.com/) with the [PrimeVue UI Framework](https://www.primefaces.org/primevue/#/).
3+
PrimeVue based [FormKit Inputs](https://sfxcode.github.io/formkit-primevue/guide/inputs.html) for using [FormKit](https://formkit.com/) with the [PrimeVue UI Framework](https://www.primefaces.org/primevue/#/).
44

55
Main focus of this project is to provide configuration based forms with validation.
66

7+
In addition, you can use the same pattern for **data output** from **schema** using [PrimeOutputs](https://sfxcode.github.io/formkit-primevue/guide/outputs.html).
8+
79
## PrimeVue Versions
810

9-
Actual PrimeVue Version in the main branch is *4.x.*
11+
Actual PrimeVue Version of the main branch is *4.x.*
1012

11-
PrimeVue 3 is in the prime3 branch.
13+
PrimeVue 3 is in the prime3 branch, but future development will only focus on PrimeVue 4
1214

1315
## Docs
1416

@@ -30,13 +32,29 @@ app.use(plugin, defaultConfig({
3032
locales: { de, en },
3133
// Define the active locale
3234
locale: 'en',
33-
inputs: primeInputs,
35+
inputs: primeInputs,
3436
}))
3537
```
3638

39+
or if using also the output part
40+
41+
```typescript
42+
import { defaultConfig, plugin } from '@formkit/vue'
43+
import { primeInputs, primeOutputs } from '@sfxcode/formkit-primevue'
44+
45+
app.use(plugin, defaultConfig({
46+
locales: { de, en },
47+
// Define the active locale
48+
locale: 'en',
49+
inputs: { ...primeInputs, ...primeOutputs },
50+
}))
51+
```
52+
53+
Important: output elements depends on vue-i18n to style numbers, dates, ...
54+
3755
### Nuxt
3856

39-
Important: use *autoimport: false* if using primevue formkit validation and include or
57+
Important: use *autoimport: false* if using PrimeVue-FormKit validation and include or
4058
exclude not needed components as usual.
4159

4260
Autoimport true prevents elements lookup correctly.
@@ -72,7 +90,7 @@ Prefixing of the PrimeVue component names is not supported.
7290

7391
### Basic Styling
7492

75-
Basic styling is provided with the [formkit-primevue.scss](https://github.com/sfxcode/formkit-primevue/blob/main/src/sass/formkit-primevue.scss) file.
93+
Basic styling is provided with the [formkit-primevue.scss](https://github.com/sfxcode/formkit-primevue/blob/main/src/sass/formkit-primevue.scss) file or the corresponding css file in the package.
7694

7795
Features:
7896

@@ -84,20 +102,20 @@ You can use it or take it as base for your own styling.
84102

85103
### Extended Styling
86104

87-
- All inputs are wrapped in a div with a **p-formkit** class
88-
- Use *wrapperClass* to add additional styleclasses to wrapper div
89-
- Most Prime Components have access to class / styles attributes
90-
- Most Prime Components have access to class / styles attributes
105+
- Styling outerClas, innerClass .... is provided by FormKit
106+
- All inputs, outputs are wrapped in a div with a **p-formkit** class
107+
- Most of the Prime Input Components have access to class / styles attributes
91108
- PT and PTOptions are available ([https://primevue.org/passthrough/](https://primevue.org/passthrough/))
92109
- [Styling](https://formkit-primevue.netlify.app/styling/base) and [PT](https://formkit-primevue.netlify.app/styling/passThrough) demo available
110+
- [Grid](https://formkit-primevue.netlify.app/styling/grid) Demo of the provided grid styling (col-[1-12])
93111

94112
### Samples
95113

96114
Some samples for common tasks are available
97115

98-
- [Repeater](https://formkit-primevue.netlify.app/samples/repeater) (with the help of the useFormKitSchema composable)
99-
- [Grid](https://formkit-primevue.netlify.app/samples/grid)
100-
- [Input Editor](https://formkit-primevue.netlify.app/samples/inputEditor) (let you test the configurations in your schema file)
116+
- [Repeater](https://formkit-primevue.netlify.app/samples/repeater) Use Repeater composable for using repeating values in your schema
117+
- [Input Editor](https://formkit-primevue.netlify.app/samples/inputEditor) Edit FormKit schema on the based on a provided composable
118+
- [Form Editor](https://formkit-primevue.netlify.app/samples/formEditor) Basic demo as starter to create Forms visually
101119

102120
## Showcases
103121

@@ -131,7 +149,4 @@ Some samples for common tasks are available
131149
- ToggleSwitch
132150
- TreeSelect
133151

134-
## Demo
135-
[Demo/Playground](https://formkit-primevue.netlify.app/)
136-
137152
![](formkit-primevue.png)

0 commit comments

Comments
 (0)