This package has been deprecated

Author message:

Package no longer supported. Please use "npm i use-react-singleton-state" instead.

use-singleton-react-state
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

use-singleton-react-state

A singleton version of React useState

GitHub GitHub package.json version npm GitHub file size in bytes

NPM

Motivation

Working in many React projects, I, sometimes, need to access or modify a certain state created by another component, without the need to put the state the parent of this 2 components to avoid rerendering ont on the setter component. Examples will be shown further.

Why not using React Context?

For a similar reason of not add the state on the top, to avoid rerendering on the setter component.

Let's have a look on the common use of context to understand more

const { setContextValue } = useContext(appContext);

It seems harmless, it only set the data in the context, and you're not even consuming the value, but in fact you are.

The object destruction you're using for convention is simply consuming the context, and only using the setter property.

const context = useContext(appContext); // { contextValue, setContextValue }
const { setContextValue } = context;

Use cases

Let's say you have table, its filters and params, but at a specific occasion, you need to reset these filters.

Say your profile has multiple characters:

  • Your first one has multiple pages in the table and you decided to switch character on page 2 from the header
  • Your second character doesn't have much data to show int he table, only for the page 1, yet the request to the server was sent with page 2, so it returns nothing.

What you need here is to be able to reset the filters from the header component without the need to rerender the header component or any sibling.

How to use

Say you have your custom hook useFilers.ts, basically you use it in the ListFilter.tsx and want to manipulate it as well from Header.tsx

// useFilters.ts
import SingletonReactState from "use-singleton-react-state";

const {
  createSingletonStateHook,
  updateSingletonState: updateSingletonFilters,
  singletonState: filtersSingletonState,
} = SingletonReactState();

function useFilters<T>(
  initialValue: Partial<T>
): [T, (newFilters: Partial<T>) => void] {
  ...
}

export default createSingletonStateHook<typeof useFilters, true>(useFilters);
export { filtersSingletonState, updateSingletonFilters };
// ListFilter.tsx
...
const [filters, updateFilters] = useFilters({ page: 1 });
...
// Header.tsx
import { updateSingletonFilters } from "hooks/useFilters"

const Header = () => {
  ...

  <button onClick={() => updateSingletonFilters({ page: 1 })}>Reset Filter</button>
  ...
}

With this implementation filtersSingletonState will change with each file calling useFilters.

That means that updateSingletonFilters can be called from within other components to manipulate the state.

Api for createSingletonStateHook

Param Type Description
<T> Type The typeof your custom hook
hooks Argument The custom hook

Package Sidebar

Install

npm i use-singleton-react-state

Weekly Downloads

1

Version

1.2.0

License

MIT

Unpacked Size

14.7 kB

Total Files

8

Last publish

Collaborators

  • andrew-lawendy