docs

packages/runed/src/lib/functions/useActiveElement/useActiveElement.svelte.ts

@@ -1,5 +1,13 @@
 import { isBrowser } from "$lib/internal/utils/browser.js";
 
+
+/**
+ * Returns a reactive value that is equal to `document.activeElement`.
+ * It automatically listens for changes, keeping the reference up to date.
+ *
+ * @export
+ * @returns {{ value: Readonly<Element | null> }}
+ */
 export function useActiveElement(): { value: Readonly<Element | null> } {
 	const activeElement = $state({ value: isBrowser() ? document.activeElement : null });
 

packages/runed/src/lib/functions/useDebounce/useDebounce.svelte.ts

@@ -12,10 +12,6 @@ import type { FunctionArgs, ValueOrGetter } from "$lib/internal/types.js";
  * The second parameter is the time to wait before calling the original callback.
  * Alternatively, it can also be a getter function that returns the time to wait.
  *
- * @export
- * @template {FunctionArgs} Callback
- * @param {Callback} callback
- * @param {number} wait
  */
 export function useDebounce<Callback extends FunctionArgs>(
 	callback: Callback,

packages/runed/src/lib/functions/useElementSize/useElementSize.svelte.ts

@@ -9,20 +9,31 @@ type Options = {
 	box?: "content-box" | "border-box";
 };
 
+
+/**
+ * Returns a reactive value holding the size of `node`.
+ *
+ * @export
+ * @param {ValueOrGetter<HTMLElement | undefined>} node
+ * @param {Options} [options={
+ * 		box: "border-box",
+ * 	}]
+ * @returns {*}
+ */
 export function useElementSize(
-	_node: ValueOrGetter<HTMLElement | undefined>,
+	node: ValueOrGetter<HTMLElement | undefined>,
 	options: Options = {
 		box: "border-box",
 	}
 ) {
-	const node = boxed(_node);
+	const $node = boxed(node);
 	const size = $state({
 		width: options.initialSize?.width ?? 0,
 		height: options.initialSize?.height ?? 0,
 	});
 
 	$effect(() => {
-		if (!node.value) return;
+		if (!$node.value) return;
 
 		const observer = new ResizeObserver((entries) => {
 			for (const entry of entries) {
@@ -33,7 +44,7 @@ export function useElementSize(
 				size.height = boxSizeArr.reduce((acc, size) => Math.max(acc, size.blockSize), 0);
 			}
 		});
-		observer.observe(node.value);
+		observer.observe($node.value);
 
 		return () => {
 			observer.disconnect();