FieldSwitch

type switch

Basic example

Code

{
    name: 'switchExample',
    label: 'Enable test?',
    model: 'switchModel',
    type: 'switch'
}

Value: false

Enable test?

Programmatic toggle

Code

{
  model: {
    switchModel: false
  },
  schema: {
    fields: [
      {
        name: 'switchExample',
        label: 'Enable test?',
        model: 'switchModel',
        type: 'switch'
      },
      {
        type: 'button',
        buttonText: 'Toggle switch',
        onClick: (model) => {
          model.switchModel = !model.switchModel
        }
      }
    ]
  }
}

Value: false

Enable test?

Properties

Shared properties

Property	Default	Type	Description
name	-	string	Name of the field
model	-	string	Key of model in the form schema model
label	-	string	Label for the field
labelIcon	-	string | ComponentPublicInstance | LabelIconDefinition	Label for the field
type	-	string	Type of field, generally input if the field is an input.
inputType	-	string	Type of input, only required when type === 'input'
id	computed	string	id of the field
visible	true	Boolean | Function	Whether the field is visible, method will be passed the model, field and field component*
required	false	Boolean | Function	Whether the field is required, method will be passed the model, field and field component*
readonly	false	Boolean | Function	Whether the field is read only, method will be passed the model, field and field component*
disabled	false	Boolean | Function	Whether the field is disabled, method will be passed the model, field and field component*
hint	-	string | Function	Hint to display underneath the field, can be passed a method*
validator	computed	Array<Function> | Function | undefined	A (list of) validator(s) to be validating the field against.
validate	onBlur	'onChanged' | 'onBlur'	Method of validation for the field.
onValidated	-	Function | undefined	Method to be called after validation has been completed.

* see determineDynamicAttribute() for more information.