{"componentChunkName":"component---src-templates-tag-js","path":"/tags/refs/","result":{"data":{"site":{"siteMetadata":{"title":"LoginRadius Blog"}},"allMarkdownRemark":{"totalCount":1,"edges":[{"node":{"fields":{"slug":"/engineering/react-with-refs/"},"html":"

In this article, We will discuss the manipulation of DOM elements with Ref directly with React.

\n

React Framework builds your components and abstracts your code away from manipulation within the DOM but still leaves the door open for developers to access it. Reason are few cases where it might be necessary. That's why React provides an escape hatch know as refs.

\n

Refs are a function that use to access the DOM from components. You only need to attach a ref to the element in your application to provide access to it from anywhere within your component without making use of props and all.

\n

We can also use Refs to direct access to React elements and use callbacks with them.

\n

We should only use refs when the required interaction cannot be achieved using state and props.

\n

Use Refs

\n

We can use refs to do anything that needs to be manipulated in the DOM. Some good cases like focus, test selection, media playback, triggering mandatory animations, or integration with the third-party DOM library.

\n

Note: We should avoid using refs because it removes the purpose of using React. For example, If you want to show and hide a \tpopup component. We should use a boolean prop for it instead of manipulating dom.\n

\n

Creating Refs

\n

We can use React.createRef()method to create Refs, and then we can attach to a Dom element via the ref attribute after that, we can access and modify that element through the ref.

\n
class App extends React.Component {\n  constructor(props) {  \n    super(props);  \n    this.myRef = React.createRef();\n  }\n  render() {\n    return <div ref={this.myRef} />; \n  }\n}
\n

In above code, We created this.myRef in the constructor by calling React.createRef() method.

\n

Then in the render method , we attached the returned value to ref of the div element, a reference to the node becomes accessible at the current attribute of the ref.

\n

We should not use ref attribute on function components because they do not have instances.

\n

React will assign the current property with Dom element when component mount and assign null to it when component unmount.

\n

ref updates happen before componentDidMount or componentDidUpdate methods.

\n

We can pass refs as props to the component. Example:

\n
function MyCustomTextInput ({ myInputRef }) {  \n  return <input ref={myInputRef} />;  \n}\n\nclass App extends React.Component {  \n  constructor(props) {  \n    super(props);  \n    this.myInputRef = React.createRef();  \n  } \n  \n  componentDidMount() {  \n    this.myInputRef.current.focus();  \n  }\n  \n  render() {  \n    return <MyCustomTextInput inputRef={this.myInputRef} />;  \n  }\n}
\n

In above code, App passed its ref as props to MyCustomTextInput component.

\n

Callback Refs

\n

We can create ref using another way called callback refs; it gives us more fine-grain control over when refs are set and unset within the component.

\n

Instead of passing ref returned by createRef() method, we will pass a function to ref attribute.\nThe function receives React component instance or DOM element, which can be stored and accessed anywhere.

\n
class App extends React.Component {  \n  componentDidMount() {  \n    this.input.focus();  \n  } \n  \n  render() {  \n    return (    \n        <input ref={element => (this.input = element)} />;   \n    );  \n  }  \n}
\n

In the above code, React will call the ref callback t store the reference of the input element when the component mounts; then, it will focus the input element automatically and when the component unmounts, call it with null.

\n

We can pass callback refs between components . Example:

\n
function MyCustomTextInput({ inputRef }) {  \n  return <input ref={inputRef} />;  \n}\n\nclass App extends React.Component {  \n  componentDidMount() {  \n    this.myInputElement.focus();  \n  } \n  render() {  \n    return <MyCustomTextInput inputRef={el => (this.myInputElement = el)} />;  \n  } \n}
\n

In the above code, We passed the function to inputRef and access it in App component so we can call focus on it to focus the input element.

\n

Caveats with callback refs

\n

Callback refs are calling two times during updates if they are defined as an inline function. This is because a new instance of the function is created with each render. We can avoid this by calling it a method of a class.

\n

To understand more about React refs. Read Refs and the DOM

\n","frontmatter":{"date":"April 16, 2021","updated_date":null,"title":"React with Ref","tags":["React","Refs","DOM"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5037593984962405,"src":"/static/0e4deace8ac6b8fceb2ca7ce559fc393/ee604/title-image.png","srcSet":"/static/0e4deace8ac6b8fceb2ca7ce559fc393/69585/title-image.png 200w,\n/static/0e4deace8ac6b8fceb2ca7ce559fc393/497c6/title-image.png 400w,\n/static/0e4deace8ac6b8fceb2ca7ce559fc393/ee604/title-image.png 800w,\n/static/0e4deace8ac6b8fceb2ca7ce559fc393/f3583/title-image.png 1200w","sizes":"(max-width: 800px) 100vw, 800px"}}},"author":{"id":"Versha Gupta","github":"vershagupta","avatar":null}}}}]}},"pageContext":{"tag":"Refs"}},"staticQueryHashes":["1171199041","1384082988","2100481360","23180105","528864852"]}