Skip to content

Simple android native module to manipulate the behavior of keyboard

License

Notifications You must be signed in to change notification settings

darleikroth/rn-android-keyboard-adjust

Repository files navigation

rn-android-keyboard-adjust

npm size

Simple android native module to manipulate the behavior of keyboard. Based on react-native-android-keyboard-adjust by Marc Zubricky.

Installation

npm i -S rn-android-keyboard-adjust

Usage

import { setAdjustResize, setAdjustNothing } from 'rn-android-keyboard-adjust';

// ...

React.useEffect(() => {
    setAdjustResize();
    return () => {
      setAdjustNothing();
    };
  }, []);

Methods

Name Description
setAdjustNothing Set to have a window not adjust for a shown input method. The window will not be resized, and it will not be panned to make its focus visible.
setAdjustPan Set to have a window pan when an input method is shown, so it doesn't need to deal with resizing but just panned by the framework to ensure the current input focus is visible.
setAdjustResize Set to allow the window to be resized when an input method is shown, so that its contents are not covered by the input method.
setAdjustUnspecified Nothing specified. The system will try to pick one or the other depending on the contents of the window.
setAlwaysHidden Please always hide any soft input area when this window receives focus.
setAlwaysVisible Please always make the soft input area visible when this window receives input focus.
setVisible Please show the soft input area when normally appropriate (when the user is navigating forward to your window).
setHidden Please hide any soft input area when normally appropriate (when the user is navigating forward to your window).
setUnchanged Please don't change the state of the soft input area.
getSoftInputMode Get an integer code of current softInputMode value.
setSoftInputMode Set softInputMode value by an integer code .

Methods reference from Android Developer.

License

MIT