├── .editorconfig
├── .gitattributes
├── .github
├── actions
│ └── setup
│ │ └── action.yml
└── workflows
│ └── ci.yml
├── .gitignore
├── .nvmrc
├── .watchmanconfig
├── .yarnrc
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── babel.config.js
├── example
├── App.js
├── app.json
├── assets
│ ├── adaptive-icon.png
│ ├── favicon.png
│ ├── icon.png
│ └── splash.png
├── babel.config.js
├── metro.config.js
├── package.json
├── src
│ ├── App.tsx
│ ├── Components.tsx
│ ├── DropdownExample.tsx
│ ├── InsideOutsideExample.tsx
│ └── SimpleExample.tsx
├── tsconfig.json
├── webpack.config.js
└── yarn.lock
├── lefthook.yml
├── package.json
├── scripts
└── bootstrap.js
├── src
├── Provider.tsx
├── __tests__
│ └── index.test.tsx
├── index.tsx
├── useClickOutside.ts
├── useFocusEffect.ts
└── utils
│ ├── collection.ts
│ └── helpers.ts
├── tsconfig.build.json
├── tsconfig.json
└── yarn.lock
/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig helps developers define and maintain consistent
2 | # coding styles between different editors and IDEs
3 | # editorconfig.org
4 |
5 | root = true
6 |
7 | [*]
8 |
9 | indent_style = space
10 | indent_size = 2
11 |
12 | end_of_line = lf
13 | charset = utf-8
14 | trim_trailing_whitespace = true
15 | insert_final_newline = true
16 |
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | *.pbxproj -text
2 | # specific for windows script files
3 | *.bat text eol=crlf
--------------------------------------------------------------------------------
/.github/actions/setup/action.yml:
--------------------------------------------------------------------------------
1 | name: Setup
2 | description: Setup Node.js and install dependencies
3 |
4 | runs:
5 | using: composite
6 | steps:
7 | - name: Setup Node.js
8 | uses: actions/setup-node@v3
9 | with:
10 | node-version-file: .nvmrc
11 |
12 | - name: Cache dependencies
13 | id: yarn-cache
14 | uses: actions/cache@v3
15 | with:
16 | path: |
17 | **/node_modules
18 | key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
19 | restore-keys: |
20 | ${{ runner.os }}-yarn-
21 |
22 | - name: Install dependencies
23 | if: steps.yarn-cache.outputs.cache-hit != 'true'
24 | run: |
25 | yarn install --cwd example --frozen-lockfile
26 | yarn install --frozen-lockfile
27 | shell: bash
28 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 | on:
3 | push:
4 | branches:
5 | - main
6 | pull_request:
7 | branches:
8 | - main
9 |
10 | jobs:
11 | lint:
12 | runs-on: ubuntu-latest
13 | steps:
14 | - name: Checkout
15 | uses: actions/checkout@v3
16 |
17 | - name: Setup
18 | uses: ./.github/actions/setup
19 |
20 | - name: Lint files
21 | run: yarn lint
22 |
23 | - name: Typecheck files
24 | run: yarn typecheck
25 |
26 | test:
27 | runs-on: ubuntu-latest
28 | steps:
29 | - name: Checkout
30 | uses: actions/checkout@v3
31 |
32 | - name: Setup
33 | uses: ./.github/actions/setup
34 |
35 | - name: Run unit tests
36 | run: yarn test --maxWorkers=2 --coverage
37 |
38 | build:
39 | runs-on: ubuntu-latest
40 | steps:
41 | - name: Checkout
42 | uses: actions/checkout@v3
43 |
44 | - name: Setup
45 | uses: ./.github/actions/setup
46 |
47 | - name: Build package
48 | run: yarn prepack
49 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # OSX
2 | #
3 | .DS_Store
4 |
5 | # XDE
6 | .expo/
7 |
8 | # VSCode
9 | .vscode/
10 | jsconfig.json
11 |
12 | # Xcode
13 | #
14 | build/
15 | *.pbxuser
16 | !default.pbxuser
17 | *.mode1v3
18 | !default.mode1v3
19 | *.mode2v3
20 | !default.mode2v3
21 | *.perspectivev3
22 | !default.perspectivev3
23 | xcuserdata
24 | *.xccheckout
25 | *.moved-aside
26 | DerivedData
27 | *.hmap
28 | *.ipa
29 | *.xcuserstate
30 | project.xcworkspace
31 |
32 | # Android/IJ
33 | #
34 | .classpath
35 | .cxx
36 | .gradle
37 | .idea
38 | .project
39 | .settings
40 | local.properties
41 | android.iml
42 |
43 | # Cocoapods
44 | #
45 | example/ios/Pods
46 |
47 | # Ruby
48 | example/vendor/
49 |
50 | # node.js
51 | #
52 | node_modules/
53 | npm-debug.log
54 | yarn-debug.log
55 | yarn-error.log
56 |
57 | # BUCK
58 | buck-out/
59 | \.buckd/
60 | android/app/libs
61 | android/keystores/debug.keystore
62 |
63 | # Expo
64 | .expo/
65 |
66 | # Turborepo
67 | .turbo/
68 |
69 | # generated by bob
70 | lib/
71 |
--------------------------------------------------------------------------------
/.nvmrc:
--------------------------------------------------------------------------------
1 | 16.18.1
2 |
--------------------------------------------------------------------------------
/.watchmanconfig:
--------------------------------------------------------------------------------
1 | {}
--------------------------------------------------------------------------------
/.yarnrc:
--------------------------------------------------------------------------------
1 | # Override Yarn command so we can automatically setup the repo on running `yarn`
2 |
3 | yarn-path "scripts/bootstrap.js"
4 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 |
2 | # Contributor Covenant Code of Conduct
3 |
4 | ## Our Pledge
5 |
6 | We as members, contributors, and leaders pledge to make participation in our
7 | community a harassment-free experience for everyone, regardless of age, body
8 | size, visible or invisible disability, ethnicity, sex characteristics, gender
9 | identity and expression, level of experience, education, socio-economic status,
10 | nationality, personal appearance, race, caste, color, religion, or sexual
11 | identity and orientation.
12 |
13 | We pledge to act and interact in ways that contribute to an open, welcoming,
14 | diverse, inclusive, and healthy community.
15 |
16 | ## Our Standards
17 |
18 | Examples of behavior that contributes to a positive environment for our
19 | community include:
20 |
21 | * Demonstrating empathy and kindness toward other people
22 | * Being respectful of differing opinions, viewpoints, and experiences
23 | * Giving and gracefully accepting constructive feedback
24 | * Accepting responsibility and apologizing to those affected by our mistakes,
25 | and learning from the experience
26 | * Focusing on what is best not just for us as individuals, but for the overall
27 | community
28 |
29 | Examples of unacceptable behavior include:
30 |
31 | * The use of sexualized language or imagery, and sexual attention or advances of
32 | any kind
33 | * Trolling, insulting or derogatory comments, and personal or political attacks
34 | * Public or private harassment
35 | * Publishing others' private information, such as a physical or email address,
36 | without their explicit permission
37 | * Other conduct which could reasonably be considered inappropriate in a
38 | professional setting
39 |
40 | ## Enforcement Responsibilities
41 |
42 | Community leaders are responsible for clarifying and enforcing our standards of
43 | acceptable behavior and will take appropriate and fair corrective action in
44 | response to any behavior that they deem inappropriate, threatening, offensive,
45 | or harmful.
46 |
47 | Community leaders have the right and responsibility to remove, edit, or reject
48 | comments, commits, code, wiki edits, issues, and other contributions that are
49 | not aligned to this Code of Conduct, and will communicate reasons for moderation
50 | decisions when appropriate.
51 |
52 | ## Scope
53 |
54 | This Code of Conduct applies within all community spaces, and also applies when
55 | an individual is officially representing the community in public spaces.
56 | Examples of representing our community include using an official e-mail address,
57 | posting via an official social media account, or acting as an appointed
58 | representative at an online or offline event.
59 |
60 | ## Enforcement
61 |
62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
63 | reported to the community leaders responsible for enforcement at
64 | [INSERT CONTACT METHOD].
65 | All complaints will be reviewed and investigated promptly and fairly.
66 |
67 | All community leaders are obligated to respect the privacy and security of the
68 | reporter of any incident.
69 |
70 | ## Enforcement Guidelines
71 |
72 | Community leaders will follow these Community Impact Guidelines in determining
73 | the consequences for any action they deem in violation of this Code of Conduct:
74 |
75 | ### 1. Correction
76 |
77 | **Community Impact**: Use of inappropriate language or other behavior deemed
78 | unprofessional or unwelcome in the community.
79 |
80 | **Consequence**: A private, written warning from community leaders, providing
81 | clarity around the nature of the violation and an explanation of why the
82 | behavior was inappropriate. A public apology may be requested.
83 |
84 | ### 2. Warning
85 |
86 | **Community Impact**: A violation through a single incident or series of
87 | actions.
88 |
89 | **Consequence**: A warning with consequences for continued behavior. No
90 | interaction with the people involved, including unsolicited interaction with
91 | those enforcing the Code of Conduct, for a specified period of time. This
92 | includes avoiding interactions in community spaces as well as external channels
93 | like social media. Violating these terms may lead to a temporary or permanent
94 | ban.
95 |
96 | ### 3. Temporary Ban
97 |
98 | **Community Impact**: A serious violation of community standards, including
99 | sustained inappropriate behavior.
100 |
101 | **Consequence**: A temporary ban from any sort of interaction or public
102 | communication with the community for a specified period of time. No public or
103 | private interaction with the people involved, including unsolicited interaction
104 | with those enforcing the Code of Conduct, is allowed during this period.
105 | Violating these terms may lead to a permanent ban.
106 |
107 | ### 4. Permanent Ban
108 |
109 | **Community Impact**: Demonstrating a pattern of violation of community
110 | standards, including sustained inappropriate behavior, harassment of an
111 | individual, or aggression toward or disparagement of classes of individuals.
112 |
113 | **Consequence**: A permanent ban from any sort of public interaction within the
114 | community.
115 |
116 | ## Attribution
117 |
118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119 | version 2.1, available at
120 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121 |
122 | Community Impact Guidelines were inspired by
123 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124 |
125 | For answers to common questions about this code of conduct, see the FAQ at
126 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127 | [https://www.contributor-covenant.org/translations][translations].
128 |
129 | [homepage]: https://www.contributor-covenant.org
130 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131 | [Mozilla CoC]: https://github.com/mozilla/diversity
132 | [FAQ]: https://www.contributor-covenant.org/faq
133 | [translations]: https://www.contributor-covenant.org/translations
134 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Contributions are always welcome, no matter how large or small!
4 |
5 | We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
6 |
7 | ## Development workflow
8 |
9 | To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
10 |
11 | ```sh
12 | yarn
13 | ```
14 |
15 | > While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
16 |
17 | While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
18 |
19 | To start the packager:
20 |
21 | ```sh
22 | yarn example start
23 | ```
24 |
25 | To run the example app on Android:
26 |
27 | ```sh
28 | yarn example android
29 | ```
30 |
31 | To run the example app on iOS:
32 |
33 | ```sh
34 | yarn example ios
35 | ```
36 |
37 | To run the example app on Web:
38 |
39 | ```sh
40 | yarn example web
41 | ```
42 |
43 | Make sure your code passes TypeScript and ESLint. Run the following to verify:
44 |
45 | ```sh
46 | yarn typecheck
47 | yarn lint
48 | ```
49 |
50 | To fix formatting errors, run the following:
51 |
52 | ```sh
53 | yarn lint --fix
54 | ```
55 |
56 | Remember to add tests for your change if possible. Run the unit tests by:
57 |
58 | ```sh
59 | yarn test
60 | ```
61 |
62 |
63 | ### Commit message convention
64 |
65 | We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
66 |
67 | - `fix`: bug fixes, e.g. fix crash due to deprecated method.
68 | - `feat`: new features, e.g. add new method to the module.
69 | - `refactor`: code refactor, e.g. migrate from class components to hooks.
70 | - `docs`: changes into documentation, e.g. add usage example for the module..
71 | - `test`: adding or updating tests, e.g. add integration tests using detox.
72 | - `chore`: tooling changes, e.g. change CI config.
73 |
74 | Our pre-commit hooks verify that your commit message matches this format when committing.
75 |
76 | ### Linting and tests
77 |
78 | [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
79 |
80 | We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
81 |
82 | Our pre-commit hooks verify that the linter and tests pass when committing.
83 |
84 | ### Publishing to npm
85 |
86 | We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
87 |
88 | To publish new versions, run the following:
89 |
90 | ```sh
91 | yarn release
92 | ```
93 |
94 | ### Scripts
95 |
96 | The `package.json` file contains various scripts for common tasks:
97 |
98 | - `yarn bootstrap`: setup project by installing all dependencies and pods.
99 | - `yarn typecheck`: type-check files with TypeScript.
100 | - `yarn lint`: lint files with ESLint.
101 | - `yarn test`: run unit tests with Jest.
102 | - `yarn example start`: start the Metro server for the example app.
103 | - `yarn example android`: run the example app on Android.
104 | - `yarn example ios`: run the example app on iOS.
105 |
106 | ### Sending a pull request
107 |
108 | > **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
109 |
110 | When you're sending a pull request:
111 |
112 | - Prefer small pull requests focused on one change.
113 | - Verify that linters and tests are passing.
114 | - Review the documentation to make sure it looks good.
115 | - Follow the pull request template when opening a pull request.
116 | - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
117 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2022 Jakub Grzywacz
4 | Permission is hereby granted, free of charge, to any person obtaining a copy
5 | of this software and associated documentation files (the "Software"), to deal
6 | in the Software without restriction, including without limitation the rights
7 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 | copies of the Software, and to permit persons to whom the Software is
9 | furnished to do so, subject to the following conditions:
10 |
11 | The above copyright notice and this permission notice shall be included in all
12 | copies or substantial portions of the Software.
13 |
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 | SOFTWARE.
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # react-native-click-outside
2 |
3 | React Native library to detect clicks outside the component 👆
4 |
5 |
6 | 
7 | 
8 | 
9 | 
10 |
11 |
12 | ## 🪄 Installation
13 |
14 | ```sh
15 | yarn add react-native-click-outside
16 | ```
17 |
18 | ## 📖 Usage
19 |
20 | First of all, you need to wrap your app with `ClickOutsideProvider` as high as possible, for example in `App.tsx`:
21 |
22 | ```tsx
23 | import { ClickOutsideProvider } from 'react-native-click-outside';
24 |
25 | export const App = () => (
26 |
27 | { /* rest of your app */ }
28 |
29 | );
30 | ```
31 |
32 | Then you can call `useClickOutside` hook to detect clicks outside the component. First argument is the function that will be called every time user clicks outside of this component. It returns `ref` that you need to attach to the component you want to detect clicks outside of. For example:
33 |
34 | ```tsx
35 | import { useClickOutside } from 'react-native-click-outside';
36 |
37 | export default function MyComponent() {
38 | const ref = useClickOutside(() => console.log('clicked outside A'));
39 | return (
40 |
41 | Test
42 |
43 | );
44 | }
45 | ```
46 |
47 | ## 🛠️ Troubleshooting
48 |
49 | ### iOS works fine, but Android doesn't
50 | As stated in react-native docs, on Android
51 |
52 | > Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization.
53 |
54 | _Source: https://reactnative.dev/docs/view#collapsable-android_
55 |
56 | If your element is collapsable, it won't be rendered, and therefore you won't be able to detect clicks outside of it.
57 | To prevent this, you need to add `collapsable={false}` prop to the component. For example:
58 |
59 | ```tsx
60 | const ref = useClickOutside(() => console.log('clicked outside'));
61 |
62 | Test
63 |
64 | ```
65 |
66 | ## ⚖️ License
67 |
68 | **[MIT](/LICENSE)**
69 |
70 | ## 📝 Contribute
71 |
72 | See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
73 |
74 |
75 | ### Built with ♥️ by Jakub Grzywacz
76 |
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: ['module:metro-react-native-babel-preset'],
3 | };
4 |
--------------------------------------------------------------------------------
/example/App.js:
--------------------------------------------------------------------------------
1 | export { default } from './src/App';
2 |
--------------------------------------------------------------------------------
/example/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "expo": {
3 | "name": "example",
4 | "slug": "example",
5 | "version": "1.0.0",
6 | "orientation": "portrait",
7 | "icon": "./assets/icon.png",
8 | "userInterfaceStyle": "light",
9 | "splash": {
10 | "image": "./assets/splash.png",
11 | "resizeMode": "contain",
12 | "backgroundColor": "#ffffff"
13 | },
14 | "updates": {
15 | "fallbackToCacheTimeout": 0
16 | },
17 | "assetBundlePatterns": [
18 | "**/*"
19 | ],
20 | "ios": {
21 | "supportsTablet": true
22 | },
23 | "android": {
24 | "adaptiveIcon": {
25 | "foregroundImage": "./assets/adaptive-icon.png",
26 | "backgroundColor": "#FFFFFF"
27 | }
28 | },
29 | "web": {
30 | "favicon": "./assets/favicon.png"
31 | }
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/example/assets/adaptive-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jakex7/react-native-click-outside/c2d144b0a95b87a6d1bc839f06af4cb031f9061d/example/assets/adaptive-icon.png
--------------------------------------------------------------------------------
/example/assets/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jakex7/react-native-click-outside/c2d144b0a95b87a6d1bc839f06af4cb031f9061d/example/assets/favicon.png
--------------------------------------------------------------------------------
/example/assets/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jakex7/react-native-click-outside/c2d144b0a95b87a6d1bc839f06af4cb031f9061d/example/assets/icon.png
--------------------------------------------------------------------------------
/example/assets/splash.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jakex7/react-native-click-outside/c2d144b0a95b87a6d1bc839f06af4cb031f9061d/example/assets/splash.png
--------------------------------------------------------------------------------
/example/babel.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 | const pak = require('../package.json');
3 |
4 | module.exports = function (api) {
5 | api.cache(true);
6 |
7 | return {
8 | presets: ['babel-preset-expo'],
9 | plugins: [
10 | [
11 | 'module-resolver',
12 | {
13 | extensions: ['.tsx', '.ts', '.js', '.json'],
14 | alias: {
15 | // For development, we want to alias the library to the source
16 | [pak.name]: path.join(__dirname, '..', pak.source),
17 | },
18 | },
19 | ],
20 | ],
21 | };
22 | };
23 |
--------------------------------------------------------------------------------
/example/metro.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 | const escape = require('escape-string-regexp');
3 | const { getDefaultConfig } = require('@expo/metro-config');
4 | const exclusionList = require('metro-config/src/defaults/exclusionList');
5 | const pak = require('../package.json');
6 |
7 | const root = path.resolve(__dirname, '..');
8 |
9 | const modules = Object.keys({
10 | ...pak.peerDependencies,
11 | });
12 |
13 | const defaultConfig = getDefaultConfig(__dirname);
14 |
15 | module.exports = {
16 | ...defaultConfig,
17 |
18 | projectRoot: __dirname,
19 | watchFolders: [root],
20 |
21 | // We need to make sure that only one version is loaded for peerDependencies
22 | // So we block them at the root, and alias them to the versions in example's node_modules
23 | resolver: {
24 | ...defaultConfig.resolver,
25 |
26 | blacklistRE: exclusionList(modules.map((m) => new RegExp(`^${escape(path.join(root, 'node_modules', m))}\\/.*$`))),
27 |
28 | extraNodeModules: modules.reduce((acc, name) => {
29 | acc[name] = path.join(__dirname, 'node_modules', name);
30 | return acc;
31 | }, {}),
32 | },
33 | };
34 |
--------------------------------------------------------------------------------
/example/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "example",
3 | "version": "1.0.0",
4 | "main": "node_modules/expo/AppEntry.js",
5 | "scripts": {
6 | "start": "expo start",
7 | "android": "expo start --android",
8 | "ios": "expo start --ios",
9 | "web": "expo start --web"
10 | },
11 | "dependencies": {
12 | "expo": "~49.0.3",
13 | "expo-status-bar": "~1.6.0",
14 | "react": "18.2.0",
15 | "react-dom": "18.2.0",
16 | "react-native": "0.72.3",
17 | "react-native-web": "~0.19.6"
18 | },
19 | "devDependencies": {
20 | "@babel/core": "^7.20.0",
21 | "@expo/webpack-config": "^0.17.2",
22 | "babel-loader": "^8.1.0",
23 | "babel-plugin-module-resolver": "^4.1.0"
24 | },
25 | "private": true
26 | }
27 |
--------------------------------------------------------------------------------
/example/src/App.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react';
2 |
3 | import { StyleSheet, Text, TouchableOpacity, SafeAreaView, ScrollView } from 'react-native';
4 | import { SimpleExample } from './SimpleExample';
5 | import { DropdownExample } from './DropdownExample';
6 | import { InsideOutsideExample } from './InsideOutsideExample';
7 |
8 | const stages = ['simple', 'click inside/outside', 'dropdown'] as const;
9 | export default function App() {
10 | const [stage, setStage] = React.useState<(typeof stages)[number] | undefined>();
11 | if (stage === 'simple') return ;
12 | if (stage === 'dropdown') return ;
13 | if (stage === 'click inside/outside') return ;
14 | return (
15 |
16 | react-native-click-outside
17 |
18 | {stages.map((s) => (
19 | setStage(s)} key={s} style={styles.button}>
20 | {s}
21 |
22 | ))}
23 |
24 |
25 | );
26 | }
27 |
28 | const styles = StyleSheet.create({
29 | container: { flex: 1 },
30 | header: { textAlign: 'center', fontSize: 24, margin: 16 },
31 | button: {
32 | marginBottom: 16,
33 | marginHorizontal: 16,
34 | justifyContent: 'center',
35 | alignItems: 'center',
36 | backgroundColor: '#34495E',
37 | padding: 16,
38 | borderRadius: 8,
39 | },
40 | label: { color: '#FFF', fontWeight: 'bold', textTransform: 'capitalize' },
41 | });
42 |
--------------------------------------------------------------------------------
/example/src/Components.tsx:
--------------------------------------------------------------------------------
1 | import { StyleSheet, Text } from 'react-native';
2 | import * as React from 'react';
3 |
4 | export const Note = ({ children }: { children: React.ReactNode }) => Note: {children};
5 |
6 | const styles = StyleSheet.create({
7 | note: { margin: 30, textAlign: 'center', fontStyle: 'italic' },
8 | });
9 |
--------------------------------------------------------------------------------
/example/src/DropdownExample.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react';
2 |
3 | import { StyleSheet, View, Text, Button, TouchableOpacity } from 'react-native';
4 | import { ClickOutsideProvider, useClickOutside } from 'react-native-click-outside';
5 | import { Note } from './Components';
6 |
7 | const options = ['One', 'Two', 'Three'];
8 | export const DropdownExample = () => {
9 | const ref = useClickOutside(() => setIsOpen(false));
10 | const [isOpen, setIsOpen] = React.useState(false);
11 | const [selected, setSelected] = React.useState();
12 | return (
13 |
14 |
15 |
41 |
42 | );
43 | };
44 |
45 | const styles = StyleSheet.create({
46 | container: {
47 | flex: 1,
48 | justifyContent: 'center',
49 | padding: 16,
50 | },
51 | dropdownContainer: {
52 | backgroundColor: '#ECF0F1',
53 | borderWidth: 2,
54 | borderColor: '#3498DB',
55 | borderRadius: 8,
56 | },
57 | selected: {
58 | fontWeight: 'bold',
59 | padding: 16,
60 | },
61 | item: { padding: 16 },
62 | });
63 |
--------------------------------------------------------------------------------
/example/src/InsideOutsideExample.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react';
2 |
3 | import { StyleSheet, View, Text, TouchableOpacity } from 'react-native';
4 | import { ClickOutsideProvider, useClickOutside } from 'react-native-click-outside';
5 | import { Note } from './Components';
6 |
7 | export const InsideOutsideExample = () => {
8 | const ref = useClickOutside(() => setResults('outside'), { triggerOnBlur: true });
9 | const [results, setResults] = React.useState();
10 |
11 | return (
12 |
13 |
14 | Clicked: {results || 'none'}
15 | setResults('inside')} />
16 | You can detect clicks outside of the component.
17 |
18 |
19 | );
20 | };
21 |
22 | const styles = StyleSheet.create({
23 | container: {
24 | flex: 1,
25 | alignItems: 'center',
26 | justifyContent: 'center',
27 | padding: 16,
28 | },
29 | box: {
30 | width: 100,
31 | height: 100,
32 | marginVertical: 20,
33 | backgroundColor: '#2ECC71',
34 | borderRadius: 8,
35 | },
36 | });
37 |
--------------------------------------------------------------------------------
/example/src/SimpleExample.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react';
2 |
3 | import { StyleSheet, View, Text } from 'react-native';
4 | import { ClickOutsideProvider, useClickOutside } from 'react-native-click-outside';
5 | import { Note } from './Components';
6 |
7 | export const SimpleExample = () => {
8 | const refA = useClickOutside(() => console.log('clicked outside A'));
9 | const refB = useClickOutside(() => console.log('clicked outside B'));
10 | return (
11 |
12 |
13 | AAAAAAA
14 | BBBBBBB
15 | Press inside/outside Text component and see console for the results
16 |
17 |
18 | );
19 | };
20 |
21 | const styles = StyleSheet.create({
22 | container: {
23 | flex: 1,
24 | alignItems: 'center',
25 | justifyContent: 'center',
26 | },
27 | });
28 |
--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig",
3 | "compilerOptions": {
4 | // Avoid expo-cli auto-generating a tsconfig
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/example/webpack.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 | const createExpoWebpackConfigAsync = require('@expo/webpack-config');
3 | const { resolver } = require('./metro.config');
4 |
5 | const root = path.resolve(__dirname, '..');
6 | const node_modules = path.join(__dirname, 'node_modules');
7 |
8 | module.exports = async function (env, argv) {
9 | const config = await createExpoWebpackConfigAsync(env, argv);
10 |
11 | config.module.rules.push({
12 | test: /\.(js|jsx|ts|tsx)$/,
13 | include: path.resolve(root, 'src'),
14 | use: 'babel-loader',
15 | });
16 |
17 | // We need to make sure that only one version is loaded for peerDependencies
18 | // So we alias them to the versions in example's node_modules
19 | Object.assign(config.resolve.alias, {
20 | ...resolver.extraNodeModules,
21 | 'react-native-web': path.join(node_modules, 'react-native-web'),
22 | });
23 |
24 | return config;
25 | };
26 |
--------------------------------------------------------------------------------
/lefthook.yml:
--------------------------------------------------------------------------------
1 | pre-commit:
2 | parallel: true
3 | commands:
4 | lint:
5 | files: git diff --name-only @{push}
6 | glob: "*.{js,ts,jsx,tsx}"
7 | run: npx eslint {files}
8 | types:
9 | files: git diff --name-only @{push}
10 | glob: "*.{js,ts, jsx, tsx}"
11 | run: npx tsc --noEmit
12 | commit-msg:
13 | parallel: true
14 | commands:
15 | commitlint:
16 | run: npx commitlint --edit
17 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "react-native-click-outside",
3 | "version": "0.1.1",
4 | "description": "React Native library to detect clicks outside the component 👆",
5 | "main": "lib/commonjs/index",
6 | "module": "lib/module/index",
7 | "types": "lib/typescript/index.d.ts",
8 | "react-native": "src/index",
9 | "source": "src/index",
10 | "files": [
11 | "src",
12 | "lib",
13 | "android",
14 | "ios",
15 | "cpp",
16 | "*.podspec",
17 | "!lib/typescript/example",
18 | "!ios/build",
19 | "!android/build",
20 | "!android/gradle",
21 | "!android/gradlew",
22 | "!android/gradlew.bat",
23 | "!android/local.properties",
24 | "!**/__tests__",
25 | "!**/__fixtures__",
26 | "!**/__mocks__",
27 | "!**/.*"
28 | ],
29 | "scripts": {
30 | "test": "jest",
31 | "typecheck": "tsc --noEmit",
32 | "lint": "eslint \"**/*.{js,ts,tsx}\"",
33 | "prepack": "bob build",
34 | "release": "release-it",
35 | "example": "yarn --cwd example",
36 | "bootstrap": "yarn example && yarn install"
37 | },
38 | "keywords": [
39 | "react-native",
40 | "ios",
41 | "android"
42 | ],
43 | "repository": "https://github.com/jakex7/react-native-click-outside",
44 | "author": "Jakub Grzywacz (https://github.com/jakex7)",
45 | "license": "MIT",
46 | "bugs": {
47 | "url": "https://github.com/jakex7/react-native-click-outside/issues"
48 | },
49 | "homepage": "https://github.com/jakex7/react-native-click-outside#readme",
50 | "publishConfig": {
51 | "registry": "https://registry.npmjs.org/"
52 | },
53 | "devDependencies": {
54 | "@evilmartians/lefthook": "^1.2.2",
55 | "@commitlint/config-conventional": "^17.0.2",
56 | "@react-native-community/eslint-config": "^3.0.2",
57 | "@release-it/conventional-changelog": "^5.0.0",
58 | "@types/jest": "^28.1.2",
59 | "@types/react": "~17.0.21",
60 | "@types/react-native": "0.70.0",
61 | "commitlint": "^17.0.2",
62 | "del-cli": "^5.0.0",
63 | "eslint": "^8.4.1",
64 | "eslint-config-prettier": "^8.5.0",
65 | "eslint-plugin-prettier": "^4.0.0",
66 | "jest": "^28.1.1",
67 | "pod-install": "^0.1.0",
68 | "prettier": "^2.0.5",
69 | "react": "18.1.0",
70 | "react-native": "0.70.5",
71 | "react-native-builder-bob": "^0.20.0",
72 | "release-it": "^15.0.0",
73 | "typescript": "^4.5.2"
74 | },
75 | "resolutions": {
76 | "@types/react": "17.0.21"
77 | },
78 | "peerDependencies": {
79 | "react": "*",
80 | "react-native": "*"
81 | },
82 | "engines": {
83 | "node": ">= 16.0.0"
84 | },
85 | "packageManager": "^yarn@1.22.15",
86 | "jest": {
87 | "preset": "react-native",
88 | "modulePathIgnorePatterns": [
89 | "/example/node_modules",
90 | "/lib/"
91 | ]
92 | },
93 | "commitlint": {
94 | "extends": [
95 | "@commitlint/config-conventional"
96 | ]
97 | },
98 | "release-it": {
99 | "git": {
100 | "commitMessage": "chore: release ${version}",
101 | "tagName": "v${version}"
102 | },
103 | "npm": {
104 | "publish": true
105 | },
106 | "github": {
107 | "release": true
108 | },
109 | "plugins": {
110 | "@release-it/conventional-changelog": {
111 | "preset": "angular"
112 | }
113 | }
114 | },
115 | "eslintConfig": {
116 | "root": true,
117 | "extends": [
118 | "@react-native-community",
119 | "prettier"
120 | ],
121 | "rules": {
122 | "prettier/prettier": [
123 | "error",
124 | {
125 | "quoteProps": "consistent",
126 | "singleQuote": true,
127 | "tabWidth": 2,
128 | "trailingComma": "es5",
129 | "useTabs": false,
130 | "printWidth": 120
131 | }
132 | ]
133 | }
134 | },
135 | "eslintIgnore": [
136 | "node_modules/",
137 | "lib/"
138 | ],
139 | "prettier": {
140 | "quoteProps": "consistent",
141 | "singleQuote": true,
142 | "tabWidth": 2,
143 | "trailingComma": "es5",
144 | "useTabs": false,
145 | "printWidth": 120
146 | },
147 | "react-native-builder-bob": {
148 | "source": "src",
149 | "output": "lib",
150 | "targets": [
151 | "commonjs",
152 | "module",
153 | [
154 | "typescript",
155 | {
156 | "project": "tsconfig.build.json"
157 | }
158 | ]
159 | ]
160 | }
161 | }
162 |
--------------------------------------------------------------------------------
/scripts/bootstrap.js:
--------------------------------------------------------------------------------
1 | const os = require('os');
2 | const path = require('path');
3 | const child_process = require('child_process');
4 |
5 | const root = path.resolve(__dirname, '..');
6 | const args = process.argv.slice(2);
7 | const options = {
8 | cwd: process.cwd(),
9 | env: process.env,
10 | stdio: 'inherit',
11 | encoding: 'utf-8',
12 | };
13 |
14 | if (os.type() === 'Windows_NT') {
15 | options.shell = true;
16 | }
17 |
18 | let result;
19 |
20 | if (process.cwd() !== root || args.length) {
21 | // We're not in the root of the project, or additional arguments were passed
22 | // In this case, forward the command to `yarn`
23 | result = child_process.spawnSync('yarn', args, options);
24 | } else {
25 | // If `yarn` is run without arguments, perform bootstrap
26 | result = child_process.spawnSync('yarn', ['bootstrap'], options);
27 | }
28 |
29 | process.exitCode = result.status;
30 |
--------------------------------------------------------------------------------
/src/Provider.tsx:
--------------------------------------------------------------------------------
1 | import React, { FC } from 'react';
2 | import { GestureResponderEvent, Platform, StyleSheet, View } from 'react-native';
3 | import { onTouch, setIsTouch } from './utils/collection';
4 | import { isInRange } from './utils/helpers';
5 |
6 | type ClickOutsideProviderProps = {
7 | activateOnSwipe?: boolean;
8 | swipeThreshold?: number;
9 | children: React.ReactNode;
10 | };
11 |
12 | let touchX: number | undefined;
13 | let touchY: number | undefined;
14 | export const ClickOutsideProvider: FC = ({
15 | children,
16 | activateOnSwipe,
17 | swipeThreshold = 8,
18 | }) => (
19 | {
22 | if (!touchX) touchX = e.nativeEvent.changedTouches[0]?.pageX;
23 | if (!touchY) touchY = e.nativeEvent.changedTouches[0]?.pageY;
24 | if (!e.nativeEvent.changedTouches[0] || !touchX || !touchY) return;
25 | if (
26 | isInRange(e.nativeEvent.changedTouches[0]?.pageX, touchX, swipeThreshold) &&
27 | isInRange(e.nativeEvent.changedTouches[0]?.pageY, touchY, swipeThreshold)
28 | )
29 | setIsTouch(true);
30 | else if (activateOnSwipe) setIsTouch(true);
31 | else setIsTouch(false);
32 | onTouch(e);
33 | touchX = undefined;
34 | touchY = undefined;
35 | }}
36 | onTouchStart={(e) => {
37 | touchX = e.nativeEvent.changedTouches[0]?.pageX;
38 | touchY = e.nativeEvent.changedTouches[0]?.pageY;
39 | setIsTouch(true);
40 | }}
41 | {...(Platform.OS === 'web' && {
42 | onClick: (e: GestureResponderEvent) => {
43 | setIsTouch(true);
44 | onTouch(e);
45 | },
46 | })}
47 | >
48 | {children}
49 |
50 | );
51 |
52 | const styles = StyleSheet.create({
53 | flex: { flex: 1 },
54 | });
55 |
--------------------------------------------------------------------------------
/src/__tests__/index.test.tsx:
--------------------------------------------------------------------------------
1 | it.todo('write a test');
2 |
--------------------------------------------------------------------------------
/src/index.tsx:
--------------------------------------------------------------------------------
1 | export { useClickOutside } from './useClickOutside';
2 | export { ClickOutsideProvider } from './Provider';
3 |
--------------------------------------------------------------------------------
/src/useClickOutside.ts:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import type { View } from 'react-native';
3 | import { register, unregister } from './utils/collection';
4 | import { useFocusEffect } from './useFocusEffect';
5 |
6 | type HookConfig = {
7 | triggerOnUnmount?: boolean;
8 | triggerOnBlur?: boolean;
9 | };
10 |
11 | export const useClickOutside = (callback: () => void, config?: HookConfig): React.RefObject => {
12 | const callbackRef = React.useRef(callback);
13 | callbackRef.current = callback;
14 | const callbackRegisterWrapper = () => callbackRef.current();
15 |
16 | const ref = React.useRef(null);
17 |
18 | useFocusEffect(
19 | () => {
20 | if (config?.triggerOnBlur === false) return;
21 | register(ref, callbackRegisterWrapper);
22 | },
23 | () => {
24 | if (config?.triggerOnBlur === false) return;
25 | callbackRegisterWrapper();
26 | unregister(ref);
27 | }
28 | );
29 | React.useEffect(() => {
30 | register(ref, callbackRegisterWrapper);
31 | return () => {
32 | unregister(ref);
33 | if (config?.triggerOnUnmount === false) return;
34 | callbackRegisterWrapper();
35 | };
36 | }, [config?.triggerOnUnmount]);
37 |
38 | return ref;
39 | };
40 |
--------------------------------------------------------------------------------
/src/useFocusEffect.ts:
--------------------------------------------------------------------------------
1 | import { useCallback, useEffect, useRef } from 'react';
2 | import { AppState, AppStateStatus } from 'react-native';
3 |
4 | export const useFocusEffect = (activeCallback: () => void, inactiveCallback: () => void) => {
5 | const appState = useRef(AppState.currentState);
6 | const _handleAppStateChange = useCallback(
7 | (nextAppState: AppStateStatus) => {
8 | if (appState.current.match(/inactive|background/) && nextAppState === 'active') {
9 | activeCallback();
10 | }
11 | if (appState.current === 'active' && nextAppState.match(/inactive|background/)) {
12 | inactiveCallback();
13 | }
14 | appState.current = nextAppState;
15 | },
16 | [activeCallback, inactiveCallback]
17 | );
18 | useEffect(() => {
19 | const listener = AppState.addEventListener('change', _handleAppStateChange);
20 | return () => {
21 | listener.remove();
22 | };
23 | }, [_handleAppStateChange]);
24 | };
25 |
--------------------------------------------------------------------------------
/src/utils/collection.ts:
--------------------------------------------------------------------------------
1 | import type { Ref } from 'react';
2 | import type { GestureResponderEvent } from 'react-native';
3 |
4 | export type ComponentRef = Ref;
5 |
6 | let collection: { ref: ComponentRef; cb: () => void }[] = [];
7 |
8 | export let isTouch: boolean | undefined;
9 | export const setIsTouch = (value: boolean) => (isTouch = value);
10 |
11 | export const onTouch = (event: GestureResponderEvent) => {
12 | if (!isTouch) return;
13 | const { pageX, pageY } = event.nativeEvent;
14 | collection.forEach((item) => {
15 | // @ts-ignore
16 | item.ref?.current?.measure((_x, _y, width: number, height: number, x: number, y: number) => {
17 | if (pageX < x || pageX > x + width || pageY < y || pageY > y + height) item.cb();
18 | });
19 | });
20 | isTouch = undefined;
21 | };
22 |
23 | export const register: (ref: ComponentRef, cb: () => void) => void = (ref, cb) => {
24 | if (collection.find((c) => c.ref === ref)) return;
25 | collection.push({ ref, cb });
26 | };
27 |
28 | export const unregister: (ref: ComponentRef) => void = (refToRemove) =>
29 | (collection = collection.filter(({ ref }) => ref !== refToRemove));
30 |
--------------------------------------------------------------------------------
/src/utils/helpers.ts:
--------------------------------------------------------------------------------
1 | export const isInRange = (value: number, target: number, threshold: number) =>
2 | value < target + threshold && value > target - threshold;
3 |
--------------------------------------------------------------------------------
/tsconfig.build.json:
--------------------------------------------------------------------------------
1 |
2 | {
3 | "extends": "./tsconfig",
4 | "exclude": ["example"]
5 | }
6 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "baseUrl": "./",
4 | "paths": {
5 | "react-native-click-outside": ["./src/index"]
6 | },
7 | "allowUnreachableCode": false,
8 | "allowUnusedLabels": false,
9 | "esModuleInterop": true,
10 | "importsNotUsedAsValues": "error",
11 | "forceConsistentCasingInFileNames": true,
12 | "jsx": "react",
13 | "lib": ["esnext"],
14 | "module": "esnext",
15 | "moduleResolution": "node",
16 | "noFallthroughCasesInSwitch": true,
17 | "noImplicitReturns": true,
18 | "noImplicitUseStrict": false,
19 | "noStrictGenericChecks": false,
20 | "noUncheckedIndexedAccess": true,
21 | "noUnusedLocals": true,
22 | "noUnusedParameters": true,
23 | "resolveJsonModule": true,
24 | "skipLibCheck": true,
25 | "strict": true,
26 | "target": "esnext"
27 | }
28 | }
29 |
--------------------------------------------------------------------------------