higher-order v0.1.0

Higher Order

A simple JavaScript utility for composing higher-order components.

Documentation

• Installation
• Usage
• Why
• License

Installation

$ npm i --save higher-order

Usage

Simple

Here's a simple example to get you started.

import React, { Component } from 'react';
import higherOrder from 'higher-order';
import SomeHigherOrderComponent from './path/to/some-higher-order-component';

class MyComponent extends Component {
  // ...
}

export default higherOrder(MyComponent)(SomeHigherOrderComponent);

Ordering higher-order components

There are times where the order in which you compose your higher-over components matters. Higher Order composes your higher-order components in the reversed order that they are provided.

import React, { Component } from 'react';
import higherOrder from 'higher-order';
import {
  FirstHigherOrder,
  SecondHigherOrder,
  ThirdHigherOrder
} from './path/to/higher-order-components';

class MyComponent extends Component {
  // ...
}

export default higherOrder(MyComponent)(
  FirstHigherOrder,
  SecondHigherOrder,
  ThirdHigherOrder
);

This export translates to:

export default FirstHigherOrder(
  SecondHigherOrder(
    ThirdHigherOrderComponent(MyComponent)
  )
);

Redux

Higher Order and Redux play nicely together too.

import React, { Component } from 'react';
import { connect } from 'react-redux';
import higherOrder from 'higher-order';
import SomeHigherOrderComponent from './path/to/some-higher-order-component';
import { mapStateToProps } from 'path/to/helpers';

class MyApp extends Component {
  // ...
}

export default higherOrder(MyApp)(
  connect(mapStateToProps),
  SomeHigherOrderComponent
);

Why

If you've ever composed multiple Higher-order components then you've probably found yourself deeply nesting — I like to call this The Higher Order Pyramid of Doom.

export default FirstHigherOrder(
  SecondHigherOrder(
    ThirdHigherOrderComponent(MyComponent)
  )
);

Higher Order solves this by providing more readable interface for higher-order component compositions.

License

The MIT License (MIT)

Copyright (c) 2016, Naoufal Kadhom

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.