ButtonOptions

The ButtonOptions type defines the configuration for an individual button in ts-better-console. It specifies the label, styling, hover styling, and click handler for a terminal button.

Type Definition

The ButtonOptions type includes the following properties:

• label: A string representing the text displayed on the button.
• style: An optional StyleOptions object that defines the default styling of the button.
• hoverStyle: An optional StyleOptions object that defines the styling applied when the button is hovered or focused.
• onClick: A callback function that is invoked when the button is clicked.

type ButtonOptions = {
  label: string;
  style?: StyleOptions;
  hoverStyle?: StyleOptions;
  onClick: () => void;
}

Usage

You can use ButtonOptions when creating buttons in the terminal:

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

const buttonGroup = new ButtonGroup([
  {
    label: "Click Me",
    style: { color: "white", backgroundColor: "blue" },
    hoverStyle: { color: "white", backgroundColor: "cyan" },
    onClick: () => {
      // Handle button click
      console.log("Button clicked!");
      buttonGroup.destroy();
    }
  }]);

buttonGroup.show();