TairoCheckboxAnimated is an enhanced checkbox component featuring a smooth circular animation with checkmark and customizable color variants for different states.
<script setup lang="ts">
const checked = ref(false)
</script>
<template>
<label class="flex items-center gap-3">
<TairoCheckboxAnimated
v-model="checked"
variant="success"
/>
<BaseText
class="text-muted-500 dark:text"
size="sm"
>
Lowercase
</BaseText>
</label>
</template>
| Model | Type |
|---|---|
v-model | boolean | "indeterminate"The controlled value of the checkbox. Can be binded with v-model. |
| Prop | Type |
|---|---|
asdefault: - | AsTag | ComponentThe element or component this component should render as. Can be overwritten by `asChild`. |
as-childdefault: - | booleanChange the default rendered element for the one passed as a child, merging their props and behavior. Read our [Composition](https://www.reka-ui.com/docs/guides/composition) guide for more details. |
classdefault: - | unknown |
default-valuedefault: - | boolean | "indeterminate"The value of the checkbox when it is initially rendered. Use when you do not need to control its value. |
disableddefault: - | booleanWhen `true`, prevents the user from interacting with the checkbox |
iddefault: - | stringId of the element |
keydefault: - | PropertyKey |
namedefault: - | stringThe name of the field. Submitted with its owning form as part of a name/value pair. |
refdefault: - | VNodeRef |
ref-fordefault: - | boolean |
ref-keydefault: - | string |
requireddefault: - | booleanWhen `true`, indicates that the user must set the value before the owning form can be submitted. |
styledefault: - | unknown |
valuedefault: - | AcceptableValueThe value given as data when submitted with a `name`. |
| Exposed | Type |
|---|---|
variant | "success" | "primary" | "info" | "warning" | "destructive" | "muted" | "light" | "dark" | "black" | "custom"The color of the checkbox. |