Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poly-state/poly-state
A boilerplate free simple state management library
https://github.com/poly-state/poly-state
hacktoberfest poly-state react redux state state-management
Last synced: 26 days ago
JSON representation
A boilerplate free simple state management library
- Host: GitHub
- URL: https://github.com/poly-state/poly-state
- Owner: poly-state
- License: mit
- Created: 2021-12-12T17:52:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T10:42:16.000Z (8 months ago)
- Last Synced: 2024-10-09T17:29:44.104Z (29 days ago)
- Topics: hacktoberfest, poly-state, react, redux, state, state-management
- Language: TypeScript
- Homepage: https://poly-state.github.io
- Size: 32.9 MB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# poly-state
A boilerplate free state management library for your React, Next.js, Preact and SolidJS applications. Check out the [**documentation**](https://poly-state.github.io) for quick start.
[](https://github.com/poly-state/poly-state/issues)
[](https://github.com/poly-state/poly-state/blob/master/LICENSE)
## Installation
For the core library:
```bash
npm install @poly-state/core
```
For React and Next.js:
```bash
npm install @poly-state/core @poly-state/react
```
For Preact:
```bash
npm install @poly-state/core @poly-state/preact
```
For more installation details, see the [**instructions**](https://poly-state.github.io/docs/installation).
## Features
- Boilerplate free API
- No reducers and actions
- No context provider
- Lightweight
- Fully typed and should work fine with javascript projects as well
- Ability to extend store functionality by extending the store class and adding your own methods.
- Equality Checks to prevent unnecessary re-renders
- SSR support
## Documentation
Documentation for poly-state is located at **https://poly-state.github.io**.
- [**Installation**](https://poly-state.github.io/docs/installation)
- [**React**](https://poly-state.github.io/docs/react-quick-start)
- [**SSR with Next.js**](https://poly-state.github.io/docs/nextjs-ssr)
- [**Preact**](https://poly-state.github.io/docs/preact)
- [**Advanced Uses**](https://poly-state.github.io/docs/advanced-uses)
- [**API Reference**](https://poly-state.github.io/docs/api-reference)
- [**Middleware**](https://poly-state.github.io/docs/advanced-uses#middleware)
## Examples
```jsx
import { createStore } from '@poly-state/core';
import { useStore } from '@poly-state/react'; // React & Next.js only
// import { useStore } from '@poly-state/preact'; // Preact only
// Create your own store
const counterStore = createStore({ count: 0 });
const useCounterStore = () => useStore(counterStore);
// Your React / Next.js / Preact component
export const MyCounter = () => {
const { count } = useCounterStore();
return (
{count}
counterStore.setCount(prev => prev - 1)}>Decrement
counterStore.setCount(prev => prev + 1)}>Increment
);
};
```
## Supported platforms
- React/Next.js
- npm: `npm install @poly-state/react`
- yarn: `yarn add @poly-state/react`
- Preact
- npm: `npm install @poly-state/preact`
- yarn: `yarn add @poly-state/preact`
> It is also possible to use this library in other frontend frameworks/libraries, we plan on adding support for Svelte, Vue, Angular in the near future.
## Contributing
Issues and pull requests of all sorts are welcome!
> More Documentation and Advanced usage examples can be found in the [**documentation**](https://poly-state.github.io).
## License
This project is licensed under the [MIT License](https://github.com/poly-state/poly-state/blob/master/LICENSE).