CheckboxgroupElement

Renders a list of native HTML checkboxes.

Basic Usage

<CheckboxgroupElement> component can be used in a <Vueform> component:

vue
<template>
  <Vueform>
    <CheckboxgroupElement
      name="checkboxgroup"
      :items="[
        'Vue.js',
        'React',
        'AngularJS',
      ]"
    />
  </Vueform>
</template>

Configuration options can be passed over as regular component props. Check out Options section for available configuration options.

Options

Find below the list of options that can use to configure CheckboxgroupElement component. Options can be passed to the component via props in inline templates, or in the element's object when using schema.

items

  • Type: object|array|function|string
  • Default: {}
  • Localizable: true
vue
<CheckboxgroupElement :items="['Vue.js', 'React', 'AngularJS']" ... />

Defines the list of checkbox options.

Array

Can be a plain array where both the checkbox value and label will be the same:

vue
<CheckboxgroupElement :items="['Vue.js', 'React', 'AngularJS']" ... />

Object

Can be an plain object where the object key is the value and the value is the label of the checkbox:

vue
<CheckboxgroupElement :items="{
  vuejs: 'Vue.js',
  react: 'React',
  angularjs: 'AngularJS'
}" ... />

Array of Objects

Can be an array of objects. Each item should be an object that contains at least a value and label key:

vue
<CheckboxgroupElement :items="[
  { value: 'vuejs', label: 'Vue.js' },
  { value: 'react', label: 'React' },
  { value: 'angularjs', label: 'AngularJS' },
]" ... />

Async

Can be an async function or a function that returns a Promise. The resolved value should have one of the formats from above.

vue
<CheckboxgroupElement :items="async function(){
  return await (axios.get('https://vueform.com/json/async-users.json')).data
}" ... />

String (endpoint)

Can be a string that is an endpoint where the options should be loaded from. The endpoint should return any of the formats from above.

vue
<CheckboxgroupElement items="https://vueform.com/json/async-users.json" ... />

Hint: checkbox templates can be overridden with #checkbox slot.

Can be a string that contains variables in {elementPath|'default'} format.

vue
<CheckboxgroupElement name="category" items="https://api.vueform.com/categories" ... />
<CheckboxgroupElement name="subcategory" items="https://api.vueform.com/category/{category|'0'}" ... />

The items that depend on an other element's value, will be refetched when the other element's value change. We can also reference complex elements (eg. lists or objects), in which case their value will be transformed to JSON and added to the url in an encoded format. If a value is already selected which is not among the newly fetched items, the value will be removed.

disables

  • Type: array
  • Default: []
vue
<CheckboxgroupElement
  :items="['Vue.js', 'React', 'AngularJS']"
  :disables="['React', 'AngularJS']"
... />

The list of values to disable.

clearOnRefetch

  • Type: boolean
  • Default: true

Whether the value should be cleared when the options list is refetched while using String (endpoint) with variables.

name

  • Type: string|number
  • Default: undefined
  • Required: true
vue
<CheckboxgroupElement name="element" ... />

Sets the element's name.

id

  • Type: string
  • Default: null
vue
<CheckboxgroupElement id="field-id" ... />

Sets the base id for checkboxes rendered by CheckboxgroupCheckbox. By default each checkbox will have the following id format: {checkboxgroup.id}-{checkbox.value}. If id is not defined name will be used.

disabled

  • Type: boolean
  • Default: false
vue
<CheckboxgroupElement :disabled="true" ... />

Disables the checkbox group.

label

  • Type: string|object|function
  • Default: null
  • Localizable: true

Sets a label for the element. Can be defined as a string, a Vue component object with a render function or as a function that receives el$ as its first a param.

Can also be defined via #label slot.

info

vue
<CheckboxgroupElement label="Info" info="Info" ... />

Renders an ElementInfo component next to the element's label. By default the icon shows the value of info when hovered, which can contain plain text or HTML. The element needs to have a label defined in order for info to be rendered.

Can be also defined via #info slot.

infoPosition

  • Type: string
  • Default: right
vue
<CheckboxgroupElement label="Top" info="Top" info-position="top" ... />
<CheckboxgroupElement label="Right" info="Right" info-position="right" ... />
<CheckboxgroupElement label="Left" info="Left" info-position="left" ... />
<CheckboxgroupElement label="Bottom" info="Bottom" info-position="bottom" ... />

Sets the position of the info tooltip.

Can be also defined via #info slot.

description

vue
<CheckboxgroupElement description="Lorem ipsum dolor sit amet" ... />

Renders the contents of description prop in the ElementDescription component below the checkbox group. It can contain plain text or HTML.

Can be also defined via #description slot.

before

  • Type: object|string|number
  • Default: null
  • Localizable: true
vue
<CheckboxgroupElement before="Before" ... />

Renders the contents of before in a ElementText component before the checkbox group. It can contain plain text or HTML.

Can be also defined via #before slot.

between

  • Type: object|string|number
  • Default: null
  • Localizable: true
vue
<CheckboxgroupElement description="Description" between="Between" ... />

Renders the contents of between in a ElementText component between the checkbox group and the description. It can contain plain text or HTML.

Can be also defined via #between slot.

after

  • Type: object|string|number
  • Default: null
  • Localizable: true
vue
<CheckboxgroupElement description="Description" rules="required" after="After" ... />

Renders the contents of after in a ElementText component after the description and error. It can contain plain text or HTML.

Can be also defined via #after slot.

default

  • Type: array
  • Default: []
vue
<CheckboxgroupElement :default="['Vue.js', 'React']" ... />

Sets the default value for the checkbox group.

formatData

  • Type: function
  • Default: null
vue
<CheckboxgroupElement :format-data="(n, v) => ({[n]: /* transformed value */ })" ... />

Formats the element's requestData.

The first param is the element's name, the second is the value. The return value should be an object, which only contains one item with the element's name as key and the transformed value as value.

formatLoad

  • Type: function
  • Default: null
vue
<CheckboxgroupElement :format-load="(v) => /* transformed value */" ... />

Formats the data being loaded to the element when using load(data, format: true). It receives the value being loaded to the element as its first param and should return the formatted value of the element.

submit

  • Type: boolean
  • Default: true
vue
<CheckboxgroupElement :submit="false" ... />

If set to false the element's data will not be included in requestData and will not be submitted.

rules

  • Type: array|string|object
  • Default: null
vue
<CheckboxgroupElement rules="required|min:2" ... />
<CheckboxgroupElement :rules="['required', 'min:2']" ... />

The validation rules to be applied for the element.

The list of rules can be defined as a string separated by | or as an array, where each item should be a single validation rule.

fieldName

  • Type: string
  • Default: name|label
vue
<CheckboxgroupElement field-name="Field name" rules="required" ... />

Sets the name of the field in validation rule messages.

messages

  • Type: object
  • Default: {}
vue
<CheckboxgroupElement rules="required" :messages="{ required: 'Please select at least one' }" ... />

Overrides the default messages for the element's validation rules. The value is an object where each key is the name of a validation rule and the value is the error message that will be displayed when the rule fails.

You can override validation messages on form level with messages.

conditions

  • Type: array
  • Default: []
vue
<!-- field1 - type 'show' -->
<TextElement name="field1" ... />

<!-- Group 1 - only if field1 == 'show' -->
<CheckboxgroupElement :conditions="[['field1', 'show']]" ... />

<!-- Group 2 - only if field1 != 'show' -->
<CheckboxgroupElement" :conditions="[['field1', '!=', 'show']]" ... />

<!-- Group 3 - only if field1 == 'show' -->
<CheckboxgroupElement :conditions="[
  (form$, el$) => form$.el$('field1')?.value === 'show'
]" ... />

Shows or hides an element based on the provided conditions.

If an element's conditions are unmet the element will be hidden and its available property will become false. If hidden, its value will not be part of requestData.

Conditions can be provided as an array, where each item has to be either an array or a function. The element will only become available if all the conditions are fulfilled.

If a condition is provided as an array, the first value must be the path of an other field which value should be watched. The second is an operator that defines the type of comparison. The third is the expected value of the other field.

vue
<CheckboxgroupElement name="field" :conditions="[['other_field', '==', 'expected_value']]" ... />

Hint: In case you want to check for equality you might leave the operator and pass the expected value as the second param:

vue
<CheckboxgroupElement name="field" :conditions="[['other_field', 'expected_value']]" ... />

Available operators:

  • == - expect equality
  • != - expect inequality
  • > - expect the other element's value(s) to be higher
  • >=- expect the other element's value(s) to be higher or equal
  • < - expect the other element's value(s) to be lower
  • <= - expect the other element's value(s) to be lower or equal
  • ^ - expect the other element's value to start with
  • $ - expect the other element's value to end with
  • * - expect the other element's value to contain
  • in - expect to be among an array of values
  • not_in - expect not to be among an array of values
  • today - expect to be today
  • before - expect to be before a date (value can be a YYYY-MM-DD date string or today)
  • after - expect to be after a date (value can be a YYYY-MM-DD date string or today)

The expected value can also be defined as an array in which case any of its values will fulfill the condition.

Conditions can be defined with OR relation or as function. Learn more about conditions here.

columns

  • Type: object|string|number
  • Default: null
vue
<CheckboxgroupElement label="Label" :columns="{ container: 12, label: 3, wrapper: 12 }" ... />

Sets the size of the container, label and wrapper using the theme's grid system, where the:

  • container is the wrapper DOM that contains both label and wrapper
  • label contains the label
  • wrapper contains the checkbox group.
container: 12
label: 3
wrapper: 12

The value of container defines the size of the element's container. 12 will result in full width, 6 in half, 4 in third and so on.

The value of label defines the amount of space the label should take up within the container. If the container is 12 and label is 6 the label is going to take up half the space and the checkbox group will the other half (which is calculated automatically). If the container is 6 and label is 6, the label will only take up one forth and the checkbox group the rest. In case the label has full width (12) the checkbox group will also take up full space instead of becoming zero.

The value of wrapper defines the size of the checkbox group wrapper within the space left for it in the container after subtracting the size of the label. If the container is 12 and label is 4 the space left for the checkbox group is 8. In this case if the wrapper value is 12 it will take up the full space left for it (which is 8) while if it is changed to 6 it will only take up half the space left for it (4):

vue
<CheckboxgroupElement label="Label" :columns="{ container: 12, label: 4, wrapper: 12 }" ... />
<CheckboxgroupElement label="Label" :columns="{ container: 12, label: 4, wrapper: 6 }" ... />

Note that while the size of the checkbox group wrapper changes, the size of extras like a description or error won't be limited to the wrapper's space. Instead it will take up the full space in the container left after subtracting the size of the label:

vue
<CheckboxgroupElement
  label="Label"
  :columns="{ container: 12, label: 4, wrapper: 6 }" 
  description="Lorem ipsum dolor sit amet, consectetur adipiscing elit"
... />

You can set the value of columns as a number in which case the container will receive its value without affecting the default settings of label and wrapper:

vue
<CheckboxgroupElement label="Label" :columns="6" ... /> <!-- { container: 6, label: 3, wrapper: 12 } -->

You can as well define column values for different breakpoints using the theme system's breakpoints like sm, md, etc. as keys:

vue
<CheckboxgroupElement label="Label" :columns="{
  xs: { container: 12, label: 12, wrapper: 12 },
  sm: { container: 12, label: 4, wrapper: 12 },
  md: 12,
  lg: { container: 12, label: 2, wrapper: 12 }
}" ... />

Default column sizes can be defined globally in vueform.config.js or on form level using columns.

inline

  • Type: boolean
  • Default: false
vue
<CheckboxgroupElement :inline="true" ... />

Renders the element and all of its components in a single <span> without applying columns.

size

  • Type: string
  • Default: undefined
vue
<CheckboxgroupElement size="sm" ... />
<CheckboxgroupElement ... /> <!-- Default size: 'md' -->
<CheckboxgroupElement size="lg" ... />

The size of the element and its child components.

view

  • Type: string
  • Default: undefined
vue
<CheckboxgroupElement view="alt" ... />

The name of the view to be used for the element and by default for its child components. If undefined the default view will be used. Child component views can be overridden with views option.

Views can be found at Views section.

Learn more about views here.

views

  • Type: object
  • Default: {}
vue
<CheckboxgroupElement :views="{
  ComponentName: 'alt'
}" ... />

The name of the views for the child components.

Learn more about views here.

addClasses

  • Type: object|function
  • Default: {}
vue
<CheckboxgroupElement :add-classes="{
  ComponentName: {
    classname: 'class-value',
    classname: ['class-value'],
    classname: [{'class-value': true}],
  }
}" ... />

Adds classes to any component's class names. The classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :add-classes="(form$) => ({
  ComponentName: {
    classname: [
      { 'class-value': form$.el$('other_field')?.value === 'some_value' }
    ],
  }
})" ... />

Learn more about adding classes here.

addClass

  • Type: array|object|string|function
  • Default: null
vue
<CheckboxgroupElement :add-class="{
  classname: 'class-value',
  classname: ['class-value'],
  classname: [{'class-value': true}],
}" ... />

Adds classes to any of CheckboxgroupElement component's class names. Classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :add-class="(form$) => ({
  classname: [
    { 'class-value': form$.el$('other_field')?.value === 'some_value' }
  ],
})" ... />

Learn more about adding classes here.

removeClasses

  • Type: object|function
  • Default: {}
vue
<CheckboxgroupElement :remove-classes="{
  ComponentName: {
    classname: ['class-value-1', 'class-value-2']
  }
}" ... />

Removes classes from any class names of any components. The classes to be removed must be listed in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :remove-classes="(form$) => ({
  ComponentName: {
    classname: form$.el$('other_field')?.value === 'some_value'
      ? ['class-value-1', 'class-value-2']
      : [],
  }
})" ... />

Learn more about removing classes here.

removeClass

  • Type: array|object|function
  • Default: null
vue
<CheckboxgroupElement :remove-class="{
  classname: ['class-value-1', 'class-value-2']
}" ... />

Removes classes from any of CheckboxgroupElement component's class names. The classes to be removed must be listed in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :remove-class="(form$) => ({
  classname: form$.el$('other_field')?.value === 'some_value'
    ? ['class-value-1', 'class-value-2']
    : [],
})" ... />

Learn more about removing classes here.

replaceClasses

  • Type: object|function
  • Default: {}
vue
<CheckboxgroupElement :replace-classes="{
  ComponentName: {
    classname: {
      'from-class': 'to-class',
      'from-class': ['to-class'],
      'from-class': [{'to-class': true}],
    }
  }
}" ... />

Replaces classes of any class names of any component. The keys are the original class names and the values are the replacements. The keys can only be single classes, while values can contain multiple ones in string or an array. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :replace-classes="(form$) => ({
  ComponentName: {
    classname: form$.el$('other_field')?.value === 'some_value' ? {
      'from-class': 'to-class'
    } : {},
  }
})" ... />

Learn more about replacing classes here.

replaceClass

  • Type: object|function
  • Default: null
vue
<CheckboxgroupElement :replace-class="{
  classname: {
    'from-class': 'to-class',
    'from-class': ['to-class'],
    'from-class': [{'to-class': true}],
  }
}" ... />

Replaces the classes of any class names of CheckboxgroupElement component. The keys are the original class names and the values are the replacements. The keys can only be single classes, while values can contain multiple ones in string or an array. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :replace-class="(form$) => ({
  classname: form$.el$('other_field')?.value === 'some_value' ? {
    'from-class': 'to-class'
  } : {},
})" ... />

Learn more about replacing classes here.

overrideClasses

  • Type: object|function
  • Default: {}
vue
<CheckboxgroupElement :override-classes="{
  ComponentName: {
    classname: 'class-value',
    classname: ['class-value'],
    classname: [{'class-value': true}],
  }
}" ... />

Overrides the classes of any component's class names. The classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :override-classes="(form$) => ({
  ComponentName: form$.el$('other_field')?.value === 'some_value' ? {
    classname: 'class-value'
  } : {}
})" ... />

Learn more about overriding classes here.

overrideClass

  • Type: array|object|string|function
  • Default: null
vue
<CheckboxgroupElement :override-classes="{
  ComponentName: {
    classname: 'class-value',
    classname: ['class-value'],
    classname: [{'class-value': true}],
  }
}" ... />

Overrides the classes of any of CheckboxgroupElement component's class names. The classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

vue
<CheckboxgroupElement :override-class="(form$) => (form$.el$('other_field')?.value === 'some_value' ? {
  classname: 'class-value'
} : {})" ... />

Learn more about overriding classes here.

templates

  • Type: object
  • Default: {}
vue
<template>
  <div id="app">
    <Vueform>
      <CheckboxgroupElement :templates="{ ElementError }" ... />
    </Vueform>
  </div>
</template>

<script>
import { markRaw } from 'vue'
import CustomElementError from './CustomElementError.vue'

export default {
  data() {
    return {
      ElementError: markRaw(CustomElementError),
    }
  }
}
</script>

Overrides templates used by the component.

Learn more about overriding templates here.

presets

  • Type: array
  • Default: []
vue
<CheckboxgroupElement :presets="['preset1', 'preset2']" ... />

The presets to be applied for the component.

Learn more about presets classes here.

slots

  • Type: object
  • Default: {}
vue
<script>
import { Vueform, useVueform } from '@vueform/vueform';
import CustomDescriptionSlot from 'path/to/CustomDescriptionSlot.vue';

export default {
  mixins: [Vueform],
  setup: useVueform,
  data: () => ({
    vueform: {
      schema: {
        element: {
          type: 'checkboxgroup',
          slots: {
            label: '<span>Label</span>',
            description: CustomDescriptionSlot,
          }
        }
      }
    }
  })
}
</script>

With this option you can define slot values in a schema based form that you would normally just write inline. The value of a slot can be a plain string, HTML or a component with render function.

While this option can be also used in inline forms, it's primarily intended for schema based forms.

Properties

Properties include data, computed and inject properties of the component. You can use them by reaching the element's Vue component instance via form$'s el$(path) method or directly via this in options API or el$ in Composition API.

aria

  • Type: object
  • Group: computed

The aria-* attributes of the input.

resolvedOptions

  • Type: array
  • Group: computed

Contains the available items. If items are async this contains the resolved items.

value

  • Type: any
  • Group: computed

The value of the element.

model

  • Type: any
  • Group: computed

Intermediary value between element's value and field's v-model. It is required when we need to transform the value format between the element and its field.

data

  • Type: object
  • Group: computed

The value of the element in {[name]: value} value format. This gets merged with the parent component's data.

requestData

  • Type: object
  • Group: computed

Same as data property except that it only includes the element's value if submit is not disabled and available is true (has no conditions or they are fulfilled).

path

  • Type: string
  • Group: computed

The path of the element using dot . syntax.

dataPath

  • Type: string
  • Group: computed

The path of the element's data using dot . syntax.

validated

  • Type: boolean
  • Group: computed

Whether the element was already validated at least once.

invalid

  • Type: boolean
  • Group: computed

Whether the element has any failing rules.

dirty

  • Type: boolean
  • Group: computed

Whether the element's value was modified.

pending

  • Type: boolean
  • Group: computed

Whether the element has any async rules in progress.

busy

  • Type: boolean
  • Group: computed

Whether the element is pending.

messageBag

  • Type: MessageBag
  • Default: MessageBag
  • Group: data

Instance of MessageBag service. Custom errors and messages can be added.

errors

  • Type: array
  • Group: computed

All the errors of MessageBag.

error

  • Type: string
  • Group: computed

The first error of MessageBag.

available

  • Type: boolean
  • Group: computed

Whether no conditions are defined or they are all fulfilled.

hidden

  • Type: boolean
  • Default: false
  • Group: data

Whether the element was hidden programmatically with show() or hide() methods.

visible

  • Type: boolean
  • Group: computed

Whether the element is visible. It's false when available or active is false or hidden is true.

isDisabled

  • Type: boolean
  • Group: computed

Whether the element is disabled.

isSuccess

  • Type: boolean
  • Group: computed

Whether the element has been filled in successfully.

isDanger

  • Type: boolean
  • Group: computed

Whether the element has errors.

container

  • Type: HTMLElement
  • Group: data

The ref to the outermost DOM of the element.

fieldId

  • Type: string
  • Group: computed

The id of the checkbox group. If id is not provided path will be used.

hasLabel

  • Type: boolean
  • Group: computed

Whether the element has a label option, a #label slot or Vueform component's forceLabels option is true.

Size

  • Type: string
  • Group: computed

The resolved size of the element and all of its child components.

View

  • Type: string
  • Group: computed

The name of the resolved view for the component and the default view for its child components. Child component views can be overridden with views option. This one should be used to determine the component's view in class functions.

template

  • Type: object
  • Group: computed

The component's template.

classes

  • Type: object
  • Group: computed

The component's classes.

theme

  • Type: object
  • Group: inject

The global theme object, which contains all the default templates and classes.

form$

  • Type: Vueform
  • Group: inject

The root form's component.

el$

  • Type: VueformElement
  • Group: computed

The element's component.

mounted

  • Type: boolean
  • Default: true
  • Group: data

Whether the element has been already mounted.

Methods

The methods of the component that you can use by reaching the element's Vue component instance via form$'s el$(path) method or directly via this in options API or el$ in Composition API.

updateItems

  • Arguments:
    • {boolean} disable* - whether the input field should be disabled while fetching options
  • Returns: Promise

Fetches & updates items when using async items.

toggle

  • Arguments:
    • {string|number} value* - value to toggle
  • Returns: void

Toggle's a checkbox's value.

check

  • Arguments:
    • {array|string|number} values* - value(s) to check
  • Returns: void

Checks one or more checkboxes.

uncheck

  • Arguments:
    • {array|string|number} values* - value(s) to check
  • Returns: void

Unchecks one or more checkboxes.

checkAll

  • Returns: void

Checks all checkboxes.

uncheckAll

  • Returns: void

Unchecks all checkboxes.

clearMessages

  • Returns: void

Clears the manually added messages from the messageBag.

load

  • Arguments:
    • {any} value* - the value to be loaded
    • {boolean} format* - whether the loaded value should be formatted with formatLoad before setting the value of the element (default: false)
  • Returns: void

Loads value to the element using optional formatLoad formatter. This is the method that gets called for each element when loading data to the form with format: true.

update

  • Arguments:
    • {any} value* - the value to be set
  • Returns: void

Updates the value of the element similarly to load, only that it can't format data.

clear

  • Returns: void

Clears the element's value.

reset

  • Returns: void

Resets the element's value to default (or empty if default is not provided). Also resets all the validation state for the element.

disable

  • Arguments:
    • {array|string|number} values* - value(s) to disable
  • Returns: void

Disables one item or more items.

disableAll

  • Returns: void

Disables all items.

enable

  • Arguments:
    • {array|string|number} values* - value(s) to enable
  • Returns: void

Disables one item or more disabled items.

enableAll

  • Returns: void

Enables all items.

on

  • Arguments:
    • {string} event* - name of the event to listen for
    • {function} callback* - callback to run when the event is triggered
  • Returns: void

Adds a listener for an event.

off

  • Arguments:
    • {string} event* - name of the event to remove
  • Returns: void

Removes all listeners for an event.

fire

  • Arguments:
    • {any} args* - list of arguments to pass over to the event callback
  • Returns: void

Fires and emits an event.

validate

  • Returns: Promise

Checks each validation rule for the element (async).

clean

  • Returns: void

Removes the element's dirty state.

resetValidators

  • Returns: void

Sets the validators to default state.

reinitValidation

  • Returns: void

Re-initializes validators when rules have changed.

hide

  • Returns: void

Hides the element.

show

  • Returns: void

Shows the element if it was hidden with hide() method.

Events

With events you can subscribe to different events broadcasted by the element. It can be used inline as regular Vue event listeners with @event format. In schema it can be used in PascalCase format prefixed with on (eg. onChange).

vue
<template>
  <Vueform>
    <CheckboxgroupElement @{eventName}="handler" ... />
  </Vueform>
</template>
vue
<script>
import { Vueform, useVueform } from '@vueform/vueform'

export default {
  mixins: [Vueform],
  setup: useVueform,
  data: () => ({
    vueform: {
      schema: {
        element: {
          type: 'checkboxgroup',
          on{EventName}() {
            // ...
          }
        }
      }
    }
  })
}
</script>

You can also use on(event, callback) method to subscribe to events.

change

  • Params:
    • {string} newValue - the new value
    • {string} oldValue - the old value
    • {component} el$ - the element's component

Triggered when the element's value is changed.

beforeCreate

  • Params:
    • {component} el$ - the element's component

Triggered in beforeCreate hook.

created

  • Params:
    • {component} el$ - the element's component

Triggered in created hook.

beforeMount

  • Params:
    • {component} el$ - the element's component

Triggered in beforeMount hook.

mounted

  • Params:
    • {component} el$ - the element's component

Triggered in mounted hook.

beforeUpdate

  • Params:
    • {component} el$ - the element's component

Triggered in beforeUpdate hook.

updated

  • Params:
    • {component} el$ - the element's component

Triggered in updated hook.

beforeUnmount

  • Params:
    • {component} el$ - the element's component

Triggered in beforeUnmount (or beforeDestroy in Vue 2) hook.

unmounted

  • Params:
    • {component} el$ - the element's component

Triggered in unmounted (or destroyed in Vue 2) hook.

Views

Alternative views for the component that can be used with view option.

default

vue
<CheckboxgroupElement
  name="checkboxgroup"
  :items="['Vue.js', 'React', 'AngularJS']"
/>

tabs

vue
<CheckboxgroupElement
  name="checkboxgroup"
  :items="['Vue.js', 'React', 'AngularJS']"
  view="tabs"
/>

blocks

vue
<CheckboxgroupElement
  name="checkboxgroup"
  :items="[
    { value: 'Vue.js', label: 'Vue.js', description: 'Vue.js framework' },
    { value: 'React', label: 'React', description: 'React framework' },
    { value: 'AngularJS', label: 'AngularJS', description: 'AngularJS framework' }
  ]"
  view="blocks"
/>

Slots

Slots can be used inline or in slots option object when used in schema:

vue
<template>
  <Vueform>
    <CheckboxgroupElement ... >
      <template #{slot-name}="scope">
        <!-- ... --->
      </template>
    </CheckboxgroupElement>
  </Vueform>
</template>
vue
<script>
import { Vueform, useVueform } from '@vueform/vueform'

export default {
  mixins: [Vueform],
  setup: useVueform,
  data: () => ({
    vueform: {
      schema: {
        element: {
          type: 'checkboxgroup',
          slots: {
            {slotName}: // implementation
          }
        }
      }
    }
  })
}
</script>

checkbox

  • Scope:
    • {component} el$ - the element's component
    • {object} item - the checkbox item
    • {string|number} value - the checkbox value
    • {object} items - the checkbox items
    • {number} index - the index of current checkbox
    • {string} id - the id attribute of the checkbox field used by the default template
    • {string} name - the name attribute of the checkbox field used by the default template
    • {boolean} isDisabled - whether the checkbox is disabled
    • {object} classes - an object containing the classes of CheckboxgroupCheckbox component

Replaces the template for the checkbox field. Checkboxes are rendered by the CheckboxgroupCheckbox component which has a default checkbox template. If the this slot is defined, the default template in CheckboxgroupCheckbox component will be overridden with the content of this slot.

Here's how the default implementation looks like as a slot:

vue
<CheckboxgroupElement name="checkbox">
  <template v-slot:checkbox="{ item, value, el$, classes, isDisabled, id, name }">
    <input
      type="checkbox"
      v-model="el$.model"
      :value="value"
      :class="classes.input"
      :name="name"
      :id="id"
      :disabled="isDisabled"
    />
    <span 
      :class="classes.text"
      v-html="item.label"
    />
  </template>
</CheckboxgroupElement>

label

  • Scope:
    • {component} el$ - the element's component

Renders a label for the element in ElementLabel component.

info

  • Scope:
    • {component} el$ - the element's component

Renders an info icon in ElementInfo component next the the element label. When the icon is hovered it shows the content of this slot. The element needs to have a label to render this.

description

  • Scope:
    • {component} el$ - the element's component

Renders description for the element in ElementDescription component.

before

  • Scope:
    • {component} el$ - the element's component

Renders an ElementText component before the checkbox group.

between

  • Scope:
    • {component} el$ - the element's component

Renders an ElementText component after the checkbox group and before description.

after

  • Scope:
    • {component} el$ - the element's component

Renders an ElementText component after the description and error.

👋 Hire Vueform team for form customizations and developmentLearn more