@pie-element/complex-rubric 2.19.3-next.9 → 2.19.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.
@@ -95,6 +95,110 @@ Properties of the `h3` object:
95
95
 
96
96
  Indicates if the plugin is disabled or not
97
97
 
98
+ ### `languageCharacters` (object)
99
+
100
+ Properties of the `languageCharacters` object:
101
+
102
+ #### `disabled` (boolean)
103
+
104
+ Indicates if the plugin is disabled or not
105
+
106
+ ### `bold` (object)
107
+
108
+ Properties of the `bold` object:
109
+
110
+ #### `disabled` (boolean)
111
+
112
+ Indicates if the plugin is disabled or not
113
+
114
+ ### `html` (object)
115
+
116
+ Properties of the `html` object:
117
+
118
+ #### `disabled` (boolean)
119
+
120
+ Indicates if the plugin is disabled or not
121
+
122
+ ### `italic` (object)
123
+
124
+ Properties of the `italic` object:
125
+
126
+ #### `disabled` (boolean)
127
+
128
+ Indicates if the plugin is disabled or not
129
+
130
+ ### `ol_list` (object)
131
+
132
+ Properties of the `ol_list` object:
133
+
134
+ #### `disabled` (boolean)
135
+
136
+ Indicates if the plugin is disabled or not
137
+
138
+ ### `redo` (object)
139
+
140
+ Properties of the `redo` object:
141
+
142
+ #### `disabled` (boolean)
143
+
144
+ Indicates if the plugin is disabled or not
145
+
146
+ ### `strikethrough` (object)
147
+
148
+ Properties of the `strikethrough` object:
149
+
150
+ #### `disabled` (boolean)
151
+
152
+ Indicates if the plugin is disabled or not
153
+
154
+ ### `sub` (object)
155
+
156
+ Properties of the `sub` object:
157
+
158
+ #### `disabled` (boolean)
159
+
160
+ Indicates if the plugin is disabled or not
161
+
162
+ ### `sup` (object)
163
+
164
+ Properties of the `sup` object:
165
+
166
+ #### `disabled` (boolean)
167
+
168
+ Indicates if the plugin is disabled or not
169
+
170
+ ### `table` (object)
171
+
172
+ Properties of the `table` object:
173
+
174
+ #### `disabled` (boolean)
175
+
176
+ Indicates if the plugin is disabled or not
177
+
178
+ ### `ul_list` (object)
179
+
180
+ Properties of the `ul_list` object:
181
+
182
+ #### `disabled` (boolean)
183
+
184
+ Indicates if the plugin is disabled or not
185
+
186
+ ### `underline` (object)
187
+
188
+ Properties of the `underline` object:
189
+
190
+ #### `disabled` (boolean)
191
+
192
+ Indicates if the plugin is disabled or not
193
+
194
+ ### `undo` (object)
195
+
196
+ Properties of the `undo` object:
197
+
198
+ #### `disabled` (boolean)
199
+
200
+ Indicates if the plugin is disabled or not
201
+
98
202
  ## `settingsPanelDisabled` (boolean)
99
203
 
100
204
  Indicates if the settings panel is not available
@@ -282,102 +386,113 @@ Properties of the `h3` object:
282
386
 
283
387
  Indicates if the plugin is disabled or not
284
388
 
285
- ## `expandedInput` (object)
389
+ ### `languageCharacters` (object)
286
390
 
287
- Properties of the `expandedInput` object:
391
+ Properties of the `languageCharacters` object:
288
392
 
289
- ### `inputConfiguration` (object)
393
+ #### `disabled` (boolean)
290
394
 
291
- Properties of the `inputConfiguration` object:
395
+ Indicates if the plugin is disabled or not
292
396
 
293
- #### `math` (object)
397
+ ### `bold` (object)
294
398
 
295
- Properties of the `math` object:
399
+ Properties of the `bold` object:
296
400
 
297
- ##### `disabled` (boolean)
401
+ #### `disabled` (boolean)
298
402
 
299
403
  Indicates if the plugin is disabled or not
300
404
 
301
- #### `audio` (object)
405
+ ### `html` (object)
302
406
 
303
- Properties of the `audio` object:
407
+ Properties of the `html` object:
304
408
 
305
- ##### `disabled` (boolean)
409
+ #### `disabled` (boolean)
306
410
 
307
411
  Indicates if the plugin is disabled or not
308
412
 
309
- #### `video` (object)
413
+ ### `italic` (object)
310
414
 
311
- Properties of the `video` object:
415
+ Properties of the `italic` object:
312
416
 
313
- ##### `disabled` (boolean)
417
+ #### `disabled` (boolean)
314
418
 
315
419
  Indicates if the plugin is disabled or not
316
420
 
317
- #### `image` (object)
421
+ ### `ol_list` (object)
318
422
 
319
- Properties of the `image` object:
423
+ Properties of the `ol_list` object:
320
424
 
321
- ##### `disabled` (boolean)
425
+ #### `disabled` (boolean)
322
426
 
323
427
  Indicates if the plugin is disabled or not
324
428
 
325
- #### `customPlugins` (array)
429
+ ### `redo` (object)
326
430
 
327
- An array of objects that determine custom plugins.
328
- 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).
329
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
431
+ Properties of the `redo` object:
330
432
 
331
- The object is an array with all elements of the type `object`.
433
+ #### `disabled` (boolean)
332
434
 
333
- The array object has the following properties:
435
+ Indicates if the plugin is disabled or not
334
436
 
335
- ##### `event` (string, required)
437
+ ### `strikethrough` (object)
336
438
 
337
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
338
- PIE will emit the event prefixed with "PIE-".
339
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
439
+ Properties of the `strikethrough` object:
340
440
 
341
- ##### `iconAlt` (string, required)
441
+ #### `disabled` (boolean)
342
442
 
343
- The alt for the custom button icon
443
+ Indicates if the plugin is disabled or not
344
444
 
345
- ##### `iconType` (string, required)
445
+ ### `sub` (object)
346
446
 
347
- The icon type.
348
- Currently, only "SVG" is supported.
447
+ Properties of the `sub` object:
349
448
 
350
- ##### `icon` (string, required)
449
+ #### `disabled` (boolean)
351
450
 
352
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
451
+ Indicates if the plugin is disabled or not
353
452
 
354
- #### `blockquote` (object)
453
+ ### `sup` (object)
355
454
 
356
- Properties of the `blockquote` object:
455
+ Properties of the `sup` object:
357
456
 
358
- ##### `disabled` (boolean)
457
+ #### `disabled` (boolean)
359
458
 
360
459
  Indicates if the plugin is disabled or not
361
460
 
362
- #### `h3` (object)
461
+ ### `table` (object)
363
462
 
364
- Properties of the `h3` object:
463
+ Properties of the `table` object:
365
464
 
366
- ##### `disabled` (boolean)
465
+ #### `disabled` (boolean)
367
466
 
368
467
  Indicates if the plugin is disabled or not
369
468
 
370
- ### `settings` (boolean)
469
+ ### `ul_list` (object)
371
470
 
372
- Indicates if the item has to be displayed in the Settings Panel
471
+ Properties of the `ul_list` object:
373
472
 
374
- ### `label` (string)
473
+ #### `disabled` (boolean)
375
474
 
376
- Indicates the label for the item that has to be displayed in the Settings Panel
475
+ Indicates if the plugin is disabled or not
377
476
 
378
- ## `labelInput` (object)
477
+ ### `underline` (object)
379
478
 
380
- Properties of the `labelInput` object:
479
+ Properties of the `underline` object:
480
+
481
+ #### `disabled` (boolean)
482
+
483
+ Indicates if the plugin is disabled or not
484
+
485
+ ### `undo` (object)
486
+
487
+ Properties of the `undo` object:
488
+
489
+ #### `disabled` (boolean)
490
+
491
+ Indicates if the plugin is disabled or not
492
+
493
+ ## `expandedInput` (object)
494
+
495
+ Properties of the `expandedInput` object:
381
496
 
382
497
  ### `inputConfiguration` (object)
383
498
 
@@ -460,105 +575,109 @@ Properties of the `h3` object:
460
575
 
461
576
  Indicates if the plugin is disabled or not
462
577
 
463
- ### `settings` (boolean)
578
+ #### `languageCharacters` (object)
464
579
 
465
- Indicates if the item has to be displayed in the Settings Panel
580
+ Properties of the `languageCharacters` object:
466
581
 
467
- ### `label` (string)
582
+ ##### `disabled` (boolean)
468
583
 
469
- Indicates the label for the item that has to be displayed in the Settings Panel
584
+ Indicates if the plugin is disabled or not
470
585
 
471
- ## `excludeZeroDialogBoxContent` (object)
586
+ #### `bold` (object)
472
587
 
473
- Properties of the `excludeZeroDialogBoxContent` object:
588
+ Properties of the `bold` object:
474
589
 
475
- ### `title` (string)
590
+ ##### `disabled` (boolean)
476
591
 
477
- Dialog box title
592
+ Indicates if the plugin is disabled or not
478
593
 
479
- ### `text` (string)
594
+ #### `html` (object)
480
595
 
481
- Dialog box text
596
+ Properties of the `html` object:
482
597
 
483
- ## `includeZeroDialogBoxContent` (object)
598
+ ##### `disabled` (boolean)
484
599
 
485
- Properties of the `includeZeroDialogBoxContent` object:
600
+ Indicates if the plugin is disabled or not
486
601
 
487
- ### `title` (string)
602
+ #### `italic` (object)
488
603
 
489
- Dialog box title
604
+ Properties of the `italic` object:
490
605
 
491
- ### `text` (string)
606
+ ##### `disabled` (boolean)
492
607
 
493
- Dialog box text
608
+ Indicates if the plugin is disabled or not
494
609
 
495
- ## `deleteScaleDialogBoxContent` (object)
610
+ #### `ol_list` (object)
496
611
 
497
- Properties of the `deleteScaleDialogBoxContent` object:
612
+ Properties of the `ol_list` object:
498
613
 
499
- ### `title` (string)
614
+ ##### `disabled` (boolean)
500
615
 
501
- Dialog box title
616
+ Indicates if the plugin is disabled or not
502
617
 
503
- ### `text` (string)
618
+ #### `redo` (object)
504
619
 
505
- Dialog box text
620
+ Properties of the `redo` object:
506
621
 
507
- ## `maxPointsDialogBoxContent` (object)
622
+ ##### `disabled` (boolean)
508
623
 
509
- Properties of the `maxPointsDialogBoxContent` object:
624
+ Indicates if the plugin is disabled or not
510
625
 
511
- ### `title` (string)
626
+ #### `strikethrough` (object)
512
627
 
513
- Dialog box title
628
+ Properties of the `strikethrough` object:
514
629
 
515
- ### `text` (string)
630
+ ##### `disabled` (boolean)
516
631
 
517
- Dialog box text
632
+ Indicates if the plugin is disabled or not
518
633
 
519
- ## `settingsPanelDisabled` (boolean)
634
+ #### `sub` (object)
520
635
 
521
- Indicates if the settings panel is not available
636
+ Properties of the `sub` object:
522
637
 
523
- ## `showExcludeZero` (object)
638
+ ##### `disabled` (boolean)
524
639
 
525
- Properties of the `showExcludeZero` object:
640
+ Indicates if the plugin is disabled or not
526
641
 
527
- ### `settings` (boolean)
642
+ #### `sup` (object)
528
643
 
529
- Indicates if the item has to be displayed in the Settings Panel
644
+ Properties of the `sup` object:
530
645
 
531
- ### `label` (string)
646
+ ##### `disabled` (boolean)
532
647
 
533
- Indicates the label for the item that has to be displayed in the Settings Panel
648
+ Indicates if the plugin is disabled or not
534
649
 
535
- ## `showScorePointLabels` (object)
650
+ #### `table` (object)
536
651
 
537
- Properties of the `showScorePointLabels` object:
652
+ Properties of the `table` object:
538
653
 
539
- ### `settings` (boolean)
654
+ ##### `disabled` (boolean)
540
655
 
541
- Indicates if the item has to be displayed in the Settings Panel
656
+ Indicates if the plugin is disabled or not
542
657
 
543
- ### `label` (string)
658
+ #### `ul_list` (object)
544
659
 
545
- Indicates the label for the item that has to be displayed in the Settings Panel
660
+ Properties of the `ul_list` object:
546
661
 
547
- ## `showDescription` (object)
662
+ ##### `disabled` (boolean)
548
663
 
549
- Properties of the `showDescription` object:
664
+ Indicates if the plugin is disabled or not
550
665
 
551
- ### `settings` (boolean)
666
+ #### `underline` (object)
552
667
 
553
- Indicates if the item has to be displayed in the Settings Panel
668
+ Properties of the `underline` object:
554
669
 
555
- ### `label` (string)
670
+ ##### `disabled` (boolean)
556
671
 
557
- Indicates the label for the item that has to be displayed in the Settings Panel
672
+ Indicates if the plugin is disabled or not
558
673
 
559
- ## `showVisibleToStudent` (object)
674
+ #### `undo` (object)
560
675
 
561
- Properties of the `showVisibleToStudent` object:
676
+ Properties of the `undo` object:
677
+
678
+ ##### `disabled` (boolean)
679
+
680
+ Indicates if the plugin is disabled or not
562
681
 
563
682
  ### `settings` (boolean)
564
683
 
@@ -568,172 +687,1009 @@ Indicates if the item has to be displayed in the Settings Panel
568
687
 
569
688
  Indicates the label for the item that has to be displayed in the Settings Panel
570
689
 
571
- ## `showHalfScoring` (object)
690
+ ## `labelInput` (object)
572
691
 
573
- Properties of the `showHalfScoring` object:
692
+ Properties of the `labelInput` object:
574
693
 
575
- ### `settings` (boolean)
694
+ ### `inputConfiguration` (object)
576
695
 
577
- Indicates if the item has to be displayed in the Settings Panel
696
+ Properties of the `inputConfiguration` object:
578
697
 
579
- ### `label` (string)
698
+ #### `math` (object)
580
699
 
581
- Indicates the label for the item that has to be displayed in the Settings Panel
700
+ Properties of the `math` object:
582
701
 
583
- ## `spellCheck` (object)
702
+ ##### `disabled` (boolean)
584
703
 
585
- Properties of the `spellCheck` object:
704
+ Indicates if the plugin is disabled or not
586
705
 
587
- ### `settings` (boolean)
706
+ #### `audio` (object)
588
707
 
589
- Indicates if the item has to be displayed in the Settings Panel
708
+ Properties of the `audio` object:
590
709
 
591
- ### `label` (string)
710
+ ##### `disabled` (boolean)
592
711
 
593
- Indicates the label for the item that has to be displayed in the Settings Panel
712
+ Indicates if the plugin is disabled or not
594
713
 
595
- ## `width` (string, required)
714
+ #### `video` (object)
715
+
716
+ Properties of the `video` object:
717
+
718
+ ##### `disabled` (boolean)
719
+
720
+ Indicates if the plugin is disabled or not
721
+
722
+ #### `image` (object)
723
+
724
+ Properties of the `image` object:
725
+
726
+ ##### `disabled` (boolean)
727
+
728
+ Indicates if the plugin is disabled or not
729
+
730
+ #### `customPlugins` (array)
731
+
732
+ An array of objects that determine custom plugins.
733
+ 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).
734
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
735
+
736
+ The object is an array with all elements of the type `object`.
737
+
738
+ The array object has the following properties:
739
+
740
+ ##### `event` (string, required)
741
+
742
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
743
+ PIE will emit the event prefixed with "PIE-".
744
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
745
+
746
+ ##### `iconAlt` (string, required)
747
+
748
+ The alt for the custom button icon
749
+
750
+ ##### `iconType` (string, required)
751
+
752
+ The icon type.
753
+ Currently, only "SVG" is supported.
754
+
755
+ ##### `icon` (string, required)
756
+
757
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
758
+
759
+ #### `blockquote` (object)
760
+
761
+ Properties of the `blockquote` object:
762
+
763
+ ##### `disabled` (boolean)
764
+
765
+ Indicates if the plugin is disabled or not
766
+
767
+ #### `h3` (object)
768
+
769
+ Properties of the `h3` object:
770
+
771
+ ##### `disabled` (boolean)
772
+
773
+ Indicates if the plugin is disabled or not
774
+
775
+ #### `languageCharacters` (object)
776
+
777
+ Properties of the `languageCharacters` object:
778
+
779
+ ##### `disabled` (boolean)
780
+
781
+ Indicates if the plugin is disabled or not
782
+
783
+ #### `bold` (object)
784
+
785
+ Properties of the `bold` object:
786
+
787
+ ##### `disabled` (boolean)
788
+
789
+ Indicates if the plugin is disabled or not
790
+
791
+ #### `html` (object)
792
+
793
+ Properties of the `html` object:
794
+
795
+ ##### `disabled` (boolean)
796
+
797
+ Indicates if the plugin is disabled or not
798
+
799
+ #### `italic` (object)
800
+
801
+ Properties of the `italic` object:
802
+
803
+ ##### `disabled` (boolean)
804
+
805
+ Indicates if the plugin is disabled or not
806
+
807
+ #### `ol_list` (object)
808
+
809
+ Properties of the `ol_list` object:
810
+
811
+ ##### `disabled` (boolean)
812
+
813
+ Indicates if the plugin is disabled or not
814
+
815
+ #### `redo` (object)
816
+
817
+ Properties of the `redo` object:
818
+
819
+ ##### `disabled` (boolean)
820
+
821
+ Indicates if the plugin is disabled or not
822
+
823
+ #### `strikethrough` (object)
824
+
825
+ Properties of the `strikethrough` object:
826
+
827
+ ##### `disabled` (boolean)
828
+
829
+ Indicates if the plugin is disabled or not
830
+
831
+ #### `sub` (object)
832
+
833
+ Properties of the `sub` object:
834
+
835
+ ##### `disabled` (boolean)
836
+
837
+ Indicates if the plugin is disabled or not
838
+
839
+ #### `sup` (object)
840
+
841
+ Properties of the `sup` object:
842
+
843
+ ##### `disabled` (boolean)
844
+
845
+ Indicates if the plugin is disabled or not
846
+
847
+ #### `table` (object)
848
+
849
+ Properties of the `table` object:
850
+
851
+ ##### `disabled` (boolean)
852
+
853
+ Indicates if the plugin is disabled or not
854
+
855
+ #### `ul_list` (object)
856
+
857
+ Properties of the `ul_list` object:
858
+
859
+ ##### `disabled` (boolean)
860
+
861
+ Indicates if the plugin is disabled or not
862
+
863
+ #### `underline` (object)
864
+
865
+ Properties of the `underline` object:
866
+
867
+ ##### `disabled` (boolean)
868
+
869
+ Indicates if the plugin is disabled or not
870
+
871
+ #### `undo` (object)
872
+
873
+ Properties of the `undo` object:
874
+
875
+ ##### `disabled` (boolean)
876
+
877
+ Indicates if the plugin is disabled or not
878
+
879
+ ### `settings` (boolean)
880
+
881
+ Indicates if the item has to be displayed in the Settings Panel
882
+
883
+ ### `label` (string)
884
+
885
+ Indicates the label for the item that has to be displayed in the Settings Panel
886
+
887
+ ## `excludeZeroDialogBoxContent` (object)
888
+
889
+ Properties of the `excludeZeroDialogBoxContent` object:
890
+
891
+ ### `title` (string)
892
+
893
+ Dialog box title
894
+
895
+ ### `text` (string)
896
+
897
+ Dialog box text
898
+
899
+ ## `includeZeroDialogBoxContent` (object)
900
+
901
+ Properties of the `includeZeroDialogBoxContent` object:
902
+
903
+ ### `title` (string)
904
+
905
+ Dialog box title
906
+
907
+ ### `text` (string)
908
+
909
+ Dialog box text
910
+
911
+ ## `deleteScaleDialogBoxContent` (object)
912
+
913
+ Properties of the `deleteScaleDialogBoxContent` object:
914
+
915
+ ### `title` (string)
916
+
917
+ Dialog box title
918
+
919
+ ### `text` (string)
920
+
921
+ Dialog box text
922
+
923
+ ## `maxPointsDialogBoxContent` (object)
924
+
925
+ Properties of the `maxPointsDialogBoxContent` object:
926
+
927
+ ### `title` (string)
928
+
929
+ Dialog box title
930
+
931
+ ### `text` (string)
932
+
933
+ Dialog box text
934
+
935
+ ## `settingsPanelDisabled` (boolean)
936
+
937
+ Indicates if the settings panel is not available
938
+
939
+ ## `showExcludeZero` (object)
940
+
941
+ Properties of the `showExcludeZero` object:
942
+
943
+ ### `settings` (boolean)
944
+
945
+ Indicates if the item has to be displayed in the Settings Panel
946
+
947
+ ### `label` (string)
948
+
949
+ Indicates the label for the item that has to be displayed in the Settings Panel
950
+
951
+ ## `showScorePointLabels` (object)
952
+
953
+ Properties of the `showScorePointLabels` object:
954
+
955
+ ### `settings` (boolean)
956
+
957
+ Indicates if the item has to be displayed in the Settings Panel
958
+
959
+ ### `label` (string)
960
+
961
+ Indicates the label for the item that has to be displayed in the Settings Panel
962
+
963
+ ## `showDescription` (object)
964
+
965
+ Properties of the `showDescription` object:
966
+
967
+ ### `settings` (boolean)
968
+
969
+ Indicates if the item has to be displayed in the Settings Panel
970
+
971
+ ### `label` (string)
972
+
973
+ Indicates the label for the item that has to be displayed in the Settings Panel
974
+
975
+ ## `showVisibleToStudent` (object)
976
+
977
+ Properties of the `showVisibleToStudent` object:
978
+
979
+ ### `settings` (boolean)
980
+
981
+ Indicates if the item has to be displayed in the Settings Panel
982
+
983
+ ### `label` (string)
984
+
985
+ Indicates the label for the item that has to be displayed in the Settings Panel
986
+
987
+ ## `showHalfScoring` (object)
988
+
989
+ Properties of the `showHalfScoring` object:
990
+
991
+ ### `settings` (boolean)
992
+
993
+ Indicates if the item has to be displayed in the Settings Panel
994
+
995
+ ### `label` (string)
996
+
997
+ Indicates the label for the item that has to be displayed in the Settings Panel
998
+
999
+ ## `spellCheck` (object)
1000
+
1001
+ Properties of the `spellCheck` object:
1002
+
1003
+ ### `settings` (boolean)
1004
+
1005
+ Indicates if the item has to be displayed in the Settings Panel
1006
+
1007
+ ### `label` (string)
1008
+
1009
+ Indicates the label for the item that has to be displayed in the Settings Panel
1010
+
1011
+ ## `width` (string, required)
1012
+
1013
+ How large (in px) should multi-trait-rubric be
1014
+
1015
+ ## `minNoOfTraits` (number)
1016
+
1017
+ Minimum number of traits
1018
+
1019
+ ## `maxNoOfTraits` (number)
1020
+
1021
+ Maximum number of traits
1022
+
1023
+ ## `minNoOfScales` (number)
1024
+
1025
+ Minimum number of scales
1026
+
1027
+ ## `maxNoOfScales` (number)
1028
+
1029
+ Maximum number of scales
1030
+
1031
+ ## `defaultTraitLabel` (string)
1032
+
1033
+ The default trait label for new created scales.
1034
+ If it's not defined, it will default to the label of the first trait.
1035
+
1036
+ ## `mathMlOptions` (object)
1037
+
1038
+ Properties of the `mathMlOptions` object:
1039
+
1040
+ ### `mmlOutput` (number)
1041
+
1042
+ Indicates if model should have mathML output instead of latex
1043
+
1044
+ ### `mmlEditing` (number)
1045
+
1046
+ Indicates if mathML that's already in model should be editable
1047
+
1048
+ ## `maxMaxPoints` (number)
1049
+
1050
+ Indicates the max limit for scoring points
1051
+
1052
+ # `rubricless` (object, required)
1053
+
1054
+ Properties of the `rubricless` object:
1055
+
1056
+ ## `settingsPanelDisabled` (boolean)
1057
+
1058
+ Indicates if the settings panel is not available
1059
+
1060
+ ## `showExcludeZero` (object)
1061
+
1062
+ Properties of the `showExcludeZero` object:
1063
+
1064
+ ### `settings` (boolean)
1065
+
1066
+ Indicates if the item has to be displayed in the Settings Panel
1067
+
1068
+ ### `label` (string)
1069
+
1070
+ Indicates the label for the item that has to be displayed in the Settings Panel
1071
+
1072
+ ## `showMaxPoint` (object)
1073
+
1074
+ Properties of the `showMaxPoint` object:
1075
+
1076
+ ### `settings` (boolean)
1077
+
1078
+ Indicates if the item has to be displayed in the Settings Panel
1079
+
1080
+ ### `label` (string)
1081
+
1082
+ Indicates the label for the item that has to be displayed in the Settings Panel
1083
+
1084
+ ## `width` (string)
1085
+
1086
+ How large can the rubric be
1087
+
1088
+ ## `mathMlOptions` (object)
1089
+
1090
+ Properties of the `mathMlOptions` object:
1091
+
1092
+ ### `mmlOutput` (number)
1093
+
1094
+ Indicates if model should have mathML output instead of latex
1095
+
1096
+ ### `mmlEditing` (number)
1097
+
1098
+ Indicates if mathML that's already in model should be editable
1099
+
1100
+ ## `maxMaxPoints` (number)
1101
+
1102
+ Indicates the max limit for scoring points
1103
+
1104
+ ## `rubricless` (boolean, enum, required)
1105
+
1106
+ Indicates that it is rubricless
1107
+
1108
+ This element must be one of the following enum values:
1109
+
1110
+ * `true`
1111
+
1112
+ ## `rubriclessInstruction` (object, required)
1113
+
1114
+ Properties of the `rubriclessInstruction` object:
1115
+
1116
+ ### `inputConfiguration` (object)
1117
+
1118
+ Properties of the `inputConfiguration` object:
1119
+
1120
+ #### `math` (object)
1121
+
1122
+ Properties of the `math` object:
1123
+
1124
+ ##### `disabled` (boolean)
1125
+
1126
+ Indicates if the plugin is disabled or not
1127
+
1128
+ #### `audio` (object)
1129
+
1130
+ Properties of the `audio` object:
1131
+
1132
+ ##### `disabled` (boolean)
1133
+
1134
+ Indicates if the plugin is disabled or not
1135
+
1136
+ #### `video` (object)
1137
+
1138
+ Properties of the `video` object:
1139
+
1140
+ ##### `disabled` (boolean)
1141
+
1142
+ Indicates if the plugin is disabled or not
1143
+
1144
+ #### `image` (object)
1145
+
1146
+ Properties of the `image` object:
1147
+
1148
+ ##### `disabled` (boolean)
1149
+
1150
+ Indicates if the plugin is disabled or not
1151
+
1152
+ #### `customPlugins` (array)
1153
+
1154
+ An array of objects that determine custom plugins.
1155
+ 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).
1156
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1157
+
1158
+ The object is an array with all elements of the type `object`.
1159
+
1160
+ The array object has the following properties:
1161
+
1162
+ ##### `event` (string, required)
1163
+
1164
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1165
+ PIE will emit the event prefixed with "PIE-".
1166
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1167
+
1168
+ ##### `iconAlt` (string, required)
1169
+
1170
+ The alt for the custom button icon
1171
+
1172
+ ##### `iconType` (string, required)
1173
+
1174
+ The icon type.
1175
+ Currently, only "SVG" is supported.
1176
+
1177
+ ##### `icon` (string, required)
1178
+
1179
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1180
+
1181
+ #### `blockquote` (object)
1182
+
1183
+ Properties of the `blockquote` object:
1184
+
1185
+ ##### `disabled` (boolean)
1186
+
1187
+ Indicates if the plugin is disabled or not
1188
+
1189
+ #### `h3` (object)
1190
+
1191
+ Properties of the `h3` object:
1192
+
1193
+ ##### `disabled` (boolean)
1194
+
1195
+ Indicates if the plugin is disabled or not
1196
+
1197
+ #### `languageCharacters` (object)
1198
+
1199
+ Properties of the `languageCharacters` object:
1200
+
1201
+ ##### `disabled` (boolean)
1202
+
1203
+ Indicates if the plugin is disabled or not
1204
+
1205
+ #### `bold` (object)
1206
+
1207
+ Properties of the `bold` object:
1208
+
1209
+ ##### `disabled` (boolean)
1210
+
1211
+ Indicates if the plugin is disabled or not
1212
+
1213
+ #### `html` (object)
1214
+
1215
+ Properties of the `html` object:
1216
+
1217
+ ##### `disabled` (boolean)
1218
+
1219
+ Indicates if the plugin is disabled or not
1220
+
1221
+ #### `italic` (object)
1222
+
1223
+ Properties of the `italic` object:
1224
+
1225
+ ##### `disabled` (boolean)
1226
+
1227
+ Indicates if the plugin is disabled or not
1228
+
1229
+ #### `ol_list` (object)
1230
+
1231
+ Properties of the `ol_list` object:
1232
+
1233
+ ##### `disabled` (boolean)
1234
+
1235
+ Indicates if the plugin is disabled or not
1236
+
1237
+ #### `redo` (object)
1238
+
1239
+ Properties of the `redo` object:
1240
+
1241
+ ##### `disabled` (boolean)
1242
+
1243
+ Indicates if the plugin is disabled or not
1244
+
1245
+ #### `strikethrough` (object)
1246
+
1247
+ Properties of the `strikethrough` object:
1248
+
1249
+ ##### `disabled` (boolean)
1250
+
1251
+ Indicates if the plugin is disabled or not
1252
+
1253
+ #### `sub` (object)
1254
+
1255
+ Properties of the `sub` object:
1256
+
1257
+ ##### `disabled` (boolean)
1258
+
1259
+ Indicates if the plugin is disabled or not
1260
+
1261
+ #### `sup` (object)
1262
+
1263
+ Properties of the `sup` object:
1264
+
1265
+ ##### `disabled` (boolean)
1266
+
1267
+ Indicates if the plugin is disabled or not
1268
+
1269
+ #### `table` (object)
1270
+
1271
+ Properties of the `table` object:
1272
+
1273
+ ##### `disabled` (boolean)
1274
+
1275
+ Indicates if the plugin is disabled or not
1276
+
1277
+ #### `ul_list` (object)
1278
+
1279
+ Properties of the `ul_list` object:
1280
+
1281
+ ##### `disabled` (boolean)
1282
+
1283
+ Indicates if the plugin is disabled or not
1284
+
1285
+ #### `underline` (object)
1286
+
1287
+ Properties of the `underline` object:
1288
+
1289
+ ##### `disabled` (boolean)
1290
+
1291
+ Indicates if the plugin is disabled or not
1292
+
1293
+ #### `undo` (object)
1294
+
1295
+ Properties of the `undo` object:
1296
+
1297
+ ##### `disabled` (boolean)
1298
+
1299
+ Indicates if the plugin is disabled or not
1300
+
1301
+ ### `settings` (boolean)
1302
+
1303
+ Indicates if the item has to be displayed in the Settings Panel
1304
+
1305
+ ### `label` (string)
1306
+
1307
+ Indicates the label for the item that has to be displayed in the Settings Panel
1308
+
1309
+ ## `showPrompt` (boolean)
1310
+
1311
+ Determines whether prompt field will be displayed or not
1312
+
1313
+ Default: `true`
1314
+
1315
+ ## `promptLabel` (string)
1316
+
1317
+ The label for the item stem/prompt field
1318
+
1319
+ Default: `"Item Stemm"`
1320
+
1321
+ ## `contentDimensions` (object)
1322
+
1323
+ Indicates the dimensions configuration for the authoring container
1324
+ Note: Some items have a default minimum width because of their content, but if
1325
+ the minWidth is lower than this, the overflow behavior will take care of that
1326
+
1327
+ Properties of the `contentDimensions` object:
1328
+
1329
+ ### `maxHeight` (string,number)
1330
+
1331
+ Indicates the max height of the authoring container
1332
+
1333
+ Default: `"undefined"`
1334
+
1335
+ ### `maxWidth` (string,number)
1336
+
1337
+ Indicates the max width of the authoring container
1338
+
1339
+ Default: `"undefined"`
1340
+
1341
+ ### `minHeight` (string,number)
1342
+
1343
+ Indicates the min height of the authoring container
1344
+
1345
+ Default: `"undefined"`
1346
+
1347
+ ### `minWidth` (string,number)
1348
+
1349
+ Indicates the min width of the authoring container
1350
+
1351
+ Default: `"undefined"`
1352
+
1353
+ Default: `": {}"`
1354
+
1355
+ ## `settingsPartialScoring` (boolean)
1356
+
1357
+ Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1358
+
1359
+ Default: `true`
1360
+
1361
+ ---
1362
+
1363
+ # Sub Schemas
1364
+
1365
+ The schema defines the following additional types:
1366
+
1367
+ ## `RubricConfigure` (object)
1368
+
1369
+ Properties of the `RubricConfigure` object:
1370
+
1371
+ ### `baseInputConfiguration` (object)
1372
+
1373
+ Properties of the `baseInputConfiguration` object:
1374
+
1375
+ #### `math` (object)
1376
+
1377
+ Properties of the `math` object:
1378
+
1379
+ ##### `disabled` (boolean)
1380
+
1381
+ Indicates if the plugin is disabled or not
1382
+
1383
+ #### `audio` (object)
1384
+
1385
+ Properties of the `audio` object:
1386
+
1387
+ ##### `disabled` (boolean)
1388
+
1389
+ Indicates if the plugin is disabled or not
1390
+
1391
+ #### `video` (object)
1392
+
1393
+ Properties of the `video` object:
1394
+
1395
+ ##### `disabled` (boolean)
1396
+
1397
+ Indicates if the plugin is disabled or not
1398
+
1399
+ #### `image` (object)
1400
+
1401
+ Properties of the `image` object:
1402
+
1403
+ ##### `disabled` (boolean)
1404
+
1405
+ Indicates if the plugin is disabled or not
1406
+
1407
+ #### `customPlugins` (array)
1408
+
1409
+ An array of objects that determine custom plugins.
1410
+ 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).
1411
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
1412
+
1413
+ The object is an array with all elements of the type `object`.
1414
+
1415
+ The array object has the following properties:
1416
+
1417
+ ##### `event` (string, required)
1418
+
1419
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1420
+ PIE will emit the event prefixed with "PIE-".
1421
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1422
+
1423
+ ##### `iconAlt` (string, required)
1424
+
1425
+ The alt for the custom button icon
1426
+
1427
+ ##### `iconType` (string, required)
1428
+
1429
+ The icon type.
1430
+ Currently, only "SVG" is supported.
1431
+
1432
+ ##### `icon` (string, required)
1433
+
1434
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1435
+
1436
+ #### `blockquote` (object)
1437
+
1438
+ Properties of the `blockquote` object:
1439
+
1440
+ ##### `disabled` (boolean)
1441
+
1442
+ Indicates if the plugin is disabled or not
1443
+
1444
+ #### `h3` (object)
1445
+
1446
+ Properties of the `h3` object:
1447
+
1448
+ ##### `disabled` (boolean)
1449
+
1450
+ Indicates if the plugin is disabled or not
1451
+
1452
+ #### `languageCharacters` (object)
1453
+
1454
+ Properties of the `languageCharacters` object:
1455
+
1456
+ ##### `disabled` (boolean)
1457
+
1458
+ Indicates if the plugin is disabled or not
1459
+
1460
+ #### `bold` (object)
1461
+
1462
+ Properties of the `bold` object:
1463
+
1464
+ ##### `disabled` (boolean)
1465
+
1466
+ Indicates if the plugin is disabled or not
596
1467
 
597
- How large (in px) should multi-trait-rubric be
1468
+ #### `html` (object)
598
1469
 
599
- ## `minNoOfTraits` (number)
1470
+ Properties of the `html` object:
600
1471
 
601
- Minimum number of traits
1472
+ ##### `disabled` (boolean)
602
1473
 
603
- ## `maxNoOfTraits` (number)
1474
+ Indicates if the plugin is disabled or not
604
1475
 
605
- Maximum number of traits
1476
+ #### `italic` (object)
606
1477
 
607
- ## `minNoOfScales` (number)
1478
+ Properties of the `italic` object:
608
1479
 
609
- Minimum number of scales
1480
+ ##### `disabled` (boolean)
610
1481
 
611
- ## `maxNoOfScales` (number)
1482
+ Indicates if the plugin is disabled or not
612
1483
 
613
- Maximum number of scales
1484
+ #### `ol_list` (object)
614
1485
 
615
- ## `defaultTraitLabel` (string)
1486
+ Properties of the `ol_list` object:
616
1487
 
617
- The default trait label for new created scales.
618
- If it's not defined, it will default to the label of the first trait.
1488
+ ##### `disabled` (boolean)
619
1489
 
620
- ## `mathMlOptions` (object)
1490
+ Indicates if the plugin is disabled or not
621
1491
 
622
- Properties of the `mathMlOptions` object:
1492
+ #### `redo` (object)
623
1493
 
624
- ### `mmlOutput` (number)
1494
+ Properties of the `redo` object:
625
1495
 
626
- Indicates if model should have mathML output instead of latex
1496
+ ##### `disabled` (boolean)
627
1497
 
628
- ### `mmlEditing` (number)
1498
+ Indicates if the plugin is disabled or not
629
1499
 
630
- Indicates if mathML that's already in model should be editable
1500
+ #### `strikethrough` (object)
631
1501
 
632
- ## `maxMaxPoints` (number)
1502
+ Properties of the `strikethrough` object:
633
1503
 
634
- Indicates the max limit for scoring points
1504
+ ##### `disabled` (boolean)
635
1505
 
636
- # `rubricless` (object, required)
1506
+ Indicates if the plugin is disabled or not
637
1507
 
638
- Properties of the `rubricless` object:
1508
+ #### `sub` (object)
639
1509
 
640
- ## `settingsPanelDisabled` (boolean)
1510
+ Properties of the `sub` object:
1511
+
1512
+ ##### `disabled` (boolean)
1513
+
1514
+ Indicates if the plugin is disabled or not
1515
+
1516
+ #### `sup` (object)
1517
+
1518
+ Properties of the `sup` object:
1519
+
1520
+ ##### `disabled` (boolean)
1521
+
1522
+ Indicates if the plugin is disabled or not
1523
+
1524
+ #### `table` (object)
1525
+
1526
+ Properties of the `table` object:
1527
+
1528
+ ##### `disabled` (boolean)
1529
+
1530
+ Indicates if the plugin is disabled or not
1531
+
1532
+ #### `ul_list` (object)
1533
+
1534
+ Properties of the `ul_list` object:
1535
+
1536
+ ##### `disabled` (boolean)
1537
+
1538
+ Indicates if the plugin is disabled or not
1539
+
1540
+ #### `underline` (object)
1541
+
1542
+ Properties of the `underline` object:
1543
+
1544
+ ##### `disabled` (boolean)
1545
+
1546
+ Indicates if the plugin is disabled or not
1547
+
1548
+ #### `undo` (object)
1549
+
1550
+ Properties of the `undo` object:
1551
+
1552
+ ##### `disabled` (boolean)
1553
+
1554
+ Indicates if the plugin is disabled or not
1555
+
1556
+ ### `settingsPanelDisabled` (boolean)
641
1557
 
642
1558
  Indicates if the settings panel is not available
643
1559
 
644
- ## `showExcludeZero` (object)
1560
+ ### `showExcludeZero` (object)
645
1561
 
646
1562
  Properties of the `showExcludeZero` object:
647
1563
 
648
- ### `settings` (boolean)
1564
+ #### `settings` (boolean)
649
1565
 
650
1566
  Indicates if the item has to be displayed in the Settings Panel
651
1567
 
652
- ### `label` (string)
1568
+ #### `label` (string)
653
1569
 
654
1570
  Indicates the label for the item that has to be displayed in the Settings Panel
655
1571
 
656
- ## `showMaxPoint` (object)
1572
+ ### `showMaxPoint` (object)
657
1573
 
658
1574
  Properties of the `showMaxPoint` object:
659
1575
 
660
- ### `settings` (boolean)
1576
+ #### `settings` (boolean)
661
1577
 
662
1578
  Indicates if the item has to be displayed in the Settings Panel
663
1579
 
664
- ### `label` (string)
1580
+ #### `label` (string)
665
1581
 
666
1582
  Indicates the label for the item that has to be displayed in the Settings Panel
667
1583
 
668
- ## `width` (string)
1584
+ ### `width` (string)
669
1585
 
670
1586
  How large can the rubric be
671
1587
 
672
- ## `mathMlOptions` (object)
1588
+ ### `mathMlOptions` (object)
673
1589
 
674
1590
  Properties of the `mathMlOptions` object:
675
1591
 
676
- ### `mmlOutput` (number)
1592
+ #### `mmlOutput` (number)
677
1593
 
678
1594
  Indicates if model should have mathML output instead of latex
679
1595
 
680
- ### `mmlEditing` (number)
1596
+ #### `mmlEditing` (number)
681
1597
 
682
1598
  Indicates if mathML that's already in model should be editable
683
1599
 
684
- ## `maxMaxPoints` (number)
1600
+ ### `maxMaxPoints` (number)
685
1601
 
686
1602
  Indicates the max limit for scoring points
687
1603
 
688
- ## `rubricless` (boolean, enum, required)
1604
+ ### `showPrompt` (boolean)
689
1605
 
690
- Indicates that it is rubricless
1606
+ Determines whether prompt field will be displayed or not
691
1607
 
692
- This element must be one of the following enum values:
1608
+ Default: `true`
693
1609
 
694
- * `true`
1610
+ ### `promptLabel` (string)
695
1611
 
696
- ## `rubriclessInstruction` (object, required)
1612
+ The label for the item stem/prompt field
697
1613
 
698
- Properties of the `rubriclessInstruction` object:
1614
+ Default: `"Item Stemm"`
699
1615
 
700
- ### `inputConfiguration` (object)
1616
+ ### `contentDimensions` (object)
701
1617
 
702
- Properties of the `inputConfiguration` object:
1618
+ Indicates the dimensions configuration for the authoring container
1619
+ Note: Some items have a default minimum width because of their content, but if
1620
+ the minWidth is lower than this, the overflow behavior will take care of that
703
1621
 
704
- #### `math` (object)
1622
+ Properties of the `contentDimensions` object:
1623
+
1624
+ #### `maxHeight` (string,number)
1625
+
1626
+ Indicates the max height of the authoring container
1627
+
1628
+ Default: `"undefined"`
1629
+
1630
+ #### `maxWidth` (string,number)
1631
+
1632
+ Indicates the max width of the authoring container
1633
+
1634
+ Default: `"undefined"`
1635
+
1636
+ #### `minHeight` (string,number)
1637
+
1638
+ Indicates the min height of the authoring container
1639
+
1640
+ Default: `"undefined"`
1641
+
1642
+ #### `minWidth` (string,number)
1643
+
1644
+ Indicates the min width of the authoring container
1645
+
1646
+ Default: `"undefined"`
1647
+
1648
+ Default: `": {}"`
1649
+
1650
+ ### `settingsPartialScoring` (boolean)
1651
+
1652
+ Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1653
+
1654
+ Default: `true`
1655
+
1656
+ ## `EditableHtmlConfigureProp` (object)
1657
+
1658
+ Properties of the `EditableHtmlConfigureProp` object:
1659
+
1660
+ ### `math` (object)
705
1661
 
706
1662
  Properties of the `math` object:
707
1663
 
708
- ##### `disabled` (boolean)
1664
+ #### `disabled` (boolean)
709
1665
 
710
1666
  Indicates if the plugin is disabled or not
711
1667
 
712
- #### `audio` (object)
1668
+ ### `audio` (object)
713
1669
 
714
1670
  Properties of the `audio` object:
715
1671
 
716
- ##### `disabled` (boolean)
1672
+ #### `disabled` (boolean)
717
1673
 
718
1674
  Indicates if the plugin is disabled or not
719
1675
 
720
- #### `video` (object)
1676
+ ### `video` (object)
721
1677
 
722
1678
  Properties of the `video` object:
723
1679
 
724
- ##### `disabled` (boolean)
1680
+ #### `disabled` (boolean)
725
1681
 
726
1682
  Indicates if the plugin is disabled or not
727
1683
 
728
- #### `image` (object)
1684
+ ### `image` (object)
729
1685
 
730
1686
  Properties of the `image` object:
731
1687
 
732
- ##### `disabled` (boolean)
1688
+ #### `disabled` (boolean)
733
1689
 
734
1690
  Indicates if the plugin is disabled or not
735
1691
 
736
- #### `customPlugins` (array)
1692
+ ### `customPlugins` (array)
737
1693
 
738
1694
  An array of objects that determine custom plugins.
739
1695
  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).
@@ -743,110 +1699,205 @@ The object is an array with all elements of the type `object`.
743
1699
 
744
1700
  The array object has the following properties:
745
1701
 
746
- ##### `event` (string, required)
1702
+ #### `event` (string, required)
747
1703
 
748
1704
  The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
749
1705
  PIE will emit the event prefixed with "PIE-".
750
1706
  Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
751
1707
 
752
- ##### `iconAlt` (string, required)
1708
+ #### `iconAlt` (string, required)
753
1709
 
754
1710
  The alt for the custom button icon
755
1711
 
756
- ##### `iconType` (string, required)
1712
+ #### `iconType` (string, required)
757
1713
 
758
1714
  The icon type.
759
1715
  Currently, only "SVG" is supported.
760
1716
 
761
- ##### `icon` (string, required)
1717
+ #### `icon` (string, required)
762
1718
 
763
1719
  The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
764
1720
 
765
- #### `blockquote` (object)
1721
+ ### `blockquote` (object)
766
1722
 
767
1723
  Properties of the `blockquote` object:
768
1724
 
769
- ##### `disabled` (boolean)
1725
+ #### `disabled` (boolean)
770
1726
 
771
1727
  Indicates if the plugin is disabled or not
772
1728
 
773
- #### `h3` (object)
1729
+ ### `h3` (object)
774
1730
 
775
1731
  Properties of the `h3` object:
776
1732
 
777
- ##### `disabled` (boolean)
1733
+ #### `disabled` (boolean)
778
1734
 
779
1735
  Indicates if the plugin is disabled or not
780
1736
 
781
- ### `settings` (boolean)
1737
+ ### `languageCharacters` (object)
782
1738
 
783
- Indicates if the item has to be displayed in the Settings Panel
1739
+ Properties of the `languageCharacters` object:
784
1740
 
785
- ### `label` (string)
1741
+ #### `disabled` (boolean)
1742
+
1743
+ Indicates if the plugin is disabled or not
1744
+
1745
+ ### `bold` (object)
1746
+
1747
+ Properties of the `bold` object:
1748
+
1749
+ #### `disabled` (boolean)
1750
+
1751
+ Indicates if the plugin is disabled or not
1752
+
1753
+ ### `html` (object)
1754
+
1755
+ Properties of the `html` object:
1756
+
1757
+ #### `disabled` (boolean)
1758
+
1759
+ Indicates if the plugin is disabled or not
1760
+
1761
+ ### `italic` (object)
1762
+
1763
+ Properties of the `italic` object:
1764
+
1765
+ #### `disabled` (boolean)
1766
+
1767
+ Indicates if the plugin is disabled or not
1768
+
1769
+ ### `ol_list` (object)
1770
+
1771
+ Properties of the `ol_list` object:
1772
+
1773
+ #### `disabled` (boolean)
1774
+
1775
+ Indicates if the plugin is disabled or not
1776
+
1777
+ ### `redo` (object)
1778
+
1779
+ Properties of the `redo` object:
1780
+
1781
+ #### `disabled` (boolean)
1782
+
1783
+ Indicates if the plugin is disabled or not
1784
+
1785
+ ### `strikethrough` (object)
1786
+
1787
+ Properties of the `strikethrough` object:
1788
+
1789
+ #### `disabled` (boolean)
1790
+
1791
+ Indicates if the plugin is disabled or not
1792
+
1793
+ ### `sub` (object)
1794
+
1795
+ Properties of the `sub` object:
1796
+
1797
+ #### `disabled` (boolean)
1798
+
1799
+ Indicates if the plugin is disabled or not
1800
+
1801
+ ### `sup` (object)
1802
+
1803
+ Properties of the `sup` object:
1804
+
1805
+ #### `disabled` (boolean)
1806
+
1807
+ Indicates if the plugin is disabled or not
1808
+
1809
+ ### `table` (object)
1810
+
1811
+ Properties of the `table` object:
1812
+
1813
+ #### `disabled` (boolean)
1814
+
1815
+ Indicates if the plugin is disabled or not
1816
+
1817
+ ### `ul_list` (object)
1818
+
1819
+ Properties of the `ul_list` object:
1820
+
1821
+ #### `disabled` (boolean)
1822
+
1823
+ Indicates if the plugin is disabled or not
1824
+
1825
+ ### `underline` (object)
1826
+
1827
+ Properties of the `underline` object:
1828
+
1829
+ #### `disabled` (boolean)
1830
+
1831
+ Indicates if the plugin is disabled or not
1832
+
1833
+ ### `undo` (object)
1834
+
1835
+ Properties of the `undo` object:
786
1836
 
787
- Indicates the label for the item that has to be displayed in the Settings Panel
1837
+ #### `disabled` (boolean)
788
1838
 
789
- ## `showPrompt` (boolean)
1839
+ Indicates if the plugin is disabled or not
790
1840
 
791
- Determines whether prompt field will be displayed or not
1841
+ ## `EditableHtmlButtonConfigure` (object)
792
1842
 
793
- Default: `true`
1843
+ Properties of the `EditableHtmlButtonConfigure` object:
794
1844
 
795
- ## `promptLabel` (string)
1845
+ ### `disabled` (boolean)
796
1846
 
797
- The label for the item stem/prompt field
1847
+ Indicates if the plugin is disabled or not
798
1848
 
799
- Default: `"Item Stemm"`
1849
+ ## `CustomPlugin` (object)
800
1850
 
801
- ## `contentDimensions` (object)
1851
+ Properties of the `CustomPlugin` object:
802
1852
 
803
- Indicates the dimensions configuration for the authoring container
804
- Note: Some items have a default minimum width because of their content, but if
805
- the minWidth is lower than this, the overflow behavior will take care of that
1853
+ ### `event` (string, required)
806
1854
 
807
- Properties of the `contentDimensions` object:
1855
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1856
+ PIE will emit the event prefixed with "PIE-".
1857
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
808
1858
 
809
- ### `maxHeight` (string,number)
1859
+ ### `iconAlt` (string, required)
810
1860
 
811
- Indicates the max height of the authoring container
1861
+ The alt for the custom button icon
812
1862
 
813
- Default: `"undefined"`
1863
+ ### `iconType` (string, required)
814
1864
 
815
- ### `maxWidth` (string,number)
1865
+ The icon type.
1866
+ Currently, only "SVG" is supported.
816
1867
 
817
- Indicates the max width of the authoring container
1868
+ ### `icon` (string, required)
818
1869
 
819
- Default: `"undefined"`
1870
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
820
1871
 
821
- ### `minHeight` (string,number)
1872
+ ## `ConfigureProp` (object)
822
1873
 
823
- Indicates the min height of the authoring container
1874
+ Properties of the `ConfigureProp` object:
824
1875
 
825
- Default: `"undefined"`
1876
+ ### `settings` (boolean)
826
1877
 
827
- ### `minWidth` (string,number)
1878
+ Indicates if the item has to be displayed in the Settings Panel
828
1879
 
829
- Indicates the min width of the authoring container
1880
+ ### `label` (string)
830
1881
 
831
- Default: `"undefined"`
1882
+ Indicates the label for the item that has to be displayed in the Settings Panel
832
1883
 
833
- Default: `": {}"`
1884
+ ## `ConfigureMathMLProp` (object)
834
1885
 
835
- ## `settingsPartialScoring` (boolean)
1886
+ Properties of the `ConfigureMathMLProp` object:
836
1887
 
837
- Indicates whether the settings panel wil allow the author to modify settings for partial scoring
1888
+ ### `mmlOutput` (number)
838
1889
 
839
- Default: `true`
1890
+ Indicates if model should have mathML output instead of latex
840
1891
 
841
- ---
1892
+ ### `mmlEditing` (number)
842
1893
 
843
- # Sub Schemas
1894
+ Indicates if mathML that's already in model should be editable
844
1895
 
845
- The schema defines the following additional types:
1896
+ ## `MultiTraitRubricConfigure` (object)
846
1897
 
847
- ## `RubricConfigure` (object)
1898
+ Config Object for @pie-elements/multi-trait-rubric
848
1899
 
849
- Properties of the `RubricConfigure` object:
1900
+ Properties of the `MultiTraitRubricConfigure` object:
850
1901
 
851
1902
  ### `baseInputConfiguration` (object)
852
1903
 
@@ -929,143 +1980,151 @@ Properties of the `h3` object:
929
1980
 
930
1981
  Indicates if the plugin is disabled or not
931
1982
 
932
- ### `settingsPanelDisabled` (boolean)
1983
+ #### `languageCharacters` (object)
933
1984
 
934
- Indicates if the settings panel is not available
1985
+ Properties of the `languageCharacters` object:
935
1986
 
936
- ### `showExcludeZero` (object)
1987
+ ##### `disabled` (boolean)
937
1988
 
938
- Properties of the `showExcludeZero` object:
1989
+ Indicates if the plugin is disabled or not
939
1990
 
940
- #### `settings` (boolean)
1991
+ #### `bold` (object)
941
1992
 
942
- Indicates if the item has to be displayed in the Settings Panel
1993
+ Properties of the `bold` object:
943
1994
 
944
- #### `label` (string)
1995
+ ##### `disabled` (boolean)
945
1996
 
946
- Indicates the label for the item that has to be displayed in the Settings Panel
1997
+ Indicates if the plugin is disabled or not
947
1998
 
948
- ### `showMaxPoint` (object)
1999
+ #### `html` (object)
949
2000
 
950
- Properties of the `showMaxPoint` object:
2001
+ Properties of the `html` object:
951
2002
 
952
- #### `settings` (boolean)
2003
+ ##### `disabled` (boolean)
953
2004
 
954
- Indicates if the item has to be displayed in the Settings Panel
2005
+ Indicates if the plugin is disabled or not
955
2006
 
956
- #### `label` (string)
2007
+ #### `italic` (object)
957
2008
 
958
- Indicates the label for the item that has to be displayed in the Settings Panel
2009
+ Properties of the `italic` object:
959
2010
 
960
- ### `width` (string)
2011
+ ##### `disabled` (boolean)
961
2012
 
962
- How large can the rubric be
2013
+ Indicates if the plugin is disabled or not
963
2014
 
964
- ### `mathMlOptions` (object)
2015
+ #### `ol_list` (object)
965
2016
 
966
- Properties of the `mathMlOptions` object:
2017
+ Properties of the `ol_list` object:
967
2018
 
968
- #### `mmlOutput` (number)
2019
+ ##### `disabled` (boolean)
969
2020
 
970
- Indicates if model should have mathML output instead of latex
2021
+ Indicates if the plugin is disabled or not
971
2022
 
972
- #### `mmlEditing` (number)
2023
+ #### `redo` (object)
973
2024
 
974
- Indicates if mathML that's already in model should be editable
2025
+ Properties of the `redo` object:
975
2026
 
976
- ### `maxMaxPoints` (number)
2027
+ ##### `disabled` (boolean)
977
2028
 
978
- Indicates the max limit for scoring points
2029
+ Indicates if the plugin is disabled or not
979
2030
 
980
- ### `showPrompt` (boolean)
2031
+ #### `strikethrough` (object)
981
2032
 
982
- Determines whether prompt field will be displayed or not
2033
+ Properties of the `strikethrough` object:
983
2034
 
984
- Default: `true`
2035
+ ##### `disabled` (boolean)
985
2036
 
986
- ### `promptLabel` (string)
2037
+ Indicates if the plugin is disabled or not
987
2038
 
988
- The label for the item stem/prompt field
2039
+ #### `sub` (object)
989
2040
 
990
- Default: `"Item Stemm"`
2041
+ Properties of the `sub` object:
991
2042
 
992
- ### `contentDimensions` (object)
2043
+ ##### `disabled` (boolean)
993
2044
 
994
- Indicates the dimensions configuration for the authoring container
995
- Note: Some items have a default minimum width because of their content, but if
996
- the minWidth is lower than this, the overflow behavior will take care of that
2045
+ Indicates if the plugin is disabled or not
997
2046
 
998
- Properties of the `contentDimensions` object:
2047
+ #### `sup` (object)
999
2048
 
1000
- #### `maxHeight` (string,number)
2049
+ Properties of the `sup` object:
1001
2050
 
1002
- Indicates the max height of the authoring container
2051
+ ##### `disabled` (boolean)
1003
2052
 
1004
- Default: `"undefined"`
2053
+ Indicates if the plugin is disabled or not
1005
2054
 
1006
- #### `maxWidth` (string,number)
2055
+ #### `table` (object)
1007
2056
 
1008
- Indicates the max width of the authoring container
2057
+ Properties of the `table` object:
1009
2058
 
1010
- Default: `"undefined"`
2059
+ ##### `disabled` (boolean)
1011
2060
 
1012
- #### `minHeight` (string,number)
2061
+ Indicates if the plugin is disabled or not
1013
2062
 
1014
- Indicates the min height of the authoring container
2063
+ #### `ul_list` (object)
1015
2064
 
1016
- Default: `"undefined"`
2065
+ Properties of the `ul_list` object:
1017
2066
 
1018
- #### `minWidth` (string,number)
2067
+ ##### `disabled` (boolean)
1019
2068
 
1020
- Indicates the min width of the authoring container
2069
+ Indicates if the plugin is disabled or not
1021
2070
 
1022
- Default: `"undefined"`
2071
+ #### `underline` (object)
1023
2072
 
1024
- Default: `": {}"`
2073
+ Properties of the `underline` object:
1025
2074
 
1026
- ### `settingsPartialScoring` (boolean)
2075
+ ##### `disabled` (boolean)
1027
2076
 
1028
- Indicates whether the settings panel wil allow the author to modify settings for partial scoring
2077
+ Indicates if the plugin is disabled or not
1029
2078
 
1030
- Default: `true`
2079
+ #### `undo` (object)
1031
2080
 
1032
- ## `EditableHtmlConfigureProp` (object)
2081
+ Properties of the `undo` object:
1033
2082
 
1034
- Properties of the `EditableHtmlConfigureProp` object:
2083
+ ##### `disabled` (boolean)
1035
2084
 
1036
- ### `math` (object)
2085
+ Indicates if the plugin is disabled or not
2086
+
2087
+ ### `expandedInput` (object)
2088
+
2089
+ Properties of the `expandedInput` object:
2090
+
2091
+ #### `inputConfiguration` (object)
2092
+
2093
+ Properties of the `inputConfiguration` object:
2094
+
2095
+ ##### `math` (object)
1037
2096
 
1038
2097
  Properties of the `math` object:
1039
2098
 
1040
- #### `disabled` (boolean)
2099
+ ###### `disabled` (boolean)
1041
2100
 
1042
2101
  Indicates if the plugin is disabled or not
1043
2102
 
1044
- ### `audio` (object)
2103
+ ##### `audio` (object)
1045
2104
 
1046
2105
  Properties of the `audio` object:
1047
2106
 
1048
- #### `disabled` (boolean)
2107
+ ###### `disabled` (boolean)
1049
2108
 
1050
2109
  Indicates if the plugin is disabled or not
1051
2110
 
1052
- ### `video` (object)
2111
+ ##### `video` (object)
1053
2112
 
1054
2113
  Properties of the `video` object:
1055
2114
 
1056
- #### `disabled` (boolean)
2115
+ ###### `disabled` (boolean)
1057
2116
 
1058
2117
  Indicates if the plugin is disabled or not
1059
2118
 
1060
- ### `image` (object)
2119
+ ##### `image` (object)
1061
2120
 
1062
2121
  Properties of the `image` object:
1063
2122
 
1064
- #### `disabled` (boolean)
2123
+ ###### `disabled` (boolean)
1065
2124
 
1066
2125
  Indicates if the plugin is disabled or not
1067
2126
 
1068
- ### `customPlugins` (array)
2127
+ ##### `customPlugins` (array)
1069
2128
 
1070
2129
  An array of objects that determine custom plugins.
1071
2130
  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).
@@ -1075,186 +2134,156 @@ The object is an array with all elements of the type `object`.
1075
2134
 
1076
2135
  The array object has the following properties:
1077
2136
 
1078
- #### `event` (string, required)
2137
+ ###### `event` (string, required)
1079
2138
 
1080
2139
  The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1081
2140
  PIE will emit the event prefixed with "PIE-".
1082
2141
  Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1083
2142
 
1084
- #### `iconAlt` (string, required)
2143
+ ###### `iconAlt` (string, required)
1085
2144
 
1086
2145
  The alt for the custom button icon
1087
2146
 
1088
- #### `iconType` (string, required)
2147
+ ###### `iconType` (string, required)
1089
2148
 
1090
2149
  The icon type.
1091
2150
  Currently, only "SVG" is supported.
1092
2151
 
1093
- #### `icon` (string, required)
2152
+ ###### `icon` (string, required)
1094
2153
 
1095
2154
  The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1096
2155
 
1097
- ### `blockquote` (object)
2156
+ ##### `blockquote` (object)
1098
2157
 
1099
2158
  Properties of the `blockquote` object:
1100
2159
 
1101
- #### `disabled` (boolean)
2160
+ ###### `disabled` (boolean)
1102
2161
 
1103
2162
  Indicates if the plugin is disabled or not
1104
2163
 
1105
- ### `h3` (object)
2164
+ ##### `h3` (object)
1106
2165
 
1107
2166
  Properties of the `h3` object:
1108
2167
 
1109
- #### `disabled` (boolean)
2168
+ ###### `disabled` (boolean)
1110
2169
 
1111
2170
  Indicates if the plugin is disabled or not
1112
2171
 
1113
- ## `EditableHtmlButtonConfigure` (object)
2172
+ ##### `languageCharacters` (object)
1114
2173
 
1115
- Properties of the `EditableHtmlButtonConfigure` object:
2174
+ Properties of the `languageCharacters` object:
1116
2175
 
1117
- ### `disabled` (boolean)
2176
+ ###### `disabled` (boolean)
1118
2177
 
1119
2178
  Indicates if the plugin is disabled or not
1120
2179
 
1121
- ## `CustomPlugin` (object)
1122
-
1123
- Properties of the `CustomPlugin` object:
1124
-
1125
- ### `event` (string, required)
1126
-
1127
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1128
- PIE will emit the event prefixed with "PIE-".
1129
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
1130
-
1131
- ### `iconAlt` (string, required)
1132
-
1133
- The alt for the custom button icon
1134
-
1135
- ### `iconType` (string, required)
1136
-
1137
- The icon type.
1138
- Currently, only "SVG" is supported.
1139
-
1140
- ### `icon` (string, required)
1141
-
1142
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
1143
-
1144
- ## `ConfigureProp` (object)
1145
-
1146
- Properties of the `ConfigureProp` object:
2180
+ ##### `bold` (object)
1147
2181
 
1148
- ### `settings` (boolean)
2182
+ Properties of the `bold` object:
1149
2183
 
1150
- Indicates if the item has to be displayed in the Settings Panel
2184
+ ###### `disabled` (boolean)
1151
2185
 
1152
- ### `label` (string)
2186
+ Indicates if the plugin is disabled or not
1153
2187
 
1154
- Indicates the label for the item that has to be displayed in the Settings Panel
2188
+ ##### `html` (object)
1155
2189
 
1156
- ## `ConfigureMathMLProp` (object)
2190
+ Properties of the `html` object:
1157
2191
 
1158
- Properties of the `ConfigureMathMLProp` object:
2192
+ ###### `disabled` (boolean)
1159
2193
 
1160
- ### `mmlOutput` (number)
2194
+ Indicates if the plugin is disabled or not
1161
2195
 
1162
- Indicates if model should have mathML output instead of latex
2196
+ ##### `italic` (object)
1163
2197
 
1164
- ### `mmlEditing` (number)
2198
+ Properties of the `italic` object:
1165
2199
 
1166
- Indicates if mathML that's already in model should be editable
2200
+ ###### `disabled` (boolean)
1167
2201
 
1168
- ## `MultiTraitRubricConfigure` (object)
2202
+ Indicates if the plugin is disabled or not
1169
2203
 
1170
- Config Object for @pie-elements/multi-trait-rubric
2204
+ ##### `ol_list` (object)
1171
2205
 
1172
- Properties of the `MultiTraitRubricConfigure` object:
2206
+ Properties of the `ol_list` object:
1173
2207
 
1174
- ### `baseInputConfiguration` (object)
2208
+ ###### `disabled` (boolean)
1175
2209
 
1176
- Properties of the `baseInputConfiguration` object:
2210
+ Indicates if the plugin is disabled or not
1177
2211
 
1178
- #### `math` (object)
2212
+ ##### `redo` (object)
1179
2213
 
1180
- Properties of the `math` object:
2214
+ Properties of the `redo` object:
1181
2215
 
1182
- ##### `disabled` (boolean)
2216
+ ###### `disabled` (boolean)
1183
2217
 
1184
2218
  Indicates if the plugin is disabled or not
1185
2219
 
1186
- #### `audio` (object)
2220
+ ##### `strikethrough` (object)
1187
2221
 
1188
- Properties of the `audio` object:
2222
+ Properties of the `strikethrough` object:
1189
2223
 
1190
- ##### `disabled` (boolean)
2224
+ ###### `disabled` (boolean)
1191
2225
 
1192
2226
  Indicates if the plugin is disabled or not
1193
2227
 
1194
- #### `video` (object)
2228
+ ##### `sub` (object)
1195
2229
 
1196
- Properties of the `video` object:
2230
+ Properties of the `sub` object:
1197
2231
 
1198
- ##### `disabled` (boolean)
2232
+ ###### `disabled` (boolean)
1199
2233
 
1200
2234
  Indicates if the plugin is disabled or not
1201
2235
 
1202
- #### `image` (object)
2236
+ ##### `sup` (object)
1203
2237
 
1204
- Properties of the `image` object:
2238
+ Properties of the `sup` object:
1205
2239
 
1206
- ##### `disabled` (boolean)
2240
+ ###### `disabled` (boolean)
1207
2241
 
1208
2242
  Indicates if the plugin is disabled or not
1209
2243
 
1210
- #### `customPlugins` (array)
2244
+ ##### `table` (object)
1211
2245
 
1212
- An array of objects that determine custom plugins.
1213
- 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).
1214
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2246
+ Properties of the `table` object:
1215
2247
 
1216
- The object is an array with all elements of the type `object`.
2248
+ ###### `disabled` (boolean)
1217
2249
 
1218
- The array object has the following properties:
2250
+ Indicates if the plugin is disabled or not
1219
2251
 
1220
- ##### `event` (string, required)
2252
+ ##### `ul_list` (object)
1221
2253
 
1222
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1223
- PIE will emit the event prefixed with "PIE-".
1224
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2254
+ Properties of the `ul_list` object:
1225
2255
 
1226
- ##### `iconAlt` (string, required)
2256
+ ###### `disabled` (boolean)
1227
2257
 
1228
- The alt for the custom button icon
2258
+ Indicates if the plugin is disabled or not
1229
2259
 
1230
- ##### `iconType` (string, required)
2260
+ ##### `underline` (object)
1231
2261
 
1232
- The icon type.
1233
- Currently, only "SVG" is supported.
2262
+ Properties of the `underline` object:
1234
2263
 
1235
- ##### `icon` (string, required)
2264
+ ###### `disabled` (boolean)
1236
2265
 
1237
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2266
+ Indicates if the plugin is disabled or not
1238
2267
 
1239
- #### `blockquote` (object)
2268
+ ##### `undo` (object)
1240
2269
 
1241
- Properties of the `blockquote` object:
2270
+ Properties of the `undo` object:
1242
2271
 
1243
- ##### `disabled` (boolean)
2272
+ ###### `disabled` (boolean)
1244
2273
 
1245
2274
  Indicates if the plugin is disabled or not
1246
2275
 
1247
- #### `h3` (object)
2276
+ #### `settings` (boolean)
1248
2277
 
1249
- Properties of the `h3` object:
2278
+ Indicates if the item has to be displayed in the Settings Panel
1250
2279
 
1251
- ##### `disabled` (boolean)
2280
+ #### `label` (string)
1252
2281
 
1253
- Indicates if the plugin is disabled or not
2282
+ Indicates the label for the item that has to be displayed in the Settings Panel
1254
2283
 
1255
- ### `expandedInput` (object)
2284
+ ### `labelInput` (object)
1256
2285
 
1257
- Properties of the `expandedInput` object:
2286
+ Properties of the `labelInput` object:
1258
2287
 
1259
2288
  #### `inputConfiguration` (object)
1260
2289
 
@@ -1337,94 +2366,105 @@ Properties of the `h3` object:
1337
2366
 
1338
2367
  Indicates if the plugin is disabled or not
1339
2368
 
1340
- #### `settings` (boolean)
2369
+ ##### `languageCharacters` (object)
1341
2370
 
1342
- Indicates if the item has to be displayed in the Settings Panel
2371
+ Properties of the `languageCharacters` object:
1343
2372
 
1344
- #### `label` (string)
2373
+ ###### `disabled` (boolean)
1345
2374
 
1346
- Indicates the label for the item that has to be displayed in the Settings Panel
2375
+ Indicates if the plugin is disabled or not
1347
2376
 
1348
- ### `labelInput` (object)
2377
+ ##### `bold` (object)
1349
2378
 
1350
- Properties of the `labelInput` object:
2379
+ Properties of the `bold` object:
1351
2380
 
1352
- #### `inputConfiguration` (object)
2381
+ ###### `disabled` (boolean)
1353
2382
 
1354
- Properties of the `inputConfiguration` object:
2383
+ Indicates if the plugin is disabled or not
1355
2384
 
1356
- ##### `math` (object)
2385
+ ##### `html` (object)
1357
2386
 
1358
- Properties of the `math` object:
2387
+ Properties of the `html` object:
1359
2388
 
1360
2389
  ###### `disabled` (boolean)
1361
2390
 
1362
2391
  Indicates if the plugin is disabled or not
1363
2392
 
1364
- ##### `audio` (object)
2393
+ ##### `italic` (object)
1365
2394
 
1366
- Properties of the `audio` object:
2395
+ Properties of the `italic` object:
1367
2396
 
1368
2397
  ###### `disabled` (boolean)
1369
2398
 
1370
2399
  Indicates if the plugin is disabled or not
1371
2400
 
1372
- ##### `video` (object)
2401
+ ##### `ol_list` (object)
1373
2402
 
1374
- Properties of the `video` object:
2403
+ Properties of the `ol_list` object:
1375
2404
 
1376
2405
  ###### `disabled` (boolean)
1377
2406
 
1378
2407
  Indicates if the plugin is disabled or not
1379
2408
 
1380
- ##### `image` (object)
2409
+ ##### `redo` (object)
1381
2410
 
1382
- Properties of the `image` object:
2411
+ Properties of the `redo` object:
1383
2412
 
1384
2413
  ###### `disabled` (boolean)
1385
2414
 
1386
2415
  Indicates if the plugin is disabled or not
1387
2416
 
1388
- ##### `customPlugins` (array)
2417
+ ##### `strikethrough` (object)
1389
2418
 
1390
- An array of objects that determine custom plugins.
1391
- 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).
1392
- Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
2419
+ Properties of the `strikethrough` object:
1393
2420
 
1394
- The object is an array with all elements of the type `object`.
2421
+ ###### `disabled` (boolean)
1395
2422
 
1396
- The array object has the following properties:
2423
+ Indicates if the plugin is disabled or not
1397
2424
 
1398
- ###### `event` (string, required)
2425
+ ##### `sub` (object)
1399
2426
 
1400
- The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
1401
- PIE will emit the event prefixed with "PIE-".
1402
- Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
2427
+ Properties of the `sub` object:
1403
2428
 
1404
- ###### `iconAlt` (string, required)
2429
+ ###### `disabled` (boolean)
1405
2430
 
1406
- The alt for the custom button icon
2431
+ Indicates if the plugin is disabled or not
1407
2432
 
1408
- ###### `iconType` (string, required)
2433
+ ##### `sup` (object)
1409
2434
 
1410
- The icon type.
1411
- Currently, only "SVG" is supported.
2435
+ Properties of the `sup` object:
1412
2436
 
1413
- ###### `icon` (string, required)
2437
+ ###### `disabled` (boolean)
1414
2438
 
1415
- The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
2439
+ Indicates if the plugin is disabled or not
1416
2440
 
1417
- ##### `blockquote` (object)
2441
+ ##### `table` (object)
1418
2442
 
1419
- Properties of the `blockquote` object:
2443
+ Properties of the `table` object:
1420
2444
 
1421
2445
  ###### `disabled` (boolean)
1422
2446
 
1423
2447
  Indicates if the plugin is disabled or not
1424
2448
 
1425
- ##### `h3` (object)
2449
+ ##### `ul_list` (object)
1426
2450
 
1427
- Properties of the `h3` object:
2451
+ Properties of the `ul_list` object:
2452
+
2453
+ ###### `disabled` (boolean)
2454
+
2455
+ Indicates if the plugin is disabled or not
2456
+
2457
+ ##### `underline` (object)
2458
+
2459
+ Properties of the `underline` object:
2460
+
2461
+ ###### `disabled` (boolean)
2462
+
2463
+ Indicates if the plugin is disabled or not
2464
+
2465
+ ##### `undo` (object)
2466
+
2467
+ Properties of the `undo` object:
1428
2468
 
1429
2469
  ###### `disabled` (boolean)
1430
2470
 
@@ -1688,6 +2728,110 @@ Properties of the `h3` object:
1688
2728
 
1689
2729
  Indicates if the plugin is disabled or not
1690
2730
 
2731
+ #### `languageCharacters` (object)
2732
+
2733
+ Properties of the `languageCharacters` object:
2734
+
2735
+ ##### `disabled` (boolean)
2736
+
2737
+ Indicates if the plugin is disabled or not
2738
+
2739
+ #### `bold` (object)
2740
+
2741
+ Properties of the `bold` object:
2742
+
2743
+ ##### `disabled` (boolean)
2744
+
2745
+ Indicates if the plugin is disabled or not
2746
+
2747
+ #### `html` (object)
2748
+
2749
+ Properties of the `html` object:
2750
+
2751
+ ##### `disabled` (boolean)
2752
+
2753
+ Indicates if the plugin is disabled or not
2754
+
2755
+ #### `italic` (object)
2756
+
2757
+ Properties of the `italic` object:
2758
+
2759
+ ##### `disabled` (boolean)
2760
+
2761
+ Indicates if the plugin is disabled or not
2762
+
2763
+ #### `ol_list` (object)
2764
+
2765
+ Properties of the `ol_list` object:
2766
+
2767
+ ##### `disabled` (boolean)
2768
+
2769
+ Indicates if the plugin is disabled or not
2770
+
2771
+ #### `redo` (object)
2772
+
2773
+ Properties of the `redo` object:
2774
+
2775
+ ##### `disabled` (boolean)
2776
+
2777
+ Indicates if the plugin is disabled or not
2778
+
2779
+ #### `strikethrough` (object)
2780
+
2781
+ Properties of the `strikethrough` object:
2782
+
2783
+ ##### `disabled` (boolean)
2784
+
2785
+ Indicates if the plugin is disabled or not
2786
+
2787
+ #### `sub` (object)
2788
+
2789
+ Properties of the `sub` object:
2790
+
2791
+ ##### `disabled` (boolean)
2792
+
2793
+ Indicates if the plugin is disabled or not
2794
+
2795
+ #### `sup` (object)
2796
+
2797
+ Properties of the `sup` object:
2798
+
2799
+ ##### `disabled` (boolean)
2800
+
2801
+ Indicates if the plugin is disabled or not
2802
+
2803
+ #### `table` (object)
2804
+
2805
+ Properties of the `table` object:
2806
+
2807
+ ##### `disabled` (boolean)
2808
+
2809
+ Indicates if the plugin is disabled or not
2810
+
2811
+ #### `ul_list` (object)
2812
+
2813
+ Properties of the `ul_list` object:
2814
+
2815
+ ##### `disabled` (boolean)
2816
+
2817
+ Indicates if the plugin is disabled or not
2818
+
2819
+ #### `underline` (object)
2820
+
2821
+ Properties of the `underline` object:
2822
+
2823
+ ##### `disabled` (boolean)
2824
+
2825
+ Indicates if the plugin is disabled or not
2826
+
2827
+ #### `undo` (object)
2828
+
2829
+ Properties of the `undo` object:
2830
+
2831
+ ##### `disabled` (boolean)
2832
+
2833
+ Indicates if the plugin is disabled or not
2834
+
1691
2835
  ### `settings` (boolean)
1692
2836
 
1693
2837
  Indicates if the item has to be displayed in the Settings Panel
@@ -1853,6 +2997,110 @@ Properties of the `h3` object:
1853
2997
 
1854
2998
  Indicates if the plugin is disabled or not
1855
2999
 
3000
+ ##### `languageCharacters` (object)
3001
+
3002
+ Properties of the `languageCharacters` object:
3003
+
3004
+ ###### `disabled` (boolean)
3005
+
3006
+ Indicates if the plugin is disabled or not
3007
+
3008
+ ##### `bold` (object)
3009
+
3010
+ Properties of the `bold` object:
3011
+
3012
+ ###### `disabled` (boolean)
3013
+
3014
+ Indicates if the plugin is disabled or not
3015
+
3016
+ ##### `html` (object)
3017
+
3018
+ Properties of the `html` object:
3019
+
3020
+ ###### `disabled` (boolean)
3021
+
3022
+ Indicates if the plugin is disabled or not
3023
+
3024
+ ##### `italic` (object)
3025
+
3026
+ Properties of the `italic` object:
3027
+
3028
+ ###### `disabled` (boolean)
3029
+
3030
+ Indicates if the plugin is disabled or not
3031
+
3032
+ ##### `ol_list` (object)
3033
+
3034
+ Properties of the `ol_list` object:
3035
+
3036
+ ###### `disabled` (boolean)
3037
+
3038
+ Indicates if the plugin is disabled or not
3039
+
3040
+ ##### `redo` (object)
3041
+
3042
+ Properties of the `redo` object:
3043
+
3044
+ ###### `disabled` (boolean)
3045
+
3046
+ Indicates if the plugin is disabled or not
3047
+
3048
+ ##### `strikethrough` (object)
3049
+
3050
+ Properties of the `strikethrough` object:
3051
+
3052
+ ###### `disabled` (boolean)
3053
+
3054
+ Indicates if the plugin is disabled or not
3055
+
3056
+ ##### `sub` (object)
3057
+
3058
+ Properties of the `sub` object:
3059
+
3060
+ ###### `disabled` (boolean)
3061
+
3062
+ Indicates if the plugin is disabled or not
3063
+
3064
+ ##### `sup` (object)
3065
+
3066
+ Properties of the `sup` object:
3067
+
3068
+ ###### `disabled` (boolean)
3069
+
3070
+ Indicates if the plugin is disabled or not
3071
+
3072
+ ##### `table` (object)
3073
+
3074
+ Properties of the `table` object:
3075
+
3076
+ ###### `disabled` (boolean)
3077
+
3078
+ Indicates if the plugin is disabled or not
3079
+
3080
+ ##### `ul_list` (object)
3081
+
3082
+ Properties of the `ul_list` object:
3083
+
3084
+ ###### `disabled` (boolean)
3085
+
3086
+ Indicates if the plugin is disabled or not
3087
+
3088
+ ##### `underline` (object)
3089
+
3090
+ Properties of the `underline` object:
3091
+
3092
+ ###### `disabled` (boolean)
3093
+
3094
+ Indicates if the plugin is disabled or not
3095
+
3096
+ ##### `undo` (object)
3097
+
3098
+ Properties of the `undo` object:
3099
+
3100
+ ###### `disabled` (boolean)
3101
+
3102
+ Indicates if the plugin is disabled or not
3103
+
1856
3104
  #### `settings` (boolean)
1857
3105
 
1858
3106
  Indicates if the item has to be displayed in the Settings Panel