WidgetContextRawProps

Properties

contextless

If true, the widget ignores surrounding context like field or form.

Type: boolean

Source: client/lib/use/useWidget.js:140

disabled

Whether the widget is disabled.

Type: boolean

Source: client/lib/use/useWidget.js:136

disabledFn

A function that returns a boolean indicating disabled state.

Type: () => boolean

Source: client/lib/use/useWidget.js:137

displayDependencies

The widget dependencies to register with the field context, if any.

Type: string[]

Source: client/lib/use/useWidget.js:143

fieldToWidget

The value adapter for turing form values into values suitable for UI concerns.

Type: ValueAdapter | Ref

Source: client/lib/use/useWidget.js:130

help

The help text for the widget.

Type: string

Source: client/lib/use/useWidget.js:121

invalid

Whether the widget is invalid, when not in a field context.

Type: boolean

Source: client/lib/use/useWidget.js:125

label

The label to display next to the widget.

Type: string

Source: client/lib/use/useWidget.js:120

modelValue

The widget’s bound value (v-model).

Type: any

Source: client/lib/use/useWidget.js:129

name

The name of the widget.

Type: string

Source: client/lib/use/useWidget.js:117

required

Whether the widget is required. Inherits from field context if undefined.

Type: boolean

Source: client/lib/use/useWidget.js:124

warning

Whether the widget is in a warning state, when not in a field context.

Type: boolean

Source: client/lib/use/useWidget.js:126

widgetToField

The value adapter for the widget values back into form values, for validation and submission concerns.

Type: ValueAdapter | Ref

Source: client/lib/use/useWidget.js:132

Source

client/lib/use/useWidget.js:114