RootRef

RootRef

The API documentation of the RootRef React component.

Helper component to allow attaching a ref to a wrapped element to access the underlying DOM element.

It's highly inspired by https://github.com/facebook/react/issues/11401#issuecomment-340543801. For example:

import React from 'react';
import RootRef from '@material-ui/core/RootRef';

class MyComponent extends React.Component {
  constructor() {
    super();
    this.domRef = React.createRef();
  }

  componentDidMount() {
    console.log(this.domRef.current); // DOM node
  }

  render() {
    return (
      <RootRef rootRef={this.domRef}>
        <SomeChildComponent />
      </RootRef>
    );
  }
}

Props

Name Type Default Description
children * element   The wrapped element.
rootRef * union: func |
 object
  Provide a way to access the DOM node of the wrapped element. You can provide a callback ref or a React.createRef() ref.

Any other properties supplied will be spread to the root element (native element).