@pie-element/placement-ordering 9.8.1-next.5 → 9.9.1-next.4
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.
- package/CHANGELOG.md +11 -0
- package/configure/CHANGELOG.md +11 -0
- package/configure/lib/choice-editor.js +3 -3
- package/configure/lib/choice-editor.js.map +1 -1
- package/configure/lib/choice-tile.js +3 -14
- package/configure/lib/choice-tile.js.map +1 -1
- package/configure/lib/defaults.js +71 -5
- package/configure/lib/defaults.js.map +1 -1
- package/configure/lib/design.js +17 -1
- package/configure/lib/design.js.map +1 -1
- package/configure/package.json +1 -1
- package/docs/config-schema.json +848 -11
- package/docs/config-schema.json.md +628 -4
- package/docs/pie-schema.json +322 -2
- package/docs/pie-schema.json.md +240 -2
- package/package.json +2 -2
package/docs/pie-schema.json
CHANGED
|
@@ -401,6 +401,239 @@
|
|
|
401
401
|
"teacherInstructionsEnabled"
|
|
402
402
|
],
|
|
403
403
|
"definitions": {
|
|
404
|
+
"EditableHtmlConfigureProp": {
|
|
405
|
+
"title": "EditableHtmlConfigureProp",
|
|
406
|
+
"type": "object",
|
|
407
|
+
"properties": {
|
|
408
|
+
"math": {
|
|
409
|
+
"title": "EditableHtmlButtonConfigure",
|
|
410
|
+
"type": "object",
|
|
411
|
+
"properties": {
|
|
412
|
+
"disabled": {
|
|
413
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
414
|
+
"type": "boolean",
|
|
415
|
+
"title": "disabled"
|
|
416
|
+
}
|
|
417
|
+
}
|
|
418
|
+
},
|
|
419
|
+
"audio": {
|
|
420
|
+
"title": "EditableHtmlButtonConfigure",
|
|
421
|
+
"type": "object",
|
|
422
|
+
"properties": {
|
|
423
|
+
"disabled": {
|
|
424
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
425
|
+
"type": "boolean",
|
|
426
|
+
"title": "disabled"
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
},
|
|
430
|
+
"video": {
|
|
431
|
+
"title": "EditableHtmlButtonConfigure",
|
|
432
|
+
"type": "object",
|
|
433
|
+
"properties": {
|
|
434
|
+
"disabled": {
|
|
435
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
436
|
+
"type": "boolean",
|
|
437
|
+
"title": "disabled"
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
},
|
|
441
|
+
"image": {
|
|
442
|
+
"title": "EditableHtmlButtonConfigure",
|
|
443
|
+
"type": "object",
|
|
444
|
+
"properties": {
|
|
445
|
+
"disabled": {
|
|
446
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
447
|
+
"type": "boolean",
|
|
448
|
+
"title": "disabled"
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
},
|
|
452
|
+
"customPlugins": {
|
|
453
|
+
"description": "An array of objects that determine custom plugins.\nA 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).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
454
|
+
"type": "array",
|
|
455
|
+
"items": {
|
|
456
|
+
"title": "CustomPlugin",
|
|
457
|
+
"type": "object",
|
|
458
|
+
"properties": {
|
|
459
|
+
"event": {
|
|
460
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
461
|
+
"type": "string",
|
|
462
|
+
"title": "event"
|
|
463
|
+
},
|
|
464
|
+
"iconAlt": {
|
|
465
|
+
"description": "The alt for the custom button icon",
|
|
466
|
+
"type": "string",
|
|
467
|
+
"title": "iconAlt"
|
|
468
|
+
},
|
|
469
|
+
"iconType": {
|
|
470
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
471
|
+
"type": "string",
|
|
472
|
+
"title": "iconType"
|
|
473
|
+
},
|
|
474
|
+
"icon": {
|
|
475
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
476
|
+
"type": "string",
|
|
477
|
+
"title": "icon"
|
|
478
|
+
}
|
|
479
|
+
},
|
|
480
|
+
"required": [
|
|
481
|
+
"event",
|
|
482
|
+
"icon",
|
|
483
|
+
"iconAlt",
|
|
484
|
+
"iconType"
|
|
485
|
+
]
|
|
486
|
+
},
|
|
487
|
+
"title": "customPlugins"
|
|
488
|
+
}
|
|
489
|
+
}
|
|
490
|
+
},
|
|
491
|
+
"EditableHtmlButtonConfigure": {
|
|
492
|
+
"title": "EditableHtmlButtonConfigure",
|
|
493
|
+
"type": "object",
|
|
494
|
+
"properties": {
|
|
495
|
+
"disabled": {
|
|
496
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
497
|
+
"type": "boolean",
|
|
498
|
+
"title": "disabled"
|
|
499
|
+
}
|
|
500
|
+
}
|
|
501
|
+
},
|
|
502
|
+
"CustomPlugin": {
|
|
503
|
+
"title": "CustomPlugin",
|
|
504
|
+
"type": "object",
|
|
505
|
+
"properties": {
|
|
506
|
+
"event": {
|
|
507
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
508
|
+
"type": "string",
|
|
509
|
+
"title": "event"
|
|
510
|
+
},
|
|
511
|
+
"iconAlt": {
|
|
512
|
+
"description": "The alt for the custom button icon",
|
|
513
|
+
"type": "string",
|
|
514
|
+
"title": "iconAlt"
|
|
515
|
+
},
|
|
516
|
+
"iconType": {
|
|
517
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
518
|
+
"type": "string",
|
|
519
|
+
"title": "iconType"
|
|
520
|
+
},
|
|
521
|
+
"icon": {
|
|
522
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
523
|
+
"type": "string",
|
|
524
|
+
"title": "icon"
|
|
525
|
+
}
|
|
526
|
+
},
|
|
527
|
+
"required": [
|
|
528
|
+
"event",
|
|
529
|
+
"icon",
|
|
530
|
+
"iconAlt",
|
|
531
|
+
"iconType"
|
|
532
|
+
]
|
|
533
|
+
},
|
|
534
|
+
"EditableHtmlPluginConfigure": {
|
|
535
|
+
"title": "EditableHtmlPluginConfigure",
|
|
536
|
+
"type": "object",
|
|
537
|
+
"properties": {
|
|
538
|
+
"inputConfiguration": {
|
|
539
|
+
"title": "EditableHtmlConfigureProp",
|
|
540
|
+
"type": "object",
|
|
541
|
+
"properties": {
|
|
542
|
+
"math": {
|
|
543
|
+
"title": "EditableHtmlButtonConfigure",
|
|
544
|
+
"type": "object",
|
|
545
|
+
"properties": {
|
|
546
|
+
"disabled": {
|
|
547
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
548
|
+
"type": "boolean",
|
|
549
|
+
"title": "disabled"
|
|
550
|
+
}
|
|
551
|
+
}
|
|
552
|
+
},
|
|
553
|
+
"audio": {
|
|
554
|
+
"title": "EditableHtmlButtonConfigure",
|
|
555
|
+
"type": "object",
|
|
556
|
+
"properties": {
|
|
557
|
+
"disabled": {
|
|
558
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
559
|
+
"type": "boolean",
|
|
560
|
+
"title": "disabled"
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
"video": {
|
|
565
|
+
"title": "EditableHtmlButtonConfigure",
|
|
566
|
+
"type": "object",
|
|
567
|
+
"properties": {
|
|
568
|
+
"disabled": {
|
|
569
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
570
|
+
"type": "boolean",
|
|
571
|
+
"title": "disabled"
|
|
572
|
+
}
|
|
573
|
+
}
|
|
574
|
+
},
|
|
575
|
+
"image": {
|
|
576
|
+
"title": "EditableHtmlButtonConfigure",
|
|
577
|
+
"type": "object",
|
|
578
|
+
"properties": {
|
|
579
|
+
"disabled": {
|
|
580
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
581
|
+
"type": "boolean",
|
|
582
|
+
"title": "disabled"
|
|
583
|
+
}
|
|
584
|
+
}
|
|
585
|
+
},
|
|
586
|
+
"customPlugins": {
|
|
587
|
+
"description": "An array of objects that determine custom plugins.\nA 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).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
588
|
+
"type": "array",
|
|
589
|
+
"items": {
|
|
590
|
+
"title": "CustomPlugin",
|
|
591
|
+
"type": "object",
|
|
592
|
+
"properties": {
|
|
593
|
+
"event": {
|
|
594
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
595
|
+
"type": "string",
|
|
596
|
+
"title": "event"
|
|
597
|
+
},
|
|
598
|
+
"iconAlt": {
|
|
599
|
+
"description": "The alt for the custom button icon",
|
|
600
|
+
"type": "string",
|
|
601
|
+
"title": "iconAlt"
|
|
602
|
+
},
|
|
603
|
+
"iconType": {
|
|
604
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
605
|
+
"type": "string",
|
|
606
|
+
"title": "iconType"
|
|
607
|
+
},
|
|
608
|
+
"icon": {
|
|
609
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
610
|
+
"type": "string",
|
|
611
|
+
"title": "icon"
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"required": [
|
|
615
|
+
"event",
|
|
616
|
+
"icon",
|
|
617
|
+
"iconAlt",
|
|
618
|
+
"iconType"
|
|
619
|
+
]
|
|
620
|
+
},
|
|
621
|
+
"title": "customPlugins"
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
"settings": {
|
|
626
|
+
"description": "Indicates if the item has to be displayed in the Settings Panel",
|
|
627
|
+
"type": "boolean",
|
|
628
|
+
"title": "settings"
|
|
629
|
+
},
|
|
630
|
+
"label": {
|
|
631
|
+
"description": "Indicates the label for the item that has to be displayed in the Settings Panel",
|
|
632
|
+
"type": "string",
|
|
633
|
+
"title": "label"
|
|
634
|
+
}
|
|
635
|
+
}
|
|
636
|
+
},
|
|
404
637
|
"ConfigureProp": {
|
|
405
638
|
"title": "ConfigureProp",
|
|
406
639
|
"type": "object",
|
|
@@ -417,10 +650,97 @@
|
|
|
417
650
|
}
|
|
418
651
|
}
|
|
419
652
|
},
|
|
420
|
-
"
|
|
421
|
-
"title": "
|
|
653
|
+
"EditableHtmlPluginConfigureRequired": {
|
|
654
|
+
"title": "EditableHtmlPluginConfigureRequired",
|
|
422
655
|
"type": "object",
|
|
423
656
|
"properties": {
|
|
657
|
+
"inputConfiguration": {
|
|
658
|
+
"title": "EditableHtmlConfigureProp",
|
|
659
|
+
"type": "object",
|
|
660
|
+
"properties": {
|
|
661
|
+
"math": {
|
|
662
|
+
"title": "EditableHtmlButtonConfigure",
|
|
663
|
+
"type": "object",
|
|
664
|
+
"properties": {
|
|
665
|
+
"disabled": {
|
|
666
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
667
|
+
"type": "boolean",
|
|
668
|
+
"title": "disabled"
|
|
669
|
+
}
|
|
670
|
+
}
|
|
671
|
+
},
|
|
672
|
+
"audio": {
|
|
673
|
+
"title": "EditableHtmlButtonConfigure",
|
|
674
|
+
"type": "object",
|
|
675
|
+
"properties": {
|
|
676
|
+
"disabled": {
|
|
677
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
678
|
+
"type": "boolean",
|
|
679
|
+
"title": "disabled"
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
},
|
|
683
|
+
"video": {
|
|
684
|
+
"title": "EditableHtmlButtonConfigure",
|
|
685
|
+
"type": "object",
|
|
686
|
+
"properties": {
|
|
687
|
+
"disabled": {
|
|
688
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
689
|
+
"type": "boolean",
|
|
690
|
+
"title": "disabled"
|
|
691
|
+
}
|
|
692
|
+
}
|
|
693
|
+
},
|
|
694
|
+
"image": {
|
|
695
|
+
"title": "EditableHtmlButtonConfigure",
|
|
696
|
+
"type": "object",
|
|
697
|
+
"properties": {
|
|
698
|
+
"disabled": {
|
|
699
|
+
"description": "Indicates if the plugin is disabled or not",
|
|
700
|
+
"type": "boolean",
|
|
701
|
+
"title": "disabled"
|
|
702
|
+
}
|
|
703
|
+
}
|
|
704
|
+
},
|
|
705
|
+
"customPlugins": {
|
|
706
|
+
"description": "An array of objects that determine custom plugins.\nA 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).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
|
|
707
|
+
"type": "array",
|
|
708
|
+
"items": {
|
|
709
|
+
"title": "CustomPlugin",
|
|
710
|
+
"type": "object",
|
|
711
|
+
"properties": {
|
|
712
|
+
"event": {
|
|
713
|
+
"description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
|
|
714
|
+
"type": "string",
|
|
715
|
+
"title": "event"
|
|
716
|
+
},
|
|
717
|
+
"iconAlt": {
|
|
718
|
+
"description": "The alt for the custom button icon",
|
|
719
|
+
"type": "string",
|
|
720
|
+
"title": "iconAlt"
|
|
721
|
+
},
|
|
722
|
+
"iconType": {
|
|
723
|
+
"description": "The icon type.\nCurrently, only \"SVG\" is supported.",
|
|
724
|
+
"type": "string",
|
|
725
|
+
"title": "iconType"
|
|
726
|
+
},
|
|
727
|
+
"icon": {
|
|
728
|
+
"description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
|
|
729
|
+
"type": "string",
|
|
730
|
+
"title": "icon"
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"required": [
|
|
734
|
+
"event",
|
|
735
|
+
"icon",
|
|
736
|
+
"iconAlt",
|
|
737
|
+
"iconType"
|
|
738
|
+
]
|
|
739
|
+
},
|
|
740
|
+
"title": "customPlugins"
|
|
741
|
+
}
|
|
742
|
+
}
|
|
743
|
+
},
|
|
424
744
|
"required": {
|
|
425
745
|
"description": "Indicates if the item is required and the value cannot be empty",
|
|
426
746
|
"type": "boolean",
|
package/docs/pie-schema.json.md
CHANGED
|
@@ -197,6 +197,179 @@ The html Element tag name
|
|
|
197
197
|
|
|
198
198
|
The schema defines the following additional types:
|
|
199
199
|
|
|
200
|
+
## `EditableHtmlConfigureProp` (object)
|
|
201
|
+
|
|
202
|
+
Properties of the `EditableHtmlConfigureProp` object:
|
|
203
|
+
|
|
204
|
+
### `math` (object)
|
|
205
|
+
|
|
206
|
+
Properties of the `math` object:
|
|
207
|
+
|
|
208
|
+
#### `disabled` (boolean)
|
|
209
|
+
|
|
210
|
+
Indicates if the plugin is disabled or not
|
|
211
|
+
|
|
212
|
+
### `audio` (object)
|
|
213
|
+
|
|
214
|
+
Properties of the `audio` object:
|
|
215
|
+
|
|
216
|
+
#### `disabled` (boolean)
|
|
217
|
+
|
|
218
|
+
Indicates if the plugin is disabled or not
|
|
219
|
+
|
|
220
|
+
### `video` (object)
|
|
221
|
+
|
|
222
|
+
Properties of the `video` object:
|
|
223
|
+
|
|
224
|
+
#### `disabled` (boolean)
|
|
225
|
+
|
|
226
|
+
Indicates if the plugin is disabled or not
|
|
227
|
+
|
|
228
|
+
### `image` (object)
|
|
229
|
+
|
|
230
|
+
Properties of the `image` object:
|
|
231
|
+
|
|
232
|
+
#### `disabled` (boolean)
|
|
233
|
+
|
|
234
|
+
Indicates if the plugin is disabled or not
|
|
235
|
+
|
|
236
|
+
### `customPlugins` (array)
|
|
237
|
+
|
|
238
|
+
An array of objects that determine custom plugins.
|
|
239
|
+
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).
|
|
240
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
241
|
+
|
|
242
|
+
The object is an array with all elements of the type `object`.
|
|
243
|
+
|
|
244
|
+
The array object has the following properties:
|
|
245
|
+
|
|
246
|
+
#### `event` (string, required)
|
|
247
|
+
|
|
248
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
249
|
+
PIE will emit the event prefixed with "PIE-".
|
|
250
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
251
|
+
|
|
252
|
+
#### `iconAlt` (string, required)
|
|
253
|
+
|
|
254
|
+
The alt for the custom button icon
|
|
255
|
+
|
|
256
|
+
#### `iconType` (string, required)
|
|
257
|
+
|
|
258
|
+
The icon type.
|
|
259
|
+
Currently, only "SVG" is supported.
|
|
260
|
+
|
|
261
|
+
#### `icon` (string, required)
|
|
262
|
+
|
|
263
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
264
|
+
|
|
265
|
+
## `EditableHtmlButtonConfigure` (object)
|
|
266
|
+
|
|
267
|
+
Properties of the `EditableHtmlButtonConfigure` object:
|
|
268
|
+
|
|
269
|
+
### `disabled` (boolean)
|
|
270
|
+
|
|
271
|
+
Indicates if the plugin is disabled or not
|
|
272
|
+
|
|
273
|
+
## `CustomPlugin` (object)
|
|
274
|
+
|
|
275
|
+
Properties of the `CustomPlugin` object:
|
|
276
|
+
|
|
277
|
+
### `event` (string, required)
|
|
278
|
+
|
|
279
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
280
|
+
PIE will emit the event prefixed with "PIE-".
|
|
281
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
282
|
+
|
|
283
|
+
### `iconAlt` (string, required)
|
|
284
|
+
|
|
285
|
+
The alt for the custom button icon
|
|
286
|
+
|
|
287
|
+
### `iconType` (string, required)
|
|
288
|
+
|
|
289
|
+
The icon type.
|
|
290
|
+
Currently, only "SVG" is supported.
|
|
291
|
+
|
|
292
|
+
### `icon` (string, required)
|
|
293
|
+
|
|
294
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
295
|
+
|
|
296
|
+
## `EditableHtmlPluginConfigure` (object)
|
|
297
|
+
|
|
298
|
+
Properties of the `EditableHtmlPluginConfigure` object:
|
|
299
|
+
|
|
300
|
+
### `inputConfiguration` (object)
|
|
301
|
+
|
|
302
|
+
Properties of the `inputConfiguration` object:
|
|
303
|
+
|
|
304
|
+
#### `math` (object)
|
|
305
|
+
|
|
306
|
+
Properties of the `math` object:
|
|
307
|
+
|
|
308
|
+
##### `disabled` (boolean)
|
|
309
|
+
|
|
310
|
+
Indicates if the plugin is disabled or not
|
|
311
|
+
|
|
312
|
+
#### `audio` (object)
|
|
313
|
+
|
|
314
|
+
Properties of the `audio` object:
|
|
315
|
+
|
|
316
|
+
##### `disabled` (boolean)
|
|
317
|
+
|
|
318
|
+
Indicates if the plugin is disabled or not
|
|
319
|
+
|
|
320
|
+
#### `video` (object)
|
|
321
|
+
|
|
322
|
+
Properties of the `video` object:
|
|
323
|
+
|
|
324
|
+
##### `disabled` (boolean)
|
|
325
|
+
|
|
326
|
+
Indicates if the plugin is disabled or not
|
|
327
|
+
|
|
328
|
+
#### `image` (object)
|
|
329
|
+
|
|
330
|
+
Properties of the `image` object:
|
|
331
|
+
|
|
332
|
+
##### `disabled` (boolean)
|
|
333
|
+
|
|
334
|
+
Indicates if the plugin is disabled or not
|
|
335
|
+
|
|
336
|
+
#### `customPlugins` (array)
|
|
337
|
+
|
|
338
|
+
An array of objects that determine custom plugins.
|
|
339
|
+
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).
|
|
340
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
341
|
+
|
|
342
|
+
The object is an array with all elements of the type `object`.
|
|
343
|
+
|
|
344
|
+
The array object has the following properties:
|
|
345
|
+
|
|
346
|
+
##### `event` (string, required)
|
|
347
|
+
|
|
348
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
349
|
+
PIE will emit the event prefixed with "PIE-".
|
|
350
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
351
|
+
|
|
352
|
+
##### `iconAlt` (string, required)
|
|
353
|
+
|
|
354
|
+
The alt for the custom button icon
|
|
355
|
+
|
|
356
|
+
##### `iconType` (string, required)
|
|
357
|
+
|
|
358
|
+
The icon type.
|
|
359
|
+
Currently, only "SVG" is supported.
|
|
360
|
+
|
|
361
|
+
##### `icon` (string, required)
|
|
362
|
+
|
|
363
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
364
|
+
|
|
365
|
+
### `settings` (boolean)
|
|
366
|
+
|
|
367
|
+
Indicates if the item has to be displayed in the Settings Panel
|
|
368
|
+
|
|
369
|
+
### `label` (string)
|
|
370
|
+
|
|
371
|
+
Indicates the label for the item that has to be displayed in the Settings Panel
|
|
372
|
+
|
|
200
373
|
## `ConfigureProp` (object)
|
|
201
374
|
|
|
202
375
|
Properties of the `ConfigureProp` object:
|
|
@@ -209,9 +382,74 @@ Indicates if the item has to be displayed in the Settings Panel
|
|
|
209
382
|
|
|
210
383
|
Indicates the label for the item that has to be displayed in the Settings Panel
|
|
211
384
|
|
|
212
|
-
## `
|
|
385
|
+
## `EditableHtmlPluginConfigureRequired` (object)
|
|
386
|
+
|
|
387
|
+
Properties of the `EditableHtmlPluginConfigureRequired` object:
|
|
388
|
+
|
|
389
|
+
### `inputConfiguration` (object)
|
|
390
|
+
|
|
391
|
+
Properties of the `inputConfiguration` object:
|
|
392
|
+
|
|
393
|
+
#### `math` (object)
|
|
394
|
+
|
|
395
|
+
Properties of the `math` object:
|
|
396
|
+
|
|
397
|
+
##### `disabled` (boolean)
|
|
398
|
+
|
|
399
|
+
Indicates if the plugin is disabled or not
|
|
400
|
+
|
|
401
|
+
#### `audio` (object)
|
|
402
|
+
|
|
403
|
+
Properties of the `audio` object:
|
|
404
|
+
|
|
405
|
+
##### `disabled` (boolean)
|
|
406
|
+
|
|
407
|
+
Indicates if the plugin is disabled or not
|
|
408
|
+
|
|
409
|
+
#### `video` (object)
|
|
410
|
+
|
|
411
|
+
Properties of the `video` object:
|
|
412
|
+
|
|
413
|
+
##### `disabled` (boolean)
|
|
414
|
+
|
|
415
|
+
Indicates if the plugin is disabled or not
|
|
416
|
+
|
|
417
|
+
#### `image` (object)
|
|
418
|
+
|
|
419
|
+
Properties of the `image` object:
|
|
420
|
+
|
|
421
|
+
##### `disabled` (boolean)
|
|
422
|
+
|
|
423
|
+
Indicates if the plugin is disabled or not
|
|
424
|
+
|
|
425
|
+
#### `customPlugins` (array)
|
|
426
|
+
|
|
427
|
+
An array of objects that determine custom plugins.
|
|
428
|
+
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).
|
|
429
|
+
Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
|
|
430
|
+
|
|
431
|
+
The object is an array with all elements of the type `object`.
|
|
432
|
+
|
|
433
|
+
The array object has the following properties:
|
|
434
|
+
|
|
435
|
+
##### `event` (string, required)
|
|
436
|
+
|
|
437
|
+
The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
|
|
438
|
+
PIE will emit the event prefixed with "PIE-".
|
|
439
|
+
Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
|
|
440
|
+
|
|
441
|
+
##### `iconAlt` (string, required)
|
|
442
|
+
|
|
443
|
+
The alt for the custom button icon
|
|
444
|
+
|
|
445
|
+
##### `iconType` (string, required)
|
|
446
|
+
|
|
447
|
+
The icon type.
|
|
448
|
+
Currently, only "SVG" is supported.
|
|
449
|
+
|
|
450
|
+
##### `icon` (string, required)
|
|
213
451
|
|
|
214
|
-
|
|
452
|
+
The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
|
|
215
453
|
|
|
216
454
|
### `required` (boolean)
|
|
217
455
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pie-element/placement-ordering",
|
|
3
|
-
"version": "9.
|
|
3
|
+
"version": "9.9.1-next.4+44cb8eb36",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": "pie-framework/pie-elements",
|
|
6
6
|
"publishConfig": {
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
},
|
|
23
23
|
"author": "",
|
|
24
24
|
"license": "ISC",
|
|
25
|
-
"gitHead": "
|
|
25
|
+
"gitHead": "44cb8eb36e997cd5218007c604c8d94137022f6e",
|
|
26
26
|
"scripts": {
|
|
27
27
|
"postpublish": "../../scripts/postpublish"
|
|
28
28
|
},
|