UNPKG

menu-string

Version:

Generate a menu with selectable menu items as a string

github.com/watson/menu-string

watson/menu-string

144 lines (99 loc) • 3.5 kB
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# menu-string Generate a menu with selectable menu items as a string. [![npm](https://img.shields.io/npm/v/menu-string.svg)](https://www.npmjs.com/package/menu-string) [![Build status](https://travis-ci.org/watson/menu-string.svg?branch=master)](https://travis-ci.org/watson/menu-string) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) ## Installation ``` npm install menu-string --save ``` ## Usage ```js const Menu = require('menu-string') const menu = new Menu({ items: [ {text: 'Item 1'}, {text: 'Item 2'}, {text: '------', separator: true}, {text: 'Item 3'} ], selected: 0 }) console.log(menu.toString()) // > Item 1 // Item 2 // ------ // Item 3 // Move cursor one item down menu.down() console.log(menu.toString()) // Item 1 // > Item 2 // ------ // Item 3 ``` ## API ### `menu = new Menu(options)` Initialize a new `menu` object. Options: - `items` - An array of `item` objects - `render` - An optional render function that will be called for each menu item that is rendered. Will be called with the `item` object that should be rendered and a boolean indicating if the `item` is currectly selected. Should return a rendered string representing the menu item. The `item` object will have an `index` property indicating its position in the menu - `selected` - An optional integer specifying which menu item should be selected by default (defaults to `0`) - `height` - Set menu max height (in rows). If set, the menu will maintain a viewport, only ever rendering that amout of menu items. When moving the cursor up or down, the viewport will scroll to accommodate. An `item` object can have the following properties: - `text` - The text to show when rendering the item - `separator` - A boolean indicating if the item can be selected - `marked` - A boolean indicating if the item should me "marked". This property can be toggled using `item.toggleMark()`. It's up the the implementer to render marked items differently. An `item` can also just be a string, which is treated as `{text: item}`. If no custom render function is provided, the following default render function is used: ```js function (item, selected) { return (selected ? '> ' : ' ') + item.text } ``` ### `menu = new Menu(items)` An alias for: ```js new Menu({ items: items }) ``` ### Event: `update` An update event is emitted when ever the menu is updated - i.e. the cursor is moved. ### `menu.items` Array of menu items. ### `success = menu.up()` Move the cursor one item up. Separator items will be skipped. Returns `false` if top of menu have been reached. Returns `true` otherwise. ### `success = menu.down()` Move the cursor one item down. Separator items will be skipped. Returns `false` if bottom of menu have been reached. Returns `true` otherwise. ### `menu.select(index)` Select a specific menu item. Returns `false` if the index was invalid. Returns `true` otherwise. ### `item = menu.selected()` Returns the selected `item` object. The returned `item` object will have an `index` property indicating its position in the menu. Returns `null` if no selectable menu item exists. ### `menu.toggleMark()` Toggle the `marked` boolean of the currently selected item. ### `str = menu.toString()` Returns the entire menu as a single string. One line for each menu item rendered by the render function. ## License [MIT](LICENSE)