Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yesmeck/mini-store
A minimal state store for React component.
https://github.com/yesmeck/mini-store
Last synced: 2 months ago
JSON representation
A minimal state store for React component.
- Host: GitHub
- URL: https://github.com/yesmeck/mini-store
- Owner: yesmeck
- Archived: true
- Created: 2017-10-21T04:13:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T07:36:53.000Z (about 3 years ago)
- Last Synced: 2024-05-19T13:41:49.702Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 53.7 KB
- Stars: 100
- Watchers: 7
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-star-libs - [yesmeck / mini-store
README
# mini-store
**Deprecated, see [use-context-selector](https://github.com/dai-shi/use-context-selector) for optimized state subscribtion**
[](https://travis-ci.org/yesmeck/mini-store)
A state store for React component.
## Motivation
When you want to share a component's state to another one, a commom pattern in React world is [lifting state up](https://reactjs.org/docs/lifting-state-up.html#lifting-state-up). But one problem of this pattern is performance, assume we have a component in following hierarchy:
```javascript
```
`ChildA` want to share state with `ChildB`, so you lifting `ChildA`'s state up to `Parent`. Now, when `ChildA`'s state changes, the whole `Parent` will rerender, includes `ChildC` which should not happen.
Redux do a good job at this situation throgh keeping all state in store, then component can subscribe state's changes, and only connected components will rerender. But `redux` + `react-redux` is overkill when you are writing a component library. So I wrote this little library, It's like Redux's store without "reducer" and "dispatch".
## Example
[See this demo online.](https://codesandbox.io/s/mq6223x08p)
```javascript
import { Provider, create, connect } from 'mini-store';
class Counter extends React.Component {
constructor(props) {
super(props);
this.store = create({
count: 0,
});
}
render() {
return (
)
}
}
@connect()
class Buttons extends React.Component {
handleClick = (step) => () => {
const { store } = this.props;
const { count } = store.getState();
store.setState({ count: count + step });
}
render() {
return (
+
-
);
}
}
@connect((state) => ({ count: state.count }))
class Result extends React.Component {
render() {
return (
{this.props.count}
);
};
}
```
## API
### `create(initialState)`
Creates a store that holds the state. `initialState` is plain object.
### ``
Makes the store available to the connect() calls in the component hierarchy below.
### `connect(mapStateToProps)`
Connects a React component to the store. It works like Redux's `connect`, but only accept `mapStateToProps`. The connected component also receive `store` as a prop, you can call `setState` directly on store.
## License
MIT