react-anonymous

Rules of hooks made less painful. Use hooks anywhere in your render tree by rendering an Anonymous component.

See the example below for some use cases where this might be helpful:

import * as React from "react";
import Anonymous from "@lewisl9029/react-anonymous";

const Example = ({ colors }) => {
  const [isOpen, setIsOpen] = React.useState(false);

  return (
    <div>
      {isOpen
        ? // Ever wanted to call a hook within a branching path?
          <Anonymous key="true">
            {() => (
              <Modal
                close={React.useCallback(() => setIsOpen(false), [setIsOpen])}
              >
                <ul>
                  {colors.map((color) =>
                    // Or within a mapping function?
                    <Anonymous key={color}>
                      {() => (
                        <li style={useMemo(() => ({ color }), [color])}>{color}</li>
                      )}
                    </Anonymous>
                  )}
                </ul>
              </Modal>
            )}
          </Anonymous>
        : null}
    </div>
  );
};

Motivation

I documented the motivation and use cases in much more detail in the following RFC: reactjs/rfcs#197

Unfortunately it was declined, but I hope if we eventually demonstrate enough demand in userland, the React team could start reconsidering this and other solutions to the poor usage ergonomics caused by rules of hooks.

By now I'm sure we're all deeply familiar with the infamous Rules of Hooks:

Don’t call Hooks inside loops, conditions, or nested functions.

https://reactjs.org/docs/hooks-rules.html#only-call-hooks-at-the-top-level

Often, to adhere to these rules, we end up adding extra layers of indirection into our render function in the form of components whose sole purpose is to act as a container for hook calls.

Consider the case of a simple Modal component that accepts a close function, where we would like to memoize the close function using useCallback.

We may want to write code that looks like this:

const Example = () => {
  const [isOpen, setIsOpen] = React.useState(false);

  return (
    <div>
      {isOpen ? (
        // This violates the rule of hooks on branching
        <Modal close={React.useCallback(() => setIsOpen(false), [setIsOpen])}>
          Blah
        </Modal>
      ) : null}
    </div>
  );
};

But due to the rule of hooks on branching, we're instead forced to write code that looks like this:

const ModalWrapper = ({ setIsOpen }) => (
  <Modal close={React.useCallback(() => setIsOpen(false), [setIsOpen])}>
    Blah
  </Modal>
);

const Example = () => {
  const [isOpen, setIsOpen] = React.useState(false);

  return <div>{isOpen ? <ModalWrapper setIsOpen={setIsOpen} /> : null}</div>;
};

So we're forced to add an extra layer of indirection to what used to be a simple, self-contained render function, in addition to being forced to write a bunch of boilerplate for creating the new component and drilling in all the necessary props (TypeScript users will feel double the pain here as they'd have to duplicate type declarations for the drilled-in props as well).

Some readers may point out that they prefer the latter version to the earlier one, as they might feel encapsulating everything in that branch into a ModalWrapper component reduces noise and improves readability, i.e. that it's a useful layer of indirection.

That's a perfectly valid position to take, but I'd like to remind those readers that the decision on whether or not to add any layer of indirection should reflect a value judgement on whether or not we feel the indirection is actually useful (inherently subjective and should be made on case-by-case basis), not forced upon us by some arbitrary implementation detail of the library we're using.

This is where react-anonymous comes in.

Installation

npm i @lewisl9029/react-anonymous

or

yarn add @lewisl9029/react-anonymous

Usage

import * as React from "react";
import Anonymous from "@lewisl9029/react-anonymous";

const Example = () => {
  const [isOpen, setIsOpen] = React.useState(false);

  return (
    <div>
      {isOpen
        ? // call anonymous anywhere in the tree, without introducing a separate named component
          <Anonymous key="true">
            {() => (
              <Modal
                close={React.useCallback(() => setIsOpen(false), [setIsOpen])}
              >
                Blah
              </Modal>
            )}
          </Anonymous>
        : null}
    </div>
  );
};

The Anonymous component from react-anonymous acts as a component boundary for all of your hook calls. You can add it anywhere inside the render tree to call hooks in a way that would otherwise have violated the rules of hooks, without adding any additional layers of indirection.

The key prop is used to distinguish different branches in cases like the following:

isOpen
  ?
    <Anonymous key="true">
      {() => {
        const [state] = useState('open')
        return state
      }}
    </Anonymous>
  : 
    <Anonymous key="false">
      {() => {
        const [state] = useState('closed')
        return state
      }}
    </Anonymous>

Without the key, when isOpen changes between renders, React would assume that the same component is being rendered and share the same set of hook calls & state between the two branches. It's not strictly necessary in the original example where we don't render a separate branch, but we recommend providing it anyways in case an alternate branch with an Anonymous component is added later. We enforce this if you use TypeScript.

Note that the Anonymous component also works great for looping:

import * as React from "react";
import Anonymous from "@lewisl9029/react-anonymous";

const Example = ({ colors }) => {
  return (
    <ul>
      {colors.map((color) =>
        <Anonymous key={color}>
          {() => (
            <li style={useMemo(() => ({ color }), [color])}>{color}</li>
          )}
        </Anonymous>
      )}
    </ul>
  );
};

However, keep in mind that you still have to obey the rules of hooks within the Anonymous component's render function:

import * as React from "react";
import Anonymous from "@lewisl9029/react-anonymous";

const Example = ({ colors }) => {
  const [isOpen, setIsOpen] = React.useState(false);

  return (
    <div>
      {isOpen
        ? 
          <Anonymous key="true">
            {() => (
              <Modal
                close={React.useCallback(() => setIsOpen(false), [setIsOpen])}
              >
                <ul>
                  {colors.map((color) => (
                    // This still violates the rule of hooks on looping
                    <li style={useMemo(() => ({ color }), [color])}>{color}</li>
                  ))}
                </ul>
              </Modal>
            )}
          </Anonymous>
        : null}
    </div>
  );
};

We can, however, nest additional layers of Anonymous components to arbitrary depths to work around this:

import * as React from "react";
import Anonymous from "@lewisl9029/react-anonymous";

const Example = ({ colors }) => {
  const [isOpen, setIsOpen] = React.useState(false);

  return (
    <div>
      {isOpen
        ? 
          <Anonymous key="true">
            {() => (
              <Modal
                close={React.useCallback(() => setIsOpen(false), [setIsOpen])}
              >
                <ul>
                  {colors.map((color) =>
                    <Anonymous key={color}>
                      {() => (
                        // All good now
                        <li style={useMemo(() => ({ color }), [color])}>{color}</li>
                      )}
                    </Anonymous>
                  )}
                </ul>
              </Modal>
            )}
          </Anonymous>
        : null}
    </div>
  );
};

The extra levels of indenting could make code impractical to read past a certain point, so at some point we may still want to break down into separate components. But note that now we can go back to adding indirection only when we feel it's useful, instead of being forced to every time we want to call a hook inside a branch or loop.

The anonymous component pattern also opens up possibilities for new use cases for hooks where previously the rules of hooks would have made usage ergonomics too prohibitively poor, due to the countless extra layers of indirection that would have been required.

For instance, a CSS-in-JS hook where styles can be applied anonymously anywhere in the tree regardless of branching/mapping (basically a more robust runtime alternative to @emotion/babel-plugin's build-time css prop):

import * as React from "react";
import Anonymous from "@lewisl9029/react-anonymous";
import { useStyles } from "@lewisl9029/use-styles";

const Example = ({ colors }) => {
  const [isOpen, setIsOpen] = React.useState(false);

  return (
    <div>
      {isOpen
        ? 
          <Anonymous key="true">
            {() => (
              <Modal
                close={React.useCallback(() => setIsOpen(false), [setIsOpen])}
              >
                <ul className={useStyles(() => ({ listStyleType: 'none' }), [])}>
                  {colors.map((color) =>
                    <Anonymous key={color}>
                      {() => (
                        <li className={useStyles(() => ({ color }), [color])}>{color}</li>
                      )}
                    </Anonymous>
                  )}
                </ul>
              </Modal>
            )}
          </Anonymous>
        : null}
    </div>
  );
};

The anonymous component pattern can help reduce forced indirection in ways beyond just hooks usage as well, one use case I recently discovered is using a context in the same render function as where the provider is rendered:

import * as React from 'react'
import Anonymous from "@lewisl9029/react-anonymous";

const themeContext = React.createContext()

const Example = () => {
  return (
    <themeContext.Provider value={{ foreground: 'black', background: 'white' }}>
      <Anonymous key="true">
        {() => {
          // Calling useContext(themeContext) outside of anonymous would result in undefined.
          // 
          // Since only components downstream from the component where the Provider 
          // is rendered can read from the Provider.
          const theme = React.useContext(themeContext)
          return (
            <span className={
              useStyles(
                () => ({ 
                  color: theme.foreground, 
                  backgroundColor: theme.background 
                }), 
                [theme.background, theme.background]
              )}
            >
              themed text
            </span>
          )
        }
      </Anonymous>
    </themeContext.Provider>
  )
}

Linting

If you're using eslint-plugin-react-hooks, you'll get errors when trying to use react-anonymous due to the plugin not recognizing that the Anonymous render function can be treated as a valid component boundary.

I've created a fork of the plugin at https://www.npmjs.com/package/@lewisl9029/eslint-plugin-react-hooks-for-react-anonymous to add support for this pattern. The changes are very naive however, so I do anticipate some edge cases. Please feel free to report any issues you find with the plugin here.

How it works

The implementation is literally a 1-liner:

export const Anonymous = ({ children }) => children();

By packaging it as a library, I'm mostly aiming to promote the pattern and make it easier for people to get started. Feel free to simply copy paste this into your project and use it directly, replacing the eslint plugin with my fork from above.

License

MIT

License

lewisl9029/react-anonymous

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages