1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
import Checkbox, { type CheckboxProps } from '@components/atoms/forms/checkbox';
import Label, { type LabelProps } from '@components/atoms/forms/label';
import { FC, ReactNode } from 'react';
import styles from './toggle.module.scss';
export type ToggleChoices = {
/**
* The left part of the toggle field (unchecked).
*/
left: ReactNode;
/**
* The right part of the toggle field (checked).
*/
right: ReactNode;
};
export type ToggleProps = Pick<CheckboxProps, 'id' | 'name'> & {
/**
* The toggle choices.
*/
choices: ToggleChoices;
/**
* Set additional classnames to the toggle wrapper.
*/
className?: string;
/**
* The toggle label.
*/
label: string;
/**
* Set additional classnames to the label.
*/
labelClassName?: LabelProps['className'];
/**
* The label size.
*/
labelSize?: LabelProps['size'];
/**
* The toggle value. True if checked.
*/
value: boolean;
/**
* A callback function to update the toggle value.
*/
setValue: (value: boolean) => void;
};
/**
* Toggle component
*
* Render a toggle with a label and two choices.
*/
const Toggle: FC<ToggleProps> = ({
choices,
className = '',
id,
label,
labelClassName = '',
labelSize,
name,
setValue,
value,
}) => {
return (
<>
<Checkbox
name={name}
id={id}
value={value}
setValue={() => setValue(!value)}
className={styles.checkbox}
/>
<Label
size={labelSize}
htmlFor={id}
className={`${styles.label} ${className}`}
>
<span className={`${styles.title} ${labelClassName}`}>{label}</span>
{choices.left}
<span className={styles.toggle}></span>
{choices.right}
</Label>
</>
);
};
export default Toggle;
|
