soda-material
Version:
A React(>=18) component library that may follow [Material Design 3](https://m3.material.io/components) (a.k.a. Material You)
25 lines (24 loc) • 1.05 kB
TypeScript
/// <reference types="react" />
import './checkbox.scss';
/**
* According to the official implementation, the ripple effect should not occupy space.
* Therefore, if the parent container has `overflow: hidden`, make sure that there is enough area to show the ripple effect.
* @specs https://m3.material.io/components/checkbox/specs
*/
export declare const Checkbox: import("react").ForwardRefExoticComponent<{
/**
* This components is controlled if checked !== undefined
*/
checked?: boolean | undefined;
onChange?: ((checked: boolean) => void) | undefined;
/**
* For uncontrolled
*/
defaultChecked?: boolean | undefined;
children?: React.ReactNode;
disabled?: boolean | undefined;
/**
* This do not have any functional effect, just change color to red
*/
error?: boolean | undefined;
} & Omit<import("react").HTMLProps<HTMLElement>, "as" | "ref" | "checked" | "disabled" | "defaultChecked" | "children" | "onChange" | "error"> & import("react").RefAttributes<HTMLDivElement>>;