CheckButtonGroup

Demos

Size variants

Available size variant for the ui prop: alt/large/small/tiny/micro/square.

Normal size

Checked: -

Small size

Checked: -

<template>
<article>
  <section>
    <h4>Normal size</h4>
    <veui-check-button-group
      v-model="selected"
      :items="licenses"
    />
    <p>Checked: {{ readable }}</p>
  </section>
  <section>
    <h4>Small size</h4>
    <veui-check-button-group
      v-model="selected"
      ui="small"
      :items="licenses"
    />
    <p>Checked: {{ readable }}</p>
  </section>
</article>
</template>

<script>
import { CheckButtonGroup } from 'veui'

export default {
  components: {
    'veui-check-button-group': CheckButtonGroup
  },
  data () {
    return {
      selected: null,
      licenses: [
        {
          label: 'MIT License',
          value: 'mit'
        },
        {
          label: 'BSD License',
          value: 'bsd'
        },
        {
          label: 'Apache License 2.0',
          value: 'apache2'
        }
      ]
    }
  },
  computed: {
    readable () {
      return (this.selected || []).join(', ') || '-'
    }
  }
}
</script>

API

Props

Name Type Default Description

ui

string

Style variants.

Value	Description
`alt`	Alternative style.
`large`	Large size.
`small`	Small size.
`tiny`	Tiny size.
`micro`	Micro size.
`square`	Square button.

items

Array<Object>

[]

The datasource of items with the item type being {label, value, disabled, ...}.

Name	Type	Description
`label`	`string`	The descriptive label of the item.
`value`	`*`	The value of the item.
`disabled`	`boolean=`	Whether the item is disabled.

value

Array

[]

v-model

The values of the selected items.

disabled boolean false Whether the check button group is disabled.

readonly boolean false Whether the check button group is read-only.

Slots

Name Description

default

The label content of each button. Displays the value of the label prop by default.

Name	Type	Description
`label`	`string`	The descriptive label of the item.
`value`	`*`	The value of the item.
`index`	`number`	The index of the item within `items`.
`disabled`	`boolean=`	Whether the item is disabled.

Additionally, custom properties apart from the listed ones will also be passes into the scope object via v-bind.

Events

Name	Description
`change`	`v-model` Triggers when the selected item changed. The callback parameter list is `(value: Array)` and `value` is the value array of the selected items.