@yamada-ui/checkbox
Version:
Yamada UI checkbox component
35 lines (32 loc) • 1.41 kB
TypeScript
import './checkbox.js';
import { CheckboxCardProps } from './checkbox-card.js';
import './checkbox-card-addon.js';
import './checkbox-card-description.js';
import { ThemeProps, ComponentArgs } from '@yamada-ui/core';
import { RefAttributes, ReactElement } from 'react';
import { CheckboxGroupSharedProps } from './checkbox-group.js';
import './checkbox-card-label.js';
import './use-checkbox.js';
import './use-checkbox-group.js';
import '@yamada-ui/form-control';
import '@yamada-ui/motion';
import '@yamada-ui/utils';
import '@yamada-ui/layouts';
type CheckboxCardItem<Y extends number | string = string> = CheckboxCardProps<Y>;
interface CheckboxCardGroupProps<Y extends number | string = string> extends CheckboxGroupSharedProps<Y>, Pick<CheckboxCardProps, "addonProps" | "descriptionProps" | "labelProps" | "withIcon">, ThemeProps<"CheckboxCard"> {
/**
* If provided, generate checkbox cards based on items.
*
* @default '[]'
*/
items?: CheckboxCardItem<Y>[];
}
/**
* `CheckboxCardGroup` is a component that groups `CheckboxCard` components.
*
* @see Docs https://yamada-ui.com/components/forms/checkbox-card
*/
declare const CheckboxCardGroup: {
<Y extends number | string = string>(props: CheckboxCardGroupProps<Y> & RefAttributes<HTMLDivElement>): ReactElement;
} & ComponentArgs;
export { CheckboxCardGroup, type CheckboxCardGroupProps, type CheckboxCardItem };