refactor: rename unwrap util

Author: danielwaltz

packages/react/src/hooks/useAdhesive.ts

@@ -1,9 +1,9 @@
 import { Adhesive, type AdhesiveOptions } from "@adhesivejs/core";
 import { useEffect, useRef } from "react";
 import {
-  unrefElement,
+  unwrapElement,
   type MaybeElementOrSelectorRef,
-} from "../utils/unrefElement.js";
+} from "../utils/unwrapElement.js";
 
 /**
  * Configuration options for the useAdhesive hook.
@@ -53,9 +53,9 @@ export function useAdhesive(
   options?: UseAdhesiveOptions,
 ) {
   function getValidatedOptions() {
-    const targetEl = unrefElement(target);
+    const targetEl = unwrapElement(target);
     const boundingEl =
-      unrefElement(options?.boundingRef) ?? options?.boundingEl;
+      unwrapElement(options?.boundingRef) ?? options?.boundingEl;
 
     if (!targetEl) {
       throw new Error("@adhesivejs/react: sticky element is not defined");

packages/react/src/utils/unrefElement.ts packages/react/src/utils/unwrapElement.tspackages/react/src/utils/unrefElement.ts renamed to packages/react/src/utils/unwrapElement.ts

@@ -7,11 +7,11 @@ export type MaybeElementOrSelectorRef =
   | null
   | undefined;
 
-type UnRefElementReturn = HTMLElement | string | null | undefined;
+type UnwrapElementReturn = HTMLElement | string | null | undefined;
 
-export function unrefElement(
+export function unwrapElement(
   elOrSelectorRef: MaybeElementOrSelectorRef,
-): UnRefElementReturn {
+): UnwrapElementReturn {
   // Handle React ref objects by accessing their .current property
   // For non-ref values, return them as-is
   if (
@@ -21,5 +21,5 @@ export function unrefElement(
   ) {
     return elOrSelectorRef.current;
   }
-  return elOrSelectorRef as UnRefElementReturn;
+  return elOrSelectorRef as UnwrapElementReturn;
 }

packages/vue/src/components/AdhesiveContainer.ts

@@ -10,7 +10,7 @@ import {
   useAdhesive,
   type UseAdhesiveOptions,
 } from "../composables/useAdhesive.js";
-import type { MaybeElementOrSelectorRef } from "../utils/unrefElement.js";
+import type { MaybeElementOrSelectorRef } from "../utils/unwrapElement.js";
 
 type BaseProps = Omit<
   Partial<UseAdhesiveOptions>,

packages/vue/src/composables/useAdhesive.ts

@@ -7,9 +7,9 @@ import {
   type MaybeRefOrGetter,
 } from "vue";
 import {
-  unrefElement,
+  unwrapElement,
   type MaybeElementOrSelectorRef,
-} from "../utils/unrefElement.js";
+} from "../utils/unwrapElement.js";
 
 /**
  * Configuration options for the useAdhesive composable.
@@ -80,9 +80,9 @@ export function useAdhesive(
   function getValidatedOptions() {
     const optionsValue = toValue(options);
 
-    const targetEl = unrefElement(target);
+    const targetEl = unwrapElement(target);
     const boundingEl =
-      unrefElement(optionsValue?.boundingRef) ?? optionsValue?.boundingEl;
+      unwrapElement(optionsValue?.boundingRef) ?? optionsValue?.boundingEl;
 
     if (!targetEl) {
       throw new Error("@adhesivejs/vue: sticky element is not defined");

packages/vue/src/utils/unrefElement.ts packages/vue/src/utils/unwrapElement.tspackages/vue/src/utils/unrefElement.ts renamed to packages/vue/src/utils/unwrapElement.ts

@@ -17,11 +17,11 @@ export type MaybeElementOrSelectorRef<
   T extends MaybeElementOrSelector = MaybeElementOrSelector,
 > = MaybeRefOrGetter<T>;
 
-type UnRefElementReturn = HTMLElement | string | null | undefined;
+type UnwrapElementReturn = HTMLElement | string | null | undefined;
 
-export function unrefElement(
+export function unwrapElement(
   elOrSelectorRef: MaybeElementOrSelectorRef,
-): UnRefElementReturn {
+): UnwrapElementReturn {
   const elOrSelectorValue = toValue(elOrSelectorRef);
   return (elOrSelectorValue as VueInstance)?.$el ?? elOrSelectorValue;
 }