govbr-ds-angular
Version:
Implementação em Angular do Design System GovBR.
70 lines (69 loc) • 2.32 kB
TypeScript
import { EventEmitter } from '@angular/core';
import * as i0 from "@angular/core";
/**
* Componente CheckboxComponent é responsável por exibir um checkbox com estado e rótulo.
* @
* @example
* <app-checkbox [label]="'Aceitar termos'" [id]="'checkbox1'" [(value)]="isChecked"></app-checkbox>
*
* @public
* {@link https://www.gov.br/ds/components/checkbox?tab=desenvolvedor|Documentação oficial}
*/
export declare class CheckboxComponent {
/**
* Estado do checkbox.
* @type {'valid' | 'invalid' | ''}
* @default ''
* @optional
*/
state: 'valid' | 'invalid' | '';
/**
* Rótulo do checkbox.
* @type {string}
* @required
*/
label: string;
/**
* ID do checkbox.
* @type {string}
* @required
*/
id: string;
/**
* Indica se o checkbox está desabilitado.
* @default false
* @type {boolean}
*/
disabled: boolean;
/**
* Indica se o checkbox está marcado.
* @default false
* @type {boolean}
*/
checked: boolean;
/** Classe CSS para o estado desabilitado. */
get disabledClass(): boolean;
private _value;
/**
* Obtém o valor do checkbox.
* @returns O valor atual do checkbox.
*/
get value(): boolean;
/**
* Define o valor do checkbox.
* @param val - O novo valor do checkbox.
*/
set value(val: boolean);
/** Evento emitido quando o valor do checkbox muda. */
valueChange: EventEmitter<boolean>;
/**
* Manipulador de evento para mudança de estado do checkbox.
* @param event - O evento de mudança.
* @internal
*/
onChangeCheck(event: Event): void;
static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<CheckboxComponent, "app-checkbox", never, { "state": { "alias": "state"; "required": false; }; "label": { "alias": "label"; "required": true; }; "id": { "alias": "id"; "required": true; }; "disabled": { "alias": "disabled"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
static ngAcceptInputType_disabled: unknown;
static ngAcceptInputType_checked: unknown;
}