Install

$ npm i keyboard-menu

Usage

Info

I have only tested the package with the latest node version 18.x.x

This package doesn't work with commonjs, it's ESM.

Basics

Creating a new Menu will need an object as arguments. This Object needs a title and and options property, latter is an array of object containing a name and a value. The value can be a number | boolean | string.

Optional arguments contain start to start the menu immediatly after creation without the need to call menu.start()

After starting it the menu will automatically render itself. You can navigate up and down with the respective arrow keys. The currently selected point is highlighted in green and you can type normally.

When you have a number you can either increase it by one with the right arrow key or decrease by one with the left arrow key. You can also just type a number and use backspace to delete the last digit.

If your value is a boolean you can change it to the opposite with either the left or right arrow key.

If it's a string you can just normally type, use spaces and backspace.

Supported chars

const lowerCase = "abcdefghijklmnopqrstuvwxyz";
const upperCase = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
const specialChars = "<>\\,;.:-_+¦\"@*#ç°%§&¬/|(¢)='?´^`~[¨!]{$£} ";
const specialLetters = "üÜèÈöÖéÉäÄàÄ";
const numbers = "0123456789";

You can exit the menu with either confirming your choice by hitting return, canceling by ctrl+c or esc.

The menu.get() method returns a promise with the results if the user didn't cancel the menu. you can obviously await that as seen below.

The result is an object with the keys being the name you've given and the value being... the value.

Typescript

import Menu from "keyboard-menu";

const options = { Number: 64, Boolean: true, String: "Some string" }

const menu = new Menu({
  title: "Settings",
  options,
});

menu.start()

console.log(await menu.get<typeof options>())

Javascript

import Menu from "keyboard-menu";

const menu = new Menu({
  title: "Settings",
  options: { Number: 64, Boolean: true, String: "Some string" },
});

menu.start()

console.log(await menu.get())

result

Settings

|> Number: 64
|> Boolean: true
|> String: 'Some string'
{ Number: 64, Boolean: true, String: 'Some string' }

Reach me

You can reach me for improvements, bugs and for new features over on discord Royal Foxy#5469 or on my github.