Create independent scrollable areas with ANSI support in the terminal.

Install

npm install scrollable-cli

Usage

Create a scrollable area with content and print it:

import Scrollable from 'scrollable-cli';

const box = Scrollable({
    content:
        "Lorem ipsum is boring but I couldn't think " +
        "of anything else, so here's a yellow cat:" +
        chalk.yellow(`
        |\\---/|
        | o_o |
        `),
    start: { x: 10, y: 3 },
    size: { width: 22, height: 4 },
    wrapOptions: { trim: false, hard: false, wordWrap: true }
})
.print();

Or use the fluent API:

const box = Scrollable()
    .setContent("...")
    .setStart({ x: 10, y: 3 })
    .setSize({ width: 22, height: 4 })
    .setWrapOptions({ trim: false, hard: false, wordWrap: true })
    .print();

Scroll the content up and down:

box.scroll(1).print(); // Down

box.scroll(-1).print(); //Up

Key press events

This package doesn't handle keypress events to make it easier for you to integrate it with your own keypress event handler:

const box = Scrollable(/* ... */);

emitKeypressEvents(process.stdin);
process.stdin.setRawMode(true);

process.stdin.on('keypress', (str, key) => {
    switch (key.name) {
    case 'up':
        box.scroll(-1).print();
        break;
    case 'down':
        box.scroll(1).print();
        break;
    }
});

Examples

1. Clone the repo:

git clone https://github.com/pawap90/scrollable-cli.git

2. Install dependencies:

npm install

3. Run the examples:

npm run example --file=<example-file-name>

## Or for windows:
npm run example:win --file=<example-file-name>

## E.g:
npm run example --file=1-simple-box

npm run example:win --file=1-simple-box

| Example file | Description | | -------- | -------- | | 1-simple-box | Prints a simple "lorem ipsum" box that scrolls automatically up and down. | | 2-keypress-events | Prints 3 independent boxes that can be scrolled up and down with the arrow keys. |

Test

npm test