Recompose is a React utility belt for function components and higher-order components. Think of it like lodash for React.
- Full API documentation - Learn about each helper
- Recompose Base Fiddle - Easy way to dive in
npm install recompose --save
- recompose-relay — Recompose helpers for Relay
- rx-recompose — RxJS utilities for Recompose and React
Helpers like withState() and withReducer() provide a nicer way to express state updates:
const enhance = withState('counter', 'setCounter', 0)
const Counter = enhance(({ counter, setCounter }) =>
<div>
Count: {counter}
<button onClick={() => setCounter(n => n + 1)}>Increment</button>
<button onClick={() => setCounter(n => n - 1)}>Decrement</button>
</div>
)Or with a Redux-style reducer:
const counterReducer = (count, action) => {
switch (action.type) {
case INCREMENT:
return count + 1
case DECREMENT:
return count - 1
default:
return count
}
}
const enhance = withReducer('counter', 'dispatch', counterReducer, 0)
const Counter = enhance(({ counter, dispatch }) =>
<div>
Count: {counter}
<button onClick={() => dispatch({ type: INCREMENT })}>Increment</button>
<button onClick={() => dispatch({ type: DECREMENT })}>Decrement</button>
</div>
)Helpers like componentFromProp() and withContext() encapsulate common React patterns into a simple functional interface:
const enhance = defaultProps({ component: 'button' })
const Button = enhance(componentFromProp('component'))
<Button /> // renders <button>
<Button component={Link} /> // renders <Link />const provide = store => withContext(
{ store: PropTypes.object },
() => ({ store })
)
// Apply to base component
// Descendants of App have access to context.store
const AppWithContext = provide(store)(App)No need to write a new class just to implement shouldComponentUpdate(). Recompose helpers like pure() and onlyUpdateForKeys() do this for you:
// A component that is expensive to render
const ExpensiveComponent = ({ propA, propB }) => {...}
// Optimized version of same component, using shallow comparison of props
// Same effect as React's PureRenderMixin
const OptimizedComponent = pure(ExpensiveComponent)
// Even more optimized: only updates if specific prop keys have changed
const HyperOptimizedComponent = onlyUpdateForKeys(['propA', 'propB'])(ExpensiveComponent)Recompose helpers integrate really nicely with external libraries like Relay, Redux, and RxJS
const enhance = compose(
// This is a Recompose-friendly version of Relay.createContainer(), provided by recompose-relay
createContainer({
fragments: {
post: () => Relay.QL`
fragment on Post {
title,
content
}
`
}
}),
flattenProp('post')
)
const Post = enhance(({ title, content }) =>
<article>
<h1>{title}</h1>
<div>{content}</div>
</article>
)Many React libraries end up implementing the same utilities over and over again, like shallowEqual() and getDisplayName(). Recompose provides these utilities for you.
// Any Recompose module can be imported individually
import getDisplayName from 'recompose/getDisplayName'
ConnectedComponent.displayName = `connect(${getDisplayName(BaseComponent)})`
// Or, even better:
import wrapDisplayName from 'recompose/wrapDisplayName'
ConnectedComponent.displayName = wrapDisplayName(BaseComponent, 'connect')
import toClass from 'recompose/toClass'
// Converts a function component to a class component, e.g. so it can be given
// a ref. Returns class components as is.
const ClassComponent = toClass(FunctionComponent)Forget ES6 classes vs. createClass().
An idiomatic React application consists mostly of function components.
const Greeting = props =>
<p>
Hello, {props.name}!
</p>Function components have several key advantages:
- They help prevent abuse of the
setState()API, favoring props instead. - They encourage the "smart" vs. "dumb" component pattern.
- They encourage code that is more reusable and modular.
- They discourage giant, complicated components that do too many things.
- In the future, they will allow React to make performance optimizations by avoiding unnecessary checks and memory allocations.
(Note that although Recompose encourages the use of function components whenever possible, it works with normal React components as well.)
Most of the time when we talk about composition in React, we're talking about composition of components. For example, a <Blog> component may be composed of many <Post> components, which are composed of many <Comment> components.
Recompose focuses on another unit of composition: higher-order components (HoCs). HoCs are functions that accept a base component and return a new component with additional functionality. They can be used to abstract common tasks into reusable pieces.
Recompose provides a toolkit of helper functions for creating higher-order components.
All functions are available on the top-level export.
import { compose, mapProps, withState /* ... */ } from 'recompose'Recompose helpers are designed to be composable:
const BaseComponent = props => {...}
// This will work, but it's tedious
let EnhancedComponent = pure(BaseComponent)
EnhancedComponent = mapProps(/*...args*/)(EnhancedComponent)
EnhancedComponent = withState(/*...args*/)(EnhancedComponent)
// Do this instead
// Note that the order has reversed — props flow from top to bottom
const enhance = compose(
withState(/*...args*/),
mapProps(/*...args*/),
pure
)
const EnhancedComponent = enhance(BaseComponent)Technically, this also means you can use them as decorators (if that's your thing):
@withState(/*...args*/)
@mapProps(/*...args*/)
@pure
class Component extends React.Component {...}You can reduce your bundle size by only including the modules that you need.
All top-level exports can be imported individually:
import compose from 'recompose/compose'
import mapProps from 'recompose/mapProps'
import withState from 'recompose/withState'
// ... and so onThis is the recommended import pattern for library authors.
Project is still in the early stages. Please file an issue or submit a PR if you have suggestions! Or ping me (Andrew Clark) on Twitter.