@pie-element/match 12.1.2-next.1 → 12.1.2

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