-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathproperties.schema
executable file
·256 lines (256 loc) · 9.25 KB
/
properties.schema
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://jsonschema.net",
"$ref": "http://localhost/plugins/content/component/model.schema",
"globals": {
"ariaRegion": {
"type": "string",
"required": true,
"default": "Selectable image component. Select each item to show more information.",
"inputType": "Text",
"validators": []
},
"item": {
"type": "string",
"title": "Hotgrid item label",
"required": true,
"default": "Item",
"inputType": "Text",
"validators": [],
"help": "This is the aria label that indicates the item number."
},
"previous": {
"type": "string",
"title": "Hotgrid popup previous label",
"default": "{{#if title}}Back to {{{title}}} (item {{itemNumber}} of {{totalItems}}){{else}}{{_globals._accessibility._ariaLabels.previous}}{{/if}}",
"inputType": "Text",
"translatable": true,
"help": "This is the aria label for the previous button in the popup."
},
"next": {
"type": "string",
"title": "Hotgrid popup next label",
"default": "{{#if title}}Forward to {{{title}}} (item {{itemNumber}} of {{totalItems}}){{else}}{{_globals._accessibility._ariaLabels.next}}{{/if}}",
"inputType": "Text",
"translatable": true,
"help": "This is the aria label for the next button in the popup."
},
"popupPagination": {
"type": "string",
"title": "Hotgrid popup pagination",
"required": true,
"default": "{{itemNumber}} / {{totalItems}}",
"inputType": "Text",
"validators": [],
"help": "This is the aria label for each item. Use {{itemNumber}} and {{totalItems}} in your text to tell the user which item they are viewing and how many items there are in total.",
"translatable": true
}
},
"properties": {
"_supportedLayout": {
"type": "string",
"required": true,
"enum": ["full-width", "half-width", "both"],
"default": "full-width",
"editorOnly": true
},
"instruction": {
"type": "string",
"required": false,
"default": "Select the images to find out more.",
"inputType": "Text",
"validators": [],
"translatable": true
},
"_setCompletionOn": {
"type": "string",
"required": false,
"default": "allItems",
"title": "Set completion on:",
"enum": ["inview", "allItems"],
"inputType": {
"type": "Select",
"options": ["inview", "allItems"]
},
"validators": [],
"help": "Whether completion is based on the learner having viewed all the items - or just having viewed the component"
},
"_hidePagination": {
"type": "boolean",
"required": true,
"default": false,
"title": "Hide pagination",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the progress indicator and previous and next links will not be shown on the popup toolbar"
},
"_canCycleThroughPagination": {
"type": "boolean",
"required": true,
"default": false,
"title": "Cycle through item pagination",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, the popup navigation buttons will cycle continuously through the popup items (i.e. clicking next on the last item will cause the first item to be shown)."
},
"_columns": {
"type": "number",
"required": true,
"title": "Columns",
"inputType": "Number",
"default": 3,
"validators": ["number"],
"help": "This value determines the number of columns within the grid. Any number of columns can be set however keep in mind the more columns there are the smaller the items will be."
},
"_isRound": {
"type": "boolean",
"required": false,
"default": false,
"title": "Should item image be round?",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, a 50% border radius will be applied to the item images including the pop up."
},
"_showPlusIcon": {
"type": "boolean",
"required": true,
"default": false,
"title": "Show plus icon",
"inputType": "Checkbox",
"validators": [],
"help": "Show a plus icon on each item. The default is 'false'"
},
"_items": {
"type": "array",
"required": true,
"title": "Items",
"items": {
"type": "object",
"required": true,
"properties": {
"title": {
"type": "string",
"required": true,
"default": "",
"title": "Item Popup Title",
"inputType": "Text",
"validators": ["required"],
"translatable": true
},
"body": {
"type": "string",
"required": false,
"default": "",
"title": "Item Popup Body",
"inputType": "TextArea",
"validators": [],
"translatable": true
},
"_imageAlignment": {
"type": "string",
"required": false,
"default": "right",
"inputType": {"type":"Select", "options":["left","top","right","bottom"]},
"title": "Image alignment",
"help": "Defines the alignment of the item image in the pop up. Left: Image aligned to the left of the text area. Top: Image aligned above the text area. Right: Image aligned to the right of the text area. Bottom: Image aligned below the text area.The default alignment is `right`."
},
"_classes": {
"type": "string",
"required": false,
"default": "",
"title": "Item Popup Classes",
"inputType": "Text",
"validators": [],
"help": "Allows you to specify custom CSS classes to be applied to the popup item. 'hide-desktop-image' hides the pop up image in desktop view. 'hide-popup-image' hides the pop up image for all screen sizes."
},
"_graphic": {
"type": "object",
"required": true,
"title": "Item Graphic",
"properties": {
"src": {
"type": "string",
"required": true,
"default": "",
"inputType": "Asset:image",
"validators": ["required"],
"help": "The item image (default state)."
},
"srcHover": {
"type": "string",
"required": false,
"default": "",
"inputType": "Asset:image",
"validators": [],
"help": "The item image (hover state)."
},
"srcVisited": {
"type": "string",
"required": false,
"default": "",
"inputType": "Asset:image",
"validators": [],
"help": "The item image (visited state)."
},
"alt": {
"type": "string",
"required": false,
"default": "",
"title": "Alternative text",
"inputType": "Text",
"validators": [],
"help": "A description of the image; required when it has meaning that must be conveyed to the learner. For 'decorative' images, leave this blank. By default, the item is labelled by the 'title', if set, otherwise a generic 'Item 1, 2, 3 etc'. Followed by the alternative text.",
"translatable": true
},
"title": {
"type": "string",
"required": false,
"default": "",
"title": "Item Title",
"inputType": "Text",
"validators": [],
"help": "Optional image title, displayed under the grid item image.",
"translatable": true
}
}
},
"_itemGraphic": {
"type": "object",
"required": true,
"title": "Popup Graphic",
"properties": {
"src": {
"type": "string",
"required": false,
"default": "",
"inputType": "Asset:image",
"validators": [],
"help": "Only needs to be set if you want a different image to be shown. If left blank, the Item Graphic (default state) will be displayed in the popup."
},
"alt": {
"type": "string",
"required": false,
"default": "",
"title": "Alternative text",
"inputType": "Text",
"validators": [],
"help": "A description of the image; required when it has meaning that must be conveyed to the learner. For 'decorative' images, leave this blank.",
"translatable": true
},
"attribution": {
"type": "string",
"required": false,
"default": "",
"inputType": "Text",
"validators": [],
"help": "Text to be displayed as an attribution for the popup image",
"translatable": true
}
}
}
}
}
}
}
}