@bonprix-ds/react-checkbox-group 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { FC } from 'react';
+import { SelectionControlGroupProps } from '@bonprix-ds/internal-components';
+
+declare const CheckboxGroup: FC<CheckboxGroupProps> & Subcomponents;
+export default CheckboxGroup;
+
+declare interface CheckboxGroupBaseProps extends Omit<SelectionControlGroupProps, "componentName" | "divider" | "horizontalPadding"> {
+    /** The caption for the checkbox group. */
+    label: string;
+    /** The name of the checkbox group. Will be used as the `name` attribute for every item. */
+    name: string;
+}
+
+declare const CheckboxGroupItem: FC<CheckboxGroupItemProps>;
+
+declare interface CheckboxGroupItemProps {
+    /** Value of the checkbox group item, which will be submitted. Defaults to the label if not provided. */
+    value?: string;
+    /** The label for the checkbox group item. */
+    label: string;
+}
+
+export declare type CheckboxGroupProps = ControlledCheckboxGroupProps | UncontrolledCheckboxGroupProps;
+
+declare interface ControlledCheckboxGroupProps extends CheckboxGroupBaseProps {
+    /** The current values of the checkbox group. Should be used in conjunction with `onChange`, when controlling the values. Should be `undefined` otherwise. */
+    values: string[];
+    /** The default values of the checkbox group. Should be used when the checkbox group is uncontrolled. */
+    defaultValues?: never;
+    /** Callback function that is called when the checkbox group state changes. `values` should be adjusted appropriately. */
+    onChange: (value: string[]) => void;
+}
+
+declare interface Subcomponents {
+    Item: typeof CheckboxGroupItem;
+}
+
+declare interface UncontrolledCheckboxGroupProps extends CheckboxGroupBaseProps {
+    values?: never;
+    defaultValues: string[];
+    onChange?: (value: string[]) => void;
+}
+
+export { }