@pie-element/matrix 0.27.1-next.0 → 0.27.1-next.16

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.
@@ -50,6 +50,43 @@
50
50
  "title": "disabled"
51
51
  }
52
52
  }
53
+ },
54
+ "customPlugins": {
55
+ "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.",
56
+ "type": "array",
57
+ "items": {
58
+ "title": "CustomPlugin",
59
+ "type": "object",
60
+ "properties": {
61
+ "event": {
62
+ "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\"",
63
+ "type": "string",
64
+ "title": "event"
65
+ },
66
+ "iconAlt": {
67
+ "description": "The alt for the custom button icon",
68
+ "type": "string",
69
+ "title": "iconAlt"
70
+ },
71
+ "iconType": {
72
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
73
+ "type": "string",
74
+ "title": "iconType"
75
+ },
76
+ "icon": {
77
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
78
+ "type": "string",
79
+ "title": "icon"
80
+ }
81
+ },
82
+ "required": [
83
+ "event",
84
+ "icon",
85
+ "iconAlt",
86
+ "iconType"
87
+ ]
88
+ },
89
+ "title": "customPlugins"
53
90
  }
54
91
  }
55
92
  },
@@ -125,6 +162,43 @@
125
162
  "title": "disabled"
126
163
  }
127
164
  }
165
+ },
166
+ "customPlugins": {
167
+ "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.",
168
+ "type": "array",
169
+ "items": {
170
+ "title": "CustomPlugin",
171
+ "type": "object",
172
+ "properties": {
173
+ "event": {
174
+ "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\"",
175
+ "type": "string",
176
+ "title": "event"
177
+ },
178
+ "iconAlt": {
179
+ "description": "The alt for the custom button icon",
180
+ "type": "string",
181
+ "title": "iconAlt"
182
+ },
183
+ "iconType": {
184
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
185
+ "type": "string",
186
+ "title": "iconType"
187
+ },
188
+ "icon": {
189
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
190
+ "type": "string",
191
+ "title": "icon"
192
+ }
193
+ },
194
+ "required": [
195
+ "event",
196
+ "icon",
197
+ "iconAlt",
198
+ "iconType"
199
+ ]
200
+ },
201
+ "title": "customPlugins"
128
202
  }
129
203
  }
130
204
  },
@@ -196,6 +270,43 @@
196
270
  "title": "disabled"
197
271
  }
198
272
  }
273
+ },
274
+ "customPlugins": {
275
+ "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.",
276
+ "type": "array",
277
+ "items": {
278
+ "title": "CustomPlugin",
279
+ "type": "object",
280
+ "properties": {
281
+ "event": {
282
+ "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\"",
283
+ "type": "string",
284
+ "title": "event"
285
+ },
286
+ "iconAlt": {
287
+ "description": "The alt for the custom button icon",
288
+ "type": "string",
289
+ "title": "iconAlt"
290
+ },
291
+ "iconType": {
292
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
293
+ "type": "string",
294
+ "title": "iconType"
295
+ },
296
+ "icon": {
297
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
298
+ "type": "string",
299
+ "title": "icon"
300
+ }
301
+ },
302
+ "required": [
303
+ "event",
304
+ "icon",
305
+ "iconAlt",
306
+ "iconType"
307
+ ]
308
+ },
309
+ "title": "customPlugins"
199
310
  }
200
311
  }
201
312
  },
@@ -327,6 +438,43 @@
327
438
  "title": "disabled"
328
439
  }
329
440
  }
441
+ },
442
+ "customPlugins": {
443
+ "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.",
444
+ "type": "array",
445
+ "items": {
446
+ "title": "CustomPlugin",
447
+ "type": "object",
448
+ "properties": {
449
+ "event": {
450
+ "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\"",
451
+ "type": "string",
452
+ "title": "event"
453
+ },
454
+ "iconAlt": {
455
+ "description": "The alt for the custom button icon",
456
+ "type": "string",
457
+ "title": "iconAlt"
458
+ },
459
+ "iconType": {
460
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
461
+ "type": "string",
462
+ "title": "iconType"
463
+ },
464
+ "icon": {
465
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
466
+ "type": "string",
467
+ "title": "icon"
468
+ }
469
+ },
470
+ "required": [
471
+ "event",
472
+ "icon",
473
+ "iconAlt",
474
+ "iconType"
475
+ ]
476
+ },
477
+ "title": "customPlugins"
330
478
  }
331
479
  }
332
480
  },
@@ -341,6 +489,38 @@
341
489
  }
342
490
  }
343
491
  },
492
+ "CustomPlugin": {
493
+ "title": "CustomPlugin",
494
+ "type": "object",
495
+ "properties": {
496
+ "event": {
497
+ "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\"",
498
+ "type": "string",
499
+ "title": "event"
500
+ },
501
+ "iconAlt": {
502
+ "description": "The alt for the custom button icon",
503
+ "type": "string",
504
+ "title": "iconAlt"
505
+ },
506
+ "iconType": {
507
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
508
+ "type": "string",
509
+ "title": "iconType"
510
+ },
511
+ "icon": {
512
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
513
+ "type": "string",
514
+ "title": "icon"
515
+ }
516
+ },
517
+ "required": [
518
+ "event",
519
+ "icon",
520
+ "iconAlt",
521
+ "iconType"
522
+ ]
523
+ },
344
524
  "ConfigureProp": {
345
525
  "title": "ConfigureProp",
346
526
  "type": "object",
@@ -408,6 +588,43 @@
408
588
  "title": "disabled"
409
589
  }
410
590
  }
591
+ },
592
+ "customPlugins": {
593
+ "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.",
594
+ "type": "array",
595
+ "items": {
596
+ "title": "CustomPlugin",
597
+ "type": "object",
598
+ "properties": {
599
+ "event": {
600
+ "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\"",
601
+ "type": "string",
602
+ "title": "event"
603
+ },
604
+ "iconAlt": {
605
+ "description": "The alt for the custom button icon",
606
+ "type": "string",
607
+ "title": "iconAlt"
608
+ },
609
+ "iconType": {
610
+ "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
611
+ "type": "string",
612
+ "title": "iconType"
613
+ },
614
+ "icon": {
615
+ "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
616
+ "type": "string",
617
+ "title": "icon"
618
+ }
619
+ },
620
+ "required": [
621
+ "event",
622
+ "icon",
623
+ "iconAlt",
624
+ "iconType"
625
+ ]
626
+ },
627
+ "title": "customPlugins"
411
628
  }
412
629
  }
413
630
  },
@@ -38,6 +38,35 @@ Properties of the `image` object:
38
38
 
39
39
  Indicates if the plugin is disabled or not
40
40
 
41
+ ## `customPlugins` (array)
42
+
43
+ An array of objects that determine custom plugins.
44
+ A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
45
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
46
+
47
+ The object is an array with all elements of the type `object`.
48
+
49
+ The array object has the following properties:
50
+
51
+ ### `event` (string, required)
52
+
53
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
54
+ PIE will emit the event prefixed with "PIE-".
55
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
56
+
57
+ ### `iconAlt` (string, required)
58
+
59
+ The alt for the custom button icon
60
+
61
+ ### `iconType` (string, required)
62
+
63
+ The icon type.
64
+ Currently, only "SVG" is supported.
65
+
66
+ ### `icon` (string, required)
67
+
68
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
69
+
41
70
  # `settingsPanelDisabled` (boolean)
42
71
 
43
72
  Indicates if the settings panel is not available
@@ -94,6 +123,35 @@ Properties of the `image` object:
94
123
 
95
124
  Indicates if the plugin is disabled or not
96
125
 
126
+ ### `customPlugins` (array)
127
+
128
+ An array of objects that determine custom plugins.
129
+ 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).
130
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
131
+
132
+ The object is an array with all elements of the type `object`.
133
+
134
+ The array object has the following properties:
135
+
136
+ #### `event` (string, required)
137
+
138
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
139
+ PIE will emit the event prefixed with "PIE-".
140
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
141
+
142
+ #### `iconAlt` (string, required)
143
+
144
+ The alt for the custom button icon
145
+
146
+ #### `iconType` (string, required)
147
+
148
+ The icon type.
149
+ Currently, only "SVG" is supported.
150
+
151
+ #### `icon` (string, required)
152
+
153
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
154
+
97
155
  ## `required` (boolean)
98
156
 
99
157
  Indicates if the item is required and the value cannot be empty
@@ -146,6 +204,35 @@ Properties of the `image` object:
146
204
 
147
205
  Indicates if the plugin is disabled or not
148
206
 
207
+ ### `customPlugins` (array)
208
+
209
+ An array of objects that determine custom plugins.
210
+ 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).
211
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
212
+
213
+ The object is an array with all elements of the type `object`.
214
+
215
+ The array object has the following properties:
216
+
217
+ #### `event` (string, required)
218
+
219
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
220
+ PIE will emit the event prefixed with "PIE-".
221
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
222
+
223
+ #### `iconAlt` (string, required)
224
+
225
+ The alt for the custom button icon
226
+
227
+ #### `iconType` (string, required)
228
+
229
+ The icon type.
230
+ Currently, only "SVG" is supported.
231
+
232
+ #### `icon` (string, required)
233
+
234
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
235
+
149
236
  ## `required` (boolean)
150
237
 
151
238
  Indicates if the item is required and the value cannot be empty
@@ -252,6 +339,35 @@ Properties of the `image` object:
252
339
 
253
340
  Indicates if the plugin is disabled or not
254
341
 
342
+ ### `customPlugins` (array)
343
+
344
+ An array of objects that determine custom plugins.
345
+ 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).
346
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
347
+
348
+ The object is an array with all elements of the type `object`.
349
+
350
+ The array object has the following properties:
351
+
352
+ #### `event` (string, required)
353
+
354
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
355
+ PIE will emit the event prefixed with "PIE-".
356
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
357
+
358
+ #### `iconAlt` (string, required)
359
+
360
+ The alt for the custom button icon
361
+
362
+ #### `iconType` (string, required)
363
+
364
+ The icon type.
365
+ Currently, only "SVG" is supported.
366
+
367
+ #### `icon` (string, required)
368
+
369
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
370
+
255
371
  ## `EditableHtmlButtonConfigure` (object)
256
372
 
257
373
  Properties of the `EditableHtmlButtonConfigure` object:
@@ -260,6 +376,29 @@ Properties of the `EditableHtmlButtonConfigure` object:
260
376
 
261
377
  Indicates if the plugin is disabled or not
262
378
 
379
+ ## `CustomPlugin` (object)
380
+
381
+ Properties of the `CustomPlugin` object:
382
+
383
+ ### `event` (string, required)
384
+
385
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
386
+ PIE will emit the event prefixed with "PIE-".
387
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
388
+
389
+ ### `iconAlt` (string, required)
390
+
391
+ The alt for the custom button icon
392
+
393
+ ### `iconType` (string, required)
394
+
395
+ The icon type.
396
+ Currently, only "SVG" is supported.
397
+
398
+ ### `icon` (string, required)
399
+
400
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
401
+
263
402
  ## `ConfigureProp` (object)
264
403
 
265
404
  Properties of the `ConfigureProp` object:
@@ -312,6 +451,35 @@ Properties of the `image` object:
312
451
 
313
452
  Indicates if the plugin is disabled or not
314
453
 
454
+ #### `customPlugins` (array)
455
+
456
+ An array of objects that determine custom plugins.
457
+ 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).
458
+ Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
459
+
460
+ The object is an array with all elements of the type `object`.
461
+
462
+ The array object has the following properties:
463
+
464
+ ##### `event` (string, required)
465
+
466
+ The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
467
+ PIE will emit the event prefixed with "PIE-".
468
+ Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
469
+
470
+ ##### `iconAlt` (string, required)
471
+
472
+ The alt for the custom button icon
473
+
474
+ ##### `iconType` (string, required)
475
+
476
+ The icon type.
477
+ Currently, only "SVG" is supported.
478
+
479
+ ##### `icon` (string, required)
480
+
481
+ The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
482
+
315
483
  ### `required` (boolean)
316
484
 
317
485
  Indicates if the item is required and the value cannot be empty
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "repository": "pie-framework/pie-elements",
7
- "version": "0.27.1-next.0+6d8f12130",
7
+ "version": "0.27.1-next.16+44cb8eb36",
8
8
  "description": "",
9
9
  "scripts": {
10
10
  "test": "echo \"Error: no test specified\" && exit 1"
@@ -21,7 +21,7 @@
21
21
  },
22
22
  "author": "",
23
23
  "license": "ISC",
24
- "gitHead": "6d8f121309d801dbe0346ec33a9eed8af766d392",
24
+ "gitHead": "44cb8eb36e997cd5218007c604c8d94137022f6e",
25
25
  "main": "lib/index.js",
26
26
  "module": "src/index.js"
27
27
  }