Merge branch 'master' into production

Author: kevinkosterr

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+# Summary
+*Give a quick summary of the changes this pull request includes and what they do.*
+
+## Checklist
+- [ ] The commits in this PR follow the [commit guidelines](https://github.com/kevinkosterr/vue3-form-generator/CONTRIBUTING.md)
+- [ ] The pull request was issued to the `master` branch (if not part of a release)
+
+#### What kind of change(s) does this PR introduce? (Check at least one)
+- [ ] Bug fix :bug: - `fix(...)`
+- [ ] Feature - `feat(...)`
+- [ ] Documentation - `docs(...)`
+- [ ] Introduces or modifies test(s) - `test(...)`
+- [ ] Other (please describe)

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+Please read the following before contributing to this repository.
+
+## Commit guidelines
+Commits should follow the basic guidelines as specified by [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
+The `scope` is applicable to `docs`, `feat`, `refactor`, `fix`, `test` or `perf`. Typically, the `scope` would be the
+field component that the change is made to/made for. For example: if you fix a bug in the `FieldCheckbox` component
+the commit should start with `fix(FieldCheckbox)`.
+
+Commits must follow the guidelines as specified above in order for `semantic-release` to create proper release notes.
+Commits are also evaluated against the [default release rules](https://github.com/semantic-release/commit-analyzer/blob/master/lib/default-release-rules.js).
+E.g. `feat:` will create a `minor` release and `fix:` will create a `patch` release.
+
+Should your commits close any issues, please mention them in the footer of the commit message.

apps/docs/.vitepress/config.js

@@ -1,11 +1,17 @@
 import { defineConfig } from 'vitepress'
+import { groupIconMdPlugin, groupIconVitePlugin } from 'vitepress-plugin-group-icons'
 import path from 'path'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   base: '/vue3-form-generator/',
   title: 'Vue3 Form Generator',
   description: 'Documentation for vue3-form-generator',
+  markdown: {
+    config(md) {
+      md.use(groupIconMdPlugin)
+    }
+  },
   themeConfig: {
     nav: [
       { text: 'Home', link: '/' }
@@ -48,6 +54,7 @@ export default defineConfig({
         items: [
           { text: 'FieldButton', link: '/guide/fields/FieldButton' },
           { text: 'FieldCheckbox', link: '/guide/fields/FieldCheckbox' },
+          { text: 'FieldChecklist', link: '/guide/fields/FieldChecklist' },
           { text: 'FieldColor', link: '/guide/fields/FieldColor' },
           { text: 'FieldMask', link: '/guide/fields/FieldMask' },
           { text: 'FieldNumber', link: '/guide/fields/FieldNumber' },
@@ -75,6 +82,7 @@ export default defineConfig({
     ]
   },
   vite: {
+    plugins: [ groupIconVitePlugin() ],
     resolve: {
       alias: {
         '@': path.resolve(__dirname, '../../../src')

apps/docs/.vitepress/theme/index.js

@@ -3,6 +3,7 @@ import VueFormGenerator from '@/index'
 
 import './index.css'
 import '@/scss/themes/basic.scss'
+import 'virtual:group-icons.css'
 
 export default {
   extends: DefaultTheme,

apps/docs/components/ValidatorExample.vue renamed to apps/docs/components/examples/ValidatorExample.vue

@@ -0,0 +1,29 @@
+<template>
+  permissions: <code>{{ form.model.permissions }}</code>
+  <vue-form-generator :schema="form.schema" :model="form.model" />
+</template>
+
+<script setup>
+import { ref } from 'vue'
+
+const form = ref({
+  model: {
+    permissions: []
+  },
+  schema: {
+    fields: [
+      {
+        name: 'activePermissions',
+        label: 'Active permissions',
+        model: 'permissions',
+        type: 'checklist',
+        options: [
+          { name: 'Manage warehouse', value: 'manageWarehouse' },
+          { name: 'Create orders', value: 'createOrders' },
+          { name: 'Manage orders', value: 'manageOrders' }
+        ]
+      }
+    ]
+  }
+})
+</script>