├── .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 ├── docs └── preview.gif ├── 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 │ │ ├── ContentCard.tsx │ │ └── TextInput.tsx │ ├── navigation │ │ └── MainStackNavigator.tsx │ └── screens │ │ ├── Home.tsx │ │ └── SecondScreen.tsx ├── tsconfig.json ├── webpack.config.js └── yarn.lock ├── package.json ├── scripts └── bootstrap.js ├── src ├── KeyboardScrollView.tsx └── index.tsx ├── 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') }}-${{ hashFiles('**/package.json') }} 19 | restore-keys: | 20 | ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} 21 | ${{ runner.os }}-yarn- 22 | 23 | - name: Install dependencies 24 | if: steps.yarn-cache.outputs.cache-hit != 'true' 25 | run: | 26 | yarn install --cwd example --frozen-lockfile 27 | yarn install --frozen-lockfile 28 | shell: bash 29 | -------------------------------------------------------------------------------- /.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 | build-library: 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: Build package 36 | run: yarn prepack 37 | -------------------------------------------------------------------------------- /.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 | v18 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) 2023 Rodolphe Lemasquerier 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-keyboard-scrollview 2 | 3 | A react-native scrollview that will avoid the keyboard when focusing some inputs 4 | 5 | ## Preview 6 | 7 | ![gif preview](docs/preview.gif "Video preview") 8 | 9 | ## Installation 10 | 11 | ```sh 12 | npm install @rlemasquerier/react-native-keyboard-scrollview 13 | ``` 14 | 15 | ## Usage 16 | 17 | ```js 18 | import { KeyboardScrollView } from '@rlemasquerier/react-native-keyboard-scrollview'; 19 | 20 | // ... 21 | 22 | 26 | 27 | { /*... */ } 28 | 29 | ``` 30 | 31 | ## Contributing 32 | 33 | See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. 34 | 35 | ## License 36 | 37 | MIT 38 | 39 | --- 40 | 41 | Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob) 42 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: ['module:metro-react-native-babel-preset'], 3 | }; 4 | -------------------------------------------------------------------------------- /docs/preview.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rlemasquerier/react-native-keyboard-scrollview/e2bfb50ed089e993f23a06420a8484c81c8321ca/docs/preview.gif -------------------------------------------------------------------------------- /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 | "assetBundlePatterns": [ 15 | "**/*" 16 | ], 17 | "ios": { 18 | "supportsTablet": true 19 | }, 20 | "android": { 21 | "adaptiveIcon": { 22 | "foregroundImage": "./assets/adaptive-icon.png", 23 | "backgroundColor": "#ffffff" 24 | } 25 | }, 26 | "web": { 27 | "favicon": "./assets/favicon.png" 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /example/assets/adaptive-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rlemasquerier/react-native-keyboard-scrollview/e2bfb50ed089e993f23a06420a8484c81c8321ca/example/assets/adaptive-icon.png -------------------------------------------------------------------------------- /example/assets/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rlemasquerier/react-native-keyboard-scrollview/e2bfb50ed089e993f23a06420a8484c81c8321ca/example/assets/favicon.png -------------------------------------------------------------------------------- /example/assets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rlemasquerier/react-native-keyboard-scrollview/e2bfb50ed089e993f23a06420a8484c81c8321ca/example/assets/icon.png -------------------------------------------------------------------------------- /example/assets/splash.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rlemasquerier/react-native-keyboard-scrollview/e2bfb50ed089e993f23a06420a8484c81c8321ca/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 | const modules = Object.keys({ ...pak.peerDependencies }); 9 | 10 | const defaultConfig = getDefaultConfig(__dirname); 11 | 12 | /** 13 | * Metro configuration 14 | * https://facebook.github.io/metro/docs/configuration 15 | * 16 | * @type {import('metro-config').MetroConfig} 17 | */ 18 | const config = { 19 | ...defaultConfig, 20 | 21 | projectRoot: __dirname, 22 | watchFolders: [root], 23 | 24 | // We need to make sure that only one version is loaded for peerDependencies 25 | // So we block them at the root, and alias them to the versions in example's node_modules 26 | resolver: { 27 | ...defaultConfig.resolver, 28 | 29 | blacklistRE: exclusionList( 30 | modules.map( 31 | (m) => 32 | new RegExp(`^${escape(path.join(root, 'node_modules', m))}\\/.*$`) 33 | ) 34 | ), 35 | 36 | extraNodeModules: modules.reduce((acc, name) => { 37 | acc[name] = path.join(__dirname, 'node_modules', name); 38 | return acc; 39 | }, {}), 40 | }, 41 | }; 42 | 43 | module.exports = config; 44 | -------------------------------------------------------------------------------- /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 | "@react-navigation/native": "^6.1.9", 13 | "@react-navigation/native-stack": "^6.9.16", 14 | "expo": "~49.0.11", 15 | "expo-status-bar": "~1.6.0", 16 | "react": "18.2.0", 17 | "react-dom": "18.2.0", 18 | "react-native": "0.72.5", 19 | "react-native-safe-area-context": "4.6.3", 20 | "react-native-screens": "~3.22.0", 21 | "react-native-web": "~0.19.6" 22 | }, 23 | "devDependencies": { 24 | "@babel/core": "^7.20.0", 25 | "@expo/webpack-config": "^19.0.0", 26 | "babel-loader": "^8.1.0", 27 | "babel-plugin-module-resolver": "^5.0.0" 28 | }, 29 | "private": true 30 | } 31 | -------------------------------------------------------------------------------- /example/src/App.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | 3 | import { NavigationContainer } from '@react-navigation/native'; 4 | 5 | import { MainStackNavigator } from './navigation/MainStackNavigator'; 6 | 7 | export default function App() { 8 | return ( 9 | 10 | 11 | 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /example/src/components/ContentCard.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { StyleSheet, Text, View } from 'react-native'; 3 | 4 | export const ContentCard = () => { 5 | return ( 6 | 7 | 8 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod 9 | tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim 10 | veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea 11 | commodo consequat 12 | 13 | 14 | ); 15 | }; 16 | 17 | const styles = StyleSheet.create({ 18 | container: { 19 | justifyContent: 'center', 20 | marginBottom: 8, 21 | padding: 8, 22 | borderWidth: 1, 23 | borderRadius: 4, 24 | width: 200, 25 | }, 26 | }); 27 | -------------------------------------------------------------------------------- /example/src/components/TextInput.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { 3 | TextInput as RNTextInput, 4 | StyleSheet, 5 | View, 6 | type TextInputProps, 7 | } from 'react-native'; 8 | 9 | export const TextInput = (props: TextInputProps) => { 10 | return ( 11 | 12 | 17 | 18 | ); 19 | }; 20 | 21 | const styles = StyleSheet.create({ 22 | container: { 23 | justifyContent: 'center', 24 | borderWidth: 1, 25 | borderRadius: 4, 26 | width: 200, 27 | height: 40, 28 | }, 29 | inputStyle: { 30 | paddingHorizontal: 10, 31 | fontSize: 16, 32 | }, 33 | }); 34 | -------------------------------------------------------------------------------- /example/src/navigation/MainStackNavigator.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | 3 | import { createNativeStackNavigator } from '@react-navigation/native-stack'; 4 | 5 | import { HomeScreen } from '../screens/Home'; 6 | import { SecondScreen } from '../screens/SecondScreen'; 7 | 8 | const Stack = createNativeStackNavigator(); 9 | 10 | export type MainStackParamsList = { 11 | Home: undefined; 12 | SecondScreen: undefined; 13 | }; 14 | 15 | export const MainStackNavigator = () => { 16 | return ( 17 | 18 | 19 | 20 | 21 | ); 22 | }; 23 | -------------------------------------------------------------------------------- /example/src/screens/Home.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | import { StyleSheet, View, Text, Pressable } from 'react-native'; 3 | 4 | import { KeyboardScrollView } from '@rlemasquerier/react-native-keyboard-scrollview'; 5 | import { useNavigation } from '@react-navigation/native'; 6 | import type { NativeStackNavigationProp } from '@react-navigation/native-stack'; 7 | 8 | import type { MainStackParamsList } from '../navigation/MainStackNavigator'; 9 | import { TextInput } from '../components/TextInput'; 10 | import { ContentCard } from '../components/ContentCard'; 11 | 12 | export const HomeScreen = () => { 13 | const navigation = 14 | useNavigation>(); 15 | 16 | return ( 17 | 18 | 19 | Example app 20 | navigation.navigate('SecondScreen')}> 21 | Go to second screen 22 | 23 | 24 | 28 | 29 | 30 | 31 | 32 | 33 | ); 34 | }; 35 | 36 | const styles = StyleSheet.create({ 37 | appContainer: { 38 | flex: 1, 39 | flexGrow: 1, 40 | }, 41 | header: { 42 | justifyContent: 'center', 43 | padding: 16, 44 | height: 120, 45 | borderBottomWidth: 1, 46 | }, 47 | headerText: { 48 | fontSize: 24, 49 | }, 50 | container: { 51 | padding: 16, 52 | alignItems: 'center', 53 | }, 54 | box: { 55 | width: 60, 56 | height: 60, 57 | marginVertical: 20, 58 | }, 59 | }); 60 | -------------------------------------------------------------------------------- /example/src/screens/SecondScreen.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | import { StyleSheet, View, Text } from 'react-native'; 3 | 4 | import { KeyboardScrollView } from '@rlemasquerier/react-native-keyboard-scrollview'; 5 | 6 | import { TextInput } from '../components/TextInput'; 7 | import { ContentCard } from '../components/ContentCard'; 8 | 9 | export const SecondScreen = () => { 10 | return ( 11 | 12 | 13 | Example app 14 | 15 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | ); 32 | }; 33 | 34 | const styles = StyleSheet.create({ 35 | appContainer: { 36 | flex: 1, 37 | flexGrow: 1, 38 | }, 39 | header: { 40 | justifyContent: 'center', 41 | padding: 16, 42 | height: 120, 43 | borderBottomWidth: 1, 44 | }, 45 | headerText: { 46 | fontSize: 24, 47 | }, 48 | container: { 49 | padding: 16, 50 | alignItems: 'center', 51 | }, 52 | box: { 53 | width: 60, 54 | height: 60, 55 | marginVertical: 20, 56 | }, 57 | }); 58 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@rlemasquerier/react-native-keyboard-scrollview", 3 | "version": "0.2.1", 4 | "description": "A react-native scrollview that will avoid the keyboard when focusing some inputs", 5 | "main": "lib/commonjs/index", 6 | "module": "lib/module/index", 7 | "types": "lib/typescript/src/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/rlemasquerier/react-native-keyboard-scrollview", 44 | "author": "Rodolphe Lemasquerier (https://github.com/rlemasquerier)", 45 | "license": "MIT", 46 | "bugs": { 47 | "url": "https://github.com/rlemasquerier/react-native-keyboard-scrollview/issues" 48 | }, 49 | "homepage": "https://github.com/rlemasquerier/react-native-keyboard-scrollview#readme", 50 | "publishConfig": { 51 | "registry": "https://registry.npmjs.org/" 52 | }, 53 | "devDependencies": { 54 | "@react-native/eslint-config": "^0.72.2", 55 | "@release-it/conventional-changelog": "^5.0.0", 56 | "@types/jest": "^28.1.2", 57 | "@types/react": "~17.0.21", 58 | "@types/react-native": "0.70.0", 59 | "del-cli": "^5.0.0", 60 | "eslint": "^8.4.1", 61 | "eslint-config-prettier": "^8.5.0", 62 | "eslint-plugin-prettier": "^4.0.0", 63 | "jest": "^28.1.1", 64 | "pod-install": "^0.1.0", 65 | "prettier": "^2.0.5", 66 | "react": "18.2.0", 67 | "react-native": "0.72.4", 68 | "react-native-builder-bob": "^0.22.0", 69 | "release-it": "^15.0.0", 70 | "typescript": "^5.0.2" 71 | }, 72 | "resolutions": { 73 | "@types/react": "17.0.21" 74 | }, 75 | "peerDependencies": { 76 | "react": "*", 77 | "react-native": "*" 78 | }, 79 | "engines": { 80 | "node": ">= 18.0.0" 81 | }, 82 | "jest": { 83 | "preset": "react-native", 84 | "modulePathIgnorePatterns": [ 85 | "/example/node_modules", 86 | "/lib/" 87 | ] 88 | }, 89 | "release-it": { 90 | "git": { 91 | "commitMessage": "chore: release ${version}", 92 | "tagName": "v${version}" 93 | }, 94 | "npm": { 95 | "publish": true 96 | }, 97 | "github": { 98 | "release": true 99 | }, 100 | "plugins": { 101 | "@release-it/conventional-changelog": { 102 | "preset": "angular" 103 | } 104 | } 105 | }, 106 | "eslintConfig": { 107 | "root": true, 108 | "extends": [ 109 | "@react-native", 110 | "prettier" 111 | ], 112 | "rules": { 113 | "prettier/prettier": [ 114 | "error", 115 | { 116 | "quoteProps": "consistent", 117 | "singleQuote": true, 118 | "tabWidth": 2, 119 | "trailingComma": "es5", 120 | "useTabs": false 121 | } 122 | ] 123 | } 124 | }, 125 | "eslintIgnore": [ 126 | "node_modules/", 127 | "lib/" 128 | ], 129 | "prettier": { 130 | "quoteProps": "consistent", 131 | "singleQuote": true, 132 | "tabWidth": 2, 133 | "trailingComma": "es5", 134 | "useTabs": false 135 | }, 136 | "react-native-builder-bob": { 137 | "source": "src", 138 | "output": "lib", 139 | "targets": [ 140 | "commonjs", 141 | "module", 142 | [ 143 | "typescript", 144 | { 145 | "project": "tsconfig.build.json" 146 | } 147 | ] 148 | ] 149 | } 150 | } 151 | -------------------------------------------------------------------------------- /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/KeyboardScrollView.tsx: -------------------------------------------------------------------------------- 1 | import React, { 2 | useCallback, 3 | useEffect, 4 | useMemo, 5 | useRef, 6 | useState, 7 | } from 'react'; 8 | import { Platform } from 'react-native'; 9 | import { Keyboard, ScrollView, TextInput, StatusBar } from 'react-native'; 10 | 11 | interface Props extends React.ComponentProps { 12 | additionalScrollHeight?: number; 13 | } 14 | 15 | export const KeyboardScrollView = ({ 16 | children, 17 | additionalScrollHeight, 18 | contentContainerStyle, 19 | ...props 20 | }: Props) => { 21 | const scrollViewRef = useRef(null); 22 | const scrollPositionRef = useRef(0); 23 | const scrollContentSizeRef = useRef(0); 24 | const scrollViewSizeRef = useRef(0); 25 | 26 | const [isKeyboardVisible, setIsKeyboardVisible] = useState(false); 27 | const [additionalPadding, setAdditionalPadding] = useState(0); 28 | 29 | const scrollToPosition = useCallback( 30 | (toPosition: number, animated?: boolean) => { 31 | scrollViewRef.current?.scrollTo({ y: toPosition, animated: !!animated }); 32 | scrollPositionRef.current = toPosition; 33 | }, 34 | [] 35 | ); 36 | 37 | const additionalScroll = useMemo( 38 | () => additionalScrollHeight ?? 0, 39 | [additionalScrollHeight] 40 | ); 41 | const androidStatusBarOffset = useMemo( 42 | () => StatusBar.currentHeight ?? 0, 43 | [] 44 | ); 45 | 46 | useEffect(() => { 47 | const didShowListener = Keyboard.addListener( 48 | 'keyboardDidShow', 49 | (frames) => { 50 | const keyboardY = frames.endCoordinates.screenY; 51 | 52 | if (Platform.OS === 'ios') { 53 | const keyboardHeight = frames.endCoordinates.height; 54 | setAdditionalPadding(keyboardHeight); 55 | } 56 | 57 | setTimeout(() => { 58 | setIsKeyboardVisible(true); 59 | }, 100); 60 | 61 | const currentlyFocusedInput = TextInput.State.currentlyFocusedInput(); 62 | const currentScrollY = scrollPositionRef.current; 63 | 64 | currentlyFocusedInput?.measureInWindow((_x, y, _width, height) => { 65 | const endOfInputY = y + height + androidStatusBarOffset; 66 | const deltaToScroll = endOfInputY - keyboardY; 67 | 68 | if (deltaToScroll < 0) return; 69 | 70 | const scrollPositionTarget = 71 | currentScrollY + deltaToScroll + additionalScroll; 72 | scrollToPosition(scrollPositionTarget, true); 73 | }); 74 | } 75 | ); 76 | 77 | const didHideListener = Keyboard.addListener('keyboardDidHide', () => { 78 | setAdditionalPadding(0); 79 | setIsKeyboardVisible(false); 80 | }); 81 | 82 | const willHideListener = Keyboard.addListener( 83 | 'keyboardWillHide', 84 | (frames) => { 85 | // iOS only, scroll back to initial position to avoid flickering 86 | const keyboardHeight = frames.endCoordinates.height; 87 | const currentScrollY = scrollPositionRef.current; 88 | 89 | /* 90 | Added this early return to avoid a bug with react-navigation, where moving from a screen to another, this event was triggered twice 91 | In any case, no need to scroll back if we are already at the top so this early return should be safe 92 | */ 93 | if (currentScrollY <= 0) return; 94 | 95 | const scrollPositionTarget = currentScrollY - keyboardHeight; 96 | scrollToPosition(scrollPositionTarget, true); 97 | } 98 | ); 99 | 100 | return () => { 101 | didShowListener.remove(); 102 | didHideListener.remove(); 103 | willHideListener.remove(); 104 | }; 105 | }, [additionalScroll, androidStatusBarOffset, scrollToPosition]); 106 | 107 | return ( 108 | { 114 | scrollPositionRef.current = event.nativeEvent.contentOffset.y; 115 | }} 116 | onScrollEndDrag={(event) => { 117 | scrollPositionRef.current = event.nativeEvent.contentOffset.y; 118 | }} 119 | onLayout={(event) => { 120 | scrollViewSizeRef.current = event.nativeEvent.layout.height; 121 | }} 122 | onContentSizeChange={(_width, height) => { 123 | const currentContentHeight = scrollContentSizeRef.current; 124 | const contentSizeDelta = height - currentContentHeight; 125 | scrollContentSizeRef.current = height; 126 | 127 | if (!isKeyboardVisible) return; 128 | 129 | const currentScrollY = scrollPositionRef.current; 130 | const scrollPositionTarget = currentScrollY + contentSizeDelta; 131 | scrollToPosition(scrollPositionTarget, true); 132 | }} 133 | {...props} 134 | > 135 | {children} 136 | 137 | ); 138 | }; 139 | -------------------------------------------------------------------------------- /src/index.tsx: -------------------------------------------------------------------------------- 1 | export { KeyboardScrollView } from './KeyboardScrollView'; 2 | -------------------------------------------------------------------------------- /tsconfig.build.json: -------------------------------------------------------------------------------- 1 | 2 | { 3 | "extends": "./tsconfig", 4 | "exclude": ["example"] 5 | } 6 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "rootDir": ".", 4 | "paths": { 5 | "@rlemasquerier/react-native-keyboard-scrollview": ["./src/index"] 6 | }, 7 | "allowUnreachableCode": false, 8 | "allowUnusedLabels": false, 9 | "esModuleInterop": true, 10 | "forceConsistentCasingInFileNames": true, 11 | "jsx": "react", 12 | "lib": ["esnext"], 13 | "module": "esnext", 14 | "moduleResolution": "node", 15 | "noFallthroughCasesInSwitch": true, 16 | "noImplicitReturns": true, 17 | "noImplicitUseStrict": false, 18 | "noStrictGenericChecks": false, 19 | "noUncheckedIndexedAccess": true, 20 | "noUnusedLocals": true, 21 | "noUnusedParameters": true, 22 | "resolveJsonModule": true, 23 | "skipLibCheck": true, 24 | "strict": true, 25 | "target": "esnext", 26 | "verbatimModuleSyntax": true 27 | } 28 | } 29 | --------------------------------------------------------------------------------