Close Menu

keyboard

The Keyboard module provides a simple and convenient way to manage keyboard interactions in your iOS app. It allows you to easily handle keyboard events such as showing and hiding the keyboard, as well as managing the keyboard’s position and appearance.

Features

  • Simple and intuitive API for managing keyboard interactions
  • Automatic handling of keyboard appearance and dismissal
  • Customizable keyboard toolbar with flexible options
  • Convenient methods for keyboard-related tasks

Getting Started

Installation

To install the Keyboard module, follow these steps:



npm install keyboard --save

Usage

Import the Keyboard module into your project:



import Keyboard from 'keyboard';

Initialize the Keyboard module and handle different keyboard events:



// Initialize Keyboard module
Keyboard.initialize();

// Listen for keyboard show event
Keyboard.on('keyboardShow', () => {
// Your code here
});

// Listen for keyboard hide event
Keyboard.on('keyboardHide', () => {
// Your code here
});

// Other keyboard event listeners...

The Keyboard module also provides additional methods to perform various tasks related to the keyboard:



// Show the keyboard
Keyboard.show();

// Hide the keyboard
Keyboard.hide();

// Resize the keyboard to a specific height
Keyboard.resize(height);

// Get the current keyboard height
Keyboard.getHeight();

Customization

The Keyboard module allows you to customize the appearance and behavior of the keyboard toolbar:

Customizing the Keyboard Toolbar

You can customize the keyboard toolbar by modifying its appearance, adding buttons, and defining button actions:



// Customize keyboard toolbar appearance
Keyboard.setToolbarStyle({
backgroundColor: '#f2f2f2',
tintColor: '#333333',
buttonTintColor: '#007AFF',
buttonFontWeight: 'bold'
});

// Add buttons to keyboard toolbar
Keyboard.addToolbarButtons([
{
title: 'Undo',
onPress: () => {
// Handle undo action
}
},
{
title: 'Redo',
onPress: () => {
// Handle redo action
}
}
]);

FAQs

How can I dismiss the keyboard programmatically?

To dismiss the keyboard programmatically, you can use the Keyboard.hide() method. Call this method whenever you want to hide the keyboard, such as when the user taps outside of a text input.

How can I get the height of the keyboard?

You can use the Keyboard.getHeight() method to retrieve the current height of the keyboard. This can be useful if you need to adjust the layout of your app based on the keyboard visibility.