Checkbox

El componente e-checkbox captura valores booleanos o mapeados (on/off) con un contrato consistente de campo, incluyendo validacion, texto de ayuda y estados disabled/readonly.

Usa esta pagina para validar patrones de interaccion, mapeo del modelo y etiquetado accesible antes de integrar flujos con checkbox en formularios de produccion.

Uso

Usa este playground base para configurar el checkbox en contexto: color, outlined, disabled, readonly, tonal y retain-color para mantener continuidad visual entre estados.

Requerido para la checklist de despliegue
primary

Variantes visuales

Compara la presentacion default, outlined, tonal, retain-color, activa, disabled y readonly para mantener clara la intencion semantica en formularios densos.

Valores personalizados

Mapea el estado del checkbox a valores de dominio con true-value y false-value cuando el contrato del formulario no es estrictamente booleano.

Activa esta opcion para marcar el despliegue como listo

Valor actual del modelo

hold

Slots nombrados

Usa el slot label para renderizar etiquetas enriquecidas con enlaces o contexto adicional sin perder la semantica nativa del checkbox.

Validacion

Valida flujos de consentimiento con reglas obligatorias y feedback explicito de envio antes de continuar con acciones criticas.

Envia el formulario para validar la regla del checkbox.

Props

Usa la tabla de API como fuente de verdad para tipos aceptados, defaults y comportamiento heredado del campo.

PropiedadTipoPor defecto
modelValueboolean | string | numberundefined

Valor actual del checkbox. El estado marcado se resuelve por igualdad estricta contra trueValue.

trueValueboolean | string | numbertrue

Valor emitido cuando el checkbox queda marcado.

falseValueboolean | string | numberfalse

Valor emitido cuando el checkbox queda desmarcado.

tonalbooleanfalse

Muestra estilo de overlay del field dentro del slot de control sin cambiar el comportamiento.

clearablebooleanfalse

Muestra accion de limpiar cuando existe valor.

colorstring"primary"

Color base de tema aplicado al estado e interacciones del field.

outlinedbooleanfalse

Usa variante visual outlined para el contenedor del field.

disabledbooleanfalse

Desactiva interaccion y evita actualizar valor.

readonlybooleanfalse

Evita edicion manteniendo comportamiento de foco.

densebooleanfalse

Aplica espaciado vertical mas compacto heredado de Field.

retainColorbooleanfalse

Mantiene estilo de color activo despues de foco/interaccion.

labelstring | numberundefined

Texto de etiqueta del field.

labelMinWidthstring | numberundefined

Ancho minimo reservado para la region de etiqueta.

labelBehavior"static""static"

El comportamiento de label es estatico para controles checkbox.

inputAlignleft | right | center | start | end"start"

Alineacion horizontal del texto dentro del area de input/seleccion.

prependIconstring | IconPath | IconPath[]undefined

Icono renderizado en la region externa izquierda.

prependInnerIconstring | IconPath | IconPath[]undefined

Icono renderizado antes del contenido dentro del frame del input.

appendInnerIconstring | IconPath | IconPath[]undefined

Icono renderizado despues del contenido dentro del frame del input.

appendIconstring | IconPath | IconPath[]undefined

Icono renderizado en la region externa derecha.

detailstringundefined

Texto de ayuda mostrado en el area de detalles cuando no hay errores.

detailsOnMessageOnlybooleanfalse

Muestra el area de detalles solo cuando existen mensajes/errores.

rulesFieldRule[]undefined

Reglas de validacion evaluadas contra modelValue.

detailErrorsstring[]undefined

Mensajes de error explicitos renderizados en el area de detalles.