node package manager

redux-clazz

Redux-Clazz

https://img.shields.io/npm/v/redux-clazz.svg Build Status availabledownloads Average time to resolve an issue Percentage of issues still open

Connect ordinary classes to Redux.

Redux Clazz lets you connect any normal class to redux

Example, first you need to create the store with redux-clazz (You can follow the normal process here, just make sure you import createStore from redux-clazz, the other are optional and it is possible to just import them from redux directly)

import { createStore, applyMiddleware, compose } from 'redux-clazz'
import thunk from 'redux-thunk'
import reducers from './reducers'
 
const middleware = [
  thunk,
]
 
// Create Store 
const store = createStore(
  reducers,
  initialState,
  compose(
    applyMiddleware(...middleware),
  ),
)
 
return store
 

The class container:

import { connect } from 'redux-clazz'
import OrdinaryClass from './OrdinaryClass'
 
import * as Actions from './Actions'
import * as Selectors from './Selectors'
 
export const mapStateToProps = state => ({
  ordinaryProp: Selectors.getOrdinaryProp(state),
  ordinaryPropNoSelector: state.myReducer.ordinaryProp,
})
 
export default connect(mapStateToProps, { ...Actions })(OrdinaryClass)
 
// To create a singleton 
export default connect(mapStateToProps, { ...Actions }, true)(OrdinaryClass)
 

Finally, the class:

import ReduxClazz from 'redux-clazz'
 
export default class OrdinaryClass extends ReduxClazz {
  
  // All actions and props are available in here 
  props
  
  constructor(...props) {
    super(props)
  }
  
  clazzWillReceiveProps = (nextProps) => {
    // This function will get fired when the props linked in mapStateToProps get updated ed 
  }
  
}

Installation

$ npm install --save redux-clazz

Development

If you'd like to contribute to this project, all you need to do is clone this project and run:

$ npm install

You can use npm link to use your development version in your own project:

  • Go to redux-clazz directory and execute command npm link
  • Go to your project directory and execute command npm link redux-clazz

License

Internet Systems Consortium license

The MIT License (MIT)

Copyright (c) 2015 David Zukowski

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.

Collaboration

If you have questions or issues, please open an issue!