import React from "react"; import { MarginProps } from "styled-system"; import { TagProps } from "../../../__internal__/utils/helpers/tags/tags"; export type CheckboxSizes = "small" | "medium" | "large"; export interface CheckboxGroupProps extends MarginProps, TagProps { /** * Unique identifier for the component. * Will use a randomly generated GUID if none is provided. */ id?: string; /** The content for the CheckboxGroup Legend */ legend?: string; /** Content for the hint text below the legend. */ legendHint?: string; /** Size of the CheckboxGroup. */ size?: CheckboxSizes; /** Error message to be displayed when validation fails. */ error?: string; /** * Warning message to be displayed when validation warning occurs. * @deprecated The `warning` state is deprecated and will be removed in a future release. */ warning?: string; /** * [Legacy] Indicate additional information. * @deprecated Information validation is no longer supported on this component. */ info?: string | boolean; /** * The content for the RadioButtonGroup hint text, * will only be rendered when `validationRedesignOptIn` is true. * @deprecated The `legendHelp` prop is deprecated and will be removed in a future release. Please use the `legendHint` prop instead. */ legendHelp?: string; /** * [Legacy] When true, legend is placed in line with the Checkboxes. * @deprecated Inline legends are no longer supported on this component. */ legendInline?: boolean; /** * [Legacy] Percentage width of legend (only when legend is inline) * @deprecated Inline legends are no longer supported on this component. */ legendWidth?: number; /** * [Legacy] Alignment of the legend. * @deprecated Right legend alignment is no longer supported. */ legendAlign?: "left" | "right"; /** * [Legacy] Spacing between legend and field for inline legend, number multiplied by base spacing unit (8) * @deprecated Custom spacing for legends is no longer supported on this component. */ legendSpacing?: 1 | 2; /** The Checkboxes to be rendered in the group */ children: React.ReactNode; /** * Spacing between label and a field for inline label, given number will be multiplied by base spacing unit (8) * @deprecated Custom spacing for labels is no longer supported on this component. */ labelSpacing?: 1 | 2; /** Flag to disable the CheckboxGroup. */ disabled?: boolean; /** Flag to configure CheckboxGroup as mandatory*/ required?: boolean; /** * Overrides the default tooltip position * @deprecated Tooltips are no longer supported on this component. */ tooltipPosition?: "top" | "bottom" | "left" | "right"; /** When true, Checkbox children are inline. */ inline?: boolean; /** * Render the ValidationMessage above the CheckboxGroup * @deprecated The `validationMessagePositionTop` prop is deprecated and will be removed in a future release. */ validationMessagePositionTop?: boolean; } export declare const CheckboxGroup: { ({ children, legend, legendHint, size, error, warning, info, disabled, required, legendInline, legendWidth, legendAlign, legendSpacing, legendHelp, tooltipPosition, inline, id, validationMessagePositionTop, ...rest }: CheckboxGroupProps): React.JSX.Element; displayName: string; }; export default CheckboxGroup;