JIYIK CN >

Current Location:Home > Learning > WEB FRONT-END > React >

Adding Types to Refs in React with TypeScript

Author:JIYIK Last Updated:2025/03/16 Views:

Adding types to the useRef hook might be a little confusing at first, let’s see why this is the case:

import {useEffect, useRef} from 'react';

export function RefDemo() {
  const inputRef = useRef();

  useEffect(() => {
    inputRef.current.focus();
  }, []);

  return (
    <div>
      <input ref={inputRef} />
    </div>
  );
}

In the above code snippet, we get several errors - the errors are quite lengthy and confusing when we hover over the ref attribute - in summary, inputRef.currentis probably undefined and cannot be assigned to HTMLInputElement.

To fix the error we have to do a few things:

First, add a generic to useRefthe hook and pass in HTMLInputElementas the type.

- const inputRef = useRef();
+ const inputRef = useRef<HTMLInputElement>();

How we get the name is when we hover over the input element we see something like this:

(property) JSX.IntrinsicElements.input: React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>

We can see the type is HTMLInputElement. We can also control click in VSCode and read the declaration file to get the type of any element.

Second, even after adding generics, TypeScript will tell us that we may not actually pass ref to the input element, so because we did not pass an initial value to it useRef, the value of ref may be undefined. So we have to tell TypeScript inputRef.currentthat the value is initialized to null and is either null or HTMLInputElement.

import {useEffect, useRef} from 'react';

export function RefDemo() {
  const inputRef = useRef<HTMLInputElement | null>(null);

  useEffect(() => {
    inputRef?.current?.focus();
  }, []);

  return (
    <div>
      <input ref={inputRef} />
    </div>
  );
}

Because TypeScript doesn't know if we're assigning a ref to an input element, we still have to conditionally call the focus() function on the ref.

For reprinting, please send an email to 1244347461@qq.com for approval. After obtaining the author's consent, kindly include the source as a link.

Article URL:

Related Articles

React Tutorial - Transferring Props

Publish Date:2025/03/16 Views:185 Category:React

React transfers Props. Props are generated when components are encapsulated. Components expose some properties (Props) to the outside world to complete some functions.

React Tutorial: Props Anti-Pattern

Publish Date:2025/03/16 Views:183 Category:React

React's Props anti-pattern, using Props to generate state in getInitialState is an anti-pattern - Anti-Pattern.

React Tutorial - Props Validation

Publish Date:2025/03/16 Views:99 Category:React

Props validation is a very useful way to use components correctly. It can avoid many bugs and problems as your application becomes more and more complex. In addition, it can make your program more readable.

Why do you need to bind event handlers in React Class Components?

Publish Date:2025/03/16 Views:58 Category:React

When using React, we must have come across control components and event handlers. We need to use `.bind()` in the constructor of the custom component to bind these methods to the component instance. As shown in the following code:

Solution to the error "does not contain a default export" in React

Publish Date:2025/03/16 Views:187 Category:React

When we try to use `default import` to import from a module that does not have a `default export`, we get a "does not contain a default export" error. To fix the error, make sure the module has named exports and wrap the import in curly braces, e.g.

Scan to Read All Tech Tutorials

Social Media
  • https://www.github.com/onmpw
  • qq:1244347461

Recommended

Tags

Scan the Code
Easier Access Tutorial