import { RequiredProp } from '../../composables/required.js'; import { CustomValidityProp } from '../../composables/useFormElementError.js'; import { AutofocusProp, BaseSelectOption, Nullable, Orientation, SelectOptionValue } from '../../types/index.js'; import { SharedFormElementProps } from '../OnyxFormElement/types.js'; export type OnyxCheckboxGroupProps = Pick & Pick & { /** * Checkbox options. */ options: CheckboxGroupOption[]; /** * Currently checked checkboxes. */ modelValue?: Nullable; /** * Orientation of the checkboxes. */ orientation?: Orientation; /** * If true, an additional checkbox will be displayed to check/uncheck all options. * Disabled and skeleton checkboxes will be excluded from the check/uncheck behavior. */ withCheckAll?: boolean | { /** * Label for the `select all` checkbox. * If unset, a default label will be shown depending on the current locale/language. */ label?: string; }; }; export type CheckboxGroupOption = BaseSelectOption & RequiredProp & CustomValidityProp & AutofocusProp;