High Level API

Kotlin: High Level API depends on Keyboard which is a wrapper around the NativeKeyboardHandler.

Java: High Level API depends on JKeyboard.

NodeJS: High Level API depends on JsKeyboard.

Importing the package.

Kotlin (MPP)

import com.github.animeshz.keyboard.Keyboard

val keyboard = Keyboard()

NodeJS

const kbkt = require('keyboard-kt');

const keyboard = new kbkt.com.github.animeshz.keyboard.JsKeyboard();

^{Note: This large import is due to limitations of K/JS to not able to export to global namespace currently, see KT-37710.}

Java 8 or above

import com.github.animeshz.keyboard.JKeyboard;

JKeyboard handler = new JKeyboard();

Adding a shortcut (Hotkey).

Kotlin

keyboard.addShortcut(Key.LeftCtrl + Key.E, trigger = KeyState.KeyDown) {
    println("triggered")
}

^{Note: The lambda is in suspend context, launched in context provided at time of instantiation of Keyboard (defaults to Dispatchers.Default).}

NodeJS

keyboard.addShortcut('LeftCtrl + E', true,
    () => console.log("triggered")
);

Java 8

Set<Key> keys = new HashSet<>();
Collections.addAll(keys, Key.LeftCtrl, Key.E);

keyboard.addShortcut(new KeySet(keys), KeyState.KeyDown,
    () -> System.out.println("triggered")
);

Java 9 or above

Set<Key> keys = Set.of(Key.LeftCtrl, Key.E);

keyboard.addShortcut(new KeySet(keys), KeyState.KeyDown,
    () -> System.out.println("triggered")
);

^{Note: trigger defaults to KeyState.KeyDown when not provided.}

Send a KeySet to the host machine.

Kotlin

keyboard.send(Key.LeftAlt + Key.M)

NodeJS

keyboard.send('LeftAlt + M');

Java 8

Set<Key> keys = new HashSet<>();
Collections.addAll(keys, Key.LeftAlt, Key.M);

keyboard.send(new KeySet(keys));

Java 9 or above

Set<Key> keys = Set.of(Key.LeftAlt, Key.M);

keyboard.send(new KeySet(keys));

Write a sentence (String) on the host machine.

Kotlin

keyboard.write("Hello Keyboard!")

NodeJS

keyboard.write('Hello Keyboard!');

Java 8 or above

keyboard.write("Hello Keyboard!");

Wait till a KeySet is pressed.

Suspensive wait in Kotlin, whereas asynchronous CompletableFuture<> for Java

Kotlin

keyboard.awaitTill(Key.LeftCtrl + Key.LeftShift + Key.R, trigger = KeyState.KeyDown)

NodeJS

await keyboard.completeWhenPressed('LeftCtrl + LeftShift + R');

Java 8

Set<Key> keys = new HashSet<>();
Collections.addAll(keys, Key.LeftCtrl + Key.LeftShift + Key.R);

keyboard.completeWhenPressed(new KeySet(keys), KeyState.KeyDown)
    .thenApply(unit -> {...});

^{Note: Unit is similar to java.lang.Void, a singleton object which has nothing to do for us.}

Java 9 or above

Set<Key> keys = Set.of(Key.LeftCtrl + Key.LeftShift + Key.R);

keyboard.completeWhenPressed(new KeySet(keys), KeyState.KeyDown)
    .thenApply(unit -> {...});

^{Note: Unit is similar to java.lang.Void, a singleton object which has nothing to do for us.}

^{Note: trigger defaults to KeyState.KeyDown when not provided.}

Record Key presses till specific KeySet.

Recorded KeyPresses is pushed into a KeyPressSequence (List<Duration, KeyEvent>)

Kotlin

val records: KeyPressSequence = keyboard.recordTill(Key.LeftAlt + Key.A, trigger = KeyState.KeyDown)

NodeJS

const records = await keyboard.recordKeyPressesTill('LeftCtrl + LeftShift + R', true);

Java 8

Set<Key> keys = new HashSet<>();
Collections.addAll(keys, Key.LeftAlt, Key.A);

// `trigger` defaults to KeyState.KeyDown when not provided.
CompletableFuture<List<Duration, KeyEvent>> records =
    keyboard.recordTill(new KeySet(keys), KeyState.KeyDown);

Java 9 or above

Set<Key> keys = Set.of(Key.LeftAlt, Key.A);

CompletableFuture<List<Duration, KeyEvent>> records =
    keyboard.recordTill(new KeySet(keys), KeyState.KeyDown);

Play a recorded or created collection of Keys at defined order.

Kotlin

keyboard.play(records, speedFactor = 1.25)

NodeJS

await keyboard.play(records, 1.0);

Java 8 or above

CompletableFuture<Unit> onFinish = keyboard.play(records, 1.25)

^{Note: speedFactor defaults to 1.0 when not provided.}