Giter Site home page Giter Site logo

ship-components-subscribe's Introduction

ship-components-subscribe

Higher order React component to subscribe to a store

npm coverage Build Status dependencies devDependencies

Basic Usage

// @file ReactComponentSubscribed.js
import ReactComponent from './ReactComponent';
import Store from 'stores/Store';
import Actions from 'actions/Actions';
import subscription from 'ship-components-subscribe';

/**
 * Returns a Component that listens to a store
 * @return    {React.Component}
 */
export default subscription({
  WrappedComponent: ReactComponent,
  Store,
  selectData: store => store.getState(),
  callAction: () => Actions.read(),
  interval: 30000
});

The following component isn't directly used since we're wrapping using the higher order component above. Since we don't need to listen to the store we can use a pure function here.

// @file ReactComponent.js
import React from 'react';

export default function ReactComponent(props) {
  const {
    data // This is managed by the subscribe component and is the result of `selectData`
  } = this.props;
  return (
    <div>
      {data}
    </div>
  )
}

Once we've wrapped a component we then import the wrapped component.

// @file ExampleView.js
import React from 'react';

// NOTE we're importing the subscribed component here
import ReactComponent from './ReactComponentSubscribed.js';

export function ExampleView(props) {
  return (
    <ReactComponent />
  )
}

Tests

  1. npm install
  2. npm test

History

  • 0.2.0 - Added loading state
  • 0.1.1 - Moved to src folder like other ship-components
  • 0.1.0 - Initial

License

The MIT License (MIT)

Copyright (c) SHIP

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.

ship-components-subscribe's People

Contributors

isuttell avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.