Detect whether input element is focused within ReactJS

Javascriptnode.jsReactjs

Javascript Problem Overview


How can I detect whether an input element such as the following is currently focused within a ReactJS render function?

<input type="text" style={searchBoxStyle} placeholder="Search"></input>   

Javascript Solutions


Solution 1 - Javascript

You can check against document.activeElement as long as the input node is mounted and there is a reference to it:

const searchInput = React.useRef(null)

if (document.activeElement === searchInput.current) {
  // do something
}

return <input type="text" ref={searchInput} />

Another way would be to add event listeners for the focus and blur events inside the input field:

const [focused, setFocused] = React.useState(false)
const onFocus = () => setFocused(true)
const onBlur = () => setFocused(false)

return <input type="text" onFocus={onFocus} onBlur={onBlur} />

Note that this will call a re-render each time the node is focused or blurred (but this is what you want, right?)

Solution 2 - Javascript

I started with the answer given by David, where he describes two methods, and they both worked for me, but I had concerns about both:

  1. On the first case it uses findDOMNode, what has some disadvantages: at minimum its use is discouraged, and it can easily be implemented in a way that it is considered an anti-pattern; and also it can make the code slower, by bypassing the virtual DOM and working with the DOM directly.

  2. On the second option, create and manage a component state only to find that answer seems too much work, can easily get out of sync, and can cause the component to re-render unnecessarily.

So after trying to explore the issue more, I came up with the following solution:

if (this.props.id === document.activeElement.id) {
  // your code goes here
}

The same comment on David's answer applies:

> You should not do this in the render method though, because the input node might not be mounted yet. Use a lifecycle method like componentDidUpdate or componentDidMount.

Advantages:

  • uses the current component properties (which are immutable values)
  • doesn't require state management, and therefore won't cause unnecessary re-rendering
  • doesn't require DOM traversing, so performance should be as good as it gets
  • doesn't require creating a component reference

Requirements:

  • your component should have an id property that is passed to the form element you want to check (which is most likely the case anyway)

Solution 3 - Javascript

Using hooks:

First you create and initialize your Reference

const yourElement = useRef(null)

Then You tag your element with the reference you have just created:

<div ref={yourElement}>Im an DOM node</div>

And then, you use this logic as you need to compare if the document.activeElement document property is equal to the DOM node you are referencing to

yourElement.current === document.activeElement

Solution 4 - Javascript

There is much easier approach with hooks.

Make an import

import React, {useState} from "react";

Define

const [isMyInputFocused, setIsMyInputFocused] = useState(false);

And in your chosen input just add

                    onBlur={() => setIsMyInputFocused(false)}
                    onFocus={() => setIsMyInputFocused(true)}

And from now you could access the isMyInputFocused as you wish.

Solution 5 - Javascript

Using functional component you can determine if the current input has focus:

import React from "react";

export default function App() {
  const ref = React.createRef(null);

  const handleMouseOut = (currentRef) => {

    if (document.activeElement === currentRef) {
      console.log("Yesss");
    }
  };
  return (
    <div className="App">
      <input
        type="text"
        ref={ref}
        onMouseOut={() => handleMouseOut(ref.current)}
      />
    </div>
  );
}

Live example: https://codesandbox.io/s/reverent-allen-0qr8u

Solution 6 - Javascript

Depending on what you want to do, you can use onFocus (React 17) or onBlur (React 16) to implement the functionality that you want when these things are in focus.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionHelpMeStackOverflowMyOnlyHopeView Question on Stackoverflow
Solution 1 - JavascriptDavid HellsingView Answer on Stackoverflow
Solution 2 - JavascriptMarcos AbreuView Answer on Stackoverflow
Solution 3 - JavascriptRolando NiubóView Answer on Stackoverflow
Solution 4 - JavascriptdeathfryView Answer on Stackoverflow
Solution 5 - JavascriptAbhishek E HView Answer on Stackoverflow
Solution 6 - JavascriptSamView Answer on Stackoverflow