https://github.com/sidneys/macos-accessibility-keyboard
The missing interface for the hidden native virtual on-screen keyboard on macOS.
https://github.com/sidneys/macos-accessibility-keyboard
Last synced: 3 months ago
JSON representation
The missing interface for the hidden native virtual on-screen keyboard on macOS.
- Host: GitHub
- URL: https://github.com/sidneys/macos-accessibility-keyboard
- Owner: sidneys
- Created: 2018-06-07T15:30:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-07T17:15:56.000Z (about 7 years ago)
- Last Synced: 2025-03-16T08:04:06.524Z (4 months ago)
- Language: JavaScript
- Size: 37.1 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# macos-accessibility-keyboard
------
The missing interface for Apples' new native virtual keyboard.
Enter the macOS on-screen Accessibility Keyboard.
------
## Contents
1. [Installation](#installation)
1. [API](#api)
1. [Examples](#examples)
1. [Platforms](#platforms)
1. [Contribututions](#contribututions)
1. [Author](#author)
### Installation
```shell
$ npm install macos-accessibility-keyboard --save
```
### CommonJS Require
```javascript
const keyboard = require('macos-accessibility-keyboard')
```
### ES6 Module Import
```javascript
import keyboard from 'macos-accessibility-keyboard'
```
This module exposes the following methods:
#### `isEnabled()`
- Returns: `Promise`
- 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
### Show
```javascript
const {enable, disable} = require('macos-accessibility-keyboard');
enable().then(() => {
console.log('The keyboard was enabled.')
disable().then(() => {
console.log('The keyboard was disabled.')
})
})
```
```javascript
>>> The keyboard was enabled.
```
### Check
```javascript
const keyboard = require('macos-accessibility-keyboard');
const isEnabled = keyboard.isEnabledSync()
console.log('The keyboard is:', isEnabled ? 'on': 'off')
```
```javascript
>>> The keyboard is: off
```
Tested on macOS High Sierra 10.13.4.
## Contribututions 
Read the [contribution documentation](https://github.com/sidneys/macos-accessibility-keyboard/blob/release/CONTRIBUTING.md) first.
- [Dev Chat](http://gitter.im/sidneys/macos-accessibility-keyboard): Talk about features and suggestions.
- [Issues](http;//github.com/sidneys/macos-accessibility-keyboard/issues) File bugs and document issues.
[sidneys.github.io](http://sidneys.github.io) 2018