Interface QuickInputButton

A button for an action in a QuickPick or InputBox.

interface QuickInputButton {
    iconPath: IconPath;
    location?: QuickInputButtonLocation;
    toggle?: { checked: boolean };
    tooltip?: string;
}

Index

Properties

iconPath location? toggle? tooltip?

Properties

`Readonly`iconPath

iconPath: IconPath

The icon for the button.

`Optional`location

location?: QuickInputButtonLocation

The location where the button should be rendered.

Defaults to QuickInputButtonLocation.Title.

Note: This property is ignored if the button was added to a QuickPickItem.

`Optional` `Readonly`toggle

toggle?: { checked: boolean }

When present, indicates that the button is a toggle button that can be checked or unchecked.

Type Declaration

checked: boolean
Indicates whether the toggle button is currently checked. This property will be updated when the button is toggled.

`Optional` `Readonly`tooltip

tooltip?: string

An optional tooltip displayed when hovering over the button.