Casilla de verificación
LhCheckbox admite un valor booleano independiente; LhCheckboxGroup admite un valor de matriz para varias opciones.
Uso independiente
<script setup lang="ts">
import { ref } from 'vue'
import { LhCheckbox } from '@lh-ui/vue3'
const accepted = ref(false)
</script>
<template>
<LhCheckbox v-model="accepted" label="He leído y acepto" />
</template><script>
import { LhCheckbox } from '@lh-ui/vue3'
export default {
components: { LhCheckbox },
data() {
return {
accepted: false
}
}
}
</script>
<template>
<LhCheckbox v-model="accepted" label="He leído y acepto" />
</template>Uso en grupo
<script setup lang="ts">
import { ref } from 'vue'
import { LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
const selected = ref(['vue'])
</script>
<template>
<LhCheckboxGroup v-model="selected" name="framework">
<LhCheckbox value="vue" label="Vue" />
<LhCheckbox value="react" label="React" />
<LhCheckbox value="svelte" label="Svelte" />
</LhCheckboxGroup>
</template><script>
import { LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
export default {
components: { LhCheckbox, LhCheckboxGroup },
data() {
return {
selected: ['vue']
}
}
}
</script>
<template>
<LhCheckboxGroup v-model="selected" name="framework">
<LhCheckbox value="vue" label="Vue" />
<LhCheckbox value="react" label="React" />
<LhCheckbox value="svelte" label="Svelte" />
</LhCheckboxGroup>
</template>Tema personalizado
Aplica a las casillas de verificación una paleta temática personalizada.
<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
const selected = ref(['option1'])
const cerblueTheme = {
'primary-color': '#2B4C7C',
'primary-color-hover': '#3D649E',
'primary-color-bg': '#E8EDF3',
}
</script>
<template>
<LhConfigProvider :theme-vars="cerblueTheme">
<LhCheckboxGroup v-model="selected">
<LhCheckbox value="option1" label="Opción 1" />
<LhCheckbox value="option2" label="Opción 2" />
</LhCheckboxGroup>
</LhConfigProvider>
</template><script>
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
export default {
components: { LhConfigProvider, LhCheckbox, LhCheckboxGroup },
data() {
return {
selected: ['option1'],
cerblueTheme: {
'primary-color': '#2B4C7C',
'primary-color-hover': '#3D649E',
'primary-color-bg': '#E8EDF3',
},
}
},
}
</script>
<template>
<LhConfigProvider :theme-vars="cerblueTheme">
<LhCheckboxGroup v-model="selected">
<LhCheckbox value="option1" label="Opción 1" />
<LhCheckbox value="option2" label="Opción 2" />
</LhCheckboxGroup>
</LhConfigProvider>
</template>Para más temas, consulta Personalización del tema.
Internacionalización
El texto de las casillas de verificación puede internacionalizarse con LhConfigProvider y un paquete de idioma.
<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'
const locale = ref('zh-CN')
const selected = ref(['vue'])
</script>
<template>
<!-- Configuración del paquete de idioma -->
<LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
<LhCheckboxGroup v-model="selected">
<LhCheckbox value="vue" :label="locale === 'zh-CN' ? 'Vue框架' : 'Vue Framework'" />
<LhCheckbox value="react" :label="locale === 'zh-CN' ? 'React框架' : 'React Framework'" />
</LhCheckboxGroup>
</LhConfigProvider>
</template><script>
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'
export default {
components: { LhConfigProvider, LhCheckbox, LhCheckboxGroup },
data() {
return {
locale: 'zh-CN',
selected: ['vue'],
zhCN: zhCN,
enUS: enUS,
}
},
}
</script>
<template>
<!-- Configuración del paquete de idioma -->
<LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
<LhCheckboxGroup v-model="selected">
<LhCheckbox value="vue" :label="locale === 'zh-CN' ? 'Vue框架' : 'Vue Framework'" />
<LhCheckbox value="react" :label="locale === 'zh-CN' ? 'React框架' : 'React Framework'" />
</LhCheckboxGroup>
</LhConfigProvider>
</template>Deshabilitado, estado indeterminado y tamaño
La casilla independiente se deshabilita con disabled, muestra el estado indeterminado con indeterminate y ajusta su tamaño con size; el grupo se deshabilita entero con disabled y unifica el tamaño de las casillas con size.
<script setup lang="ts">
import { ref } from 'vue'
const demoCbDisabled = ref(true)
const demoCbIndeterminate = ref(false)
const demoIndeterminate = ref(true)
const demoCbSmall = ref(false)
const demoCbLarge = ref(false)
const demoCbGroupDisabled = ref<string[]>([])
const demoCbGroupSize = ref<string[]>([])
</script>
<template>
<!-- Deshabilitado -->
<LhCheckbox v-model="demoCbDisabled" disabled label="Deshabilitado" />
<!-- Estado indeterminado -->
<LhCheckbox v-model="demoCbIndeterminate" :indeterminate="demoIndeterminate" label="Estado indeterminado" />
<!-- Tamaño pequeño -->
<LhCheckbox v-model="demoCbSmall" size="small" label="small" />
<!-- Tamaño grande -->
<LhCheckbox v-model="demoCbLarge" size="large" label="large" />
<!-- Grupo entero deshabilitado -->
<LhCheckboxGroup v-model="demoCbGroupDisabled" disabled>
<LhCheckbox value="a" label="Opción A" />
<LhCheckbox value="b" label="Opción B" />
</LhCheckboxGroup>
<!-- Tamaño grande unificado en el grupo -->
<LhCheckboxGroup v-model="demoCbGroupSize" size="large">
<LhCheckbox value="a" label="Opción A" />
<LhCheckbox value="b" label="Opción B" />
</LhCheckboxGroup>
</template><script>
export default {
data() {
return {
demoCbDisabled: true,
demoCbIndeterminate: false,
demoIndeterminate: true,
demoCbSmall: false,
demoCbLarge: false,
demoCbGroupDisabled: [],
demoCbGroupSize: [],
}
},
}
</script>
<template>
<!-- Deshabilitado -->
<LhCheckbox v-model="demoCbDisabled" disabled label="Deshabilitado" />
<!-- Estado indeterminado -->
<LhCheckbox v-model="demoCbIndeterminate" :indeterminate="demoIndeterminate" label="Estado indeterminado" />
<!-- Tamaño pequeño -->
<LhCheckbox v-model="demoCbSmall" size="small" label="small" />
<!-- Tamaño grande -->
<LhCheckbox v-model="demoCbLarge" size="large" label="large" />
<!-- Grupo entero deshabilitado -->
<LhCheckboxGroup v-model="demoCbGroupDisabled" disabled>
<LhCheckbox value="a" label="Opción A" />
<LhCheckbox value="b" label="Opción B" />
</LhCheckboxGroup>
<!-- Tamaño grande unificado en el grupo -->
<LhCheckboxGroup v-model="demoCbGroupSize" size="large">
<LhCheckbox value="a" label="Opción A" />
<LhCheckbox value="b" label="Opción B" />
</LhCheckboxGroup>
</template>Checkbox API
LhCheckbox Props
| Prop | Descripción | Tipo | Predeterminado |
|---|---|---|---|
| modelValue | Estado de selección en modo independiente | boolean | false |
| value | Valor que se envía en modo grupo | unknown | — |
| label | Texto de la etiqueta | string | — |
| disabled | Si se deshabilita | boolean | false |
| indeterminate | Si está en estado indeterminado | boolean | false |
| name | — | string | — |
| size | Tamaño | "small" | "medium" | "large" | 'medium' |
| sx | Props de disposición rápida | LhSxProps | — |
LhCheckboxGroup Props
| Prop | Descripción | Tipo | Predeterminado |
|---|---|---|---|
| model-value | Estado de selección en modo independiente | unknown[] | [] |
| disabled | Si se deshabilita todo el grupo | boolean | false |
| name | Nombre nativo del formulario | string | — |
| size | Tamaño de las casillas del grupo | 'small' | 'medium' | 'large' | 'medium' |
Events
| Evento | Descripción | Parámetros |
|---|---|---|
| update:modelValue | El valor cambia | value: boolean o value[] |
| change | La selección cambia | value |
Slots
| Slot | Descripción |
|---|---|
| default | Contenido personalizado |
Definiciones de tipos
Las estructuras de tipos TypeScript exportadas por este componente (extraídas automáticamente de packages/components/checkbox/src/types.ts y de las fuentes @lh-ui/share/core/*; abre cada entrada para ver la definición completa; la descripción de los atributos está en la tabla de Props de arriba):
LhCheckboxSize
export type LhCheckboxSize = 'small' | 'medium' | 'large'LhCheckboxProps
export interface LhCheckboxProps {
modelValue?: boolean
value?: unknown
label?: string
disabled?: boolean
indeterminate?: boolean
name?: string
size?: LhCheckboxSize
/** Props de disposición rápida */
sx?: LhSxProps
}LhCheckboxGroupProps
export interface LhCheckboxGroupProps {
modelValue?: unknown[]
disabled?: boolean
name?: string
size?: LhCheckboxSize
}