{"componentChunkName":"component---src-templates-docs-js","path":"/docs/higher-order-components.html","result":{"data":{"markdownRemark":{"html":"

A higher-order component (HOC) is an advanced technique in React for reusing component logic. HOCs are not part of the React API, per se. They are a pattern that emerges from React’s compositional nature.

\n

Concretely, a higher-order component is a function that takes a component and returns a new component.

\n
const EnhancedComponent = higherOrderComponent(WrappedComponent);
\n

Whereas a component transforms props into UI, a higher-order component transforms a component into another component.

\n

HOCs are common in third-party React libraries, such as Redux’s connect and Relay’s createFragmentContainer.

\n

In this document, we’ll discuss why higher-order components are useful, and how to write your own.

\n

Use HOCs For Cross-Cutting Concerns

\n
\n

Note

\n

We previously recommended mixins as a way to handle cross-cutting concerns. We’ve since realized that mixins create more trouble than they are worth. Read more about why we’ve moved away from mixins and how you can transition your existing components.

\n
\n

Components are the primary unit of code reuse in React. However, you’ll find that some patterns aren’t a straightforward fit for traditional components.

\n

For example, say you have a CommentList component that subscribes to an external data source to render a list of comments:

\n
class CommentList extends React.Component {\n  constructor(props) {\n    super(props);\n    this.handleChange = this.handleChange.bind(this);\n    this.state = {\n      // \"DataSource\" is some global data source\n      comments: DataSource.getComments()\n    };\n  }\n\n  componentDidMount() {\n    // Subscribe to changes\n    DataSource.addChangeListener(this.handleChange);\n  }\n\n  componentWillUnmount() {\n    // Clean up listener\n    DataSource.removeChangeListener(this.handleChange);\n  }\n\n  handleChange() {\n    // Update component state whenever the data source changes\n    this.setState({\n      comments: DataSource.getComments()\n    });\n  }\n\n  render() {\n    return (\n      <div>\n        {this.state.comments.map((comment) => (\n          <Comment comment={comment} key={comment.id} />\n        ))}\n      </div>\n    );\n  }\n}
\n

Later, you write a component for subscribing to a single blog post, which follows a similar pattern:

\n
class BlogPost extends React.Component {\n  constructor(props) {\n    super(props);\n    this.handleChange = this.handleChange.bind(this);\n    this.state = {\n      blogPost: DataSource.getBlogPost(props.id)\n    };\n  }\n\n  componentDidMount() {\n    DataSource.addChangeListener(this.handleChange);\n  }\n\n  componentWillUnmount() {\n    DataSource.removeChangeListener(this.handleChange);\n  }\n\n  handleChange() {\n    this.setState({\n      blogPost: DataSource.getBlogPost(this.props.id)\n    });\n  }\n\n  render() {\n    return <TextBlock text={this.state.blogPost} />;\n  }\n}
\n

CommentList and BlogPost aren’t identical — they call different methods on DataSource, and they render different output. But much of their implementation is the same:

\n\n

You can imagine that in a large app, this same pattern of subscribing to DataSource and calling setState will occur over and over again. We want an abstraction that allows us to define this logic in a single place and share it across many components. This is where higher-order components excel.

\n

We can write a function that creates components, like CommentList and BlogPost, that subscribe to DataSource. The function will accept as one of its arguments a child component that receives the subscribed data as a prop. Let’s call the function withSubscription:

\n
const CommentListWithSubscription = withSubscription(\n  CommentList,\n  (DataSource) => DataSource.getComments()\n);\n\nconst BlogPostWithSubscription = withSubscription(\n  BlogPost,\n  (DataSource, props) => DataSource.getBlogPost(props.id)\n);
\n

The first parameter is the wrapped component. The second parameter retrieves the data we’re interested in, given a DataSource and the current props.

\n

When CommentListWithSubscription and BlogPostWithSubscription are rendered, CommentList and BlogPost will be passed a data prop with the most current data retrieved from DataSource:

\n
// This function takes a component...\nfunction withSubscription(WrappedComponent, selectData) {\n  // ...and returns another component...\n  return class extends React.Component {\n    constructor(props) {\n      super(props);\n      this.handleChange = this.handleChange.bind(this);\n      this.state = {\n        data: selectData(DataSource, props)\n      };\n    }\n\n    componentDidMount() {\n      // ... that takes care of the subscription...\n      DataSource.addChangeListener(this.handleChange);\n    }\n\n    componentWillUnmount() {\n      DataSource.removeChangeListener(this.handleChange);\n    }\n\n    handleChange() {\n      this.setState({\n        data: selectData(DataSource, this.props)\n      });\n    }\n\n    render() {\n      // ... and renders the wrapped component with the fresh data!\n      // Notice that we pass through any additional props\n      return <WrappedComponent data={this.state.data} {...this.props} />;\n    }\n  };\n}
\n

Note that a HOC doesn’t modify the input component, nor does it use inheritance to copy its behavior. Rather, a HOC composes the original component by wrapping it in a container component. A HOC is a pure function with zero side-effects.

\n

And that’s it! The wrapped component receives all the props of the container, along with a new prop, data, which it uses to render its output. The HOC isn’t concerned with how or why the data is used, and the wrapped component isn’t concerned with where the data came from.

\n

Because withSubscription is a normal function, you can add as many or as few arguments as you like. For example, you may want to make the name of the data prop configurable, to further isolate the HOC from the wrapped component. Or you could accept an argument that configures shouldComponentUpdate, or one that configures the data source. These are all possible because the HOC has full control over how the component is defined.

\n

Like components, the contract between withSubscription and the wrapped component is entirely props-based. This makes it easy to swap one HOC for a different one, as long as they provide the same props to the wrapped component. This may be useful if you change data-fetching libraries, for example.

\n

Don’t Mutate the Original Component. Use Composition.

\n

Resist the temptation to modify a component’s prototype (or otherwise mutate it) inside a HOC.

\n
function logProps(InputComponent) {\n  InputComponent.prototype.componentDidUpdate = function(prevProps) {\n    console.log('Current props: ', this.props);\n    console.log('Previous props: ', prevProps);\n  };\n  // The fact that we're returning the original input is a hint that it has\n  // been mutated.\n  return InputComponent;\n}\n\n// EnhancedComponent will log whenever props are received\nconst EnhancedComponent = logProps(InputComponent);
\n

There are a few problems with this. One is that the input component cannot be reused separately from the enhanced component. More crucially, if you apply another HOC to EnhancedComponent that also mutates componentDidUpdate, the first HOC’s functionality will be overridden! This HOC also won’t work with function components, which do not have lifecycle methods.

\n

Mutating HOCs are a leaky abstraction—the consumer must know how they are implemented in order to avoid conflicts with other HOCs.

\n

Instead of mutation, HOCs should use composition, by wrapping the input component in a container component:

\n
function logProps(WrappedComponent) {\n  return class extends React.Component {\n    componentDidUpdate(prevProps) {\n      console.log('Current props: ', this.props);\n      console.log('Previous props: ', prevProps);\n    }\n    render() {\n      // Wraps the input component in a container, without mutating it. Good!\n      return <WrappedComponent {...this.props} />;\n    }\n  }\n}
\n

This HOC has the same functionality as the mutating version while avoiding the potential for clashes. It works equally well with class and function components. And because it’s a pure function, it’s composable with other HOCs, or even with itself.

\n

You may have noticed similarities between HOCs and a pattern called container components. Container components are part of a strategy of separating responsibility between high-level and low-level concerns. Containers manage things like subscriptions and state, and pass props to components that handle things like rendering UI. HOCs use containers as part of their implementation. You can think of HOCs as parameterized container component definitions.

\n

Convention: Pass Unrelated Props Through to the Wrapped Component

\n

HOCs add features to a component. They shouldn’t drastically alter its contract. It’s expected that the component returned from a HOC has a similar interface to the wrapped component.

\n

HOCs should pass through props that are unrelated to its specific concern. Most HOCs contain a render method that looks something like this:

\n
render() {\n  // Filter out extra props that are specific to this HOC and shouldn't be\n  // passed through\n  const { extraProp, ...passThroughProps } = this.props;\n\n  // Inject props into the wrapped component. These are usually state values or\n  // instance methods.\n  const injectedProp = someStateOrInstanceMethod;\n\n  // Pass props to wrapped component\n  return (\n    <WrappedComponent\n      injectedProp={injectedProp}\n      {...passThroughProps}\n    />\n  );\n}
\n

This convention helps ensure that HOCs are as flexible and reusable as possible.

\n

Convention: Maximizing Composability

\n

Not all HOCs look the same. Sometimes they accept only a single argument, the wrapped component:

\n
const NavbarWithRouter = withRouter(Navbar);
\n

Usually, HOCs accept additional arguments. In this example from Relay, a config object is used to specify a component’s data dependencies:

\n
const CommentWithRelay = Relay.createContainer(Comment, config);
\n

The most common signature for HOCs looks like this:

\n
// React Redux's `connect`\nconst ConnectedComment = connect(commentSelector, commentActions)(CommentList);
\n

What?! If you break it apart, it’s easier to see what’s going on.

\n
// connect is a function that returns another function\nconst enhance = connect(commentListSelector, commentListActions);\n// The returned function is a HOC, which returns a component that is connected\n// to the Redux store\nconst ConnectedComment = enhance(CommentList);
\n

In other words, connect is a higher-order function that returns a higher-order component!

\n

This form may seem confusing or unnecessary, but it has a useful property. Single-argument HOCs like the one returned by the connect function have the signature Component => Component. Functions whose output type is the same as its input type are really easy to compose together.

\n
// Instead of doing this...\nconst EnhancedComponent = withRouter(connect(commentSelector)(WrappedComponent))\n\n// ... you can use a function composition utility\n// compose(f, g, h) is the same as (...args) => f(g(h(...args)))\nconst enhance = compose(\n  // These are both single-argument HOCs\n  withRouter,\n  connect(commentSelector)\n)\nconst EnhancedComponent = enhance(WrappedComponent)
\n

(This same property also allows connect and other enhancer-style HOCs to be used as decorators, an experimental JavaScript proposal.)

\n

The compose utility function is provided by many third-party libraries including lodash (as lodash.flowRight), Redux, and Ramda.

\n

Convention: Wrap the Display Name for Easy Debugging

\n

The container components created by HOCs show up in the React Developer Tools like any other component. To ease debugging, choose a display name that communicates that it’s the result of a HOC.

\n

The most common technique is to wrap the display name of the wrapped component. So if your higher-order component is named withSubscription, and the wrapped component’s display name is CommentList, use the display name WithSubscription(CommentList):

\n
function withSubscription(WrappedComponent) {\n  class WithSubscription extends React.Component {/* ... */}\n  WithSubscription.displayName = `WithSubscription(${getDisplayName(WrappedComponent)})`;\n  return WithSubscription;\n}\n\nfunction getDisplayName(WrappedComponent) {\n  return WrappedComponent.displayName || WrappedComponent.name || 'Component';\n}
\n

Caveats

\n

Higher-order components come with a few caveats that aren’t immediately obvious if you’re new to React.

\n

Don’t Use HOCs Inside the render Method

\n

React’s diffing algorithm (called Reconciliation) uses component identity to determine whether it should update the existing subtree or throw it away and mount a new one. If the component returned from render is identical (===) to the component from the previous render, React recursively updates the subtree by diffing it with the new one. If they’re not equal, the previous subtree is unmounted completely.

\n

Normally, you shouldn’t need to think about this. But it matters for HOCs because it means you can’t apply a HOC to a component within the render method of a component:

\n
render() {\n  // A new version of EnhancedComponent is created on every render\n  // EnhancedComponent1 !== EnhancedComponent2\n  const EnhancedComponent = enhance(MyComponent);\n  // That causes the entire subtree to unmount/remount each time!\n  return <EnhancedComponent />;\n}
\n

The problem here isn’t just about performance — remounting a component causes the state of that component and all of its children to be lost.

\n

Instead, apply HOCs outside the component definition so that the resulting component is created only once. Then, its identity will be consistent across renders. This is usually what you want, anyway.

\n

In those rare cases where you need to apply a HOC dynamically, you can also do it inside a component’s lifecycle methods or its constructor.

\n

Static Methods Must Be Copied Over

\n

Sometimes it’s useful to define a static method on a React component. For example, Relay containers expose a static method getFragment to facilitate the composition of GraphQL fragments.

\n

When you apply a HOC to a component, though, the original component is wrapped with a container component. That means the new component does not have any of the static methods of the original component.

\n
// Define a static method\nWrappedComponent.staticMethod = function() {/*...*/}\n// Now apply a HOC\nconst EnhancedComponent = enhance(WrappedComponent);\n\n// The enhanced component has no static method\ntypeof EnhancedComponent.staticMethod === 'undefined' // true
\n

To solve this, you could copy the methods onto the container before returning it:

\n
function enhance(WrappedComponent) {\n  class Enhance extends React.Component {/*...*/}\n  // Must know exactly which method(s) to copy :(\n  Enhance.staticMethod = WrappedComponent.staticMethod;\n  return Enhance;\n}
\n

However, this requires you to know exactly which methods need to be copied. You can use hoist-non-react-statics to automatically copy all non-React static methods:

\n
import hoistNonReactStatic from 'hoist-non-react-statics';\nfunction enhance(WrappedComponent) {\n  class Enhance extends React.Component {/*...*/}\n  hoistNonReactStatic(Enhance, WrappedComponent);\n  return Enhance;\n}
\n

Another possible solution is to export the static method separately from the component itself.

\n
// Instead of...\nMyComponent.someFunction = someFunction;\nexport default MyComponent;\n\n// ...export the method separately...\nexport { someFunction };\n\n// ...and in the consuming module, import both\nimport MyComponent, { someFunction } from './MyComponent.js';
\n

Refs Aren’t Passed Through

\n

While the convention for higher-order components is to pass through all props to the wrapped component, this does not work for refs. That’s because ref is not really a prop — like key, it’s handled specially by React. If you add a ref to an element whose component is the result of a HOC, the ref refers to an instance of the outermost container component, not the wrapped component.

\n

The solution for this problem is to use the React.forwardRef API (introduced with React 16.3). Learn more about it in the forwarding refs section.

","frontmatter":{"title":"Higher-Order Components","next":null,"prev":null},"fields":{"path":"content/docs/higher-order-components.md","slug":"docs/higher-order-components.html"}}},"pageContext":{"slug":"docs/higher-order-components.html"}},"staticQueryHashes":[]}