Nanotechnology Promises Much
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@anew/provider

2.2.2 • Public • Published

@anew/provider

A small util for providing and connecting store to application.

🔥🔥🔥  For Hooks see the @anew/hooks package 🔥🔥🔥

Table of Contents

Installation

To install anew directly into your project run:

npm i @anew/provider -S

for yarn users, run:

yarn add @anew/provider

Usage

import React from 'react'
import Store from '@anew/store'
import Provider from '@anew/provider'
import Router from '@anew/router'
 
class App extends React.Component {
  static mapStateToProps = ({ state, getters }) => ({
    count: state.count
  })
 
  static mapDispatchToProps = ({ actions, reducers }) => ({
    inc: actions.inc
  })
 
  render() {
    // Access Connected Props
    const { count, inc } = this.props
 
    return (
      <center>
        <span>{count}</span>
        <hr />
        <button onClick={inc}>INC</button>
      </center>
    )
  }
}
 
// Connect App to Store
const ConnectedApp = Provider.connect(App)
 
// Create App Core Store
// See @anew/store for more on Store
const AppStore = new Store({
  name: 'core',
 
  state: {
    count: 1
  },
 
  reducers: {
    inc: state => ({
      count: state.count + 1
    })
  },
 
  getters: {
    countDoubled: state => state.count * 2
  }
})
 
// Share AnewStore with entire App
Provider.use(AppStore)
 
// Mount wrapped App to DOM
ReactDOM.render(Provider.wrap(ConnectedApp), document.getElementById('root'))

Parameters

Provider.wrap((Component: ReactComponent), {
  Provider: ReactComponent
})

Component: Entry react component to Application.

Provider (Optional): A react provider that get passed the store as a prop.

The wrap method returns the Component wrapped around the provider with the configured store. This could be used with any component that you want to access some store. Most often, this method is used to provide the application's root store to the entire application. Note, you should not pass the id parameter to wrap a sub component from the appliation as that attempts to mount the component to the DOM at the provided element id.

import Provider, { AnewProvider } from '@anew/provider'
 
class TodoComponent extends React.Component {...}
 
const TodoProvider = new AnewProvider(todoStore)
 
// Alternative to above
const TodoProvider = new AnewProvider()
TodoProvider.use(todoStore)
 
// @return
//
// <Provider store={todoStore}>
//     <TodoComponent />
// </Provider>
TodoProvider.wrap(TodoComponent)
Provider.connect(Component)
 
// or
// you may extract the connect methods
// from the Component class and pass
// it directly to Provider.connect({...})
Provider.connect(Config)(Component)

The connect method is not different fromt the react-redux's connect method except that it passes an addition parameter to mapStateToProps which is the provided store's getState method for accessing anew's store selectors.

Provider.use(StoreObject)

An anew or redux store object. See redux provider for more information.

Install

npm i @anew/provider

DownloadsWeekly Downloads

26

Version

2.2.2

License

MIT

Unpacked Size

48.4 kB

Total Files

27

Last publish

Collaborators

  • avatar