Interface: IQMenuOptions

core/menu.IQMenuOptions

Table of contents

Properties

• art
• autoRenderItems
• basepath
• commands
• data
• description
• globalHotkeys
• hotkeys
• itemFormat
• itemsX
• itemsY
• mouse
• mouseHighlightFormat
• name
• prompt
• promptX
• promptY

Properties

art

• Optional art: IQMenuArtOptions

Defined in

core/src/menu.ts:70

---

autoRenderItems

• Optional autoRenderItems: boolean

Defined in

core/src/menu.ts:77

---

basepath

• Optional basepath: string

Defined in

core/src/menu.ts:71

---

commands

• Optional commands: IMenuCommands & { default?: IMenuCommand }

Defined in

core/src/menu.ts:68

---

data

• Optional data: any

Defined in

core/src/menu.ts:69

---

description

• Optional description: string

Defined in

core/src/menu.ts:67

---

globalHotkeys

• Optional globalHotkeys: Record<string, () => Promise<void>>

Global hotkeys run before menu commands (e.g. “/” for quick AI). Handler runs, then menu loop continues.

Defined in

core/src/menu.ts:86

---

hotkeys

• Optional hotkeys: boolean

Enable keyboard hotkeys for menu items (default true)

Defined in

core/src/menu.ts:80

---

itemFormat

• Optional itemFormat: string

Defined in

core/src/menu.ts:78

---

itemsX

• Optional itemsX: number

Defined in

core/src/menu.ts:75

---

itemsY

• Optional itemsY: number

Defined in

core/src/menu.ts:76

---

mouse

• Optional mouse: boolean

Enable SGR mouse for clicking items (default true)

Defined in

core/src/menu.ts:82

---

mouseHighlightFormat

• Optional mouseHighlightFormat: string

MCI string for “pressed” look when an item is clicked (e.g. “

15

16”). If omitted, reverse video is used.

Defined in

core/src/menu.ts:84

---

name

• name: string

Defined in

core/src/menu.ts:66

---

prompt

• Optional prompt: string

Defined in

core/src/menu.ts:72

---

promptX

• Optional promptX: number

Defined in

core/src/menu.ts:73

---

promptY

• Optional promptY: number

Defined in

core/src/menu.ts:74