infinity-ui-elements
Version:
A React TypeScript component library with Tailwind CSS design system
49 lines • 1.55 kB
TypeScript
import * as React from "react";
declare const checkboxVariants: (props?: ({
size?: "medium" | "large" | "small" | null | undefined;
validationState?: "none" | "error" | null | undefined;
isChecked?: boolean | null | undefined;
isIndeterminate?: boolean | null | undefined;
isDisabled?: boolean | null | undefined;
} & import("class-variance-authority/dist/types").ClassProp) | undefined) => string;
export interface CheckboxProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, "size"> {
/**
* Label text to display next to the checkbox
*/
label?: string;
/**
* Error text to display below the checkbox
*/
errorText?: string;
/**
* Size of the checkbox
*/
size?: "small" | "medium" | "large";
/**
* Validation state of the checkbox
*/
validationState?: "none" | "error";
/**
* Whether the checkbox is disabled
*/
isDisabled?: boolean;
/**
* Whether the checkbox is in an indeterminate state
*/
isIndeterminate?: boolean;
/**
* Whether to show error text (defaults to true if errorText is provided)
*/
showErrorText?: boolean;
/**
* Custom class name for the container
*/
containerClassName?: string;
/**
* Custom class name for the label
*/
labelClassName?: string;
}
declare const Checkbox: React.ForwardRefExoticComponent<CheckboxProps & React.RefAttributes<HTMLInputElement>>;
export { Checkbox, checkboxVariants };
//# sourceMappingURL=Checkbox.d.ts.map