retro-react
Version:
A React component library for building retro-style websites
33 lines (32 loc) • 1.05 kB
TypeScript
/// <reference types="react" />
import { ThemeUICSSObject } from 'theme-ui';
export declare type CheckboxColor = 'primary' | 'secondary' | 'success' | 'error' | 'warn' | 'greyscale' | 'greyscale-dark';
export interface CheckboxProps extends React.InputHTMLAttributes<HTMLInputElement> {
/**
* The color of the Checkbox.
*
* @default 'primary'
*/
color?: CheckboxColor;
/**
* The content of the Checkbox.
*
* @default undefined
*/
label?: string | React.ReactNode;
/**
* Puts the checkbox in an indeterminate state.
* @default false
*/
indeterminate?: boolean;
sx?: ThemeUICSSObject;
}
/**
* Checkboxes are used to select one or more options from a list of options.
*
* @example
* <Checkbox color="primary" />
* <Checkbox color="primary" checked />
* <Checkbox color="primary" disabled />
*/
export declare const Checkbox: import("react").ForwardRefExoticComponent<CheckboxProps & import("react").RefAttributes<HTMLInputElement>>;