summaryrefslogtreecommitdiffstats
path: root/src/components/molecules/forms/toggle.tsx
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/molecules/forms/toggle.tsx')
-rw-r--r--src/components/molecules/forms/toggle.tsx78
1 files changed, 78 insertions, 0 deletions
diff --git a/src/components/molecules/forms/toggle.tsx b/src/components/molecules/forms/toggle.tsx
new file mode 100644
index 0000000..288062d
--- /dev/null
+++ b/src/components/molecules/forms/toggle.tsx
@@ -0,0 +1,78 @@
+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;
+ /**
+ * 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,
+ 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}>
+ <span className={`${styles.title} ${labelClassName}`}>{label}</span>
+ {choices.left}
+ <span className={styles.toggle}></span>
+ {choices.right}
+ </Label>
+ </>
+ );
+};
+
+export default Toggle;