@pie-element/ebsr 12.3.4-next.3 → 13.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/configure/lib/defaults.js +23 -36
  2. package/configure/lib/defaults.js.map +1 -1
  3. package/configure/lib/index.js +114 -202
  4. package/configure/lib/index.js.map +1 -1
  5. package/configure/lib/main.js +188 -271
  6. package/configure/lib/main.js.map +1 -1
  7. package/configure/node_modules/@pie-element/multiple-choice/CHANGELOG.json +1972 -0
  8. package/configure/node_modules/@pie-element/multiple-choice/CHANGELOG.md +4213 -0
  9. package/configure/node_modules/@pie-element/multiple-choice/PRINT.md +35 -0
  10. package/configure/node_modules/@pie-element/multiple-choice/README.md +56 -0
  11. package/configure/node_modules/@pie-element/multiple-choice/choice.png +0 -0
  12. package/configure/node_modules/@pie-element/multiple-choice/configure/CHANGELOG.json +1387 -0
  13. package/configure/node_modules/@pie-element/multiple-choice/configure/CHANGELOG.md +3351 -0
  14. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/__tests__/root.test.js +248 -0
  15. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/defaults.js +200 -0
  16. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/defaults.js.map +1 -0
  17. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/index.js +211 -0
  18. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/index.js.map +1 -0
  19. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/main.js +477 -0
  20. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/main.js.map +1 -0
  21. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/utils.js +18 -0
  22. package/configure/node_modules/@pie-element/multiple-choice/configure/lib/utils.js.map +1 -0
  23. package/configure/node_modules/@pie-element/multiple-choice/configure/package.json +22 -0
  24. package/configure/node_modules/@pie-element/multiple-choice/controller/CHANGELOG.json +527 -0
  25. package/configure/node_modules/@pie-element/multiple-choice/controller/CHANGELOG.md +2316 -0
  26. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/__tests__/index.test.js +520 -0
  27. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/__tests__/utils.test.js +8 -0
  28. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/defaults.js +33 -0
  29. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/defaults.js.map +1 -0
  30. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/index.js +251 -0
  31. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/index.js.map +1 -0
  32. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/utils.js +16 -0
  33. package/configure/node_modules/@pie-element/multiple-choice/controller/lib/utils.js.map +1 -0
  34. package/configure/node_modules/@pie-element/multiple-choice/controller/package.json +15 -0
  35. package/configure/node_modules/@pie-element/multiple-choice/docs/config-schema.json +2993 -0
  36. package/configure/node_modules/@pie-element/multiple-choice/docs/config-schema.json.md +2217 -0
  37. package/configure/node_modules/@pie-element/multiple-choice/docs/demo/config.js +8 -0
  38. package/configure/node_modules/@pie-element/multiple-choice/docs/demo/generate.js +61 -0
  39. package/configure/node_modules/@pie-element/multiple-choice/docs/demo/index.html +1 -0
  40. package/configure/node_modules/@pie-element/multiple-choice/docs/demo/pie.manifest.json +11 -0
  41. package/configure/node_modules/@pie-element/multiple-choice/docs/demo/session.js +7 -0
  42. package/configure/node_modules/@pie-element/multiple-choice/docs/pie-schema.json +1332 -0
  43. package/configure/node_modules/@pie-element/multiple-choice/docs/pie-schema.json.md +1015 -0
  44. package/configure/node_modules/@pie-element/multiple-choice/lib/__tests__/choice-input-test.js +117 -0
  45. package/configure/node_modules/@pie-element/multiple-choice/lib/__tests__/index-test.js +151 -0
  46. package/configure/node_modules/@pie-element/multiple-choice/lib/__tests__/key-events-test.js +95 -0
  47. package/configure/node_modules/@pie-element/multiple-choice/lib/__tests__/multiple-choice-test.js +223 -0
  48. package/configure/node_modules/@pie-element/multiple-choice/lib/__tests__/session-updater-test.js +70 -0
  49. package/configure/node_modules/@pie-element/multiple-choice/lib/choice-input.js +370 -0
  50. package/configure/node_modules/@pie-element/multiple-choice/lib/choice-input.js.map +1 -0
  51. package/configure/node_modules/@pie-element/multiple-choice/lib/choice.js +197 -0
  52. package/configure/node_modules/@pie-element/multiple-choice/lib/choice.js.map +1 -0
  53. package/configure/node_modules/@pie-element/multiple-choice/lib/feedback-tick.js +130 -0
  54. package/configure/node_modules/@pie-element/multiple-choice/lib/feedback-tick.js.map +1 -0
  55. package/configure/node_modules/@pie-element/multiple-choice/lib/index.js +292 -0
  56. package/configure/node_modules/@pie-element/multiple-choice/lib/index.js.map +1 -0
  57. package/configure/node_modules/@pie-element/multiple-choice/lib/main.js +54 -0
  58. package/configure/node_modules/@pie-element/multiple-choice/lib/main.js.map +1 -0
  59. package/configure/node_modules/@pie-element/multiple-choice/lib/multiple-choice.js +386 -0
  60. package/configure/node_modules/@pie-element/multiple-choice/lib/multiple-choice.js.map +1 -0
  61. package/configure/node_modules/@pie-element/multiple-choice/lib/print.js +92 -0
  62. package/configure/node_modules/@pie-element/multiple-choice/lib/print.js.map +1 -0
  63. package/configure/node_modules/@pie-element/multiple-choice/lib/session-updater.js +37 -0
  64. package/configure/node_modules/@pie-element/multiple-choice/lib/session-updater.js.map +1 -0
  65. package/configure/node_modules/@pie-element/multiple-choice/package.json +39 -0
  66. package/configure/package.json +9 -6
  67. package/configure/src/__tests__/index.test.js +99 -108
  68. package/configure/src/index.js +13 -6
  69. package/configure/src/main.jsx +14 -18
  70. package/controller/lib/defaults.js +20 -32
  71. package/controller/lib/defaults.js.map +1 -1
  72. package/controller/lib/index.js +224 -349
  73. package/controller/lib/index.js.map +1 -1
  74. package/controller/lib/utils.js +4 -18
  75. package/controller/lib/utils.js.map +1 -1
  76. package/controller/package.json +3 -3
  77. package/lib/index.js +113 -181
  78. package/lib/index.js.map +1 -1
  79. package/lib/print.js +120 -204
  80. package/lib/print.js.map +1 -1
  81. package/package.json +5 -13
  82. package/src/__tests__/index.test.js +18 -5
  83. package/configure/src/__tests__/__snapshots__/index.test.js.snap +0 -83
  84. package/esm/configure.js +0 -12003
  85. package/esm/configure.js.map +0 -1
  86. package/esm/controller.js +0 -3358
  87. package/esm/controller.js.map +0 -1
  88. package/esm/element.js +0 -2203
  89. package/esm/element.js.map +0 -1
  90. package/esm/package.json +0 -3
  91. package/esm/print.js +0 -4092
  92. package/esm/print.js.map +0 -1
  93. package/module/configure.js +0 -1
  94. package/module/controller.js +0 -6469
  95. package/module/demo.js +0 -77
  96. package/module/element.js +0 -1
  97. package/module/index.html +0 -21
  98. package/module/manifest.json +0 -14
  99. package/module/print-demo.js +0 -115
  100. package/module/print.html +0 -18
  101. package/module/print.js +0 -1
@@ -0,0 +1,2217 @@
1
+ Config Object for @pie-elements/multiple-choice
2
+
3
+ The schema defines the following properties:
4
+
5
+ # `answerChoiceCount` (number)
6
+
7
+ The number of empty choices to show in config view if no choice model is provided
8
+
9
+ Default: `4`
10
+
11
+ Additional restrictions:
12
+
13
+ * Minimum: `1`
14
+
15
+ # `addChoiceButton` (object)
16
+
17
+ Properties of the `addChoiceButton` object:
18
+
19
+ ## `settings` (boolean)
20
+
21
+ Indicates if the item has to be displayed in the Settings Panel
22
+
23
+ ## `label` (string)
24
+
25
+ Indicates the label for the item that has to be displayed in the Settings Panel
26
+
27
+ # `baseInputConfiguration` (object)
28
+
29
+ Properties of the `baseInputConfiguration` object:
30
+
31
+ ## `math` (object)
32
+
33
+ Properties of the `math` object:
34
+
35
+ ### `disabled` (boolean)
36
+
37
+ Indicates if the plugin is disabled or not
38
+
39
+ ## `audio` (object)
40
+
41
+ Properties of the `audio` object:
42
+
43
+ ### `disabled` (boolean)
44
+
45
+ Indicates if the plugin is disabled or not
46
+
47
+ ## `video` (object)
48
+
49
+ Properties of the `video` object:
50
+
51
+ ### `disabled` (boolean)
52
+
53
+ Indicates if the plugin is disabled or not
54
+
55
+ ## `image` (object)
56
+
57
+ Properties of the `image` object:
58
+
59
+ ### `disabled` (boolean)
60
+
61
+ Indicates if the plugin is disabled or not
62
+
63
+ ## `customPlugins` (array)
64
+
65
+ An array of objects that determine custom plugins.
66
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
67
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
68
+
69
+ The object is an array with all elements of the type `object`.
70
+
71
+ The array object has the following properties:
72
+
73
+ ### `event` (string, required)
74
+
75
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
76
+ PIE will emit the event prefixed with "PIE-".
77
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
78
+
79
+ ### `iconAlt` (string, required)
80
+
81
+ The alt for the custom button icon
82
+
83
+ ### `iconType` (string, required)
84
+
85
+ The icon type.
86
+ Currently, only "SVG" is supported.
87
+
88
+ ### `icon` (string, required)
89
+
90
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
91
+
92
+ ## `blockquote` (object)
93
+
94
+ Properties of the `blockquote` object:
95
+
96
+ ### `disabled` (boolean)
97
+
98
+ Indicates if the plugin is disabled or not
99
+
100
+ ## `h3` (object)
101
+
102
+ Properties of the `h3` object:
103
+
104
+ ### `disabled` (boolean)
105
+
106
+ Indicates if the plugin is disabled or not
107
+
108
+ ## `characters` (object)
109
+
110
+ Properties of the `characters` object:
111
+
112
+ ### `disabled` (boolean)
113
+
114
+ Indicates if the plugin is disabled or not
115
+
116
+ ## `bold` (object)
117
+
118
+ Properties of the `bold` object:
119
+
120
+ ### `disabled` (boolean)
121
+
122
+ Indicates if the plugin is disabled or not
123
+
124
+ ## `html` (object)
125
+
126
+ Properties of the `html` object:
127
+
128
+ ### `disabled` (boolean)
129
+
130
+ Indicates if the plugin is disabled or not
131
+
132
+ ## `italic` (object)
133
+
134
+ Properties of the `italic` object:
135
+
136
+ ### `disabled` (boolean)
137
+
138
+ Indicates if the plugin is disabled or not
139
+
140
+ ## `ol_list` (object)
141
+
142
+ Properties of the `ol_list` object:
143
+
144
+ ### `disabled` (boolean)
145
+
146
+ Indicates if the plugin is disabled or not
147
+
148
+ ## `redo` (object)
149
+
150
+ Properties of the `redo` object:
151
+
152
+ ### `disabled` (boolean)
153
+
154
+ Indicates if the plugin is disabled or not
155
+
156
+ ## `strikethrough` (object)
157
+
158
+ Properties of the `strikethrough` object:
159
+
160
+ ### `disabled` (boolean)
161
+
162
+ Indicates if the plugin is disabled or not
163
+
164
+ ## `sub` (object)
165
+
166
+ Properties of the `sub` object:
167
+
168
+ ### `disabled` (boolean)
169
+
170
+ Indicates if the plugin is disabled or not
171
+
172
+ ## `sup` (object)
173
+
174
+ Properties of the `sup` object:
175
+
176
+ ### `disabled` (boolean)
177
+
178
+ Indicates if the plugin is disabled or not
179
+
180
+ ## `table` (object)
181
+
182
+ Properties of the `table` object:
183
+
184
+ ### `disabled` (boolean)
185
+
186
+ Indicates if the plugin is disabled or not
187
+
188
+ ## `ul_list` (object)
189
+
190
+ Properties of the `ul_list` object:
191
+
192
+ ### `disabled` (boolean)
193
+
194
+ Indicates if the plugin is disabled or not
195
+
196
+ ## `underline` (object)
197
+
198
+ Properties of the `underline` object:
199
+
200
+ ### `disabled` (boolean)
201
+
202
+ Indicates if the plugin is disabled or not
203
+
204
+ ## `undo` (object)
205
+
206
+ Properties of the `undo` object:
207
+
208
+ ### `disabled` (boolean)
209
+
210
+ Indicates if the plugin is disabled or not
211
+
212
+ # `choices` (object)
213
+
214
+ Properties of the `choices` object:
215
+
216
+ ## `inputConfiguration` (object)
217
+
218
+ Properties of the `inputConfiguration` object:
219
+
220
+ ### `math` (object)
221
+
222
+ Properties of the `math` object:
223
+
224
+ #### `disabled` (boolean)
225
+
226
+ Indicates if the plugin is disabled or not
227
+
228
+ ### `audio` (object)
229
+
230
+ Properties of the `audio` object:
231
+
232
+ #### `disabled` (boolean)
233
+
234
+ Indicates if the plugin is disabled or not
235
+
236
+ ### `video` (object)
237
+
238
+ Properties of the `video` object:
239
+
240
+ #### `disabled` (boolean)
241
+
242
+ Indicates if the plugin is disabled or not
243
+
244
+ ### `image` (object)
245
+
246
+ Properties of the `image` object:
247
+
248
+ #### `disabled` (boolean)
249
+
250
+ Indicates if the plugin is disabled or not
251
+
252
+ ### `customPlugins` (array)
253
+
254
+ An array of objects that determine custom plugins.
255
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
256
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
257
+
258
+ The object is an array with all elements of the type `object`.
259
+
260
+ The array object has the following properties:
261
+
262
+ #### `event` (string, required)
263
+
264
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
265
+ PIE will emit the event prefixed with "PIE-".
266
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
267
+
268
+ #### `iconAlt` (string, required)
269
+
270
+ The alt for the custom button icon
271
+
272
+ #### `iconType` (string, required)
273
+
274
+ The icon type.
275
+ Currently, only "SVG" is supported.
276
+
277
+ #### `icon` (string, required)
278
+
279
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
280
+
281
+ ### `blockquote` (object)
282
+
283
+ Properties of the `blockquote` object:
284
+
285
+ #### `disabled` (boolean)
286
+
287
+ Indicates if the plugin is disabled or not
288
+
289
+ ### `h3` (object)
290
+
291
+ Properties of the `h3` object:
292
+
293
+ #### `disabled` (boolean)
294
+
295
+ Indicates if the plugin is disabled or not
296
+
297
+ ### `characters` (object)
298
+
299
+ Properties of the `characters` object:
300
+
301
+ #### `disabled` (boolean)
302
+
303
+ Indicates if the plugin is disabled or not
304
+
305
+ ### `bold` (object)
306
+
307
+ Properties of the `bold` object:
308
+
309
+ #### `disabled` (boolean)
310
+
311
+ Indicates if the plugin is disabled or not
312
+
313
+ ### `html` (object)
314
+
315
+ Properties of the `html` object:
316
+
317
+ #### `disabled` (boolean)
318
+
319
+ Indicates if the plugin is disabled or not
320
+
321
+ ### `italic` (object)
322
+
323
+ Properties of the `italic` object:
324
+
325
+ #### `disabled` (boolean)
326
+
327
+ Indicates if the plugin is disabled or not
328
+
329
+ ### `ol_list` (object)
330
+
331
+ Properties of the `ol_list` object:
332
+
333
+ #### `disabled` (boolean)
334
+
335
+ Indicates if the plugin is disabled or not
336
+
337
+ ### `redo` (object)
338
+
339
+ Properties of the `redo` object:
340
+
341
+ #### `disabled` (boolean)
342
+
343
+ Indicates if the plugin is disabled or not
344
+
345
+ ### `strikethrough` (object)
346
+
347
+ Properties of the `strikethrough` object:
348
+
349
+ #### `disabled` (boolean)
350
+
351
+ Indicates if the plugin is disabled or not
352
+
353
+ ### `sub` (object)
354
+
355
+ Properties of the `sub` object:
356
+
357
+ #### `disabled` (boolean)
358
+
359
+ Indicates if the plugin is disabled or not
360
+
361
+ ### `sup` (object)
362
+
363
+ Properties of the `sup` object:
364
+
365
+ #### `disabled` (boolean)
366
+
367
+ Indicates if the plugin is disabled or not
368
+
369
+ ### `table` (object)
370
+
371
+ Properties of the `table` object:
372
+
373
+ #### `disabled` (boolean)
374
+
375
+ Indicates if the plugin is disabled or not
376
+
377
+ ### `ul_list` (object)
378
+
379
+ Properties of the `ul_list` object:
380
+
381
+ #### `disabled` (boolean)
382
+
383
+ Indicates if the plugin is disabled or not
384
+
385
+ ### `underline` (object)
386
+
387
+ Properties of the `underline` object:
388
+
389
+ #### `disabled` (boolean)
390
+
391
+ Indicates if the plugin is disabled or not
392
+
393
+ ### `undo` (object)
394
+
395
+ Properties of the `undo` object:
396
+
397
+ #### `disabled` (boolean)
398
+
399
+ Indicates if the plugin is disabled or not
400
+
401
+ ## `settings` (boolean)
402
+
403
+ Indicates if the item has to be displayed in the Settings Panel
404
+
405
+ ## `label` (string)
406
+
407
+ Indicates the label for the item that has to be displayed in the Settings Panel
408
+
409
+ # `choiceMode` (object)
410
+
411
+ Properties of the `choiceMode` object:
412
+
413
+ ## `settings` (boolean)
414
+
415
+ Indicates if the item has to be displayed in the Settings Panel
416
+
417
+ ## `label` (string)
418
+
419
+ Indicates the label for the item that has to be displayed in the Settings Panel
420
+
421
+ # `choicePrefix` (object)
422
+
423
+ Properties of the `choicePrefix` object:
424
+
425
+ ## `settings` (boolean)
426
+
427
+ Indicates if the item has to be displayed in the Settings Panel
428
+
429
+ ## `label` (string)
430
+
431
+ Indicates the label for the item that has to be displayed in the Settings Panel
432
+
433
+ # `deleteChoice` (object)
434
+
435
+ Properties of the `deleteChoice` object:
436
+
437
+ ## `settings` (boolean)
438
+
439
+ Indicates if the item has to be displayed in the Settings Panel
440
+
441
+ ## `label` (string)
442
+
443
+ Indicates the label for the item that has to be displayed in the Settings Panel
444
+
445
+ # `feedback` (object)
446
+
447
+ Properties of the `feedback` object:
448
+
449
+ ## `settings` (boolean)
450
+
451
+ Indicates if the item has to be displayed in the Settings Panel
452
+
453
+ ## `label` (string)
454
+
455
+ Indicates the label for the item that has to be displayed in the Settings Panel
456
+
457
+ # `prompt` (object)
458
+
459
+ Properties of the `prompt` object:
460
+
461
+ ## `inputConfiguration` (object)
462
+
463
+ Properties of the `inputConfiguration` object:
464
+
465
+ ### `math` (object)
466
+
467
+ Properties of the `math` object:
468
+
469
+ #### `disabled` (boolean)
470
+
471
+ Indicates if the plugin is disabled or not
472
+
473
+ ### `audio` (object)
474
+
475
+ Properties of the `audio` object:
476
+
477
+ #### `disabled` (boolean)
478
+
479
+ Indicates if the plugin is disabled or not
480
+
481
+ ### `video` (object)
482
+
483
+ Properties of the `video` object:
484
+
485
+ #### `disabled` (boolean)
486
+
487
+ Indicates if the plugin is disabled or not
488
+
489
+ ### `image` (object)
490
+
491
+ Properties of the `image` object:
492
+
493
+ #### `disabled` (boolean)
494
+
495
+ Indicates if the plugin is disabled or not
496
+
497
+ ### `customPlugins` (array)
498
+
499
+ An array of objects that determine custom plugins.
500
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
501
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
502
+
503
+ The object is an array with all elements of the type `object`.
504
+
505
+ The array object has the following properties:
506
+
507
+ #### `event` (string, required)
508
+
509
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
510
+ PIE will emit the event prefixed with "PIE-".
511
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
512
+
513
+ #### `iconAlt` (string, required)
514
+
515
+ The alt for the custom button icon
516
+
517
+ #### `iconType` (string, required)
518
+
519
+ The icon type.
520
+ Currently, only "SVG" is supported.
521
+
522
+ #### `icon` (string, required)
523
+
524
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
525
+
526
+ ### `blockquote` (object)
527
+
528
+ Properties of the `blockquote` object:
529
+
530
+ #### `disabled` (boolean)
531
+
532
+ Indicates if the plugin is disabled or not
533
+
534
+ ### `h3` (object)
535
+
536
+ Properties of the `h3` object:
537
+
538
+ #### `disabled` (boolean)
539
+
540
+ Indicates if the plugin is disabled or not
541
+
542
+ ### `characters` (object)
543
+
544
+ Properties of the `characters` object:
545
+
546
+ #### `disabled` (boolean)
547
+
548
+ Indicates if the plugin is disabled or not
549
+
550
+ ### `bold` (object)
551
+
552
+ Properties of the `bold` object:
553
+
554
+ #### `disabled` (boolean)
555
+
556
+ Indicates if the plugin is disabled or not
557
+
558
+ ### `html` (object)
559
+
560
+ Properties of the `html` object:
561
+
562
+ #### `disabled` (boolean)
563
+
564
+ Indicates if the plugin is disabled or not
565
+
566
+ ### `italic` (object)
567
+
568
+ Properties of the `italic` object:
569
+
570
+ #### `disabled` (boolean)
571
+
572
+ Indicates if the plugin is disabled or not
573
+
574
+ ### `ol_list` (object)
575
+
576
+ Properties of the `ol_list` object:
577
+
578
+ #### `disabled` (boolean)
579
+
580
+ Indicates if the plugin is disabled or not
581
+
582
+ ### `redo` (object)
583
+
584
+ Properties of the `redo` object:
585
+
586
+ #### `disabled` (boolean)
587
+
588
+ Indicates if the plugin is disabled or not
589
+
590
+ ### `strikethrough` (object)
591
+
592
+ Properties of the `strikethrough` object:
593
+
594
+ #### `disabled` (boolean)
595
+
596
+ Indicates if the plugin is disabled or not
597
+
598
+ ### `sub` (object)
599
+
600
+ Properties of the `sub` object:
601
+
602
+ #### `disabled` (boolean)
603
+
604
+ Indicates if the plugin is disabled or not
605
+
606
+ ### `sup` (object)
607
+
608
+ Properties of the `sup` object:
609
+
610
+ #### `disabled` (boolean)
611
+
612
+ Indicates if the plugin is disabled or not
613
+
614
+ ### `table` (object)
615
+
616
+ Properties of the `table` object:
617
+
618
+ #### `disabled` (boolean)
619
+
620
+ Indicates if the plugin is disabled or not
621
+
622
+ ### `ul_list` (object)
623
+
624
+ Properties of the `ul_list` object:
625
+
626
+ #### `disabled` (boolean)
627
+
628
+ Indicates if the plugin is disabled or not
629
+
630
+ ### `underline` (object)
631
+
632
+ Properties of the `underline` object:
633
+
634
+ #### `disabled` (boolean)
635
+
636
+ Indicates if the plugin is disabled or not
637
+
638
+ ### `undo` (object)
639
+
640
+ Properties of the `undo` object:
641
+
642
+ #### `disabled` (boolean)
643
+
644
+ Indicates if the plugin is disabled or not
645
+
646
+ ## `required` (boolean)
647
+
648
+ Indicates if the item is required and the value cannot be empty
649
+
650
+ ## `settings` (boolean)
651
+
652
+ Indicates if the item has to be displayed in the Settings Panel
653
+
654
+ ## `label` (string)
655
+
656
+ Indicates the label for the item that has to be displayed in the Settings Panel
657
+
658
+ # `spellCheck` (object)
659
+
660
+ Properties of the `spellCheck` object:
661
+
662
+ ## `settings` (boolean)
663
+
664
+ Indicates if the item has to be displayed in the Settings Panel
665
+
666
+ ## `label` (string)
667
+
668
+ Indicates the label for the item that has to be displayed in the Settings Panel
669
+
670
+ # `choicesLayout` (object)
671
+
672
+ Properties of the `choicesLayout` object:
673
+
674
+ ## `settings` (boolean)
675
+
676
+ Indicates if the item has to be displayed in the Settings Panel
677
+
678
+ ## `label` (string)
679
+
680
+ Indicates the label for the item that has to be displayed in the Settings Panel
681
+
682
+ # `gridColumns` (object)
683
+
684
+ Properties of the `gridColumns` object:
685
+
686
+ ## `settings` (boolean)
687
+
688
+ Indicates if the item has to be displayed in the Settings Panel
689
+
690
+ ## `label` (string)
691
+
692
+ Indicates the label for the item that has to be displayed in the Settings Panel
693
+
694
+ # `lockChoiceOrder` (object)
695
+
696
+ Properties of the `lockChoiceOrder` object:
697
+
698
+ ## `settings` (boolean)
699
+
700
+ Indicates if the item has to be displayed in the Settings Panel
701
+
702
+ ## `label` (string)
703
+
704
+ Indicates the label for the item that has to be displayed in the Settings Panel
705
+
706
+ # `partialScoring` (object)
707
+
708
+ Properties of the `partialScoring` object:
709
+
710
+ ## `settings` (boolean)
711
+
712
+ Indicates if the item has to be displayed in the Settings Panel
713
+
714
+ ## `label` (string)
715
+
716
+ Indicates the label for the item that has to be displayed in the Settings Panel
717
+
718
+ # `rationale` (object)
719
+
720
+ Properties of the `rationale` object:
721
+
722
+ ## `inputConfiguration` (object)
723
+
724
+ Properties of the `inputConfiguration` object:
725
+
726
+ ### `math` (object)
727
+
728
+ Properties of the `math` object:
729
+
730
+ #### `disabled` (boolean)
731
+
732
+ Indicates if the plugin is disabled or not
733
+
734
+ ### `audio` (object)
735
+
736
+ Properties of the `audio` object:
737
+
738
+ #### `disabled` (boolean)
739
+
740
+ Indicates if the plugin is disabled or not
741
+
742
+ ### `video` (object)
743
+
744
+ Properties of the `video` object:
745
+
746
+ #### `disabled` (boolean)
747
+
748
+ Indicates if the plugin is disabled or not
749
+
750
+ ### `image` (object)
751
+
752
+ Properties of the `image` object:
753
+
754
+ #### `disabled` (boolean)
755
+
756
+ Indicates if the plugin is disabled or not
757
+
758
+ ### `customPlugins` (array)
759
+
760
+ An array of objects that determine custom plugins.
761
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
762
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
763
+
764
+ The object is an array with all elements of the type `object`.
765
+
766
+ The array object has the following properties:
767
+
768
+ #### `event` (string, required)
769
+
770
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
771
+ PIE will emit the event prefixed with "PIE-".
772
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
773
+
774
+ #### `iconAlt` (string, required)
775
+
776
+ The alt for the custom button icon
777
+
778
+ #### `iconType` (string, required)
779
+
780
+ The icon type.
781
+ Currently, only "SVG" is supported.
782
+
783
+ #### `icon` (string, required)
784
+
785
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
786
+
787
+ ### `blockquote` (object)
788
+
789
+ Properties of the `blockquote` object:
790
+
791
+ #### `disabled` (boolean)
792
+
793
+ Indicates if the plugin is disabled or not
794
+
795
+ ### `h3` (object)
796
+
797
+ Properties of the `h3` object:
798
+
799
+ #### `disabled` (boolean)
800
+
801
+ Indicates if the plugin is disabled or not
802
+
803
+ ### `characters` (object)
804
+
805
+ Properties of the `characters` object:
806
+
807
+ #### `disabled` (boolean)
808
+
809
+ Indicates if the plugin is disabled or not
810
+
811
+ ### `bold` (object)
812
+
813
+ Properties of the `bold` object:
814
+
815
+ #### `disabled` (boolean)
816
+
817
+ Indicates if the plugin is disabled or not
818
+
819
+ ### `html` (object)
820
+
821
+ Properties of the `html` object:
822
+
823
+ #### `disabled` (boolean)
824
+
825
+ Indicates if the plugin is disabled or not
826
+
827
+ ### `italic` (object)
828
+
829
+ Properties of the `italic` object:
830
+
831
+ #### `disabled` (boolean)
832
+
833
+ Indicates if the plugin is disabled or not
834
+
835
+ ### `ol_list` (object)
836
+
837
+ Properties of the `ol_list` object:
838
+
839
+ #### `disabled` (boolean)
840
+
841
+ Indicates if the plugin is disabled or not
842
+
843
+ ### `redo` (object)
844
+
845
+ Properties of the `redo` object:
846
+
847
+ #### `disabled` (boolean)
848
+
849
+ Indicates if the plugin is disabled or not
850
+
851
+ ### `strikethrough` (object)
852
+
853
+ Properties of the `strikethrough` object:
854
+
855
+ #### `disabled` (boolean)
856
+
857
+ Indicates if the plugin is disabled or not
858
+
859
+ ### `sub` (object)
860
+
861
+ Properties of the `sub` object:
862
+
863
+ #### `disabled` (boolean)
864
+
865
+ Indicates if the plugin is disabled or not
866
+
867
+ ### `sup` (object)
868
+
869
+ Properties of the `sup` object:
870
+
871
+ #### `disabled` (boolean)
872
+
873
+ Indicates if the plugin is disabled or not
874
+
875
+ ### `table` (object)
876
+
877
+ Properties of the `table` object:
878
+
879
+ #### `disabled` (boolean)
880
+
881
+ Indicates if the plugin is disabled or not
882
+
883
+ ### `ul_list` (object)
884
+
885
+ Properties of the `ul_list` object:
886
+
887
+ #### `disabled` (boolean)
888
+
889
+ Indicates if the plugin is disabled or not
890
+
891
+ ### `underline` (object)
892
+
893
+ Properties of the `underline` object:
894
+
895
+ #### `disabled` (boolean)
896
+
897
+ Indicates if the plugin is disabled or not
898
+
899
+ ### `undo` (object)
900
+
901
+ Properties of the `undo` object:
902
+
903
+ #### `disabled` (boolean)
904
+
905
+ Indicates if the plugin is disabled or not
906
+
907
+ ## `required` (boolean)
908
+
909
+ Indicates if the item is required and the value cannot be empty
910
+
911
+ ## `settings` (boolean)
912
+
913
+ Indicates if the item has to be displayed in the Settings Panel
914
+
915
+ ## `label` (string)
916
+
917
+ Indicates the label for the item that has to be displayed in the Settings Panel
918
+
919
+ # `scoringType` (object)
920
+
921
+ Properties of the `scoringType` object:
922
+
923
+ ## `settings` (boolean)
924
+
925
+ Indicates if the item has to be displayed in the Settings Panel
926
+
927
+ ## `label` (string)
928
+
929
+ Indicates the label for the item that has to be displayed in the Settings Panel
930
+
931
+ # `settingsPanelDisabled` (boolean)
932
+
933
+ Indicates if the settings panel is not available
934
+
935
+ # `studentInstructions` (object)
936
+
937
+ Properties of the `studentInstructions` object:
938
+
939
+ ## `settings` (boolean)
940
+
941
+ Indicates if the item has to be displayed in the Settings Panel
942
+
943
+ ## `label` (string)
944
+
945
+ Indicates the label for the item that has to be displayed in the Settings Panel
946
+
947
+ # `teacherInstructions` (object)
948
+
949
+ Properties of the `teacherInstructions` object:
950
+
951
+ ## `inputConfiguration` (object)
952
+
953
+ Properties of the `inputConfiguration` object:
954
+
955
+ ### `math` (object)
956
+
957
+ Properties of the `math` object:
958
+
959
+ #### `disabled` (boolean)
960
+
961
+ Indicates if the plugin is disabled or not
962
+
963
+ ### `audio` (object)
964
+
965
+ Properties of the `audio` object:
966
+
967
+ #### `disabled` (boolean)
968
+
969
+ Indicates if the plugin is disabled or not
970
+
971
+ ### `video` (object)
972
+
973
+ Properties of the `video` object:
974
+
975
+ #### `disabled` (boolean)
976
+
977
+ Indicates if the plugin is disabled or not
978
+
979
+ ### `image` (object)
980
+
981
+ Properties of the `image` object:
982
+
983
+ #### `disabled` (boolean)
984
+
985
+ Indicates if the plugin is disabled or not
986
+
987
+ ### `customPlugins` (array)
988
+
989
+ An array of objects that determine custom plugins.
990
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
991
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
992
+
993
+ The object is an array with all elements of the type `object`.
994
+
995
+ The array object has the following properties:
996
+
997
+ #### `event` (string, required)
998
+
999
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1000
+ PIE will emit the event prefixed with "PIE-".
1001
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1002
+
1003
+ #### `iconAlt` (string, required)
1004
+
1005
+ The alt for the custom button icon
1006
+
1007
+ #### `iconType` (string, required)
1008
+
1009
+ The icon type.
1010
+ Currently, only "SVG" is supported.
1011
+
1012
+ #### `icon` (string, required)
1013
+
1014
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1015
+
1016
+ ### `blockquote` (object)
1017
+
1018
+ Properties of the `blockquote` object:
1019
+
1020
+ #### `disabled` (boolean)
1021
+
1022
+ Indicates if the plugin is disabled or not
1023
+
1024
+ ### `h3` (object)
1025
+
1026
+ Properties of the `h3` object:
1027
+
1028
+ #### `disabled` (boolean)
1029
+
1030
+ Indicates if the plugin is disabled or not
1031
+
1032
+ ### `characters` (object)
1033
+
1034
+ Properties of the `characters` object:
1035
+
1036
+ #### `disabled` (boolean)
1037
+
1038
+ Indicates if the plugin is disabled or not
1039
+
1040
+ ### `bold` (object)
1041
+
1042
+ Properties of the `bold` object:
1043
+
1044
+ #### `disabled` (boolean)
1045
+
1046
+ Indicates if the plugin is disabled or not
1047
+
1048
+ ### `html` (object)
1049
+
1050
+ Properties of the `html` object:
1051
+
1052
+ #### `disabled` (boolean)
1053
+
1054
+ Indicates if the plugin is disabled or not
1055
+
1056
+ ### `italic` (object)
1057
+
1058
+ Properties of the `italic` object:
1059
+
1060
+ #### `disabled` (boolean)
1061
+
1062
+ Indicates if the plugin is disabled or not
1063
+
1064
+ ### `ol_list` (object)
1065
+
1066
+ Properties of the `ol_list` object:
1067
+
1068
+ #### `disabled` (boolean)
1069
+
1070
+ Indicates if the plugin is disabled or not
1071
+
1072
+ ### `redo` (object)
1073
+
1074
+ Properties of the `redo` object:
1075
+
1076
+ #### `disabled` (boolean)
1077
+
1078
+ Indicates if the plugin is disabled or not
1079
+
1080
+ ### `strikethrough` (object)
1081
+
1082
+ Properties of the `strikethrough` object:
1083
+
1084
+ #### `disabled` (boolean)
1085
+
1086
+ Indicates if the plugin is disabled or not
1087
+
1088
+ ### `sub` (object)
1089
+
1090
+ Properties of the `sub` object:
1091
+
1092
+ #### `disabled` (boolean)
1093
+
1094
+ Indicates if the plugin is disabled or not
1095
+
1096
+ ### `sup` (object)
1097
+
1098
+ Properties of the `sup` object:
1099
+
1100
+ #### `disabled` (boolean)
1101
+
1102
+ Indicates if the plugin is disabled or not
1103
+
1104
+ ### `table` (object)
1105
+
1106
+ Properties of the `table` object:
1107
+
1108
+ #### `disabled` (boolean)
1109
+
1110
+ Indicates if the plugin is disabled or not
1111
+
1112
+ ### `ul_list` (object)
1113
+
1114
+ Properties of the `ul_list` object:
1115
+
1116
+ #### `disabled` (boolean)
1117
+
1118
+ Indicates if the plugin is disabled or not
1119
+
1120
+ ### `underline` (object)
1121
+
1122
+ Properties of the `underline` object:
1123
+
1124
+ #### `disabled` (boolean)
1125
+
1126
+ Indicates if the plugin is disabled or not
1127
+
1128
+ ### `undo` (object)
1129
+
1130
+ Properties of the `undo` object:
1131
+
1132
+ #### `disabled` (boolean)
1133
+
1134
+ Indicates if the plugin is disabled or not
1135
+
1136
+ ## `required` (boolean)
1137
+
1138
+ Indicates if the item is required and the value cannot be empty
1139
+
1140
+ ## `settings` (boolean)
1141
+
1142
+ Indicates if the item has to be displayed in the Settings Panel
1143
+
1144
+ ## `label` (string)
1145
+
1146
+ Indicates the label for the item that has to be displayed in the Settings Panel
1147
+
1148
+ # `sequentialChoiceLabels` (object)
1149
+
1150
+ Properties of the `sequentialChoiceLabels` object:
1151
+
1152
+ ## `enabled` (boolean)
1153
+
1154
+ Indicates the value of the item if it affects config-ui
1155
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
1156
+
1157
+ ## `settings` (boolean)
1158
+
1159
+ Indicates if the item has to be displayed in the Settings Panel
1160
+
1161
+ ## `label` (string)
1162
+
1163
+ Indicates the label for the item that has to be displayed in the Settings Panel
1164
+
1165
+ # `accessibility` (object)
1166
+
1167
+ Properties of the `accessibility` object:
1168
+
1169
+ ## `inputConfiguration` (object)
1170
+
1171
+ Properties of the `inputConfiguration` object:
1172
+
1173
+ ### `math` (object)
1174
+
1175
+ Properties of the `math` object:
1176
+
1177
+ #### `disabled` (boolean)
1178
+
1179
+ Indicates if the plugin is disabled or not
1180
+
1181
+ ### `audio` (object)
1182
+
1183
+ Properties of the `audio` object:
1184
+
1185
+ #### `disabled` (boolean)
1186
+
1187
+ Indicates if the plugin is disabled or not
1188
+
1189
+ ### `video` (object)
1190
+
1191
+ Properties of the `video` object:
1192
+
1193
+ #### `disabled` (boolean)
1194
+
1195
+ Indicates if the plugin is disabled or not
1196
+
1197
+ ### `image` (object)
1198
+
1199
+ Properties of the `image` object:
1200
+
1201
+ #### `disabled` (boolean)
1202
+
1203
+ Indicates if the plugin is disabled or not
1204
+
1205
+ ### `customPlugins` (array)
1206
+
1207
+ An array of objects that determine custom plugins.
1208
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
1209
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1210
+
1211
+ The object is an array with all elements of the type `object`.
1212
+
1213
+ The array object has the following properties:
1214
+
1215
+ #### `event` (string, required)
1216
+
1217
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1218
+ PIE will emit the event prefixed with "PIE-".
1219
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1220
+
1221
+ #### `iconAlt` (string, required)
1222
+
1223
+ The alt for the custom button icon
1224
+
1225
+ #### `iconType` (string, required)
1226
+
1227
+ The icon type.
1228
+ Currently, only "SVG" is supported.
1229
+
1230
+ #### `icon` (string, required)
1231
+
1232
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1233
+
1234
+ ### `blockquote` (object)
1235
+
1236
+ Properties of the `blockquote` object:
1237
+
1238
+ #### `disabled` (boolean)
1239
+
1240
+ Indicates if the plugin is disabled or not
1241
+
1242
+ ### `h3` (object)
1243
+
1244
+ Properties of the `h3` object:
1245
+
1246
+ #### `disabled` (boolean)
1247
+
1248
+ Indicates if the plugin is disabled or not
1249
+
1250
+ ### `characters` (object)
1251
+
1252
+ Properties of the `characters` object:
1253
+
1254
+ #### `disabled` (boolean)
1255
+
1256
+ Indicates if the plugin is disabled or not
1257
+
1258
+ ### `bold` (object)
1259
+
1260
+ Properties of the `bold` object:
1261
+
1262
+ #### `disabled` (boolean)
1263
+
1264
+ Indicates if the plugin is disabled or not
1265
+
1266
+ ### `html` (object)
1267
+
1268
+ Properties of the `html` object:
1269
+
1270
+ #### `disabled` (boolean)
1271
+
1272
+ Indicates if the plugin is disabled or not
1273
+
1274
+ ### `italic` (object)
1275
+
1276
+ Properties of the `italic` object:
1277
+
1278
+ #### `disabled` (boolean)
1279
+
1280
+ Indicates if the plugin is disabled or not
1281
+
1282
+ ### `ol_list` (object)
1283
+
1284
+ Properties of the `ol_list` object:
1285
+
1286
+ #### `disabled` (boolean)
1287
+
1288
+ Indicates if the plugin is disabled or not
1289
+
1290
+ ### `redo` (object)
1291
+
1292
+ Properties of the `redo` object:
1293
+
1294
+ #### `disabled` (boolean)
1295
+
1296
+ Indicates if the plugin is disabled or not
1297
+
1298
+ ### `strikethrough` (object)
1299
+
1300
+ Properties of the `strikethrough` object:
1301
+
1302
+ #### `disabled` (boolean)
1303
+
1304
+ Indicates if the plugin is disabled or not
1305
+
1306
+ ### `sub` (object)
1307
+
1308
+ Properties of the `sub` object:
1309
+
1310
+ #### `disabled` (boolean)
1311
+
1312
+ Indicates if the plugin is disabled or not
1313
+
1314
+ ### `sup` (object)
1315
+
1316
+ Properties of the `sup` object:
1317
+
1318
+ #### `disabled` (boolean)
1319
+
1320
+ Indicates if the plugin is disabled or not
1321
+
1322
+ ### `table` (object)
1323
+
1324
+ Properties of the `table` object:
1325
+
1326
+ #### `disabled` (boolean)
1327
+
1328
+ Indicates if the plugin is disabled or not
1329
+
1330
+ ### `ul_list` (object)
1331
+
1332
+ Properties of the `ul_list` object:
1333
+
1334
+ #### `disabled` (boolean)
1335
+
1336
+ Indicates if the plugin is disabled or not
1337
+
1338
+ ### `underline` (object)
1339
+
1340
+ Properties of the `underline` object:
1341
+
1342
+ #### `disabled` (boolean)
1343
+
1344
+ Indicates if the plugin is disabled or not
1345
+
1346
+ ### `undo` (object)
1347
+
1348
+ Properties of the `undo` object:
1349
+
1350
+ #### `disabled` (boolean)
1351
+
1352
+ Indicates if the plugin is disabled or not
1353
+
1354
+ ## `settings` (boolean)
1355
+
1356
+ Indicates if the item has to be displayed in the Settings Panel
1357
+
1358
+ ## `label` (string)
1359
+
1360
+ Indicates the label for the item that has to be displayed in the Settings Panel
1361
+
1362
+ # `minAnswerChoices` (number)
1363
+
1364
+ Minimum number of answer choices
1365
+
1366
+ # `maxAnswerChoices` (number)
1367
+
1368
+ Maximum number of answer choices
1369
+
1370
+ # `maxImageWidth` (object)
1371
+
1372
+ Properties of the `maxImageWidth` object:
1373
+
1374
+ ## `teacherInstructions` (number)
1375
+
1376
+ Indicates the max dimension for images in teacher instructions
1377
+
1378
+ ## `prompt` (number)
1379
+
1380
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1381
+
1382
+ ## `rationale` (number)
1383
+
1384
+ Indicates the max dimension for images in rationale
1385
+
1386
+ ## `choices` (number)
1387
+
1388
+ Indicates the max dimension for images in choices
1389
+
1390
+ # `maxImageHeight` (object)
1391
+
1392
+ Properties of the `maxImageHeight` object:
1393
+
1394
+ ## `teacherInstructions` (number)
1395
+
1396
+ Indicates the max dimension for images in teacher instructions
1397
+
1398
+ ## `prompt` (number)
1399
+
1400
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1401
+
1402
+ ## `rationale` (number)
1403
+
1404
+ Indicates the max dimension for images in rationale
1405
+
1406
+ ## `choices` (number)
1407
+
1408
+ Indicates the max dimension for images in choices
1409
+
1410
+ # `withRubric` (object)
1411
+
1412
+ Properties of the `withRubric` object:
1413
+
1414
+ ## `settings` (boolean)
1415
+
1416
+ Indicates if the item has to be displayed in the Settings Panel
1417
+
1418
+ ## `label` (string)
1419
+
1420
+ Indicates the label for the item that has to be displayed in the Settings Panel
1421
+
1422
+ # `mathMlOptions` (object)
1423
+
1424
+ Properties of the `mathMlOptions` object:
1425
+
1426
+ ## `mmlOutput` (number)
1427
+
1428
+ Indicates if model should have mathML output instead of latex
1429
+
1430
+ ## `mmlEditing` (number)
1431
+
1432
+ Indicates if mathML that's already in model should be editable
1433
+
1434
+ # `language` (object)
1435
+
1436
+ Properties of the `language` object:
1437
+
1438
+ ## `enabled` (boolean)
1439
+
1440
+ Indicates the value of the item if it affects config-ui
1441
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
1442
+
1443
+ ## `settings` (boolean)
1444
+
1445
+ Indicates if the item has to be displayed in the Settings Panel
1446
+
1447
+ ## `label` (string)
1448
+
1449
+ Indicates the label for the item that has to be displayed in the Settings Panel
1450
+
1451
+ # `languageChoices` (object)
1452
+
1453
+ Language choices configuration
1454
+ Only available if language is enabled
1455
+
1456
+ Properties of the `languageChoices` object:
1457
+
1458
+ ## `label` (string, required)
1459
+
1460
+ ## `options` (array, required)
1461
+
1462
+ The object is an array with all elements of the type `object`.
1463
+
1464
+ The array object has the following properties:
1465
+
1466
+ ### `value` (string, required)
1467
+
1468
+ Value of the language option
1469
+
1470
+ ### `label` (string, required)
1471
+
1472
+ Label of the language option
1473
+
1474
+ # `showPrompt` (boolean)
1475
+
1476
+ Determines whether prompt field will be displayed or not
1477
+
1478
+ Default: `true`
1479
+
1480
+ # `promptLabel` (string)
1481
+
1482
+ The label for the item stem/prompt field
1483
+
1484
+ Default: `"Item Stemm"`
1485
+
1486
+ # `contentDimensions` (object)
1487
+
1488
+ Indicates the dimensions configuration for the authoring container
1489
+ Note: Some items have a default minimum width because of their content, but if
1490
+ the minWidth is lower than this, the overflow behavior will take care of that
1491
+
1492
+ Properties of the `contentDimensions` object:
1493
+
1494
+ ## `maxHeight` (string,number)
1495
+
1496
+ Indicates the max height of the authoring container
1497
+
1498
+ Default: `"undefined"`
1499
+
1500
+ ## `maxWidth` (string,number)
1501
+
1502
+ Indicates the max width of the authoring container
1503
+
1504
+ Default: `"undefined"`
1505
+
1506
+ ## `minHeight` (string,number)
1507
+
1508
+ Indicates the min height of the authoring container
1509
+
1510
+ Default: `"undefined"`
1511
+
1512
+ ## `minWidth` (string,number)
1513
+
1514
+ Indicates the min width of the authoring container
1515
+
1516
+ Default: `"undefined"`
1517
+
1518
+ Default: `": {}"`
1519
+
1520
+ # `settingsPartialScoring` (boolean)
1521
+
1522
+ Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1523
+
1524
+ Default: `true`
1525
+
1526
+ ---
1527
+
1528
+ # Sub Schemas
1529
+
1530
+ The schema defines the following additional types:
1531
+
1532
+ ## `ConfigureProp` (object)
1533
+
1534
+ Properties of the `ConfigureProp` object:
1535
+
1536
+ ### `settings` (boolean)
1537
+
1538
+ Indicates if the item has to be displayed in the Settings Panel
1539
+
1540
+ ### `label` (string)
1541
+
1542
+ Indicates the label for the item that has to be displayed in the Settings Panel
1543
+
1544
+ ## `EditableHtmlConfigureProp` (object)
1545
+
1546
+ Properties of the `EditableHtmlConfigureProp` object:
1547
+
1548
+ ### `math` (object)
1549
+
1550
+ Properties of the `math` object:
1551
+
1552
+ #### `disabled` (boolean)
1553
+
1554
+ Indicates if the plugin is disabled or not
1555
+
1556
+ ### `audio` (object)
1557
+
1558
+ Properties of the `audio` object:
1559
+
1560
+ #### `disabled` (boolean)
1561
+
1562
+ Indicates if the plugin is disabled or not
1563
+
1564
+ ### `video` (object)
1565
+
1566
+ Properties of the `video` object:
1567
+
1568
+ #### `disabled` (boolean)
1569
+
1570
+ Indicates if the plugin is disabled or not
1571
+
1572
+ ### `image` (object)
1573
+
1574
+ Properties of the `image` object:
1575
+
1576
+ #### `disabled` (boolean)
1577
+
1578
+ Indicates if the plugin is disabled or not
1579
+
1580
+ ### `customPlugins` (array)
1581
+
1582
+ An array of objects that determine custom plugins.
1583
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
1584
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1585
+
1586
+ The object is an array with all elements of the type `object`.
1587
+
1588
+ The array object has the following properties:
1589
+
1590
+ #### `event` (string, required)
1591
+
1592
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1593
+ PIE will emit the event prefixed with "PIE-".
1594
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1595
+
1596
+ #### `iconAlt` (string, required)
1597
+
1598
+ The alt for the custom button icon
1599
+
1600
+ #### `iconType` (string, required)
1601
+
1602
+ The icon type.
1603
+ Currently, only "SVG" is supported.
1604
+
1605
+ #### `icon` (string, required)
1606
+
1607
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1608
+
1609
+ ### `blockquote` (object)
1610
+
1611
+ Properties of the `blockquote` object:
1612
+
1613
+ #### `disabled` (boolean)
1614
+
1615
+ Indicates if the plugin is disabled or not
1616
+
1617
+ ### `h3` (object)
1618
+
1619
+ Properties of the `h3` object:
1620
+
1621
+ #### `disabled` (boolean)
1622
+
1623
+ Indicates if the plugin is disabled or not
1624
+
1625
+ ### `characters` (object)
1626
+
1627
+ Properties of the `characters` object:
1628
+
1629
+ #### `disabled` (boolean)
1630
+
1631
+ Indicates if the plugin is disabled or not
1632
+
1633
+ ### `bold` (object)
1634
+
1635
+ Properties of the `bold` object:
1636
+
1637
+ #### `disabled` (boolean)
1638
+
1639
+ Indicates if the plugin is disabled or not
1640
+
1641
+ ### `html` (object)
1642
+
1643
+ Properties of the `html` object:
1644
+
1645
+ #### `disabled` (boolean)
1646
+
1647
+ Indicates if the plugin is disabled or not
1648
+
1649
+ ### `italic` (object)
1650
+
1651
+ Properties of the `italic` object:
1652
+
1653
+ #### `disabled` (boolean)
1654
+
1655
+ Indicates if the plugin is disabled or not
1656
+
1657
+ ### `ol_list` (object)
1658
+
1659
+ Properties of the `ol_list` object:
1660
+
1661
+ #### `disabled` (boolean)
1662
+
1663
+ Indicates if the plugin is disabled or not
1664
+
1665
+ ### `redo` (object)
1666
+
1667
+ Properties of the `redo` object:
1668
+
1669
+ #### `disabled` (boolean)
1670
+
1671
+ Indicates if the plugin is disabled or not
1672
+
1673
+ ### `strikethrough` (object)
1674
+
1675
+ Properties of the `strikethrough` object:
1676
+
1677
+ #### `disabled` (boolean)
1678
+
1679
+ Indicates if the plugin is disabled or not
1680
+
1681
+ ### `sub` (object)
1682
+
1683
+ Properties of the `sub` object:
1684
+
1685
+ #### `disabled` (boolean)
1686
+
1687
+ Indicates if the plugin is disabled or not
1688
+
1689
+ ### `sup` (object)
1690
+
1691
+ Properties of the `sup` object:
1692
+
1693
+ #### `disabled` (boolean)
1694
+
1695
+ Indicates if the plugin is disabled or not
1696
+
1697
+ ### `table` (object)
1698
+
1699
+ Properties of the `table` object:
1700
+
1701
+ #### `disabled` (boolean)
1702
+
1703
+ Indicates if the plugin is disabled or not
1704
+
1705
+ ### `ul_list` (object)
1706
+
1707
+ Properties of the `ul_list` object:
1708
+
1709
+ #### `disabled` (boolean)
1710
+
1711
+ Indicates if the plugin is disabled or not
1712
+
1713
+ ### `underline` (object)
1714
+
1715
+ Properties of the `underline` object:
1716
+
1717
+ #### `disabled` (boolean)
1718
+
1719
+ Indicates if the plugin is disabled or not
1720
+
1721
+ ### `undo` (object)
1722
+
1723
+ Properties of the `undo` object:
1724
+
1725
+ #### `disabled` (boolean)
1726
+
1727
+ Indicates if the plugin is disabled or not
1728
+
1729
+ ## `EditableHtmlButtonConfigure` (object)
1730
+
1731
+ Properties of the `EditableHtmlButtonConfigure` object:
1732
+
1733
+ ### `disabled` (boolean)
1734
+
1735
+ Indicates if the plugin is disabled or not
1736
+
1737
+ ## `CustomPlugin` (object)
1738
+
1739
+ Properties of the `CustomPlugin` object:
1740
+
1741
+ ### `event` (string, required)
1742
+
1743
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1744
+ PIE will emit the event prefixed with "PIE-".
1745
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1746
+
1747
+ ### `iconAlt` (string, required)
1748
+
1749
+ The alt for the custom button icon
1750
+
1751
+ ### `iconType` (string, required)
1752
+
1753
+ The icon type.
1754
+ Currently, only "SVG" is supported.
1755
+
1756
+ ### `icon` (string, required)
1757
+
1758
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1759
+
1760
+ ## `EditableHtmlPluginConfigure` (object)
1761
+
1762
+ Properties of the `EditableHtmlPluginConfigure` object:
1763
+
1764
+ ### `inputConfiguration` (object)
1765
+
1766
+ Properties of the `inputConfiguration` object:
1767
+
1768
+ #### `math` (object)
1769
+
1770
+ Properties of the `math` object:
1771
+
1772
+ ##### `disabled` (boolean)
1773
+
1774
+ Indicates if the plugin is disabled or not
1775
+
1776
+ #### `audio` (object)
1777
+
1778
+ Properties of the `audio` object:
1779
+
1780
+ ##### `disabled` (boolean)
1781
+
1782
+ Indicates if the plugin is disabled or not
1783
+
1784
+ #### `video` (object)
1785
+
1786
+ Properties of the `video` object:
1787
+
1788
+ ##### `disabled` (boolean)
1789
+
1790
+ Indicates if the plugin is disabled or not
1791
+
1792
+ #### `image` (object)
1793
+
1794
+ Properties of the `image` object:
1795
+
1796
+ ##### `disabled` (boolean)
1797
+
1798
+ Indicates if the plugin is disabled or not
1799
+
1800
+ #### `customPlugins` (array)
1801
+
1802
+ An array of objects that determine custom plugins.
1803
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
1804
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1805
+
1806
+ The object is an array with all elements of the type `object`.
1807
+
1808
+ The array object has the following properties:
1809
+
1810
+ ##### `event` (string, required)
1811
+
1812
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1813
+ PIE will emit the event prefixed with "PIE-".
1814
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1815
+
1816
+ ##### `iconAlt` (string, required)
1817
+
1818
+ The alt for the custom button icon
1819
+
1820
+ ##### `iconType` (string, required)
1821
+
1822
+ The icon type.
1823
+ Currently, only "SVG" is supported.
1824
+
1825
+ ##### `icon` (string, required)
1826
+
1827
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1828
+
1829
+ #### `blockquote` (object)
1830
+
1831
+ Properties of the `blockquote` object:
1832
+
1833
+ ##### `disabled` (boolean)
1834
+
1835
+ Indicates if the plugin is disabled or not
1836
+
1837
+ #### `h3` (object)
1838
+
1839
+ Properties of the `h3` object:
1840
+
1841
+ ##### `disabled` (boolean)
1842
+
1843
+ Indicates if the plugin is disabled or not
1844
+
1845
+ #### `characters` (object)
1846
+
1847
+ Properties of the `characters` object:
1848
+
1849
+ ##### `disabled` (boolean)
1850
+
1851
+ Indicates if the plugin is disabled or not
1852
+
1853
+ #### `bold` (object)
1854
+
1855
+ Properties of the `bold` object:
1856
+
1857
+ ##### `disabled` (boolean)
1858
+
1859
+ Indicates if the plugin is disabled or not
1860
+
1861
+ #### `html` (object)
1862
+
1863
+ Properties of the `html` object:
1864
+
1865
+ ##### `disabled` (boolean)
1866
+
1867
+ Indicates if the plugin is disabled or not
1868
+
1869
+ #### `italic` (object)
1870
+
1871
+ Properties of the `italic` object:
1872
+
1873
+ ##### `disabled` (boolean)
1874
+
1875
+ Indicates if the plugin is disabled or not
1876
+
1877
+ #### `ol_list` (object)
1878
+
1879
+ Properties of the `ol_list` object:
1880
+
1881
+ ##### `disabled` (boolean)
1882
+
1883
+ Indicates if the plugin is disabled or not
1884
+
1885
+ #### `redo` (object)
1886
+
1887
+ Properties of the `redo` object:
1888
+
1889
+ ##### `disabled` (boolean)
1890
+
1891
+ Indicates if the plugin is disabled or not
1892
+
1893
+ #### `strikethrough` (object)
1894
+
1895
+ Properties of the `strikethrough` object:
1896
+
1897
+ ##### `disabled` (boolean)
1898
+
1899
+ Indicates if the plugin is disabled or not
1900
+
1901
+ #### `sub` (object)
1902
+
1903
+ Properties of the `sub` object:
1904
+
1905
+ ##### `disabled` (boolean)
1906
+
1907
+ Indicates if the plugin is disabled or not
1908
+
1909
+ #### `sup` (object)
1910
+
1911
+ Properties of the `sup` object:
1912
+
1913
+ ##### `disabled` (boolean)
1914
+
1915
+ Indicates if the plugin is disabled or not
1916
+
1917
+ #### `table` (object)
1918
+
1919
+ Properties of the `table` object:
1920
+
1921
+ ##### `disabled` (boolean)
1922
+
1923
+ Indicates if the plugin is disabled or not
1924
+
1925
+ #### `ul_list` (object)
1926
+
1927
+ Properties of the `ul_list` object:
1928
+
1929
+ ##### `disabled` (boolean)
1930
+
1931
+ Indicates if the plugin is disabled or not
1932
+
1933
+ #### `underline` (object)
1934
+
1935
+ Properties of the `underline` object:
1936
+
1937
+ ##### `disabled` (boolean)
1938
+
1939
+ Indicates if the plugin is disabled or not
1940
+
1941
+ #### `undo` (object)
1942
+
1943
+ Properties of the `undo` object:
1944
+
1945
+ ##### `disabled` (boolean)
1946
+
1947
+ Indicates if the plugin is disabled or not
1948
+
1949
+ ### `settings` (boolean)
1950
+
1951
+ Indicates if the item has to be displayed in the Settings Panel
1952
+
1953
+ ### `label` (string)
1954
+
1955
+ Indicates the label for the item that has to be displayed in the Settings Panel
1956
+
1957
+ ## `EditableHtmlPluginConfigureRequired` (object)
1958
+
1959
+ Properties of the `EditableHtmlPluginConfigureRequired` object:
1960
+
1961
+ ### `inputConfiguration` (object)
1962
+
1963
+ Properties of the `inputConfiguration` object:
1964
+
1965
+ #### `math` (object)
1966
+
1967
+ Properties of the `math` object:
1968
+
1969
+ ##### `disabled` (boolean)
1970
+
1971
+ Indicates if the plugin is disabled or not
1972
+
1973
+ #### `audio` (object)
1974
+
1975
+ Properties of the `audio` object:
1976
+
1977
+ ##### `disabled` (boolean)
1978
+
1979
+ Indicates if the plugin is disabled or not
1980
+
1981
+ #### `video` (object)
1982
+
1983
+ Properties of the `video` object:
1984
+
1985
+ ##### `disabled` (boolean)
1986
+
1987
+ Indicates if the plugin is disabled or not
1988
+
1989
+ #### `image` (object)
1990
+
1991
+ Properties of the `image` object:
1992
+
1993
+ ##### `disabled` (boolean)
1994
+
1995
+ Indicates if the plugin is disabled or not
1996
+
1997
+ #### `customPlugins` (array)
1998
+
1999
+ An array of objects that determine custom plugins.
2000
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
2001
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2002
+
2003
+ The object is an array with all elements of the type `object`.
2004
+
2005
+ The array object has the following properties:
2006
+
2007
+ ##### `event` (string, required)
2008
+
2009
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2010
+ PIE will emit the event prefixed with "PIE-".
2011
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2012
+
2013
+ ##### `iconAlt` (string, required)
2014
+
2015
+ The alt for the custom button icon
2016
+
2017
+ ##### `iconType` (string, required)
2018
+
2019
+ The icon type.
2020
+ Currently, only "SVG" is supported.
2021
+
2022
+ ##### `icon` (string, required)
2023
+
2024
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2025
+
2026
+ #### `blockquote` (object)
2027
+
2028
+ Properties of the `blockquote` object:
2029
+
2030
+ ##### `disabled` (boolean)
2031
+
2032
+ Indicates if the plugin is disabled or not
2033
+
2034
+ #### `h3` (object)
2035
+
2036
+ Properties of the `h3` object:
2037
+
2038
+ ##### `disabled` (boolean)
2039
+
2040
+ Indicates if the plugin is disabled or not
2041
+
2042
+ #### `characters` (object)
2043
+
2044
+ Properties of the `characters` object:
2045
+
2046
+ ##### `disabled` (boolean)
2047
+
2048
+ Indicates if the plugin is disabled or not
2049
+
2050
+ #### `bold` (object)
2051
+
2052
+ Properties of the `bold` object:
2053
+
2054
+ ##### `disabled` (boolean)
2055
+
2056
+ Indicates if the plugin is disabled or not
2057
+
2058
+ #### `html` (object)
2059
+
2060
+ Properties of the `html` object:
2061
+
2062
+ ##### `disabled` (boolean)
2063
+
2064
+ Indicates if the plugin is disabled or not
2065
+
2066
+ #### `italic` (object)
2067
+
2068
+ Properties of the `italic` object:
2069
+
2070
+ ##### `disabled` (boolean)
2071
+
2072
+ Indicates if the plugin is disabled or not
2073
+
2074
+ #### `ol_list` (object)
2075
+
2076
+ Properties of the `ol_list` object:
2077
+
2078
+ ##### `disabled` (boolean)
2079
+
2080
+ Indicates if the plugin is disabled or not
2081
+
2082
+ #### `redo` (object)
2083
+
2084
+ Properties of the `redo` object:
2085
+
2086
+ ##### `disabled` (boolean)
2087
+
2088
+ Indicates if the plugin is disabled or not
2089
+
2090
+ #### `strikethrough` (object)
2091
+
2092
+ Properties of the `strikethrough` object:
2093
+
2094
+ ##### `disabled` (boolean)
2095
+
2096
+ Indicates if the plugin is disabled or not
2097
+
2098
+ #### `sub` (object)
2099
+
2100
+ Properties of the `sub` object:
2101
+
2102
+ ##### `disabled` (boolean)
2103
+
2104
+ Indicates if the plugin is disabled or not
2105
+
2106
+ #### `sup` (object)
2107
+
2108
+ Properties of the `sup` object:
2109
+
2110
+ ##### `disabled` (boolean)
2111
+
2112
+ Indicates if the plugin is disabled or not
2113
+
2114
+ #### `table` (object)
2115
+
2116
+ Properties of the `table` object:
2117
+
2118
+ ##### `disabled` (boolean)
2119
+
2120
+ Indicates if the plugin is disabled or not
2121
+
2122
+ #### `ul_list` (object)
2123
+
2124
+ Properties of the `ul_list` object:
2125
+
2126
+ ##### `disabled` (boolean)
2127
+
2128
+ Indicates if the plugin is disabled or not
2129
+
2130
+ #### `underline` (object)
2131
+
2132
+ Properties of the `underline` object:
2133
+
2134
+ ##### `disabled` (boolean)
2135
+
2136
+ Indicates if the plugin is disabled or not
2137
+
2138
+ #### `undo` (object)
2139
+
2140
+ Properties of the `undo` object:
2141
+
2142
+ ##### `disabled` (boolean)
2143
+
2144
+ Indicates if the plugin is disabled or not
2145
+
2146
+ ### `required` (boolean)
2147
+
2148
+ Indicates if the item is required and the value cannot be empty
2149
+
2150
+ ### `settings` (boolean)
2151
+
2152
+ Indicates if the item has to be displayed in the Settings Panel
2153
+
2154
+ ### `label` (string)
2155
+
2156
+ Indicates the label for the item that has to be displayed in the Settings Panel
2157
+
2158
+ ## `ConfigurePropWithEnabled` (object)
2159
+
2160
+ Properties of the `ConfigurePropWithEnabled` object:
2161
+
2162
+ ### `enabled` (boolean)
2163
+
2164
+ Indicates the value of the item if it affects config-ui
2165
+ (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
2166
+
2167
+ ### `settings` (boolean)
2168
+
2169
+ Indicates if the item has to be displayed in the Settings Panel
2170
+
2171
+ ### `label` (string)
2172
+
2173
+ Indicates the label for the item that has to be displayed in the Settings Panel
2174
+
2175
+ ## `ConfigureMaxImageDimensionsProp` (object)
2176
+
2177
+ Properties of the `ConfigureMaxImageDimensionsProp` object:
2178
+
2179
+ ### `teacherInstructions` (number)
2180
+
2181
+ Indicates the max dimension for images in teacher instructions
2182
+
2183
+ ### `prompt` (number)
2184
+
2185
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
2186
+
2187
+ ### `rationale` (number)
2188
+
2189
+ Indicates the max dimension for images in rationale
2190
+
2191
+ ### `choices` (number)
2192
+
2193
+ Indicates the max dimension for images in choices
2194
+
2195
+ ## `ConfigureMathMLProp` (object)
2196
+
2197
+ Properties of the `ConfigureMathMLProp` object:
2198
+
2199
+ ### `mmlOutput` (number)
2200
+
2201
+ Indicates if model should have mathML output instead of latex
2202
+
2203
+ ### `mmlEditing` (number)
2204
+
2205
+ Indicates if mathML that's already in model should be editable
2206
+
2207
+ ## `ConfigureLanguageOptionsProp` (object)
2208
+
2209
+ Properties of the `ConfigureLanguageOptionsProp` object:
2210
+
2211
+ ### `value` (string, required)
2212
+
2213
+ Value of the language option
2214
+
2215
+ ### `label` (string, required)
2216
+
2217
+ Label of the language option