Logo for jsDocs.io

@ionic-native/keyboard

  • Version 5.36.0
  • Published
  • 34.8 kB
  • 1 dependency
  • MIT license

Install

npm i @ionic-native/keyboard
yarn add @ionic-native/keyboard
pnpm add @ionic-native/keyboard

Overview

Ionic Native - Native plugins for ionic apps

Index

Variables

Classes

Enums

Variables

variable Keyboard

const Keyboard: KeyboardOriginal;

    Classes

    class KeyboardOriginal

    class KeyboardOriginal extends IonicNativePlugin {}

    • Keyboard keyboard true Keyboard plugin for Cordova.

      Requires Cordova plugin: cordova-plugin-ionic-keyboard. For more info, please see the [Keyboard plugin docs](https://github.com/ionic-team/cordova-plugin-ionic-keyboard).

      import { Keyboard } from '@ionic-native/keyboard/ngx';
      

      constructor(private keyboard: Keyboard) { }
      

      ...
      

      this.keyboard.show();
      

      this.keyboard.hide();

    property isVisible

    isVisible: boolean;

    • Check keyboard status visible or not.

      Returns

      {boolean}

    method disableScroll

    disableScroll: (disable: boolean) => void;

    • Programatically enable or disable the WebView scroll

      Parameter mode

    method hide

    hide: () => void;

    • Hide the keyboard if shown.

    method hideFormAccessoryBar

    hideFormAccessoryBar: (hide: boolean) => void;

    • Hide the keyboard accessory bar with the next, previous and done buttons.

      Parameter hide

    method onKeyboardDidHide

    onKeyboardDidHide: () => Observable<any>;

    • Creates an observable that notifies you when the keyboard did hide. Unsubscribe to observable to cancel event watch.

      Returns

      {Observable}

    method onKeyboardDidShow

    onKeyboardDidShow: () => Observable<any>;

    • Creates an observable that notifies you when the keyboard did show. Unsubscribe to observable to cancel event watch.

      Returns

      {Observable}

    method onKeyboardHide

    onKeyboardHide: () => Observable<any>;

    • Creates an observable that notifies you when the keyboard is hidden. Unsubscribe to observable to cancel event watch.

      Returns

      {Observable}

    method onKeyboardShow

    onKeyboardShow: () => Observable<any>;

    • Creates an observable that notifies you when the keyboard is shown. Unsubscribe to observable to cancel event watch.

      Returns

      {Observable}

    method onKeyboardWillHide

    onKeyboardWillHide: () => Observable<any>;

    • Creates an observable that notifies you when the keyboard will hide. Unsubscribe to observable to cancel event watch.

      Returns

      {Observable}

    method onKeyboardWillShow

    onKeyboardWillShow: () => Observable<any>;

    • Creates an observable that notifies you when the keyboard will show. Unsubscribe to observable to cancel event watch.

      Returns

      {Observable}

    method setKeyboardStyle

    setKeyboardStyle: (style: KeyboardStyle) => void;

    • Programatically set Keyboard style

      Parameter mode

    method setResizeMode

    setResizeMode: (mode: KeyboardResizeMode) => void;

    • Programatically set the resize mode

      Parameter mode

    method show

    show: () => void;

    • Force keyboard to be shown.

    Enums

    enum KeyboardResizeMode

    enum KeyboardResizeMode {
        Native = 'native',
        Ionic = 'ionic',
        Body = 'body',
        None = 'none',
    }

      member Body

      Body = 'body'

        member Ionic

        Ionic = 'ionic'

          member Native

          Native = 'native'

            member None

            None = 'none'

              enum KeyboardStyle

              enum KeyboardStyle {
                  Light = 'light',
                  Dark = 'dark',
              }

                member Dark

                Dark = 'dark'

                  member Light

                  Light = 'light'

                    Package Files (1)

                    Dependencies (1)

                    Dev Dependencies (0)

                    No dev dependencies.

                    Peer Dependencies (2)

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@ionic-native/keyboard.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@ionic-native/keyboard)
                    • HTML
                      <a href="https://www.jsdocs.io/package/@ionic-native/keyboard"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>