# @poly-state/poly-state

> A boilerplate free simple state management library

Latest version **1.1.4** (published 2022-03-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @poly-state/poly-state
pnpm add @poly-state/poly-state
yarn add @poly-state/poly-state
bun add @poly-state/poly-state
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2022-03-06 |
| First published | 2021-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Shahriar Shojib |
| Maintainers | shahriar-shojib |

## Links

- npm: https://www.npmjs.com/package/@poly-state/poly-state
- Repository: https://github.com/poly-state/poly-state
- Issues: https://github.com/poly-state/poly-state/issues
- npm.io page: https://npm.io/package/@poly-state/poly-state

## Recent versions

- 1.1.4 (latest) — 2022-03-06
- 1.1.3 — 2022-03-03
- 1.1.2 — 2022-02-27
- 1.1.1 — 2022-02-27
- 1.1.0 — 2022-02-26
- 1.0.0 — 2022-02-21
- 0.8.2 — 2022-01-18
- 0.8.1 — 2022-01-18
- 0.8.0 — 2022-01-18
- 0.7.1 — 2022-01-18
- 0.7.0 — 2022-01-18
- 0.6.0 — 2022-01-18
- 0.5.0 — 2022-01-09
- 0.4.0 — 2021-12-15
- 0.3.0 — 2021-12-15
- … 2 more at https://npm.io/package/@poly-state/poly-state/versions

## 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.

[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/poly-state/poly-state/issues)
[![License](https://badgen.net/badge/License/MIT/blue)](https://github.com/poly-state/poly-state/blob/master/LICENSE)
![npm downloads](https://img.shields.io/npm/dm/@poly-state/poly-state)
![npm](https://img.shields.io/npm/v/@poly-state/poly-state)

## Installation

For the core library:

```bash
npm install @poly-state/poly-state
```

For React and Next.js:

```bash
npm install @poly-state/poly-state @poly-state/react
```

For Preact:

```bash
npm install @poly-state/poly-state @poly-state/preact
```

You can also install the library with `yarn add @poly-state/poly-state`, `yarn add @poly-state/react` and `yarn add @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)

## Preview

![create store](https://github.com/poly-state/poly-state.github.io/raw/master/static/preview.gif)

## Examples

```typescript
import { createStore } from '@poly-state/poly-state';
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 (
		<div>
			<h1>{count}</h1>
			<button onClick={() => counterStore.setCount((prev) => prev - 1)}>Decrement</button>
			<button onClick={() => counterStore.setCount((prev) => prev + 1)}>Increment</button>
		</div>
	);
};
```

## 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`
- SolidJS (experimental)

> 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!

I am actively looking for contributors/maintainers for this project, if you're interested please reach out to me on LinkedIn/Email

> 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).

---
_Source: https://npm.io/package/@poly-state/poly-state · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._