auto-claude: subtask-4-2 - Add JSDoc to useOnClickOutside.ts hook

This commit is contained in:
2026-01-25 11:59:48 +01:00
parent 6558e9ae79
commit 0a69a9bfbf
+16
View File
@@ -1,5 +1,21 @@
/**
* Click Outside Detection Hook
* Detects clicks outside of a referenced element and triggers a handler
*/
import { RefObject, useEffect } from 'react';
/**
* Hook that triggers a handler when user clicks outside the referenced element
* Useful for closing dropdowns, modals, or menus when clicking outside
*
* @param ref - React ref object pointing to the element to monitor
* @param handler - Callback function to execute when click occurs outside the element
*
* @example
* const menuRef = useRef<HTMLDivElement>(null);
* useOnClickOutside(menuRef, () => setMenuOpen(false));
*/
export function useOnClickOutside(ref: RefObject<HTMLElement>, handler: (event: MouseEvent | TouchEvent) => void) {
useEffect(() => {
const listener = (event: MouseEvent | TouchEvent) => {