@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
27 lines (26 loc) • 1.13 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { InputHTMLAttributes, PropsWithChildren, ReactNode } from 'react';
export type CheckboxProps = {
/** An icon to display instead of the default icon. */
icon?: ReactNode;
/** 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. */
icon?: ReactNode;
/** Allows being neither checked nor unchecked. */
indeterminate?: boolean;
/** Whether the value fails a validation rule. */
invalid?: boolean;
} & Omit<InputHTMLAttributes<HTMLInputElement>, "aria-invalid" | "type"> & {
children?: ReactNode | undefined;
} & import("react").RefAttributes<HTMLInputElement>>;