Nostalgic Primordial Monster

    @jsonforms/vue2-vanilla
    TypeScript icon, indicating that this package has built-in type declarations

    2.5.2 • Public • Published

    JSON Forms - More Forms. Less Code

    Complex Forms in the blink of an eye

    JSON Forms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.

    Vue 2 Vanilla Renderers

    This is the JSON Forms Vue 2 Vanilla renderers package which provides a HTML5-based renderer set for JSON Forms Vue 2.

    JSON Forms Vue 2 seed app

    See our JSON Forms Vue seed repository to get started as quickly as possible. Make sure to switch to branch vue2.

    Quick start

    Install JSON Forms Core, Vue 2 and Vue 2 Vanilla Renderers.

    npm i --save @jsonforms/core @jsonforms/vue2 @jsonforms/vue2-vanilla

    Use the json-forms component for each form you want to render and hand over the renderer set.

    <script>
    import { JsonForms } from '@jsonforms/vue2';
    import { vanillaRenderers } from '@jsonforms/vue2-vanilla'
    
    const renderers = [
      ...vanillaRenderers,
      // here you can add custom renderers
    ]
    
    export default defineComponent({
      name: 'app',
      components: {
        JsonForms
      },
      data() {
        return {
          renderers: Object.freeze(renderers),
          data,
          schema,
          uischema,
        };
      },
      methods: {
        onChange(event) {
          this.data = event.data;
        },
      }
    });
    </script>
    <template>
      <json-forms
        :data="data"
        :schema="schema"
        :uischema="uischema"
        :renderers="renderers"
        @change="onChange"
      />
    </template>

    By default the Vanilla Renderers don't apply any CSS at all. For a quick start you can use @jsonforms/vue-vanilla/vanilla.css.

    As JSON Forms uses the Vue 3 composition API you need to add the @vue/composition-api plugin to your Vue 2 app.

    import VueCompositionAPI from '@vue/composition-api'
    
    Vue.use(VueCompositionAPI)

    For more information on how JSON Forms can be configured, please see the README of @jsonforms/vue2.

    Styling

    Each rendered HTML element specifies a CSS class which can be used to style it. This process can also be customized so that each element declares user-specified CSS classes. Therefore JSON Forms Vue Vanilla can be integrated with any CSS-only UI framework quite easily.

    You can find the default CSS classes in `defaultStyles.ts.

    To render your own classes simply provide them as styles. These styles replace the defaultStyles. If you want to fall back to defaultStyles or combine them with your own classes you'll need to do so programmatically, e.g.:

    <script>
    import { JsonForms } from '@jsonforms/vue';
    import { defaultStyles, mergeStyles, vanillaRenderers } from '@jsonforms/vue-vanilla'
    
    // mergeStyles combines all classes from both styles definitions
    const myStyles = mergeStyles(defaultStyles, { control: { root: 'my-control' } });
    
    export default defineComponent({
      name: 'app',
      components: {
        JsonForms
      },
      data() {
        return {
          renderers: Object.freeze(vanillaRenderers),
          data,
          schema,
          uischema,
        };
      },
      methods: {
        onChange(event) {
          this.data = event.data;
        },
      },
      provide() {
        return {
          styles: myStyles;
        }
      }
    });
    </script>
    <template>
      <json-forms
        :data="data"
        :schema="schema"
        :uischema="uischema"
        :renderers="renderers"
        @change="onChange"
      />
    </template>

    You can also use specify styles in the ui schema via the options.styles property. Attributes specified here override the respective defaultStyles or provided styles. Attributes not specified here fall back to either the defaultStyles or provided styles.

    {
      "type": "Control",
      "scope": "#/properties/name",
      "options": {
        "styles": {
          "control": {
            "root": "my-control-root"
          }
        }
      }
    }

    License

    The JSONForms project is licensed under the MIT License. See the LICENSE file for more information.

    Roadmap

    Our current roadmap is available here.

    Install

    npm i @jsonforms/vue2-vanilla

    DownloadsWeekly Downloads

    217

    Version

    2.5.2

    License

    MIT

    Unpacked Size

    214 kB

    Total Files

    66

    Last publish

    Collaborators

    • jsonforms-publish
    • sdirix
    • mkoegel
    • tortmayr
    • eugenneufeld
    • jfaltermeier