Stacks API

Checkbox — checkbox

• Type:checkbox
• Array Types:checkbox-2, checkbox-3, checkbox-4
• Output Value:any value

Available: Stacks API v8

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.

Radio Mode

Checkboxes arrays can be used where only one of the group is allowed to be checked at a time. To use checkboxes in this mode use one of the array types (see below) and enable the Radio property.

New

Checkbox Array

Checkboxes can be used in arrays. Each has its own subtitle, trueValue, falseValue, and default, all other values are shared.

NB: checkbox-3 and trueValue/falseValue arrays requires Stacks API v8 (Stacks v3.1+), 2 & 4 require v7 (Stacks v3.0+), single control requires v1.

Checkbox types are:

• checkbox : a regular checkbox.
• checkbox-2 : two checkboxes.
• checkbox-3 : three checkboxes.
• checkbox-4 : four checkboxes.

Radio Buttons

• Key:radio
• Type:boolean

True Value

• Key:trueValue
• Type:string
• Default Value:true

False Value

• Key:falseValue
• Type:string

Default Value

• Key:default
• Type:boolean
• Default Value:False (not pushed in)

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 truncated, 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.
• index (number) - for arrayed controls you’ll need to specify the index of the array id.
• round (boolean) - whether or not to round numeric control values. the default is YES. you must set this value to NO to disable – even if the property that’s being matched has rounding enabled.
• operation (string) - can be any of the following: ==, <, <=, >, >=, contains, matches, or caseInsensitiveMatches.

Enable Operations

• == - (any type) - default compares any two values. to maintain backwards compatibility rounding is never applied. (aliases: =, equals, equalTo)
• < - (number) - less than. (aliases: lessThan)
• <= - (number) - less than or equal to. (aliases: lessThanOrEqualTo, lessThanOrEquals)
• > - (number) - greater than. (aliases: greaterThan)
• >= - (number) - greater than or equal to. (aliases: greaterThanOrEqualTo, greaterThanOrEquals)
• contains - (string) - This does a case insensitive match of the value anywhere in the string.
• matches - (string) - Wildcard match. Examples: Red (matches: Red and Reddish), R?d (matches: Red and Rad )
• caseInsensitiveMatches - (string) - Similar to matches but ignores case.

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

NB: macOS does not specify the wildcard characters available or how they function. * and ? clearly work as they do in a UNIX shell. you’ll just have to guess at the rest.

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.

Subtitles

• Key:subtitles
• Type:array of strings
• Default Value:No subtitles are displayed.

Subtitles are displayed under the control. Subtitles are unique for each item in a control array. You should provide one for each item in the control array. In the plist the subtitles should be an array of Subtitle strings. Note that some controls have very little space, so only very short subtitles can be used.

Scope

• Key:scope
• Type:string
• Default Value:"each"

New

The scope of a property can be set to bind to the page instead of each stack. Binding a property to the page-scope means that the values set by this control will be shared between all stack-instances on the page.

Inheritance

• Key:inheritsFrom
• Type:string
• Default Value:No inheritance.

New

Inheritance allows one stack to pull in the controls and properties of another stack. All of the controls from the specified stack are pulled in to the current stack. The inherited controls will be ordered as if they were they were first in the plist customItems array. The value should be the ID of the stack to inherit from.