MenuOptions

The MenuOptions type defines the configuration options for a menu component in ts-better-console. These options allow you to customize the appearance and behavior of the interactive menu, including selection icons, styling, and the default selected index.

Type Definition

The MenuOptions type includes the following properties:

• selectedIcon: An optional string for the icon displayed next to the currently selected menu item.
• unselectedIcon: An optional string for the icon displayed next to unselected menu items.
• focusStyle: An optional StyleOptions object defining the styling applied to the focused/selected item.
• itemStyle: An optional StyleOptions object defining the default styling for all menu items.
• defaultIndex: An optional number specifying the index of the item that should be selected by default when the menu is first displayed.

type MenuOptions = {
  selectedIcon?: string;
  unselectedIcon?: string;
  focusStyle?: StyleOptions;
  itemStyle?: StyleOptions;
  defaultIndex?: number;
}

Usage

You can pass MenuOptions when creating a menu to customize its appearance:

import { Menu } from "ts-better-console";

new Menu(
[
{ label: "Apple" },
{ label: "Banana" },
{ label: "Cherry" },
],
{
selectedIcon: "👉",
unselectedIcon: " ",
focusStyle: { color: "cyan", styles: ["bold"] },
defaultIndex: 0,
}
).show();