@sfxcode/formkit-primevue 3.2.10 → 3.3.1

package/README.md

@@ -1,148 +1,23 @@
-# Formkit - Primevue
+# tsdown-starter
 
-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/#/).
+A starter for creating a TypeScript package.
 
-Main focus of this project is to provide configuration based forms with validation.
+## Development
 
-In addition, you can use the same pattern for **data output** from **schema** using [PrimeOutputs](https://sfxcode.github.io/formkit-primevue/guide/outputs.html).
+- Install dependencies:
 
-## PrimeVue Versions
-
-Actual PrimeVue Version of the main branch is *4.x.*
-
-PrimeVue 3 is in the prime3 branch, but future development will only focus on PrimeVue 4
-
-## Build
-
-[![CI](https://github.com/sfxcode/formkit-primevue/actions/workflows/deploy.yml/badge.svg)](https://github.com/sfxcode/formkit-primevue/actions/workflows/deploy.yml)
-
-[![Netlify Status](https://api.netlify.com/api/v1/badges/6142cb73-02e0-4b2a-9ca3-25496f59ba9b/deploy-status)](https://app.netlify.com/sites/formkit-primevue/deploys)
-
-## Docs
-
-[Docs](https://sfxcode.github.io/formkit-primevue/)
-
-[Demo/Playground](https://formkit-primevue.netlify.app/)
-
-## Usage
-
-### Configuration
-
-Add *formkit.config.ts*
-
-```typescript
-import { defaultConfig, plugin } from '@formkit/vue'
-import { primeInputs } from '@sfxcode/formkit-primevue'
-
-app.use(plugin, defaultConfig({
-  locales: { de, en },
-  // Define the active locale
-  locale: 'en',
-  inputs: primeInputs, 
-}))
+```bash
+npm install
 ```
 
-or if using also the output part
+- Run the unit tests:
 
-```typescript
-import { defaultConfig, plugin } from '@formkit/vue'
-import { primeInputs, primeOutputs } from '@sfxcode/formkit-primevue'
-
-app.use(plugin, defaultConfig({
-  locales: { de, en },
-  // Define the active locale
-  locale: 'en',
-    inputs: { ...primeInputs, ...primeOutputs },
-}))
+```bash
+npm run test
 ```
 
-Important: output elements depends on vue-i18n to style numbers, dates, ...
-
-### Nuxt
-
-[FormKit-PrimeVue-Nuxt](https://github.com/sfxcode/formkit-primevue-nuxt) module available.
-
-Features:
-
-- add PrimeVue Nuxt Module
-- add FormKit Nuxt Module
-- add i18n Nuxt Module
-- Default Configuration for FormKit (with PrimeVue components) is provided (can be disabled if needed)
-- AutoImport of PrimeVue Form Components
-- PrimeIcons are loaded by Default
-- FormKit Styling of this package is loaded by default
-- AutoImport of Composables
-- AutoImport of Components
-
-## Limitations
-
-Prefixing of the PrimeVue component names is not supported.
+- Build the library:
 
-### Schema Helper Functions
-
-[useFormKitSchema](https://github.com/sfxcode/formkit-primevue/blob/main/src/composables/useFormKitSchema.ts) provide functions to simplify the usage of elements, components, lists, ...
-
-[useInputEditorSchema](https://github.com/sfxcode/formkit-primevue/blob/main/src/composables/useInputEditorSchema.ts) provide functions for a component schema generation builder
-
-### Basic Styling
-
-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.
-
-Features:
-
-- Width of all text and dropdown elements is set to 100%
-- Error Color by variable (--formkit-error-color)
-- Some margins, font sizes ...
-
-You can use it or take it as base for your own styling.
-
-### Extended Styling
-
-- Styling outerClas, innerClass .... is provided by FormKit
-- All inputs, outputs are wrapped in a div with a **p-formkit** class
-- Most of the Prime Input Components have access to class / styles attributes
-- PT and PTOptions are available ([https://primevue.org/passthrough/](https://primevue.org/passthrough/))
-- [Styling](https://formkit-primevue.netlify.app/styling/base) and [PT](https://formkit-primevue.netlify.app/styling/passThrough) demo available
-- [Grid](https://formkit-primevue.netlify.app/styling/grid) Demo of the provided grid styling (col-[1-12])
-
-### Samples
-
-Some samples for common tasks are available
-
-- [Repeater](https://formkit-primevue.netlify.app/samples/repeater) Use Repeater composable for using repeating values in your schema
-- [Input Editor](https://formkit-primevue.netlify.app/samples/inputEditor) Edit FormKit schema on the based on a provided composable
-- [Form Editor](https://formkit-primevue.netlify.app/samples/formEditor) Basic demo as starter to create Forms visually
-
-## Showcases
-
-[Demo Application](https://formkit-primevue.netlify.app/)
-
-[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.
-
-## Supported Inputs for PrimeVue 4
-
-- AutoComplete
-- CascadeSelect
-- Checkbox
-- ColorPicker
-- DatePicker
-- Editor (HTML Editor - if you register the editor component, make sure to import quill)
-- InputMask
-- InputNumber
-- InputOtp
-- InputText
-- Knob
-- Listbox
-- MultiSelect
-- Password
-- RadioButton
-- Rating
-- Select
-- SelectButton
-- Slider
-- Textarea
-- ToggleButton
-- ToggleSwitch
-- TreeSelect
-
-![](formkit-primevue.png)
+```bash
+npm run build
+```