Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
keyboard-menu
Advanced tools
Create a simple menu with options. Change their values with your keyboard at runtime.
Readme
$ npm i keyboard-menu
I have only tested the package with the latest node version 18.x.x
This package doesn't work with commonjs, it's ESM.
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.
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.
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>())
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())
Settings
|> Number: 64
|> Boolean: true
|> String: 'Some string'
{ Number: 64, Boolean: true, String: 'Some string' }
You can reach me for improvements, bugs and for new features over on discord Royal Foxy#5469
or on my github.
FAQs
Create a simple menu with options. Change their values with your keyboard at runtime.
The npm package keyboard-menu receives a total of 0 weekly downloads. As such, keyboard-menu popularity was classified as not popular.
We found that keyboard-menu demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.