Skip to main content

Type Alias: CheckboxAtomProps<A, B>

CheckboxAtomProps<A, B> = object

Defined in: lib/state-management/CheckboxAtom.tsx:16

Props for the CheckboxAtom component.

Type Parameters

A

A extends WritableAtom<boolean, any, any>

The type of the main checkbox atom

B

B extends (WritableAtom<boolean, any, any> | undefined)[]

The type of the array of associated checkbox atoms

Properties

associated?

optional associated: B

Defined in: lib/state-management/CheckboxAtom.tsx:30

Array of associated checkbox atoms for group behavior


atom

atom: A

Defined in: lib/state-management/CheckboxAtom.tsx:26

The Jotai atom controlling the checkbox state


boxClassName?

optional boxClassName: string

Defined in: lib/state-management/CheckboxAtom.tsx:28

Additional CSS classes for the checkbox box


className?

optional className: string

Defined in: lib/state-management/CheckboxAtom.tsx:18

Additional CSS classes for the container


label?

optional label: string

Defined in: lib/state-management/CheckboxAtom.tsx:20

Text label for the checkbox


labelClassName?

optional labelClassName: string

Defined in: lib/state-management/CheckboxAtom.tsx:22

Additional CSS classes for the label


labelPrepend?

optional labelPrepend: boolean

Defined in: lib/state-management/CheckboxAtom.tsx:24

Whether to show the label before the checkbox