summaryrefslogtreecommitdiffstats
path: root/src/components/molecules/forms
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-04-09 19:16:30 +0200
committerArmand Philippot <git@armandphilippot.com>2022-04-09 19:20:08 +0200
commit9cbef657ac9484cbf79234527ec6bfe6a451ece8 (patch)
tree68a4fec038cf742f1bc949c3b1ad239793f58ced /src/components/molecules/forms
parentaf575907c254d3233c3fd5904afc87c1db0bdcf3 (diff)
refactor(toggle): use Checkbox component and move it to molecules
Diffstat (limited to 'src/components/molecules/forms')
-rw-r--r--src/components/molecules/forms/motion-toggle.tsx2
-rw-r--r--src/components/molecules/forms/prism-theme-toggle.tsx6
-rw-r--r--src/components/molecules/forms/theme-toggle.tsx6
-rw-r--r--src/components/molecules/forms/toggle.module.scss75
-rw-r--r--src/components/molecules/forms/toggle.stories.tsx117
-rw-r--r--src/components/molecules/forms/toggle.test.tsx29
-rw-r--r--src/components/molecules/forms/toggle.tsx86
7 files changed, 314 insertions, 7 deletions
diff --git a/src/components/molecules/forms/motion-toggle.tsx b/src/components/molecules/forms/motion-toggle.tsx
index d4f7d11..9f30b42 100644
--- a/src/components/molecules/forms/motion-toggle.tsx
+++ b/src/components/molecules/forms/motion-toggle.tsx
@@ -1,7 +1,7 @@
import Toggle, {
ToggleChoices,
ToggleProps,
-} from '@components/atoms/forms/toggle';
+} from '@components/molecules/forms/toggle';
import { useState, VFC } from 'react';
import { useIntl } from 'react-intl';
diff --git a/src/components/molecules/forms/prism-theme-toggle.tsx b/src/components/molecules/forms/prism-theme-toggle.tsx
index 81a211b..daee6bd 100644
--- a/src/components/molecules/forms/prism-theme-toggle.tsx
+++ b/src/components/molecules/forms/prism-theme-toggle.tsx
@@ -1,9 +1,9 @@
+import Moon from '@components/atoms/icons/moon';
+import Sun from '@components/atoms/icons/sun';
import Toggle, {
ToggleChoices,
ToggleProps,
-} from '@components/atoms/forms/toggle';
-import Moon from '@components/atoms/icons/moon';
-import Sun from '@components/atoms/icons/sun';
+} from '@components/molecules/forms/toggle';
import { useState, VFC } from 'react';
import { useIntl } from 'react-intl';
diff --git a/src/components/molecules/forms/theme-toggle.tsx b/src/components/molecules/forms/theme-toggle.tsx
index 6d54591..eb56ce9 100644
--- a/src/components/molecules/forms/theme-toggle.tsx
+++ b/src/components/molecules/forms/theme-toggle.tsx
@@ -1,9 +1,9 @@
+import Moon from '@components/atoms/icons/moon';
+import Sun from '@components/atoms/icons/sun';
import Toggle, {
ToggleChoices,
ToggleProps,
-} from '@components/atoms/forms/toggle';
-import Moon from '@components/atoms/icons/moon';
-import Sun from '@components/atoms/icons/sun';
+} from '@components/molecules/forms/toggle';
import { useState, VFC } from 'react';
import { useIntl } from 'react-intl';
diff --git a/src/components/molecules/forms/toggle.module.scss b/src/components/molecules/forms/toggle.module.scss
new file mode 100644
index 0000000..2e8a49f
--- /dev/null
+++ b/src/components/molecules/forms/toggle.module.scss
@@ -0,0 +1,75 @@
+@use "@styles/abstracts/functions" as fun;
+
+.label {
+ --toggle-width: #{fun.convert-px(45)};
+ --toggle-height: calc(var(--toggle-width) / 2);
+
+ display: inline-flex;
+ align-items: center;
+ width: 100%;
+}
+
+.title {
+ margin-right: var(--spacing-2xs);
+}
+
+.toggle {
+ display: inline-flex;
+ align-items: center;
+ width: var(--toggle-width);
+ height: var(--toggle-height);
+ background: var(--color-shadow-light);
+ border: fun.convert-px(1) solid var(--color-primary);
+ border-radius: fun.convert-px(32);
+ box-shadow: inset 0 0 fun.convert-px(3) 0 var(--color-shadow-dark);
+ margin: 0 var(--spacing-2xs);
+ position: relative;
+
+ &::after {
+ content: "";
+ display: block;
+ width: calc((var(--toggle-width) / 2) - 1px);
+ height: calc((var(--toggle-width) / 2) - 1px);
+ background: var(--color-primary-light);
+ border: fun.convert-px(1) solid var(--color-primary);
+ border-radius: 50%;
+ box-shadow: inset 0 0 fun.convert-px(1) fun.convert-px(1)
+ var(--color-shadow),
+ 0 0 fun.convert-px(2) fun.convert-px(1) var(--color-shadow-light);
+ position: absolute;
+ left: fun.convert-px(-2);
+ transition: all 0.3s ease-in-out 0s;
+ }
+}
+
+.checkbox {
+ position: absolute;
+ opacity: 0;
+ cursor: pointer;
+
+ &:checked ~ .label {
+ .toggle::after {
+ position: absolute;
+ left: calc(100% - (var(--toggle-width) / 2) + #{fun.convert-px(2)});
+ }
+ }
+
+ &:hover,
+ &:focus {
+ ~ .label {
+ .toggle::after {
+ background: var(--color-primary-lighter);
+ }
+ }
+ }
+
+ &:focus ~ .label {
+ .title {
+ text-decoration: underline solid var(--color-primary) fun.convert-px(2);
+ }
+
+ .toggle {
+ outline: var(--color-border) solid fun.convert-px(5);
+ }
+ }
+}
diff --git a/src/components/molecules/forms/toggle.stories.tsx b/src/components/molecules/forms/toggle.stories.tsx
new file mode 100644
index 0000000..078a34c
--- /dev/null
+++ b/src/components/molecules/forms/toggle.stories.tsx
@@ -0,0 +1,117 @@
+import { ComponentMeta, ComponentStory } from '@storybook/react';
+import { useState } from 'react';
+import ToggleComponent from './toggle';
+
+export default {
+ title: 'Molecules/Forms',
+ component: ToggleComponent,
+ argTypes: {
+ choices: {
+ description: 'The toggle choices.',
+ type: {
+ name: 'object',
+ required: true,
+ value: {},
+ },
+ },
+ id: {
+ control: {
+ type: 'text',
+ },
+ description: 'The input id.',
+ type: {
+ name: 'string',
+ required: true,
+ },
+ },
+ label: {
+ control: {
+ type: 'text',
+ },
+ description: 'The toggle label.',
+ type: {
+ name: 'string',
+ required: true,
+ },
+ },
+ labelClassName: {
+ control: {
+ type: 'text',
+ },
+ description: 'Set additional classnames to the label.',
+ table: {
+ category: 'Styles',
+ },
+ type: {
+ name: 'string',
+ required: false,
+ },
+ },
+ labelSize: {
+ control: {
+ type: 'select',
+ },
+ description: 'The label size.',
+ options: ['medium', 'small'],
+ table: {
+ category: 'Options',
+ },
+ type: {
+ name: 'string',
+ required: false,
+ },
+ },
+ name: {
+ control: {
+ type: 'text',
+ },
+ description: 'The input name.',
+ type: {
+ name: 'string',
+ required: true,
+ },
+ },
+ setValue: {
+ control: {
+ type: null,
+ },
+ description: 'A callback function to update the toggle value.',
+ type: {
+ name: 'function',
+ required: true,
+ },
+ },
+ value: {
+ control: {
+ type: null,
+ },
+ description: 'The toggle value. True if checked.',
+ type: {
+ name: 'boolean',
+ required: true,
+ },
+ },
+ },
+} as ComponentMeta<typeof ToggleComponent>;
+
+const Template: ComponentStory<typeof ToggleComponent> = ({
+ value: _value,
+ setValue: _setValue,
+ ...args
+}) => {
+ const [isChecked, setIsChecked] = useState<boolean>(false);
+ return (
+ <ToggleComponent value={isChecked} setValue={setIsChecked} {...args} />
+ );
+};
+
+export const Toggle = Template.bind({});
+Toggle.args = {
+ choices: {
+ left: 'On',
+ right: 'Off',
+ },
+ id: 'toggle-example',
+ label: 'Activate setting:',
+ name: 'toggle-example',
+};
diff --git a/src/components/molecules/forms/toggle.test.tsx b/src/components/molecules/forms/toggle.test.tsx
new file mode 100644
index 0000000..fb97adc
--- /dev/null
+++ b/src/components/molecules/forms/toggle.test.tsx
@@ -0,0 +1,29 @@
+import { render, screen } from '@test-utils';
+import Toggle from './toggle';
+
+const choices = {
+ left: 'On',
+ right: 'Off',
+};
+
+const label = 'Activate this setting:';
+
+describe('Toggle', () => {
+ it('renders a checked toggle', () => {
+ render(
+ <Toggle
+ id="toggle-example"
+ name="toggle-example"
+ choices={choices}
+ label={label}
+ value={true}
+ setValue={(__value) => null}
+ />
+ );
+ expect(
+ screen.getByRole('checkbox', {
+ name: `${label} ${choices.left} ${choices.right}`,
+ })
+ ).toBeChecked();
+ });
+});
diff --git a/src/components/molecules/forms/toggle.tsx b/src/components/molecules/forms/toggle.tsx
new file mode 100644
index 0000000..dff2d2d
--- /dev/null
+++ b/src/components/molecules/forms/toggle.tsx
@@ -0,0 +1,86 @@
+import Checkbox from '@components/atoms/forms/checkbox';
+import Label, { type LabelProps } from '@components/atoms/forms/label';
+import { ReactNode, VFC } 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 = {
+ /**
+ * The toggle choices.
+ */
+ choices: ToggleChoices;
+ /**
+ * The input id.
+ */
+ id: string;
+ /**
+ * The toggle label.
+ */
+ label: string;
+ /**
+ * Set additional classnames to the label.
+ */
+ labelClassName?: string;
+ /**
+ * The label size.
+ */
+ labelSize?: LabelProps['size'];
+ /**
+ * The input name.
+ */
+ name: string;
+ /**
+ * 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: VFC<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;