Docs

Author: yandodov

.gitattributes

@@ -1,3 +1,7 @@
-# Git
+docs export-ignore
+src export-ignore
+.editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
+package-lock.json export-ignore
+package.json export-ignore

README.md

@@ -0,0 +1,56 @@
+# kirby-json
+
+Kirby JSON field and JSON editor Vue component.
+
+## Installation
+
+With Composer:
+
+```
+composer require oblik/kirby-json
+```
+
+## Usage
+
+### Field
+
+In the blueprint:
+
+```yml
+fields:
+  myData:
+    type: json
+```
+
+Available blueprint options for the editor:
+
+```yml
+array: false  # Saved value should be an array?
+keys: false   # Edit object keys?
+values: true  # Edit values?
+mutate: false # Add/remove entries?
+sort: true    # Allow entry reordering?
+```
+
+In the template, use the native Kirby `toData()` method:
+
+```php
+$data = $page->myData()->toData('json');
+```
+
+### Component
+
+If you're building a plugin and you need to allow the user to edit JSON, you can use the same component that the above JSON field uses, `k-json-editor`, in your own panel plugin:
+
+```html
+<template>
+  <k-json-editor
+    v-model="data"
+    :label="label"
+    :options="options"
+    @input="input"
+  ></k-json-editor>
+</template>
+```
+
+![JSON editor component](editor.png)

docs/README.md

@@ -25,7 +25,7 @@ export default {
       default: true
     },
     mutate: { // Add/remove entries?
-      default: true
+      default: false
     },
     sort: { // Allow entry reordering?
       default: true