1.1.4 • Published 2 years ago

@poly-state/poly-state v1.1.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

poly-state

A boilerplate free state management library for your React, Next.js, Preact and SolidJS applications. Check out the documentation for quick start.

Open Source? Yes! License npm downloads npm

Installation

For the core library:

npm install @poly-state/poly-state

For React and Next.js:

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

For Preact:

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.

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.

Preview

create store

Examples

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.

License

This project is licensed under the MIT License.

1.1.1

2 years ago

1.1.0

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.0.0

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago

0.7.1

2 years ago

0.8.2

2 years ago

0.5.0

2 years ago

0.7.0

2 years ago

0.6.0

2 years ago

0.4.0

2 years ago

0.3.0

2 years ago

0.2.0

2 years ago

0.1.0

2 years ago