WidgetJson

Overview

A JSON editor widget backed by CodeMirror. It edits real JSON values, not stringified copies, so JSONField submissions keep their object/scalar shape.

Theme entry: WidgetJson

Props

Name	Type	Required	Default	Description
name	String		undefined	The widget name; falls back to the field context value when omitted.
label	String		undefined	The label displayed next to the widget; falls back to the field context value when omitted.
help	String		undefined	Help text displayed alongside the widget; falls back to the field context value when omitted.
readOnly	Boolean		false	Whether the widget is read-only; falls back to the field context value when omitted.
required	Boolean		undefined, // let the default from field context take over	Whether the widget is required; falls back to the field context value when undefined.
modelValue	String|Number|Boolean|Array|Object		undefined	The widget's bound value (v-model); used only in contextless mode.
fieldToWidget	Object|Function		null	Adapter that converts the form model value into a value suitable for the widget UI.
widgetToField	Object|Function		null	Adapter that converts the widget UI value back into a form model value for validation and submission.
invalid	Boolean		undefined	Manually set the invalid state when not in a field context.
warning	Boolean		undefined	Manually set the warning state when not in a field context.
disabled	Boolean		false	Whether the widget is disabled.
disabledFn	Function		null	A function that returns whether the widget should be disabled; takes precedence over the disabled prop.
contextless	Boolean		false	When true, the widget ignores any surrounding field or form context and manages its own state.
displayDependencies	Array		() => []	Field paths whose values the widget needs for display logic; registered with the field context.
themeOverride	Object		null	A partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
prettyPrint	boolean		true	Whether values should be serialized with indentation.
indent	number		2	Number of spaces to use when prettyPrint is true.
formatOnBlur	boolean		true	Whether valid JSON should be reformatted when the editor loses focus.

Events

Name	Description
update:modelValue	Emitted when the widget value changes.

Full event reference

Source

client/lib/widgets/WidgetJson.vue