@veracity/vui/dist/checkbox/checkboxGroup.types.d.ts

Veracity UI is a React component library crafted for use within Veracity applications and pages. Based on Styled Components and @xstyled.

import { ChangeEventHandler, FocusEventHandler } from "../utils/types.js";
import "../utils/index.js";
import { ThemingProps } from "../theme/types.js";
import "../theme/index.js";
import { SystemProps } from "../system/system.js";
import "../system/index.js";
import { ReactNode } from "react";
//#region src/checkbox/checkboxGroup.types.d.ts
type CheckboxGroupProps = SystemProps & ThemingProps<'Checkbox'> & {
  /** Deprecated. Please use variant instead. @deprecated  */
  colorScheme?: 'blue' | 'prussian';
  /** Passes the prop to each checkbox. */
  disabled?: boolean;
  /**
   * Overrides the gap between the group label/help text and the checkbox stack (defaults to a
   * size-scaled value). Only takes effect when `label` or `helpText` is set. `gap` (from
   * `SystemProps`) overrides the gap between individual checkboxes in either case.
   */
  groupGap?: SystemProps['gap'];
  /** Help text rendered below the checkbox stack. */
  helpText?: ReactNode;
  /** Displays checkboxes in a row. */
  isRow?: boolean;
  /** Group heading rendered above the checkbox stack. */
  label?: ReactNode;
  /** Passes the prop to each checkbox. */
  name?: string;
  /** Passes the prop to each checkbox. */
  onBlur?: FocusEventHandler;
  /** Passes the prop to each checkbox. */
  onChange?: ChangeEventHandler;
  /** Passes the prop to each checkbox. */
  onFocus?: FocusEventHandler;
};
//#endregion
export { CheckboxGroupProps };

//# sourceMappingURL=checkboxGroup.types.d.ts.map