vue3-schema-forms 0.0.26 → 0.0.28

package/README.md

@@ -5,6 +5,12 @@ This library is designed to simplify form creation by leveraging the JSON Schema
 
 Inspired by https://koumoul-dev.github.io/vuetify-jsonschema-form/latest/
 
+## Documentation
+
+The documentation and some of the testing was based on the Storybook
+application [click here](https://maciejdybowski.github.io/vue3-schema-forms/)
+
+Check the changelog here => [latest](https://maciejdybowski.github.io/vue3-schema-forms/?path=/docs/changelog--docs)
 
 ## Installation
 
@@ -31,11 +37,12 @@ After importing the plugin, we can invoke the form-generating component and pass
 
 ```javascript
 // someComponent.vue
-<vue-schema-forms 
+<vue-schema-forms
   v-model="model" 
-  :schema="schema" 
-  :options="formOptions"
-/>
+  :schema = "schema"
+:
+options = "formOptions"
+  / >
 
 const formOptions = ref({})
 const model = ref({})
@@ -50,10 +57,25 @@ const schema = ref({
     },
   },
 ```
-## Documentation
-The documentation and some of the testing was based on the Storybook application [click here](https://maciejdybowski.github.io/vue3-schema-forms/)
+
+#### Props description
+
+| Name                | Default  | Type                | Description                                                                                                                                          |
+|---------------------|----------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| model               | -        | object              | json object in which the values collected by the form will be stored                                                                                 |
+| schema              | -        | Schema              | JSON object conforming to the defined Schema interface, is responsible for the appearance, layout and type of fields generated by the form component |
+| options             | -        | object              | JSON object in which the user can define options common to multiple form fields                                                                      |
+| defaultFormActions  | false    | boolean             | flag, which is responsible for the visibility of the default form buttons in the #formActions slot                                                   |
+| validationBehaviour | "scroll" | ValidationBehaviour | A flag that defines the validation behavior after a failed attempt to validate the form. Available options "scroll" / "messages"                     |
+
+#### Component slots
+
+| Name        | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| formActions | The slot contains predefined default actions for the form: validation, reset validation and reset form. The user is free to override this slot and write his own buttons using exposed functions from the component. Just give "ref" and enjoy a ready-made validation function that takes 3 options: no parameter / scroll / messages [example](https://maciejdybowski.github.io/vue3-schema-forms/?path=/story/forms-features-validations--add-custom-submit-with-built-in-validation) |
 
 ## Tests
+
 1. ```cd``` to the project directory
 2. Install development dependencies: ```npm install```
 3. Run the tests: ```npm test```
@@ -61,26 +83,19 @@ The documentation and some of the testing was based on the Storybook application
 5. Run storybook tests: ```npm run test-storybook```
 
 ## Contributing
+
 1. Fork it!
 2. Create your feature branch: ```git checkout -b my-new-feature```
 3. Commit your changes: ```git commit -am 'Add some feature'```
 4. Push to the branch: ```git push origin my-new-feature```
 5. Submit a pull request
 
-
 ## ToDo List
-- [ ] Create many basics fields like data/radio/checkbox/combo etc.
+- [ ] Signal for form is ready (for autosave but after initial model changes)
+- [ ] Create date/datetime field
 - [ ] Use resolveDepsComposable for deps on fields
 - [ ] Create editable sections
 - [ ] Change to use Engine props (decomposition)
 - [ ] i18n [warnings] how to resolve message -> test on library
 
 In progress:
-- [ ] section
-- [ ] hide fields
-
-
-Przypadki testowe
-1. reset formularza - czy domyślne zostają
-2. reset formularza = null tam gdzie trzeba
-

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "vue3-schema-forms",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "Vue3 Schema Forms powered by Vuetify",
   "main": "dist/main.umd.js",
   "module": "dist/main.es.js",
@@ -15,7 +15,7 @@
     "format": "prettier --write src/",
     "preview": "vite preview",
     "storybook": "storybook dev -p 6006",
-    "test-storybook": "test-storybook",
+    "test-storybook": "test-storybook --verbose",
     "build-storybook": "storybook build -o dist-storybook",
     "test": "vitest"
   },
@@ -33,54 +33,58 @@
   },
   "homepage": "https://maciejdybowski.github.io/vue3-schema-forms/",
   "dependencies": {
-    "@mdi/font": "^7.3.67",
+    "@mdi/font": "^7.4.47",
     "@stoplight/json-ref-resolver": "3.1.6",
+    "@vueuse/core": "^10.7.1",
     "expr-eval": "^2.0.2",
     "lodash": "^4.17.21",
+    "maska": "^2.1.10",
     "uuid": "^9.0.1",
-    "vue-json-pretty": "^2.2.4"
+    "vue-json-pretty": "^2.3.0"
   },
   "peerDependencies": {
     "axios": "^1.6.2",
-    "vue": "^3.3.4",
+    "dayjs": "^1.11.10",
+    "pinia": "2.1.7",
+    "vue": "^3.4.3",
     "vue-i18n": "^9.6.4",
     "vuedraggable": "^4.1.0",
-    "vuetify": "^3.4.2"
+    "vuetify": "^3.4.9"
   },
   "devDependencies": {
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@intlify/unplugin-vue-i18n": "^0.10.1",
-    "@storybook/addon-essentials": "^7.6.5",
-    "@storybook/addon-interactions": "^7.6.5",
-    "@storybook/addon-links": "^7.6.5",
-    "@storybook/addon-mdx-gfm": "^7.6.5",
-    "@storybook/blocks": "^7.6.5",
+    "@intlify/unplugin-vue-i18n": "2.0.0",
+    "@storybook/addon-essentials": "^7.6.7",
+    "@storybook/addon-interactions": "^7.6.7",
+    "@storybook/addon-links": "^7.6.7",
+    "@storybook/addon-mdx-gfm": "^7.6.7",
+    "@storybook/blocks": "^7.6.7",
     "@storybook/jest": "^0.2.3",
-    "@storybook/manager-api": "^7.6.5",
+    "@storybook/manager-api": "^7.6.7",
     "@storybook/test-runner": "^0.16.0",
     "@storybook/testing-library": "^0.2.2",
-    "@storybook/theming": "^7.6.5",
-    "@storybook/vue3": "^7.6.5",
-    "@storybook/vue3-vite": "^7.6.5",
+    "@storybook/theming": "^7.6.7",
+    "@storybook/vue3": "^7.6.7",
+    "@storybook/vue3-vite": "^7.6.7",
     "@types/uuid": "^9.0.7",
     "@vitejs/plugin-vue": "^4.4.0",
-    "@vue/test-utils": "^2.4.1",
-    "eslint": "^8.51.0",
+    "@vue/test-utils": "^2.4.3",
+    "eslint": "^8.56.0",
     "eslint-plugin-storybook": "^0.6.15",
-    "jsdom": "^22.1.0",
-    "prettier": "2.8.7",
+    "jsdom": "^23.0.1",
+    "prettier": "3.1.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "remark-gfm": "^3.0.1",
+    "remark-gfm": "^4.0.0",
     "rollup-plugin-typescript2": "^0.36.0",
-    "storybook": "^7.6.5",
+    "sass": "^1.69.6",
+    "storybook": "^7.6.7",
     "storybook-addon-mock": "^4.3.0",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.3",
     "vite": "^4.4.11",
-    "vite-plugin-dts": "^3.6.3",
-    "vite-plugin-vue-devtools": "^1.0.0-rc.5",
+    "vite-plugin-dts": "^3.7.0",
     "vite-plugin-vuetify": "^1.0.2",
-    "vitest": "^0.34.6",
-    "vue-tsc": "^1.8.19"
+    "vitest": "^1.1.1",
+    "vue-tsc": "^1.8.27"
   }
 }

package/dist/components/main.d.ts

@@ -1 +0,0 @@
-export * from '../src/main'