@muenchen/digiwf-form-renderer NPM

About The Project

Built With

Getting Started

Below is an example of how you can installing and setup up your service

git clone
npm install
npm run build

Developing the library locally

Start the dev server with npm run serve

Use your library in another project locally

Run the following commands in your library:

npm run build
npm run pack

Make sure you have provided all the necessary dependencies in your vuetify project and add the library vai file path:

"digiwf-form-renderer": "file:../digiwf-form-renderer-0.0.1.tgz"

For more examples, and how to use the underlying vjsf library, please refer to the Documentation

Usage

The package can be used by following these steps:

install the package

npm install @muenchen/digiwf-form-renderer --save

import form and/or renderer in main.ts

import {VJsonForm, VJsonRenderer} from "@muenchen/digiwf-form-renderer";

Vue.component('VDivider', VDivider);
Vue.component('VJsonForm', VJsonForm);
Vue.component('VJsonRenderer', VJsonRenderer);

use it

  <v-json-form
    :value="value"
    :schema="schema"
    @complete-form="complete"
    button-text="Validate"
  >
  </v-json-form>

if you want to pass custom fields to the renderer use template slots

  <v-json-form
    :value="value"
    :schema="schema"
    @complete-form="complete"
    button-text="Validate"
  >
    <template
      v-slot:custom-user-input="context">
      <v-autocomplete outlined dense v-bind="context"></v-autocomplete>
    </template>
  </v-json-form>

For more examples, and how to use the underlying vjsf library, please refer to the Documentation

Roadmap

Modifying Default VJSF Options
Enhanced Validation with ajv
I18n Support

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!