gov-gui/dist/types/components/gov-checkbox/gov-checkbox.d.ts

Gov UI Component Library Typscript Build

import { EventEmitter } from '../../stencil-public-runtime';
import { AnimationProps } from '../../global/animation-helpers';
export declare class Checkbox implements AnimationProps {
    label: string;
    checked: boolean;
    disabled: boolean;
    value: string;
    required: boolean;
    requiredErrorMessage: string;
    isHovered: boolean;
    error: string;
    valueChanged: EventEmitter<string>;
    animation?: string;
    animationDelay?: '2s' | '3s' | '4s' | '5s';
    animationSpeed?: 'slow' | 'slower' | 'fast' | 'faster';
    private allClasses;
    /**
     * Returns the current value of the checkbox.
     * If checked, returns the `value` prop; otherwise, returns an empty string.
     */
    getValue(): Promise<string>;
    /**
     * Public method to validate the checkbox.
     * If the checkbox is required and not checked, sets an error message and returns false.
     */
    validate(): Promise<boolean>;
    handleCheckboxClick: () => void;
    handleMouseEnter: () => void;
    handleMouseLeave: () => void;
    watchAnimations(): void;
    watchAnimationsDelay(): void;
    watchAnimationsSpeed(): void;
    componentWillLoad(): void;
    provideClass(): void;
    render(): any;
}