https://github.com/souvik666/react-outside-click-hook
A React hook to detect clicks outside of an element. Returns a ref and a boolean indicating if clicked outside. Useful for modals, dropdown menus, and other UI components that need to be hidden when clicked outside.
https://github.com/souvik666/react-outside-click-hook
accessibility hooks outsideclick reactjs
Last synced: 6 months ago
JSON representation
A React hook to detect clicks outside of an element. Returns a ref and a boolean indicating if clicked outside. Useful for modals, dropdown menus, and other UI components that need to be hidden when clicked outside.
- Host: GitHub
- URL: https://github.com/souvik666/react-outside-click-hook
- Owner: souvik666
- Created: 2023-01-26T16:08:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-22T03:05:54.000Z (11 months ago)
- Last Synced: 2025-10-11T01:11:32.521Z (10 months ago)
- Topics: accessibility, hooks, outsideclick, reactjs
- Language: TypeScript
- Homepage: https://souvik666.github.io/react-outside-click-hook/
- Size: 13.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- Security: SECURITY.md
Awesome Lists containing this project
README
## useOutsideClick
A Custom React hook for capturing outside click events. The `useOutsideClick` hook allows you to detect when a user clicks outside of a specific element on your website. It returns a reference to the element, which you can attach to a DOM node using the `ref` attribute, and a boolean indicating whether the user has clicked outside of the element.
## Installation
```bash
npm i @souvik666/react-outside-click-hook
```
## Usage
```tsx
import { useOutsideClick } from "@souvik666/react-outside-click-hook";
const MyComponent = () => {
const [isClickedOutside, ref] = useOutsideClick({
callback: () => console.log("clicked outside"),
});
return (
<>
Click outside of me
{isClickedOutside && clicked outside}
>
);
};
export default MyComponent;
```
## Parameters
| Parameter | Type | Description |
| --------- | -------- | ------------------------------------------------------------------------------------------ |
| callback | function | A function that will be called when a user clicks outside of the element. |
| isOpen | boolean | (optional) A boolean variable that indicate whether the element should be open or closed. |
| return | ref | A ref that should be attached to the DOM element that you want to detect clicks outside of |
Note that, the `isOpen` parameter is optional and you can use it to conditionally render the elements based on whether it's open or closed. If you don't pass this parameter, the hook will assume that the element is always open and will call the callback function whenever a click outside of the element occurs.
Also, the `return` is the `ref` variable that should be attached to the DOM element that you want to detect clicks outside of, you can use this variable to attach to the DOM element using `ref` attribute.
## Example
```tsx
import { useOutsideClick } from "@souvik666/react-outside-click-hook";
const MyComponent = () => {
const [isClickedOutside, ref] = useOutsideClick({
callback: () => console.log("clicked outside"),
});
return (
<>
Click outside of me
{isClickedOutside && clicked outside}
>
);
};
export default MyComponent;
```
## FAQ
`Q: How do I attach the returned ref to a DOM element?`
A: You can attach the ref to a DOM element using the `ref` attribute. For example, if your component has a div that you want to detect clicks outside of, you can do something like this:
```tsx
const ref = useOutsideClick(myCallback);
return
Content goes here;
```
`Q: What is the second parameter for?`
A: The second parameter is an optional boolean that indicates whether the element is open or closed. If you pass `true`, the hook will call the callback function when a click outside of the element occurs. If you pass `false`, the hook will do nothing. If you don't pass this parameter, the hook will assume that the element is always open.
`Q: Can I use this hook with a class component? `
A: No, this hook can only be used in functional components.
### Please note that, you should use this hook in a functional component.