Toggler

Toggler[x]

represents a toggler button with setting x, that toggles between True and False.

Toggler[Dynamic[x]]

takes the setting to be the dynamically updated current value of x, with the value of x being toggled if the button is clicked.

Toggler[x,{val1,val2,}]

represents a toggler button that cycles through any sequence of values vali.

Toggler[x,{val1pict1,val2pict2,}]

cycles through values vali displaying them as picti.

Toggler[x,vlist,dpict]

displays as dpict if x is none of the vali.

Details and Options

  • Checkbox and Opener are effectively special cases of Toggler. »
  • Toggler[x] by default displays as x.
  • Clicking anywhere inside a Toggler advances to the next value.
  • Shift-clicking goes to the previous value.
  • The dpict case cannot be reached by clicking, only by externally setting x. »
  • The vali and picti in Toggler can be strings, boxes, graphics or any other expressions, including dynamic expressions. »
  • The following options can be given:
  • AutoActionFalsewhether to change the toggler automatically when the mouse is over it
    BaselinePositionAutomaticalignment relative to surrounding text
    BaseStyle{}base style specifications for the displayed toggler
    ContentPaddingTruewhether to shrink the margins tightly around the contents
    EnabledAutomaticwhether the toggler is enabled or grayed out
    ImageMargins0margins around the image of the displayed toggler
    ImageSizeAllthe overall image size of the displayed toggler
  • Controls such as Button and Slider are not clickable inside Toggler.
  • EventHandler intercepts mouse clicks, but passes them through to Toggler if the setting PassEventsDown->True is given.
  • The settings for BaseStyle are appended to the default style typically given by the "Toggler" style in the current stylesheet.

Examples

open allclose all

Basic Examples  (2)

Click the output to toggle its value:

Dynamically change the value of :

Scope  (3)

Include labels:

Display the last element () since the setting is not in the list of values:

Sometimes the setting is affected by external actions; in this display, "N/A":

Use any type of expression as values:

Options  (10)

Alignment  (1)

Align labels in the toggler:

All possible alignment positions:

AutoAction  (2)

By default, clicking the output toggles its value:

By setting AutoAction->True, the value toggles when the mouse moves over the output:

Background  (1)

Specify the background color:

BaselinePosition  (1)

Align with surrounding text:

Enabled  (2)

By default Toggler is enabled:

By setting Enabled->False, the toggler is disabled but visible in its current state:

FrameMargins  (1)

Increase the clickable area:

ImageMargins  (1)

Add margins to the toggler image:

ImageSize  (1)

Use numeric values:

Applications  (1)

Use Toggler to create a tic-tac-toe board, where every cell knows the game logic:

Properties & Relations  (1)

Checkbox and Opener are special cases of Toggler:

Introduced in 2007
 (6.0)