UNPKG

@material-ui/core

Version:

React components that implement Google's Material Design.

91 lines (80 loc) 2.37 kB
import React from 'react'; import ReactDOM from 'react-dom'; import PropTypes from 'prop-types'; import { exactProp } from '@material-ui/utils'; import { setRef } from '../utils/reactHelpers'; /** * ⚠️⚠️⚠️ * If you want the DOM element of a Material-UI component check out * [FAQ: How can I access the DOM element?](/getting-started/faq/#how-can-i-access-the-dom-element) * first. * * This component uses `findDOMNode` which is deprecated in React.StrictMode. * * 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: * ```jsx * 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> * ); * } * } * ``` */ class RootRef extends React.Component { componentDidMount() { this.ref = ReactDOM.findDOMNode(this); setRef(this.props.rootRef, this.ref); } componentDidUpdate(prevProps) { const ref = ReactDOM.findDOMNode(this); if (prevProps.rootRef !== this.props.rootRef || this.ref !== ref) { if (prevProps.rootRef !== this.props.rootRef) { setRef(prevProps.rootRef, null); } this.ref = ref; setRef(this.props.rootRef, this.ref); } } componentWillUnmount() { this.ref = null; setRef(this.props.rootRef, null); } render() { return this.props.children; } } process.env.NODE_ENV !== "production" ? RootRef.propTypes = { /** * The wrapped element. */ children: PropTypes.element.isRequired, /** * Provide a way to access the DOM node of the wrapped element. * You can provide a callback ref or a `React.createRef()` ref. */ rootRef: PropTypes.oneOfType([PropTypes.func, PropTypes.object]).isRequired } : void 0; if (process.env.NODE_ENV !== 'production') { process.env.NODE_ENV !== "production" ? RootRef.propTypes = exactProp(RootRef.propTypes) : void 0; } export default RootRef;