@loll/state v0.1.1

@loll/state

Library agnostic state management.

Install

npm i @loll/state --save

Creating a Store

Create new stores by passing an initial state object to createStore:

import createStore from '@loll/state'

const store = createStore({
  count: 0
})

Actions

Create actions that mutate state using store.setState:

function inc () {
  store.setState(state => ({ count: state.count + 1 }))
}

Components

Attach state to components using the connect export from ./store.js. Import actions to mutate state:

/** @jsx h */
import h from '@loll/h'

const MyComponent = store.connect(state => ({
  count: state.count
}))((props) => {
  return (
    <div>
      <h1>The count is {props.count}</h1>

      <button onclick={inc}>Up</button>
    </div>
  )
})

Rendering

The store returns emitter methods. When setState is called, a shallow-compare checks the state object for differences. If one is found, an update event is emitted.

store.on('update', () => {
  // re-render application here
})

API

setState

Accepts an object or a function that returns an object.

setState({
  count: 12
})

// or

setState(state => ({
  count: state.count + 1
}))

getState

Returns the full state object.

getState() // { count: 12 }

connect

Accepts an function that returns a slice of state and returns a function that in turn accepts a component.

const Component = connect(state => ({
  number: state.count
}))((props) => {
  return <h1>The count is {props.count}</h1>
})

on & off

The store uses mitt interally to emit a single update event when the state is updated. It also exposes mitt's off handler, should you need it.

function render () {}

on('update', render)

off('update', render)

MIT