@poly-state/core v1.4.0

poly-state

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

Installation

For the core library:

npm install @poly-state/core

For React and Next.js:

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

For Preact:

npm install @poly-state/core @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.

• Installation
• React
• SSR with Next.js
• Preact
• Advanced Uses
• API Reference
• Middleware

Examples

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

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.

License

This project is licensed under the MIT License.