mirror of
https://github.com/status-im/react-native.git
synced 2025-01-09 09:12:02 +00:00
5105c09f56
Summary: They keyboard module is an instance of `NativeEventEmitter` which is an instance of `EventEmitter`. But the exported module only has a small subset of the APIs. This broke existing codebases which are using the methods not exported currently. The PR just reassigns the variable before exporting so that the actual module is exported instead of the dummy object used for documentation. It also fixes a layout issue in the documentation. Closes https://github.com/facebook/react-native/pull/10671 Differential Revision: D4110355 fbshipit-source-id: a6757f3ca8c2494970ba221b10a7e6e9a5f2d64d
141 lines
3.9 KiB
JavaScript
141 lines
3.9 KiB
JavaScript
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*
|
|
* @providesModule Keyboard
|
|
* @flow
|
|
*/
|
|
'use strict';
|
|
|
|
const invariant = require('fbjs/lib/invariant');
|
|
const NativeEventEmitter = require('NativeEventEmitter');
|
|
const KeyboardObserver = require('NativeModules').KeyboardObserver;
|
|
const dismissKeyboard = require('dismissKeyboard');
|
|
const KeyboardEventEmitter = new NativeEventEmitter(KeyboardObserver);
|
|
|
|
type KeyboardEventName =
|
|
| 'keyboardWillShow'
|
|
| 'keyboardDidShow'
|
|
| 'keyboardWillHide'
|
|
| 'keyboardDidHide'
|
|
| 'keyboardWillChangeFrame'
|
|
| 'keyboardDidChangeFrame';
|
|
|
|
type KeyboardEventData = {
|
|
endCoordinates: {
|
|
width: number,
|
|
height: number,
|
|
screenX: number,
|
|
screenY: number,
|
|
},
|
|
};
|
|
|
|
type KeyboardEventListener = (e: KeyboardEventData) => void;
|
|
|
|
// The following object exists for documentation purposes
|
|
// Actual work happens in
|
|
// https://github.com/facebook/react-native/blob/master/Libraries/EventEmitter/NativeEventEmitter.js
|
|
|
|
/**
|
|
* `Keyboard` module to control keyboard events.
|
|
*
|
|
* ### Usage
|
|
*
|
|
* The Keyboard module allows you to listen for native events and react to them, as
|
|
* well as make changes to the keyboard, like dismissing it.
|
|
*
|
|
*```
|
|
* import React, { Component } from 'react';
|
|
* import { Keyboard, TextInput } from 'react-native';
|
|
*
|
|
* class Example extends Component {
|
|
* componentWillMount () {
|
|
* this.keyboardDidShowListener = Keyboard.addListener('keyboardDidShow', this._keyboardDidShow);
|
|
* this.keyboardDidHideListener = Keyboard.addListener('keyboardDidHide', this._keyboardDidHide);
|
|
* }
|
|
*
|
|
* componentWillUnmount () {
|
|
* this.keyboardDidShowListener.remove();
|
|
* this.keyboardDidHideListener.remove();
|
|
* }
|
|
*
|
|
* _keyboardDidShow () {
|
|
* alert('Keyboard Shown');
|
|
* }
|
|
*
|
|
* _keyboardDidHide () {
|
|
* alert('Keyboard Hidden');
|
|
* }
|
|
*
|
|
* render() {
|
|
* return (
|
|
* <TextInput
|
|
* onSubmitEditing={Keyboard.dismiss}
|
|
* />
|
|
* );
|
|
* }
|
|
* }
|
|
*```
|
|
*/
|
|
|
|
let Keyboard = {
|
|
/**
|
|
* The `addListener` function connects a JavaScript function to an identified native
|
|
* keyboard notification event.
|
|
*
|
|
* This function then returns the reference to the listener.
|
|
*
|
|
* @param {string} eventName The `nativeEvent` is the string that identifies the event you're listening for. This
|
|
*can be any of the following:
|
|
*
|
|
* - `keyboardWillShow`
|
|
* - `keyboardDidShow`
|
|
* - `keyboardWillHide`
|
|
* - `keyboardDidHide`
|
|
* - `keyboardWillChangeFrame`
|
|
* - `keyboardDidChangeFrame`
|
|
*
|
|
* @param {function} callback function to be called when the event fires.
|
|
*/
|
|
addListener(eventName: KeyboardEventName, callback: KeyboardEventListener) {
|
|
invariant(false, 'Dummy method used for documentation');
|
|
},
|
|
|
|
/**
|
|
* Removes a specific listener.
|
|
*
|
|
* @param {string} eventName The `nativeEvent` is the string that identifies the event you're listening for.
|
|
* @param {function} callback function to be called when the event fires.
|
|
*/
|
|
removeListener(eventName: KeyboardEventName, callback: Function) {
|
|
invariant(false, 'Dummy method used for documentation');
|
|
},
|
|
|
|
/**
|
|
* Removes all listeners for a specific event type.
|
|
*
|
|
* @param {string} eventType The native event string listeners are watching which will be removed.
|
|
*/
|
|
removeAllListeners(eventName: KeyboardEventName) {
|
|
invariant(false, 'Dummy method used for documentation');
|
|
},
|
|
|
|
/**
|
|
* Dismisses the active keyboard and removes focus.
|
|
*/
|
|
dismiss() {
|
|
invariant(false, 'Dummy method used for documentation');
|
|
}
|
|
};
|
|
|
|
// Throw away the dummy object and reassign it to original module
|
|
Keyboard = KeyboardEventEmitter;
|
|
Keyboard.dismiss = dismissKeyboard;
|
|
|
|
module.exports = Keyboard;
|
|
|