https://github.com/danielmschmidt/react-native-dismiss-keyboard

A simple way to dismiss the keyboard programmatically in a react native application
https://github.com/danielmschmidt/react-native-dismiss-keyboard

keyboard react-native

Last synced: 4 days ago
JSON representation

A simple way to dismiss the keyboard programmatically in a react native application

• Host: GitHub
• URL: https://github.com/danielmschmidt/react-native-dismiss-keyboard
• Owner: DanielMSchmidt
• License: mit
• Created: 2016-01-10T20:13:47.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-24T04:39:06.000Z (23 days ago)
• Last Synced: 2025-01-07T00:37:16.872Z (9 days ago)
• Topics: keyboard, react-native
• Language: JavaScript
• Homepage:
• Size: 113 KB
• Stars: 94
• Watchers: 2
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-dismiss-keyboard ![CircleCi](https://circleci.com/gh/DanielMSchmidt/react-native-dismiss-keyboard.png?circle-token=905f7ed099611e3f8079a5bf72674beab5e55e50) [![npm version](https://badge.fury.io/js/react-native-dismiss-keyboard.svg)](https://badge.fury.io/js/react-native-dismiss-keyboard) ![Downloads](https://img.shields.io/npm/dm/react-native-dismiss-keyboard.svg)

A simple way to dismiss the keyboard programmatically in a react native application. [A demo app can be found here](https://github.com/DanielMSchmidt/DismissKeyboardExample).

## Deprecated for React Native >= 0.35

This module extracts code from an undocumented React Native feature. The reason I wrote it is that the import of the internal module failed after updating and in some specific setups. The feature is now documented in React Native and may be used directly with the [React Native Keyboard API](https://facebook.github.io/react-native/docs/keyboard.html). If your React Native version is high enough I can only encourage you to use React Natives implementation.

## Web Views

This module targets React Native Views, therefore the solution will not work in React Native Web Views. Please use an [alternative solution](http://stackoverflow.com/questions/8335834/how-can-i-hide-the-android-keyboard-using-javascript) in your Web Views Javascript.

## Add it to your project

1. Run `npm install react-native-dismiss-keyboard --save`

2. To import the library choose one of these options

  - ```js 

    var dismissKeyboard = require('react-native-dismiss-keyboard');

    ```

  - ```js

    import dismissKeyboard from 'react-native-dismiss-keyboard';

    ```

3. Run 

    ```js 

    dismissKeyboard()

    ``` 

   anywhere in your code to close the keyboard.

## Support

| React Native Version          | react-native-dismiss-keyboard Version |

|-------------------------------|---------------------------------------|

| >= 0.11 & < 0.23              | < 1.0                                 |

| >= 0.23                       | >= 1.0                                |

| >= 0.36                       | [React Native Keyboard API](https://facebook.github.io/react-native/docs/0.36/keyboard)|

If you experience any restrictions or if it works on other versions, please let us know.

## Contribution

Please make sure to run the tests before proposing a PR by running `npm test`.