{"id":19852992,"url":"https://github.com/ship-components/ship-components-outsideclick","last_synced_at":"2026-04-09T22:32:55.037Z","repository":{"id":57146191,"uuid":"42471622","full_name":"ship-components/ship-components-outsideclick","owner":"ship-components","description":"React component to detect clicks outside of its children","archived":false,"fork":false,"pushed_at":"2018-05-02T23:20:05.000Z","size":245,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-27T00:06:36.703Z","etag":null,"topics":["babel","browserify","javascript","javascript-library","jsx","react","reactjs","webpack"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ship-components-outsideclick","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ship-components.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-14T19:24:53.000Z","updated_at":"2018-05-02T23:20:07.000Z","dependencies_parsed_at":"2022-09-05T14:02:00.671Z","dependency_job_id":null,"html_url":"https://github.com/ship-components/ship-components-outsideclick","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-outsideclick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-outsideclick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-outsideclick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ship-components%2Fship-components-outsideclick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ship-components","download_url":"https://codeload.github.com/ship-components/ship-components-outsideclick/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241241900,"owners_count":19932839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","browserify","javascript","javascript-library","jsx","react","reactjs","webpack"],"created_at":"2024-11-12T14:05:08.034Z","updated_at":"2026-04-09T22:32:50.018Z","avatar_url":"https://github.com/ship-components.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ship-components-outsideclick\nCaptures 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/).\n\n[![npm](https://img.shields.io/npm/v/ship-components-outsideclick.svg?maxAge=2592000)](https://www.npmjs.com/package/ship-components-outsideclick)\n[![Build Status](http://img.shields.io/travis/ship-components/ship-components-dropdown-menu/master.svg?style=flat)](https://travis-ci.org/ship-components/ship-components-outsideclick)\n[![Coverage](http://img.shields.io/coveralls/ship-components/ship-components-outsideclick.svg?style=flat)](https://coveralls.io/github/ship-components/ship-components-outsideclick)\n[![devDependencies](https://img.shields.io/david/dev/ship-components/ship-components-outsideclick.svg?style=flat)](https://david-dm.org/ship-components/ship-components-outsideclick?type=dev)\n\n## Usage\n\n### With Babel (Recommended)\nThe 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).\n```js\nimport React from 'react';\nimport OutsideClick from 'ship-components-outsideclick';\n\nexport default class Dialog extends React.Component {\n  render() {\n    return (\n      \u003cdiv className='dialog--overlay'\u003e\n        /**\n         * Any clicks within this component are ignored. Only clicks outside of it are triggered.\n         */\n        \u003cOutsideClick\n          tag='div'\n          className='dialog--container'\n          onClick={this.props.onCancel}\n        \u003e\n          \u003cdiv className='dialog--body'\u003e\n            Hello World\n          \u003c/div\u003e\n        \u003c/OutsideClick\u003e\n      \u003c/div\u003e\n    );\n  }\n}\n```\n\n### Without Babel\nA version compiled down to es5 can be found in the `es5/` folder. This can be directly required by another module using webpack or browserify.\n\n```js\nvar React = require('react');\nvar OutsideClick = require('ship-components-outsideclick/es5');\n\nvar Dialog = React.createClass({\n  render: function() {\n    return (\n      React.createElement('div', {className: 'dialog--overlay'},\n        React.createElement(OutsideClick, {\n          onClick: this.props.onCancel\n        },\n          React.createElement('div', {className: 'dialog--body'},\n            \"Hello World\"\n          )\n        )\n      )\n    );\n  }\n});\n```\n\n## Tests\n\n1. `npm install`\n2. `npm test`\n\n## History\n* 1.0.1 - Updates for React 16 compatibility\n* 1.0.0 - Updates for eslint, banner\n* 0.3.0 - Updates to the latest babel configurations (babel-preset-env).\n* 0.2.0 - Upgrades to React 15, Adds Travis CI, coverage and ESLint rule\n* 0.1.1 - Initial\n\n## License\nThe MIT License (MIT)\n\nCopyright (c) 2017 Isaac Suttell\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fship-components%2Fship-components-outsideclick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fship-components%2Fship-components-outsideclick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fship-components%2Fship-components-outsideclick/lists"}