@amsterdam/design-system-react/dist/Checkbox/Checkbox.d.ts

All React components from the Amsterdam Design System. Use it to compose pages in your website or application.

/**
 * @license EUPL-1.2+
 * Copyright Gemeente Amsterdam
 */
import type { InputHTMLAttributes, PropsWithChildren } from 'react';
import type { IconProps } from '../Icon';
export type CheckboxProps = {
    /**
     * An icon to display instead of the default icon.
     * @default CheckboxIcon
     */
    icon?: IconProps['svg'];
    /** Allows being neither checked nor unchecked. */
    indeterminate?: boolean;
    /** Whether the value fails a validation rule. */
    invalid?: boolean;
} & PropsWithChildren<Omit<InputHTMLAttributes<HTMLInputElement>, 'aria-invalid' | 'type'>>;
/**
 * @see {@link https://designsystem.amsterdam/?path=/docs/components-forms-checkbox--docs Checkbox docs at Amsterdam Design System}
 */
export declare const Checkbox: import("react").ForwardRefExoticComponent<{
    /**
     * An icon to display instead of the default icon.
     * @default CheckboxIcon
     */
    icon?: IconProps["svg"];
    /** Allows being neither checked nor unchecked. */
    indeterminate?: boolean;
    /** Whether the value fails a validation rule. */
    invalid?: boolean;
} & Omit<InputHTMLAttributes<HTMLInputElement>, "aria-invalid" | "type"> & {
    children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLInputElement>>;