@intility/bifrost-react
Version:
React library for Intility's design system, Bifrost.
28 lines (27 loc) • 1.17 kB
TypeScript
import type { PropsFor } from "../../types.js";
export type CheckboxCardType = CheckboxCardProps["type"];
export type CheckboxCardProps = PropsFor<"input", {
/** CheckboxCard type: `"checkbox"` (default), '"switch"', or `"radio"` */
type?: "checkbox" | "radio" | "switch";
/** Place the checkbox/radio/switch icon `"left"` or `"right"` (default) */
align?: "left" | "right";
/** Available states: `"default"`, `"alert"` */
state?: "default" | "alert";
/** Label text or content shown as title */
label: React.ReactNode;
/** Optional header content */
header?: React.ReactElement;
/** Style for internal `<input>` element */
inputStyle?: React.CSSProperties;
/** CSS class name(s) for internal `<input>` element */
inputClassName?: string;
/** Indeterminate state, overrides checked styling */
indeterminate?: boolean;
}>;
/**
* A card rendered as a Checkbox or Radio button
*
* @see https://bifrost.intility.com/react/checkboxCard
*/
declare const CheckboxCard: import("react").ForwardRefExoticComponent<CheckboxCardProps & import("react").RefAttributes<HTMLInputElement>>;
export default CheckboxCard;