summaryrefslogtreecommitdiffstats
path: root/src/components/molecules/forms/motion-toggle.tsx
blob: cbe38febfc8acc9f718b3e016ee83bb885f79ef1 (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
import Toggle, {
  type ToggleChoices,
  type ToggleProps,
} from '@components/molecules/forms/toggle';
import useAttributes from '@utils/hooks/use-attributes';
import useLocalStorage from '@utils/hooks/use-local-storage';
import { FC } from 'react';
import { useIntl } from 'react-intl';

export type MotionToggleProps = Pick<
  ToggleProps,
  'labelClassName' | 'value'
> & {
  /**
   * The local storage key to save preference.
   */
  storageKey: string;
};

/**
 * MotionToggle component
 *
 * Render a Toggle component to set reduce motion.
 */
const MotionToggle: FC<MotionToggleProps> = ({
  storageKey,
  value,
  ...props
}) => {
  const intl = useIntl();
  const { value: isReduced, setValue: setIsReduced } = useLocalStorage<boolean>(
    storageKey,
    value
  );
  useAttributes({
    element: 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 reduceMotionChoices: ToggleChoices = {
    left: onLabel,
    right: offLabel,
  };

  return (
    <Toggle
      id="reduce-motion-settings"
      name="reduce-motion-settings"
      label={reduceMotionLabel}
      labelSize="medium"
      choices={reduceMotionChoices}
      value={isReduced}
      setValue={setIsReduced}
      {...props}
    />
  );
};

export default MotionToggle;