use-common-state v2.0.2

use-common-state

Cross-component common state hook without context providers.

• Super-small. 490 bytes (minified and gzipped). No dependencies.
• Performance-friendly. Component renders only when required data is changed.
• Boilerplate-free. No wrappers, mappers, providers, subscribers, etc... Simple React State Hook without context.

Why?

Current implementations of the React state management seem to be overcomplicated and redundant for most of the regular web apps. A lot of boilerplate/configuration code need to be written before getting and updating common state. Thanks to the incredibly elegant useState() hook, the mechanism of synchronizing local component states can be significantly simplified and doesn't require any additional code outside the functional component. It also makes components more reusable across different applications since there are no additional requirements to the app architecture and no needs in the top context providers.

Install

npm install use-common-state

Usage

You can use common state hook inside your functional components without any additional wrappers nor setup:

import React from "react";
import useCommonState from "use-common-state";

export const FirstName = () => {
  const [firstName] = useCommonState("user.firstName");

  return <div>{firstName}</div>;
};

export const LastName = () => {
  const [lastName] = useCommonState("user.lastName");

  return <div>{lastName}</div>;
};

export const FirstNameInput = () => {
  const [firstName, setFirstName] = useCommonState("user.firstName");

  return <input 
    value={firstName} 
    placeholder="First name"
    onChange={e => setFirstName(e.target.value)} 
  />;
};

export const LastNameInput = () => {
  const [lastName, setLastName] = useCommonState("user.lastName");

  return <input 
    value={lastName} 
    placeholder="Last name"
    onChange={e => setLastName(e.target.value)} 
  />;
};

After that you can use these components at any place of your components tree without any top context providers.

It's highly recomended, but not mandatory, to specify the path to the common state property you need to render as an argument of useCommonState hook. In this case the component will be rerendered only when this specific property is updated (reference identity is used). The useCommonState hook returns an array of [value, setter] which is completely similar to the original React useState hook API. You can get get/set the common state properties in any component, no matter where it's placed in the components tree. See the full example here: https://codesandbox.io/s/use-common-state-1-p0gp6

It's also possible to update the common state outside the component, which is handy for global actions like fetching/initializing data:

import React from "react";
import { setCommonState } from "use-common-state";
import { FirstName, LastName, Input } from "../components";

const fetchUser = () => {
  setCommonState("isLoadingUser", true);
  ajax("path/to/user/api")
    .then(user => setCommonState({user}))
    .catch(err => setCommonState("userError", err))
    .finally(() => setCommonState("isLoadingUser", false));
};

function Page() {
  const [isLoadingUser = true] = useCommonState("isLoadingUser");
  const [userError] = useCommonState("userError");

  React.useEffect(() => {
    fetchUser();
  }, []);

  if (isLoadingUser) {
    return "Loading user..."
  }

  if (userError) {
    return userError.message
  }

  return (
    <>
      <FirstName />
      <LastName />
      <FirstNameInput />
      <LastNameInput />
    </>
  );
}

See the full example here: https://codesandbox.io/s/use-common-state-2-y8x46

Advanced usage

In complex web apps, when managing big data structures and working with different APIs you will likely think about splitting the monolithic common state into small independent parts. It could help you to avoid naming collisions, code conflicts, increase performance and share different common states as an independent modules. For this purposes you can use createCommonState factory function which returns the array of [useCommonStateHook, commonStateSetter]. The optional argument is initial common state value:

import React from "react";
import { createCommonState } from "use-common-state";
import { FirstName, LastName, FirstNameInput, LastNameInput } from "../components";

const [useUser, setUser] = createCommonState({
  isLoading: true,
  user: null,
  error: null
});

const fetchUser = () => {
  setUser("isLoading", true);
  ajax("path/to/user/api")
    .then(user => setUser({ user }))
    .catch(error => setUser("error", error))
    .finally(() => setUser("isLoading", false));
};

function Page() {
  const [isLoadingUser = true] = useUser("isLoading");
  const [userError] = useUser("error");

  React.useEffect(() => {
    fetchUser();
  }, []);

  if (isLoadingUser) {
    return "Loading user...";
  }

  if (userError) {
    return userError.message;
  }

  return (
    <>
      <FirstName />
      <LastName />
      <FirstNameInput />
      <LastNameInput />
    </>
  );
}

See full example here: https://codesandbox.io/s/use-common-state-3-55v7r