feat: add jsdoc for useOnClickOutside

gravity-ui · Sep 13, 2023 · 9b83c41 · 9b83c41
1 parent 06a54c9
commit 9b83c41
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/components/utils/useOnClickOutside/useOnClickOutside.tsx b/src/components/utils/useOnClickOutside/useOnClickOutside.tsx
@@ -9,6 +9,15 @@ export type UseOnClickOutsideType = <T extends HTMLElement>({
     handleCallback?: () => void;
 }) => void;
 
+/**
+ * Hook for observing clicks outside a given target
+ *
+ * @param observedRef - purpose of observation
+ * @param enabled - enabled/disable flag
+ * @param handleCallback - callback when a click is triggered outside the observation target
+ *
+ * @return - nothing
+ */
 export const useOnClickOutside: UseOnClickOutsideType = ({
     observedRef,
     enabled = true,