Skip to content

Commit

Permalink
docs: negligible
Browse files Browse the repository at this point in the history
  • Loading branch information
cloydlau committed Nov 2, 2022
1 parent 0307f97 commit 8191b2c
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,11 +510,13 @@ export default {

## Props

| Name | Description | Type | Default |
| ------- | --------------------------------------------------------------------------------------------- | ------------------ | -------- |
| v-model | binding value | `any` | |
| mode | edit mode, <br>use `v-model:mode` in Vue 3 <br>or `:mode.sync` in Vue 2 | `'tree'`, `'text'` | `'tree'` |
| ... | properties of [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) | | |
| Name | Description | Type | Default |
| ------- | --------------------------------------------------------------------------------------------- | ------------- | -------- |
| v-model | binding value | `any` | |
| mode | edit mode, <br>use `v-model:mode` in Vue 3 <br>or `:mode.sync` in Vue 2 | [Mode](#Mode) | `'tree'` |
| ... | properties of [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) | | |

> ⚠ kebab-case is required for tag & prop name when using from CDN
### Binding value difference between `svelte-jsoneditor` and `json-editor-vue`

Expand All @@ -541,8 +543,6 @@ Including the boolean properties of `svelte-jsoneditor` like `readOnly` with no

- ✔️ `<JsonEditorVue :readOnly="true" />`

> kebab-case is required for tag & prop name when using via CDN
<br>

## Expose
Expand All @@ -555,6 +555,8 @@ Including the boolean properties of `svelte-jsoneditor` like `readOnly` with no

## Types

<a name="Mode"></a>

```ts
type Mode = 'tree' | 'text'
```
Expand Down

0 comments on commit 8191b2c

Please sign in to comment.