From dbfb2c227ecde2dafb390d71a0b1ac717e45ce9b Mon Sep 17 00:00:00 2001
From: Ryan Gossiaux <ryan.gossiaux@gmail.com>
Date: Wed, 15 Dec 2021 10:13:01 -0800
Subject: [PATCH] Move contexts over to useXContext model

Fixes #4
---
 src/lib/components/listbox/Listbox.svelte     | 20 +++++++++++++++++--
 .../components/listbox/ListboxButton.svelte   |  5 +++--
 .../components/listbox/ListboxLabel.svelte    |  4 ++--
 .../components/listbox/ListboxOption.svelte   |  6 +++---
 .../components/listbox/ListboxOptions.svelte  |  5 +++--
 src/lib/components/popover/Popover.svelte     | 17 +++++++++++++++-
 .../components/popover/PopoverButton.svelte   | 16 +++++++--------
 .../components/popover/PopoverGroup.svelte    |  9 +++++++--
 .../components/popover/PopoverOverlay.svelte  |  4 ++--
 .../components/popover/PopoverPanel.svelte    | 17 +++++++++++++---
 src/lib/components/switch/Switch.svelte       |  4 ++--
 src/lib/components/switch/SwitchGroup.svelte  |  9 ++++++++-
 12 files changed, 85 insertions(+), 31 deletions(-)

diff --git a/src/lib/components/listbox/Listbox.svelte b/src/lib/components/listbox/Listbox.svelte
index eb28dd9..2aebe20 100644
--- a/src/lib/components/listbox/Listbox.svelte
+++ b/src/lib/components/listbox/Listbox.svelte
@@ -34,6 +34,22 @@
     unregisterOption(id: string): void;
     select(value: unknown): void;
   };
+
+  const LISTBOX_CONTEXT_NAME = "ListboxContext";
+  export function useListboxContext(
+    component: string
+  ): Writable<StateDefinition | undefined> {
+    let context: Writable<StateDefinition | undefined> | undefined =
+      getContext(LISTBOX_CONTEXT_NAME);
+
+    if (context === undefined) {
+      throw new Error(
+        `<${component} /> is missing a parent <Listbox /> component.`
+      );
+    }
+
+    return context;
+  }
 </script>
 
 <script lang="ts">
@@ -41,7 +57,7 @@
     Focus,
     calculateActiveIndex,
   } from "$lib/utils/calculate-active-index";
-  import { createEventDispatcher, setContext } from "svelte";
+  import { createEventDispatcher, getContext, setContext } from "svelte";
   import { writable, Writable } from "svelte/store";
   import { match } from "$lib/utils/match";
   import { State, useOpenClosedProvider } from "$lib/internal/open-closed";
@@ -63,7 +79,7 @@
   let activeOptionIndex = null;
 
   let api: Writable<StateDefinition | undefined> = writable();
-  setContext("api", api);
+  setContext(LISTBOX_CONTEXT_NAME, api);
 
   let openClosedState = writable(State.Closed);
   useOpenClosedProvider(openClosedState);
diff --git a/src/lib/components/listbox/ListboxButton.svelte b/src/lib/components/listbox/ListboxButton.svelte
index 2252fe0..0cf6c28 100644
--- a/src/lib/components/listbox/ListboxButton.svelte
+++ b/src/lib/components/listbox/ListboxButton.svelte
@@ -1,10 +1,11 @@
 <script lang="ts">
   import { getContext, tick } from "svelte";
-  import { ListboxStates, StateDefinition } from "./Listbox.svelte";
+  import { ListboxStates, useListboxContext } from "./Listbox.svelte";
   import { useId } from "$lib/hooks/use-id";
   import { Keys } from "$lib/utils/keyboard";
   import { Focus } from "$lib/utils/calculate-active-index";
-  let api: SvelteStore<StateDefinition> = getContext("api");
+
+  let api = useListboxContext("ListboxButton");
   let id = `headlessui-listbox-button-${useId()}`;
   let buttonStore: SvelteStore<HTMLButtonElement> = getContext("buttonStore");
 
diff --git a/src/lib/components/listbox/ListboxLabel.svelte b/src/lib/components/listbox/ListboxLabel.svelte
index 5d34a70..1b2e422 100644
--- a/src/lib/components/listbox/ListboxLabel.svelte
+++ b/src/lib/components/listbox/ListboxLabel.svelte
@@ -1,8 +1,8 @@
 <script lang="ts">
   import { getContext } from "svelte";
-  import { ListboxStates, StateDefinition } from "./Listbox.svelte";
+  import { ListboxStates, useListboxContext } from "./Listbox.svelte";
   import { useId } from "$lib/hooks/use-id";
-  let api: SvelteStore<StateDefinition> = getContext("api");
+  let api = useListboxContext("ListboxLabel");
   let id = `headlessui-listbox-label-${useId()}`;
   let labelStore: SvelteStore<HTMLLabelElement> = getContext("labelStore");
 
diff --git a/src/lib/components/listbox/ListboxOption.svelte b/src/lib/components/listbox/ListboxOption.svelte
index 3607deb..0ccb2dc 100644
--- a/src/lib/components/listbox/ListboxOption.svelte
+++ b/src/lib/components/listbox/ListboxOption.svelte
@@ -1,11 +1,11 @@
 <script lang="ts">
-  import { getContext, onDestroy, onMount, tick } from "svelte";
-  import { ListboxStates, StateDefinition } from "./Listbox.svelte";
+  import { onDestroy, onMount, tick } from "svelte";
+  import { ListboxStates, useListboxContext } from "./Listbox.svelte";
   import { useId } from "$lib/hooks/use-id";
   import { Focus } from "$lib/utils/calculate-active-index";
   export let value: any;
   export let disabled = false;
-  let api: SvelteStore<StateDefinition> = getContext("api");
+  let api = useListboxContext("ListboxOption");
   let id = `headlessui-listbox-option-${useId()}`;
 
   $: active =
diff --git a/src/lib/components/listbox/ListboxOptions.svelte b/src/lib/components/listbox/ListboxOptions.svelte
index 1b56874..a440b2a 100644
--- a/src/lib/components/listbox/ListboxOptions.svelte
+++ b/src/lib/components/listbox/ListboxOptions.svelte
@@ -1,12 +1,13 @@
 <script lang="ts">
   import { getContext, tick } from "svelte";
-  import { ListboxStates, StateDefinition } from "./Listbox.svelte";
+  import { ListboxStates, useListboxContext } from "./Listbox.svelte";
   import { useId } from "$lib/hooks/use-id";
   import { match } from "$lib/utils/match";
   import { Keys } from "$lib/utils/keyboard";
   import { Focus } from "$lib/utils/calculate-active-index";
   import { State, useOpenClosed } from "$lib/internal/open-closed";
-  let api: SvelteStore<StateDefinition> = getContext("api");
+
+  let api = useListboxContext("ListboxOptions");
   let id = `headlessui-listbox-options-${useId()}`;
   let optionsStore: SvelteStore<HTMLUListElement> = getContext("optionsStore");
 
diff --git a/src/lib/components/popover/Popover.svelte b/src/lib/components/popover/Popover.svelte
index ef066ad..50baace 100644
--- a/src/lib/components/popover/Popover.svelte
+++ b/src/lib/components/popover/Popover.svelte
@@ -24,6 +24,21 @@
     panelId: string;
     close(): void;
   }
+
+  const POPOVER_CONTEXT_NAME = "PopoverContext";
+  export function usePopoverContext(
+    component: string
+  ): Writable<StateDefinition | undefined> {
+    let context = getContext(POPOVER_CONTEXT_NAME) as
+      | Writable<StateDefinition | undefined>
+      | undefined;
+    if (context === undefined) {
+      throw new Error(
+        `<${component} /> is missing a parent <Popover /> component.`
+      );
+    }
+    return context;
+  }
 </script>
 
 <script lang="ts">
@@ -43,7 +58,7 @@
   let popoverState: PopoverStates = PopoverStates.Closed;
 
   let api: Writable<StateDefinition | undefined> = writable();
-  setContext("PopoverApi", api);
+  setContext(POPOVER_CONTEXT_NAME, api);
 
   let openClosedState: Writable<State> | undefined = writable();
   setContext("OpenClosed", openClosedState);
diff --git a/src/lib/components/popover/PopoverButton.svelte b/src/lib/components/popover/PopoverButton.svelte
index c20371c..9577f3c 100644
--- a/src/lib/components/popover/PopoverButton.svelte
+++ b/src/lib/components/popover/PopoverButton.svelte
@@ -7,19 +7,17 @@
   } from "$lib/utils/focus-management";
   import { getContext } from "svelte";
   import { writable, Writable } from "svelte/store";
-  import { PopoverStates, StateDefinition } from "./Popover.svelte";
-  import type { PopoverGroupContext } from "./PopoverGroup.svelte";
-  import type { PopoverPanelContext } from "./PopoverPanel.svelte";
+  import { PopoverStates, usePopoverContext } from "./Popover.svelte";
+  import { usePopoverGroupContext } from "./PopoverGroup.svelte";
+  import { usePopoverPanelContext } from "./PopoverPanel.svelte";
   let buttonStore: Writable<HTMLButtonElement> = getContext("PopoverButtonRef");
   export let disabled: Boolean = false;
-  let api: Writable<StateDefinition> | undefined = getContext("PopoverApi");
+  let api = usePopoverContext("PopoverButton");
 
-  const groupContext: PopoverGroupContext | undefined =
-    getContext("PopoverGroup");
-  const closeOthers = groupContext?.closeOthers;
+  let groupContext = usePopoverGroupContext();
+  let closeOthers = groupContext?.closeOthers;
 
-  let panelContext: PopoverPanelContext | undefined =
-    getContext("PopoverPanel");
+  let panelContext = usePopoverPanelContext();
   let isWithinPanel =
     panelContext === null ? false : panelContext === $api.panelId;
   if (isWithinPanel) {
diff --git a/src/lib/components/popover/PopoverGroup.svelte b/src/lib/components/popover/PopoverGroup.svelte
index b9b51e1..ee020d6 100644
--- a/src/lib/components/popover/PopoverGroup.svelte
+++ b/src/lib/components/popover/PopoverGroup.svelte
@@ -5,11 +5,16 @@
     isFocusWithinPopoverGroup(): boolean;
     closeOthers(buttonId: string): void;
   }
+
+  const POPOVER_GROUP_CONTEXT_NAME = "PopoverGroupContext";
+  export function usePopoverGroupContext(): PopoverGroupContext | undefined {
+    return getContext(POPOVER_GROUP_CONTEXT_NAME);
+  }
 </script>
 
 <script lang="ts">
   import type { PopoverRegisterBag } from "./Popover.svelte";
-  import { setContext } from "svelte";
+  import { getContext, setContext } from "svelte";
   let groupRef: HTMLDivElement | undefined;
   let popovers: PopoverRegisterBag[] = [];
 
@@ -44,7 +49,7 @@
     }
   }
 
-  setContext("PopoverGroup", {
+  setContext(POPOVER_GROUP_CONTEXT_NAME, {
     unregisterPopover,
     registerPopover,
     isFocusWithinPopoverGroup,
diff --git a/src/lib/components/popover/PopoverOverlay.svelte b/src/lib/components/popover/PopoverOverlay.svelte
index 0f58d99..64be7af 100644
--- a/src/lib/components/popover/PopoverOverlay.svelte
+++ b/src/lib/components/popover/PopoverOverlay.svelte
@@ -2,9 +2,9 @@
   import { State } from "$lib/internal/open-closed";
   import { getContext } from "svelte";
   import type { Writable } from "svelte/store";
-  import { PopoverStates, StateDefinition } from "./Popover.svelte";
+  import { PopoverStates, usePopoverContext } from "./Popover.svelte";
 
-  let api: Writable<StateDefinition> | undefined = getContext("PopoverApi");
+  let api = usePopoverContext("PopoverOverlay");
 
   let openClosedState: Writable<State> | undefined = getContext("OpenClosed");
 
diff --git a/src/lib/components/popover/PopoverPanel.svelte b/src/lib/components/popover/PopoverPanel.svelte
index 052a109..a821a67 100644
--- a/src/lib/components/popover/PopoverPanel.svelte
+++ b/src/lib/components/popover/PopoverPanel.svelte
@@ -1,5 +1,12 @@
 <script lang="ts" context="module">
   export type PopoverPanelContext = string | null;
+
+  const POPOVER_PANEL_CONTEXT_NAME = "PopoverPanelContext";
+  export function usePopoverPanelContext():
+    | StateDefinition["panelId"]
+    | undefined {
+    return getContext(POPOVER_PANEL_CONTEXT_NAME);
+  }
 </script>
 
 <script lang="ts">
@@ -13,12 +20,16 @@
   } from "$lib/utils/focus-management";
   import { getContext, setContext, onMount } from "svelte";
   import type { Writable } from "svelte/store";
-  import { PopoverStates, StateDefinition } from "./Popover.svelte";
+  import {
+    PopoverStates,
+    StateDefinition,
+    usePopoverContext,
+  } from "./Popover.svelte";
   let panelStore: SvelteStore<HTMLDivElement> = getContext("PopoverPanelRef");
   export let focus = false;
 
-  let api: Writable<StateDefinition> | undefined = getContext("PopoverApi");
-  setContext("PopoverPanelContext", $api.panelId);
+  let api = usePopoverContext("PopoverPanel");
+  setContext(POPOVER_PANEL_CONTEXT_NAME, $api.panelId);
 
   let openClosedState: Writable<State> | undefined = getContext("OpenClosed");
 
diff --git a/src/lib/components/switch/Switch.svelte b/src/lib/components/switch/Switch.svelte
index 32df199..a4a313f 100644
--- a/src/lib/components/switch/Switch.svelte
+++ b/src/lib/components/switch/Switch.svelte
@@ -1,5 +1,5 @@
 <script lang="ts">
-  import type { StateDefinition } from "./SwitchGroup.svelte";
+  import { useSwitchContext } from "./SwitchGroup.svelte";
   import type { LabelContext } from "$lib/components/label/LabelProvider.svelte";
   import type { DescriptionContext } from "$lib/components/description/DescriptionProvider.svelte";
   import { useId } from "$lib/hooks/use-id";
@@ -9,7 +9,7 @@
 
   const dispatch = createEventDispatcher();
   export let checked = false;
-  let api: Writable<StateDefinition> | undefined = getContext("SwitchApi");
+  let api = useSwitchContext();
   let labelContext: Writable<LabelContext> | undefined = getContext(
     "headlessui-label-context"
   );
diff --git a/src/lib/components/switch/SwitchGroup.svelte b/src/lib/components/switch/SwitchGroup.svelte
index 0c001d4..7d8bca1 100644
--- a/src/lib/components/switch/SwitchGroup.svelte
+++ b/src/lib/components/switch/SwitchGroup.svelte
@@ -2,12 +2,19 @@
   export interface StateDefinition {
     switchStore: Writable<HTMLButtonElement | null>;
   }
+
+  const SWITCH_CONTEXT_NAME = "SwitchContext";
+  export function useSwitchContext():
+    | Writable<StateDefinition | undefined>
+    | undefined {
+    return getContext(SWITCH_CONTEXT_NAME);
+  }
 </script>
 
 <script lang="ts">
   import DescriptionProvider from "./DescriptionProvider.svelte";
   import LabelProvider from "./LabelProvider.svelte";
-  import { setContext } from "svelte";
+  import { getContext, setContext } from "svelte";
   import { Writable, writable } from "svelte/store";
 
   let switchStore: Writable<HTMLButtonElement | null> = writable(null);