# @wllr9505/target-menu
> Simple terminal menu
Latest version **2.1.0** (published 2020-08-26) · MIT license · 0 weekly downloads
## Install
```sh
npm install @wllr9505/target-menu
pnpm add @wllr9505/target-menu
yarn add @wllr9505/target-menu
bun add @wllr9505/target-menu
```
## 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 | 2.1.0 |
| Published | 2020-08-26 |
| First published | 2020-08-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 218.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Weuller Jr. Souza |
| Maintainers | wllr9505 |
| Keywords | terminal, menu, simple |
## Links
- npm: https://www.npmjs.com/package/@wllr9505/target-menu
- Repository: https://github.com/WLLR9505/target
- Homepage: https://github.com/WLLR9505/target#readme
- Issues: https://github.com/WLLR9505/target/issues
- npm.io page: https://npm.io/package/@wllr9505/target-menu
## Dependencies (3)
- [@types/node](https://npm.io/package/@types/node.md) ^13.11.1
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10
- [@types/readline-sync](https://npm.io/package/@types/readline-sync.md) ^1.4.3
## Alternatives
- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads
## Recent versions
- 2.1.0 (latest) — 2020-08-26
## README
target-menu
Um simples menu customizável utilizando o terminal
# Sumário
* [Instalação](#Instalação)
* [Usando](#Usando)
* [Submenu](#Submenu)
* [Flexmenu](#Flexmenu)
* [Estrutura do Menu variável](#Estrutura-do-Menu-variável)
* [Retorno do flexMenu](#Retorno-do-flexMenu)
* [Controles](#Controles)
---
# Usando
```js
// 1 - faça require do módulo
var target = require('target-menu');
// 2 - crie os controles
var control = new target.Controls();
// 3 - crie o(s) menu(s)
//NOTA: submenu é opcional
var example = [
'item',
'item',
'item',
'item',
'item',
];
var sub = ['alterar', 'excluir'];
// 4 - faça um loop chamando o menu
while (control.pos1 >= 0) {
target.menu(control, 'cyan', example, sub);
// 5 - faça um ponto de saida logo em seguida
if (control.pos1 == -1) {
console.clear();
return 0;
}
// 6 - chame suas funções baseadas nos seletores do menu
if (control.pos2 == 0) {
yourFunction(control.pos1);
} else if (control.pos2 == 1) {
yourSecondFunction(control.pos1);
}
}
```
[Voltar ao Sumário](#Sumário)
## Submenu
O uso do submenu é opcional e indicado apenas quando o menu principal tem o mesmo submenu para seus itens, exemplo: listas. Quando utilizado o **.pos1** indicará o item do menu principal selecionado, e o **.pos2** a função que será aplicada neste item.
Se não for utilizar o submenu o omita da função e utilize apenas **.pos1**
[Voltar ao Sumário](#Sumário)
## Flexmenu
O flexMenu contorna o problema dos submenus, ele permite que sejam utilizados submenus diferentes para cada item que compõe o menu, porém sua sintaxe é diferente.
> as imagens acima representam o menu em forma horizontal e vertical, essa opção é definida no último parâmetro da função `flexMenu()` devendo ser utilizado 'h' para horizontal e 'v' para vertical
### Estrutura do Menu variável
A variável que armazena este tipo de menu é um Array, esse array contém dentro de si outro Array onde: **a primeira posição é o item a ser exibido no menu** e **a segunda posição é o submenu deste item** *que pode ser omitido*.
### Retorno do flexMenu
Quando não houver submenu o flexMenu retornará o item selecionado em forma de array porém os indicadores de posição dos controles ainda podem ser utilizados.
```js
// 1 - faça require do módulo
var target = require('target-menu');
// 2 - crie os controles
var control = new target.Controls();
// 3 - crie a estrutura de menus
let menu = [
['profile'],
['social', ['instagram', 'twitter', 'discord', 'steam']],
['following'],
['followed']
];
(function exampleFlexMenu() {
let selected; // 4 - crie uma variável para armazenar o retorno do menu (quando ele não possuir submenu)
while (control.pos1 >= 0) { // 5 - faça um loop chamando o menu
selected = flexMenu(control, 'green', menu, 'v');
switch (control.pos1) { // 6 - faça a estrutura que manipalará o menu (utilize ifs ou switch)
case -1:
break;
case 0:
print(selected); // output : ['profile']
break;
case 1:
print(menu[control.pos1][1][control.pos2]);
break;
case 2:
print(selected[0]); // output : following
break;
case 3:
print(selected);
break;
}
}
})();
```
[Voltar ao Sumário](#Sumário)
# Controles
A classe controles possui além das teclas responsáveis pelo direcionamento do menu, a posição atual do seletor no menu **.pos1** e **.pos2** que devem ser utilizados para se referir as funções dos mesmos depois de selecionados.
Os controles padrões utilizando:
```js
var control = new Controls();
```
| função | Tecla |
|-|-|
| selecionar | e |
| voltar/sair | q |
| cima | w |
| baixo | s |
| direita | d |
| esquerda | a |
> **Nota**: você pode customizar os controles passando como parâmetros seguindo a ordem acima:
> ```js
> var control = new target.Controls('o', 'u', 'i','k', 'l', 'j');
> ```
[Voltar ao Sumário](#Sumário)
---
_Source: https://npm.io/package/@wllr9505/target-menu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._