Design+Code logo

Quick links

Suggested search

Code Sandbox Link

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

Why use forwardRef?

As the name implies, forwardRef is used to forward a ref to a child component, when we wish to access that ref further down the DOM tree. In the example below, if we try passing a ref as a prop from the App component to the SubmitButton component, we'll get an error in the console. The error message suggests us to use forwardRef instead.

Errors when passing a ref to child component

Create the ref

First, let's create our SubmitButton component. Note the ref is passed as a prop to this component - but it'll raise an error.

// SubmitButton.js

const SubmitButton = ({ title, ref }) => {
  return (
    <button ref={ref} type="button">
      {title}
    </button>
  );
};

export default SubmitButton;

Next, let's import the SubmitButton into App.js.

// App.js

import SubmitButton from "./SubmitButton";

const App = () => {
		// More code...
				<SubmitButton title="Submit" />
		// More code...
}

export default App;

We'll need to create a ref using the useRef hook from the React library, so import it at the top.

// App.js

import { useRef } from "react";

To create a ref , just call the useRef function and save the result in a ref constant.

// App.js

const ref = useRef();

Pass the ref to the SubmitButton . Note that an error will be raised and it'll be printed on the console.

// App.js

<SubmitButton title="Submit" ref={ref} />

Use forwardRef

In order to use forwardRef , we need to change our SubmitButton component a little bit. Instead of defining a normal functional component, we'll need to use forwardRef . Let's import it.

// SubmitButton.js

import { forwardRef } from "react";

In the code below, the SubmitButton is now equals to the forwardRef . Note that inside of the parentheses of the forwardRef , we need to specify a callback function. This function requires two arguments:

  • The first one is the props object. In our case, since we only pass a title as a prop, we'll only add title to the object.
  • The second argument, which is outside of the props object, is the ref. In the return body of the callback function is the component itself - in this case, the button. Since we passed a ref, let's add this to the JSX attributes of the button. We want to display our title on the button, so let's add this as well.
// SubmitButton.js

const SubmitButton = forwardRef(({ title }, ref) => (
  <Button ref={ref}>{title}</Button>
));

Access the ref

Let's try to access the ref in App.js . Note that the ref is accessible only after the component has mounted. In other words, if you add the console log right after the ref in App.js , you'll always see null printed on the console.

// App.js

const App = () => {
  const ref = useRef();

  console.log("ref", ref);

  return (
    <Wrapper>
      <TitleWrapper>
        <h1>forwardRef</h1>
        <p>A Design+Code tutorial</p>
      </TitleWrapper>
      <SubmitButton title="Submit" ref={ref} />
    </Wrapper>
  );
};

To solve this issue, we need a way to print the message only once the component has been mounted. To know when the component has been mounted, we need to use the useEffect hook. Add it to the imports.

import { useRef, useEffect } from "react";

Let's define the useEffect , and print the ref there.

useEffect(() => {
		console.log("ref", ref);
});

Now when you refresh the page, you'll see the forwardRef printed on the console, which is our button from SubmitButton.js !

Accessing the ref assigned with forwardRef

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

useMemo Hook

READ NEXT

Handling Events

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