Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ship-components/ship-components-outsideclick
React component to detect clicks outside of its children
https://github.com/ship-components/ship-components-outsideclick
babel browserify javascript javascript-library jsx react reactjs webpack
Last synced: about 2 months ago
JSON representation
React component to detect clicks outside of its children
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-outsideclick
- Owner: ship-components
- License: mit
- Created: 2015-09-14T19:24:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-02T23:20:05.000Z (over 6 years ago)
- Last Synced: 2024-04-27T00:06:36.703Z (9 months ago)
- Topics: babel, browserify, javascript, javascript-library, jsx, react, reactjs, webpack
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ship-components-outsideclick
- Size: 239 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ship-components-outsideclick
Captures clicks outside of a [React](http://facebook.github.io/react/) component. Exports a commonjs module that can be used with [webpack](http://webpack.github.io/) or [browserify](http://browserify.org/). Source is in ES6 and is compiled down to ES5 using [Babel](https://babeljs.io/).
[](https://www.npmjs.com/package/ship-components-outsideclick)
[](https://travis-ci.org/ship-components/ship-components-outsideclick)
[](https://coveralls.io/github/ship-components/ship-components-outsideclick)
[](https://david-dm.org/ship-components/ship-components-outsideclick?type=dev)
## Usage
### With Babel (Recommended)
The component is written using ES6/JSX therefore Babel is required to directly use it. The below example is based on using [webpack](http://webpack.github.io/) and [babel-loader](https://github.com/babel/babel-loader).
```js
import React from 'react';
import OutsideClick from 'ship-components-outsideclick';
export default class Dialog extends React.Component {
render() {
return (
/**
* Any clicks within this component are ignored. Only clicks outside of it are triggered.
*/
Hello World
);
}
}
```
### Without Babel
A version compiled down to es5 can be found in the `es5/` folder. This can be directly required by another module using webpack or browserify.
```js
var React = require('react');
var OutsideClick = require('ship-components-outsideclick/es5');
var Dialog = React.createClass({
render: function() {
return (
React.createElement('div', {className: 'dialog--overlay'},
React.createElement(OutsideClick, {
onClick: this.props.onCancel
},
React.createElement('div', {className: 'dialog--body'},
"Hello World"
)
)
)
);
}
});
```
## Tests
1. `npm install`
2. `npm test`
## History
* 1.0.1 - Updates for React 16 compatibility
* 1.0.0 - Updates for eslint, banner
* 0.3.0 - Updates to the latest babel configurations (babel-preset-env).
* 0.2.0 - Upgrades to React 15, Adds Travis CI, coverage and ESLint rule
* 0.1.1 - Initial
## License
The MIT License (MIT)
Copyright (c) 2017 Isaac Suttell
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.