use-reduced-motion

Usage

use-reduced-motion detects if user prefers to reduce motion. It uses use-media-query hook under the hood. Hook relies on window.matchMedia() API and will always return false if api is not available (e.g. during server side rendering), unless initial value is provided in the first argument.

Use hook to detect if user prefers to reduce motion ((prefers-reduced-motion: reduce) media query) and set animations duration based on this value. All Mantine components which use animations support it by default:

import { Badge } from '@asuikit/core';
import { useReducedMotion } from '@asuikit/hooks';

function Demo() {
  const reduceMotion = useReducedMotion();

  return (
    <Badge
      color={reduceMotion ? 'red' : 'teal'}
      style={{ transitionDuration: reduceMotion ? '0ms' : '200ms' }}
      variant="filled"
    >
      {reduceMotion ? 'You prefer to reduce motion' : 'You prefer not to reduce motion'}
    </Badge>
  );
}

Definition

function useReducedMotion(
  initialValue?: boolean,
  options?: {
    getInitialValueInEffect: boolean;
  }
): boolean;