-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #109 from heyjul3s/chore/bundle-size-reduction
Chore/bundle size reduction
- Loading branch information
Showing
3 changed files
with
26 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,29 @@ | ||
# `@artifak/useclickaway` | ||
|
||
> TODO: description | ||
A React hook to trigger a callback when a click event occurs on a target that is not the specified ref HTML element. | ||
|
||
## Usage | ||
|
||
``` | ||
const useclickaway = require('@artifak/useclickaway'); | ||
```ts | ||
import React from 'react'; | ||
import { useClickAway } from '@artifak/useclickaway; | ||
|
||
const Dummy = () => { | ||
const ref: React.RefObject<HTMLDivElement> = React.createRef(); | ||
|
||
const onClickAway = () => { | ||
console.log('Clicked'); | ||
}; | ||
|
||
useClickAway(ref, onClickAway); | ||
|
||
// TODO: DEMONSTRATE API | ||
return ( | ||
<div> | ||
Wrapper | ||
<div ref={ref}> | ||
Click Me | ||
</div> | ||
</div> | ||
); | ||
}; | ||
``` |