1.1.0 • Published 4 months ago
@atmgrupomaggioli/iris-checkbox v1.1.0
iris-checkbox
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
disabled | disabled | Define si el checkbox está deshabilitado. | boolean | false |
label (required) | label | Texto descriptivo que acompaña al checkbox. | string | undefined |
name | name | Nombre del checkbox - Se usa para identificar el checkbox en formularios. | string | undefined |
required | required | Define si el checkbox es requerido. | boolean | false |
rules | rules | Conjunto de reglas de validación para el checkbox, cada una con una condición y un mensaje de error si no se cumple, permitiendo guiar al usuario. | Rule[] | undefined |
state | state | Define si el checkbox está activado. En el caso de que sea tristate, podrá ser indeterminate también. | "indeterminate" \| boolean | false |
tooltip | tooltip | Contenido del tooltip. | string \| string[] | undefined |
tristate | tristate | Define si el checkbox tiene tres estados (checked, unchecked e indeterminate). | boolean | false |
Events
| Event | Description | Type |
|---|---|---|
toggle | Evento emitido cuando el estado del checkbox cambia. Envía el nuevo estado, que puede ser true, false o 'indeterminate'. | CustomEvent<"indeterminate" \| boolean> |
Methods
clear() => Promise<void>
Resetea el valor del checkbox.
Returns
Type: Promise<void>
getValue() => Promise<boolean | "indeterminate">
Devuelve el valor seleccionado.
Returns
Type: Promise<boolean | "indeterminate">
setValue(value: boolean | "indeterminate") => Promise<void>
Permite establecer el valor programáticamente.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean \| "indeterminate" |
Returns
Type: Promise<void>
validate() => Promise<boolean>
Valida según las reglas definidas y retorna true si es válido, de lo contrario, almacena los mensajes de error y retorna false.
Returns
Type: Promise<boolean>
Retorna true si el valor es válido según las reglas definidas, o false si alguna regla no se cumple.
Built with StencilJS