declarative-events v0.2.0
declarative-events
Action creators for redux-effects-events
Installation
$ npm install declarative-events
Usage
Functions
handle(name, cb)
- Dispatch the action returned bycb
in response to thename
event. Returns anid
(to the handler it is composed with) that can be used to unbind it.handleOnce(name, cb)
- Same ashandle
, except the handler is immediately unbound after the first time it is calledunhandle(name, id)
- Unbind the handler ofname
specified byid
.
Events
This list is by no means comprehensive, it's just representative of stuff I happened to think of / need at the moment. Feel free to send PR's or make your own middleware/creators for other events.
resize
scroll
popstate
unload
load
beforeunload
DOMContentLoaded
Example
Initializing on DOMContentLoaded
import {handleOnce} from 'declarative-events'
import {createAction} from 'redux-actions'
const appReady = createAction('APP_READY')
function initializeApp () {
return handleOnce('DOMContentLoaded', appReady)
}
Handling resize
import {handle, unhandle} from 'declarative-events'
import {createAction} from 'redux-actions'
import bind from 'bind-effect'
function bindWindowSize () {
return bind(handle('resize', windowDidResize), boundResizeListener)
}
function unbindWindowSize (id) {
return unhandle('resize', id)
}
const windowDidResize = createAction('WINDOW_DID_RESIZE')
const boundResizeListener = createAction('BOUND_RESIZE_LISTENER')
// ... In your state reducers ...
function reduce (state, action) {
if (action.type === 'WINDOW_DID_RESIZE') {
const wnd = action.payload.currentTarget
state = {...state, wndDims: {width: wnd.innerWidth, height: wnd.innerHeight}}
} else if (action.type === 'BOUND_RESIZE_LISTENER') {
state = {...state, listeners: {...state.listeners, resize: action.payload}}
}
return state
}
License
The MIT License
Copyright © 2015, Weo.io <info@weo.io>
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.