All Articles

Strongly Type useRef with ElementRef

Matt Pocock
Matt PocockMatt is a well-regarded TypeScript expert known for his ability to demystify complex TypeScript concepts.

Using useRef with native elements can be a bit of a pain. You need to specify the type of the element you're targeting, but it's not always clear what type you should be using.

tsx
import { useRef } from "react";
 
const Component = () => {
// What goes here?
const audioRef = useRef<NoIdeaWhatGoesHere>(null);
 
return <audio ref={audioRef}>Hello</audio>;
};

A simple solution is to hover over the type of ref to check what it accepts:

tsx
import { useRef } from "react";
 
const Component = () => {
// What goes here?
const audioRef = useRef<HTMLAudioElement>(null);
 
return <audio ref={audioRef}>Hello</audio>;
(property) React.ClassAttributes<HTMLAudioElement>.ref?: React.LegacyRef<HTMLAudioElement> | undefined
};

But there's an easier way.

What is ElementRef?

You can use ElementRef, a type helper from React, to easily extract the type from the element you're targeting.

tsx
import { useRef, ElementRef } from "react";
 
const Component = () => {
const audioRef = useRef<ElementRef<"audio">>(null);
 
return <audio ref={audioRef}>Hello</audio>;
};

This even works with custom components that use forwardRef. You can use typeof to pass them to ElementRef, and it'll extract the type of the element that the component is forwarding to.

tsx
// @filename: other-component.tsx
import React, { forwardRef } from "react";
export const OtherComponent = forwardRef<
HTMLTableElement,
{ children: React.ReactNode }
>(({ children }, ref) => {
return <table ref={ref}>{children}</table>;
});
// @filename: index.tsx
// ---cut---
import { OtherComponent } from "./other-component";
import React, { useRef, ElementRef } from "react";
// Pass it in via typeof!
type OtherComponentRef = ElementRef<typeof OtherComponent>;
const Component = () => {
const ref = useRef<OtherComponentRef>(null);
return <OtherComponent ref={ref}>Hello</OtherComponent>;
};

If you're using the previous solution (with HTMLAudioElement or HTMLDivElement, etc.), there's no reason to change it. But if you're ever unsure what type to use, ElementRef is a great helper.

And if you want more tips like this, check out my free React and TypeScript beginner's course. There are 21 interactive exercises packed with TypeScript tips and tricks for React apps.

Matt's signature

Share this article with your friends

`any` Considered Harmful, Except For These Cases

Discover when it's appropriate to use TypeScript's any type despite its risks. Learn about legitimate cases where any is necessary.

Matt Pocock
Matt Pocock

No, TypeScript Types Don't Exist At Runtime

Learn why TypeScript's types don't exist at runtime. Discover how TypeScript compiles down to JavaScript and how it differs from other strongly-typed languages.

Matt Pocock
Matt Pocock

Deriving vs Decoupling: When NOT To Be A TypeScript Wizard

In this book teaser, we discuss deriving vs decoupling your types: when building relationships between your types or segregating them makes sense.

Matt Pocock
Matt Pocock

NoInfer: TypeScript 5.4's New Utility Type

Learn how TypeScript's new utility type, NoInfer, can improve inference behavior by controlling where types are inferred in generic functions.

Matt Pocock
Matt Pocock