Skip to content

Checkbox - Flowbite Vue ​

Use the checkbox component to allow users to select one or more options from a set, with support for validation, helper text, and accessible label linking ​


Checkbox - Flowbite

Original reference: https://flowbite.com/docs/forms/checkbox/

The checkbox component can be used to allow users to select one or more options in the form of a square box. It supports helper text, validation feedback, rich label content via a slot, and attribute passthrough to the native <input> element.

Default Checkbox ​

Use v-model to bind the checked state and the label prop to set the visible label text.

vue
<template>
  <fwb-checkbox v-model="check" label="Default checkbox" />
  <fwb-checkbox v-model="checked" label="Checked state" />
</template>

<script setup>
import { ref } from 'vue'
import { FwbCheckbox } from 'flowbite-vue'

const check = ref(false)
const checked = ref(true)
</script>

Disabled State ​

Add the disabled prop to prevent the user from interacting with the checkbox.

vue
<template>
  <fwb-checkbox v-model="check" disabled label="Disabled checkbox" />
</template>

<script setup>
import { ref } from 'vue'
import { FwbCheckbox } from 'flowbite-vue'

const check = ref(false)
</script>

Use the default slot instead of the label prop when the label contains rich content such as links.

vue
<template>
  <fwb-checkbox v-model="check">
    I agree with the
    <fwb-a class="text-blue-600 hover:underline" href="#">terms and conditions.</fwb-a>
  </fwb-checkbox>
</template>

<script setup>
import { ref } from 'vue'
import { FwbA, FwbCheckbox } from 'flowbite-vue'

const check = ref(false)
</script>

Checkbox Group ​

When using v-model with an array, pass the :value attribute on each checkbox. Selected values are added to or removed from the array automatically.

Selected fruits: [ "Banana", "Strawberry" ]

Selected planets: [ "3" ]

vue
<template>
  <div class="space-y-2">
    <fwb-checkbox
      v-for="(fruit, i) in fruits"
      :key="i"
      v-model="selectedFruits"
      :label="fruit"
      :value="fruit"
      name="fruits"
    />
    <p class="text-sm text-gray-500">Selected: {{ selectedFruits }}</p>
  </div>
</template>

<script setup>
import { ref } from 'vue'
import { FwbCheckbox } from 'flowbite-vue'

const selectedFruits = ref(['Banana'])
const fruits = ['Apple', 'Banana', 'Orange', 'Strawberry']
</script>

Validation ​

Use validationStatus together with the validationMessage slot (rich content) or the validationMessage prop (plain string) to show success or error feedback below the checkbox. The slot takes priority when both are given.

Great! You have accepted the terms.

Required! You must accept the terms to continue.

vue
<template>
  <fwb-checkbox v-model="check1" label="Terms accepted (success)" validation-status="success">
    <template #validationMessage>
      <span class="font-medium">Great!</span> You have accepted the terms.
    </template>
  </fwb-checkbox>
  <fwb-checkbox
    v-model="check2"
    label="Terms not accepted (error)"
    validation-message="Required! You must accept the terms to continue."
    validation-status="error"
  />
</template>

Helper Text ​

Use the helper slot to show a hint below the checkbox.

For orders shipped from $25 in books or $29 in other categories.

vue
<template>
  <fwb-checkbox v-model="check" label="Free shipping via Flowbite">
    <template #helper>
      For orders shipped from $25 in books or $29 in other categories.
    </template>
  </fwb-checkbox>
</template>

Styling ​

Use dedicated props to pass classes to individual elements inside the checkbox.

vue
<template>
  <fwb-checkbox
    v-model="check"
    label="Custom styled checkbox"
    class="text-amber-600 dark:text-green-500 bg-amber-50 dark:bg-green-900 border-amber-400 dark:border-green-600 focus:ring-amber-500 dark:focus:ring-green-400"
    label-class="font-bold text-amber-900 dark:text-green-200"
    wrapper-class="border-2 border-amber-700 dark:border-green-400 bg-amber-300 dark:bg-green-800 rounded-lg p-3"
  />
</template>

Checkbox component API ​

FwbCheckbox Props ​

Native attribute passthrough

FwbCheckbox sets inheritAttrs: false and forwards all extra attributes (e.g. name, value, form, aria-label) directly to the <input type="checkbox"> element. Pass :value and name as regular attributes when using the checkbox in a group.

NameTypeDefaultDescription
classString | Object''Added to the checkbox input element.
disabledBooleanfalseDisables the checkbox.
labelString''Label text rendered next to the checkbox. Ignored when the default slot is used.
labelClassString | Object''Added to the label text element.
modelValueBoolean | ArrayfalseThe current value (use with v-model). Pass an array for group checkboxes.
validationMessageStringundefinedValidation feedback text; fallback for the validationMessage slot.
validationStatus'success' | 'error'undefinedApplies success or error colour styles to the label text.
wrapperClassString | Object''Added to the outer root <div>.

Accessibility

aria-invalid="true" is set automatically on the native checkbox when validationStatus="error". aria-describedby is wired to the IDs of any rendered validationMessage (slot or prop) and helper slots, and is merged with any aria-describedby value you pass as an attribute. When no label prop or default slot is provided, pass aria-label as an attribute to maintain an accessible name — it is forwarded directly to the <input>.

FwbCheckbox Slots ​

NameDescription
defaultRich label content rendered next to the checkbox (takes priority over label prop).
helperHelper text rendered below the checkbox.
validationMessageValidation feedback rendered below the checkbox (styled by validationStatus). Takes priority over the validationMessage prop.

Released under the MIT License.