Tutorial

Introduction to the React Ref System

Published on May 16, 2017
author

Matthew Garcia

Introduction to the React Ref System

While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

While React’s virtual DOM elegantly handles most situations you’ll run into, there are some cases where you’ll need to interact with the actual elements. For these occasions, React provides a ref system.

Creating a Ref

Creating a ref is pretty straightforward; just pass a callback that assigns to a property.

class MyComponent extends Component {
  render() {
    return (
      <div>
        <input ref={input => this.myInput = input} />
      </div>
    );
  }
}

From there, you can access that element via this.myInput. There are a few ways you can use this.

Using Refs to Get the Value of an Input

It’s as simple as accessing the value of the element. It’s like it’s 2005 again.

class MyComponent extends Component {
  alertInput() {
    const value = this.myInput.value;
    // Please don't use alert in actual applications.
    alert(value);
  }

  render() {
    return (
      <div>
        <input ref={input => this.myInput = input} />
        <button onClick={this.alertInput.bind(this)}>Alert</button>
      </div>
    );
  }
}

If you’re using Redux, you’d probably want to use a controlled component for this. But it’s handy to know for a quick demo.

Setting value won’t end well; React will wipe out the element when it re-renders.

Using Refs to Focus Input

Managing focus is probably one of the most common use cases for refs, if only because there’s no good alternative.

class MyComponent extends Component {
  // As soon as the component mounts, `myInput` will be focused.
  componentDidMount() {
    this.myInput.focus();
  }

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

Using Refs to Manipulate a Canvas

Canvases aren’t very useful unless there’s a canvas element with which to interact.

class MyComponent extends Component {
  // The canvas is drawn when the component is mounted.
  componentDidMount() {
    this.drawCanvas();
  }

  // The canvas is drawn when the component updates.
  componentDidUpdate() {
    this.drawCanvas();
  }

  drawCanvas() {
    const context = this.myCanvas.getContext('2d');
    context.clearRect(0, 0, 500, 500);
    context.fillText('If you can read this, your eyes are better than mine.', 250, 250);
  }

  render() {
    return (
      <div>
        <canvas ref={canvas => this.myCanvas = canvas} height={500} width={500} />
      </div>
    );
  }
}

Remember to redraw the canvas on update.

Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.

Learn more about our products


About the authors
Default avatar
Matthew Garcia

author

Still looking for an answer?

Ask a questionSearch for more help

Was this helpful?
 
Leave a comment


This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Try DigitalOcean for free

Click below to sign up and get $200 of credit to try our products over 60 days!

Sign up

Join the Tech Talk
Success! Thank you! Please check your email for further details.

Please complete your information!

Featured on Community

Get our biweekly newsletter

Sign up for Infrastructure as a Newsletter.

Hollie's Hub for Good

Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.

Become a contributor

Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.

Welcome to the developer cloud

DigitalOcean makes it simple to launch in the cloud and scale up as you grow — whether you're running one virtual machine or ten thousand.

Learn more
DigitalOcean Cloud Control Panel