@frontless/redux
v1.0.0
Published
Redux store for frontless
Downloads
5
Maintainers
Readme
frontless-redux
Simple redux plugin for Frontless and Riot.JS
npm i @frontless/redux --save
Component settings
observe
- an array of property names.
A component re-renders only when specified properties are changed.
export default {
observe: ['number']
}
Properties
The plugin extends component's scope with following properties:
this.$store
- Redux store instancethis.$state
- The state
Hooks
onAction(data)
- fires whenever a redux action is dispatched
Plugin factory
Plugin factory accepts two positional arguments: store( Object<{state, actions}> , Function<Context> )
Second argument is a context resolver function it has to return any global object where Redux store instance should be kept, defaults to document.__GLOBAL
.
import store from '@frontles/redux'
const plugin = store({ state, actions,}, () => window)
Usage
// store.js
import store from '@frontles/redux'
import riot from 'riot'
const state = {
number: 0
}
const actions = {
INCREMENT: function(state, {value = 1}){
state.number += value
},
DECREMENT: function(state, {value = 1}){
state.number -= value
}
}
const plugin = store({ state, actions,}, () => window)
riot.install(plugin)
// component.riot
export default {
observe: ['number'],
plus(){
this.$store.dispatch({
type: 'INCREMENT',
value: 10
})
}
}