input
Checkbox

InputCheckbox

El componente InputCheckbox es un campo de entrada de tipo checkbox que permite al usuario seleccionar o deseleccionar una opción. Puede mostrar etiquetas y manejar validaciones, así como valores personalizados para las opciones activas e inactivas.

Ejemplo

Importación

Para importar el componente InputCheckbox, se puede hacer desde fenextjs

import { InputCheckbox } from "fenextjs";

Parámetros

ParámetroTipoRequeridoDefaultDescripcion
labelReactNodeno''Etiqueta que se muestra al lado del checkbox.
labelPosition'right' | 'left'no'right'Posición de la etiqueta en relación con el checkbox.
namestringno''Atributo name del elemento input checkbox.
onChange(checked: boolean) => voidnoundefinedFunción que se ejecuta cuando se alterna el checkbox, recibe un valor booleano que indica si está seleccionado.
defaultValuebooleannofalseValor predeterminado del checkbox cuando se renderiza por primera vez.
valuebooleannoundefinedValor controlado del checkbox.
disabledbooleannofalseIndica si el checkbox está deshabilitado.
onValidateCheck() => Promise<void> | voidnoundefinedFunción que se ejecuta para validar el checkbox.
optionalbooleannofalseIndica si el checkbox es opcional.
optionalTextstringno'(optional)'Texto que se muestra si el checkbox es opcional.
requiredbooleannofalseIndica si el checkbox es obligatorio.
requiredTextstringno'*'Texto que se muestra si el checkbox es obligatorio.
onActive() => voidnoundefinedFunción que se ejecuta cuando el checkbox se activa.
onInactive() => voidnoundefinedFunción que se ejecuta cuando el checkbox se desactiva.
valueActiveVTnoundefinedValor a pasar cuando el checkbox se activa.
valueInactiveVFnoundefinedValor a pasar cuando el checkbox se desactiva.
iconReactNodeno<Check />Ícono que se muestra junto al checkbox.

Storybook

Para ver el storybook del componente lo puede hacer con este link (opens in a new tab)

Usos

  • Básico
<InputCheckbox label="Acepto los términos y condiciones" />
  • Checkbox deshabilitado
<InputCheckbox label="No puedo seleccionar este" disabled={true} />
  • Checkbox obligatorio
<InputCheckbox label="Este checkbox es obligatorio" required={true} />
  • Checkbox opcional con texto
<InputCheckbox
  label="Este es opcional"
  optional={true}
  optionalText="(opcional)"
/>