/controls/number/index/

Number — `number`

Type:number
Array Types:number-2, number-3, number-4
Output Value:number

Available: Stacks API v8

A text entry field that validates only numbers in an allowed range. There are up/down arrows next to text entry to increment/decrement the number.

New

Number Control Array

Number controls can be used in arrays. Each has its own subtitle and default, all other values are shared.

NB: number-3 requires Stacks API v8 (Stacks v3.1+), 2 & 4 require v7 (Stacks v3.0+), single control requires v2.

Number control types are:

number : a regular number control.
number-2 : two number controls.
number-3 : three number controls.
number-4 : four number controls.

Minimum

Key:min
Type:number
Default Value:0

The minimum value for the slider.

Maximum

Key:max
Type:number
Default Value:20

The maximum value for the slider.

Rounding

Key:round
Type:Boolean
Default Value:true

If rounding is enabled then the returned values will be integers. When disabled returned values will be floating point. Rounding is enabled by default

Note: because rounding is enabled by default, you must include this key and set it to False in order to disable rounding.

Units

Key:units
Type:string
Default Value:No units are displayed.

The units string is displayed next to the slider value. The units is strictly for the user interface, it will not be included in template output value.

Default Value

Key:default
Type:number
Default Value:0

When the stack is placed onto the page the default value will be used. If no default is provided, 0 will be used.

Clear Value

Key:clearValue
Type:string
Default Value:""

When all the content is cleared out of a text input area (the user deletes all the text), the control will automatically fill with this value. This is useful for applications where a non-empty string is required.

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.

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.

Number — number