A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

+

== Purpose ==

+

''Toggle buttons'' look similar to regular buttons, but are used to show or change a state rather than initiate an action. A toggle button's two states, set and unset, are shown by its appearing "pushed in" or "popped out" respectively.

−

==When to Use==

+

Toggle buttons are a valid option to indicate a state with the advance of using an icon. Compared to the related radio button or check box they are an efficient way to save screen space. But toggle buttons should be used with care outside a toolbar because the state is not clearly indicated.

−

Use a toggle button to indicate a '''state'''.

+

== Example ==

−

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

+

== Guidelines ==

−

+

=== Is this the right control ===

−

==When not to Use==

+

* Use a toggle button to indicate a state if no other control apply, i.e. in case of the [[Projects/Usability/HIG/toolbar|toolbar]].

Example: A music player should not use a toggle button to implement a Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

+

* Separate toggle buttons from other controls, so they are not mistaken for push buttons.

−

+

* Do not use a toggle button to initiate an action.

−

==How to Use==

+

* Do not change the label according the button state.

−

+

=== Appearance ===

−

===Label Wording===

+

* Align groups of toggle buttons horizontally rather than vertically.

−

+

* Provide an access key in the label of all toggle buttons that allows the user to set or unset the button directly from the keyboard.

−

Label of toggle buttons can often be reduced to a "noun only" form instead of the classic "verb (+ noun)" used with classic buttons. The "noun only" form should be favored over the "verb (+ noun)" form whenever it does not cause any ambiguity as this form reduces clutter.

Example: A toggle button to show/hide a sidebar can be labeled either "Show Sidebar" or simply "Sidebar".

+

[http://api.kde.org/4.10-api/kdelibs-apidocs/kdeui/html/classKAction.html#KAction] is used to generate buttons in toolbars.

−

+

−

===Icon and Label===

+

−

+

−

In most cases one should never change the icon or label of a toggle button. A toggle button is very similar to a check box and should thus behave in the same way. The fact that it is pressed down is enough to indicate the current state of the element it represents.

+

−

+

−

It may make sense in some case to change the icon to reflect the '''current''' state. Think of it like an outdoor light switch with an embedded led to indicate whether the outdoor light is on.

+

−

+

−

In the "Sidebar" example, "Show Sidebar" should not be turned into "Hide Sidebar" when the sidebar is visible. If you consider it more explicit to change the icon and label of your button then you should use a normal button, not a toggle button.

+

−

+

−

[[File:Toggle-button-summary.png]]

+

Revision as of 11:07, 26 September 2013

Purpose

Toggle buttons look similar to regular buttons, but are used to show or change a state rather than initiate an action. A toggle button's two states, set and unset, are shown by its appearing "pushed in" or "popped out" respectively.

Toggle buttons are a valid option to indicate a state with the advance of using an icon. Compared to the related radio button or check box they are an efficient way to save screen space. But toggle buttons should be used with care outside a toolbar because the state is not clearly indicated.

Example

Guidelines

Is this the right control

Use a toggle button to indicate a state if no other control apply, i.e. in case of the toolbar.