Home » Reactjs » React set focus on input after render

React set focus on input after render

Posted by: admin November 29, 2017 Leave a comment

Questions:

What’s the react way of setting focus on a particular text field after the component is rendered?

Documentation seems to suggest using refs, e.g:

Set ref="nameInput" on my input field in the render function, and then call:

this.refs.nameInput.getInputDOMNode().focus(); 

But where should I call this? I’ve tried a few places but I cannot get it to work.

Answers:

You should do it in componentDidMount and refs callback instead. Something like this

componentDidMount(){
   this.nameInput.focus(); 
}
class App extends React.Component{
  componentDidMount(){
    this.nameInput.focus();
  }
  render() {
    return(
      <div>
        <input 
          defaultValue="Won't focus" 
        />
        <input 
          ref={(input) => { this.nameInput = input; }} 
          defaultValue="will focus"
        />
      </div>
    );
  }
}
    
ReactDOM.render(<App />, document.getElementById('app'));
<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.3.1/react.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.3.1/react-dom.js"></script>
<div id="app"></div>

Questions:
Answers:

@Dhiraj’s answer is correct, but for convenience you can use the autoFocus prop to have an input automatically focus when mounted.

<input autoFocus name=...

Questions:
Answers:

As of React 0.15, the most concise method is:

<input ref={input => input && input.focus()}/>

Questions:
Answers:

If you just want to make autofocus in React, it’s simple.

<input autoFocus type="text" />

While if you just want to know where to put that code, answer is in componentDidMount().

v014.3

componentDidMount() {
    this.refs.linkInput.focus()
}

In most cases, you can attach a ref to the DOM node and avoid using findDOMNode at all.

Read the API documents here: https://facebook.github.io/react/docs/top-level-api.html#reactdom.finddomnode

Questions:
Answers:

The React docs now have a section for this. https://facebook.github.io/react/docs/more-about-refs.html#the-ref-callback-attribute

 render: function() {
  return (
    <TextInput
      ref={function(input) {
        if (input != null) {
          input.focus();
        }
      }} />
    );
  },

Questions:
Answers:

I just ran into this issue and I’m using react 15.0.1 15.0.2 and I’m using ES6 syntax and didn’t quite get what I needed from the other answers since v.15 dropped weeks ago and some of the this.refs properties were deprecated and removed.

In general, what I needed was:

  1. Focus the first input (field) element when the component mounts
  2. Focus the first input (field) element with an error (after submit)

I’m using:

  • React Container/Presentation Component
  • Redux
  • React-Router

Focus the First Input Element

I used autoFocus={true} on the first <input /> on the page so that when the component mounts, it will get focus.

Focus the First Input Element with an Error

This took longer and was more convoluted. I’m keeping out code that isn’t relevant to the solution for brevity.

Redux Store / State

I need a global state to know if I should set the focus and to disable it when it was set, so I don’t keep re-setting focus when the components re-render (I’ll be using componentDidUpdate() to check for setting focus.)

This could be designed as you see fit for you application.

{
    form: {
        resetFocus: false,
    }
}

Container Component

The component will need to have the resetfocus property set and a callBack to clear the property if it ends up setting focus on itself.

Also note, I organized my Action Creators into separate files mostly due to my project is fairly large and I wanted to break them up into more manageable chunks.

import { connect } from 'react-redux';
import MyField from '../presentation/MyField';
import ActionCreator from '../actions/action-creators';

function mapStateToProps(state) {
    return {
        resetFocus: state.form.resetFocus
    }
}

function mapDispatchToProps(dispatch) {
    return {
        clearResetFocus() {
            dispatch(ActionCreator.clearResetFocus());
        }
    }
}

export default connect(mapStateToProps, mapDispatchToProps)(MyField);

Presentation Component

import React, { PropTypes } form 'react';

export default class MyField extends React.Component {
    // don't forget to .bind(this)
    constructor(props) {
        super(props);
        this._handleRef = this._handleRef.bind(this);
    }

    // This is not called on the initial render so
    // this._input will be set before this get called
    componentDidUpdate() {
        if(!this.props.resetFocus) {
            return false;
        }

        if(this.shouldfocus()) {
            this._input.focus();
            this.props.clearResetFocus();
        }
    }

    // When the component mounts, it will save a 
    // reference to itself as _input, which we'll
    // be able to call in subsequent componentDidUpdate()
    // calls if we need to set focus.
    _handleRef(c) {
        this._input = c;
    }

    // Whatever logic you need to determine if this
    // component should get focus
    shouldFocus() {
        // ...
    }

    // pass the _handleRef callback so we can access 
    // a reference of this element in other component methods
    render() {
        return (
            <input ref={this._handleRef} type="text" />
        );
    }
}

Myfield.propTypes = {
    clearResetFocus: PropTypes.func,
    resetFocus: PropTypes.bool
}

Overview

The general idea is that each form field that could have an error and be focused needs to check itself and if it needs to set focus on itself.

There’s business logic that needs to happen to determine if the given field is the right field to set focus to. This isn’t shown because it will depend on the individual application.

When a form is submitted, that event needs to set the global focus flag resetFocus to true. Then as each component updates itself, it will see that it should check to see if it gets the focus and if it does, dispatch the event to reset focus so other elements don’t have to keep checking.

edit
As a side note, I had my business logic in a “utilities” file and I just exported the method and called it within each shouldfocus() method.

Cheers!

Questions:
Answers:

This is not longer the best answer. As of v0.13, this.refs may not available until AFTER componentDidMount() runs, in some odd cases.

Just add the autoFocus tag to your input field, as FakeRainBrigand showed above.

Questions:
Answers:

Ref. @Dave’s comment on @Dhiraj’s answer; an alternative is to use the callback functionality of the ref attribute on the element being rendered (after a component first renders):

<input ref={ function(component){ React.findDOMNode(component).focus();} } />

More info

Questions:
Answers:

This is the proper way, how to autofocus. When you use callback instead of string as ref value, it is automaticly called. You got your ref awailable than without the need of touching the DOM using getDOMNode

render: function() {
  return <TextInput ref={(c) => this._input = c} />;
},
componentDidMount: function() {
  this._input.focus();
},

Questions:
Answers:

You can put that method call inside the render function. Or inside the life cycle method, componentDidUpdate

Questions:
Answers:

Warning: ReactDOMComponent: Do not access .getDOMNode() of a DOM node; instead, use the node directly. This DOM node was rendered by App.

Should be

componentDidMount: function () {
  this.refs.nameInput.focus();
}

Questions:
Answers:

The simplest answer is add the ref=”some name” in the input text element and call the below function.

componentDidMount(){
   this.refs.field_name.focus();
}
// here field_name is ref name.

<input type="text" ref="field_name" />

Questions:
Answers:

Note that none of these answers worked for me with a material-ui TextField component. Per How to set focus to a materialUI TextField? I had to jump through some hoops to get this to work:

const focusUsernameInputField = input => {
  if (input) {
    setTimeout(() => {input.focus()}, 100);
  }
};

return (
  <TextField
    hintText="Username"
    floatingLabelText="Username"
    ref={focusUsernameInputField}
  />
);

Questions:
Answers:

You don’t need getInputDOMNode?? in this case…

Just simply get the ref and focus() it when component mounted — componentDidMount

import React from 'react';
import { render } from 'react-dom';

class myApp extends React.Component {

  componentDidMount() {
    this.nameInput.focus();
  }

  render() {
    return(
      <div>
        <input ref={(input) => { this.nameInput = input; }} />
      </div>
    );
  }

}

ReactDOM.render(<myApp />, document.getElementById('root'));

Questions:
Answers:

Updated version you can check here

componentDidMount() {

    // Focus to the input as html5 autofocus
    this.inputRef.focus();

}
render() {
    return <input type="text" ref={(input) => { this.inputRef = input }} />
})

Questions:
Answers:

Can also be done in componentDidMount as it gets called just after component is rendered using

ReactDOM.findDOMNode(this.refs.item).focus();

<input type="text" ref='item'/>

Questions:
Answers:

I have same problem but I have some animation too, so my colleague suggest to use window.requestAnimationFrame

this is ref attribute of my element:

ref={(input) => {input && window.requestAnimationFrame(()=>{input.focus()})}}

Questions:
Answers:

Read almost all the answer but didnt see a getRenderedComponent().props.input

Set your text input refs

this.refs.username.getRenderedComponent().props.input.onChange('');