Add a click listener to fire a callback for everywhere on the window except your chosen element.
Installation
- run
npm install @lukeboyle/when-clicked-outside
Basic Usage
// ES6
import whenClickedOutside from '@lukeboyle/when-clicked-outside';
// CommonJs
const whenClickedOutside = require('@lukeboyle/when-clicked-outside');
whenClickedOutside('#element', whenClickedOutsideCallback, {});
function whenClickedOutsideCallback(event) {
console.log('hello');
}
Advanced Usage
// ES6
import whenClickedOutside from '@lukeboyle/when-clicked-outside';
// CommonJs
const whenClickedOutside = require('@lukeboyle/when-clicked-outside');
const listener = whenClickedOutside('#element', whenClickedOutsideCallback, {});
function whenClickedOutsideCallback(event) {
console.log('hello');
listener.destroy();
}
API
whenClickedOutside
Arguments
Element
Type: querySelector String OR HTMLElement
e.g. 'body', '.class-name', '#id', document.getElementById('id')
Callback
Type: Function
Config
Type: Object
To set the standard addEventListener, add an 'options' element to the config object
Returns
Returns an object with a reference to your element, and a destroy function to remove the listener.
Changelog
2.0.5
- fix: add missing dependency
2.0.4
- fix: remove reference to window.event to address a bug in firefox
2.0.3
- fix: add explicit reference to the
MouseEventin click verification function
2.0.2
- docs: update the readme with commonJs require
2.0.1
- fix: build issue when publishing
2.0.0
- breaking change: Export whenClickedOutside by default
1.0.2
- refactor: tidy verifyElementExists function
1.0.1
- fix: add error handling for incorrect types
- fix: add error handling for non-existent elements
253 Dec 28, 2022
14 Dec 9, 2022
4 Jun 23, 2022
1.1k Jan 7, 2023
2 Sep 5, 2022
16 Dec 15, 2022
4 Aug 28, 2022
9 Sep 12, 2022
2 Oct 30, 2020
95 Aug 17, 2022
5 Oct 23, 2022
50 Aug 16, 2022
10 Jan 8, 2023
15 Oct 2, 2022
118 Sep 8, 2022
623 Dec 26, 2022
1 Mar 26, 2022
4 Oct 18, 2022
370 Nov 5, 2022