aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/organisms/forms/motion-toggle/motion-toggle.tsx
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/organisms/forms/motion-toggle/motion-toggle.tsx')
-rw-r--r--src/components/organisms/forms/motion-toggle/motion-toggle.tsx89
1 files changed, 89 insertions, 0 deletions
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'}
+ />
+ );
+};