Class: IQMenu

Core.IQMenu

Hierarchy

• IQMenu

  ↳ Menu

Table of contents

Constructors

• constructor

Properties

• commands
• description
• name

Methods

• keypressed
• prompt
• render

Constructors

constructor

• new IQMenu(options)

Parameters

Name	Type
options	IQMenuOptions

Defined in

core/src/index.ts:616

Properties

commands

• commands: Object

Index signature

▪ [s: string]: (…args: any) => any

Defined in

core/src/index.ts:614

---

description

• Optional description: string

Defined in

core/src/index.ts:612

---

name

• Optional name: string

Defined in

core/src/index.ts:611

Methods

keypressed

▸ keypressed(cmdkeys?): string

Parameters

Name	Type
cmdkeys	null | string

Returns

string

Defined in

core/src/index.ts:698

---

prompt

▸ prompt(options?): IQMenuPromptFunctions

Will render a prompt to the screen.

example menu.prompt({ x: 20, y: 30, text: “Feed me: “ }).command(cmdkey) menu.prompt({ text: “Enter your command: “.color(“bright cyan”), x: 20, y: 20 }).command(cmdkey) menu.prompt({ x: 20, y: 30, text: “Feed me: “ }).command(cmdkey, (response, error) => { if (response.error) { alert(errors) } })

Parameters

Name	Type
options?	string | IQMenuPromptOptions

Returns

IQMenuPromptFunctions

Functions that can be chained to the prompt.

Defined in

core/src/index.ts:665

---

render

▸ render(module, options?): void

Parameters

Name	Type
module	Function
options?	IQMenuLoopOptions

Returns

void

Defined in

core/src/index.ts:623