Stacks API

Checkbox — checkbox

Overview

• Type:checkbox
• Output Value:any value

A checkbox for enabling or selecting from two options.

Although a checkbox would seem to return a boolean value, for historical reasons a checkbox control is able to return any value type. This means, by using the True Value and False Value properties a checkbox can return the string "Jedi" if checked and the value "Sith" when unchecked, or integers, floats, or booleans.

Available: Stacks API v1

True Value

• Key:min
• Type:number
• Default Value:0

False Value

• Key:max
• Type:number
• Default Value:20

Default Value

• Key:default
• Type:string
• Default Value:The first menu item.

Clear Value

• Key:clearValue
• Type:string
• Default Value:""

ID

• Key:id
• Type:string
• Required

The ID for this control. This ID must be unique within this stack. The ID is used to refer to control's property. IDs should be alpha-numeric (dashes and underscores are allowed), but should not contain special characters.

Title

• Key:title
• Type:string
• Default Value:"Untitled"
• Required

The title displayed next to the control. Long titles will be trancated, so keep it short.

Enable

• Key:enable
• Type:dictionary
• Default Value:enabled

Hide or show the control based on the value of another property.

Enables allow a stack to show only the controls needed by the user to achieve a specific task.

The enable dictionary defines the ID of another control and the value that other control must equal. When the other control's value is not equal to the provided value, this control is hidden.

Enable Dictionary

• id (string) — the ID of another control on which this control (Popup Menu) should depend.
• value (any type) — when the value of the other control is equal to this value, this control is displayed, otherwise it is hidden.

Warning: creating infinite loops in enable dependencies has undefined behavior but will likely result in a crash.

Tool Tip

• Key:toolTip
• Type:string
• Default Value:No tooltip is displayed.

The tooltip value is used to display hints for the user on the use of each control. If the function of the control is obvious, then a tooltip should be avoided. Simply re-displaying redundant information like the title has no value to the user.