How to use the List function from blessed

blessed.List is a class in the Blessed library that creates a scrollable list widget for the terminal.

How does blessed.List work?

blessed.List is a class in the blessed library that creates a scrollable list widget in the terminal interface that can be used to display a list of items, and handle user interactions such as scrolling and selecting items. It provides various properties and methods for configuring and manipulating the list, such as scroll, select, add, and remove.

Ai Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
const blessed = require("blessed");

// create a screen object
const screen = blessed.screen({
  smartCSR: true,
});

// create a list
const list = blessed.list({
  parent: screen,
  top: "center",
  left: "center",
  width: "50%",
  height: "50%",
  border: {
    type: "line",
  },
  style: {
    fg: "white",
    border: {
      fg: "#f0f0f0",
    },
    selected: {
      bg: "blue",
    },
  },
  items: ["Item 1", "Item 2", "Item 3"],
});

// select the first item in the list
list.select(0);

// handle key events
screen.key(["up", "down"], function (ch, key) {
  if (key.name === "up") {
    list.up();
  } else if (key.name === "down") {
    list.down();
  }
  screen.render();
});

// render the screen
screen.render();

In this example, a blessed.List is created and added to a blessed.Screen. The list is given a width and height of 50%, and its items are set to an array of three strings. The first item is selected by default. Finally, the screen is rendered and key events are handled to allow the user to navigate the list.