Skip to content

Commit 68076b8

Browse files
committed
docs: improve the type description of mode, closes #106
1 parent a77b83f commit 68076b8

File tree

2 files changed

+22
-14
lines changed

2 files changed

+22
-14
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -977,13 +977,13 @@ With Scope:
977977

978978
## Props
979979

980-
| Name | Description | Type | Default |
981-
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ------- | ----------- |
982-
| v-model /<br>modelValue (Vue 3) /<br>value (Vue 2) | binding value | any | |
983-
| mode /<br>v-model:mode (Vue 3) /<br>:mode.sync (Vue 2) | edit mode | `Mode` | `Mode.tree` |
984-
| debounce | debounce delay to update the binding value when typing in text mode, in milliseconds | number | `300` |
985-
| stringified | whether to keep the binding value as stringified JSON in text mode | boolean | `true` |
986-
| ... | properties of [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) | | |
980+
| Name | Description | Type | Default |
981+
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------ | ----------- |
982+
| v-model /<br>modelValue (Vue 3) /<br>value (Vue 2) | binding value | any | |
983+
| mode /<br>v-model:mode (Vue 3) /<br>:mode.sync (Vue 2) | edit mode | `Mode` /<br>you can use string in JS | `Mode.tree` |
984+
| debounce | debounce delay to update the binding value when typing in text mode, in milliseconds | number | `300` |
985+
| stringified | whether to keep the binding value as stringified JSON in text mode | boolean | `true` |
986+
| ... | properties of [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) | | |
987987

988988
### parsed JSON vs. stringified JSON
989989

@@ -1038,6 +1038,10 @@ import { Mode } from 'vanilla-jsoneditor'
10381038
</template>
10391039
```
10401040

1041+
> [!Tip]
1042+
>
1043+
> You can use `mode="text"` in JavaScript context without installing vanilla-jsoneditor.
1044+
10411045
### Naming convention
10421046

10431047
Support camelCase and kebab-case for tag & property name.

docs/README.zh-CN.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -977,13 +977,13 @@ npm rm json-editor-vue && npm i json-editor-vue
977977

978978
## 属性
979979

980-
| 名称 | 说明 | 类型 | 默认值 |
981-
| ------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------- | ----------- |
982-
| v-model /<br>modelValue (Vue 3) /<br>value (Vue 2) | 绑定值 | any | |
983-
| mode /<br>v-model:mode (Vue 3) /<br>:mode.sync (Vue 2) | 编辑模式 | `Mode` | `Mode.tree` |
984-
| debounce | 在 text 模式下输入时更新绑定值的去抖延迟 (毫秒) | number | `300` |
985-
| stringified | 在 text 模式下保持绑定值为 stringified JSON | boolean | `true` |
986-
| ... | [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) 的属性 | | |
980+
| 名称 | 说明 | 类型 | 默认值 |
981+
| ------------------------------------------------------ | -------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
982+
| v-model /<br>modelValue (Vue 3) /<br>value (Vue 2) | 绑定值 | any | |
983+
| mode /<br>v-model:mode (Vue 3) /<br>:mode.sync (Vue 2) | 编辑模式 | `Mode` /<br>可以在 JS 中使用 string | `Mode.tree` |
984+
| debounce | 在 text 模式下输入时更新绑定值的去抖延迟 (毫秒) | number | `300` |
985+
| stringified | 在 text 模式下保持绑定值为 stringified JSON | boolean | `true` |
986+
| ... | [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) 的属性 | | |
987987

988988
### parsed JSON vs. stringified JSON
989989

@@ -1038,6 +1038,10 @@ import { Mode } from 'vanilla-jsoneditor'
10381038
</template>
10391039
```
10401040

1041+
> [!Tip]
1042+
>
1043+
> 可以在 JavaScript 上下文中使用 `mode="text"` 而无需安装 vanilla-jsoneditor.
1044+
10411045
### 命名惯例
10421046

10431047
标签、属性名称支持驼峰命名和短横线命名

0 commit comments

Comments
 (0)