react-pipe-effects

React distributed state management solution with rxjs.

Usage

import React from 'react'
import ReactDOM from 'react-dom'
import { effectable, declareActions, createEffects } from 'react-pipe-effects'
 
const App = effectable(
  class App extends React.Component {
    state = {
      text: ''
    }
 
    getText = () => this.state.text
 
    setText = text => {
      this.setState({
        text
      })
    }
 
    actions = this.props.handshakeActions({
      getText: this.getText,
      setText: this.setText
    })
 
    render() {
      return (
        <div className="sample">
          <div className="text">{this.state.text}</div>
          <button className="inner-btn" {...this.props.createEvents('onClick')}>
            button
          </button>
        </div>
      )
    }
  }
)
 
 
const actions = declareActions('setText')
const effects = createEffects($ => {
  $('onClick').subscribe(() => {
    actions.setText('This is inner click')
  })
})
 
ReactDOM.render(
  <div>
    <App actions={actions} effects={effects} />
    <button
      className="outer-btn"
      onClick={() => {
        actions.setText('This is outer click')
      }}
    >
      button
    </button>
  </div>
)

API

1. effectable(options : Object | ReactComponent) : (Target : ReactComponent)=>ReactComponent

The effectable's options

The target component will receive the following properties.

2. declareActions(...type : String) : Object

It is used for batch declaration of state actions.

3. createEffects(callback : (\$ : (type : String, filter : Function)=>Observable)=>{}) : Function

It is used to create a side-effect execution environment.

4. usePipeEffects({declaredActions:Object,effects:Function})

It will return the following methods.

USECASE

import { usePipeEffects } from 'react-pipe-effects'
 
const App = props => {
  const [state, setState] = useState({ text: '' })
  const { handshakeActions, createEvents } = usePipeEffects(props)
  const actions = handshakeActions({
    getText: () => state.text,
    setText: text => setState({ text })
  })
  return (
    <div className="sample">
      <div className="text">{state.text}</div>
      <button className="inner-btn" {...createEvents('onClick')}>
        button
      </button>
    </div>
  )
}

Install

npm install --save react-pipe-effects

LICENSE

The MIT License (MIT)

Copyright (c) 2018 JanryWang

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.