WidgetTagsInput

Overview

A tags input widget for a field that holds a list of values. Each entry becomes a removable tag, and the field value is the array of entered strings. An entry is added on Enter, on the comma delimiter, on paste, and when the input loses focus. Each entry is trimmed before it is added, so 2 next to an existing 2 is a duplicate. With numeric, only entries written as decimal numbers are added, such as 12, -2.5, .5, or 1e3. A rejected entry stays in the input, marked invalid, until it is edited.

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.
numeric	boolean		false	When true, only entries written as decimal numbers are added, the forms a Django DecimalField reads.
placeholder	string		undefined	Placeholder text shown in the entry input.

Events

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

Full event reference

Source

client/lib/widgets/WidgetTagsInput.vue