# ionic-plugin-keyboard

> Ionic Keyboard Plugin

Latest version **2.2.1** (published 2016-06-20) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install ionic-plugin-keyboard
pnpm add ionic-plugin-keyboard
yarn add ionic-plugin-keyboard
bun add ionic-plugin-keyboard
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2016-06-20 |
| First published | 2015-04-22 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 605 |
| Author | Ionic |
| Maintainers | drifty, ionicjs, tlancina |
| Keywords | ionic, cordova, keyboard, ecosystem:cordova, cordova-android, cordova-ios, cordova-blackberry10, cordova-wp8, cordova-windows |

## Links

- npm: https://www.npmjs.com/package/ionic-plugin-keyboard
- Repository: https://github.com/driftyco/ionic-plugin-keyboard
- Homepage: https://github.com/driftyco/ionic-plugin-keyboard#readme
- Issues: https://github.com/driftyco/ionic-plugin-keyboard/issues
- npm.io page: https://npm.io/package/ionic-plugin-keyboard

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.2.1 (latest) — 2016-06-20
- 2.2.0 — 2016-05-10
- 2.1.0 — 2016-05-02
- 1.0.9 — 2016-03-18
- 2.0.1 — 2016-03-18
- 2.0.0 — 2016-03-18
- 1.0.8 — 2015-11-19
- 1.0.7 — 2015-09-14
- 1.0.6 — 2015-09-14
- 1.0.5 — 2015-07-01
- 1.0.4 — 2015-04-22

## README

Keyboard
======

The `cordova.plugins.Keyboard` object provides functions to make interacting with the keyboard easier, and fires events to indicate that the keyboard will hide/show.

    cordova plugin add ionic-plugin-keyboard

Methods
-------

- cordova.plugins.Keyboard.hideKeyboardAccessoryBar
- cordova.plugins.Keyboard.close
- cordova.plugins.Keyboard.disableScroll
- cordova.plugins.Keyboard.show

Properties
--------

- cordova.plugins.Keyboard.isVisible

Events
--------

These events are fired on the window.

- native.keyboardshow
  * A number `keyboardHeight` is given on the event object, which is the pixel height of the keyboard.
- native.keyboardhide


# API reference

Keyboard.hideKeyboardAccessoryBar
=================

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

    cordova.plugins.Keyboard.hideKeyboardAccessoryBar(true);
    cordova.plugins.Keyboard.hideKeyboardAccessoryBar(false);

Supported Platforms
-------------------

- iOS


Keyboard.close
=================

Close the keyboard if it is open.

    cordova.plugins.Keyboard.close();

Supported Platforms
-------------------

- iOS, Android, Blackberry 10, Windows


Keyboard.disableScroll
=================

Prevent the native UIScrollView from moving when an input is focused.  The telltale sign that this is happening is the top of your app scrolls out of view (if using Ionic, your header bar will disappear).

This does *not* prevent any DOM elements from being able to scroll.  That needs to happen from CSS and JavaScript, not this plugin. 

    cordova.plugins.Keyboard.disableScroll(true);
    cordova.plugins.Keyboard.disableScroll(false);

Supported Platforms
-------------------

- iOS, Windows

Keyboard.show
=================

Force keyboard to be shown. This typically helps if autofocus on a text element does not pop up the keyboard automatically

    cordova.plugins.Keyboard.show();

Supported Platforms

- Android, Blackberry 10, Windows

native.keyboardshow
=================

This event fires when the keyboard will be shown or when the keyboard frame resizes (when switching between keyboards for example)

    window.addEventListener('native.keyboardshow', keyboardShowHandler);

    function keyboardShowHandler(e){
        alert('Keyboard height is: ' + e.keyboardHeight);
    }

Properties
-----------

keyboardHeight: the height of the keyboard in pixels


Supported Platforms
-------------------

- iOS, Android, Blackberry 10, Windows


native.keyboardhide
=================

This event fires when the keyboard will hide

    window.addEventListener('native.keyboardhide', keyboardHideHandler);

    function keyboardHideHandler(e){
        alert('Goodnight, sweet prince');
    }

Properties
-----------

None

Supported Platforms
-------------------

- iOS, Android, Blackberry 10, Windows

---
_Source: https://npm.io/package/ionic-plugin-keyboard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._