This repository has been archived by the owner on May 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
widget.json
202 lines (195 loc) · 7.8 KB
/
widget.json
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
{
"name": "laxar-headline-widget",
"description": "Shows a headline, possibly followed by a subtitle and/or buttons.",
"integration": {
"technology": "plain",
"type": "widget"
},
"styleSource": "scss/laxar-headline-widget.scss",
"features": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"headline": {
"type": "object",
"description": "The HTML text to be shown as a headline.",
"properties": {
"i18nHtmlText": {
"type": [
"string",
"object"
],
"description": "The (internationalized) HTML headline content."
},
"level": {
"type": "integer",
"description": "The hierarchical level of the headline (1 to 6).",
"minimum": 1,
"maximum": 6,
"default": 1
}
},
"additionalProperties": false
},
"intro": {
"type": "object",
"description": "Additional introductory HTML text to be shown below the headline.",
"properties": {
"i18nHtmlText": {
"type": [
"string",
"object"
],
"description": "The (internationalized) HTML intro content."
}
},
"additionalProperties": false
},
"buttons": {
"type": "array",
"description": "A list of buttons to be displayed next to the headline, each with individual action and other properties.",
"default": [],
"items": {
"type": "object",
"required": [ "action" ],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Determines if the button is used at all (true) or ignored completely (false).",
"default": true
},
"align": {
"type": "string",
"description": "The position relative to the headline.",
"enum": [
"LEFT",
"RIGHT"
],
"default": "RIGHT"
},
"index": {
"type": "integer",
"description": "The position at which the button is inserted.",
"default": 0
},
"i18nHtmlLabel": {
"type": [
"string",
"object"
],
"description": "An (internationalized) HTML label to display on the button."
},
"action": {
"type": "string",
"format": "topic",
"axRole": "outlet",
"description": "Topic name of the action to request taking upon button activation."
},
"accessKey": {
"type": "string",
"description": "A key (single character) which is used as a shortcut to this button."
},
"class": {
"type": "string",
"description": "The predefined semantic class that this button belongs to.",
"enum": [
"NORMAL",
"PRIMARY",
"INFO",
"SUCCESS",
"WARNING",
"DANGER",
"INVERSE",
"LINK"
],
"default": "NORMAL"
},
"size": {
"type": "string",
"description": "The size of the button on the bar, interpreted according to theme.",
"enum": [
"MINI",
"SMALL",
"DEFAULT",
"LARGE"
],
"default": "DEFAULT"
},
"hideOn": {
"type": "array",
"description": "List of flags. Setting any of these causes the button to be hidden from view, unsetting any reverses the effect. Space for the button is reserved in either state.",
"items": {
"type": "string",
"format": "flag-topic",
"axRole": "inlet",
"axPattern": "flag",
"description": "Flag topic. Prefixing the topic with '!' inverts its meaning."
}
},
"disableOn": {
"type": "array",
"description": "List of flags. Setting any of these causes the button to be disabled ('greyed out'), unsetting any reverses the effect.",
"items": {
"type": "string",
"format": "flag-topic",
"axRole": "inlet",
"axPattern": "flag",
"description": "Flag topic. Prefixing the topic with '!' inverts its meaning."
}
},
"omitOn": {
"type": "array",
"description": "List of flags. Setting any of these causes the button to be removed from the layout, unsetting any reverses the effect. Other buttons may claim this button's space while it is omitted.",
"items": {
"type": "string",
"format": "flag-topic",
"axRole": "inlet",
"axPattern": "flag",
"description": "Flag topic. Prefixing the topic with '!' inverts its meaning."
}
},
"busyOn": {
"type": "array",
"description": "List of flags. Setting any of these causes the button (icon) to indicate a busy state, unsetting any reverses the effect.",
"items": {
"type": "string",
"format": "flag-topic",
"axRole": "inlet",
"axPattern": "flag",
"description": "Flag topic. Prefixing the topic with '!' inverts its meaning."
}
}
}
}
},
"buttonArea": {
"type": "object",
"description": "Additional introductory HTML text to be shown below the headline.",
"properties": {
"align": {
"type": "string",
"description": "The position of the buttons. Either on the left side of the headline or on the right side.",
"enum": [
"LEFT",
"RIGHT"
]
}
}
},
"i18n": {
"description": "Which locale to use for displaying this widget.",
"type": "object",
"properties": {
"locale": {
"type": "string",
"format": "topic",
"axRole": "inlet",
"description": "The topic under which to expect the locale for this widget.",
"default": "default"
}
}
}
}
}
}