From fe7e364b890c48f1eae994f9f53bdd8e8250ea11 Mon Sep 17 00:00:00 2001 From: Julian Pollinger Date: Tue, 15 Aug 2023 14:35:24 +0200 Subject: [PATCH] docs: update documentation --- docs/README.md | 143 +++++++++++++----- docs/components/ButtonGroup.md | 12 ++ docs/components/FormRoot.md | 14 +- docs/components/vue_json_form.md | 2 - .../{app.cd37764f.css => app.717da3b3.css} | 4 +- ...4ef6c5f.css => chunk-vendors.d10aed08.css} | 2 +- docs/demo/index.html | 2 +- docs/demo/js/app.1e96a035.js | 2 - docs/demo/js/app.1e96a035.js.map | 1 - docs/demo/js/app.4d1a285c.js | 2 + docs/demo/js/app.4d1a285c.js.map | 1 + docs/demo/js/chunk-vendors.29129503.js | 66 ++++++++ docs/demo/js/chunk-vendors.29129503.js.map | 1 + docs/demo/js/chunk-vendors.8a9d249e.js | 56 ------- docs/demo/js/chunk-vendors.8a9d249e.js.map | 1 - docs/index.html | 2 +- docs/schemaDoc/README.md | 6 + ...e-submit-settings-properties-formaction.md | 15 ++ ...-submit-settings-properties-formenctype.md | 25 +++ ...e-submit-settings-properties-formmethod.md | 24 +++ ...e-submit-settings-properties-formtarget.md | 26 ++++ ...utton-properties-native-submit-settings.md | 126 +++++++++++++++ .../button-properties-the-buttons-type.md | 3 +- docs/schemaDoc/button.md | 36 ++++- .../buttongroup-properties-buttons.md | 19 +++ docs/schemaDoc/buttongroup-properties-type.md | 23 +++ .../buttongroup-properties-vertical.md | 15 ++ docs/schemaDoc/buttongroup.md | 89 +++++++++++ ...ayout-properties-elements-layoutelement.md | 4 +- docs/schemas/button.schema.json | 2 +- docs/schemas/buttongroup.schema.json | 1 + docs/schemas/layout.schema.json | 2 +- 32 files changed, 611 insertions(+), 116 deletions(-) create mode 100644 docs/components/ButtonGroup.md rename docs/demo/css/{app.cd37764f.css => app.717da3b3.css} (98%) rename docs/demo/css/{chunk-vendors.04ef6c5f.css => chunk-vendors.d10aed08.css} (98%) delete mode 100644 docs/demo/js/app.1e96a035.js delete mode 100644 docs/demo/js/app.1e96a035.js.map create mode 100644 docs/demo/js/app.4d1a285c.js create mode 100644 docs/demo/js/app.4d1a285c.js.map create mode 100644 docs/demo/js/chunk-vendors.29129503.js create mode 100644 docs/demo/js/chunk-vendors.29129503.js.map delete mode 100644 docs/demo/js/chunk-vendors.8a9d249e.js delete mode 100644 docs/demo/js/chunk-vendors.8a9d249e.js.map create mode 100644 docs/schemaDoc/button-properties-native-submit-settings-properties-formaction.md create mode 100644 docs/schemaDoc/button-properties-native-submit-settings-properties-formenctype.md create mode 100644 docs/schemaDoc/button-properties-native-submit-settings-properties-formmethod.md create mode 100644 docs/schemaDoc/button-properties-native-submit-settings-properties-formtarget.md create mode 100644 docs/schemaDoc/button-properties-native-submit-settings.md create mode 100644 docs/schemaDoc/buttongroup-properties-buttons.md create mode 100644 docs/schemaDoc/buttongroup-properties-type.md create mode 100644 docs/schemaDoc/buttongroup-properties-vertical.md create mode 100644 docs/schemaDoc/buttongroup.md create mode 100644 docs/schemas/buttongroup.schema.json diff --git a/docs/README.md b/docs/README.md index 6a21441..6488843 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,5 @@ # @educorvi/vue-json-form + [![GitHub release (latest by date)](https://img.shields.io/github/v/release/educorvi/vue_json_form)](/~https://github.com/educorvi/vue_json_form/releases/latest) [![npm](https://img.shields.io/npm/v/@educorvi/vue-json-form)](https://www.npmjs.com/package/@educorvi/vue-json-form) [![End2End Tests](/~https://github.com/educorvi/vue_json_form/actions/workflows/cypress.yml/badge.svg)](/~https://github.com/educorvi/vue_json_form/actions/workflows/cypress.yml) @@ -6,10 +7,15 @@ [![GitHub issues](https://img.shields.io/github/issues/educorvi/vue_json_form)](/~https://github.com/educorvi/vue_json_form/issues) #### Automaticly generates form from json schema and json ui schema. + - [Documentation](https://educorvi.github.io/vue_json_form/) - [Demo](https://educorvi.github.io/vue_json_form/demo/) + ## Usage -Install with `npm install @educorvi/vue-json-form`. This Component needs [Bootstrap-Vue](https://bootstrap-vue.org/) installed to work. If you want to use the wizard, you also have to MdStepper and MdButton from [Vue Material](https://vuematerial.io/). + +Install with `npm install @educorvi/vue-json-form`. This Component needs [Bootstrap-Vue](https://bootstrap-vue.org/) +installed to work. If you want to use the wizard, you also have to MdStepper and MdButton +from [Vue Material](https://vuematerial.io/). Your `main.js` file should look something like this: ``` js @@ -40,7 +46,8 @@ new Vue({ }).$mount('#app') ``` -### Use in VueJS-Component +### Use in VueJS-Component + ``` vue