feat: add PrimeVue input and output components documentation

sfxcode · sfxcode · commit 053aee357800 · 2025-08-03T22:12:21.000+02:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Formkit - Primevue
 
-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/#/).
+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://primevue.org/#/).
 
 Main focus of this project is to provide configuration based forms with validation.
 
diff --git a/docs/component/PrimeAutoComplete.md b/docs/component/PrimeAutoComplete.md
@@ -61,5 +61,5 @@ const schema = [
 | fluid        | boolean   | Full width input |
 | separators   | array     | Separators for multiple values |
 
-See [PrimeVue AutoComplete docs](https://www.primefaces.org/primevue/autocomplete/) for more details.
+See [PrimeVue AutoComplete docs](https://primevue.org/autocomplete/) for more details.
 
diff --git a/docs/component/PrimeCascadeSelect.md b/docs/component/PrimeCascadeSelect.md
@@ -76,5 +76,5 @@ const schema = [
 | unstyled          | boolean | Disable default styles |
 | size              | string  | Input size |
 
-See [PrimeVue CascadeSelect docs](https://www.primefaces.org/primevue/cascadeselect/) for more details.
+See [PrimeVue CascadeSelect docs](https://primevue.org/cascadeselect/) for more details.
 
diff --git a/docs/component/PrimeCheckbox.md b/docs/component/PrimeCheckbox.md
@@ -30,4 +30,4 @@ const data = { readonly: true }
 
 ## Props
 // ...existing code...
-See [PrimeVue Checkbox docs](https://www.primefaces.org/primevue/checkbox/) for more details.
+See [PrimeVue Checkbox docs](https://primevue.org/checkbox/) for more details.
diff --git a/docs/component/PrimeColorPicker.md b/docs/component/PrimeColorPicker.md
@@ -35,4 +35,4 @@ const data = {}
 | ptOptions    | object    | Pass-through options |
 | unstyled     | boolean   | Disable default styles |
 
-See [PrimeVue ColorPicker docs](https://www.primefaces.org/primevue/colorpicker/) for more details.
+See [PrimeVue ColorPicker docs](https://primevue.org/colorpicker/) for more details.
diff --git a/docs/component/PrimeDatePicker.md b/docs/component/PrimeDatePicker.md
@@ -39,4 +39,4 @@ const data = {}
 | manualInput  | boolean   | Allow manual input |
 | ...          | ...       | See PrimeVue docs for all props |
 
-See [PrimeVue DatePicker docs](https://www.primefaces.org/primevue/datepicker/) for more details.
+See [PrimeVue DatePicker docs](https://primevue.org/datepicker/) for more details.
diff --git a/docs/component/PrimeInputMask.md b/docs/component/PrimeInputMask.md
@@ -39,4 +39,4 @@ const data = {}
 | variant      | string    | Visual variant |
 | size         | string    | Input size |
 
-See [PrimeVue InputMask docs](https://www.primefaces.org/primevue/inputmask/) for more details.
+See [PrimeVue InputMask docs](https://primevue.org/inputmask/) for more details.
diff --git a/docs/component/PrimeInputNumber.md b/docs/component/PrimeInputNumber.md
@@ -49,4 +49,4 @@ const data = {}
 | placeholder       | string    | Placeholder text |
 | size              | string    | Input size |
 
-See [PrimeVue InputNumber docs](https://www.primefaces.org/primevue/inputnumber/) for more details.
+See [PrimeVue InputNumber docs](https://primevue.org/inputnumber/) for more details.
diff --git a/docs/component/PrimeInputOtp.md b/docs/component/PrimeInputOtp.md
@@ -36,4 +36,4 @@ const data = {}
 | unstyled     | boolean   | Disable default styles |
 | size         | string    | Input size |
 
-See [PrimeVue InputOtp docs](https://www.primefaces.org/primevue/inputotp/) for more details.
+See [PrimeVue InputOtp docs](https://primevue.org/inputotp/) for more details.
diff --git a/docs/component/PrimeInputText.md b/docs/component/PrimeInputText.md
@@ -36,4 +36,4 @@ const data = { name: 'Harry Potter', iconLeft: 'Some Text ...', iconRight: 'Anot
 | inputType    | string    | Input type (e.g. text, tel) |
 | placeholder  | string    | Placeholder text |
 
-See [PrimeVue InputText docs](https://www.primefaces.org/primevue/inputtext/) for more details.
+See [PrimeVue InputText docs](https://primevue.org/inputtext/) for more details.
diff --git a/docs/component/PrimeKnob.md b/docs/component/PrimeKnob.md
@@ -41,4 +41,4 @@ const data = {}
 | textColor    | string    | Text color |
 | valueTemplate| string    | Value template |
 
-See [PrimeVue Knob docs](https://www.primefaces.org/primevue/knob/) for more details.
+See [PrimeVue Knob docs](https://primevue.org/knob/) for more details.
diff --git a/docs/component/PrimeListbox.md b/docs/component/PrimeListbox.md
@@ -48,4 +48,4 @@ const data = {}
 | autoOptionFocus | boolean | Auto focus option |
 | selectOnFocus | boolean  | Select on focus |
 
-See [PrimeVue Listbox docs](https://www.primefaces.org/primevue/listbox/) for more details.
+See [PrimeVue Listbox docs](https://primevue.org/listbox/) for more details.
diff --git a/docs/component/PrimeMultiSelect.md b/docs/component/PrimeMultiSelect.md
@@ -44,4 +44,4 @@ const data = {}
 | size         | string    | Input size |
 | ...          | ...       | See PrimeVue docs for all props |
 
-See [PrimeVue MultiSelect docs](https://www.primefaces.org/primevue/multiselect/) for more details.
+See [PrimeVue MultiSelect docs](https://primevue.org/multiselect/) for more details.
diff --git a/docs/component/PrimeOutputBoolean.md b/docs/component/PrimeOutputBoolean.md
@@ -39,4 +39,4 @@ const data = { trueValue: true, falseValue: false }
 | iconPrefix   | string    | Icon for prefix |
 | iconSuffix   | string    | Icon for suffix |
 
-See [PrimeOutputBoolean source](../../src/components/PrimeOutputBoolean.vue) for more details.
+See [PrimeOutputBoolean source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputBoolean.vue) for more details.
diff --git a/docs/component/PrimeOutputDate.md b/docs/component/PrimeOutputDate.md
@@ -34,4 +34,4 @@ const data = { date1: new Date(), date2: new Date(), date3: new Date() }
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputDate source for all props |
 
-See [PrimeOutputDate source](../../src/components/PrimeOutputDate.vue) for more details.
+See [PrimeOutputDate source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputDate.vue) for more details.
diff --git a/docs/component/PrimeOutputDuration.md b/docs/component/PrimeOutputDuration.md
@@ -37,4 +37,4 @@ const data = { duration1: '142', duration2: '4h35m', duration3: '3:47' }
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputDuration source for all props |
 
-See [PrimeOutputDuration source](../../src/components/PrimeOutputDuration.vue) for more details.
+See [PrimeOutputDuration source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputDuration.vue) for more details.
diff --git a/docs/component/PrimeOutputLink.md b/docs/component/PrimeOutputLink.md
@@ -34,4 +34,4 @@ const data = { link1: 'https://github.com/sfxcode', link2: 'sfxcode.github.io/fo
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputLink source for all props |
 
-See [PrimeOutputLink source](../../src/components/PrimeOutputLink.vue) for more details.
+See [PrimeOutputLink source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputLink.vue) for more details.
diff --git a/docs/component/PrimeOutputList.md b/docs/component/PrimeOutputList.md
@@ -55,4 +55,4 @@ const data = { list1: ['Hello', 'World'], list2: ['FormKit', 'meets', 'PrimeVue'
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputList source for all props |
 
-See [PrimeOutputList source](../../src/components/PrimeOutputList.vue) for more details.
+See [PrimeOutputList source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputList.vue) for more details.
diff --git a/docs/component/PrimeOutputNumber.md b/docs/component/PrimeOutputNumber.md
@@ -35,4 +35,4 @@ const data = { mumber1: 12.2, number2: 42.0, number3: 20000 }
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputNumber source for all props |
 
-See [PrimeOutputNumber source](../../src/components/PrimeOutputNumber.vue) for more details.
+See [PrimeOutputNumber source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputNumber.vue) for more details.
diff --git a/docs/component/PrimeOutputReference.md b/docs/component/PrimeOutputReference.md
@@ -38,4 +38,4 @@ const data = { externalId: 42, externalValue: 'formkit-primevue', internalLink:
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputReference source for all props |
 
-See [PrimeOutputReference source](../../src/components/PrimeOutputReference.vue) for more details.
+See [PrimeOutputReference source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputReference.vue) for more details.
diff --git a/docs/component/PrimeOutputText.md b/docs/component/PrimeOutputText.md
@@ -45,4 +45,4 @@ const data = { name: 'Harry Potter', toTranslate: 'sample', iconLeft: 'Some Text
 | suffix       | string    | Suffix text |
 | ...          | ...       | See PrimeOutputText source for all props |
 
-See [PrimeOutputText source](../../src/components/PrimeOutputText.vue) for more details.
+See [PrimeOutputText source](https://github.com/sfxcode/formkit-primevue/tree/main/src/components/PrimeOutputText.vue) for more details.
diff --git a/docs/component/PrimePassword.md b/docs/component/PrimePassword.md
@@ -43,4 +43,4 @@ const data = {}
 | toggleMask   | boolean   | Show toggle mask button |
 | size         | string    | Input size |
 
-See [PrimeVue Password docs](https://www.primefaces.org/primevue/password/) for more details.
+See [PrimeVue Password docs](https://primevue.org/password/) for more details.
diff --git a/docs/component/PrimeRadioButton.md b/docs/component/PrimeRadioButton.md
@@ -46,4 +46,4 @@ const data = { basic: 'refresh' }
 | size         | string    | Input size |
 | ...          | ...       | See PrimeVue docs for all props |
 
-See [PrimeVue RadioButton docs](https://www.primefaces.org/primevue/radiobutton/) for more details.
+See [PrimeVue RadioButton docs](https://primevue.org/radiobutton/) for more details.
diff --git a/docs/component/PrimeRating.md b/docs/component/PrimeRating.md
@@ -37,4 +37,4 @@ const data = {}
 | ptOptions    | object    | Pass-through options |
 | unstyled     | boolean   | Disable default styles |
 
-See [PrimeVue Rating docs](https://www.primefaces.org/primevue/rating/) for more details.
+See [PrimeVue Rating docs](https://primevue.org/rating/) for more details.
diff --git a/docs/component/PrimeSelect.md b/docs/component/PrimeSelect.md
@@ -55,4 +55,4 @@ const data = {}
 | size         | string    | Input size |
 | ...          | ...       | See PrimeVue docs for all props |
 
-See [PrimeVue Select docs](https://www.primefaces.org/primevue/select/) for more details.
+See [PrimeVue Select docs](https://primevue.org/select/) for more details.
diff --git a/docs/component/PrimeSelectButton.md b/docs/component/PrimeSelectButton.md
@@ -49,4 +49,4 @@ const data = {}
 | size         | string    | Input size |
 | ...          | ...       | See PrimeVue docs for all props |
 
-See [PrimeVue SelectButton docs](https://www.primefaces.org/primevue/selectbutton/) for more details.
+See [PrimeVue SelectButton docs](https://primevue.org/selectbutton/) for more details.
diff --git a/docs/component/PrimeSlider.md b/docs/component/PrimeSlider.md
@@ -36,4 +36,4 @@ const data = {}
 | ptOptions    | object    | Pass-through options |
 | unstyled     | boolean   | Disable default styles |
 
-See [PrimeVue Slider docs](https://www.primefaces.org/primevue/slider/) for more details.
+See [PrimeVue Slider docs](https://primevue.org/slider/) for more details.
diff --git a/docs/component/PrimeTextarea.md b/docs/component/PrimeTextarea.md
@@ -37,4 +37,4 @@ const data = {}
 | placeholder  | string    | Placeholder text |
 | rows         | number    | Number of rows |
 
-See [PrimeVue Textarea docs](https://www.primefaces.org/primevue/textarea/) for more details.
+See [PrimeVue Textarea docs](https://primevue.org/textarea/) for more details.
diff --git a/docs/component/PrimeToggleButton.md b/docs/component/PrimeToggleButton.md
@@ -38,4 +38,4 @@ const data = {}
 | iconPos      | string    | Icon position |
 | size         | string    | Input size |
 
-See [PrimeVue ToggleButton docs](https://www.primefaces.org/primevue/togglebutton/) for more details.
+See [PrimeVue ToggleButton docs](https://primevue.org/togglebutton/) for more details.
diff --git a/docs/component/PrimeToggleSwitch.md b/docs/component/PrimeToggleSwitch.md
@@ -36,4 +36,4 @@ const data = { readonly: true }
 | ptOptions    | object    | Pass-through options |
 | unstyled     | boolean   | Disable default styles |
 
-See [PrimeVue ToggleSwitch docs](https://www.primefaces.org/primevue/toggleswitch/) for more details.
+See [PrimeVue ToggleSwitch docs](https://primevue.org/toggleswitch/) for more details.
diff --git a/docs/component/PrimeTreeSelect.md b/docs/component/PrimeTreeSelect.md
@@ -74,4 +74,4 @@ const data = {}
 | unstyled     | boolean   | Disable default styles |
 | ...          | ...       | See PrimeVue docs for all props |
 
-See [PrimeVue TreeSelect docs](https://www.primefaces.org/primevue/treeselect/) for more details.
+See [PrimeVue TreeSelect docs](https://primevue.org/treeselect/) for more details.
diff --git a/docs/component/index.md b/docs/component/index.md
@@ -0,0 +1,38 @@
+# PrimeVue FormKit Components
+
+This section documents the available FormKit wrappers for PrimeVue components. Each component has its own dedicated documentation file with usage examples, props, and more details.
+
+## Available Components
+
+- [PrimeAutoComplete](PrimeAutoComplete.md)
+- [PrimeCascadeSelect](PrimeCascadeSelect.md)
+- [PrimeCheckbox](PrimeCheckbox.md)
+- [PrimeColorPicker](PrimeColorPicker.md)
+- [PrimeDatePicker](PrimeDatePicker.md)
+- [PrimeInputMask](PrimeInputMask.md)
+- [PrimeInputNumber](PrimeInputNumber.md)
+- [PrimeInputOtp](PrimeInputOtp.md)
+- [PrimeInputText](PrimeInputText.md)
+- [PrimeKnob](PrimeKnob.md)
+- [PrimeListbox](PrimeListbox.md)
+- [PrimeMultiSelect](PrimeMultiSelect.md)
+- [PrimeOutputBoolean](PrimeOutputBoolean.md)
+- [PrimeOutputDate](PrimeOutputDate.md)
+- [PrimeOutputDuration](PrimeOutputDuration.md)
+- [PrimeOutputLink](PrimeOutputLink.md)
+- [PrimeOutputList](PrimeOutputList.md)
+- [PrimeOutputNumber](PrimeOutputNumber.md)
+- [PrimeOutputReference](PrimeOutputReference.md)
+- [PrimeOutputText](PrimeOutputText.md)
+- [PrimePassword](PrimePassword.md)
+- [PrimeRadioButton](PrimeRadioButton.md)
+- [PrimeRating](PrimeRating.md)
+- [PrimeSelect](PrimeSelect.md)
+- [PrimeSelectButton](PrimeSelectButton.md)
+- [PrimeSlider](PrimeSlider.md)
+- [PrimeTextarea](PrimeTextarea.md)
+- [PrimeToggleButton](PrimeToggleButton.md)
+- [PrimeToggleSwitch](PrimeToggleSwitch.md)
+- [PrimeTreeSelect](PrimeTreeSelect.md)
+
+Refer to each file for detailed usage and API information.
