@trail-ui/react
Version:
32 lines (29 loc) • 1.27 kB
TypeScript
import { CheckboxProps } from './checkbox.js';
import * as react from 'react';
import { ReactNode } from 'react';
import { SlotsToClasses, CheckboxGroupSlots, CheckboxVariantProps } from '@trail-ui/theme';
import { Orientation } from '@react-types/shared';
import { CheckboxGroupProps as CheckboxGroupProps$1 } from 'react-aria-components';
import './checkbox-icon.js';
import 'react/jsx-runtime';
interface CheckboxGroupProps extends CheckboxGroupProps$1, Partial<Pick<CheckboxProps, 'lineThrough' | 'isDisabled'>> {
/**
* The axis the checkbox group items should align with.
* @default "vertical"
*/
orientation?: Orientation;
label?: ReactNode;
description?: string;
errorMessage?: string;
/**
* Classes object to style the checkbox group and its children.
*/
classNames?: SlotsToClasses<CheckboxGroupSlots>;
className?: string;
}
declare const CheckboxGroupThemeContext: react.Context<CheckboxVariantProps>;
/**
* A checkbox group allows a user to select multiple items from a list of options.
*/
declare const _CheckboxGroup: react.ForwardRefExoticComponent<CheckboxGroupProps & react.RefAttributes<HTMLDivElement>>;
export { _CheckboxGroup as CheckboxGroup, CheckboxGroupProps, CheckboxGroupThemeContext };