Slashgear / use-reduced-motion

React Hook to detect option that reduce browser animation and motion for A11Y

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to use-reduced-motion 👋

Version Documentation Maintenance License: MIT Twitter: Slashgear_

React hook to detect user reduced motion feature

Install

npm install use-reduced-motion
yarn add use-reduced-motion

Usage

Use directly in your component. Pass the boolean value to your JS animated component to stop it.

import React from "react";
import { useReducedMotion } from "use-reduced-motion";
import { AnimatedDiv } from "../somewhere";

export const MyExampleComponent = () => {
  const stopMotion = useReducedMotion();
  return <AnimatedDiv pause={stopMotion} />;
};

Author

👤 Antoine CARON antoine395.caron@gmail.com

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Antoine CARON antoine395.caron@gmail.com.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

About

React Hook to detect option that reduce browser animation and motion for A11Y

License:MIT License


Languages

Language:TypeScript 76.3%Language:JavaScript 23.7%