1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
Built-in Setting Renderers
==========================
.. include:: version.rst
textLine
--------
Single line text input
**Argument**
Table with the following optional fields:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - name
- type (default)
- description
* - disabled
- bool (false)
- Disables changing the setting from the UI
checkbox
--------
True / false (yes/no) toggle
**Argument**
Table with the following optional fields:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - name
- type (default)
- description
* - disabled
- bool (false)
- Disables changing the setting from the UI
* - l10n
- string ('Interface')
- Localization context with display values for the true/false values
* - trueLabel
- string ('Yes')
- Localization key to display for the true value
* - falseLabel
- string ('No')
- Localization key to display for the false value
number
------
Numeric input
**Argument**
Table with the following optional fields:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - name
- type (default)
- description
* - disabled
- bool (false)
- Disables changing the setting from the UI
* - integer
- bool (false)
- Only allow integer values
* - min
- number (nil)
- If set, restricts setting values to numbers larger than min
* - max
- number (nil)
- If set, restricts setting values to numbers smaller than max
select
------
A small selection box with two next / previous arrows on the sides
**Argument**
Table with the following optional fields:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - name
- type (default)
- description
* - disabled
- bool (false)
- Disables changing the setting from the UI
* - l10n
- string (required)
- Localization context with display values for items
* - items
- #list<string> ({})
- List of options to choose from, all the viable values of the setting
color
-----
Hex-code color input with a preview
**Argument**
Table with the following optional fields:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - name
- type (default)
- description
* - disabled
- bool (false)
- Disables changing the setting from the UI
inputBinding
------------
Allows the user to bind inputs to an action or trigger
**Argument**
Table with the following fields:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - name
- type (default)
- description
* - key
- #string
- Key of the action or trigger to which the input is bound
* - type
- 'action', 'trigger'
- Type of the key
|
