diff --git a/src/components/utils/useOnClickOutside/useOnClickOutside.tsx b/src/components/utils/useOnClickOutside/useOnClickOutside.tsx index e3be395fcb..7bd9c3bc79 100644 --- a/src/components/utils/useOnClickOutside/useOnClickOutside.tsx +++ b/src/components/utils/useOnClickOutside/useOnClickOutside.tsx @@ -9,6 +9,15 @@ export type UseOnClickOutsideType = ({ 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,