@pie-element/likert 4.1.2-next.1 → 4.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 (87) hide show
  1. package/CHANGELOG.json +1 -0
  2. package/CHANGELOG.md +1462 -0
  3. package/LICENSE.md +5 -0
  4. package/configure/CHANGELOG.json +1 -0
  5. package/configure/CHANGELOG.md +1379 -0
  6. package/configure/lib/choiceGenerator.js +219 -0
  7. package/configure/lib/choiceGenerator.js.map +1 -0
  8. package/configure/lib/defaults.js +100 -0
  9. package/configure/lib/defaults.js.map +1 -0
  10. package/configure/lib/index.js +106 -0
  11. package/configure/lib/index.js.map +1 -0
  12. package/configure/lib/likertEntities.js +24 -0
  13. package/configure/lib/likertEntities.js.map +1 -0
  14. package/configure/lib/main.js +388 -0
  15. package/configure/lib/main.js.map +1 -0
  16. package/configure/package.json +27 -0
  17. package/controller/CHANGELOG.json +1 -0
  18. package/controller/CHANGELOG.md +90 -0
  19. package/controller/lib/defaults.js +17 -0
  20. package/controller/lib/defaults.js.map +1 -0
  21. package/controller/lib/index.js +81 -0
  22. package/controller/lib/index.js.map +1 -0
  23. package/controller/package.json +17 -0
  24. package/docs/config-schema.json +2011 -0
  25. package/docs/config-schema.json.md +1487 -0
  26. package/docs/demo/config.js +8 -0
  27. package/docs/demo/generate.js +22 -0
  28. package/docs/demo/index.html +1 -0
  29. package/docs/demo/session.js +6 -0
  30. package/docs/pie-schema.json +966 -0
  31. package/docs/pie-schema.json.md +711 -0
  32. package/lib/choice-input.js +90 -0
  33. package/lib/choice-input.js.map +1 -0
  34. package/lib/index.js +64 -0
  35. package/lib/index.js.map +1 -0
  36. package/lib/likert.js +97 -0
  37. package/lib/likert.js.map +1 -0
  38. package/lib/likertEntities.js +11 -0
  39. package/lib/likertEntities.js.map +1 -0
  40. package/lib/main.js +42 -0
  41. package/lib/main.js.map +1 -0
  42. package/lib/session-updater.js +15 -0
  43. package/lib/session-updater.js.map +1 -0
  44. package/package.json +21 -84
  45. package/readme.md +55 -0
  46. package/configure.js +0 -2
  47. package/controller.js +0 -1
  48. package/dist/author/choiceGenerator.d.ts +0 -13
  49. package/dist/author/choiceGenerator.js +0 -255
  50. package/dist/author/defaults.d.ts +0 -102
  51. package/dist/author/defaults.js +0 -60
  52. package/dist/author/index.d.ts +0 -31
  53. package/dist/author/index.js +0 -73
  54. package/dist/author/likertEntities.d.ts +0 -25
  55. package/dist/author/likertEntities.js +0 -18
  56. package/dist/author/main.d.ts +0 -27
  57. package/dist/author/main.js +0 -298
  58. package/dist/browser/Radio-CAjl01LA.js +0 -9447
  59. package/dist/browser/Radio-CAjl01LA.js.map +0 -1
  60. package/dist/browser/author/index.js +0 -39374
  61. package/dist/browser/author/index.js.map +0 -1
  62. package/dist/browser/controller/index.js +0 -51
  63. package/dist/browser/controller/index.js.map +0 -1
  64. package/dist/browser/delivery/index.js +0 -219
  65. package/dist/browser/delivery/index.js.map +0 -1
  66. package/dist/browser/likert.css +0 -2
  67. package/dist/controller/defaults.d.ts +0 -19
  68. package/dist/controller/defaults.js +0 -13
  69. package/dist/controller/index.d.ts +0 -19
  70. package/dist/controller/index.js +0 -41
  71. package/dist/delivery/choice-input.d.ts +0 -27
  72. package/dist/delivery/choice-input.js +0 -59
  73. package/dist/delivery/index.d.ts +0 -19
  74. package/dist/delivery/index.js +0 -44
  75. package/dist/delivery/likert.d.ts +0 -26
  76. package/dist/delivery/likert.js +0 -70
  77. package/dist/delivery/likertEntities.d.ts +0 -12
  78. package/dist/delivery/likertEntities.js +0 -7
  79. package/dist/delivery/main.d.ts +0 -23
  80. package/dist/delivery/main.js +0 -37
  81. package/dist/delivery/session-updater.d.ts +0 -9
  82. package/dist/index.d.ts +0 -1
  83. package/dist/index.iife.d.ts +0 -8
  84. package/dist/index.iife.js +0 -145
  85. package/dist/index.js +0 -2
  86. package/dist/runtime-support.d.ts +0 -12
  87. package/dist/runtime-support.js +0 -12
@@ -0,0 +1,1487 @@
1
+ Config Object for @pie-elements/likert
2
+
3
+ The schema defines the following properties:
4
+
5
+ # `settingsPanelDisabled` (boolean)
6
+
7
+ Indicates if the settings panel is not available
8
+
9
+ # `spellCheck` (object)
10
+
11
+ Properties of the `spellCheck` object:
12
+
13
+ ## `settings` (boolean)
14
+
15
+ Indicates if the item has to be displayed in the Settings Panel
16
+
17
+ ## `label` (string)
18
+
19
+ Indicates the label for the item that has to be displayed in the Settings Panel
20
+
21
+ # `teacherInstructions` (object)
22
+
23
+ Properties of the `teacherInstructions` object:
24
+
25
+ ## `inputConfiguration` (object)
26
+
27
+ Properties of the `inputConfiguration` object:
28
+
29
+ ### `math` (object)
30
+
31
+ Properties of the `math` object:
32
+
33
+ #### `disabled` (boolean)
34
+
35
+ Indicates if the plugin is disabled or not
36
+
37
+ ### `audio` (object)
38
+
39
+ Properties of the `audio` object:
40
+
41
+ #### `disabled` (boolean)
42
+
43
+ Indicates if the plugin is disabled or not
44
+
45
+ ### `video` (object)
46
+
47
+ Properties of the `video` object:
48
+
49
+ #### `disabled` (boolean)
50
+
51
+ Indicates if the plugin is disabled or not
52
+
53
+ ### `image` (object)
54
+
55
+ Properties of the `image` object:
56
+
57
+ #### `disabled` (boolean)
58
+
59
+ Indicates if the plugin is disabled or not
60
+
61
+ ### `customPlugins` (array)
62
+
63
+ An array of objects that determine custom plugins.
64
+ 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).
65
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
66
+
67
+ The object is an array with all elements of the type `object`.
68
+
69
+ The array object has the following properties:
70
+
71
+ #### `event` (string, required)
72
+
73
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
74
+ PIE will emit the event prefixed with "PIE-".
75
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
76
+
77
+ #### `iconAlt` (string, required)
78
+
79
+ The alt for the custom button icon
80
+
81
+ #### `iconType` (string, required)
82
+
83
+ The icon type.
84
+ Currently, only "SVG" is supported.
85
+
86
+ #### `icon` (string, required)
87
+
88
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
89
+
90
+ ### `blockquote` (object)
91
+
92
+ Properties of the `blockquote` object:
93
+
94
+ #### `disabled` (boolean)
95
+
96
+ Indicates if the plugin is disabled or not
97
+
98
+ ### `h3` (object)
99
+
100
+ Properties of the `h3` object:
101
+
102
+ #### `disabled` (boolean)
103
+
104
+ Indicates if the plugin is disabled or not
105
+
106
+ ### `characters` (object)
107
+
108
+ Properties of the `characters` object:
109
+
110
+ #### `disabled` (boolean)
111
+
112
+ Indicates if the plugin is disabled or not
113
+
114
+ ### `bold` (object)
115
+
116
+ Properties of the `bold` object:
117
+
118
+ #### `disabled` (boolean)
119
+
120
+ Indicates if the plugin is disabled or not
121
+
122
+ ### `html` (object)
123
+
124
+ Properties of the `html` object:
125
+
126
+ #### `disabled` (boolean)
127
+
128
+ Indicates if the plugin is disabled or not
129
+
130
+ ### `italic` (object)
131
+
132
+ Properties of the `italic` object:
133
+
134
+ #### `disabled` (boolean)
135
+
136
+ Indicates if the plugin is disabled or not
137
+
138
+ ### `ol_list` (object)
139
+
140
+ Properties of the `ol_list` object:
141
+
142
+ #### `disabled` (boolean)
143
+
144
+ Indicates if the plugin is disabled or not
145
+
146
+ ### `redo` (object)
147
+
148
+ Properties of the `redo` object:
149
+
150
+ #### `disabled` (boolean)
151
+
152
+ Indicates if the plugin is disabled or not
153
+
154
+ ### `strikethrough` (object)
155
+
156
+ Properties of the `strikethrough` object:
157
+
158
+ #### `disabled` (boolean)
159
+
160
+ Indicates if the plugin is disabled or not
161
+
162
+ ### `sub` (object)
163
+
164
+ Properties of the `sub` object:
165
+
166
+ #### `disabled` (boolean)
167
+
168
+ Indicates if the plugin is disabled or not
169
+
170
+ ### `sup` (object)
171
+
172
+ Properties of the `sup` object:
173
+
174
+ #### `disabled` (boolean)
175
+
176
+ Indicates if the plugin is disabled or not
177
+
178
+ ### `table` (object)
179
+
180
+ Properties of the `table` object:
181
+
182
+ #### `disabled` (boolean)
183
+
184
+ Indicates if the plugin is disabled or not
185
+
186
+ ### `ul_list` (object)
187
+
188
+ Properties of the `ul_list` object:
189
+
190
+ #### `disabled` (boolean)
191
+
192
+ Indicates if the plugin is disabled or not
193
+
194
+ ### `underline` (object)
195
+
196
+ Properties of the `underline` object:
197
+
198
+ #### `disabled` (boolean)
199
+
200
+ Indicates if the plugin is disabled or not
201
+
202
+ ### `undo` (object)
203
+
204
+ Properties of the `undo` object:
205
+
206
+ #### `disabled` (boolean)
207
+
208
+ Indicates if the plugin is disabled or not
209
+
210
+ ## `required` (boolean)
211
+
212
+ Indicates if the item is required and the value cannot be empty
213
+
214
+ ## `settings` (boolean)
215
+
216
+ Indicates if the item has to be displayed in the Settings Panel
217
+
218
+ ## `label` (string)
219
+
220
+ Indicates the label for the item that has to be displayed in the Settings Panel
221
+
222
+ # `prompt` (object)
223
+
224
+ Properties of the `prompt` object:
225
+
226
+ ## `inputConfiguration` (object)
227
+
228
+ Properties of the `inputConfiguration` object:
229
+
230
+ ### `math` (object)
231
+
232
+ Properties of the `math` object:
233
+
234
+ #### `disabled` (boolean)
235
+
236
+ Indicates if the plugin is disabled or not
237
+
238
+ ### `audio` (object)
239
+
240
+ Properties of the `audio` object:
241
+
242
+ #### `disabled` (boolean)
243
+
244
+ Indicates if the plugin is disabled or not
245
+
246
+ ### `video` (object)
247
+
248
+ Properties of the `video` object:
249
+
250
+ #### `disabled` (boolean)
251
+
252
+ Indicates if the plugin is disabled or not
253
+
254
+ ### `image` (object)
255
+
256
+ Properties of the `image` object:
257
+
258
+ #### `disabled` (boolean)
259
+
260
+ Indicates if the plugin is disabled or not
261
+
262
+ ### `customPlugins` (array)
263
+
264
+ An array of objects that determine custom plugins.
265
+ 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).
266
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
267
+
268
+ The object is an array with all elements of the type `object`.
269
+
270
+ The array object has the following properties:
271
+
272
+ #### `event` (string, required)
273
+
274
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
275
+ PIE will emit the event prefixed with "PIE-".
276
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
277
+
278
+ #### `iconAlt` (string, required)
279
+
280
+ The alt for the custom button icon
281
+
282
+ #### `iconType` (string, required)
283
+
284
+ The icon type.
285
+ Currently, only "SVG" is supported.
286
+
287
+ #### `icon` (string, required)
288
+
289
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
290
+
291
+ ### `blockquote` (object)
292
+
293
+ Properties of the `blockquote` object:
294
+
295
+ #### `disabled` (boolean)
296
+
297
+ Indicates if the plugin is disabled or not
298
+
299
+ ### `h3` (object)
300
+
301
+ Properties of the `h3` object:
302
+
303
+ #### `disabled` (boolean)
304
+
305
+ Indicates if the plugin is disabled or not
306
+
307
+ ### `characters` (object)
308
+
309
+ Properties of the `characters` object:
310
+
311
+ #### `disabled` (boolean)
312
+
313
+ Indicates if the plugin is disabled or not
314
+
315
+ ### `bold` (object)
316
+
317
+ Properties of the `bold` object:
318
+
319
+ #### `disabled` (boolean)
320
+
321
+ Indicates if the plugin is disabled or not
322
+
323
+ ### `html` (object)
324
+
325
+ Properties of the `html` object:
326
+
327
+ #### `disabled` (boolean)
328
+
329
+ Indicates if the plugin is disabled or not
330
+
331
+ ### `italic` (object)
332
+
333
+ Properties of the `italic` object:
334
+
335
+ #### `disabled` (boolean)
336
+
337
+ Indicates if the plugin is disabled or not
338
+
339
+ ### `ol_list` (object)
340
+
341
+ Properties of the `ol_list` object:
342
+
343
+ #### `disabled` (boolean)
344
+
345
+ Indicates if the plugin is disabled or not
346
+
347
+ ### `redo` (object)
348
+
349
+ Properties of the `redo` object:
350
+
351
+ #### `disabled` (boolean)
352
+
353
+ Indicates if the plugin is disabled or not
354
+
355
+ ### `strikethrough` (object)
356
+
357
+ Properties of the `strikethrough` object:
358
+
359
+ #### `disabled` (boolean)
360
+
361
+ Indicates if the plugin is disabled or not
362
+
363
+ ### `sub` (object)
364
+
365
+ Properties of the `sub` object:
366
+
367
+ #### `disabled` (boolean)
368
+
369
+ Indicates if the plugin is disabled or not
370
+
371
+ ### `sup` (object)
372
+
373
+ Properties of the `sup` object:
374
+
375
+ #### `disabled` (boolean)
376
+
377
+ Indicates if the plugin is disabled or not
378
+
379
+ ### `table` (object)
380
+
381
+ Properties of the `table` object:
382
+
383
+ #### `disabled` (boolean)
384
+
385
+ Indicates if the plugin is disabled or not
386
+
387
+ ### `ul_list` (object)
388
+
389
+ Properties of the `ul_list` object:
390
+
391
+ #### `disabled` (boolean)
392
+
393
+ Indicates if the plugin is disabled or not
394
+
395
+ ### `underline` (object)
396
+
397
+ Properties of the `underline` object:
398
+
399
+ #### `disabled` (boolean)
400
+
401
+ Indicates if the plugin is disabled or not
402
+
403
+ ### `undo` (object)
404
+
405
+ Properties of the `undo` object:
406
+
407
+ #### `disabled` (boolean)
408
+
409
+ Indicates if the plugin is disabled or not
410
+
411
+ ## `required` (boolean)
412
+
413
+ Indicates if the item is required and the value cannot be empty
414
+
415
+ ## `settings` (boolean)
416
+
417
+ Indicates if the item has to be displayed in the Settings Panel
418
+
419
+ ## `label` (string)
420
+
421
+ Indicates the label for the item that has to be displayed in the Settings Panel
422
+
423
+ # `baseInputConfiguration` (object)
424
+
425
+ Properties of the `baseInputConfiguration` object:
426
+
427
+ ## `math` (object)
428
+
429
+ Properties of the `math` object:
430
+
431
+ ### `disabled` (boolean)
432
+
433
+ Indicates if the plugin is disabled or not
434
+
435
+ ## `audio` (object)
436
+
437
+ Properties of the `audio` object:
438
+
439
+ ### `disabled` (boolean)
440
+
441
+ Indicates if the plugin is disabled or not
442
+
443
+ ## `video` (object)
444
+
445
+ Properties of the `video` object:
446
+
447
+ ### `disabled` (boolean)
448
+
449
+ Indicates if the plugin is disabled or not
450
+
451
+ ## `image` (object)
452
+
453
+ Properties of the `image` object:
454
+
455
+ ### `disabled` (boolean)
456
+
457
+ Indicates if the plugin is disabled or not
458
+
459
+ ## `customPlugins` (array)
460
+
461
+ An array of objects that determine custom plugins.
462
+ 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).
463
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
464
+
465
+ The object is an array with all elements of the type `object`.
466
+
467
+ The array object has the following properties:
468
+
469
+ ### `event` (string, required)
470
+
471
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
472
+ PIE will emit the event prefixed with "PIE-".
473
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
474
+
475
+ ### `iconAlt` (string, required)
476
+
477
+ The alt for the custom button icon
478
+
479
+ ### `iconType` (string, required)
480
+
481
+ The icon type.
482
+ Currently, only "SVG" is supported.
483
+
484
+ ### `icon` (string, required)
485
+
486
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
487
+
488
+ ## `blockquote` (object)
489
+
490
+ Properties of the `blockquote` object:
491
+
492
+ ### `disabled` (boolean)
493
+
494
+ Indicates if the plugin is disabled or not
495
+
496
+ ## `h3` (object)
497
+
498
+ Properties of the `h3` object:
499
+
500
+ ### `disabled` (boolean)
501
+
502
+ Indicates if the plugin is disabled or not
503
+
504
+ ## `characters` (object)
505
+
506
+ Properties of the `characters` object:
507
+
508
+ ### `disabled` (boolean)
509
+
510
+ Indicates if the plugin is disabled or not
511
+
512
+ ## `bold` (object)
513
+
514
+ Properties of the `bold` object:
515
+
516
+ ### `disabled` (boolean)
517
+
518
+ Indicates if the plugin is disabled or not
519
+
520
+ ## `html` (object)
521
+
522
+ Properties of the `html` object:
523
+
524
+ ### `disabled` (boolean)
525
+
526
+ Indicates if the plugin is disabled or not
527
+
528
+ ## `italic` (object)
529
+
530
+ Properties of the `italic` object:
531
+
532
+ ### `disabled` (boolean)
533
+
534
+ Indicates if the plugin is disabled or not
535
+
536
+ ## `ol_list` (object)
537
+
538
+ Properties of the `ol_list` object:
539
+
540
+ ### `disabled` (boolean)
541
+
542
+ Indicates if the plugin is disabled or not
543
+
544
+ ## `redo` (object)
545
+
546
+ Properties of the `redo` object:
547
+
548
+ ### `disabled` (boolean)
549
+
550
+ Indicates if the plugin is disabled or not
551
+
552
+ ## `strikethrough` (object)
553
+
554
+ Properties of the `strikethrough` object:
555
+
556
+ ### `disabled` (boolean)
557
+
558
+ Indicates if the plugin is disabled or not
559
+
560
+ ## `sub` (object)
561
+
562
+ Properties of the `sub` object:
563
+
564
+ ### `disabled` (boolean)
565
+
566
+ Indicates if the plugin is disabled or not
567
+
568
+ ## `sup` (object)
569
+
570
+ Properties of the `sup` object:
571
+
572
+ ### `disabled` (boolean)
573
+
574
+ Indicates if the plugin is disabled or not
575
+
576
+ ## `table` (object)
577
+
578
+ Properties of the `table` object:
579
+
580
+ ### `disabled` (boolean)
581
+
582
+ Indicates if the plugin is disabled or not
583
+
584
+ ## `ul_list` (object)
585
+
586
+ Properties of the `ul_list` object:
587
+
588
+ ### `disabled` (boolean)
589
+
590
+ Indicates if the plugin is disabled or not
591
+
592
+ ## `underline` (object)
593
+
594
+ Properties of the `underline` object:
595
+
596
+ ### `disabled` (boolean)
597
+
598
+ Indicates if the plugin is disabled or not
599
+
600
+ ## `undo` (object)
601
+
602
+ Properties of the `undo` object:
603
+
604
+ ### `disabled` (boolean)
605
+
606
+ Indicates if the plugin is disabled or not
607
+
608
+ # `likertChoice` (object)
609
+
610
+ Properties of the `likertChoice` object:
611
+
612
+ ## `inputConfiguration` (object)
613
+
614
+ Properties of the `inputConfiguration` object:
615
+
616
+ ### `math` (object)
617
+
618
+ Properties of the `math` object:
619
+
620
+ #### `disabled` (boolean)
621
+
622
+ Indicates if the plugin is disabled or not
623
+
624
+ ### `audio` (object)
625
+
626
+ Properties of the `audio` object:
627
+
628
+ #### `disabled` (boolean)
629
+
630
+ Indicates if the plugin is disabled or not
631
+
632
+ ### `video` (object)
633
+
634
+ Properties of the `video` object:
635
+
636
+ #### `disabled` (boolean)
637
+
638
+ Indicates if the plugin is disabled or not
639
+
640
+ ### `image` (object)
641
+
642
+ Properties of the `image` object:
643
+
644
+ #### `disabled` (boolean)
645
+
646
+ Indicates if the plugin is disabled or not
647
+
648
+ ### `customPlugins` (array)
649
+
650
+ An array of objects that determine custom plugins.
651
+ 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).
652
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
653
+
654
+ The object is an array with all elements of the type `object`.
655
+
656
+ The array object has the following properties:
657
+
658
+ #### `event` (string, required)
659
+
660
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
661
+ PIE will emit the event prefixed with "PIE-".
662
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
663
+
664
+ #### `iconAlt` (string, required)
665
+
666
+ The alt for the custom button icon
667
+
668
+ #### `iconType` (string, required)
669
+
670
+ The icon type.
671
+ Currently, only "SVG" is supported.
672
+
673
+ #### `icon` (string, required)
674
+
675
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
676
+
677
+ ### `blockquote` (object)
678
+
679
+ Properties of the `blockquote` object:
680
+
681
+ #### `disabled` (boolean)
682
+
683
+ Indicates if the plugin is disabled or not
684
+
685
+ ### `h3` (object)
686
+
687
+ Properties of the `h3` object:
688
+
689
+ #### `disabled` (boolean)
690
+
691
+ Indicates if the plugin is disabled or not
692
+
693
+ ### `characters` (object)
694
+
695
+ Properties of the `characters` object:
696
+
697
+ #### `disabled` (boolean)
698
+
699
+ Indicates if the plugin is disabled or not
700
+
701
+ ### `bold` (object)
702
+
703
+ Properties of the `bold` object:
704
+
705
+ #### `disabled` (boolean)
706
+
707
+ Indicates if the plugin is disabled or not
708
+
709
+ ### `html` (object)
710
+
711
+ Properties of the `html` object:
712
+
713
+ #### `disabled` (boolean)
714
+
715
+ Indicates if the plugin is disabled or not
716
+
717
+ ### `italic` (object)
718
+
719
+ Properties of the `italic` object:
720
+
721
+ #### `disabled` (boolean)
722
+
723
+ Indicates if the plugin is disabled or not
724
+
725
+ ### `ol_list` (object)
726
+
727
+ Properties of the `ol_list` object:
728
+
729
+ #### `disabled` (boolean)
730
+
731
+ Indicates if the plugin is disabled or not
732
+
733
+ ### `redo` (object)
734
+
735
+ Properties of the `redo` object:
736
+
737
+ #### `disabled` (boolean)
738
+
739
+ Indicates if the plugin is disabled or not
740
+
741
+ ### `strikethrough` (object)
742
+
743
+ Properties of the `strikethrough` object:
744
+
745
+ #### `disabled` (boolean)
746
+
747
+ Indicates if the plugin is disabled or not
748
+
749
+ ### `sub` (object)
750
+
751
+ Properties of the `sub` object:
752
+
753
+ #### `disabled` (boolean)
754
+
755
+ Indicates if the plugin is disabled or not
756
+
757
+ ### `sup` (object)
758
+
759
+ Properties of the `sup` object:
760
+
761
+ #### `disabled` (boolean)
762
+
763
+ Indicates if the plugin is disabled or not
764
+
765
+ ### `table` (object)
766
+
767
+ Properties of the `table` object:
768
+
769
+ #### `disabled` (boolean)
770
+
771
+ Indicates if the plugin is disabled or not
772
+
773
+ ### `ul_list` (object)
774
+
775
+ Properties of the `ul_list` object:
776
+
777
+ #### `disabled` (boolean)
778
+
779
+ Indicates if the plugin is disabled or not
780
+
781
+ ### `underline` (object)
782
+
783
+ Properties of the `underline` object:
784
+
785
+ #### `disabled` (boolean)
786
+
787
+ Indicates if the plugin is disabled or not
788
+
789
+ ### `undo` (object)
790
+
791
+ Properties of the `undo` object:
792
+
793
+ #### `disabled` (boolean)
794
+
795
+ Indicates if the plugin is disabled or not
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
+ # `showPrompt` (boolean)
806
+
807
+ Determines whether prompt field will be displayed or not
808
+
809
+ Default: `true`
810
+
811
+ # `promptLabel` (string)
812
+
813
+ The label for the item stem/prompt field
814
+
815
+ Default: `"Item Stemm"`
816
+
817
+ # `contentDimensions` (object)
818
+
819
+ Indicates the dimensions configuration for the authoring container
820
+ Note: Some items have a default minimum width because of their content, but if
821
+ the minWidth is lower than this, the overflow behavior will take care of that
822
+
823
+ Properties of the `contentDimensions` object:
824
+
825
+ ## `maxHeight` (string,number)
826
+
827
+ Indicates the max height of the authoring container
828
+
829
+ Default: `"undefined"`
830
+
831
+ ## `maxWidth` (string,number)
832
+
833
+ Indicates the max width of the authoring container
834
+
835
+ Default: `"undefined"`
836
+
837
+ ## `minHeight` (string,number)
838
+
839
+ Indicates the min height of the authoring container
840
+
841
+ Default: `"undefined"`
842
+
843
+ ## `minWidth` (string,number)
844
+
845
+ Indicates the min width of the authoring container
846
+
847
+ Default: `"undefined"`
848
+
849
+ Default: `": {}"`
850
+
851
+ # `settingsPartialScoring` (boolean)
852
+
853
+ Indicates whether the settings panel wil allow the author to modify settings for partial scoring
854
+
855
+ Default: `true`
856
+
857
+ ---
858
+
859
+ # Sub Schemas
860
+
861
+ The schema defines the following additional types:
862
+
863
+ ## `ConfigureProp` (object)
864
+
865
+ Properties of the `ConfigureProp` object:
866
+
867
+ ### `settings` (boolean)
868
+
869
+ Indicates if the item has to be displayed in the Settings Panel
870
+
871
+ ### `label` (string)
872
+
873
+ Indicates the label for the item that has to be displayed in the Settings Panel
874
+
875
+ ## `EditableHtmlPluginConfigureRequired` (object)
876
+
877
+ Properties of the `EditableHtmlPluginConfigureRequired` object:
878
+
879
+ ### `inputConfiguration` (object)
880
+
881
+ Properties of the `inputConfiguration` object:
882
+
883
+ #### `math` (object)
884
+
885
+ Properties of the `math` object:
886
+
887
+ ##### `disabled` (boolean)
888
+
889
+ Indicates if the plugin is disabled or not
890
+
891
+ #### `audio` (object)
892
+
893
+ Properties of the `audio` object:
894
+
895
+ ##### `disabled` (boolean)
896
+
897
+ Indicates if the plugin is disabled or not
898
+
899
+ #### `video` (object)
900
+
901
+ Properties of the `video` object:
902
+
903
+ ##### `disabled` (boolean)
904
+
905
+ Indicates if the plugin is disabled or not
906
+
907
+ #### `image` (object)
908
+
909
+ Properties of the `image` object:
910
+
911
+ ##### `disabled` (boolean)
912
+
913
+ Indicates if the plugin is disabled or not
914
+
915
+ #### `customPlugins` (array)
916
+
917
+ An array of objects that determine custom plugins.
918
+ 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).
919
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
920
+
921
+ The object is an array with all elements of the type `object`.
922
+
923
+ The array object has the following properties:
924
+
925
+ ##### `event` (string, required)
926
+
927
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
928
+ PIE will emit the event prefixed with "PIE-".
929
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
930
+
931
+ ##### `iconAlt` (string, required)
932
+
933
+ The alt for the custom button icon
934
+
935
+ ##### `iconType` (string, required)
936
+
937
+ The icon type.
938
+ Currently, only "SVG" is supported.
939
+
940
+ ##### `icon` (string, required)
941
+
942
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
943
+
944
+ #### `blockquote` (object)
945
+
946
+ Properties of the `blockquote` object:
947
+
948
+ ##### `disabled` (boolean)
949
+
950
+ Indicates if the plugin is disabled or not
951
+
952
+ #### `h3` (object)
953
+
954
+ Properties of the `h3` object:
955
+
956
+ ##### `disabled` (boolean)
957
+
958
+ Indicates if the plugin is disabled or not
959
+
960
+ #### `characters` (object)
961
+
962
+ Properties of the `characters` object:
963
+
964
+ ##### `disabled` (boolean)
965
+
966
+ Indicates if the plugin is disabled or not
967
+
968
+ #### `bold` (object)
969
+
970
+ Properties of the `bold` object:
971
+
972
+ ##### `disabled` (boolean)
973
+
974
+ Indicates if the plugin is disabled or not
975
+
976
+ #### `html` (object)
977
+
978
+ Properties of the `html` object:
979
+
980
+ ##### `disabled` (boolean)
981
+
982
+ Indicates if the plugin is disabled or not
983
+
984
+ #### `italic` (object)
985
+
986
+ Properties of the `italic` object:
987
+
988
+ ##### `disabled` (boolean)
989
+
990
+ Indicates if the plugin is disabled or not
991
+
992
+ #### `ol_list` (object)
993
+
994
+ Properties of the `ol_list` object:
995
+
996
+ ##### `disabled` (boolean)
997
+
998
+ Indicates if the plugin is disabled or not
999
+
1000
+ #### `redo` (object)
1001
+
1002
+ Properties of the `redo` object:
1003
+
1004
+ ##### `disabled` (boolean)
1005
+
1006
+ Indicates if the plugin is disabled or not
1007
+
1008
+ #### `strikethrough` (object)
1009
+
1010
+ Properties of the `strikethrough` object:
1011
+
1012
+ ##### `disabled` (boolean)
1013
+
1014
+ Indicates if the plugin is disabled or not
1015
+
1016
+ #### `sub` (object)
1017
+
1018
+ Properties of the `sub` object:
1019
+
1020
+ ##### `disabled` (boolean)
1021
+
1022
+ Indicates if the plugin is disabled or not
1023
+
1024
+ #### `sup` (object)
1025
+
1026
+ Properties of the `sup` object:
1027
+
1028
+ ##### `disabled` (boolean)
1029
+
1030
+ Indicates if the plugin is disabled or not
1031
+
1032
+ #### `table` (object)
1033
+
1034
+ Properties of the `table` object:
1035
+
1036
+ ##### `disabled` (boolean)
1037
+
1038
+ Indicates if the plugin is disabled or not
1039
+
1040
+ #### `ul_list` (object)
1041
+
1042
+ Properties of the `ul_list` object:
1043
+
1044
+ ##### `disabled` (boolean)
1045
+
1046
+ Indicates if the plugin is disabled or not
1047
+
1048
+ #### `underline` (object)
1049
+
1050
+ Properties of the `underline` object:
1051
+
1052
+ ##### `disabled` (boolean)
1053
+
1054
+ Indicates if the plugin is disabled or not
1055
+
1056
+ #### `undo` (object)
1057
+
1058
+ Properties of the `undo` object:
1059
+
1060
+ ##### `disabled` (boolean)
1061
+
1062
+ Indicates if the plugin is disabled or not
1063
+
1064
+ ### `required` (boolean)
1065
+
1066
+ Indicates if the item is required and the value cannot be empty
1067
+
1068
+ ### `settings` (boolean)
1069
+
1070
+ Indicates if the item has to be displayed in the Settings Panel
1071
+
1072
+ ### `label` (string)
1073
+
1074
+ Indicates the label for the item that has to be displayed in the Settings Panel
1075
+
1076
+ ## `EditableHtmlConfigureProp` (object)
1077
+
1078
+ Properties of the `EditableHtmlConfigureProp` object:
1079
+
1080
+ ### `math` (object)
1081
+
1082
+ Properties of the `math` object:
1083
+
1084
+ #### `disabled` (boolean)
1085
+
1086
+ Indicates if the plugin is disabled or not
1087
+
1088
+ ### `audio` (object)
1089
+
1090
+ Properties of the `audio` object:
1091
+
1092
+ #### `disabled` (boolean)
1093
+
1094
+ Indicates if the plugin is disabled or not
1095
+
1096
+ ### `video` (object)
1097
+
1098
+ Properties of the `video` object:
1099
+
1100
+ #### `disabled` (boolean)
1101
+
1102
+ Indicates if the plugin is disabled or not
1103
+
1104
+ ### `image` (object)
1105
+
1106
+ Properties of the `image` object:
1107
+
1108
+ #### `disabled` (boolean)
1109
+
1110
+ Indicates if the plugin is disabled or not
1111
+
1112
+ ### `customPlugins` (array)
1113
+
1114
+ An array of objects that determine custom plugins.
1115
+ 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).
1116
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1117
+
1118
+ The object is an array with all elements of the type `object`.
1119
+
1120
+ The array object has the following properties:
1121
+
1122
+ #### `event` (string, required)
1123
+
1124
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1125
+ PIE will emit the event prefixed with "PIE-".
1126
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1127
+
1128
+ #### `iconAlt` (string, required)
1129
+
1130
+ The alt for the custom button icon
1131
+
1132
+ #### `iconType` (string, required)
1133
+
1134
+ The icon type.
1135
+ Currently, only "SVG" is supported.
1136
+
1137
+ #### `icon` (string, required)
1138
+
1139
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1140
+
1141
+ ### `blockquote` (object)
1142
+
1143
+ Properties of the `blockquote` object:
1144
+
1145
+ #### `disabled` (boolean)
1146
+
1147
+ Indicates if the plugin is disabled or not
1148
+
1149
+ ### `h3` (object)
1150
+
1151
+ Properties of the `h3` object:
1152
+
1153
+ #### `disabled` (boolean)
1154
+
1155
+ Indicates if the plugin is disabled or not
1156
+
1157
+ ### `characters` (object)
1158
+
1159
+ Properties of the `characters` object:
1160
+
1161
+ #### `disabled` (boolean)
1162
+
1163
+ Indicates if the plugin is disabled or not
1164
+
1165
+ ### `bold` (object)
1166
+
1167
+ Properties of the `bold` object:
1168
+
1169
+ #### `disabled` (boolean)
1170
+
1171
+ Indicates if the plugin is disabled or not
1172
+
1173
+ ### `html` (object)
1174
+
1175
+ Properties of the `html` object:
1176
+
1177
+ #### `disabled` (boolean)
1178
+
1179
+ Indicates if the plugin is disabled or not
1180
+
1181
+ ### `italic` (object)
1182
+
1183
+ Properties of the `italic` object:
1184
+
1185
+ #### `disabled` (boolean)
1186
+
1187
+ Indicates if the plugin is disabled or not
1188
+
1189
+ ### `ol_list` (object)
1190
+
1191
+ Properties of the `ol_list` object:
1192
+
1193
+ #### `disabled` (boolean)
1194
+
1195
+ Indicates if the plugin is disabled or not
1196
+
1197
+ ### `redo` (object)
1198
+
1199
+ Properties of the `redo` object:
1200
+
1201
+ #### `disabled` (boolean)
1202
+
1203
+ Indicates if the plugin is disabled or not
1204
+
1205
+ ### `strikethrough` (object)
1206
+
1207
+ Properties of the `strikethrough` object:
1208
+
1209
+ #### `disabled` (boolean)
1210
+
1211
+ Indicates if the plugin is disabled or not
1212
+
1213
+ ### `sub` (object)
1214
+
1215
+ Properties of the `sub` object:
1216
+
1217
+ #### `disabled` (boolean)
1218
+
1219
+ Indicates if the plugin is disabled or not
1220
+
1221
+ ### `sup` (object)
1222
+
1223
+ Properties of the `sup` object:
1224
+
1225
+ #### `disabled` (boolean)
1226
+
1227
+ Indicates if the plugin is disabled or not
1228
+
1229
+ ### `table` (object)
1230
+
1231
+ Properties of the `table` object:
1232
+
1233
+ #### `disabled` (boolean)
1234
+
1235
+ Indicates if the plugin is disabled or not
1236
+
1237
+ ### `ul_list` (object)
1238
+
1239
+ Properties of the `ul_list` object:
1240
+
1241
+ #### `disabled` (boolean)
1242
+
1243
+ Indicates if the plugin is disabled or not
1244
+
1245
+ ### `underline` (object)
1246
+
1247
+ Properties of the `underline` object:
1248
+
1249
+ #### `disabled` (boolean)
1250
+
1251
+ Indicates if the plugin is disabled or not
1252
+
1253
+ ### `undo` (object)
1254
+
1255
+ Properties of the `undo` object:
1256
+
1257
+ #### `disabled` (boolean)
1258
+
1259
+ Indicates if the plugin is disabled or not
1260
+
1261
+ ## `EditableHtmlButtonConfigure` (object)
1262
+
1263
+ Properties of the `EditableHtmlButtonConfigure` object:
1264
+
1265
+ ### `disabled` (boolean)
1266
+
1267
+ Indicates if the plugin is disabled or not
1268
+
1269
+ ## `CustomPlugin` (object)
1270
+
1271
+ Properties of the `CustomPlugin` object:
1272
+
1273
+ ### `event` (string, required)
1274
+
1275
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1276
+ PIE will emit the event prefixed with "PIE-".
1277
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1278
+
1279
+ ### `iconAlt` (string, required)
1280
+
1281
+ The alt for the custom button icon
1282
+
1283
+ ### `iconType` (string, required)
1284
+
1285
+ The icon type.
1286
+ Currently, only "SVG" is supported.
1287
+
1288
+ ### `icon` (string, required)
1289
+
1290
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1291
+
1292
+ ## `EditableHtmlPluginConfigure` (object)
1293
+
1294
+ Properties of the `EditableHtmlPluginConfigure` object:
1295
+
1296
+ ### `inputConfiguration` (object)
1297
+
1298
+ Properties of the `inputConfiguration` object:
1299
+
1300
+ #### `math` (object)
1301
+
1302
+ Properties of the `math` object:
1303
+
1304
+ ##### `disabled` (boolean)
1305
+
1306
+ Indicates if the plugin is disabled or not
1307
+
1308
+ #### `audio` (object)
1309
+
1310
+ Properties of the `audio` object:
1311
+
1312
+ ##### `disabled` (boolean)
1313
+
1314
+ Indicates if the plugin is disabled or not
1315
+
1316
+ #### `video` (object)
1317
+
1318
+ Properties of the `video` object:
1319
+
1320
+ ##### `disabled` (boolean)
1321
+
1322
+ Indicates if the plugin is disabled or not
1323
+
1324
+ #### `image` (object)
1325
+
1326
+ Properties of the `image` object:
1327
+
1328
+ ##### `disabled` (boolean)
1329
+
1330
+ Indicates if the plugin is disabled or not
1331
+
1332
+ #### `customPlugins` (array)
1333
+
1334
+ An array of objects that determine custom plugins.
1335
+ 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).
1336
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1337
+
1338
+ The object is an array with all elements of the type `object`.
1339
+
1340
+ The array object has the following properties:
1341
+
1342
+ ##### `event` (string, required)
1343
+
1344
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1345
+ PIE will emit the event prefixed with "PIE-".
1346
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1347
+
1348
+ ##### `iconAlt` (string, required)
1349
+
1350
+ The alt for the custom button icon
1351
+
1352
+ ##### `iconType` (string, required)
1353
+
1354
+ The icon type.
1355
+ Currently, only "SVG" is supported.
1356
+
1357
+ ##### `icon` (string, required)
1358
+
1359
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1360
+
1361
+ #### `blockquote` (object)
1362
+
1363
+ Properties of the `blockquote` object:
1364
+
1365
+ ##### `disabled` (boolean)
1366
+
1367
+ Indicates if the plugin is disabled or not
1368
+
1369
+ #### `h3` (object)
1370
+
1371
+ Properties of the `h3` object:
1372
+
1373
+ ##### `disabled` (boolean)
1374
+
1375
+ Indicates if the plugin is disabled or not
1376
+
1377
+ #### `characters` (object)
1378
+
1379
+ Properties of the `characters` object:
1380
+
1381
+ ##### `disabled` (boolean)
1382
+
1383
+ Indicates if the plugin is disabled or not
1384
+
1385
+ #### `bold` (object)
1386
+
1387
+ Properties of the `bold` object:
1388
+
1389
+ ##### `disabled` (boolean)
1390
+
1391
+ Indicates if the plugin is disabled or not
1392
+
1393
+ #### `html` (object)
1394
+
1395
+ Properties of the `html` object:
1396
+
1397
+ ##### `disabled` (boolean)
1398
+
1399
+ Indicates if the plugin is disabled or not
1400
+
1401
+ #### `italic` (object)
1402
+
1403
+ Properties of the `italic` object:
1404
+
1405
+ ##### `disabled` (boolean)
1406
+
1407
+ Indicates if the plugin is disabled or not
1408
+
1409
+ #### `ol_list` (object)
1410
+
1411
+ Properties of the `ol_list` object:
1412
+
1413
+ ##### `disabled` (boolean)
1414
+
1415
+ Indicates if the plugin is disabled or not
1416
+
1417
+ #### `redo` (object)
1418
+
1419
+ Properties of the `redo` object:
1420
+
1421
+ ##### `disabled` (boolean)
1422
+
1423
+ Indicates if the plugin is disabled or not
1424
+
1425
+ #### `strikethrough` (object)
1426
+
1427
+ Properties of the `strikethrough` object:
1428
+
1429
+ ##### `disabled` (boolean)
1430
+
1431
+ Indicates if the plugin is disabled or not
1432
+
1433
+ #### `sub` (object)
1434
+
1435
+ Properties of the `sub` object:
1436
+
1437
+ ##### `disabled` (boolean)
1438
+
1439
+ Indicates if the plugin is disabled or not
1440
+
1441
+ #### `sup` (object)
1442
+
1443
+ Properties of the `sup` object:
1444
+
1445
+ ##### `disabled` (boolean)
1446
+
1447
+ Indicates if the plugin is disabled or not
1448
+
1449
+ #### `table` (object)
1450
+
1451
+ Properties of the `table` object:
1452
+
1453
+ ##### `disabled` (boolean)
1454
+
1455
+ Indicates if the plugin is disabled or not
1456
+
1457
+ #### `ul_list` (object)
1458
+
1459
+ Properties of the `ul_list` object:
1460
+
1461
+ ##### `disabled` (boolean)
1462
+
1463
+ Indicates if the plugin is disabled or not
1464
+
1465
+ #### `underline` (object)
1466
+
1467
+ Properties of the `underline` object:
1468
+
1469
+ ##### `disabled` (boolean)
1470
+
1471
+ Indicates if the plugin is disabled or not
1472
+
1473
+ #### `undo` (object)
1474
+
1475
+ Properties of the `undo` object:
1476
+
1477
+ ##### `disabled` (boolean)
1478
+
1479
+ Indicates if the plugin is disabled or not
1480
+
1481
+ ### `settings` (boolean)
1482
+
1483
+ Indicates if the item has to be displayed in the Settings Panel
1484
+
1485
+ ### `label` (string)
1486
+
1487
+ Indicates the label for the item that has to be displayed in the Settings Panel