IntelliJ Platform Plugin SDK Help

Toggle Button

The toggle button is used to switch between On and Off states.

Toggle button example

When to use

Use the toggle button to switch the state of an item in search results:

Example se

Do not use the toggle button for items in dialogs and menus. Instead, use a checkbox in dialogs and a checkmark in menus:

When to use dialog or menu

How to use

Label

The toggle button in search results should duplicate the option from the settings or the menu. Label and capitalization should be the same as on the option label:

Label checkbox
Setting in the preferences

Label checkbox se
The same setting in search results

Do not make a setting available only from search results.

If the setting is in a tree or menu, use the toggle button label to specify where the setting is located:

Label tree
Setting in a tree

Label tree se
The same setting in search results; separate tree levels with a colon

Label menu
Setting in the main menu

Label menu se
The same setting in search results; separate the first menu level with a vertical bar, and separate others with a colon

Refer to checkbox for writing checkbox labels and menu labels.

Do not add the word "On" or "Off" to the item name, since the state description is already in the toggle button.

Control

A toggle button is implemented with the OnOffButton class. But generally, you shouldn't use the class directly. The IDE automatically places the buttons in the search feed if you follow one of the patterns described below:

  1. If this is a system or editor or another kind of settings, register the corresponding BooleanOptionDescription for the option. The options can be bound (but not limited) to:

  2. Implement your own action that's inherited from ToggleAction and registered in plugin.xml.

The toggle button changes state when it is clicked with the mouse or when Enter is pressed on the item line.

Last modified: 07 August 2024