From 704273a50ec9f05cbb4cf02373a0f5ae73a189d8 Mon Sep 17 00:00:00 2001
From: Dylan Staley <88163+dstaley@users.noreply.github.com>
Date: Mon, 19 Aug 2024 13:46:17 -0700
Subject: [PATCH] feat(ui): Remove need to manually pass globalAppearance

---
 .../ui/src/components/sign-in/sign-in.tsx     |  8 +---
 .../ui/src/contexts/AppearanceContext.tsx     | 41 +++++++------------
 2 files changed, 17 insertions(+), 32 deletions(-)

diff --git a/packages/ui/src/components/sign-in/sign-in.tsx b/packages/ui/src/components/sign-in/sign-in.tsx
index e47313ad243..48adb5250f2 100644
--- a/packages/ui/src/components/sign-in/sign-in.tsx
+++ b/packages/ui/src/components/sign-in/sign-in.tsx
@@ -8,7 +8,7 @@ import { SignInGetHelp } from '~/components/sign-in/steps/get-help';
 import { SignInResetPassword } from '~/components/sign-in/steps/reset-password';
 import { SignInStart } from '~/components/sign-in/steps/start';
 import { SignInVerifications } from '~/components/sign-in/steps/verifications';
-import { type Appearance, AppearanceProvider, useAppearance } from '~/contexts';
+import { type Appearance, AppearanceProvider } from '~/contexts';
 
 import { SignInChooseSession } from './steps/choose-session';
 
@@ -25,13 +25,9 @@ import { SignInChooseSession } from './steps/choose-session';
  */
 export function SignIn({ appearance }: { appearance?: Appearance }) {
   const [showHelp, setShowHelp] = React.useState(false);
-  const { appearance: globalAppearance } = useAppearance();
 
   return (
-    <AppearanceProvider
-      globalAppearance={globalAppearance}
-      appearance={appearance}
-    >
+    <AppearanceProvider appearance={appearance}>
       <GetHelpContext.Provider value={{ showHelp, setShowHelp }}>
         <SignInRoot>
           {showHelp ? (
diff --git a/packages/ui/src/contexts/AppearanceContext.tsx b/packages/ui/src/contexts/AppearanceContext.tsx
index 5d38e21daf7..9e36d452ecb 100644
--- a/packages/ui/src/contexts/AppearanceContext.tsx
+++ b/packages/ui/src/contexts/AppearanceContext.tsx
@@ -19,23 +19,6 @@ export type ParsedAppearance = {
 };
 
 type AppearanceContextValue = {
-  /**
-   * The appearance value provided to the AppearanceProvider. Should be passed to children `AppearanceProvider`s as the
-   * `globalAppearance` prop.
-   *
-   * Example:
-   * ```tsx
-   * function SignIn({ children }) {
-   *   const { appearance } = useAppearance();
-   *   return (<AppearanceProvider globalAppearance={appearance} appearance={{}}>{children}</AppearanceProvider>)
-   * }
-   * ```
-   */
-  appearance?: Appearance;
-
-  // TODO: This can probably be removed
-  globalAppearance?: Appearance;
-
   /**
    * The calculated appearance value based on the provided `appearance` and `globalAppearance`.
    *
@@ -81,24 +64,30 @@ function parseAppearance(props: AppearanceCascade): ParsedAppearance {
   return appearance;
 }
 
-const [AppearanceContext, useAppearance] = createContextAndHook<AppearanceContextValue>('AppearanceContext');
+const [AppearanceContext, useAppearance, usePartialAppearance] =
+  createContextAndHook<AppearanceContextValue>('AppearanceContext');
 
-type AppearanceProviderProps = React.PropsWithChildren<AppearanceCascade>;
+type AppearanceProviderProps = React.PropsWithChildren<{ appearance?: Appearance }>;
 
 /**
  * Used to provide appearance values throughout an application. In typical usage, the entire application will be
  * wrapped in an `AppearanceProvider` to provide global configuration. Each top-level AIO component that accepts an
- * `appearance` prop will wrap its children in `AppearanceProvider`, and provide the `appearance` value from
- * `useAppearance` as `globalAppearance` (which ensures that global configuration is able to be accounted for as well
- * as component-level configuration). The provider handles the merging of attributes, and makes them available via the
- * `useAppearance` hook.
+ * `appearance` prop will wrap its children in `AppearanceProvider`. The provider handles the merging of attributes,
+ * and makes them available via the `useAppearance` hook.
  */
 const AppearanceProvider = (props: AppearanceProviderProps) => {
+  // Access the parsedAppearance of the parent context provider. `undefined` if this is the top-most
+  // AppearanceProvider.
+  const { parsedAppearance: globalAppearance } = usePartialAppearance();
+
   const ctxValue = useDeepEqualMemo(() => {
-    const parsedAppearance = parseAppearance(props);
+    const parsedAppearance = parseAppearance({
+      appearance: props.appearance,
+      globalAppearance: globalAppearance,
+    });
 
-    return { value: { appearance: props.appearance, globalAppearance: props.globalAppearance, parsedAppearance } };
-  }, [props.appearance, props.globalAppearance]);
+    return { value: { parsedAppearance } };
+  }, [props.appearance, globalAppearance]);
 
   return <AppearanceContext.Provider value={ctxValue}>{props.children}</AppearanceContext.Provider>;
 };