zinggrid-metadata 1.0.1 → 1.0.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.
@@ -5,6 +5,7 @@
5
5
  "description": "The `<zg-batch-edit>` element is used to define the batch edit region. \n`<zg-batch-edit>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-batch-edit>` using the `zg-batch-edit` selector.",
6
6
  "allowedChildren": [],
7
7
  "requiredChildren": [],
8
+ "requiredParent": [],
8
9
  "requiredAttributes": []
9
10
  },
10
11
  {
@@ -12,15 +13,28 @@
12
13
  "description": "`<zg-body>` is created dynamically by the ZingGrid library, and as such should not be manually added by the\ndeveloper. However the user can style `<zg-body>` using CSS.",
13
14
  "allowedChildren": [],
14
15
  "requiredChildren": [],
16
+ "requiredParent": [],
15
17
  "requiredAttributes": []
16
18
  },
17
19
  {
18
20
  "name": "zg-button",
19
21
  "description": "A custom, styled button that can be used both for internal grid-related action and for user-specific\nactions. It is stylable via CSS. Some buttons are automatically inserted when a feature that uses it enabled, like `pager`, while\nothers are inserted manually by the user.",
20
22
  "allowedChildren": [
21
- "zg-icon"
23
+ "zg-icon",
24
+ "*"
22
25
  ],
23
26
  "requiredChildren": [],
27
+ "requiredParent": [
28
+ "zg-caption",
29
+ "zg-card",
30
+ "zg-column",
31
+ "zg-dialog",
32
+ "zg-footer",
33
+ "zg-load-mask",
34
+ "zg-no-data",
35
+ "zg-pager",
36
+ "zg-source"
37
+ ],
24
38
  "requiredAttributes": []
25
39
  },
26
40
  {
@@ -36,6 +50,10 @@
36
50
  "*"
37
51
  ],
38
52
  "requiredChildren": [],
53
+ "requiredParent": [
54
+ "zg-footer",
55
+ "zing-grid"
56
+ ],
39
57
  "requiredAttributes": []
40
58
  },
41
59
  {
@@ -47,9 +65,13 @@
47
65
  "zg-icon",
48
66
  "zg-input",
49
67
  "zg-select",
50
- "zg-text"
68
+ "zg-text",
69
+ "*"
51
70
  ],
52
71
  "requiredChildren": [],
72
+ "requiredParent": [
73
+ "zing-grid"
74
+ ],
53
75
  "requiredAttributes": []
54
76
  },
55
77
  {
@@ -57,6 +79,7 @@
57
79
  "description": "`<zg-cell>` is the container for a single cell;\nit corresponds to the `<td>` tag on an HTML table. It is automatically inserted and should not \nbe placed directly in the user's HTML. `<zg-cell>` can be styled via CSS.",
58
80
  "allowedChildren": [],
59
81
  "requiredChildren": [],
82
+ "requiredParent": [],
60
83
  "requiredAttributes": []
61
84
  },
62
85
  {
@@ -64,6 +87,7 @@
64
87
  "description": "`<zg-cell-overflow>` elements can be used to add popup data to each cell on a user action. Typical use would\nbe a custom element select and optionlist. As a generated element, developers\nshould not manually place `<zg-cell-overflow>` in their grid; however, they may style the tooltips and\nits internal elements using CSS.",
65
88
  "allowedChildren": [],
66
89
  "requiredChildren": [],
90
+ "requiredParent": [],
67
91
  "requiredAttributes": []
68
92
  },
69
93
  {
@@ -71,6 +95,18 @@
71
95
  "description": "A checkbox is automatically inserted when\na feature that uses it is enabled, like `<zg-column type=\"selector\">`, or it can be manually-inserted\nto the grid. It can be styled via CSS.",
72
96
  "allowedChildren": [],
73
97
  "requiredChildren": [],
98
+ "requiredParent": [
99
+ "zg-caption",
100
+ "zg-card",
101
+ "zg-column",
102
+ "zg-dialog",
103
+ "zg-footer",
104
+ "zg-load-mask",
105
+ "zg-menu",
106
+ "zg-no-data",
107
+ "zg-pager",
108
+ "zg-source"
109
+ ],
74
110
  "requiredAttributes": []
75
111
  },
76
112
  {
@@ -79,7 +115,12 @@
79
115
  "allowedChildren": [
80
116
  "zg-column"
81
117
  ],
82
- "requiredChildren": [],
118
+ "requiredChildren": [
119
+ "zg-column"
120
+ ],
121
+ "requiredParent": [
122
+ "zing-grid"
123
+ ],
83
124
  "requiredAttributes": []
84
125
  },
85
126
  {
@@ -91,9 +132,13 @@
91
132
  "zg-icon",
92
133
  "zg-input",
93
134
  "zg-select",
94
- "zg-text"
135
+ "zg-text",
136
+ "*"
95
137
  ],
96
138
  "requiredChildren": [],
139
+ "requiredParent": [
140
+ "zg-colgroup"
141
+ ],
97
142
  "requiredAttributes": []
98
143
  },
99
144
  {
@@ -101,6 +146,7 @@
101
146
  "description": "The column resize handle appears when hovering over header to\nresize the column.",
102
147
  "allowedChildren": [],
103
148
  "requiredChildren": [],
149
+ "requiredParent": [],
104
150
  "requiredAttributes": []
105
151
  },
106
152
  {
@@ -108,6 +154,7 @@
108
154
  "description": "The `<zg-control-bar>` is inserted dynamically by the ZingGrid library\nand serves as a container for the grid's interface controls. As a generated element, developers\nshould not manually place `<zg-control-bar>` in their grid; however, they may style the bar and\nits internal elements using CSS.",
109
155
  "allowedChildren": [],
110
156
  "requiredChildren": [],
157
+ "requiredParent": [],
111
158
  "requiredAttributes": []
112
159
  },
113
160
  {
@@ -117,6 +164,9 @@
117
164
  "zg-param"
118
165
  ],
119
166
  "requiredChildren": [],
167
+ "requiredParent": [
168
+ "zing-grid"
169
+ ],
120
170
  "requiredAttributes": []
121
171
  },
122
172
  {
@@ -128,9 +178,13 @@
128
178
  "zg-icon",
129
179
  "zg-input",
130
180
  "zg-select",
131
- "zg-text"
181
+ "zg-text",
182
+ "*"
132
183
  ],
133
184
  "requiredChildren": [],
185
+ "requiredParent": [
186
+ "zing-grid"
187
+ ],
134
188
  "requiredAttributes": []
135
189
  },
136
190
  {
@@ -138,6 +192,7 @@
138
192
  "description": "`<zg-editor-row>` holds the details of the edit mode for the grid.\n`<zg-editor-row>` is created internally and should not be placed directly in the user's HTML.",
139
193
  "allowedChildren": [],
140
194
  "requiredChildren": [],
195
+ "requiredParent": [],
141
196
  "requiredAttributes": []
142
197
  },
143
198
  {
@@ -145,6 +200,7 @@
145
200
  "description": "`<zg-filter>` is the container for a single cell when the cell contains a filter.\n`<zg-filter>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-filter>` using the `zg-filter` selector.",
146
201
  "allowedChildren": [],
147
202
  "requiredChildren": [],
203
+ "requiredParent": [],
148
204
  "requiredAttributes": []
149
205
  },
150
206
  {
@@ -152,6 +208,7 @@
152
208
  "description": "The `<zg-filter-menu>` element is a container for the menu that appears when clicking the column filter button. \nThe element is dynamically inserted by the library.\nThe element can be styled using CSS.",
153
209
  "allowedChildren": [],
154
210
  "requiredChildren": [],
211
+ "requiredParent": [],
155
212
  "requiredAttributes": []
156
213
  },
157
214
  {
@@ -159,6 +216,7 @@
159
216
  "description": "The `<zg-focus>` element is a generated element added to `<zing-grid>`\nwhen the `selector` attribute is defined. It is used as a container for the focus of cell(s) \nand used as a CSS target for styling by the developer. It should not be accessed specifically\nbeyond styling.",
160
217
  "allowedChildren": [],
161
218
  "requiredChildren": [],
219
+ "requiredParent": [],
162
220
  "requiredAttributes": []
163
221
  },
164
222
  {
@@ -166,6 +224,7 @@
166
224
  "description": "The `<zg-foot>` tag contains the foot cells (`<zg-foot-cell>`) of the data \ngrid specified via the `foot-cell` attribute found on `<zg-column>` tags. The tag roughly\ncorresponds to the idea of the `<tfoot>` tag used in HTML tables. The `<zg-foot>` tag is \ngenerated by the library and should not be placed in a grid manually by a developer, but\ninstead is used as a styling target for CSS.",
167
225
  "allowedChildren": [],
168
226
  "requiredChildren": [],
227
+ "requiredParent": [],
169
228
  "requiredAttributes": []
170
229
  },
171
230
  {
@@ -179,9 +238,13 @@
179
238
  "zg-input",
180
239
  "zg-select",
181
240
  "zg-source",
182
- "zg-text"
241
+ "zg-text",
242
+ "*"
183
243
  ],
184
244
  "requiredChildren": [],
245
+ "requiredParent": [
246
+ "zing-grid"
247
+ ],
185
248
  "requiredAttributes": []
186
249
  },
187
250
  {
@@ -189,6 +252,7 @@
189
252
  "description": "The `<zg-frozen-colgroup>` element is used to define the frozen columns. \n`<zg-frozen-colgroup>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-frozen-colgroup>` using the `zg-frozen-colgroup` selector.",
190
253
  "allowedChildren": [],
191
254
  "requiredChildren": [],
255
+ "requiredParent": [],
192
256
  "requiredAttributes": []
193
257
  },
194
258
  {
@@ -196,6 +260,7 @@
196
260
  "description": "The `<zg-head>` tag contains the head cells (`<zg-head-cell>`) of the data grid specified via the\n`head-cell` attribute found on `<zg-column>` tags. The tag roughly corresponds to the idea of the `<thead>` tag used in\nHTML tables. The `<zg-head>` tag is generated by the library and should not be placed in a grid manually by a developer. Instead, it is used as a styling target for CSS.",
197
261
  "allowedChildren": [],
198
262
  "requiredChildren": [],
263
+ "requiredParent": [],
199
264
  "requiredAttributes": []
200
265
  },
201
266
  {
@@ -203,6 +268,7 @@
203
268
  "description": "The `<zg-head-cell>` contains header information for a column and is roughly equivalent to the `<th>` \ntag used for HTML tables. The `<zg-head-cell>` tag is generated by the library and should not be placed in a grid \nmanually by a developer. It can be used as a styling target for CSS.",
204
269
  "allowedChildren": [],
205
270
  "requiredChildren": [],
271
+ "requiredParent": [],
206
272
  "requiredAttributes": []
207
273
  },
208
274
  {
@@ -210,6 +276,7 @@
210
276
  "description": "`<zg-header>` is the semantic container placed at the top of the grid\nto hold various grid items. `<zg-header>` is created internally and should not be placed\ndirectly in the user's HTML. The element can be styled via CSS.",
211
277
  "allowedChildren": [],
212
278
  "requiredChildren": [],
279
+ "requiredParent": [],
213
280
  "requiredAttributes": []
214
281
  },
215
282
  {
@@ -217,6 +284,18 @@
217
284
  "description": "`<zg-icon>` is used to display custom ZingGrid icons within the grid. \nThe icon is set by its name, but can have a different look based on the grid's theme. \n`<zg-icon>` is created internally when a feature that uses it is enabled, like `pager`, \nbut can be included in the grid manually as long as the name attribute exists.",
218
285
  "allowedChildren": [],
219
286
  "requiredChildren": [],
287
+ "requiredParent": [
288
+ "zg-caption",
289
+ "zg-card",
290
+ "zg-column",
291
+ "zg-dialog",
292
+ "zg-footer",
293
+ "zg-load-mask",
294
+ "zg-menu",
295
+ "zg-no-data",
296
+ "zg-pager",
297
+ "zg-source"
298
+ ],
220
299
  "requiredAttributes": []
221
300
  },
222
301
  {
@@ -224,6 +303,18 @@
224
303
  "description": "`<zg-input>` contains input fields with added ZingGrid-specific functionality.\nThe specific functionality can be set via the `action` attribute.",
225
304
  "allowedChildren": [],
226
305
  "requiredChildren": [],
306
+ "requiredParent": [
307
+ "zg-caption",
308
+ "zg-card",
309
+ "zg-column",
310
+ "zg-dialog",
311
+ "zg-footer",
312
+ "zg-load-mask",
313
+ "zg-menu",
314
+ "zg-no-data",
315
+ "zg-pager",
316
+ "zg-source"
317
+ ],
227
318
  "requiredAttributes": []
228
319
  },
229
320
  {
@@ -231,6 +322,7 @@
231
322
  "description": "Allows you to switch between normal row mode and condensed card mode for the grid. \n`<zg-layout-controls>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-layout-controls>` using the `zg-layout-controls` selector.",
232
323
  "allowedChildren": [],
233
324
  "requiredChildren": [],
325
+ "requiredParent": [],
234
326
  "requiredAttributes": []
235
327
  },
236
328
  {
@@ -242,9 +334,13 @@
242
334
  "zg-icon",
243
335
  "zg-input",
244
336
  "zg-select",
245
- "zg-text"
337
+ "zg-text",
338
+ "*"
246
339
  ],
247
340
  "requiredChildren": [],
341
+ "requiredParent": [
342
+ "zing-grid"
343
+ ],
248
344
  "requiredAttributes": []
249
345
  },
250
346
  {
@@ -258,9 +354,13 @@
258
354
  "zg-menu-group",
259
355
  "zg-menu-item",
260
356
  "zg-select",
261
- "zg-text"
357
+ "zg-text",
358
+ "*"
262
359
  ],
263
360
  "requiredChildren": [],
361
+ "requiredParent": [
362
+ "zing-grid"
363
+ ],
264
364
  "requiredAttributes": []
265
365
  },
266
366
  {
@@ -269,7 +369,12 @@
269
369
  "allowedChildren": [
270
370
  "zg-menu-item"
271
371
  ],
272
- "requiredChildren": [],
372
+ "requiredChildren": [
373
+ "zg-menu-item"
374
+ ],
375
+ "requiredParent": [
376
+ "zg-menu"
377
+ ],
273
378
  "requiredAttributes": []
274
379
  },
275
380
  {
@@ -277,6 +382,10 @@
277
382
  "description": "This element defines a single menu item in ZingGrid's context \nmenu defined by `<zg-menu>`. The element is typically dynamically generated, though \nit can be overwritten by a user's own custom `<zg-menu-item>` elements. The \nelement can be styled via CSS.",
278
383
  "allowedChildren": [],
279
384
  "requiredChildren": [],
385
+ "requiredParent": [
386
+ "zg-menu",
387
+ "zg-menu-group"
388
+ ],
280
389
  "requiredAttributes": []
281
390
  },
282
391
  {
@@ -288,9 +397,13 @@
288
397
  "zg-icon",
289
398
  "zg-input",
290
399
  "zg-select",
291
- "zg-text"
400
+ "zg-text",
401
+ "*"
292
402
  ],
293
403
  "requiredChildren": [],
404
+ "requiredParent": [
405
+ "zing-grid"
406
+ ],
294
407
  "requiredAttributes": []
295
408
  },
296
409
  {
@@ -298,6 +411,7 @@
298
411
  "description": "An option's list to go within a `<zg-select>` element",
299
412
  "allowedChildren": [],
300
413
  "requiredChildren": [],
414
+ "requiredParent": [],
301
415
  "requiredAttributes": []
302
416
  },
303
417
  {
@@ -309,9 +423,13 @@
309
423
  "zg-icon",
310
424
  "zg-input",
311
425
  "zg-select",
312
- "zg-text"
426
+ "zg-text",
427
+ "*"
313
428
  ],
314
429
  "requiredChildren": [],
430
+ "requiredParent": [
431
+ "zing-grid"
432
+ ],
315
433
  "requiredAttributes": []
316
434
  },
317
435
  {
@@ -319,22 +437,33 @@
319
437
  "description": "`<zg-param>` is a non-visual element used to pass the configuration options for the `<zg-data>` \nelement more cleanly via `name`-`value` pairs. The element is not required, though it is preferred, as everything set \nwithin a `<zg-param>` element can also be set directly on `<zg-data>` via the `config` attribute. Developers should note \nthat when setting complex values for the `value` attribute to use JSON encoded values. Also, as a non-visual element, \nCSS styling does not apply to `<zg-param>`.",
320
438
  "allowedChildren": [],
321
439
  "requiredChildren": [],
322
- "requiredAttributes": []
440
+ "requiredParent": [
441
+ "zg-data"
442
+ ],
443
+ "requiredAttributes": [
444
+ "name",
445
+ "value"
446
+ ]
323
447
  },
324
448
  {
325
449
  "name": "zg-row",
326
450
  "description": "`<zg-row>` is the container for the `<zg-cell>`, `<zg-head-cell>`, and `<zg-filter>` elements.\nIt corresponds to the `<tr>` tag on an HTML table.\nThe `<zg-row>` element is created dynamically and should not be placed in the grid by a developer. \nHowever, the element is useful for styling the various rows of the grid using CSS.",
327
451
  "allowedChildren": [],
328
452
  "requiredChildren": [],
453
+ "requiredParent": [],
329
454
  "requiredAttributes": []
330
455
  },
331
456
  {
332
457
  "name": "zg-row-details",
333
458
  "description": "`<zg-row-details>` is the container for a row expansion;",
334
459
  "allowedChildren": [
335
- "zing-grid"
460
+ "zing-grid",
461
+ "*"
336
462
  ],
337
463
  "requiredChildren": [],
464
+ "requiredParent": [
465
+ "zing-grid"
466
+ ],
338
467
  "requiredAttributes": []
339
468
  },
340
469
  {
@@ -342,6 +471,7 @@
342
471
  "description": "The `<zg-search>` element is used to encapsulate the interface widget necessary for searching the grid -- \ntypically a text field and a button to trigger the search. The element is added dynamically when search is specified and \nshould not be directly inserted by the developer. The element and its contents can be styled using CSS.",
343
472
  "allowedChildren": [],
344
473
  "requiredChildren": [],
474
+ "requiredParent": [],
345
475
  "requiredAttributes": []
346
476
  },
347
477
  {
@@ -349,6 +479,18 @@
349
479
  "description": "A custom select dropdown defined by our library. The\ndropdown can be assigned different options through the `options` attribute.",
350
480
  "allowedChildren": [],
351
481
  "requiredChildren": [],
482
+ "requiredParent": [
483
+ "zg-caption",
484
+ "zg-card",
485
+ "zg-column",
486
+ "zg-dialog",
487
+ "zg-footer",
488
+ "zg-load-mask",
489
+ "zg-menu",
490
+ "zg-no-data",
491
+ "zg-pager",
492
+ "zg-source"
493
+ ],
352
494
  "requiredAttributes": []
353
495
  },
354
496
  {
@@ -356,6 +498,7 @@
356
498
  "description": "`<zg-selector-mask>` is used to wrap the cells during user selection for \nstyling purposes. The element is dynamically added to the grid based upon the presence of the \n`selector` attribute on the `<zing-grid>` element. The element should not be manually inserted, \nthough it can be styled using CSS.",
357
499
  "allowedChildren": [],
358
500
  "requiredChildren": [],
501
+ "requiredParent": [],
359
502
  "requiredAttributes": []
360
503
  },
361
504
  {
@@ -363,6 +506,7 @@
363
506
  "description": "`<zg-separator>` specifies the horizontal bar in the `<zg-menu>` used for separating \nitems. The element is created dynamically and should not be manually inserted by developers. However,\n`<zg-separator>` can be styled using CSS.",
364
507
  "allowedChildren": [],
365
508
  "requiredChildren": [],
509
+ "requiredParent": [],
366
510
  "requiredAttributes": []
367
511
  },
368
512
  {
@@ -374,9 +518,14 @@
374
518
  "zg-icon",
375
519
  "zg-input",
376
520
  "zg-select",
377
- "zg-text"
521
+ "zg-text",
522
+ "*"
378
523
  ],
379
524
  "requiredChildren": [],
525
+ "requiredParent": [
526
+ "zg-footer",
527
+ "zing-grid"
528
+ ],
380
529
  "requiredAttributes": []
381
530
  },
382
531
  {
@@ -384,6 +533,7 @@
384
533
  "description": "`<zg-status>` is a custom element used to display messages to the \nuser, such as errors and verifications of CRUD actions. `<zg-status>` is created \ndynamically and should not be inserted manually. The `<zg-status>` element is \nstylable with CSS.",
385
534
  "allowedChildren": [],
386
535
  "requiredChildren": [],
536
+ "requiredParent": [],
387
537
  "requiredAttributes": []
388
538
  },
389
539
  {
@@ -391,6 +541,7 @@
391
541
  "description": "The `<zg-table>` component replicates the `<table>` functionality in the grid.\nIt contains `<zg-head>`, `<zg-body>`, `<zg-foot>`, and `<zg-colgroup>`. \nThe element and its contents are stylable directly using CSS.",
392
542
  "allowedChildren": [],
393
543
  "requiredChildren": [],
544
+ "requiredParent": [],
394
545
  "requiredAttributes": []
395
546
  },
396
547
  {
@@ -398,6 +549,17 @@
398
549
  "description": "`<zg-text>` is a ZingGrid specific text value that is bound to \nthe status of the grid, as defined by the `value` attribute. The field can be \nmanually inserted by a developer, but is more commonly added by the use of certain \ngrid features, like paging. The element is stylable with CSS.",
399
550
  "allowedChildren": [],
400
551
  "requiredChildren": [],
552
+ "requiredParent": [
553
+ "zg-caption",
554
+ "zg-card",
555
+ "zg-column",
556
+ "zg-dialog",
557
+ "zg-footer",
558
+ "zg-load-mask",
559
+ "zg-menu",
560
+ "zg-no-data",
561
+ "zg-pager"
562
+ ],
401
563
  "requiredAttributes": []
402
564
  },
403
565
  {
@@ -405,6 +567,7 @@
405
567
  "description": "`<zg-tooltip>` elements are inserted dynamically by the ZingGrid library\nand serves as a container for the grid's tooltips. As a generated element, developers\nshould not manually place `<zg-tooltip>` in their grid; however, they may style the tooltips and\nits internal elements using CSS.",
406
568
  "allowedChildren": [],
407
569
  "requiredChildren": [],
570
+ "requiredParent": [],
408
571
  "requiredAttributes": []
409
572
  },
410
573
  {
@@ -419,9 +582,11 @@
419
582
  "zg-footer",
420
583
  "zg-load-mask",
421
584
  "zg-menu",
422
- "zg-pager"
585
+ "zg-pager",
586
+ "zg-source"
423
587
  ],
424
588
  "requiredChildren": [],
589
+ "requiredParent": [],
425
590
  "requiredAttributes": []
426
591
  }
427
592
  ]