feat(use-presence): Add usePresenceSwitch (#11)

* feat(use-presence): allow use-presence to be driven by arbitrary data

* fix(use-presence): make use-presence for aribtrary data separate hook

* feat(use-presence): separate options into their own types so that if the option types for the original hook change, the wrapper hook will receive the update by default

* fix(use-presence): update useUniqueDataPresence to return all state values from usePresence, and export both of their options types

* fix(use-presence): removes unused variable

* feat(use-presence): separates use-presence and use-presence-switch to separate files and performs some name updates and configuration and type remodeling

* feat(use-presence): adds test for use-presence-switch

* feat(use-presence): simplify use-presence-switch test component tree

* fix: adds test, updates names, code style cleanup

* docs(use-presence): first pass attempt at usePresenceSwitch documentation

* Cleanup

* Inline checks

---------

Co-authored-by: Jan Amann <[email protected]>

Author: EthanStandel

packages/use-presence/README.md

@@ -82,6 +82,89 @@ const {
 )
 ```
 
+## `usePresenceSwitch`
+
+If you have multiple items where only one is visible at a time, you can use the supplemental `usePresenceSwitch` hook to animate the items in and out. Previous items will exit before the next item transitions in.
+
+### API
+
+```tsx
+const {
+  /** The item that should currently be rendered. */
+  mountedItem,
+  /** Returns all other properties from `usePresence`. */
+  ...rest
+} = usePresence<ItemType>(
+  /** The current item that should be visible. If `undefined` is passed, the previous item will animate out. */
+  item: ItemType | undefined,
+  /** See the `opts` argument of `usePresence`. */
+  opts: Parameters<typeof usePresence>[1]
+)
+```
+
+### Example
+
+```jsx
+const tabs = [
+  {
+    title: 'Tab 1',
+    content: 'Tab 1 content'
+  },
+  {
+    title: 'Tab 2',
+    content: 'Tab 2 content'
+  },
+  {
+    title: 'Tab 3',
+    content: 'Tab 3 content'
+  },
+];
+
+function Tabs() {
+  const [tabIndex, setTabIndex] = useState(0);
+
+  return (
+    <>
+      {tabs.map((tab, index) => (
+        <button key={index} onClick={() => setTabIndex(index)} type="button">
+          {tab.title}
+        </button>
+      ))}
+      <TabContent>
+        {tabs[tabIndex].content}
+      </TabContent>
+    </>
+  );
+}
+
+function TabContent({ children, transitionDuration = 500 }) {
+  const {
+    isMounted,
+    isVisible,
+    mountedItem,
+  } = usePresenceSwitch(children, { transitionDuration });
+
+  if (!isMounted) {
+    return null;
+  }
+
+  return (
+    <div
+      style={{
+        opacity: 0,
+        transitionDuration: `${transitionDuration}ms`,
+        transitionProperty: 'opacity',
+        ...(isVisible && {
+          opacity: 1
+        })
+      }}
+    >
+      {mountedItem}
+    </div>
+  );
+}
+```
+
 ## Related
 
 - [`AnimatePresence` of `framer-motion`](https://www.framer.com/docs/animate-presence/)

packages/use-presence/src/index.ts

@@ -0,0 +1,2 @@
+export {default} from './usePresence';
+export {default as usePresenceSwitch} from './usePresenceSwitch';

packages/use-presence/src/index.tsx packages/use-presence/src/usePresence.tsxpackages/use-presence/src/index.tsx renamed to packages/use-presence/src/usePresence.tsx

@@ -0,0 +1,32 @@
+import {useState, useEffect} from 'react';
+import usePresence from './usePresence';
+
+export default function usePresenceSwitch<ItemType>(
+  item: ItemType | undefined,
+  opts: Parameters<typeof usePresence>[1]
+) {
+  const [mountedItem, setMountedItem] = useState(item);
+  const [shouldBeMounted, setShouldBeMounted] = useState(item !== undefined);
+  const {isMounted, ...rest} = usePresence(shouldBeMounted, opts);
+
+  useEffect(() => {
+    if (mountedItem !== item) {
+      if (isMounted) {
+        setShouldBeMounted(false);
+      } else if (item !== undefined) {
+        setMountedItem(item);
+        setShouldBeMounted(true);
+      }
+    } else if (item === undefined) {
+      setShouldBeMounted(false);
+    } else if (item !== undefined) {
+      setShouldBeMounted(true);
+    }
+  }, [item, mountedItem, shouldBeMounted, isMounted]);
+
+  return {
+    ...rest,
+    isMounted: isMounted && mountedItem !== undefined,
+    mountedItem
+  };
+}

packages/use-presence/src/usePresenceSwitch.tsx

@@ -0,0 +1,75 @@
+import {render, waitFor} from '@testing-library/react';
+import * as React from 'react';
+import {usePresenceSwitch} from '../src';
+
+function Expander({
+  initialEnter,
+  text,
+  transitionDuration = 50
+}: {
+  initialEnter?: boolean;
+  text?: string;
+  transitionDuration?: number;
+}) {
+  const {mountedItem, ...values} = usePresenceSwitch(text, {
+    transitionDuration,
+    initialEnter
+  });
+  const {isMounted, isVisible} = values;
+  const testId =
+    Object.entries(values)
+      .filter(([, value]) => value)
+      .map(([key]) => key)
+      .join(', ') || 'none';
+
+  return (
+    <div data-testid={testId}>
+      {isMounted ? (
+        <div
+          style={{
+            opacity: 0,
+            transitionDuration: `${transitionDuration}ms`,
+            transitionProperty: 'opacity',
+            ...(isVisible && {
+              opacity: 1
+            })
+          }}
+        >
+          {mountedItem}
+        </div>
+      ) : (
+        <div>Nothing mounted</div>
+      )}
+    </div>
+  );
+}
+
+it("can animate the exit and re-entrance of a component that has changed it's rendered data", async () => {
+  const {getByTestId, getByText, rerender} = render(
+    <Expander text="initial value" />
+  );
+  getByTestId('isVisible, isMounted');
+  getByText('initial value');
+  rerender(<Expander text="re-assigned value" />);
+  getByTestId('isAnimating, isExiting, isMounted');
+  getByText('initial value');
+  await waitFor(() => getByTestId('isVisible, isMounted'));
+  getByText('re-assigned value');
+});
+
+it("can animate the initial entrance and exit of a component based on it's rendered data", async () => {
+  const {getByTestId, getByText, rerender} = render(
+    <Expander text={undefined} />
+  );
+  getByTestId('none');
+  getByText('Nothing mounted');
+  rerender(<Expander text="initial value" />);
+  getByTestId('isAnimating, isEntering, isMounted');
+  getByText('initial value');
+  await waitFor(() => getByTestId('isVisible, isMounted'));
+  rerender(<Expander text={undefined} />);
+  getByTestId('isAnimating, isExiting, isMounted');
+  getByText('initial value');
+  await waitFor(() => getByTestId('none'));
+  getByText('Nothing mounted');
+});