Git Product home page Git Product logo

terminal-menu-program's Introduction

(This project is no longer being actively maintained, although I will happily merge in PRs to fix issues)

Terminal menu programs, using retro ansi terminal menus for serious 80s technicolor business... programs.

Who likes install scripts with runtime flags? Really? Guess who doesn't: everyone else (rounded up).

This is a simple bit of polish on top of the terminal-menu package that gives you a structured terminal program with navigable menus, and togglable checkbox options. Things can happen when you enter or exit menus, things can happen when you toggle a checkbox option, and things can happen when you save or cancel an entire menu of checkbox options.

Have a look at the test.js file to see how it all works, but it's pretty much "create a program", "create named menus", "add options for transitioning to other menus, possibly with callbacks" and "create checkbox options, possibly with callbacks on toggles". That's it.

Well, okay, and you can give menus an onLoad and onUnload, which will trigger when a screen is swapped in and out.

Because part of the beauty of a retro ansi terminal menu program for serious 80s technicolor business is that you don't need a lot to do a lot.

How do I use it?

It's a node package with a regular npm entry, so:

npm install terminal-menu-program

in your project directory, and then require it in. See the super simple example code below for, unsurprisingly, an example of that!

Screenshots?

Sure, why not. Bask in the glory of classic terminal menus:

image

image

super basic minimal example

// preamble
var builder = require("terminal-menu-program"),
    program = new builder.Program("Test program"),

// single screen definition
menu = program.menu("main");
menu.text("A Terminal Menu Program");
menu.spacer();
menu.option("menu switch (going to this screen when selected)", "main");
menu.spacer();
menu.check("a toggle option", function(state) { /* ... */ });
menu.check("a checked toggle option", true);
menu.check("a checked toggle callback", true, function(state) { /* ... */ });
menu.spacer();
menu.cancel("exit", function() { program.halt(); process.exit(0); });

// run single screen program
program.run("main");

What's the license?

Public Domain; in jurisdictions that do not recognise the public domain, MIT.

terminal-menu-program's People

Contributors

pomax avatar

Watchers

James Drew avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.