React Utility

GitHub | NPM | Doc's

Installation

$ npm install @biruni/react

$ yarn add @biruni/react

$ pnpm add @biruni/react

Usage As Hook

1. Import

import { useStore } from '@biruni/react';

2. Use

const MyComponent = () => {
	const store = useStore(MyStore);
};

Use As Props Mapper

1. Import

import { withStore, type WithStore } from '@biruni/react';

2. Define

update Props from:

type Props = {
	myPropKey: string;
};

to:

type Props = WithStore<
	typeof MyStore,
	{
		myPropKey: string;
	}
>;

3. Wrap

const NewMyComponent = withStore(MyStore, MyComponent);

IMPORTANT

The mapped props will be read-only props and Immutable