CheckboxgroupElement ​

<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:

<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:

<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:

<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.

<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.

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

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

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

The list of values to disable.

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

<CheckboxgroupElement name="element" ... />

Sets the element's name.

<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.

<CheckboxgroupElement :disabled="true" ... />
<CheckboxgroupElement :disabled="prop" ... /> <!-- computed / data (ref) prop -->
<CheckboxgroupElement :disabled="[['text', 'value']]" ... /> <!-- conditional -->
<CheckboxgroupElement :disabled="(el$, form$) => { return /* boolean */ }" ... />

Disables the checkbox group.

If can be a boolean value.

It can be a computed / data (ref) prop.

It can be an array of conditions. When all conditions are met the element will become disabled.

It can be a function that receives the el$ element instance and form$ form instance params and expected to return a boolean.

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.

<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.

<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.

<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.

<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.

<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.

<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.

<CheckboxgroupElement :default="['Vue.js', 'React']" ... />

Sets the default value for the checkbox group.

<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.

<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.

<CheckboxgroupElement :submit="false" ... />

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

<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.

<CheckboxgroupElement field-name="Field name" rules="required" ... />

Sets the name of the field in validation rule messages.

<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.

<CheckboxgroupElement :display-errors="false" ... />

Whether element errors should be displayed.

<!-- 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.

<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:

<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.

<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.

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):

<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:

<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:

<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:

<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.

<CheckboxgroupElement :inline="true" ... />

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

<CheckboxgroupElement size="sm" ... />
<CheckboxgroupElement ... /> <!-- Default size: 'md' -->
<CheckboxgroupElement size="lg" ... />

The size of the element and its child components.

<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.

<CheckboxgroupElement :views="{
  ComponentName: 'alt'
}" ... />

The name of the views for the child components.

Learn more about views here.

<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.:

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

Learn more about adding classes here.

<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.:

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

Learn more about adding classes here.

<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.:

<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.

<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.:

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

Learn more about removing classes here.

<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.:

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

Learn more about replacing classes here.

<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.:

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

Learn more about replacing classes here.

<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.:

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

Learn more about overriding classes here.

<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.:

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

Learn more about overriding classes here.

<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.

<CheckboxgroupElement :presets="['preset1', 'preset2']" ... />

The presets to be applied for the component.

Learn more about presets classes here.

<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.

The aria-* attributes of the input.

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

Whether the element is required (has required rule).

Whether the element should use a custom logic for checking if it is filled when validating.

Whether the element is filled is useCustomFilled is true.

Whether the element has its default value.

The value of the element.

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.

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

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).

The path of the element using dot . syntax.

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

The parent component of the element.

Whether the element was already validated at least once.

Whether the element has any failing rules.

Whether the element's value was modified.

Whether the element has any async rules in progress.

Whether the element is pending.

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

All the errors of MessageBag.

The first error of MessageBag.

Whether no conditions are defined or they are all fulfilled.

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

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

Whether the element is disabled.

Whether the element has been filled in successfully.

Whether the element has errors.

The ref to the outermost DOM of the element.

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

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

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

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.

The component's template.

The component's classes.

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

The root form's component.

The element's component.

Whether the element has been already mounted.

Fetches & updates items when using async items.

Toggle's a checkbox's value.

Checks one or more checkboxes.

Unchecks one or more checkboxes.

Checks all checkboxes.

Unchecks all checkboxes.

Clears the manually added messages from the messageBag.

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.

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

Clears the element's value.

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

Disables one item or more items.

Disables all items.

Disables one item or more disabled items.

Enables all items.

Adds a listener for an event.

Removes all listeners for an event.

Fires and emits an event.

Checks each validation rule for the element (async).

Removes the element's dirty state.

Sets the validators to default state.

Re-initializes validators when rules have changed.

Hides the element.

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

Triggered when the element's value is changed.

Triggered in beforeCreate hook.

Triggered in created hook.

Triggered in beforeMount hook.

Triggered in mounted hook.

Triggered in beforeUpdate hook.

Triggered in updated hook.

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

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

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:

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

<template>
  <Vueform :schema />
</template>

<script setup>
import { ref } from 'vue'

const CustomCheckboxSlot = {
  props: ['item', 'value', 'el$', 'classes', 'isDisabled', 'id', 'name', 'items'],
  render() {
    return h('div', {
      class: 'flex align-start'
    }, [
      h('input', {
        type: 'checkbox',
        modelValue: this.el$.model,
        value: this.value,
        class: this.classes.input,
        name: this.name,
        id: this.id,
        disabled: this.isDisabled,
        ariaLabel: this.item.label,
        onInput: (event) => {
          if (event.target.checked) {
            this.el$.model.push(this.value)
          } else {
            this.el$.model = this.el$.model.filter(v => v != this.value)
          }
        }
      }),
      h('span', {
        class: this.classes.text,
        innerHTML: this.item.label
      })
    ])
  }
}

const schema = ref({
  checkbox: {
    type: 'checkboxgroup',
    slots: {
      checkbox: CustomCheckboxSlot,
    },
  }
})
</script>

Renders a label for the element in ElementLabel 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.

Renders description for the element in ElementDescription component.

Renders an ElementText component before the checkbox group.

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

Renders an ElementText component after the description and error.