Aller au contenu principal

Case à cocher

Permet la sélection multiple au sein d'un groupe d'options ; prend en charge l'usage isolé ainsi que la combinaison avec LhCheckboxGroup.

Utilisation de base​

Isolée et en groupe

Sélectionné : ink

import { useState } from 'react'
import { LhCheckbox, LhCheckboxGroup } from '@lh-ui/react'

export default function Demo() {
const [checked, setChecked] = useState(false)
const [group, setGroup] = useState<string[]>(['ink'])

return (
<>
<LhCheckbox checked={checked} onChange={(val) => setChecked(val)}>
Case à cocher isolée
</LhCheckbox>

<LhCheckboxGroup value={group} onChange={(val) => setGroup(val as string[])}>
<LhCheckbox value="ink">Encre</LhCheckbox>
<LhCheckbox value="danqing">Danqing</LhCheckbox>
<LhCheckbox value="blank">Blanc laissé</LhCheckbox>
</LhCheckboxGroup>
</>
)
}

Checkbox Props​

PropDescriptionTypeOptionsValeur par défaut
valueValeur de l'option (active au sein d'un Group)unknown——
checkedÉtat contrôlé (usage isolé)boolean——
defaultCheckedCochée par défaut en mode non contrôléboolean—false
labelTexte affichéstring——
disabledDésactivéeboolean—false
indeterminateÉtat indéterminé (effet visuel uniquement, ne produit pas de valeur)boolean—false
sizeTaille'large' | 'middle' | 'small'—Selon ConfigProvider
nameAttribut name natif (transmis par le Group)string——
sxRaccourci de mise en pageSxProps——

Événements de Checkbox​

ÉvénementDescriptionSignature du rappelÉquivalent Vue
onChangeChangement d'état de la case (deux paramètres)(checked: boolean, event: ChangeEvent) => void@change

CheckboxGroup Props​

PropDescriptionTypeValeur par défaut
valueTableau contrôlé des valeurs cochéesunknown[]—
defaultValueValeurs par défaut en mode non contrôléunknown[][]
disabledDésactive tous les enfantsbooleanfalse
sizeTaille des enfants'large' | 'middle' | 'small'Selon ConfigProvider
nameAttribut name natif transmis aux enfantsstring—

Événements de CheckboxGroup​

ÉvénementDescriptionSignature du rappelÉquivalent Vue
onChangeChangement du tableau des valeurs cochées(value: unknown[]) => void@change
État indéterminé

indeterminate est souvent utilisé pour l'état intermédiaire de « tout sélectionner » : visuellement il s'agit d'un trait horizontal, mais cela n'affecte pas checked. Le composant le synchronise sur l'input natif via useEffect.

Styles​

import '@lh-ui/react/style/checkbox'