Reference

Checkboxes Field

<k-checkboxes-field>

<k-checkboxes-field
    v-model="value"
    :options="[
        { value: 'a', text: 'Option A' },
        { value: 'b', text: 'Option B' }
    ]"
    :required="true"
    :min="2"
    :max="5"
    label="Checkboxes"
    help="This is a checkbox field"
    @input="input"
/>

Props

autofocus

Boolean (default: false)

If true, the field will be instantly focused when the form is created

disabled

Boolean (default: false)

If true, the field is disabled and cannot be filled in or edited

help

String (default: null)

Sets the help text below the field

label

String (default: null)

Sets the label text for the field.

max

Number (default: null)

The maximum number of allowed selections.

min

Number (default: null)

The minimum number of required selections

name

String (default: null)

The name of the field must be defined to get fields in fieldsets up and running.

options

Array (default: null)

Defines all options that are available. Options must be defined as an array of objects:

[
  { value: 'a', text: 'Option A' },
  { value: 'b', text: 'Option B' },
  { value: 'c', text: 'Option C' }
]

required

Boolean (default: false)

If true, the field must not be empty

value / v-model

Array | String (default: null)

The value for the input should be provided as array. Each value in the array corresponds with the value in the options. If you provide a string, the string will be split by comma.

Methods

focus()

The focus event can be used to set the focus on the field.

Events

@input

The input event is triggered when the value changes.

CSS class

.k-checkboxes-field