Design+Code logo

Quick links

Suggested search

CodeSandbox link

You can find the full code for this tutorial, with styling, at https://codesandbox.io/s/usemouseposition-hook-rb6x8.

Create the custom hook

Create the useMousePosition function. Remember that any custom hook must start with the word use . Don't forget to export it at the bottom of the file.

// useMousePosition.js

const useMousePosition = () => {

}

export default useMousePosition;

We'll need to import two hooks from the React library: useState and useMemo.

// useMousePosition.js

import { useState, useMemo } from "react";

Then, let's create two states. One will be for the x position, and one for the y position. Both of them will have 0 as initial value.

// useMousePosition.js

const useMousePosition = () => {
  const [x, setX] = useState(0);
  const [y, setY] = useState(0);
}

Below the two states, we'll create a bind value. This bind value will be equals to useMemo. Inside the useMemo, every time the mouse moves, we want to set the X and Y positions. We can access these positions with event.nativeEvent.offsetX and event.nativeEvent.offsetY.

// useMousePosition.js

const useMousePosition = () => {
  const [x, setX] = useState(0);
  const [y, setY] = useState(0);

  const bind = useMemo(
    () => ({
      onMouseMove: (event) => {
        setX(event.nativeEvent.offsetX);
        setY(event.nativeEvent.offsetY);
      }
    }),
    []
  );
};

Finally, we'll return x , y and bind in at the bottom of the custom hook.

// useMousePosition.js

const useMousePosition = () => {
  const [x, setX] = useState(0);
  const [y, setY] = useState(0);

  const bind = useMemo(
    () => ({
      onMouseMove: (event) => {
        setX(event.nativeEvent.offsetX);
        setY(event.nativeEvent.offsetY);
      }
    }),
    []
  );

  return [x, y, bind];
};

Find below the final code for the useMousePosition hook.

// useMousePosition.js

import { useState, useMemo } from "react";

const useMousePosition = () => {
  const [x, setX] = useState(0);
  const [y, setY] = useState(0);

  const bind = useMemo(
    () => ({
      onMouseMove: (event) => {
        setX(event.nativeEvent.offsetX);
        setY(event.nativeEvent.offsetY);
      }
    }),
    []
  );

  return [x, y, bind];
};

export default useMousePosition;

Use the hook

I created a CourseCard component, and we'll be using the useMousePosition hook to detect the mouse position. You can find the completed CourseCard , with styling at https://codesandbox.io/s/usemouseposition-hook-rb6x8.

// CourseCard.js

import styled from "styled-components";

const CourseCard = () => {
  return (
    <div>
      <img
        src="https://images.ctfassets.net/ooa29xqb8tix/7MWFSk9hPe69mpKoQZrU8v/f699c21b34e3a1269faf7a84a7e76cc0/React_Hook_800x600_cover_new.png?w=400&q=50"
        alt="Course cover"
      />
      <h2>Build a web app with React Hooks</h2>
      <p>20 sections - 4 hours</p>
    </div>
  );
};

export default CourseCard;

Let's import the hook at the top.

// CourseCard.js

import useMousePosition from "./useMousePosition";

Inside of the CourseCard , let's get the x , y and bind elements from the useMousePosition hook.

// CourseCard.js

const CourseCard = () => {
	const [x, y, bind] = useMousePosition();

	// Return body...
}

Since the hook detects the mouse position on a bound component, we need to link the bind variable, which is a useMemo , to the div wrapping our CourseCard . We'll use the spread operator to bind our card with the useMemo.

// CourseCard.js

import styled from "styled-components";

const CourseCard = () => {
	const [x, y, bind] = useMousePosition();

  return (
    <div {...bind}>
      {/* Content... */}
    </div>
  );
};

export default CourseCard;

Apply animations

Now, let's add a simple animation to our card, anytime the user's mouse is on the card! On the div wrapping our CourseCard 's content, we'll add the style attribute. We'll use the transform CSS property to rotate the card anytime the user hovers over it.

// CourseCard.js

import styled from "styled-components";

const CourseCard = () => {
	const [x, y, bind] = useMousePosition();

  return (
    <div 
			{...bind} 
			style={{
        transform: `rotateX(${x / 15}deg) rotateY(${y / -15}deg)`
      }}
		>
      {/* Content... */}
    </div>
  );
};

export default CourseCard;

Learn with videos and source files. Available to Pro subscribers only.

Purchase includes access to 50+ courses, 320+ premium tutorials, 300+ hours of videos, source files and certificates.

BACK TO

Spread attributes

READ NEXT

useReducer with useContext Part 1

Templates and source code

Download source files

Download the videos and assets to refer and learn offline without interuption.

check

Design template

check

Source code for all sections

check

Video files, ePub and subtitles

Videos

ePub

Assets

Subtitles

1

Intro to React Hooks

An overview of React Hooks and the frameworks you can use to build your React application blazingly fast

3:39

2

Create your first React app

Create your first React project from the Terminal and save it on your local computer

4:23

3

React Component

Create your first JSX component using React

2:54

4

Styling in React

How to style your React components using inline styling, separate stylesheets or styled-components

5:06

5

Styles and Props

Render different styles depending on different properties passed to your component

2:22

6

Understanding Hooks

Learn about the basics of React Hooks, which introduced at React Conf 2018

3:21

7

useState Hook

Use the useState hook to manage local state in your React component

2:54

8

useEffect Hook

Manage with your component's lifecycle with the useEffect hook

3:41

9

useRef Hook

Learn about the useRef hook, which replaces the JavaScript getElementById way

3:00

10

Props

Learn about props in React to pass data from parent to child components

3:11

11

Conditional Rendering

Render different UIs depending on different conditions and states

4:21

12

Load Local Data

Load local JSON data into your React application

4:04

13

Fetch Data from an API

Learn the basics of asynchronous functions and promises by fetching data from an API using fetch, useEffect and useState

5:40

14

Toggle a state

Learn how to toggle a state from true to false and back again

4:05

15

useInput Hook

Create a hook to get the value and the onChange event of input fields

6:04

16

Gatsby and React

Create a static content-oriented website using React on Gatsby

6:44

17

NextJS and React

Create your first NextJS React application

5:24

18

React TypeScript Part 1

Learn how to create a React TypeScript application using the Create React App, Gatsby and NextJS methods

8:19

19

React TypeScript Part 2

Learn the basics of TypeScript and how to use TypeScript in a React component

7:35

20

useScrollPosition Hook

Create a custom hook to listen to the current window position of the user

4:26

21

useOnScreen hook

Create a custom hook to listen to when an element is visible on screen

8:08

22

useContext Hook

Manage global states throughout the entire application

8:32

23

Fragments

Group multiple children together with React Fragments

2:43

24

Lazy Loading

Lazy Load heavy components to improve performance

4:05

25

React Suspense

Wait for data with React Suspense and React.lazy

3:13

26

Environment Variables

Make environment variables secret with a .env file

4:43

27

Reach Router

Create a multiple-pages React application with Reach Router

5:31

28

URL Params

Create unique URL with URL Params

4:04

29

SEO and Metadata

Optimize a React application for search engines with React Helmet

6:47

30

Favicon

Add an icon to a React website

3:03

31

Dynamic Favicon

Change the favicon's fill color depending on the user's system appearance

2:14

32

PropTypes

Implement props type-checking with PropTypes

3:54

33

Custom PropTypes

Create a custom PropType using a validator function

3:58

34

useMemo Hook

Prevent unnecessary re-renders when the component stays the same

4:05

35

forwardRef Hook

Forward a ref to a child component

3:28

36

Handling Events

How to handle events in React

5:44

37

Spread attributes

Learn how to make use of the spread operator

3:35

38

useMousePosition Hook

Detect the user's mouse position on a bound element

4:55

39

useReducer with useContext Part 1

Create a reducer to be used in a context

7:33

40

useReducer with useContext Part 2

Incorporate useReducer with useContext

6:48

41

useReducer with useContext Part 3

Connect the context and reducer with the frontend

5:43

42

Netlify

Deploy to production using Netlify

5:08

43

Gatsby Cloud

Deploy to production using Gatsby Cloud

6:19

44

Gatsby Plugin Image

Use gatsby-plugin-image for automatic image resizing, formatting, and higher performance

8:11

45

useOnClickOutside Hook

Toggle a modal visibility with a useOnClickOutside hook

6:32

46

useWindowSize Hook

Create a hook to determine the width and height of the window

4:14

47

usePageBottom hook

Detect if the user scrolled to the bottom of the page

4:48

48

useLocalStorage Hook

Store an item in a browser's local storage

5:27

49

Three.js in React Part 1

Bring your website to life with beautiful 3D objects

17:33

50

Three.js in React Part 2

Bring your website to life with beautiful 3D objects

11:18