@pie-element/ebsr 9.21.3-next.8 → 9.21.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -163,6 +163,110 @@ Properties of the `h3` object:
163
163
 
164
164
  Indicates if the plugin is disabled or not
165
165
 
166
+ #### `languageCharacters` (object)
167
+
168
+ Properties of the `languageCharacters` object:
169
+
170
+ ##### `disabled` (boolean)
171
+
172
+ Indicates if the plugin is disabled or not
173
+
174
+ #### `bold` (object)
175
+
176
+ Properties of the `bold` object:
177
+
178
+ ##### `disabled` (boolean)
179
+
180
+ Indicates if the plugin is disabled or not
181
+
182
+ #### `html` (object)
183
+
184
+ Properties of the `html` object:
185
+
186
+ ##### `disabled` (boolean)
187
+
188
+ Indicates if the plugin is disabled or not
189
+
190
+ #### `italic` (object)
191
+
192
+ Properties of the `italic` object:
193
+
194
+ ##### `disabled` (boolean)
195
+
196
+ Indicates if the plugin is disabled or not
197
+
198
+ #### `ol_list` (object)
199
+
200
+ Properties of the `ol_list` object:
201
+
202
+ ##### `disabled` (boolean)
203
+
204
+ Indicates if the plugin is disabled or not
205
+
206
+ #### `redo` (object)
207
+
208
+ Properties of the `redo` object:
209
+
210
+ ##### `disabled` (boolean)
211
+
212
+ Indicates if the plugin is disabled or not
213
+
214
+ #### `strikethrough` (object)
215
+
216
+ Properties of the `strikethrough` object:
217
+
218
+ ##### `disabled` (boolean)
219
+
220
+ Indicates if the plugin is disabled or not
221
+
222
+ #### `sub` (object)
223
+
224
+ Properties of the `sub` object:
225
+
226
+ ##### `disabled` (boolean)
227
+
228
+ Indicates if the plugin is disabled or not
229
+
230
+ #### `sup` (object)
231
+
232
+ Properties of the `sup` object:
233
+
234
+ ##### `disabled` (boolean)
235
+
236
+ Indicates if the plugin is disabled or not
237
+
238
+ #### `table` (object)
239
+
240
+ Properties of the `table` object:
241
+
242
+ ##### `disabled` (boolean)
243
+
244
+ Indicates if the plugin is disabled or not
245
+
246
+ #### `ul_list` (object)
247
+
248
+ Properties of the `ul_list` object:
249
+
250
+ ##### `disabled` (boolean)
251
+
252
+ Indicates if the plugin is disabled or not
253
+
254
+ #### `underline` (object)
255
+
256
+ Properties of the `underline` object:
257
+
258
+ ##### `disabled` (boolean)
259
+
260
+ Indicates if the plugin is disabled or not
261
+
262
+ #### `undo` (object)
263
+
264
+ Properties of the `undo` object:
265
+
266
+ ##### `disabled` (boolean)
267
+
268
+ Indicates if the plugin is disabled or not
269
+
166
270
  ### `required` (boolean)
167
271
 
168
272
  Indicates if the item is required and the value cannot be empty
@@ -276,6 +380,110 @@ Properties of the `h3` object:
276
380
 
277
381
  Indicates if the plugin is disabled or not
278
382
 
383
+ #### `languageCharacters` (object)
384
+
385
+ Properties of the `languageCharacters` object:
386
+
387
+ ##### `disabled` (boolean)
388
+
389
+ Indicates if the plugin is disabled or not
390
+
391
+ #### `bold` (object)
392
+
393
+ Properties of the `bold` object:
394
+
395
+ ##### `disabled` (boolean)
396
+
397
+ Indicates if the plugin is disabled or not
398
+
399
+ #### `html` (object)
400
+
401
+ Properties of the `html` object:
402
+
403
+ ##### `disabled` (boolean)
404
+
405
+ Indicates if the plugin is disabled or not
406
+
407
+ #### `italic` (object)
408
+
409
+ Properties of the `italic` object:
410
+
411
+ ##### `disabled` (boolean)
412
+
413
+ Indicates if the plugin is disabled or not
414
+
415
+ #### `ol_list` (object)
416
+
417
+ Properties of the `ol_list` object:
418
+
419
+ ##### `disabled` (boolean)
420
+
421
+ Indicates if the plugin is disabled or not
422
+
423
+ #### `redo` (object)
424
+
425
+ Properties of the `redo` object:
426
+
427
+ ##### `disabled` (boolean)
428
+
429
+ Indicates if the plugin is disabled or not
430
+
431
+ #### `strikethrough` (object)
432
+
433
+ Properties of the `strikethrough` object:
434
+
435
+ ##### `disabled` (boolean)
436
+
437
+ Indicates if the plugin is disabled or not
438
+
439
+ #### `sub` (object)
440
+
441
+ Properties of the `sub` object:
442
+
443
+ ##### `disabled` (boolean)
444
+
445
+ Indicates if the plugin is disabled or not
446
+
447
+ #### `sup` (object)
448
+
449
+ Properties of the `sup` object:
450
+
451
+ ##### `disabled` (boolean)
452
+
453
+ Indicates if the plugin is disabled or not
454
+
455
+ #### `table` (object)
456
+
457
+ Properties of the `table` object:
458
+
459
+ ##### `disabled` (boolean)
460
+
461
+ Indicates if the plugin is disabled or not
462
+
463
+ #### `ul_list` (object)
464
+
465
+ Properties of the `ul_list` object:
466
+
467
+ ##### `disabled` (boolean)
468
+
469
+ Indicates if the plugin is disabled or not
470
+
471
+ #### `underline` (object)
472
+
473
+ Properties of the `underline` object:
474
+
475
+ ##### `disabled` (boolean)
476
+
477
+ Indicates if the plugin is disabled or not
478
+
479
+ #### `undo` (object)
480
+
481
+ Properties of the `undo` object:
482
+
483
+ ##### `disabled` (boolean)
484
+
485
+ Indicates if the plugin is disabled or not
486
+
279
487
  ### `required` (boolean)
280
488
 
281
489
  Indicates if the item is required and the value cannot be empty
@@ -385,6 +593,110 @@ Properties of the `h3` object:
385
593
 
386
594
  Indicates if the plugin is disabled or not
387
595
 
596
+ #### `languageCharacters` (object)
597
+
598
+ Properties of the `languageCharacters` object:
599
+
600
+ ##### `disabled` (boolean)
601
+
602
+ Indicates if the plugin is disabled or not
603
+
604
+ #### `bold` (object)
605
+
606
+ Properties of the `bold` object:
607
+
608
+ ##### `disabled` (boolean)
609
+
610
+ Indicates if the plugin is disabled or not
611
+
612
+ #### `html` (object)
613
+
614
+ Properties of the `html` object:
615
+
616
+ ##### `disabled` (boolean)
617
+
618
+ Indicates if the plugin is disabled or not
619
+
620
+ #### `italic` (object)
621
+
622
+ Properties of the `italic` object:
623
+
624
+ ##### `disabled` (boolean)
625
+
626
+ Indicates if the plugin is disabled or not
627
+
628
+ #### `ol_list` (object)
629
+
630
+ Properties of the `ol_list` object:
631
+
632
+ ##### `disabled` (boolean)
633
+
634
+ Indicates if the plugin is disabled or not
635
+
636
+ #### `redo` (object)
637
+
638
+ Properties of the `redo` object:
639
+
640
+ ##### `disabled` (boolean)
641
+
642
+ Indicates if the plugin is disabled or not
643
+
644
+ #### `strikethrough` (object)
645
+
646
+ Properties of the `strikethrough` object:
647
+
648
+ ##### `disabled` (boolean)
649
+
650
+ Indicates if the plugin is disabled or not
651
+
652
+ #### `sub` (object)
653
+
654
+ Properties of the `sub` object:
655
+
656
+ ##### `disabled` (boolean)
657
+
658
+ Indicates if the plugin is disabled or not
659
+
660
+ #### `sup` (object)
661
+
662
+ Properties of the `sup` object:
663
+
664
+ ##### `disabled` (boolean)
665
+
666
+ Indicates if the plugin is disabled or not
667
+
668
+ #### `table` (object)
669
+
670
+ Properties of the `table` object:
671
+
672
+ ##### `disabled` (boolean)
673
+
674
+ Indicates if the plugin is disabled or not
675
+
676
+ #### `ul_list` (object)
677
+
678
+ Properties of the `ul_list` object:
679
+
680
+ ##### `disabled` (boolean)
681
+
682
+ Indicates if the plugin is disabled or not
683
+
684
+ #### `underline` (object)
685
+
686
+ Properties of the `underline` object:
687
+
688
+ ##### `disabled` (boolean)
689
+
690
+ Indicates if the plugin is disabled or not
691
+
692
+ #### `undo` (object)
693
+
694
+ Properties of the `undo` object:
695
+
696
+ ##### `disabled` (boolean)
697
+
698
+ Indicates if the plugin is disabled or not
699
+
388
700
  ### `required` (boolean)
389
701
 
390
702
  Indicates if the item is required and the value cannot be empty
@@ -562,43 +874,147 @@ Properties of the `h3` object:
562
874
 
563
875
  Indicates if the plugin is disabled or not
564
876
 
565
- ## `choices` (object)
877
+ ### `languageCharacters` (object)
566
878
 
567
- Properties of the `choices` object:
879
+ Properties of the `languageCharacters` object:
568
880
 
569
- ### `inputConfiguration` (object)
881
+ #### `disabled` (boolean)
570
882
 
571
- Properties of the `inputConfiguration` object:
883
+ Indicates if the plugin is disabled or not
572
884
 
573
- #### `math` (object)
885
+ ### `bold` (object)
574
886
 
575
- Properties of the `math` object:
887
+ Properties of the `bold` object:
576
888
 
577
- ##### `disabled` (boolean)
889
+ #### `disabled` (boolean)
578
890
 
579
891
  Indicates if the plugin is disabled or not
580
892
 
581
- #### `audio` (object)
893
+ ### `html` (object)
582
894
 
583
- Properties of the `audio` object:
895
+ Properties of the `html` object:
584
896
 
585
- ##### `disabled` (boolean)
897
+ #### `disabled` (boolean)
586
898
 
587
899
  Indicates if the plugin is disabled or not
588
900
 
589
- #### `video` (object)
901
+ ### `italic` (object)
590
902
 
591
- Properties of the `video` object:
903
+ Properties of the `italic` object:
592
904
 
593
- ##### `disabled` (boolean)
905
+ #### `disabled` (boolean)
594
906
 
595
907
  Indicates if the plugin is disabled or not
596
908
 
597
- #### `image` (object)
909
+ ### `ol_list` (object)
598
910
 
599
- Properties of the `image` object:
911
+ Properties of the `ol_list` object:
600
912
 
601
- ##### `disabled` (boolean)
913
+ #### `disabled` (boolean)
914
+
915
+ Indicates if the plugin is disabled or not
916
+
917
+ ### `redo` (object)
918
+
919
+ Properties of the `redo` object:
920
+
921
+ #### `disabled` (boolean)
922
+
923
+ Indicates if the plugin is disabled or not
924
+
925
+ ### `strikethrough` (object)
926
+
927
+ Properties of the `strikethrough` object:
928
+
929
+ #### `disabled` (boolean)
930
+
931
+ Indicates if the plugin is disabled or not
932
+
933
+ ### `sub` (object)
934
+
935
+ Properties of the `sub` object:
936
+
937
+ #### `disabled` (boolean)
938
+
939
+ Indicates if the plugin is disabled or not
940
+
941
+ ### `sup` (object)
942
+
943
+ Properties of the `sup` object:
944
+
945
+ #### `disabled` (boolean)
946
+
947
+ Indicates if the plugin is disabled or not
948
+
949
+ ### `table` (object)
950
+
951
+ Properties of the `table` object:
952
+
953
+ #### `disabled` (boolean)
954
+
955
+ Indicates if the plugin is disabled or not
956
+
957
+ ### `ul_list` (object)
958
+
959
+ Properties of the `ul_list` object:
960
+
961
+ #### `disabled` (boolean)
962
+
963
+ Indicates if the plugin is disabled or not
964
+
965
+ ### `underline` (object)
966
+
967
+ Properties of the `underline` object:
968
+
969
+ #### `disabled` (boolean)
970
+
971
+ Indicates if the plugin is disabled or not
972
+
973
+ ### `undo` (object)
974
+
975
+ Properties of the `undo` object:
976
+
977
+ #### `disabled` (boolean)
978
+
979
+ Indicates if the plugin is disabled or not
980
+
981
+ ## `choices` (object)
982
+
983
+ Properties of the `choices` object:
984
+
985
+ ### `inputConfiguration` (object)
986
+
987
+ Properties of the `inputConfiguration` object:
988
+
989
+ #### `math` (object)
990
+
991
+ Properties of the `math` object:
992
+
993
+ ##### `disabled` (boolean)
994
+
995
+ Indicates if the plugin is disabled or not
996
+
997
+ #### `audio` (object)
998
+
999
+ Properties of the `audio` object:
1000
+
1001
+ ##### `disabled` (boolean)
1002
+
1003
+ Indicates if the plugin is disabled or not
1004
+
1005
+ #### `video` (object)
1006
+
1007
+ Properties of the `video` object:
1008
+
1009
+ ##### `disabled` (boolean)
1010
+
1011
+ Indicates if the plugin is disabled or not
1012
+
1013
+ #### `image` (object)
1014
+
1015
+ Properties of the `image` object:
1016
+
1017
+ ##### `disabled` (boolean)
602
1018
 
603
1019
  Indicates if the plugin is disabled or not
604
1020
 
@@ -647,6 +1063,110 @@ Properties of the `h3` object:
647
1063
 
648
1064
  Indicates if the plugin is disabled or not
649
1065
 
1066
+ #### `languageCharacters` (object)
1067
+
1068
+ Properties of the `languageCharacters` object:
1069
+
1070
+ ##### `disabled` (boolean)
1071
+
1072
+ Indicates if the plugin is disabled or not
1073
+
1074
+ #### `bold` (object)
1075
+
1076
+ Properties of the `bold` object:
1077
+
1078
+ ##### `disabled` (boolean)
1079
+
1080
+ Indicates if the plugin is disabled or not
1081
+
1082
+ #### `html` (object)
1083
+
1084
+ Properties of the `html` object:
1085
+
1086
+ ##### `disabled` (boolean)
1087
+
1088
+ Indicates if the plugin is disabled or not
1089
+
1090
+ #### `italic` (object)
1091
+
1092
+ Properties of the `italic` object:
1093
+
1094
+ ##### `disabled` (boolean)
1095
+
1096
+ Indicates if the plugin is disabled or not
1097
+
1098
+ #### `ol_list` (object)
1099
+
1100
+ Properties of the `ol_list` object:
1101
+
1102
+ ##### `disabled` (boolean)
1103
+
1104
+ Indicates if the plugin is disabled or not
1105
+
1106
+ #### `redo` (object)
1107
+
1108
+ Properties of the `redo` object:
1109
+
1110
+ ##### `disabled` (boolean)
1111
+
1112
+ Indicates if the plugin is disabled or not
1113
+
1114
+ #### `strikethrough` (object)
1115
+
1116
+ Properties of the `strikethrough` object:
1117
+
1118
+ ##### `disabled` (boolean)
1119
+
1120
+ Indicates if the plugin is disabled or not
1121
+
1122
+ #### `sub` (object)
1123
+
1124
+ Properties of the `sub` object:
1125
+
1126
+ ##### `disabled` (boolean)
1127
+
1128
+ Indicates if the plugin is disabled or not
1129
+
1130
+ #### `sup` (object)
1131
+
1132
+ Properties of the `sup` object:
1133
+
1134
+ ##### `disabled` (boolean)
1135
+
1136
+ Indicates if the plugin is disabled or not
1137
+
1138
+ #### `table` (object)
1139
+
1140
+ Properties of the `table` object:
1141
+
1142
+ ##### `disabled` (boolean)
1143
+
1144
+ Indicates if the plugin is disabled or not
1145
+
1146
+ #### `ul_list` (object)
1147
+
1148
+ Properties of the `ul_list` object:
1149
+
1150
+ ##### `disabled` (boolean)
1151
+
1152
+ Indicates if the plugin is disabled or not
1153
+
1154
+ #### `underline` (object)
1155
+
1156
+ Properties of the `underline` object:
1157
+
1158
+ ##### `disabled` (boolean)
1159
+
1160
+ Indicates if the plugin is disabled or not
1161
+
1162
+ #### `undo` (object)
1163
+
1164
+ Properties of the `undo` object:
1165
+
1166
+ ##### `disabled` (boolean)
1167
+
1168
+ Indicates if the plugin is disabled or not
1169
+
650
1170
  ### `settings` (boolean)
651
1171
 
652
1172
  Indicates if the item has to be displayed in the Settings Panel
@@ -816,114 +1336,105 @@ Properties of the `h3` object:
816
1336
 
817
1337
  Indicates if the plugin is disabled or not
818
1338
 
819
- ### `required` (boolean)
820
-
821
- Indicates if the item is required and the value cannot be empty
822
-
823
- ### `settings` (boolean)
1339
+ #### `languageCharacters` (object)
824
1340
 
825
- Indicates if the item has to be displayed in the Settings Panel
1341
+ Properties of the `languageCharacters` object:
826
1342
 
827
- ### `label` (string)
1343
+ ##### `disabled` (boolean)
828
1344
 
829
- Indicates the label for the item that has to be displayed in the Settings Panel
1345
+ Indicates if the plugin is disabled or not
830
1346
 
831
- ## `settingsPanelDisabled` (boolean)
1347
+ #### `bold` (object)
832
1348
 
833
- Indicates if the settings panel is not available
1349
+ Properties of the `bold` object:
834
1350
 
835
- ## `spellCheck` (object)
1351
+ ##### `disabled` (boolean)
836
1352
 
837
- Properties of the `spellCheck` object:
1353
+ Indicates if the plugin is disabled or not
838
1354
 
839
- ### `settings` (boolean)
1355
+ #### `html` (object)
840
1356
 
841
- Indicates if the item has to be displayed in the Settings Panel
1357
+ Properties of the `html` object:
842
1358
 
843
- ### `label` (string)
1359
+ ##### `disabled` (boolean)
844
1360
 
845
- Indicates the label for the item that has to be displayed in the Settings Panel
1361
+ Indicates if the plugin is disabled or not
846
1362
 
847
- ## `rationale` (object)
1363
+ #### `italic` (object)
848
1364
 
849
- Properties of the `rationale` object:
1365
+ Properties of the `italic` object:
850
1366
 
851
- ### `inputConfiguration` (object)
1367
+ ##### `disabled` (boolean)
852
1368
 
853
- Properties of the `inputConfiguration` object:
1369
+ Indicates if the plugin is disabled or not
854
1370
 
855
- #### `math` (object)
1371
+ #### `ol_list` (object)
856
1372
 
857
- Properties of the `math` object:
1373
+ Properties of the `ol_list` object:
858
1374
 
859
1375
  ##### `disabled` (boolean)
860
1376
 
861
1377
  Indicates if the plugin is disabled or not
862
1378
 
863
- #### `audio` (object)
1379
+ #### `redo` (object)
864
1380
 
865
- Properties of the `audio` object:
1381
+ Properties of the `redo` object:
866
1382
 
867
1383
  ##### `disabled` (boolean)
868
1384
 
869
1385
  Indicates if the plugin is disabled or not
870
1386
 
871
- #### `video` (object)
1387
+ #### `strikethrough` (object)
872
1388
 
873
- Properties of the `video` object:
1389
+ Properties of the `strikethrough` object:
874
1390
 
875
1391
  ##### `disabled` (boolean)
876
1392
 
877
1393
  Indicates if the plugin is disabled or not
878
1394
 
879
- #### `image` (object)
1395
+ #### `sub` (object)
880
1396
 
881
- Properties of the `image` object:
1397
+ Properties of the `sub` object:
882
1398
 
883
1399
  ##### `disabled` (boolean)
884
1400
 
885
1401
  Indicates if the plugin is disabled or not
886
1402
 
887
- #### `customPlugins` (array)
1403
+ #### `sup` (object)
888
1404
 
889
- An array of objects that determine custom plugins.
890
- 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).
891
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1405
+ Properties of the `sup` object:
892
1406
 
893
- The object is an array with all elements of the type `object`.
1407
+ ##### `disabled` (boolean)
894
1408
 
895
- The array object has the following properties:
1409
+ Indicates if the plugin is disabled or not
896
1410
 
897
- ##### `event` (string, required)
1411
+ #### `table` (object)
898
1412
 
899
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
900
- PIE will emit the event prefixed with "PIE-".
901
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1413
+ Properties of the `table` object:
902
1414
 
903
- ##### `iconAlt` (string, required)
1415
+ ##### `disabled` (boolean)
904
1416
 
905
- The alt for the custom button icon
1417
+ Indicates if the plugin is disabled or not
906
1418
 
907
- ##### `iconType` (string, required)
1419
+ #### `ul_list` (object)
908
1420
 
909
- The icon type.
910
- Currently, only "SVG" is supported.
1421
+ Properties of the `ul_list` object:
911
1422
 
912
- ##### `icon` (string, required)
1423
+ ##### `disabled` (boolean)
913
1424
 
914
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1425
+ Indicates if the plugin is disabled or not
915
1426
 
916
- #### `blockquote` (object)
1427
+ #### `underline` (object)
917
1428
 
918
- Properties of the `blockquote` object:
1429
+ Properties of the `underline` object:
919
1430
 
920
1431
  ##### `disabled` (boolean)
921
1432
 
922
1433
  Indicates if the plugin is disabled or not
923
1434
 
924
- #### `h3` (object)
1435
+ #### `undo` (object)
925
1436
 
926
- Properties of the `h3` object:
1437
+ Properties of the `undo` object:
927
1438
 
928
1439
  ##### `disabled` (boolean)
929
1440
 
@@ -941,9 +1452,13 @@ Indicates if the item has to be displayed in the Settings Panel
941
1452
 
942
1453
  Indicates the label for the item that has to be displayed in the Settings Panel
943
1454
 
944
- ## `studentInstructions` (object)
1455
+ ## `settingsPanelDisabled` (boolean)
945
1456
 
946
- Properties of the `studentInstructions` object:
1457
+ Indicates if the settings panel is not available
1458
+
1459
+ ## `spellCheck` (object)
1460
+
1461
+ Properties of the `spellCheck` object:
947
1462
 
948
1463
  ### `settings` (boolean)
949
1464
 
@@ -953,9 +1468,9 @@ Indicates if the item has to be displayed in the Settings Panel
953
1468
 
954
1469
  Indicates the label for the item that has to be displayed in the Settings Panel
955
1470
 
956
- ## `teacherInstructions` (object)
1471
+ ## `rationale` (object)
957
1472
 
958
- Properties of the `teacherInstructions` object:
1473
+ Properties of the `rationale` object:
959
1474
 
960
1475
  ### `inputConfiguration` (object)
961
1476
 
@@ -1038,186 +1553,137 @@ Properties of the `h3` object:
1038
1553
 
1039
1554
  Indicates if the plugin is disabled or not
1040
1555
 
1041
- ### `required` (boolean)
1556
+ #### `languageCharacters` (object)
1042
1557
 
1043
- Indicates if the item is required and the value cannot be empty
1558
+ Properties of the `languageCharacters` object:
1044
1559
 
1045
- ### `settings` (boolean)
1560
+ ##### `disabled` (boolean)
1046
1561
 
1047
- Indicates if the item has to be displayed in the Settings Panel
1562
+ Indicates if the plugin is disabled or not
1048
1563
 
1049
- ### `label` (string)
1564
+ #### `bold` (object)
1050
1565
 
1051
- Indicates the label for the item that has to be displayed in the Settings Panel
1566
+ Properties of the `bold` object:
1052
1567
 
1053
- ## `choicesLayout` (object)
1568
+ ##### `disabled` (boolean)
1054
1569
 
1055
- Properties of the `choicesLayout` object:
1570
+ Indicates if the plugin is disabled or not
1056
1571
 
1057
- ### `settings` (boolean)
1572
+ #### `html` (object)
1058
1573
 
1059
- Indicates if the item has to be displayed in the Settings Panel
1574
+ Properties of the `html` object:
1060
1575
 
1061
- ### `label` (string)
1062
-
1063
- Indicates the label for the item that has to be displayed in the Settings Panel
1064
-
1065
- ## `gridColumns` (object)
1066
-
1067
- Properties of the `gridColumns` object:
1068
-
1069
- ### `settings` (boolean)
1070
-
1071
- Indicates if the item has to be displayed in the Settings Panel
1072
-
1073
- ### `label` (string)
1074
-
1075
- Indicates the label for the item that has to be displayed in the Settings Panel
1076
-
1077
- ## `minAnswerChoices` (number)
1078
-
1079
- Minimum number of answer choices
1080
-
1081
- ## `maxAnswerChoices` (number)
1082
-
1083
- Maximum number of answer choices
1084
-
1085
- ## `maxImageWidth` (object)
1086
-
1087
- Properties of the `maxImageWidth` object:
1088
-
1089
- ### `teacherInstructions` (number)
1090
-
1091
- Indicates the max dimension for images in teacher instructions
1092
-
1093
- ### `prompt` (number)
1094
-
1095
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1096
-
1097
- ### `rationale` (number)
1098
-
1099
- Indicates the max dimension for images in rationale
1100
-
1101
- ### `choices` (number)
1102
-
1103
- Indicates the max dimension for images in choices
1104
-
1105
- ## `maxImageHeight` (object)
1576
+ ##### `disabled` (boolean)
1106
1577
 
1107
- Properties of the `maxImageHeight` object:
1578
+ Indicates if the plugin is disabled or not
1108
1579
 
1109
- ### `teacherInstructions` (number)
1580
+ #### `italic` (object)
1110
1581
 
1111
- Indicates the max dimension for images in teacher instructions
1582
+ Properties of the `italic` object:
1112
1583
 
1113
- ### `prompt` (number)
1584
+ ##### `disabled` (boolean)
1114
1585
 
1115
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1586
+ Indicates if the plugin is disabled or not
1116
1587
 
1117
- ### `rationale` (number)
1588
+ #### `ol_list` (object)
1118
1589
 
1119
- Indicates the max dimension for images in rationale
1590
+ Properties of the `ol_list` object:
1120
1591
 
1121
- ### `choices` (number)
1592
+ ##### `disabled` (boolean)
1122
1593
 
1123
- Indicates the max dimension for images in choices
1594
+ Indicates if the plugin is disabled or not
1124
1595
 
1125
- ## `mathMlOptions` (object)
1596
+ #### `redo` (object)
1126
1597
 
1127
- Properties of the `mathMlOptions` object:
1598
+ Properties of the `redo` object:
1128
1599
 
1129
- ### `mmlOutput` (number)
1600
+ ##### `disabled` (boolean)
1130
1601
 
1131
- Indicates if model should have mathML output instead of latex
1602
+ Indicates if the plugin is disabled or not
1132
1603
 
1133
- ### `mmlEditing` (number)
1604
+ #### `strikethrough` (object)
1134
1605
 
1135
- Indicates if mathML that's already in model should be editable
1606
+ Properties of the `strikethrough` object:
1136
1607
 
1137
- ## `baseInputConfiguration` (object)
1608
+ ##### `disabled` (boolean)
1138
1609
 
1139
- Properties of the `baseInputConfiguration` object:
1610
+ Indicates if the plugin is disabled or not
1140
1611
 
1141
- ### `math` (object)
1612
+ #### `sub` (object)
1142
1613
 
1143
- Properties of the `math` object:
1614
+ Properties of the `sub` object:
1144
1615
 
1145
- #### `disabled` (boolean)
1616
+ ##### `disabled` (boolean)
1146
1617
 
1147
1618
  Indicates if the plugin is disabled or not
1148
1619
 
1149
- ### `audio` (object)
1620
+ #### `sup` (object)
1150
1621
 
1151
- Properties of the `audio` object:
1622
+ Properties of the `sup` object:
1152
1623
 
1153
- #### `disabled` (boolean)
1624
+ ##### `disabled` (boolean)
1154
1625
 
1155
1626
  Indicates if the plugin is disabled or not
1156
1627
 
1157
- ### `video` (object)
1628
+ #### `table` (object)
1158
1629
 
1159
- Properties of the `video` object:
1630
+ Properties of the `table` object:
1160
1631
 
1161
- #### `disabled` (boolean)
1632
+ ##### `disabled` (boolean)
1162
1633
 
1163
1634
  Indicates if the plugin is disabled or not
1164
1635
 
1165
- ### `image` (object)
1636
+ #### `ul_list` (object)
1166
1637
 
1167
- Properties of the `image` object:
1638
+ Properties of the `ul_list` object:
1168
1639
 
1169
- #### `disabled` (boolean)
1640
+ ##### `disabled` (boolean)
1170
1641
 
1171
1642
  Indicates if the plugin is disabled or not
1172
1643
 
1173
- ### `customPlugins` (array)
1644
+ #### `underline` (object)
1174
1645
 
1175
- An array of objects that determine custom plugins.
1176
- 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).
1177
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1646
+ Properties of the `underline` object:
1178
1647
 
1179
- The object is an array with all elements of the type `object`.
1648
+ ##### `disabled` (boolean)
1180
1649
 
1181
- The array object has the following properties:
1650
+ Indicates if the plugin is disabled or not
1182
1651
 
1183
- #### `event` (string, required)
1652
+ #### `undo` (object)
1184
1653
 
1185
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1186
- PIE will emit the event prefixed with "PIE-".
1187
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1654
+ Properties of the `undo` object:
1188
1655
 
1189
- #### `iconAlt` (string, required)
1656
+ ##### `disabled` (boolean)
1190
1657
 
1191
- The alt for the custom button icon
1658
+ Indicates if the plugin is disabled or not
1192
1659
 
1193
- #### `iconType` (string, required)
1660
+ ### `required` (boolean)
1194
1661
 
1195
- The icon type.
1196
- Currently, only "SVG" is supported.
1662
+ Indicates if the item is required and the value cannot be empty
1197
1663
 
1198
- #### `icon` (string, required)
1664
+ ### `settings` (boolean)
1199
1665
 
1200
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1666
+ Indicates if the item has to be displayed in the Settings Panel
1201
1667
 
1202
- ### `blockquote` (object)
1668
+ ### `label` (string)
1203
1669
 
1204
- Properties of the `blockquote` object:
1670
+ Indicates the label for the item that has to be displayed in the Settings Panel
1205
1671
 
1206
- #### `disabled` (boolean)
1672
+ ## `studentInstructions` (object)
1207
1673
 
1208
- Indicates if the plugin is disabled or not
1674
+ Properties of the `studentInstructions` object:
1209
1675
 
1210
- ### `h3` (object)
1676
+ ### `settings` (boolean)
1211
1677
 
1212
- Properties of the `h3` object:
1678
+ Indicates if the item has to be displayed in the Settings Panel
1213
1679
 
1214
- #### `disabled` (boolean)
1680
+ ### `label` (string)
1215
1681
 
1216
- Indicates if the plugin is disabled or not
1682
+ Indicates the label for the item that has to be displayed in the Settings Panel
1217
1683
 
1218
- ## `choices` (object)
1684
+ ## `teacherInstructions` (object)
1219
1685
 
1220
- Properties of the `choices` object:
1686
+ Properties of the `teacherInstructions` object:
1221
1687
 
1222
1688
  ### `inputConfiguration` (object)
1223
1689
 
@@ -1300,167 +1766,1183 @@ Properties of the `h3` object:
1300
1766
 
1301
1767
  Indicates if the plugin is disabled or not
1302
1768
 
1303
- ### `settings` (boolean)
1304
-
1305
- Indicates if the item has to be displayed in the Settings Panel
1306
-
1307
- ### `label` (string)
1769
+ #### `languageCharacters` (object)
1308
1770
 
1309
- Indicates the label for the item that has to be displayed in the Settings Panel
1771
+ Properties of the `languageCharacters` object:
1310
1772
 
1311
- # `partLabels` (object)
1773
+ ##### `disabled` (boolean)
1312
1774
 
1313
- Properties of the `partLabels` object:
1775
+ Indicates if the plugin is disabled or not
1314
1776
 
1315
- ## `settings` (boolean)
1777
+ #### `bold` (object)
1316
1778
 
1317
- Indicates if the item has to be displayed in the Settings Panel
1779
+ Properties of the `bold` object:
1318
1780
 
1319
- ## `label` (string)
1781
+ ##### `disabled` (boolean)
1320
1782
 
1321
- Indicates the label for the item that has to be displayed in the Settings Panel
1783
+ Indicates if the plugin is disabled or not
1322
1784
 
1323
- # `partialScoring` (object)
1785
+ #### `html` (object)
1324
1786
 
1325
- Properties of the `partialScoring` object:
1787
+ Properties of the `html` object:
1326
1788
 
1327
- ## `settings` (boolean)
1789
+ ##### `disabled` (boolean)
1328
1790
 
1329
- Indicates if the item has to be displayed in the Settings Panel
1791
+ Indicates if the plugin is disabled or not
1330
1792
 
1331
- ## `label` (string)
1793
+ #### `italic` (object)
1332
1794
 
1333
- Indicates the label for the item that has to be displayed in the Settings Panel
1795
+ Properties of the `italic` object:
1334
1796
 
1335
- # `settingsPanelDisabled` (boolean)
1797
+ ##### `disabled` (boolean)
1336
1798
 
1337
- Indicates if the settings panel is not available
1799
+ Indicates if the plugin is disabled or not
1338
1800
 
1339
- # `scoringType` (object)
1801
+ #### `ol_list` (object)
1340
1802
 
1341
- Properties of the `scoringType` object:
1803
+ Properties of the `ol_list` object:
1342
1804
 
1343
- ## `settings` (boolean)
1805
+ ##### `disabled` (boolean)
1344
1806
 
1345
- Indicates if the item has to be displayed in the Settings Panel
1807
+ Indicates if the plugin is disabled or not
1346
1808
 
1347
- ## `label` (string)
1809
+ #### `redo` (object)
1348
1810
 
1349
- Indicates the label for the item that has to be displayed in the Settings Panel
1811
+ Properties of the `redo` object:
1350
1812
 
1351
- # `showPrompt` (boolean)
1813
+ ##### `disabled` (boolean)
1352
1814
 
1353
- Determines whether prompt field will be displayed or not
1815
+ Indicates if the plugin is disabled or not
1354
1816
 
1355
- Default: `true`
1817
+ #### `strikethrough` (object)
1356
1818
 
1357
- # `promptLabel` (string)
1819
+ Properties of the `strikethrough` object:
1358
1820
 
1359
- The label for the item stem/prompt field
1821
+ ##### `disabled` (boolean)
1360
1822
 
1361
- Default: `"Item Stemm"`
1823
+ Indicates if the plugin is disabled or not
1362
1824
 
1363
- # `contentDimensions` (object)
1825
+ #### `sub` (object)
1364
1826
 
1365
- Indicates the dimensions configuration for the authoring container
1366
- Note: Some items have a default minimum width because of their content, but if
1367
- the minWidth is lower than this, the overflow behavior will take care of that
1827
+ Properties of the `sub` object:
1368
1828
 
1369
- Properties of the `contentDimensions` object:
1829
+ ##### `disabled` (boolean)
1370
1830
 
1371
- ## `maxHeight` (string,number)
1831
+ Indicates if the plugin is disabled or not
1372
1832
 
1373
- Indicates the max height of the authoring container
1833
+ #### `sup` (object)
1374
1834
 
1375
- Default: `"undefined"`
1835
+ Properties of the `sup` object:
1376
1836
 
1377
- ## `maxWidth` (string,number)
1837
+ ##### `disabled` (boolean)
1378
1838
 
1379
- Indicates the max width of the authoring container
1839
+ Indicates if the plugin is disabled or not
1380
1840
 
1381
- Default: `"undefined"`
1841
+ #### `table` (object)
1382
1842
 
1383
- ## `minHeight` (string,number)
1843
+ Properties of the `table` object:
1384
1844
 
1385
- Indicates the min height of the authoring container
1845
+ ##### `disabled` (boolean)
1386
1846
 
1387
- Default: `"undefined"`
1847
+ Indicates if the plugin is disabled or not
1388
1848
 
1389
- ## `minWidth` (string,number)
1849
+ #### `ul_list` (object)
1390
1850
 
1391
- Indicates the min width of the authoring container
1851
+ Properties of the `ul_list` object:
1392
1852
 
1393
- Default: `"undefined"`
1853
+ ##### `disabled` (boolean)
1394
1854
 
1395
- Default: `": {}"`
1855
+ Indicates if the plugin is disabled or not
1396
1856
 
1397
- # `settingsPartialScoring` (boolean)
1857
+ #### `underline` (object)
1398
1858
 
1399
- Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1859
+ Properties of the `underline` object:
1400
1860
 
1401
- Default: `true`
1861
+ ##### `disabled` (boolean)
1402
1862
 
1403
- ---
1863
+ Indicates if the plugin is disabled or not
1404
1864
 
1405
- # Sub Schemas
1865
+ #### `undo` (object)
1406
1866
 
1407
- The schema defines the following additional types:
1867
+ Properties of the `undo` object:
1408
1868
 
1409
- ## `PartConfiguration` (object)
1869
+ ##### `disabled` (boolean)
1410
1870
 
1411
- Properties of the `PartConfiguration` object:
1871
+ Indicates if the plugin is disabled or not
1412
1872
 
1413
- ### `addChoiceButton` (object)
1873
+ ### `required` (boolean)
1414
1874
 
1415
- Properties of the `addChoiceButton` object:
1875
+ Indicates if the item is required and the value cannot be empty
1416
1876
 
1417
- #### `settings` (boolean)
1877
+ ### `settings` (boolean)
1418
1878
 
1419
1879
  Indicates if the item has to be displayed in the Settings Panel
1420
1880
 
1421
- #### `label` (string)
1881
+ ### `label` (string)
1422
1882
 
1423
1883
  Indicates the label for the item that has to be displayed in the Settings Panel
1424
1884
 
1425
- ### `choiceMode` (object)
1885
+ ## `choicesLayout` (object)
1426
1886
 
1427
- Properties of the `choiceMode` object:
1887
+ Properties of the `choicesLayout` object:
1428
1888
 
1429
- #### `settings` (boolean)
1889
+ ### `settings` (boolean)
1430
1890
 
1431
1891
  Indicates if the item has to be displayed in the Settings Panel
1432
1892
 
1433
- #### `label` (string)
1893
+ ### `label` (string)
1434
1894
 
1435
1895
  Indicates the label for the item that has to be displayed in the Settings Panel
1436
1896
 
1437
- ### `choicePrefix` (object)
1897
+ ## `gridColumns` (object)
1438
1898
 
1439
- Properties of the `choicePrefix` object:
1899
+ Properties of the `gridColumns` object:
1440
1900
 
1441
- #### `settings` (boolean)
1901
+ ### `settings` (boolean)
1442
1902
 
1443
1903
  Indicates if the item has to be displayed in the Settings Panel
1444
1904
 
1445
- #### `label` (string)
1905
+ ### `label` (string)
1446
1906
 
1447
1907
  Indicates the label for the item that has to be displayed in the Settings Panel
1448
1908
 
1449
- ### `deleteChoice` (object)
1909
+ ## `minAnswerChoices` (number)
1450
1910
 
1451
- Properties of the `deleteChoice` object:
1911
+ Minimum number of answer choices
1452
1912
 
1453
- #### `settings` (boolean)
1913
+ ## `maxAnswerChoices` (number)
1454
1914
 
1455
- Indicates if the item has to be displayed in the Settings Panel
1915
+ Maximum number of answer choices
1456
1916
 
1457
- #### `label` (string)
1917
+ ## `maxImageWidth` (object)
1458
1918
 
1459
- Indicates the label for the item that has to be displayed in the Settings Panel
1919
+ Properties of the `maxImageWidth` object:
1460
1920
 
1461
- ### `feedback` (object)
1921
+ ### `teacherInstructions` (number)
1462
1922
 
1463
- Properties of the `feedback` object:
1923
+ Indicates the max dimension for images in teacher instructions
1924
+
1925
+ ### `prompt` (number)
1926
+
1927
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1928
+
1929
+ ### `rationale` (number)
1930
+
1931
+ Indicates the max dimension for images in rationale
1932
+
1933
+ ### `choices` (number)
1934
+
1935
+ Indicates the max dimension for images in choices
1936
+
1937
+ ## `maxImageHeight` (object)
1938
+
1939
+ Properties of the `maxImageHeight` object:
1940
+
1941
+ ### `teacherInstructions` (number)
1942
+
1943
+ Indicates the max dimension for images in teacher instructions
1944
+
1945
+ ### `prompt` (number)
1946
+
1947
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
1948
+
1949
+ ### `rationale` (number)
1950
+
1951
+ Indicates the max dimension for images in rationale
1952
+
1953
+ ### `choices` (number)
1954
+
1955
+ Indicates the max dimension for images in choices
1956
+
1957
+ ## `mathMlOptions` (object)
1958
+
1959
+ Properties of the `mathMlOptions` object:
1960
+
1961
+ ### `mmlOutput` (number)
1962
+
1963
+ Indicates if model should have mathML output instead of latex
1964
+
1965
+ ### `mmlEditing` (number)
1966
+
1967
+ Indicates if mathML that's already in model should be editable
1968
+
1969
+ ## `baseInputConfiguration` (object)
1970
+
1971
+ Properties of the `baseInputConfiguration` object:
1972
+
1973
+ ### `math` (object)
1974
+
1975
+ Properties of the `math` object:
1976
+
1977
+ #### `disabled` (boolean)
1978
+
1979
+ Indicates if the plugin is disabled or not
1980
+
1981
+ ### `audio` (object)
1982
+
1983
+ Properties of the `audio` object:
1984
+
1985
+ #### `disabled` (boolean)
1986
+
1987
+ Indicates if the plugin is disabled or not
1988
+
1989
+ ### `video` (object)
1990
+
1991
+ Properties of the `video` object:
1992
+
1993
+ #### `disabled` (boolean)
1994
+
1995
+ Indicates if the plugin is disabled or not
1996
+
1997
+ ### `image` (object)
1998
+
1999
+ Properties of the `image` object:
2000
+
2001
+ #### `disabled` (boolean)
2002
+
2003
+ Indicates if the plugin is disabled or not
2004
+
2005
+ ### `customPlugins` (array)
2006
+
2007
+ An array of objects that determine custom plugins.
2008
+ 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).
2009
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2010
+
2011
+ The object is an array with all elements of the type `object`.
2012
+
2013
+ The array object has the following properties:
2014
+
2015
+ #### `event` (string, required)
2016
+
2017
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2018
+ PIE will emit the event prefixed with "PIE-".
2019
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2020
+
2021
+ #### `iconAlt` (string, required)
2022
+
2023
+ The alt for the custom button icon
2024
+
2025
+ #### `iconType` (string, required)
2026
+
2027
+ The icon type.
2028
+ Currently, only "SVG" is supported.
2029
+
2030
+ #### `icon` (string, required)
2031
+
2032
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2033
+
2034
+ ### `blockquote` (object)
2035
+
2036
+ Properties of the `blockquote` object:
2037
+
2038
+ #### `disabled` (boolean)
2039
+
2040
+ Indicates if the plugin is disabled or not
2041
+
2042
+ ### `h3` (object)
2043
+
2044
+ Properties of the `h3` object:
2045
+
2046
+ #### `disabled` (boolean)
2047
+
2048
+ Indicates if the plugin is disabled or not
2049
+
2050
+ ### `languageCharacters` (object)
2051
+
2052
+ Properties of the `languageCharacters` object:
2053
+
2054
+ #### `disabled` (boolean)
2055
+
2056
+ Indicates if the plugin is disabled or not
2057
+
2058
+ ### `bold` (object)
2059
+
2060
+ Properties of the `bold` object:
2061
+
2062
+ #### `disabled` (boolean)
2063
+
2064
+ Indicates if the plugin is disabled or not
2065
+
2066
+ ### `html` (object)
2067
+
2068
+ Properties of the `html` object:
2069
+
2070
+ #### `disabled` (boolean)
2071
+
2072
+ Indicates if the plugin is disabled or not
2073
+
2074
+ ### `italic` (object)
2075
+
2076
+ Properties of the `italic` object:
2077
+
2078
+ #### `disabled` (boolean)
2079
+
2080
+ Indicates if the plugin is disabled or not
2081
+
2082
+ ### `ol_list` (object)
2083
+
2084
+ Properties of the `ol_list` object:
2085
+
2086
+ #### `disabled` (boolean)
2087
+
2088
+ Indicates if the plugin is disabled or not
2089
+
2090
+ ### `redo` (object)
2091
+
2092
+ Properties of the `redo` object:
2093
+
2094
+ #### `disabled` (boolean)
2095
+
2096
+ Indicates if the plugin is disabled or not
2097
+
2098
+ ### `strikethrough` (object)
2099
+
2100
+ Properties of the `strikethrough` object:
2101
+
2102
+ #### `disabled` (boolean)
2103
+
2104
+ Indicates if the plugin is disabled or not
2105
+
2106
+ ### `sub` (object)
2107
+
2108
+ Properties of the `sub` object:
2109
+
2110
+ #### `disabled` (boolean)
2111
+
2112
+ Indicates if the plugin is disabled or not
2113
+
2114
+ ### `sup` (object)
2115
+
2116
+ Properties of the `sup` object:
2117
+
2118
+ #### `disabled` (boolean)
2119
+
2120
+ Indicates if the plugin is disabled or not
2121
+
2122
+ ### `table` (object)
2123
+
2124
+ Properties of the `table` object:
2125
+
2126
+ #### `disabled` (boolean)
2127
+
2128
+ Indicates if the plugin is disabled or not
2129
+
2130
+ ### `ul_list` (object)
2131
+
2132
+ Properties of the `ul_list` object:
2133
+
2134
+ #### `disabled` (boolean)
2135
+
2136
+ Indicates if the plugin is disabled or not
2137
+
2138
+ ### `underline` (object)
2139
+
2140
+ Properties of the `underline` object:
2141
+
2142
+ #### `disabled` (boolean)
2143
+
2144
+ Indicates if the plugin is disabled or not
2145
+
2146
+ ### `undo` (object)
2147
+
2148
+ Properties of the `undo` object:
2149
+
2150
+ #### `disabled` (boolean)
2151
+
2152
+ Indicates if the plugin is disabled or not
2153
+
2154
+ ## `choices` (object)
2155
+
2156
+ Properties of the `choices` object:
2157
+
2158
+ ### `inputConfiguration` (object)
2159
+
2160
+ Properties of the `inputConfiguration` object:
2161
+
2162
+ #### `math` (object)
2163
+
2164
+ Properties of the `math` object:
2165
+
2166
+ ##### `disabled` (boolean)
2167
+
2168
+ Indicates if the plugin is disabled or not
2169
+
2170
+ #### `audio` (object)
2171
+
2172
+ Properties of the `audio` object:
2173
+
2174
+ ##### `disabled` (boolean)
2175
+
2176
+ Indicates if the plugin is disabled or not
2177
+
2178
+ #### `video` (object)
2179
+
2180
+ Properties of the `video` object:
2181
+
2182
+ ##### `disabled` (boolean)
2183
+
2184
+ Indicates if the plugin is disabled or not
2185
+
2186
+ #### `image` (object)
2187
+
2188
+ Properties of the `image` object:
2189
+
2190
+ ##### `disabled` (boolean)
2191
+
2192
+ Indicates if the plugin is disabled or not
2193
+
2194
+ #### `customPlugins` (array)
2195
+
2196
+ An array of objects that determine custom plugins.
2197
+ 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).
2198
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2199
+
2200
+ The object is an array with all elements of the type `object`.
2201
+
2202
+ The array object has the following properties:
2203
+
2204
+ ##### `event` (string, required)
2205
+
2206
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2207
+ PIE will emit the event prefixed with "PIE-".
2208
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2209
+
2210
+ ##### `iconAlt` (string, required)
2211
+
2212
+ The alt for the custom button icon
2213
+
2214
+ ##### `iconType` (string, required)
2215
+
2216
+ The icon type.
2217
+ Currently, only "SVG" is supported.
2218
+
2219
+ ##### `icon` (string, required)
2220
+
2221
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2222
+
2223
+ #### `blockquote` (object)
2224
+
2225
+ Properties of the `blockquote` object:
2226
+
2227
+ ##### `disabled` (boolean)
2228
+
2229
+ Indicates if the plugin is disabled or not
2230
+
2231
+ #### `h3` (object)
2232
+
2233
+ Properties of the `h3` object:
2234
+
2235
+ ##### `disabled` (boolean)
2236
+
2237
+ Indicates if the plugin is disabled or not
2238
+
2239
+ #### `languageCharacters` (object)
2240
+
2241
+ Properties of the `languageCharacters` object:
2242
+
2243
+ ##### `disabled` (boolean)
2244
+
2245
+ Indicates if the plugin is disabled or not
2246
+
2247
+ #### `bold` (object)
2248
+
2249
+ Properties of the `bold` object:
2250
+
2251
+ ##### `disabled` (boolean)
2252
+
2253
+ Indicates if the plugin is disabled or not
2254
+
2255
+ #### `html` (object)
2256
+
2257
+ Properties of the `html` object:
2258
+
2259
+ ##### `disabled` (boolean)
2260
+
2261
+ Indicates if the plugin is disabled or not
2262
+
2263
+ #### `italic` (object)
2264
+
2265
+ Properties of the `italic` object:
2266
+
2267
+ ##### `disabled` (boolean)
2268
+
2269
+ Indicates if the plugin is disabled or not
2270
+
2271
+ #### `ol_list` (object)
2272
+
2273
+ Properties of the `ol_list` object:
2274
+
2275
+ ##### `disabled` (boolean)
2276
+
2277
+ Indicates if the plugin is disabled or not
2278
+
2279
+ #### `redo` (object)
2280
+
2281
+ Properties of the `redo` object:
2282
+
2283
+ ##### `disabled` (boolean)
2284
+
2285
+ Indicates if the plugin is disabled or not
2286
+
2287
+ #### `strikethrough` (object)
2288
+
2289
+ Properties of the `strikethrough` object:
2290
+
2291
+ ##### `disabled` (boolean)
2292
+
2293
+ Indicates if the plugin is disabled or not
2294
+
2295
+ #### `sub` (object)
2296
+
2297
+ Properties of the `sub` object:
2298
+
2299
+ ##### `disabled` (boolean)
2300
+
2301
+ Indicates if the plugin is disabled or not
2302
+
2303
+ #### `sup` (object)
2304
+
2305
+ Properties of the `sup` object:
2306
+
2307
+ ##### `disabled` (boolean)
2308
+
2309
+ Indicates if the plugin is disabled or not
2310
+
2311
+ #### `table` (object)
2312
+
2313
+ Properties of the `table` object:
2314
+
2315
+ ##### `disabled` (boolean)
2316
+
2317
+ Indicates if the plugin is disabled or not
2318
+
2319
+ #### `ul_list` (object)
2320
+
2321
+ Properties of the `ul_list` object:
2322
+
2323
+ ##### `disabled` (boolean)
2324
+
2325
+ Indicates if the plugin is disabled or not
2326
+
2327
+ #### `underline` (object)
2328
+
2329
+ Properties of the `underline` object:
2330
+
2331
+ ##### `disabled` (boolean)
2332
+
2333
+ Indicates if the plugin is disabled or not
2334
+
2335
+ #### `undo` (object)
2336
+
2337
+ Properties of the `undo` object:
2338
+
2339
+ ##### `disabled` (boolean)
2340
+
2341
+ Indicates if the plugin is disabled or not
2342
+
2343
+ ### `settings` (boolean)
2344
+
2345
+ Indicates if the item has to be displayed in the Settings Panel
2346
+
2347
+ ### `label` (string)
2348
+
2349
+ Indicates the label for the item that has to be displayed in the Settings Panel
2350
+
2351
+ # `partLabels` (object)
2352
+
2353
+ Properties of the `partLabels` object:
2354
+
2355
+ ## `settings` (boolean)
2356
+
2357
+ Indicates if the item has to be displayed in the Settings Panel
2358
+
2359
+ ## `label` (string)
2360
+
2361
+ Indicates the label for the item that has to be displayed in the Settings Panel
2362
+
2363
+ # `partialScoring` (object)
2364
+
2365
+ Properties of the `partialScoring` object:
2366
+
2367
+ ## `settings` (boolean)
2368
+
2369
+ Indicates if the item has to be displayed in the Settings Panel
2370
+
2371
+ ## `label` (string)
2372
+
2373
+ Indicates the label for the item that has to be displayed in the Settings Panel
2374
+
2375
+ # `settingsPanelDisabled` (boolean)
2376
+
2377
+ Indicates if the settings panel is not available
2378
+
2379
+ # `scoringType` (object)
2380
+
2381
+ Properties of the `scoringType` object:
2382
+
2383
+ ## `settings` (boolean)
2384
+
2385
+ Indicates if the item has to be displayed in the Settings Panel
2386
+
2387
+ ## `label` (string)
2388
+
2389
+ Indicates the label for the item that has to be displayed in the Settings Panel
2390
+
2391
+ # `showPrompt` (boolean)
2392
+
2393
+ Determines whether prompt field will be displayed or not
2394
+
2395
+ Default: `true`
2396
+
2397
+ # `promptLabel` (string)
2398
+
2399
+ The label for the item stem/prompt field
2400
+
2401
+ Default: `"Item Stemm"`
2402
+
2403
+ # `contentDimensions` (object)
2404
+
2405
+ Indicates the dimensions configuration for the authoring container
2406
+ Note: Some items have a default minimum width because of their content, but if
2407
+ the minWidth is lower than this, the overflow behavior will take care of that
2408
+
2409
+ Properties of the `contentDimensions` object:
2410
+
2411
+ ## `maxHeight` (string,number)
2412
+
2413
+ Indicates the max height of the authoring container
2414
+
2415
+ Default: `"undefined"`
2416
+
2417
+ ## `maxWidth` (string,number)
2418
+
2419
+ Indicates the max width of the authoring container
2420
+
2421
+ Default: `"undefined"`
2422
+
2423
+ ## `minHeight` (string,number)
2424
+
2425
+ Indicates the min height of the authoring container
2426
+
2427
+ Default: `"undefined"`
2428
+
2429
+ ## `minWidth` (string,number)
2430
+
2431
+ Indicates the min width of the authoring container
2432
+
2433
+ Default: `"undefined"`
2434
+
2435
+ Default: `": {}"`
2436
+
2437
+ # `settingsPartialScoring` (boolean)
2438
+
2439
+ Indicates whether the settings panel wil allow the author to modify settings for partial scoring
2440
+
2441
+ Default: `true`
2442
+
2443
+ ---
2444
+
2445
+ # Sub Schemas
2446
+
2447
+ The schema defines the following additional types:
2448
+
2449
+ ## `PartConfiguration` (object)
2450
+
2451
+ Properties of the `PartConfiguration` object:
2452
+
2453
+ ### `addChoiceButton` (object)
2454
+
2455
+ Properties of the `addChoiceButton` object:
2456
+
2457
+ #### `settings` (boolean)
2458
+
2459
+ Indicates if the item has to be displayed in the Settings Panel
2460
+
2461
+ #### `label` (string)
2462
+
2463
+ Indicates the label for the item that has to be displayed in the Settings Panel
2464
+
2465
+ ### `choiceMode` (object)
2466
+
2467
+ Properties of the `choiceMode` object:
2468
+
2469
+ #### `settings` (boolean)
2470
+
2471
+ Indicates if the item has to be displayed in the Settings Panel
2472
+
2473
+ #### `label` (string)
2474
+
2475
+ Indicates the label for the item that has to be displayed in the Settings Panel
2476
+
2477
+ ### `choicePrefix` (object)
2478
+
2479
+ Properties of the `choicePrefix` object:
2480
+
2481
+ #### `settings` (boolean)
2482
+
2483
+ Indicates if the item has to be displayed in the Settings Panel
2484
+
2485
+ #### `label` (string)
2486
+
2487
+ Indicates the label for the item that has to be displayed in the Settings Panel
2488
+
2489
+ ### `deleteChoice` (object)
2490
+
2491
+ Properties of the `deleteChoice` object:
2492
+
2493
+ #### `settings` (boolean)
2494
+
2495
+ Indicates if the item has to be displayed in the Settings Panel
2496
+
2497
+ #### `label` (string)
2498
+
2499
+ Indicates the label for the item that has to be displayed in the Settings Panel
2500
+
2501
+ ### `feedback` (object)
2502
+
2503
+ Properties of the `feedback` object:
2504
+
2505
+ #### `settings` (boolean)
2506
+
2507
+ Indicates if the item has to be displayed in the Settings Panel
2508
+
2509
+ #### `label` (string)
2510
+
2511
+ Indicates the label for the item that has to be displayed in the Settings Panel
2512
+
2513
+ ### `lockChoiceOrder` (object)
2514
+
2515
+ Properties of the `lockChoiceOrder` object:
2516
+
2517
+ #### `settings` (boolean)
2518
+
2519
+ Indicates if the item has to be displayed in the Settings Panel
2520
+
2521
+ #### `label` (string)
2522
+
2523
+ Indicates the label for the item that has to be displayed in the Settings Panel
2524
+
2525
+ ### `prompt` (object)
2526
+
2527
+ Properties of the `prompt` object:
2528
+
2529
+ #### `inputConfiguration` (object)
2530
+
2531
+ Properties of the `inputConfiguration` object:
2532
+
2533
+ ##### `math` (object)
2534
+
2535
+ Properties of the `math` object:
2536
+
2537
+ ###### `disabled` (boolean)
2538
+
2539
+ Indicates if the plugin is disabled or not
2540
+
2541
+ ##### `audio` (object)
2542
+
2543
+ Properties of the `audio` object:
2544
+
2545
+ ###### `disabled` (boolean)
2546
+
2547
+ Indicates if the plugin is disabled or not
2548
+
2549
+ ##### `video` (object)
2550
+
2551
+ Properties of the `video` object:
2552
+
2553
+ ###### `disabled` (boolean)
2554
+
2555
+ Indicates if the plugin is disabled or not
2556
+
2557
+ ##### `image` (object)
2558
+
2559
+ Properties of the `image` object:
2560
+
2561
+ ###### `disabled` (boolean)
2562
+
2563
+ Indicates if the plugin is disabled or not
2564
+
2565
+ ##### `customPlugins` (array)
2566
+
2567
+ An array of objects that determine custom plugins.
2568
+ 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).
2569
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2570
+
2571
+ The object is an array with all elements of the type `object`.
2572
+
2573
+ The array object has the following properties:
2574
+
2575
+ ###### `event` (string, required)
2576
+
2577
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2578
+ PIE will emit the event prefixed with "PIE-".
2579
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2580
+
2581
+ ###### `iconAlt` (string, required)
2582
+
2583
+ The alt for the custom button icon
2584
+
2585
+ ###### `iconType` (string, required)
2586
+
2587
+ The icon type.
2588
+ Currently, only "SVG" is supported.
2589
+
2590
+ ###### `icon` (string, required)
2591
+
2592
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2593
+
2594
+ ##### `blockquote` (object)
2595
+
2596
+ Properties of the `blockquote` object:
2597
+
2598
+ ###### `disabled` (boolean)
2599
+
2600
+ Indicates if the plugin is disabled or not
2601
+
2602
+ ##### `h3` (object)
2603
+
2604
+ Properties of the `h3` object:
2605
+
2606
+ ###### `disabled` (boolean)
2607
+
2608
+ Indicates if the plugin is disabled or not
2609
+
2610
+ ##### `languageCharacters` (object)
2611
+
2612
+ Properties of the `languageCharacters` object:
2613
+
2614
+ ###### `disabled` (boolean)
2615
+
2616
+ Indicates if the plugin is disabled or not
2617
+
2618
+ ##### `bold` (object)
2619
+
2620
+ Properties of the `bold` object:
2621
+
2622
+ ###### `disabled` (boolean)
2623
+
2624
+ Indicates if the plugin is disabled or not
2625
+
2626
+ ##### `html` (object)
2627
+
2628
+ Properties of the `html` object:
2629
+
2630
+ ###### `disabled` (boolean)
2631
+
2632
+ Indicates if the plugin is disabled or not
2633
+
2634
+ ##### `italic` (object)
2635
+
2636
+ Properties of the `italic` object:
2637
+
2638
+ ###### `disabled` (boolean)
2639
+
2640
+ Indicates if the plugin is disabled or not
2641
+
2642
+ ##### `ol_list` (object)
2643
+
2644
+ Properties of the `ol_list` object:
2645
+
2646
+ ###### `disabled` (boolean)
2647
+
2648
+ Indicates if the plugin is disabled or not
2649
+
2650
+ ##### `redo` (object)
2651
+
2652
+ Properties of the `redo` object:
2653
+
2654
+ ###### `disabled` (boolean)
2655
+
2656
+ Indicates if the plugin is disabled or not
2657
+
2658
+ ##### `strikethrough` (object)
2659
+
2660
+ Properties of the `strikethrough` object:
2661
+
2662
+ ###### `disabled` (boolean)
2663
+
2664
+ Indicates if the plugin is disabled or not
2665
+
2666
+ ##### `sub` (object)
2667
+
2668
+ Properties of the `sub` object:
2669
+
2670
+ ###### `disabled` (boolean)
2671
+
2672
+ Indicates if the plugin is disabled or not
2673
+
2674
+ ##### `sup` (object)
2675
+
2676
+ Properties of the `sup` object:
2677
+
2678
+ ###### `disabled` (boolean)
2679
+
2680
+ Indicates if the plugin is disabled or not
2681
+
2682
+ ##### `table` (object)
2683
+
2684
+ Properties of the `table` object:
2685
+
2686
+ ###### `disabled` (boolean)
2687
+
2688
+ Indicates if the plugin is disabled or not
2689
+
2690
+ ##### `ul_list` (object)
2691
+
2692
+ Properties of the `ul_list` object:
2693
+
2694
+ ###### `disabled` (boolean)
2695
+
2696
+ Indicates if the plugin is disabled or not
2697
+
2698
+ ##### `underline` (object)
2699
+
2700
+ Properties of the `underline` object:
2701
+
2702
+ ###### `disabled` (boolean)
2703
+
2704
+ Indicates if the plugin is disabled or not
2705
+
2706
+ ##### `undo` (object)
2707
+
2708
+ Properties of the `undo` object:
2709
+
2710
+ ###### `disabled` (boolean)
2711
+
2712
+ Indicates if the plugin is disabled or not
2713
+
2714
+ #### `required` (boolean)
2715
+
2716
+ Indicates if the item is required and the value cannot be empty
2717
+
2718
+ #### `settings` (boolean)
2719
+
2720
+ Indicates if the item has to be displayed in the Settings Panel
2721
+
2722
+ #### `label` (string)
2723
+
2724
+ Indicates the label for the item that has to be displayed in the Settings Panel
2725
+
2726
+ ### `settingsPanelDisabled` (boolean)
2727
+
2728
+ Indicates if the settings panel is not available
2729
+
2730
+ ### `spellCheck` (object)
2731
+
2732
+ Properties of the `spellCheck` object:
2733
+
2734
+ #### `settings` (boolean)
2735
+
2736
+ Indicates if the item has to be displayed in the Settings Panel
2737
+
2738
+ #### `label` (string)
2739
+
2740
+ Indicates the label for the item that has to be displayed in the Settings Panel
2741
+
2742
+ ### `rationale` (object)
2743
+
2744
+ Properties of the `rationale` object:
2745
+
2746
+ #### `inputConfiguration` (object)
2747
+
2748
+ Properties of the `inputConfiguration` object:
2749
+
2750
+ ##### `math` (object)
2751
+
2752
+ Properties of the `math` object:
2753
+
2754
+ ###### `disabled` (boolean)
2755
+
2756
+ Indicates if the plugin is disabled or not
2757
+
2758
+ ##### `audio` (object)
2759
+
2760
+ Properties of the `audio` object:
2761
+
2762
+ ###### `disabled` (boolean)
2763
+
2764
+ Indicates if the plugin is disabled or not
2765
+
2766
+ ##### `video` (object)
2767
+
2768
+ Properties of the `video` object:
2769
+
2770
+ ###### `disabled` (boolean)
2771
+
2772
+ Indicates if the plugin is disabled or not
2773
+
2774
+ ##### `image` (object)
2775
+
2776
+ Properties of the `image` object:
2777
+
2778
+ ###### `disabled` (boolean)
2779
+
2780
+ Indicates if the plugin is disabled or not
2781
+
2782
+ ##### `customPlugins` (array)
2783
+
2784
+ An array of objects that determine custom plugins.
2785
+ 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).
2786
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2787
+
2788
+ The object is an array with all elements of the type `object`.
2789
+
2790
+ The array object has the following properties:
2791
+
2792
+ ###### `event` (string, required)
2793
+
2794
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2795
+ PIE will emit the event prefixed with "PIE-".
2796
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2797
+
2798
+ ###### `iconAlt` (string, required)
2799
+
2800
+ The alt for the custom button icon
2801
+
2802
+ ###### `iconType` (string, required)
2803
+
2804
+ The icon type.
2805
+ Currently, only "SVG" is supported.
2806
+
2807
+ ###### `icon` (string, required)
2808
+
2809
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2810
+
2811
+ ##### `blockquote` (object)
2812
+
2813
+ Properties of the `blockquote` object:
2814
+
2815
+ ###### `disabled` (boolean)
2816
+
2817
+ Indicates if the plugin is disabled or not
2818
+
2819
+ ##### `h3` (object)
2820
+
2821
+ Properties of the `h3` object:
2822
+
2823
+ ###### `disabled` (boolean)
2824
+
2825
+ Indicates if the plugin is disabled or not
2826
+
2827
+ ##### `languageCharacters` (object)
2828
+
2829
+ Properties of the `languageCharacters` object:
2830
+
2831
+ ###### `disabled` (boolean)
2832
+
2833
+ Indicates if the plugin is disabled or not
2834
+
2835
+ ##### `bold` (object)
2836
+
2837
+ Properties of the `bold` object:
2838
+
2839
+ ###### `disabled` (boolean)
2840
+
2841
+ Indicates if the plugin is disabled or not
2842
+
2843
+ ##### `html` (object)
2844
+
2845
+ Properties of the `html` object:
2846
+
2847
+ ###### `disabled` (boolean)
2848
+
2849
+ Indicates if the plugin is disabled or not
2850
+
2851
+ ##### `italic` (object)
2852
+
2853
+ Properties of the `italic` object:
2854
+
2855
+ ###### `disabled` (boolean)
2856
+
2857
+ Indicates if the plugin is disabled or not
2858
+
2859
+ ##### `ol_list` (object)
2860
+
2861
+ Properties of the `ol_list` object:
2862
+
2863
+ ###### `disabled` (boolean)
2864
+
2865
+ Indicates if the plugin is disabled or not
2866
+
2867
+ ##### `redo` (object)
2868
+
2869
+ Properties of the `redo` object:
2870
+
2871
+ ###### `disabled` (boolean)
2872
+
2873
+ Indicates if the plugin is disabled or not
2874
+
2875
+ ##### `strikethrough` (object)
2876
+
2877
+ Properties of the `strikethrough` object:
2878
+
2879
+ ###### `disabled` (boolean)
2880
+
2881
+ Indicates if the plugin is disabled or not
2882
+
2883
+ ##### `sub` (object)
2884
+
2885
+ Properties of the `sub` object:
2886
+
2887
+ ###### `disabled` (boolean)
2888
+
2889
+ Indicates if the plugin is disabled or not
2890
+
2891
+ ##### `sup` (object)
2892
+
2893
+ Properties of the `sup` object:
2894
+
2895
+ ###### `disabled` (boolean)
2896
+
2897
+ Indicates if the plugin is disabled or not
2898
+
2899
+ ##### `table` (object)
2900
+
2901
+ Properties of the `table` object:
2902
+
2903
+ ###### `disabled` (boolean)
2904
+
2905
+ Indicates if the plugin is disabled or not
2906
+
2907
+ ##### `ul_list` (object)
2908
+
2909
+ Properties of the `ul_list` object:
2910
+
2911
+ ###### `disabled` (boolean)
2912
+
2913
+ Indicates if the plugin is disabled or not
2914
+
2915
+ ##### `underline` (object)
2916
+
2917
+ Properties of the `underline` object:
2918
+
2919
+ ###### `disabled` (boolean)
2920
+
2921
+ Indicates if the plugin is disabled or not
2922
+
2923
+ ##### `undo` (object)
2924
+
2925
+ Properties of the `undo` object:
2926
+
2927
+ ###### `disabled` (boolean)
2928
+
2929
+ Indicates if the plugin is disabled or not
2930
+
2931
+ #### `required` (boolean)
2932
+
2933
+ Indicates if the item is required and the value cannot be empty
2934
+
2935
+ #### `settings` (boolean)
2936
+
2937
+ Indicates if the item has to be displayed in the Settings Panel
2938
+
2939
+ #### `label` (string)
2940
+
2941
+ Indicates the label for the item that has to be displayed in the Settings Panel
2942
+
2943
+ ### `studentInstructions` (object)
2944
+
2945
+ Properties of the `studentInstructions` object:
1464
2946
 
1465
2947
  #### `settings` (boolean)
1466
2948
 
@@ -1470,59 +2952,328 @@ Indicates if the item has to be displayed in the Settings Panel
1470
2952
 
1471
2953
  Indicates the label for the item that has to be displayed in the Settings Panel
1472
2954
 
1473
- ### `lockChoiceOrder` (object)
2955
+ ### `teacherInstructions` (object)
1474
2956
 
1475
- Properties of the `lockChoiceOrder` object:
2957
+ Properties of the `teacherInstructions` object:
2958
+
2959
+ #### `inputConfiguration` (object)
2960
+
2961
+ Properties of the `inputConfiguration` object:
2962
+
2963
+ ##### `math` (object)
2964
+
2965
+ Properties of the `math` object:
2966
+
2967
+ ###### `disabled` (boolean)
2968
+
2969
+ Indicates if the plugin is disabled or not
2970
+
2971
+ ##### `audio` (object)
2972
+
2973
+ Properties of the `audio` object:
2974
+
2975
+ ###### `disabled` (boolean)
2976
+
2977
+ Indicates if the plugin is disabled or not
2978
+
2979
+ ##### `video` (object)
2980
+
2981
+ Properties of the `video` object:
2982
+
2983
+ ###### `disabled` (boolean)
2984
+
2985
+ Indicates if the plugin is disabled or not
2986
+
2987
+ ##### `image` (object)
2988
+
2989
+ Properties of the `image` object:
2990
+
2991
+ ###### `disabled` (boolean)
2992
+
2993
+ Indicates if the plugin is disabled or not
2994
+
2995
+ ##### `customPlugins` (array)
2996
+
2997
+ An array of objects that determine custom plugins.
2998
+ 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).
2999
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
3000
+
3001
+ The object is an array with all elements of the type `object`.
3002
+
3003
+ The array object has the following properties:
3004
+
3005
+ ###### `event` (string, required)
3006
+
3007
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
3008
+ PIE will emit the event prefixed with "PIE-".
3009
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
3010
+
3011
+ ###### `iconAlt` (string, required)
3012
+
3013
+ The alt for the custom button icon
3014
+
3015
+ ###### `iconType` (string, required)
3016
+
3017
+ The icon type.
3018
+ Currently, only "SVG" is supported.
3019
+
3020
+ ###### `icon` (string, required)
3021
+
3022
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
3023
+
3024
+ ##### `blockquote` (object)
3025
+
3026
+ Properties of the `blockquote` object:
3027
+
3028
+ ###### `disabled` (boolean)
3029
+
3030
+ Indicates if the plugin is disabled or not
3031
+
3032
+ ##### `h3` (object)
3033
+
3034
+ Properties of the `h3` object:
3035
+
3036
+ ###### `disabled` (boolean)
3037
+
3038
+ Indicates if the plugin is disabled or not
3039
+
3040
+ ##### `languageCharacters` (object)
3041
+
3042
+ Properties of the `languageCharacters` object:
3043
+
3044
+ ###### `disabled` (boolean)
3045
+
3046
+ Indicates if the plugin is disabled or not
3047
+
3048
+ ##### `bold` (object)
3049
+
3050
+ Properties of the `bold` object:
3051
+
3052
+ ###### `disabled` (boolean)
3053
+
3054
+ Indicates if the plugin is disabled or not
3055
+
3056
+ ##### `html` (object)
3057
+
3058
+ Properties of the `html` object:
3059
+
3060
+ ###### `disabled` (boolean)
3061
+
3062
+ Indicates if the plugin is disabled or not
3063
+
3064
+ ##### `italic` (object)
3065
+
3066
+ Properties of the `italic` object:
3067
+
3068
+ ###### `disabled` (boolean)
3069
+
3070
+ Indicates if the plugin is disabled or not
3071
+
3072
+ ##### `ol_list` (object)
3073
+
3074
+ Properties of the `ol_list` object:
3075
+
3076
+ ###### `disabled` (boolean)
3077
+
3078
+ Indicates if the plugin is disabled or not
3079
+
3080
+ ##### `redo` (object)
3081
+
3082
+ Properties of the `redo` object:
3083
+
3084
+ ###### `disabled` (boolean)
3085
+
3086
+ Indicates if the plugin is disabled or not
3087
+
3088
+ ##### `strikethrough` (object)
3089
+
3090
+ Properties of the `strikethrough` object:
3091
+
3092
+ ###### `disabled` (boolean)
3093
+
3094
+ Indicates if the plugin is disabled or not
3095
+
3096
+ ##### `sub` (object)
3097
+
3098
+ Properties of the `sub` object:
3099
+
3100
+ ###### `disabled` (boolean)
3101
+
3102
+ Indicates if the plugin is disabled or not
3103
+
3104
+ ##### `sup` (object)
3105
+
3106
+ Properties of the `sup` object:
3107
+
3108
+ ###### `disabled` (boolean)
3109
+
3110
+ Indicates if the plugin is disabled or not
3111
+
3112
+ ##### `table` (object)
3113
+
3114
+ Properties of the `table` object:
3115
+
3116
+ ###### `disabled` (boolean)
3117
+
3118
+ Indicates if the plugin is disabled or not
3119
+
3120
+ ##### `ul_list` (object)
3121
+
3122
+ Properties of the `ul_list` object:
3123
+
3124
+ ###### `disabled` (boolean)
3125
+
3126
+ Indicates if the plugin is disabled or not
3127
+
3128
+ ##### `underline` (object)
3129
+
3130
+ Properties of the `underline` object:
3131
+
3132
+ ###### `disabled` (boolean)
3133
+
3134
+ Indicates if the plugin is disabled or not
3135
+
3136
+ ##### `undo` (object)
3137
+
3138
+ Properties of the `undo` object:
3139
+
3140
+ ###### `disabled` (boolean)
3141
+
3142
+ Indicates if the plugin is disabled or not
3143
+
3144
+ #### `required` (boolean)
3145
+
3146
+ Indicates if the item is required and the value cannot be empty
3147
+
3148
+ #### `settings` (boolean)
3149
+
3150
+ Indicates if the item has to be displayed in the Settings Panel
3151
+
3152
+ #### `label` (string)
3153
+
3154
+ Indicates the label for the item that has to be displayed in the Settings Panel
3155
+
3156
+ ### `choicesLayout` (object)
3157
+
3158
+ Properties of the `choicesLayout` object:
3159
+
3160
+ #### `settings` (boolean)
3161
+
3162
+ Indicates if the item has to be displayed in the Settings Panel
3163
+
3164
+ #### `label` (string)
3165
+
3166
+ Indicates the label for the item that has to be displayed in the Settings Panel
3167
+
3168
+ ### `gridColumns` (object)
3169
+
3170
+ Properties of the `gridColumns` object:
1476
3171
 
1477
3172
  #### `settings` (boolean)
1478
3173
 
1479
- Indicates if the item has to be displayed in the Settings Panel
3174
+ Indicates if the item has to be displayed in the Settings Panel
3175
+
3176
+ #### `label` (string)
3177
+
3178
+ Indicates the label for the item that has to be displayed in the Settings Panel
3179
+
3180
+ ### `minAnswerChoices` (number)
3181
+
3182
+ Minimum number of answer choices
3183
+
3184
+ ### `maxAnswerChoices` (number)
3185
+
3186
+ Maximum number of answer choices
3187
+
3188
+ ### `maxImageWidth` (object)
3189
+
3190
+ Properties of the `maxImageWidth` object:
3191
+
3192
+ #### `teacherInstructions` (number)
3193
+
3194
+ Indicates the max dimension for images in teacher instructions
3195
+
3196
+ #### `prompt` (number)
3197
+
3198
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
3199
+
3200
+ #### `rationale` (number)
3201
+
3202
+ Indicates the max dimension for images in rationale
3203
+
3204
+ #### `choices` (number)
3205
+
3206
+ Indicates the max dimension for images in choices
3207
+
3208
+ ### `maxImageHeight` (object)
3209
+
3210
+ Properties of the `maxImageHeight` object:
3211
+
3212
+ #### `teacherInstructions` (number)
3213
+
3214
+ Indicates the max dimension for images in teacher instructions
3215
+
3216
+ #### `prompt` (number)
3217
+
3218
+ Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
3219
+
3220
+ #### `rationale` (number)
3221
+
3222
+ Indicates the max dimension for images in rationale
3223
+
3224
+ #### `choices` (number)
3225
+
3226
+ Indicates the max dimension for images in choices
3227
+
3228
+ ### `mathMlOptions` (object)
3229
+
3230
+ Properties of the `mathMlOptions` object:
1480
3231
 
1481
- #### `label` (string)
3232
+ #### `mmlOutput` (number)
1482
3233
 
1483
- Indicates the label for the item that has to be displayed in the Settings Panel
3234
+ Indicates if model should have mathML output instead of latex
1484
3235
 
1485
- ### `prompt` (object)
3236
+ #### `mmlEditing` (number)
1486
3237
 
1487
- Properties of the `prompt` object:
3238
+ Indicates if mathML that's already in model should be editable
1488
3239
 
1489
- #### `inputConfiguration` (object)
3240
+ ### `baseInputConfiguration` (object)
1490
3241
 
1491
- Properties of the `inputConfiguration` object:
3242
+ Properties of the `baseInputConfiguration` object:
1492
3243
 
1493
- ##### `math` (object)
3244
+ #### `math` (object)
1494
3245
 
1495
3246
  Properties of the `math` object:
1496
3247
 
1497
- ###### `disabled` (boolean)
3248
+ ##### `disabled` (boolean)
1498
3249
 
1499
3250
  Indicates if the plugin is disabled or not
1500
3251
 
1501
- ##### `audio` (object)
3252
+ #### `audio` (object)
1502
3253
 
1503
3254
  Properties of the `audio` object:
1504
3255
 
1505
- ###### `disabled` (boolean)
3256
+ ##### `disabled` (boolean)
1506
3257
 
1507
3258
  Indicates if the plugin is disabled or not
1508
3259
 
1509
- ##### `video` (object)
3260
+ #### `video` (object)
1510
3261
 
1511
3262
  Properties of the `video` object:
1512
3263
 
1513
- ###### `disabled` (boolean)
3264
+ ##### `disabled` (boolean)
1514
3265
 
1515
3266
  Indicates if the plugin is disabled or not
1516
3267
 
1517
- ##### `image` (object)
3268
+ #### `image` (object)
1518
3269
 
1519
3270
  Properties of the `image` object:
1520
3271
 
1521
- ###### `disabled` (boolean)
3272
+ ##### `disabled` (boolean)
1522
3273
 
1523
3274
  Indicates if the plugin is disabled or not
1524
3275
 
1525
- ##### `customPlugins` (array)
3276
+ #### `customPlugins` (array)
1526
3277
 
1527
3278
  An array of objects that determine custom plugins.
1528
3279
  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).
@@ -1532,181 +3283,148 @@ The object is an array with all elements of the type `object`.
1532
3283
 
1533
3284
  The array object has the following properties:
1534
3285
 
1535
- ###### `event` (string, required)
3286
+ ##### `event` (string, required)
1536
3287
 
1537
3288
  The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1538
3289
  PIE will emit the event prefixed with "PIE-".
1539
3290
  Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1540
3291
 
1541
- ###### `iconAlt` (string, required)
3292
+ ##### `iconAlt` (string, required)
1542
3293
 
1543
3294
  The alt for the custom button icon
1544
3295
 
1545
- ###### `iconType` (string, required)
3296
+ ##### `iconType` (string, required)
1546
3297
 
1547
3298
  The icon type.
1548
3299
  Currently, only "SVG" is supported.
1549
3300
 
1550
- ###### `icon` (string, required)
3301
+ ##### `icon` (string, required)
1551
3302
 
1552
3303
  The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1553
3304
 
1554
- ##### `blockquote` (object)
3305
+ #### `blockquote` (object)
1555
3306
 
1556
3307
  Properties of the `blockquote` object:
1557
3308
 
1558
- ###### `disabled` (boolean)
3309
+ ##### `disabled` (boolean)
1559
3310
 
1560
3311
  Indicates if the plugin is disabled or not
1561
3312
 
1562
- ##### `h3` (object)
3313
+ #### `h3` (object)
1563
3314
 
1564
3315
  Properties of the `h3` object:
1565
3316
 
1566
- ###### `disabled` (boolean)
3317
+ ##### `disabled` (boolean)
1567
3318
 
1568
3319
  Indicates if the plugin is disabled or not
1569
3320
 
1570
- #### `required` (boolean)
1571
-
1572
- Indicates if the item is required and the value cannot be empty
1573
-
1574
- #### `settings` (boolean)
1575
-
1576
- Indicates if the item has to be displayed in the Settings Panel
1577
-
1578
- #### `label` (string)
1579
-
1580
- Indicates the label for the item that has to be displayed in the Settings Panel
1581
-
1582
- ### `settingsPanelDisabled` (boolean)
1583
-
1584
- Indicates if the settings panel is not available
1585
-
1586
- ### `spellCheck` (object)
1587
-
1588
- Properties of the `spellCheck` object:
1589
-
1590
- #### `settings` (boolean)
1591
-
1592
- Indicates if the item has to be displayed in the Settings Panel
1593
-
1594
- #### `label` (string)
1595
-
1596
- Indicates the label for the item that has to be displayed in the Settings Panel
1597
-
1598
- ### `rationale` (object)
3321
+ #### `languageCharacters` (object)
1599
3322
 
1600
- Properties of the `rationale` object:
3323
+ Properties of the `languageCharacters` object:
1601
3324
 
1602
- #### `inputConfiguration` (object)
3325
+ ##### `disabled` (boolean)
1603
3326
 
1604
- Properties of the `inputConfiguration` object:
3327
+ Indicates if the plugin is disabled or not
1605
3328
 
1606
- ##### `math` (object)
3329
+ #### `bold` (object)
1607
3330
 
1608
- Properties of the `math` object:
3331
+ Properties of the `bold` object:
1609
3332
 
1610
- ###### `disabled` (boolean)
3333
+ ##### `disabled` (boolean)
1611
3334
 
1612
3335
  Indicates if the plugin is disabled or not
1613
3336
 
1614
- ##### `audio` (object)
3337
+ #### `html` (object)
1615
3338
 
1616
- Properties of the `audio` object:
3339
+ Properties of the `html` object:
1617
3340
 
1618
- ###### `disabled` (boolean)
3341
+ ##### `disabled` (boolean)
1619
3342
 
1620
3343
  Indicates if the plugin is disabled or not
1621
3344
 
1622
- ##### `video` (object)
3345
+ #### `italic` (object)
1623
3346
 
1624
- Properties of the `video` object:
3347
+ Properties of the `italic` object:
1625
3348
 
1626
- ###### `disabled` (boolean)
3349
+ ##### `disabled` (boolean)
1627
3350
 
1628
3351
  Indicates if the plugin is disabled or not
1629
3352
 
1630
- ##### `image` (object)
3353
+ #### `ol_list` (object)
1631
3354
 
1632
- Properties of the `image` object:
3355
+ Properties of the `ol_list` object:
1633
3356
 
1634
- ###### `disabled` (boolean)
3357
+ ##### `disabled` (boolean)
1635
3358
 
1636
3359
  Indicates if the plugin is disabled or not
1637
3360
 
1638
- ##### `customPlugins` (array)
3361
+ #### `redo` (object)
1639
3362
 
1640
- An array of objects that determine custom plugins.
1641
- 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).
1642
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
3363
+ Properties of the `redo` object:
1643
3364
 
1644
- The object is an array with all elements of the type `object`.
3365
+ ##### `disabled` (boolean)
1645
3366
 
1646
- The array object has the following properties:
3367
+ Indicates if the plugin is disabled or not
1647
3368
 
1648
- ###### `event` (string, required)
3369
+ #### `strikethrough` (object)
1649
3370
 
1650
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1651
- PIE will emit the event prefixed with "PIE-".
1652
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
3371
+ Properties of the `strikethrough` object:
1653
3372
 
1654
- ###### `iconAlt` (string, required)
3373
+ ##### `disabled` (boolean)
1655
3374
 
1656
- The alt for the custom button icon
3375
+ Indicates if the plugin is disabled or not
1657
3376
 
1658
- ###### `iconType` (string, required)
3377
+ #### `sub` (object)
1659
3378
 
1660
- The icon type.
1661
- Currently, only "SVG" is supported.
3379
+ Properties of the `sub` object:
1662
3380
 
1663
- ###### `icon` (string, required)
3381
+ ##### `disabled` (boolean)
1664
3382
 
1665
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
3383
+ Indicates if the plugin is disabled or not
1666
3384
 
1667
- ##### `blockquote` (object)
3385
+ #### `sup` (object)
1668
3386
 
1669
- Properties of the `blockquote` object:
3387
+ Properties of the `sup` object:
1670
3388
 
1671
- ###### `disabled` (boolean)
3389
+ ##### `disabled` (boolean)
1672
3390
 
1673
3391
  Indicates if the plugin is disabled or not
1674
3392
 
1675
- ##### `h3` (object)
3393
+ #### `table` (object)
1676
3394
 
1677
- Properties of the `h3` object:
3395
+ Properties of the `table` object:
1678
3396
 
1679
- ###### `disabled` (boolean)
3397
+ ##### `disabled` (boolean)
1680
3398
 
1681
3399
  Indicates if the plugin is disabled or not
1682
3400
 
1683
- #### `required` (boolean)
3401
+ #### `ul_list` (object)
1684
3402
 
1685
- Indicates if the item is required and the value cannot be empty
3403
+ Properties of the `ul_list` object:
1686
3404
 
1687
- #### `settings` (boolean)
3405
+ ##### `disabled` (boolean)
1688
3406
 
1689
- Indicates if the item has to be displayed in the Settings Panel
3407
+ Indicates if the plugin is disabled or not
1690
3408
 
1691
- #### `label` (string)
3409
+ #### `underline` (object)
1692
3410
 
1693
- Indicates the label for the item that has to be displayed in the Settings Panel
3411
+ Properties of the `underline` object:
1694
3412
 
1695
- ### `studentInstructions` (object)
3413
+ ##### `disabled` (boolean)
1696
3414
 
1697
- Properties of the `studentInstructions` object:
3415
+ Indicates if the plugin is disabled or not
1698
3416
 
1699
- #### `settings` (boolean)
3417
+ #### `undo` (object)
1700
3418
 
1701
- Indicates if the item has to be displayed in the Settings Panel
3419
+ Properties of the `undo` object:
1702
3420
 
1703
- #### `label` (string)
3421
+ ##### `disabled` (boolean)
1704
3422
 
1705
- Indicates the label for the item that has to be displayed in the Settings Panel
3423
+ Indicates if the plugin is disabled or not
1706
3424
 
1707
- ### `teacherInstructions` (object)
3425
+ ### `choices` (object)
1708
3426
 
1709
- Properties of the `teacherInstructions` object:
3427
+ Properties of the `choices` object:
1710
3428
 
1711
3429
  #### `inputConfiguration` (object)
1712
3430
 
@@ -1789,105 +3507,137 @@ Properties of the `h3` object:
1789
3507
 
1790
3508
  Indicates if the plugin is disabled or not
1791
3509
 
1792
- #### `required` (boolean)
3510
+ ##### `languageCharacters` (object)
1793
3511
 
1794
- Indicates if the item is required and the value cannot be empty
3512
+ Properties of the `languageCharacters` object:
1795
3513
 
1796
- #### `settings` (boolean)
3514
+ ###### `disabled` (boolean)
1797
3515
 
1798
- Indicates if the item has to be displayed in the Settings Panel
3516
+ Indicates if the plugin is disabled or not
1799
3517
 
1800
- #### `label` (string)
3518
+ ##### `bold` (object)
1801
3519
 
1802
- Indicates the label for the item that has to be displayed in the Settings Panel
3520
+ Properties of the `bold` object:
1803
3521
 
1804
- ### `choicesLayout` (object)
3522
+ ###### `disabled` (boolean)
1805
3523
 
1806
- Properties of the `choicesLayout` object:
3524
+ Indicates if the plugin is disabled or not
1807
3525
 
1808
- #### `settings` (boolean)
3526
+ ##### `html` (object)
1809
3527
 
1810
- Indicates if the item has to be displayed in the Settings Panel
3528
+ Properties of the `html` object:
1811
3529
 
1812
- #### `label` (string)
3530
+ ###### `disabled` (boolean)
1813
3531
 
1814
- Indicates the label for the item that has to be displayed in the Settings Panel
3532
+ Indicates if the plugin is disabled or not
1815
3533
 
1816
- ### `gridColumns` (object)
3534
+ ##### `italic` (object)
1817
3535
 
1818
- Properties of the `gridColumns` object:
3536
+ Properties of the `italic` object:
1819
3537
 
1820
- #### `settings` (boolean)
3538
+ ###### `disabled` (boolean)
1821
3539
 
1822
- Indicates if the item has to be displayed in the Settings Panel
3540
+ Indicates if the plugin is disabled or not
1823
3541
 
1824
- #### `label` (string)
3542
+ ##### `ol_list` (object)
1825
3543
 
1826
- Indicates the label for the item that has to be displayed in the Settings Panel
3544
+ Properties of the `ol_list` object:
1827
3545
 
1828
- ### `minAnswerChoices` (number)
3546
+ ###### `disabled` (boolean)
1829
3547
 
1830
- Minimum number of answer choices
3548
+ Indicates if the plugin is disabled or not
1831
3549
 
1832
- ### `maxAnswerChoices` (number)
3550
+ ##### `redo` (object)
1833
3551
 
1834
- Maximum number of answer choices
3552
+ Properties of the `redo` object:
1835
3553
 
1836
- ### `maxImageWidth` (object)
3554
+ ###### `disabled` (boolean)
1837
3555
 
1838
- Properties of the `maxImageWidth` object:
3556
+ Indicates if the plugin is disabled or not
1839
3557
 
1840
- #### `teacherInstructions` (number)
3558
+ ##### `strikethrough` (object)
1841
3559
 
1842
- Indicates the max dimension for images in teacher instructions
3560
+ Properties of the `strikethrough` object:
1843
3561
 
1844
- #### `prompt` (number)
3562
+ ###### `disabled` (boolean)
1845
3563
 
1846
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
3564
+ Indicates if the plugin is disabled or not
1847
3565
 
1848
- #### `rationale` (number)
3566
+ ##### `sub` (object)
1849
3567
 
1850
- Indicates the max dimension for images in rationale
3568
+ Properties of the `sub` object:
1851
3569
 
1852
- #### `choices` (number)
3570
+ ###### `disabled` (boolean)
1853
3571
 
1854
- Indicates the max dimension for images in choices
3572
+ Indicates if the plugin is disabled or not
1855
3573
 
1856
- ### `maxImageHeight` (object)
3574
+ ##### `sup` (object)
1857
3575
 
1858
- Properties of the `maxImageHeight` object:
3576
+ Properties of the `sup` object:
1859
3577
 
1860
- #### `teacherInstructions` (number)
3578
+ ###### `disabled` (boolean)
1861
3579
 
1862
- Indicates the max dimension for images in teacher instructions
3580
+ Indicates if the plugin is disabled or not
1863
3581
 
1864
- #### `prompt` (number)
3582
+ ##### `table` (object)
1865
3583
 
1866
- Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
3584
+ Properties of the `table` object:
1867
3585
 
1868
- #### `rationale` (number)
3586
+ ###### `disabled` (boolean)
1869
3587
 
1870
- Indicates the max dimension for images in rationale
3588
+ Indicates if the plugin is disabled or not
1871
3589
 
1872
- #### `choices` (number)
3590
+ ##### `ul_list` (object)
1873
3591
 
1874
- Indicates the max dimension for images in choices
3592
+ Properties of the `ul_list` object:
1875
3593
 
1876
- ### `mathMlOptions` (object)
3594
+ ###### `disabled` (boolean)
1877
3595
 
1878
- Properties of the `mathMlOptions` object:
3596
+ Indicates if the plugin is disabled or not
1879
3597
 
1880
- #### `mmlOutput` (number)
3598
+ ##### `underline` (object)
1881
3599
 
1882
- Indicates if model should have mathML output instead of latex
3600
+ Properties of the `underline` object:
1883
3601
 
1884
- #### `mmlEditing` (number)
3602
+ ###### `disabled` (boolean)
1885
3603
 
1886
- Indicates if mathML that's already in model should be editable
3604
+ Indicates if the plugin is disabled or not
1887
3605
 
1888
- ### `baseInputConfiguration` (object)
3606
+ ##### `undo` (object)
3607
+
3608
+ Properties of the `undo` object:
3609
+
3610
+ ###### `disabled` (boolean)
3611
+
3612
+ Indicates if the plugin is disabled or not
3613
+
3614
+ #### `settings` (boolean)
3615
+
3616
+ Indicates if the item has to be displayed in the Settings Panel
3617
+
3618
+ #### `label` (string)
3619
+
3620
+ Indicates the label for the item that has to be displayed in the Settings Panel
3621
+
3622
+ ## `ConfigureProp` (object)
3623
+
3624
+ Properties of the `ConfigureProp` object:
3625
+
3626
+ ### `settings` (boolean)
3627
+
3628
+ Indicates if the item has to be displayed in the Settings Panel
3629
+
3630
+ ### `label` (string)
3631
+
3632
+ Indicates the label for the item that has to be displayed in the Settings Panel
3633
+
3634
+ ## `EditableHtmlPluginConfigureRequired` (object)
3635
+
3636
+ Properties of the `EditableHtmlPluginConfigureRequired` object:
3637
+
3638
+ ### `inputConfiguration` (object)
1889
3639
 
1890
- Properties of the `baseInputConfiguration` object:
3640
+ Properties of the `inputConfiguration` object:
1891
3641
 
1892
3642
  #### `math` (object)
1893
3643
 
@@ -1966,102 +3716,113 @@ Properties of the `h3` object:
1966
3716
 
1967
3717
  Indicates if the plugin is disabled or not
1968
3718
 
1969
- ### `choices` (object)
3719
+ #### `languageCharacters` (object)
1970
3720
 
1971
- Properties of the `choices` object:
3721
+ Properties of the `languageCharacters` object:
1972
3722
 
1973
- #### `inputConfiguration` (object)
3723
+ ##### `disabled` (boolean)
1974
3724
 
1975
- Properties of the `inputConfiguration` object:
3725
+ Indicates if the plugin is disabled or not
1976
3726
 
1977
- ##### `math` (object)
3727
+ #### `bold` (object)
1978
3728
 
1979
- Properties of the `math` object:
3729
+ Properties of the `bold` object:
1980
3730
 
1981
- ###### `disabled` (boolean)
3731
+ ##### `disabled` (boolean)
1982
3732
 
1983
3733
  Indicates if the plugin is disabled or not
1984
3734
 
1985
- ##### `audio` (object)
3735
+ #### `html` (object)
1986
3736
 
1987
- Properties of the `audio` object:
3737
+ Properties of the `html` object:
1988
3738
 
1989
- ###### `disabled` (boolean)
3739
+ ##### `disabled` (boolean)
1990
3740
 
1991
3741
  Indicates if the plugin is disabled or not
1992
3742
 
1993
- ##### `video` (object)
3743
+ #### `italic` (object)
1994
3744
 
1995
- Properties of the `video` object:
3745
+ Properties of the `italic` object:
1996
3746
 
1997
- ###### `disabled` (boolean)
3747
+ ##### `disabled` (boolean)
1998
3748
 
1999
3749
  Indicates if the plugin is disabled or not
2000
3750
 
2001
- ##### `image` (object)
3751
+ #### `ol_list` (object)
2002
3752
 
2003
- Properties of the `image` object:
3753
+ Properties of the `ol_list` object:
2004
3754
 
2005
- ###### `disabled` (boolean)
3755
+ ##### `disabled` (boolean)
2006
3756
 
2007
3757
  Indicates if the plugin is disabled or not
2008
3758
 
2009
- ##### `customPlugins` (array)
3759
+ #### `redo` (object)
2010
3760
 
2011
- An array of objects that determine custom plugins.
2012
- 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).
2013
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
3761
+ Properties of the `redo` object:
2014
3762
 
2015
- The object is an array with all elements of the type `object`.
3763
+ ##### `disabled` (boolean)
2016
3764
 
2017
- The array object has the following properties:
3765
+ Indicates if the plugin is disabled or not
2018
3766
 
2019
- ###### `event` (string, required)
3767
+ #### `strikethrough` (object)
2020
3768
 
2021
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2022
- PIE will emit the event prefixed with "PIE-".
2023
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
3769
+ Properties of the `strikethrough` object:
2024
3770
 
2025
- ###### `iconAlt` (string, required)
3771
+ ##### `disabled` (boolean)
2026
3772
 
2027
- The alt for the custom button icon
3773
+ Indicates if the plugin is disabled or not
2028
3774
 
2029
- ###### `iconType` (string, required)
3775
+ #### `sub` (object)
2030
3776
 
2031
- The icon type.
2032
- Currently, only "SVG" is supported.
3777
+ Properties of the `sub` object:
2033
3778
 
2034
- ###### `icon` (string, required)
3779
+ ##### `disabled` (boolean)
2035
3780
 
2036
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
3781
+ Indicates if the plugin is disabled or not
2037
3782
 
2038
- ##### `blockquote` (object)
3783
+ #### `sup` (object)
2039
3784
 
2040
- Properties of the `blockquote` object:
3785
+ Properties of the `sup` object:
2041
3786
 
2042
- ###### `disabled` (boolean)
3787
+ ##### `disabled` (boolean)
2043
3788
 
2044
3789
  Indicates if the plugin is disabled or not
2045
3790
 
2046
- ##### `h3` (object)
3791
+ #### `table` (object)
2047
3792
 
2048
- Properties of the `h3` object:
3793
+ Properties of the `table` object:
2049
3794
 
2050
- ###### `disabled` (boolean)
3795
+ ##### `disabled` (boolean)
2051
3796
 
2052
3797
  Indicates if the plugin is disabled or not
2053
3798
 
2054
- #### `settings` (boolean)
3799
+ #### `ul_list` (object)
2055
3800
 
2056
- Indicates if the item has to be displayed in the Settings Panel
3801
+ Properties of the `ul_list` object:
2057
3802
 
2058
- #### `label` (string)
3803
+ ##### `disabled` (boolean)
2059
3804
 
2060
- Indicates the label for the item that has to be displayed in the Settings Panel
3805
+ Indicates if the plugin is disabled or not
2061
3806
 
2062
- ## `ConfigureProp` (object)
3807
+ #### `underline` (object)
2063
3808
 
2064
- Properties of the `ConfigureProp` object:
3809
+ Properties of the `underline` object:
3810
+
3811
+ ##### `disabled` (boolean)
3812
+
3813
+ Indicates if the plugin is disabled or not
3814
+
3815
+ #### `undo` (object)
3816
+
3817
+ Properties of the `undo` object:
3818
+
3819
+ ##### `disabled` (boolean)
3820
+
3821
+ Indicates if the plugin is disabled or not
3822
+
3823
+ ### `required` (boolean)
3824
+
3825
+ Indicates if the item is required and the value cannot be empty
2065
3826
 
2066
3827
  ### `settings` (boolean)
2067
3828
 
@@ -2071,47 +3832,43 @@ Indicates if the item has to be displayed in the Settings Panel
2071
3832
 
2072
3833
  Indicates the label for the item that has to be displayed in the Settings Panel
2073
3834
 
2074
- ## `EditableHtmlPluginConfigureRequired` (object)
2075
-
2076
- Properties of the `EditableHtmlPluginConfigureRequired` object:
2077
-
2078
- ### `inputConfiguration` (object)
3835
+ ## `EditableHtmlConfigureProp` (object)
2079
3836
 
2080
- Properties of the `inputConfiguration` object:
3837
+ Properties of the `EditableHtmlConfigureProp` object:
2081
3838
 
2082
- #### `math` (object)
3839
+ ### `math` (object)
2083
3840
 
2084
3841
  Properties of the `math` object:
2085
3842
 
2086
- ##### `disabled` (boolean)
3843
+ #### `disabled` (boolean)
2087
3844
 
2088
3845
  Indicates if the plugin is disabled or not
2089
3846
 
2090
- #### `audio` (object)
3847
+ ### `audio` (object)
2091
3848
 
2092
3849
  Properties of the `audio` object:
2093
3850
 
2094
- ##### `disabled` (boolean)
3851
+ #### `disabled` (boolean)
2095
3852
 
2096
3853
  Indicates if the plugin is disabled or not
2097
3854
 
2098
- #### `video` (object)
3855
+ ### `video` (object)
2099
3856
 
2100
3857
  Properties of the `video` object:
2101
3858
 
2102
- ##### `disabled` (boolean)
3859
+ #### `disabled` (boolean)
2103
3860
 
2104
3861
  Indicates if the plugin is disabled or not
2105
3862
 
2106
- #### `image` (object)
3863
+ ### `image` (object)
2107
3864
 
2108
3865
  Properties of the `image` object:
2109
3866
 
2110
- ##### `disabled` (boolean)
3867
+ #### `disabled` (boolean)
2111
3868
 
2112
3869
  Indicates if the plugin is disabled or not
2113
3870
 
2114
- #### `customPlugins` (array)
3871
+ ### `customPlugins` (array)
2115
3872
 
2116
3873
  An array of objects that determine custom plugins.
2117
3874
  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).
@@ -2121,129 +3878,140 @@ The object is an array with all elements of the type `object`.
2121
3878
 
2122
3879
  The array object has the following properties:
2123
3880
 
2124
- ##### `event` (string, required)
3881
+ #### `event` (string, required)
2125
3882
 
2126
3883
  The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2127
3884
  PIE will emit the event prefixed with "PIE-".
2128
3885
  Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2129
3886
 
2130
- ##### `iconAlt` (string, required)
3887
+ #### `iconAlt` (string, required)
2131
3888
 
2132
3889
  The alt for the custom button icon
2133
3890
 
2134
- ##### `iconType` (string, required)
3891
+ #### `iconType` (string, required)
2135
3892
 
2136
3893
  The icon type.
2137
3894
  Currently, only "SVG" is supported.
2138
3895
 
2139
- ##### `icon` (string, required)
3896
+ #### `icon` (string, required)
2140
3897
 
2141
3898
  The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2142
3899
 
2143
- #### `blockquote` (object)
3900
+ ### `blockquote` (object)
2144
3901
 
2145
3902
  Properties of the `blockquote` object:
2146
3903
 
2147
- ##### `disabled` (boolean)
3904
+ #### `disabled` (boolean)
2148
3905
 
2149
3906
  Indicates if the plugin is disabled or not
2150
3907
 
2151
- #### `h3` (object)
3908
+ ### `h3` (object)
2152
3909
 
2153
3910
  Properties of the `h3` object:
2154
3911
 
2155
- ##### `disabled` (boolean)
3912
+ #### `disabled` (boolean)
2156
3913
 
2157
3914
  Indicates if the plugin is disabled or not
2158
3915
 
2159
- ### `required` (boolean)
3916
+ ### `languageCharacters` (object)
2160
3917
 
2161
- Indicates if the item is required and the value cannot be empty
3918
+ Properties of the `languageCharacters` object:
2162
3919
 
2163
- ### `settings` (boolean)
3920
+ #### `disabled` (boolean)
2164
3921
 
2165
- Indicates if the item has to be displayed in the Settings Panel
3922
+ Indicates if the plugin is disabled or not
2166
3923
 
2167
- ### `label` (string)
3924
+ ### `bold` (object)
2168
3925
 
2169
- Indicates the label for the item that has to be displayed in the Settings Panel
3926
+ Properties of the `bold` object:
2170
3927
 
2171
- ## `EditableHtmlConfigureProp` (object)
3928
+ #### `disabled` (boolean)
2172
3929
 
2173
- Properties of the `EditableHtmlConfigureProp` object:
3930
+ Indicates if the plugin is disabled or not
2174
3931
 
2175
- ### `math` (object)
3932
+ ### `html` (object)
2176
3933
 
2177
- Properties of the `math` object:
3934
+ Properties of the `html` object:
2178
3935
 
2179
3936
  #### `disabled` (boolean)
2180
3937
 
2181
3938
  Indicates if the plugin is disabled or not
2182
3939
 
2183
- ### `audio` (object)
3940
+ ### `italic` (object)
2184
3941
 
2185
- Properties of the `audio` object:
3942
+ Properties of the `italic` object:
2186
3943
 
2187
3944
  #### `disabled` (boolean)
2188
3945
 
2189
3946
  Indicates if the plugin is disabled or not
2190
3947
 
2191
- ### `video` (object)
3948
+ ### `ol_list` (object)
2192
3949
 
2193
- Properties of the `video` object:
3950
+ Properties of the `ol_list` object:
2194
3951
 
2195
3952
  #### `disabled` (boolean)
2196
3953
 
2197
3954
  Indicates if the plugin is disabled or not
2198
3955
 
2199
- ### `image` (object)
3956
+ ### `redo` (object)
2200
3957
 
2201
- Properties of the `image` object:
3958
+ Properties of the `redo` object:
2202
3959
 
2203
3960
  #### `disabled` (boolean)
2204
3961
 
2205
3962
  Indicates if the plugin is disabled or not
2206
3963
 
2207
- ### `customPlugins` (array)
3964
+ ### `strikethrough` (object)
2208
3965
 
2209
- An array of objects that determine custom plugins.
2210
- 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).
2211
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
3966
+ Properties of the `strikethrough` object:
2212
3967
 
2213
- The object is an array with all elements of the type `object`.
3968
+ #### `disabled` (boolean)
2214
3969
 
2215
- The array object has the following properties:
3970
+ Indicates if the plugin is disabled or not
2216
3971
 
2217
- #### `event` (string, required)
3972
+ ### `sub` (object)
2218
3973
 
2219
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
2220
- PIE will emit the event prefixed with "PIE-".
2221
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
3974
+ Properties of the `sub` object:
2222
3975
 
2223
- #### `iconAlt` (string, required)
3976
+ #### `disabled` (boolean)
2224
3977
 
2225
- The alt for the custom button icon
3978
+ Indicates if the plugin is disabled or not
2226
3979
 
2227
- #### `iconType` (string, required)
3980
+ ### `sup` (object)
2228
3981
 
2229
- The icon type.
2230
- Currently, only "SVG" is supported.
3982
+ Properties of the `sup` object:
2231
3983
 
2232
- #### `icon` (string, required)
3984
+ #### `disabled` (boolean)
2233
3985
 
2234
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
3986
+ Indicates if the plugin is disabled or not
2235
3987
 
2236
- ### `blockquote` (object)
3988
+ ### `table` (object)
2237
3989
 
2238
- Properties of the `blockquote` object:
3990
+ Properties of the `table` object:
2239
3991
 
2240
3992
  #### `disabled` (boolean)
2241
3993
 
2242
3994
  Indicates if the plugin is disabled or not
2243
3995
 
2244
- ### `h3` (object)
3996
+ ### `ul_list` (object)
2245
3997
 
2246
- Properties of the `h3` object:
3998
+ Properties of the `ul_list` object:
3999
+
4000
+ #### `disabled` (boolean)
4001
+
4002
+ Indicates if the plugin is disabled or not
4003
+
4004
+ ### `underline` (object)
4005
+
4006
+ Properties of the `underline` object:
4007
+
4008
+ #### `disabled` (boolean)
4009
+
4010
+ Indicates if the plugin is disabled or not
4011
+
4012
+ ### `undo` (object)
4013
+
4014
+ Properties of the `undo` object:
2247
4015
 
2248
4016
  #### `disabled` (boolean)
2249
4017
 
@@ -2397,6 +4165,110 @@ Properties of the `h3` object:
2397
4165
 
2398
4166
  Indicates if the plugin is disabled or not
2399
4167
 
4168
+ #### `languageCharacters` (object)
4169
+
4170
+ Properties of the `languageCharacters` object:
4171
+
4172
+ ##### `disabled` (boolean)
4173
+
4174
+ Indicates if the plugin is disabled or not
4175
+
4176
+ #### `bold` (object)
4177
+
4178
+ Properties of the `bold` object:
4179
+
4180
+ ##### `disabled` (boolean)
4181
+
4182
+ Indicates if the plugin is disabled or not
4183
+
4184
+ #### `html` (object)
4185
+
4186
+ Properties of the `html` object:
4187
+
4188
+ ##### `disabled` (boolean)
4189
+
4190
+ Indicates if the plugin is disabled or not
4191
+
4192
+ #### `italic` (object)
4193
+
4194
+ Properties of the `italic` object:
4195
+
4196
+ ##### `disabled` (boolean)
4197
+
4198
+ Indicates if the plugin is disabled or not
4199
+
4200
+ #### `ol_list` (object)
4201
+
4202
+ Properties of the `ol_list` object:
4203
+
4204
+ ##### `disabled` (boolean)
4205
+
4206
+ Indicates if the plugin is disabled or not
4207
+
4208
+ #### `redo` (object)
4209
+
4210
+ Properties of the `redo` object:
4211
+
4212
+ ##### `disabled` (boolean)
4213
+
4214
+ Indicates if the plugin is disabled or not
4215
+
4216
+ #### `strikethrough` (object)
4217
+
4218
+ Properties of the `strikethrough` object:
4219
+
4220
+ ##### `disabled` (boolean)
4221
+
4222
+ Indicates if the plugin is disabled or not
4223
+
4224
+ #### `sub` (object)
4225
+
4226
+ Properties of the `sub` object:
4227
+
4228
+ ##### `disabled` (boolean)
4229
+
4230
+ Indicates if the plugin is disabled or not
4231
+
4232
+ #### `sup` (object)
4233
+
4234
+ Properties of the `sup` object:
4235
+
4236
+ ##### `disabled` (boolean)
4237
+
4238
+ Indicates if the plugin is disabled or not
4239
+
4240
+ #### `table` (object)
4241
+
4242
+ Properties of the `table` object:
4243
+
4244
+ ##### `disabled` (boolean)
4245
+
4246
+ Indicates if the plugin is disabled or not
4247
+
4248
+ #### `ul_list` (object)
4249
+
4250
+ Properties of the `ul_list` object:
4251
+
4252
+ ##### `disabled` (boolean)
4253
+
4254
+ Indicates if the plugin is disabled or not
4255
+
4256
+ #### `underline` (object)
4257
+
4258
+ Properties of the `underline` object:
4259
+
4260
+ ##### `disabled` (boolean)
4261
+
4262
+ Indicates if the plugin is disabled or not
4263
+
4264
+ #### `undo` (object)
4265
+
4266
+ Properties of the `undo` object:
4267
+
4268
+ ##### `disabled` (boolean)
4269
+
4270
+ Indicates if the plugin is disabled or not
4271
+
2400
4272
  ### `settings` (boolean)
2401
4273
 
2402
4274
  Indicates if the item has to be displayed in the Settings Panel