@4geit/rct-todo-store

todo store

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@4geit/rct-todo-store
Minified + gzip package size for @4geit/rct-todo-store in KB

Readme

@4geit/rct-todo-store npm version


todo store

Demo

A live storybook is available to see how the store looks like @ http://react-packages.ws3.4ge.it

Installation

  1. A recommended way to install @4geit/rct-todo-store is through npm package manager using the following command:
npm i @4geit/rct-todo-store --save

Or use yarn using the following command:

yarn add @4geit/rct-todo-store
  1. Depending on where you want to use the store you will need to import the class instance todoStore or inject it to your project JS file.

If you are willing to use it within a component, then you must use the inject decorator provided by mobx-react library.

For instance if you want to use this store in your App.js component, you can use the RctTodoStore store in the JSX code as follows:

import React, { Component } from 'react'
import { inject } from 'mobx-react'
// ...
@inject('todoStore')
class App extends Component {
  handleClick() {
    this.props.todoStore.setVar1('dummy value')
  }

  render() {
    return (
      <div className="App">
        <button onClick={ this.handleClick.bind(this) } >Click here</button>
      </div>
    )
  }
}

If you are willing to use the class instance inside another store class, then you can just import the instance as follows:

import todoStore from '@4geit/rct-todo-store'

class DummyStore {
  @action doSomething() {
    todoStore.setVar1('dummy value')
  }
}
  1. If you want to use the store class in the storybook, add todoStore within stories/index.js by first importing it:
import todoStore from '@4geit/rct-todo-store'

and then within the stores array variable add todoStore at the end of the list.

  1. If you want to use the store class in your project, add todoStore within src/index.js by first importing it:
import todoStore from '@4geit/rct-todo-store'

and then within the stores array variable add todoStore at the end of the list.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.