Navegar componentes
← Componentes

CheckboxListItem

MiscExemplo
Item de checkbox individual com label, description e slot de end content. Funciona em modo collection (dentro de CheckboxList) ou modo standalone (dentro de List).
Importação
import {CheckboxListItem} from '@pharos-ds/core/CheckboxListItem';

Exemplos

Área interativa

isDisabled
Canal
Código
import {CheckboxListItem, CheckboxList} from '@pharos-ds/core/CheckboxList';

<CheckboxListItem
  label="Alertas por e-mail"
  value="email"
  isDisabled={false}
 />

Props

PropTipoPadrãoDescrição
label *ReactNodeLabel de texto principal do item. Uma string simples nomeia o checkbox automaticamente; um label rico (ReactNode) deve ser pareado com aria-label para que leitores de tela recebam um nome conciso.
aria-labelstringNome acessível em texto simples para o checkbox quando label é um ReactNode. Aplicado ao controle do checkbox. Sem ele, itens com label rico anunciam apenas o genérico "Checkbox" para leitores de tela.
valuestringChave de identidade (obrigatória dentro de CheckboxList).
descriptionstringTexto secundário abaixo do label.
endContentReactNodeConteúdo renderizado após a área do label.
isDisabledbooleanfalseSe este item individual está desabilitado.
isLoadingbooleanfalseSe este item está carregando. Exibe um spinner dentro do checkbox e bloqueia interação neste item. Em modo collection, o item alternado também mostra isso automaticamente enquanto o changeAction pai está pendente.
isCheckedboolean | 'indeterminate'Estado checked direto (apenas modo standalone).
onCheck(checked: boolean) => voidHandler de check direto (apenas modo standalone).
Pacote: @pharos-ds/core · Import: @pharos-ds/core/CheckboxListItem
CheckboxListItem · Pharos