snippettypescriptreactCritical
How to use refs in React with Typescript
Viewed 0 times
typescriptwithhowuserefsreact
Problem
I'm using Typescript with React. I'm having trouble understanding how to use refs so as to get static typing and intellisense with respect to the react nodes referenced by the refs. My code is as follows.
import * as React from 'react';
interface AppState {
count: number;
}
interface AppProps {
steps: number;
}
interface AppRefs {
stepInput: HTMLInputElement;
}
export default class TestApp extends React.Component {
constructor(props: AppProps) {
super(props);
this.state = {
count: 0
};
}
incrementCounter() {
this.setState({count: this.state.count + 1});
}
render() {
return (
Hello World
this.incrementCounter()}>Increment
Count : {this.state.count}
);
}}Solution
If you’re using React 16.3+, the suggested way to create refs is using
When the component mounts, the
For more on
If you’re using an earlier version of React (<16.3) or need more fine-grained control over when refs are set and unset, you can use “callback refs”.
When the component mounts, React will call the
By defining the
There used to be an API where the
Edited May 22, 2018 to add the new way of doing refs in React 16.3. Thanks @apieceofbart for pointing out that there was a new way.
React.createRef().class TestApp extends React.Component {
private stepInput: React.RefObject;
constructor(props) {
super(props);
this.stepInput = React.createRef();
}
render() {
return ;
}
}When the component mounts, the
ref attribute’s current property will be assigned to the referenced component/DOM element and assigned back to null when it unmounts. So, for example, you can access it using this.stepInput.current.For more on
RefObject, see @apieceofbart's answer or the PR createRef() was added in.If you’re using an earlier version of React (<16.3) or need more fine-grained control over when refs are set and unset, you can use “callback refs”.
class TestApp extends React.Component {
private stepInput: HTMLInputElement;
constructor(props) {
super(props);
this.stepInput = null;
this.setStepInputRef = element => {
this.stepInput = element;
};
}
render() {
return
}
}When the component mounts, React will call the
ref callback with the DOM element, and will call it with null when it unmounts. So, for example, you can access it simply using this.stepInput.By defining the
ref callback as a bound method on the class as opposed to an inline function (as in a previous version of this answer), you can avoid the callback getting called twice during updates.There used to be an API where the
ref attribute was a string (see Akshar Patel's answer), but due to some issues, string refs are strongly discouraged and will eventually be removed.Edited May 22, 2018 to add the new way of doing refs in React 16.3. Thanks @apieceofbart for pointing out that there was a new way.
Code Snippets
class TestApp extends React.Component<AppProps, AppState> {
private stepInput: React.RefObject<HTMLInputElement>;
constructor(props) {
super(props);
this.stepInput = React.createRef();
}
render() {
return <input type="text" ref={this.stepInput} />;
}
}class TestApp extends React.Component<AppProps, AppState> {
private stepInput: HTMLInputElement;
constructor(props) {
super(props);
this.stepInput = null;
this.setStepInputRef = element => {
this.stepInput = element;
};
}
render() {
return <input type="text" ref={this.setStepInputRef} />
}
}Context
Stack Overflow Q#33796267, score: 324
Revisions (0)
No revisions yet.