From dbd3b03ec842c446488135853ed380f5a75adb27 Mon Sep 17 00:00:00 2001
From: Hsieh Chin Fan <pham@topo.tw>
Date: Fri, 4 Oct 2024 13:38:08 +0800
Subject: docs: add jsdoc

---
 src/utils.mjs | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/utils.mjs')

diff --git a/src/utils.mjs b/src/utils.mjs
index c9a2457..ffd8978 100644
--- a/src/utils.mjs
+++ b/src/utils.mjs
@@ -88,6 +88,11 @@ export function throttle (func, delay) {
   }
 }
 
+/**
+ * shiftByWindow. make sure HTMLElement inside viewport
+ *
+ * @param {HTMLElement} element
+ */
 export const shiftByWindow = element => {
   const rect = element.getBoundingClientRect()
   const offsetX = window.innerWidth - rect.left - rect.width
-- 
cgit v1.2.3-70-g09d2