# menu-string

> Generate a menu with selectable menu items as a string

Latest version **1.3.0** (published 2018-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install menu-string
pnpm add menu-string
yarn add menu-string
bun add menu-string
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2018-12-26 |
| First published | 2017-12-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Thomas Watson |
| Maintainers | watson |
| Keywords | menu, cli, terminal, ui, gui, list, select |

## Links

- npm: https://www.npmjs.com/package/menu-string
- Repository: https://github.com/watson/menu-string
- Homepage: https://github.com/watson/menu-string#readme
- Issues: https://github.com/watson/menu-string/issues
- npm.io page: https://npm.io/package/menu-string

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2018-12-26
- 1.2.0 — 2017-12-29
- 1.1.0 — 2017-12-28
- 1.0.0 — 2017-12-27

## README

# 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)

---
_Source: https://npm.io/package/menu-string · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._