@yamada-ui/react/dist/types/components/checkbox/checkbox-group.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { ThemeProps, WithoutThemeProps } from "../../core/system/index.types.js";
import { GenericsComponent } from "../../core/components/index.types.js";
import "../../core/index.js";
import { UseInputBorderProps } from "../input/use-input-border.js";
import { GroupProps } from "../group/group.js";
import { CheckboxStyle } from "./checkbox.style.js";
import { Checkbox, CheckboxProps } from "./checkbox.js";
import { UseCheckboxGroupProps } from "./use-checkbox-group.js";
import { ReactElement, ReactNode } from "react";

//#region src/components/checkbox/checkbox-group.d.ts
interface CheckboxGroupItem<Y extends string = string> extends CheckboxProps<Y> {
  label: ReactNode;
}
interface CheckboxGroupRootProps<Y extends string = string> extends Omit<WithoutThemeProps<GroupProps, CheckboxStyle>, "defaultValue" | "onChange" | "value">, ThemeProps<CheckboxStyle>, UseCheckboxGroupProps<Y>, UseInputBorderProps, Pick<CheckboxProps, "checkedIcon"> {
  /**
   * If provided, generate options based on items.
   *
   * @default []
   */
  items?: CheckboxGroupItem<Y>[];
}
/**
 * `CheckboxGroup` is a component that groups `Checkbox` components.
 *
 * @see https://yamada-ui.com/docs/components/checkbox
 */
declare const CheckboxGroupRoot: GenericsComponent<{
  <Y extends string = string>(props: CheckboxGroupRootProps<Y>): ReactElement;
}>;
//#endregion
export { CheckboxGroupRoot, CheckboxGroupRootProps };
//# sourceMappingURL=checkbox-group.d.ts.map