Skip to content

Commit 9b2b6c5

Browse files
committed
doc updates on jsoneditor
1 parent 715feff commit 9b2b6c5

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

docs/guide/schema-extensions.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,82 @@ All `x-*` attributes are optional. QuickForms works perfectly with standard JSON
330330

331331
---
332332

333+
## `x-render`
334+
335+
**Purpose:** Force a specific renderer for a field
336+
337+
**Type:** `string`
338+
339+
**Example:**
340+
```typescript
341+
{
342+
apiSettings: {
343+
type: 'object',
344+
title: 'API Settings',
345+
'x-render': 'jsoneditor' // Force JSON editor
346+
}
347+
}
348+
```
349+
350+
**Available Renderers:**
351+
- `'jsoneditor'` - JSON textarea editor with formatting support
352+
353+
**Use Cases:**
354+
- Force JSON editor for object fields that would normally render as nested fields
355+
- Override automatic component selection
356+
357+
**Related:** [JsonField Component](/guide/components#jsonfield)
358+
359+
---
360+
361+
## `x-rows`
362+
363+
**Purpose:** Control textarea height in rows
364+
365+
**Type:** `number`
366+
367+
**Default:** `8` (for JSON editor), varies by field type
368+
369+
**Example:**
370+
```typescript
371+
{
372+
config: {
373+
type: 'object',
374+
'x-render': 'jsoneditor',
375+
'x-rows': 12 // Taller editor
376+
}
377+
}
378+
```
379+
380+
**Applies to:**
381+
- `format: 'textarea'` - String textarea fields
382+
- `x-render: 'jsoneditor'` - JSON editor fields
383+
384+
---
385+
386+
## `x-show-format-hint`
387+
388+
**Purpose:** Show/hide the format hint icon in JSON editor (Vue package)
389+
390+
**Type:** `boolean`
391+
392+
**Default:** `true`
393+
394+
**Example:**
395+
```typescript
396+
{
397+
config: {
398+
type: 'object',
399+
'x-render': 'jsoneditor',
400+
'x-show-format-hint': false // Hide the ⓘ icon
401+
}
402+
}
403+
```
404+
405+
**Note:** For Quasar, use `x-quickforms-quasar: { showFormatHint: false }` instead.
406+
407+
---
408+
333409
## Combining Extensions
334410

335411
Multiple extensions can be used together:

0 commit comments

Comments
 (0)