diff options
Diffstat (limited to 'src/components/organisms/forms/motion-toggle')
5 files changed, 153 insertions, 0 deletions
diff --git a/src/components/organisms/forms/motion-toggle/index.ts b/src/components/organisms/forms/motion-toggle/index.ts new file mode 100644 index 0000000..0e35578 --- /dev/null +++ b/src/components/organisms/forms/motion-toggle/index.ts @@ -0,0 +1 @@ +export * from './motion-toggle'; diff --git a/src/components/organisms/forms/motion-toggle/motion-toggle.fixture.tsx b/src/components/organisms/forms/motion-toggle/motion-toggle.fixture.tsx new file mode 100644 index 0000000..f13658a --- /dev/null +++ b/src/components/organisms/forms/motion-toggle/motion-toggle.fixture.tsx @@ -0,0 +1 @@ +export const storageKey = 'reduced-motion'; diff --git a/src/components/organisms/forms/motion-toggle/motion-toggle.stories.tsx b/src/components/organisms/forms/motion-toggle/motion-toggle.stories.tsx new file mode 100644 index 0000000..7e541db --- /dev/null +++ b/src/components/organisms/forms/motion-toggle/motion-toggle.stories.tsx @@ -0,0 +1,47 @@ +import { ComponentMeta, ComponentStory } from '@storybook/react'; +import { MotionToggle } from './motion-toggle'; +import { storageKey } from './motion-toggle.fixture'; + +/** + * MotionToggle - Storybook Meta + */ +export default { + title: 'Organisms/Forms/Toggle', + component: MotionToggle, + argTypes: { + defaultValue: { + control: { + type: 'select', + }, + description: 'Set the default value.', + options: ['on', 'off'], + type: { + name: 'string', + required: true, + }, + }, + storageKey: { + control: { + type: 'text', + }, + description: 'Set local storage key.', + type: { + name: 'string', + required: true, + }, + }, + }, +} as ComponentMeta<typeof MotionToggle>; + +const Template: ComponentStory<typeof MotionToggle> = (args) => ( + <MotionToggle {...args} /> +); + +/** + * Toggle Stories - Motion + */ +export const Motion = Template.bind({}); +Motion.args = { + defaultValue: 'on', + storageKey, +}; diff --git a/src/components/organisms/forms/motion-toggle/motion-toggle.test.tsx b/src/components/organisms/forms/motion-toggle/motion-toggle.test.tsx new file mode 100644 index 0000000..614c038 --- /dev/null +++ b/src/components/organisms/forms/motion-toggle/motion-toggle.test.tsx @@ -0,0 +1,15 @@ +import { render, screen } from '../../../../../tests/utils'; +import { MotionToggle } from './motion-toggle'; +import { storageKey } from './motion-toggle.fixture'; + +describe('MotionToggle', () => { + // toHaveValue received undefined. Maybe because of localStorage hook... + it('renders a toggle component', () => { + render(<MotionToggle storageKey={storageKey} defaultValue="on" />); + expect( + screen.getByRole('radiogroup', { + name: /Animations:/i, + }) + ).toBeInTheDocument(); + }); +}); diff --git a/src/components/organisms/forms/motion-toggle/motion-toggle.tsx b/src/components/organisms/forms/motion-toggle/motion-toggle.tsx new file mode 100644 index 0000000..a8ca7ce --- /dev/null +++ b/src/components/organisms/forms/motion-toggle/motion-toggle.tsx @@ -0,0 +1,89 @@ +import { ChangeEvent, FC } from 'react'; +import { useIntl } from 'react-intl'; +import { useAttributes, useLocalStorage } from '../../../../utils/hooks'; +import { Legend } from '../../../atoms'; +import { Switch, SwitchOption, SwitchProps } from '../../../molecules'; + +export type MotionToggleValue = 'on' | 'off'; + +export type MotionToggleProps = Omit< + SwitchProps, + 'isInline' | 'items' | 'name' | 'onSwitch' | 'value' +> & { + /** + * True if motion should be reduced by default. + */ + defaultValue: 'on' | 'off'; + /** + * The local storage key to save preference. + */ + storageKey: string; +}; + +/** + * MotionToggle component + * + * Render a Toggle component to set reduce motion. + */ +export const MotionToggle: FC<MotionToggleProps> = ({ + defaultValue, + storageKey, + ...props +}) => { + const intl = useIntl(); + const { value: isReduced, setValue: setIsReduced } = useLocalStorage<boolean>( + storageKey, + defaultValue !== 'on' + ); + useAttributes({ + element: + typeof window !== 'undefined' ? document.documentElement : undefined, + attribute: 'reduced-motion', + value: `${isReduced}`, + }); + + const reduceMotionLabel = intl.formatMessage({ + defaultMessage: 'Animations:', + description: 'MotionToggle: reduce motion label', + id: '/q5csZ', + }); + const onLabel = intl.formatMessage({ + defaultMessage: 'On', + description: 'MotionToggle: activate reduce motion label', + id: 'va65iw', + }); + const offLabel = intl.formatMessage({ + defaultMessage: 'Off', + description: 'MotionToggle: deactivate reduce motion label', + id: 'pWKyyR', + }); + + const options: [SwitchOption, SwitchOption] = [ + { + id: 'reduced-motion-on', + label: onLabel, + value: 'on', + }, + { + id: 'reduced-motion-off', + label: offLabel, + value: 'off', + }, + ]; + + const updateSetting = (e: ChangeEvent<HTMLInputElement>) => { + setIsReduced((prev) => !prev); + }; + + return ( + <Switch + {...props} + isInline + items={options} + legend={<Legend>{reduceMotionLabel}</Legend>} + name="reduced-motion" + onSwitch={updateSetting} + value={isReduced ? 'off' : 'on'} + /> + ); +}; |
