Interface: BBSMenuOptions
core/bbs.BBSMenuOptions
Options for declarative menu definition
Table of contents
Properties
- art
- artCenter
- artX
- artY
- basepath
- col1X
- col1Y
- col2X
- col2Y
- hotkeys
- itemFormat
- items
- itemsX
- itemsY
- layout
- mouse
- mouseHighlightFormat
- prompt
- promptX
- promptY
Properties
art
• Optional art: string
Artwork filename to display
Defined in
artCenter
• Optional artCenter: "auto" | "horizontal" | "vertical" | "both" | "none"
Centering mode for menu artwork positioning based on screen resolution.
- ‘auto’: Center if artwork is smaller than screen (default)
- ‘horizontal’: Center horizontally only
- ‘vertical’: Center vertically only
- ‘both’: Always center both axes
- ‘none’: No centering, render at 1,1 (legacy behavior)
Defined in
artX
• Optional artX: number
Explicit X position for artwork (1-indexed). Overrides centering.
Defined in
artY
• Optional artY: number
Explicit Y position for artwork (1-indexed). Overrides centering.
Defined in
basepath
• Optional basepath: string
Base path for artwork files
Defined in
col1X
• Optional col1X: number
Column 1 (left) X position for two-column layout
Defined in
col1Y
• Optional col1Y: number
Column 1 (left) starting Y position
Defined in
col2X
• Optional col2X: number
Column 2 (right) X position for two-column layout
Defined in
col2Y
• Optional col2Y: number
Column 2 (right) starting Y position
Defined in
hotkeys
• Optional hotkeys: boolean
Enable keyboard hotkeys for menu items (default true)
Defined in
itemFormat
• Optional itemFormat: string
| Format string for menu items (e.g., “ | 11[ | 15{key} | 11] | 07{label}”) |
Defined in
items
• items: BBSMenuItem[]
Menu items
Defined in
itemsX
• Optional itemsX: number
Starting X position for single-column layout
Defined in
itemsY
• Optional itemsY: number
Starting Y position for items (used by both layouts if col1Y/col2Y not set)
Defined in
layout
• Optional layout: "single" | "two-column"
Layout mode for auto-positioning
Defined in
mouse
• Optional mouse: boolean
Enable SGR mouse for clicking items (default true)
Defined in
mouseHighlightFormat
• Optional mouseHighlightFormat: string
| MCI string for “pressed” look when an item is clicked (e.g. “ | 15 | 16”) |
Defined in
prompt
• Optional prompt: string
Custom prompt text (supports MCI/pipe codes)
Defined in
promptX
• Optional promptX: number
X position for prompt (if not specified, auto-centered)
Defined in
promptY
• Optional promptY: number
Y position for prompt (if not specified, uses layout default)