@cerberus-design/react
Version:
The Cerberus Design React component library.
52 lines (51 loc) • 3.69 kB
TypeScript
import { Checkbox, CheckboxControlProps as ArkCheckboxControlProps, CheckboxGroupProps as ArkCheckboxGroupProps, CheckboxIndicatorProps as ArkCheckboxIndicatorProps, CheckboxLabelProps as ArkCheckboxLabelProps, CheckboxRootProps as ArkCheckboxRootProps, CheckboxHiddenInputProps as ArkCheckboxHiddenInputProps } from '@ark-ui/react';
import { CheckboxVariantProps } from 'styled-system/recipes';
import { CerberusPrimitiveProps } from '../../system/index';
import { ForwardRefExoticComponent, RefAttributes } from 'react';
/**
* Checkbox Root component used to provide the context to all other checkbox
* primitives.
* @definition [Cerberus Docs](https://cerberus.digitalu.design/react/checkbox)
* @definition [Primitive Docs](https://ark-ui.com/react/docs/components/checkbox)
*/
export declare const CheckboxRoot: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Checkbox.RootProps & RefAttributes<HTMLLabelElement>>, "ref"> & RefAttributes<unknown>>;
export type CheckboxRootProps = CerberusPrimitiveProps<ArkCheckboxRootProps>;
/**
* Checkbox Label component used to display the label of the checkbox.
* @definition [Cerberus Docs](https://cerberus.digitalu.design/react/checkbox)
* @definition [Primitive Docs](https://ark-ui.com/react/docs/components/checkbox)
*/
export declare const CheckboxLabel: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Checkbox.LabelProps & RefAttributes<HTMLSpanElement>>, "ref"> & RefAttributes<unknown>>;
export type CheckboxLabelProps = CerberusPrimitiveProps<ArkCheckboxLabelProps & CheckboxVariantProps>;
/**
* Checkbox Control component used to display the control of the checkbox.
* @definition [Cerberus Docs](https://cerberus.digitalu.design/react/checkbox)
* @definition [Primitive Docs](https://ark-ui.com/react/docs/components/checkbox)
*/
export declare const CheckboxControl: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Checkbox.ControlProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type CheckboxControlProps = CerberusPrimitiveProps<ArkCheckboxControlProps & CheckboxVariantProps>;
/**
* Checkbox Indicator component used to display the indicator of the checkbox.
* @definition [Cerberus Docs](https://cerberus.digitalu.design/react/checkbox)
* @definition [Primitive Docs](https://ark-ui.com/react/docs/components/checkbox)
*/
export declare const CheckboxIndicator: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Checkbox.IndicatorProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type CheckboxIndicatorProps = CerberusPrimitiveProps<ArkCheckboxIndicatorProps>;
/**
* Checkbox HiddenInput component used to provide the native checkbox input.
* @definition [Cerberus Docs](https://cerberus.digitalu.design/react/checkbox)
* @definition [Primitive Docs](https://ark-ui.com/react/docs/components/checkbox)
*/
export declare const CheckboxHiddenInput: {
(props: CerberusPrimitiveProps<Checkbox.HiddenInputProps & RefAttributes<HTMLInputElement>>): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
export type CheckboxHiddenInputProps = CerberusPrimitiveProps<ArkCheckboxHiddenInputProps>;
/**
* Checkbox Group is used to group checkboxes together in a consistently styled
* way.
* @definition [Cerberus Docs](https://cerberus.digitalu.design/react/checkbox)
* @definition [Primitive Docs](https://ark-ui.com/react/docs/components/checkbox)
*/
export declare const CheckboxGroup: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<Checkbox.GroupProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type CheckboxGroupProps = CerberusPrimitiveProps<ArkCheckboxGroupProps>;