@pie-element/placement-ordering 14.1.2-next.5 → 14.1.3

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