sidneys / macos-accessibility-keyboard

The missing interface for the hidden native virtual on-screen keyboard on macOS.

macos-accessibility-keyboard

---

The missing interface for Apples' new native virtual keyboard.
Enter the macOS on-screen Accessibility Keyboard.

---

Contents

1. Installation
2. API
3. Examples
4. Platforms
5. Contribututions
6. Author

Usage

Installation

$ npm install macos-accessibility-keyboard --save

CommonJS Require

const keyboard = require('macos-accessibility-keyboard')

ES6 Module Import

import keyboard from 'macos-accessibility-keyboard'

API

This module exposes the following methods:

isEnabled()

• Returns: Promise<Boolean>
• Check whether the accessibility on-screen keyboard is enabled

isEnabledSync()

• Returns: Boolean
• Check whether the accessibility on-screen keyboard is enabled, synchronously

enable()

• Returns: Promise
• Enables the keyboard

disable()

• Returns: Promise
• Disables the keyboard

toggle()

• Returns: Promise
• Toggles the keyboard

Examples

Show

const {enable, disable} = require('macos-accessibility-keyboard');

enable().then(() => {
	console.log('The keyboard was enabled.')
	disable().then(() => {
		console.log('The keyboard was disabled.')
	})
})

>>> The keyboard was enabled.

Check

const keyboard = require('macos-accessibility-keyboard');

const isEnabled = keyboard.isEnabledSync()
console.log('The keyboard is:', isEnabled ? 'on': 'off')

>>>  The keyboard is: off

Platforms

Tested on macOS High Sierra 10.13.4.

Contribututions

Read the contribution documentation first.

• Dev Chat: Talk about features and suggestions.
• Issues File bugs and document issues.

Author

sidneys.github.io 2018