aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/organisms/forms/motion-toggle/motion-toggle.tsx
blob: c141bf09fb31cf4ccfea0f3ca883cd438e014ebb (plain)
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
88
89
90
91
92
93
import { useCallback, type FC } from 'react';
import { useIntl } from 'react-intl';
import { useAttributes, useLocalStorage } from '../../../../utils/hooks';
import { Legend } from '../../../atoms';
import {
  Switch,
  type SwitchOption,
  type 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' ? undefined : document.documentElement,
    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 = useCallback(() => {
    setIsReduced((prev) => !prev);
  }, [setIsReduced]);

  return (
    <Switch
      {...props}
      isInline
      items={options}
      legend={<Legend>{reduceMotionLabel}</Legend>}
      name="reduced-motion"
      onSwitch={updateSetting}
      value={isReduced ? 'off' : 'on'}
    />
  );
};