@xwiki/cristal-uiextension-api 1.1.0-rc-1 → 1.1.0
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xwiki/cristal-uiextension-api",
|
|
3
|
-
"version": "1.1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"license": "LGPL 2.1",
|
|
5
5
|
"author": "XWiki Org Community <contact@xwiki.org>",
|
|
6
6
|
"homepage": "https://cristal.xwiki.org/",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"typescript": "5.9.3",
|
|
42
42
|
"vite": "7.3.1",
|
|
43
43
|
"vue": "3.5.28",
|
|
44
|
-
"@xwiki/cristal-dev-config": "1.1.0
|
|
44
|
+
"@xwiki/cristal-dev-config": "1.1.0"
|
|
45
45
|
},
|
|
46
46
|
"scripts": {
|
|
47
47
|
"api-extractor:local": "api-extractor run --local",
|
|
@@ -1,758 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"metadata": {
|
|
3
|
-
"toolPackage": "@microsoft/api-extractor",
|
|
4
|
-
"toolVersion": "7.56.3",
|
|
5
|
-
"schemaVersion": 1011,
|
|
6
|
-
"oldestForwardsCompatibleVersion": 1001,
|
|
7
|
-
"tsdocConfig": {
|
|
8
|
-
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
9
|
-
"noStandardTags": true,
|
|
10
|
-
"tagDefinitions": [
|
|
11
|
-
{
|
|
12
|
-
"tagName": "@alpha",
|
|
13
|
-
"syntaxKind": "modifier"
|
|
14
|
-
},
|
|
15
|
-
{
|
|
16
|
-
"tagName": "@beta",
|
|
17
|
-
"syntaxKind": "modifier"
|
|
18
|
-
},
|
|
19
|
-
{
|
|
20
|
-
"tagName": "@defaultValue",
|
|
21
|
-
"syntaxKind": "block"
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"tagName": "@decorator",
|
|
25
|
-
"syntaxKind": "block",
|
|
26
|
-
"allowMultiple": true
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"tagName": "@deprecated",
|
|
30
|
-
"syntaxKind": "block"
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
"tagName": "@eventProperty",
|
|
34
|
-
"syntaxKind": "modifier"
|
|
35
|
-
},
|
|
36
|
-
{
|
|
37
|
-
"tagName": "@example",
|
|
38
|
-
"syntaxKind": "block",
|
|
39
|
-
"allowMultiple": true
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
"tagName": "@experimental",
|
|
43
|
-
"syntaxKind": "modifier"
|
|
44
|
-
},
|
|
45
|
-
{
|
|
46
|
-
"tagName": "@inheritDoc",
|
|
47
|
-
"syntaxKind": "inline"
|
|
48
|
-
},
|
|
49
|
-
{
|
|
50
|
-
"tagName": "@internal",
|
|
51
|
-
"syntaxKind": "modifier"
|
|
52
|
-
},
|
|
53
|
-
{
|
|
54
|
-
"tagName": "@label",
|
|
55
|
-
"syntaxKind": "inline"
|
|
56
|
-
},
|
|
57
|
-
{
|
|
58
|
-
"tagName": "@link",
|
|
59
|
-
"syntaxKind": "inline",
|
|
60
|
-
"allowMultiple": true
|
|
61
|
-
},
|
|
62
|
-
{
|
|
63
|
-
"tagName": "@override",
|
|
64
|
-
"syntaxKind": "modifier"
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
"tagName": "@packageDocumentation",
|
|
68
|
-
"syntaxKind": "modifier"
|
|
69
|
-
},
|
|
70
|
-
{
|
|
71
|
-
"tagName": "@param",
|
|
72
|
-
"syntaxKind": "block",
|
|
73
|
-
"allowMultiple": true
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
"tagName": "@privateRemarks",
|
|
77
|
-
"syntaxKind": "block"
|
|
78
|
-
},
|
|
79
|
-
{
|
|
80
|
-
"tagName": "@public",
|
|
81
|
-
"syntaxKind": "modifier"
|
|
82
|
-
},
|
|
83
|
-
{
|
|
84
|
-
"tagName": "@readonly",
|
|
85
|
-
"syntaxKind": "modifier"
|
|
86
|
-
},
|
|
87
|
-
{
|
|
88
|
-
"tagName": "@remarks",
|
|
89
|
-
"syntaxKind": "block"
|
|
90
|
-
},
|
|
91
|
-
{
|
|
92
|
-
"tagName": "@returns",
|
|
93
|
-
"syntaxKind": "block"
|
|
94
|
-
},
|
|
95
|
-
{
|
|
96
|
-
"tagName": "@sealed",
|
|
97
|
-
"syntaxKind": "modifier"
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"tagName": "@see",
|
|
101
|
-
"syntaxKind": "block"
|
|
102
|
-
},
|
|
103
|
-
{
|
|
104
|
-
"tagName": "@throws",
|
|
105
|
-
"syntaxKind": "block",
|
|
106
|
-
"allowMultiple": true
|
|
107
|
-
},
|
|
108
|
-
{
|
|
109
|
-
"tagName": "@typeParam",
|
|
110
|
-
"syntaxKind": "block",
|
|
111
|
-
"allowMultiple": true
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
"tagName": "@virtual",
|
|
115
|
-
"syntaxKind": "modifier"
|
|
116
|
-
},
|
|
117
|
-
{
|
|
118
|
-
"tagName": "@jsx",
|
|
119
|
-
"syntaxKind": "block"
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
"tagName": "@jsxRuntime",
|
|
123
|
-
"syntaxKind": "block"
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"tagName": "@jsxFrag",
|
|
127
|
-
"syntaxKind": "block"
|
|
128
|
-
},
|
|
129
|
-
{
|
|
130
|
-
"tagName": "@jsxImportSource",
|
|
131
|
-
"syntaxKind": "block"
|
|
132
|
-
},
|
|
133
|
-
{
|
|
134
|
-
"tagName": "@since",
|
|
135
|
-
"syntaxKind": "block"
|
|
136
|
-
}
|
|
137
|
-
],
|
|
138
|
-
"supportForTags": {
|
|
139
|
-
"@beta": true,
|
|
140
|
-
"@deprecated": true,
|
|
141
|
-
"@example": true,
|
|
142
|
-
"@internal": true,
|
|
143
|
-
"@link": true,
|
|
144
|
-
"@param": true,
|
|
145
|
-
"@public": true,
|
|
146
|
-
"@returns": true,
|
|
147
|
-
"@see": true,
|
|
148
|
-
"@throws": true,
|
|
149
|
-
"@since": true
|
|
150
|
-
},
|
|
151
|
-
"reportUnsupportedHtmlElements": false
|
|
152
|
-
}
|
|
153
|
-
},
|
|
154
|
-
"kind": "Package",
|
|
155
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!",
|
|
156
|
-
"docComment": "",
|
|
157
|
-
"name": "@xwiki/cristal-uiextension-api",
|
|
158
|
-
"preserveMemberOrder": false,
|
|
159
|
-
"members": [
|
|
160
|
-
{
|
|
161
|
-
"kind": "EntryPoint",
|
|
162
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!",
|
|
163
|
-
"name": "",
|
|
164
|
-
"preserveMemberOrder": false,
|
|
165
|
-
"members": [
|
|
166
|
-
{
|
|
167
|
-
"kind": "Class",
|
|
168
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension:class",
|
|
169
|
-
"docComment": "/**\n * Abstract class helping with localization of UI extensions.\n *\n * @since\n *\n * 0.23\n *\n * @beta\n */\n",
|
|
170
|
-
"excerptTokens": [
|
|
171
|
-
{
|
|
172
|
-
"kind": "Content",
|
|
173
|
-
"text": "declare abstract class AbstractUIExtension implements "
|
|
174
|
-
},
|
|
175
|
-
{
|
|
176
|
-
"kind": "Reference",
|
|
177
|
-
"text": "UIExtension",
|
|
178
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension:interface"
|
|
179
|
-
},
|
|
180
|
-
{
|
|
181
|
-
"kind": "Content",
|
|
182
|
-
"text": " "
|
|
183
|
-
}
|
|
184
|
-
],
|
|
185
|
-
"fileUrlPath": "dist/index.d.ts",
|
|
186
|
-
"releaseTag": "Beta",
|
|
187
|
-
"isAbstract": true,
|
|
188
|
-
"name": "AbstractUIExtension",
|
|
189
|
-
"preserveMemberOrder": false,
|
|
190
|
-
"members": [
|
|
191
|
-
{
|
|
192
|
-
"kind": "Constructor",
|
|
193
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension:constructor(1)",
|
|
194
|
-
"docComment": "/**\n * Constructs a new instance of the `AbstractUIExtension` class\n */\n",
|
|
195
|
-
"excerptTokens": [
|
|
196
|
-
{
|
|
197
|
-
"kind": "Content",
|
|
198
|
-
"text": "constructor(messages: "
|
|
199
|
-
},
|
|
200
|
-
{
|
|
201
|
-
"kind": "Reference",
|
|
202
|
-
"text": "Record",
|
|
203
|
-
"canonicalReference": "!Record:type"
|
|
204
|
-
},
|
|
205
|
-
{
|
|
206
|
-
"kind": "Content",
|
|
207
|
-
"text": "<string, "
|
|
208
|
-
},
|
|
209
|
-
{
|
|
210
|
-
"kind": "Reference",
|
|
211
|
-
"text": "Record",
|
|
212
|
-
"canonicalReference": "!Record:type"
|
|
213
|
-
},
|
|
214
|
-
{
|
|
215
|
-
"kind": "Content",
|
|
216
|
-
"text": "<string, string>>"
|
|
217
|
-
},
|
|
218
|
-
{
|
|
219
|
-
"kind": "Content",
|
|
220
|
-
"text": ");"
|
|
221
|
-
}
|
|
222
|
-
],
|
|
223
|
-
"releaseTag": "Beta",
|
|
224
|
-
"isProtected": false,
|
|
225
|
-
"overloadIndex": 1,
|
|
226
|
-
"parameters": [
|
|
227
|
-
{
|
|
228
|
-
"parameterName": "messages",
|
|
229
|
-
"parameterTypeTokenRange": {
|
|
230
|
-
"startIndex": 1,
|
|
231
|
-
"endIndex": 5
|
|
232
|
-
},
|
|
233
|
-
"isOptional": false
|
|
234
|
-
}
|
|
235
|
-
]
|
|
236
|
-
},
|
|
237
|
-
{
|
|
238
|
-
"kind": "Method",
|
|
239
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#component:member(1)",
|
|
240
|
-
"docComment": "",
|
|
241
|
-
"excerptTokens": [
|
|
242
|
-
{
|
|
243
|
-
"kind": "Content",
|
|
244
|
-
"text": "abstract component(): "
|
|
245
|
-
},
|
|
246
|
-
{
|
|
247
|
-
"kind": "Reference",
|
|
248
|
-
"text": "Promise",
|
|
249
|
-
"canonicalReference": "!Promise:interface"
|
|
250
|
-
},
|
|
251
|
-
{
|
|
252
|
-
"kind": "Content",
|
|
253
|
-
"text": "<"
|
|
254
|
-
},
|
|
255
|
-
{
|
|
256
|
-
"kind": "Reference",
|
|
257
|
-
"text": "Component",
|
|
258
|
-
"canonicalReference": "@vue/runtime-core!Component:type"
|
|
259
|
-
},
|
|
260
|
-
{
|
|
261
|
-
"kind": "Content",
|
|
262
|
-
"text": ">"
|
|
263
|
-
},
|
|
264
|
-
{
|
|
265
|
-
"kind": "Content",
|
|
266
|
-
"text": ";"
|
|
267
|
-
}
|
|
268
|
-
],
|
|
269
|
-
"isStatic": false,
|
|
270
|
-
"returnTypeTokenRange": {
|
|
271
|
-
"startIndex": 1,
|
|
272
|
-
"endIndex": 5
|
|
273
|
-
},
|
|
274
|
-
"releaseTag": "Beta",
|
|
275
|
-
"isProtected": false,
|
|
276
|
-
"overloadIndex": 1,
|
|
277
|
-
"parameters": [],
|
|
278
|
-
"isOptional": false,
|
|
279
|
-
"isAbstract": true,
|
|
280
|
-
"name": "component"
|
|
281
|
-
},
|
|
282
|
-
{
|
|
283
|
-
"kind": "Method",
|
|
284
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#enabled:member(1)",
|
|
285
|
-
"docComment": "",
|
|
286
|
-
"excerptTokens": [
|
|
287
|
-
{
|
|
288
|
-
"kind": "Content",
|
|
289
|
-
"text": "abstract enabled(): "
|
|
290
|
-
},
|
|
291
|
-
{
|
|
292
|
-
"kind": "Reference",
|
|
293
|
-
"text": "Promise",
|
|
294
|
-
"canonicalReference": "!Promise:interface"
|
|
295
|
-
},
|
|
296
|
-
{
|
|
297
|
-
"kind": "Content",
|
|
298
|
-
"text": "<boolean>"
|
|
299
|
-
},
|
|
300
|
-
{
|
|
301
|
-
"kind": "Content",
|
|
302
|
-
"text": ";"
|
|
303
|
-
}
|
|
304
|
-
],
|
|
305
|
-
"isStatic": false,
|
|
306
|
-
"returnTypeTokenRange": {
|
|
307
|
-
"startIndex": 1,
|
|
308
|
-
"endIndex": 3
|
|
309
|
-
},
|
|
310
|
-
"releaseTag": "Beta",
|
|
311
|
-
"isProtected": false,
|
|
312
|
-
"overloadIndex": 1,
|
|
313
|
-
"parameters": [],
|
|
314
|
-
"isOptional": false,
|
|
315
|
-
"isAbstract": true,
|
|
316
|
-
"name": "enabled"
|
|
317
|
-
},
|
|
318
|
-
{
|
|
319
|
-
"kind": "Property",
|
|
320
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#id:member",
|
|
321
|
-
"docComment": "",
|
|
322
|
-
"excerptTokens": [
|
|
323
|
-
{
|
|
324
|
-
"kind": "Content",
|
|
325
|
-
"text": "abstract id: "
|
|
326
|
-
},
|
|
327
|
-
{
|
|
328
|
-
"kind": "Content",
|
|
329
|
-
"text": "string"
|
|
330
|
-
},
|
|
331
|
-
{
|
|
332
|
-
"kind": "Content",
|
|
333
|
-
"text": ";"
|
|
334
|
-
}
|
|
335
|
-
],
|
|
336
|
-
"isReadonly": false,
|
|
337
|
-
"isOptional": false,
|
|
338
|
-
"releaseTag": "Beta",
|
|
339
|
-
"name": "id",
|
|
340
|
-
"propertyTypeTokenRange": {
|
|
341
|
-
"startIndex": 1,
|
|
342
|
-
"endIndex": 2
|
|
343
|
-
},
|
|
344
|
-
"isStatic": false,
|
|
345
|
-
"isProtected": false,
|
|
346
|
-
"isAbstract": true
|
|
347
|
-
},
|
|
348
|
-
{
|
|
349
|
-
"kind": "Property",
|
|
350
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#order:member",
|
|
351
|
-
"docComment": "",
|
|
352
|
-
"excerptTokens": [
|
|
353
|
-
{
|
|
354
|
-
"kind": "Content",
|
|
355
|
-
"text": "abstract order: "
|
|
356
|
-
},
|
|
357
|
-
{
|
|
358
|
-
"kind": "Content",
|
|
359
|
-
"text": "number"
|
|
360
|
-
},
|
|
361
|
-
{
|
|
362
|
-
"kind": "Content",
|
|
363
|
-
"text": ";"
|
|
364
|
-
}
|
|
365
|
-
],
|
|
366
|
-
"isReadonly": false,
|
|
367
|
-
"isOptional": false,
|
|
368
|
-
"releaseTag": "Beta",
|
|
369
|
-
"name": "order",
|
|
370
|
-
"propertyTypeTokenRange": {
|
|
371
|
-
"startIndex": 1,
|
|
372
|
-
"endIndex": 2
|
|
373
|
-
},
|
|
374
|
-
"isStatic": false,
|
|
375
|
-
"isProtected": false,
|
|
376
|
-
"isAbstract": true
|
|
377
|
-
},
|
|
378
|
-
{
|
|
379
|
-
"kind": "Property",
|
|
380
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#parameters:member",
|
|
381
|
-
"docComment": "",
|
|
382
|
-
"excerptTokens": [
|
|
383
|
-
{
|
|
384
|
-
"kind": "Content",
|
|
385
|
-
"text": "abstract parameters: "
|
|
386
|
-
},
|
|
387
|
-
{
|
|
388
|
-
"kind": "Content",
|
|
389
|
-
"text": "{\n [key: string]: unknown;\n }"
|
|
390
|
-
},
|
|
391
|
-
{
|
|
392
|
-
"kind": "Content",
|
|
393
|
-
"text": ";"
|
|
394
|
-
}
|
|
395
|
-
],
|
|
396
|
-
"isReadonly": false,
|
|
397
|
-
"isOptional": false,
|
|
398
|
-
"releaseTag": "Beta",
|
|
399
|
-
"name": "parameters",
|
|
400
|
-
"propertyTypeTokenRange": {
|
|
401
|
-
"startIndex": 1,
|
|
402
|
-
"endIndex": 2
|
|
403
|
-
},
|
|
404
|
-
"isStatic": false,
|
|
405
|
-
"isProtected": false,
|
|
406
|
-
"isAbstract": true
|
|
407
|
-
},
|
|
408
|
-
{
|
|
409
|
-
"kind": "Property",
|
|
410
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#t:member",
|
|
411
|
-
"docComment": "",
|
|
412
|
-
"excerptTokens": [
|
|
413
|
-
{
|
|
414
|
-
"kind": "Content",
|
|
415
|
-
"text": "protected t: "
|
|
416
|
-
},
|
|
417
|
-
{
|
|
418
|
-
"kind": "Reference",
|
|
419
|
-
"text": "ComposerTranslation",
|
|
420
|
-
"canonicalReference": "vue-i18n!ComposerTranslation:interface"
|
|
421
|
-
},
|
|
422
|
-
{
|
|
423
|
-
"kind": "Content",
|
|
424
|
-
"text": ";"
|
|
425
|
-
}
|
|
426
|
-
],
|
|
427
|
-
"isReadonly": false,
|
|
428
|
-
"isOptional": false,
|
|
429
|
-
"releaseTag": "Beta",
|
|
430
|
-
"name": "t",
|
|
431
|
-
"propertyTypeTokenRange": {
|
|
432
|
-
"startIndex": 1,
|
|
433
|
-
"endIndex": 2
|
|
434
|
-
},
|
|
435
|
-
"isStatic": false,
|
|
436
|
-
"isProtected": true,
|
|
437
|
-
"isAbstract": false
|
|
438
|
-
},
|
|
439
|
-
{
|
|
440
|
-
"kind": "Property",
|
|
441
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!AbstractUIExtension#uixpName:member",
|
|
442
|
-
"docComment": "",
|
|
443
|
-
"excerptTokens": [
|
|
444
|
-
{
|
|
445
|
-
"kind": "Content",
|
|
446
|
-
"text": "abstract uixpName: "
|
|
447
|
-
},
|
|
448
|
-
{
|
|
449
|
-
"kind": "Content",
|
|
450
|
-
"text": "string"
|
|
451
|
-
},
|
|
452
|
-
{
|
|
453
|
-
"kind": "Content",
|
|
454
|
-
"text": ";"
|
|
455
|
-
}
|
|
456
|
-
],
|
|
457
|
-
"isReadonly": false,
|
|
458
|
-
"isOptional": false,
|
|
459
|
-
"releaseTag": "Beta",
|
|
460
|
-
"name": "uixpName",
|
|
461
|
-
"propertyTypeTokenRange": {
|
|
462
|
-
"startIndex": 1,
|
|
463
|
-
"endIndex": 2
|
|
464
|
-
},
|
|
465
|
-
"isStatic": false,
|
|
466
|
-
"isProtected": false,
|
|
467
|
-
"isAbstract": true
|
|
468
|
-
}
|
|
469
|
-
],
|
|
470
|
-
"implementsTokenRanges": [
|
|
471
|
-
{
|
|
472
|
-
"startIndex": 1,
|
|
473
|
-
"endIndex": 2
|
|
474
|
-
}
|
|
475
|
-
]
|
|
476
|
-
},
|
|
477
|
-
{
|
|
478
|
-
"kind": "Interface",
|
|
479
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension:interface",
|
|
480
|
-
"docComment": "/**\n * Define the information held by a UI Extension (UIX).\n *\n * @since\n *\n * 0.11\n *\n * @beta\n */\n",
|
|
481
|
-
"excerptTokens": [
|
|
482
|
-
{
|
|
483
|
-
"kind": "Content",
|
|
484
|
-
"text": "interface UIExtension "
|
|
485
|
-
}
|
|
486
|
-
],
|
|
487
|
-
"fileUrlPath": "dist/index.d.ts",
|
|
488
|
-
"releaseTag": "Beta",
|
|
489
|
-
"name": "UIExtension",
|
|
490
|
-
"preserveMemberOrder": false,
|
|
491
|
-
"members": [
|
|
492
|
-
{
|
|
493
|
-
"kind": "MethodSignature",
|
|
494
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension#component:member(1)",
|
|
495
|
-
"docComment": "/**\n * The UI component of the UIX.\n */\n",
|
|
496
|
-
"excerptTokens": [
|
|
497
|
-
{
|
|
498
|
-
"kind": "Content",
|
|
499
|
-
"text": "component(): "
|
|
500
|
-
},
|
|
501
|
-
{
|
|
502
|
-
"kind": "Reference",
|
|
503
|
-
"text": "Promise",
|
|
504
|
-
"canonicalReference": "!Promise:interface"
|
|
505
|
-
},
|
|
506
|
-
{
|
|
507
|
-
"kind": "Content",
|
|
508
|
-
"text": "<"
|
|
509
|
-
},
|
|
510
|
-
{
|
|
511
|
-
"kind": "Reference",
|
|
512
|
-
"text": "Component",
|
|
513
|
-
"canonicalReference": "@vue/runtime-core!Component:type"
|
|
514
|
-
},
|
|
515
|
-
{
|
|
516
|
-
"kind": "Content",
|
|
517
|
-
"text": ">"
|
|
518
|
-
},
|
|
519
|
-
{
|
|
520
|
-
"kind": "Content",
|
|
521
|
-
"text": ";"
|
|
522
|
-
}
|
|
523
|
-
],
|
|
524
|
-
"isOptional": false,
|
|
525
|
-
"returnTypeTokenRange": {
|
|
526
|
-
"startIndex": 1,
|
|
527
|
-
"endIndex": 5
|
|
528
|
-
},
|
|
529
|
-
"releaseTag": "Beta",
|
|
530
|
-
"overloadIndex": 1,
|
|
531
|
-
"parameters": [],
|
|
532
|
-
"name": "component"
|
|
533
|
-
},
|
|
534
|
-
{
|
|
535
|
-
"kind": "MethodSignature",
|
|
536
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension#enabled:member(1)",
|
|
537
|
-
"docComment": "/**\n * Compute if the UIX should be displayed.\n */\n",
|
|
538
|
-
"excerptTokens": [
|
|
539
|
-
{
|
|
540
|
-
"kind": "Content",
|
|
541
|
-
"text": "enabled(): "
|
|
542
|
-
},
|
|
543
|
-
{
|
|
544
|
-
"kind": "Reference",
|
|
545
|
-
"text": "Promise",
|
|
546
|
-
"canonicalReference": "!Promise:interface"
|
|
547
|
-
},
|
|
548
|
-
{
|
|
549
|
-
"kind": "Content",
|
|
550
|
-
"text": "<boolean>"
|
|
551
|
-
},
|
|
552
|
-
{
|
|
553
|
-
"kind": "Content",
|
|
554
|
-
"text": ";"
|
|
555
|
-
}
|
|
556
|
-
],
|
|
557
|
-
"isOptional": false,
|
|
558
|
-
"returnTypeTokenRange": {
|
|
559
|
-
"startIndex": 1,
|
|
560
|
-
"endIndex": 3
|
|
561
|
-
},
|
|
562
|
-
"releaseTag": "Beta",
|
|
563
|
-
"overloadIndex": 1,
|
|
564
|
-
"parameters": [],
|
|
565
|
-
"name": "enabled"
|
|
566
|
-
},
|
|
567
|
-
{
|
|
568
|
-
"kind": "PropertySignature",
|
|
569
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension#id:member",
|
|
570
|
-
"docComment": "/**\n * The unique id of an UI Extension\n */\n",
|
|
571
|
-
"excerptTokens": [
|
|
572
|
-
{
|
|
573
|
-
"kind": "Content",
|
|
574
|
-
"text": "id: "
|
|
575
|
-
},
|
|
576
|
-
{
|
|
577
|
-
"kind": "Content",
|
|
578
|
-
"text": "string"
|
|
579
|
-
},
|
|
580
|
-
{
|
|
581
|
-
"kind": "Content",
|
|
582
|
-
"text": ";"
|
|
583
|
-
}
|
|
584
|
-
],
|
|
585
|
-
"isReadonly": false,
|
|
586
|
-
"isOptional": false,
|
|
587
|
-
"releaseTag": "Beta",
|
|
588
|
-
"name": "id",
|
|
589
|
-
"propertyTypeTokenRange": {
|
|
590
|
-
"startIndex": 1,
|
|
591
|
-
"endIndex": 2
|
|
592
|
-
}
|
|
593
|
-
},
|
|
594
|
-
{
|
|
595
|
-
"kind": "PropertySignature",
|
|
596
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension#order:member",
|
|
597
|
-
"docComment": "/**\n * The order of the UIX. The lowest values are expected to be presented first.\n */\n",
|
|
598
|
-
"excerptTokens": [
|
|
599
|
-
{
|
|
600
|
-
"kind": "Content",
|
|
601
|
-
"text": "order: "
|
|
602
|
-
},
|
|
603
|
-
{
|
|
604
|
-
"kind": "Content",
|
|
605
|
-
"text": "number"
|
|
606
|
-
},
|
|
607
|
-
{
|
|
608
|
-
"kind": "Content",
|
|
609
|
-
"text": ";"
|
|
610
|
-
}
|
|
611
|
-
],
|
|
612
|
-
"isReadonly": false,
|
|
613
|
-
"isOptional": false,
|
|
614
|
-
"releaseTag": "Beta",
|
|
615
|
-
"name": "order",
|
|
616
|
-
"propertyTypeTokenRange": {
|
|
617
|
-
"startIndex": 1,
|
|
618
|
-
"endIndex": 2
|
|
619
|
-
}
|
|
620
|
-
},
|
|
621
|
-
{
|
|
622
|
-
"kind": "PropertySignature",
|
|
623
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension#parameters:member",
|
|
624
|
-
"docComment": "/**\n * A free set of parameters.\n */\n",
|
|
625
|
-
"excerptTokens": [
|
|
626
|
-
{
|
|
627
|
-
"kind": "Content",
|
|
628
|
-
"text": "parameters: "
|
|
629
|
-
},
|
|
630
|
-
{
|
|
631
|
-
"kind": "Content",
|
|
632
|
-
"text": "{\n [key: string]: unknown;\n }"
|
|
633
|
-
},
|
|
634
|
-
{
|
|
635
|
-
"kind": "Content",
|
|
636
|
-
"text": ";"
|
|
637
|
-
}
|
|
638
|
-
],
|
|
639
|
-
"isReadonly": false,
|
|
640
|
-
"isOptional": false,
|
|
641
|
-
"releaseTag": "Beta",
|
|
642
|
-
"name": "parameters",
|
|
643
|
-
"propertyTypeTokenRange": {
|
|
644
|
-
"startIndex": 1,
|
|
645
|
-
"endIndex": 2
|
|
646
|
-
}
|
|
647
|
-
},
|
|
648
|
-
{
|
|
649
|
-
"kind": "PropertySignature",
|
|
650
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension#uixpName:member",
|
|
651
|
-
"docComment": "/**\n * The id of the extension point where this UIX should be injected.\n */\n",
|
|
652
|
-
"excerptTokens": [
|
|
653
|
-
{
|
|
654
|
-
"kind": "Content",
|
|
655
|
-
"text": "uixpName: "
|
|
656
|
-
},
|
|
657
|
-
{
|
|
658
|
-
"kind": "Content",
|
|
659
|
-
"text": "string"
|
|
660
|
-
},
|
|
661
|
-
{
|
|
662
|
-
"kind": "Content",
|
|
663
|
-
"text": ";"
|
|
664
|
-
}
|
|
665
|
-
],
|
|
666
|
-
"isReadonly": false,
|
|
667
|
-
"isOptional": false,
|
|
668
|
-
"releaseTag": "Beta",
|
|
669
|
-
"name": "uixpName",
|
|
670
|
-
"propertyTypeTokenRange": {
|
|
671
|
-
"startIndex": 1,
|
|
672
|
-
"endIndex": 2
|
|
673
|
-
}
|
|
674
|
-
}
|
|
675
|
-
],
|
|
676
|
-
"extendsTokenRanges": []
|
|
677
|
-
},
|
|
678
|
-
{
|
|
679
|
-
"kind": "Interface",
|
|
680
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtensionsManager:interface",
|
|
681
|
-
"docComment": "/**\n * @since\n *\n * 0.11\n *\n * @beta\n */\n",
|
|
682
|
-
"excerptTokens": [
|
|
683
|
-
{
|
|
684
|
-
"kind": "Content",
|
|
685
|
-
"text": "interface UIExtensionsManager "
|
|
686
|
-
}
|
|
687
|
-
],
|
|
688
|
-
"fileUrlPath": "dist/index.d.ts",
|
|
689
|
-
"releaseTag": "Beta",
|
|
690
|
-
"name": "UIExtensionsManager",
|
|
691
|
-
"preserveMemberOrder": false,
|
|
692
|
-
"members": [
|
|
693
|
-
{
|
|
694
|
-
"kind": "MethodSignature",
|
|
695
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtensionsManager#list:member(1)",
|
|
696
|
-
"docComment": "/**\n * @param name - the name of the UIXP\n *\n * @returns a list of UIExtension components, sorted by ascending order. disabled UIExtensions are excluded\n */\n",
|
|
697
|
-
"excerptTokens": [
|
|
698
|
-
{
|
|
699
|
-
"kind": "Content",
|
|
700
|
-
"text": "list(name: "
|
|
701
|
-
},
|
|
702
|
-
{
|
|
703
|
-
"kind": "Content",
|
|
704
|
-
"text": "string"
|
|
705
|
-
},
|
|
706
|
-
{
|
|
707
|
-
"kind": "Content",
|
|
708
|
-
"text": "): "
|
|
709
|
-
},
|
|
710
|
-
{
|
|
711
|
-
"kind": "Reference",
|
|
712
|
-
"text": "Promise",
|
|
713
|
-
"canonicalReference": "!Promise:interface"
|
|
714
|
-
},
|
|
715
|
-
{
|
|
716
|
-
"kind": "Content",
|
|
717
|
-
"text": "<"
|
|
718
|
-
},
|
|
719
|
-
{
|
|
720
|
-
"kind": "Reference",
|
|
721
|
-
"text": "UIExtension",
|
|
722
|
-
"canonicalReference": "@xwiki/cristal-uiextension-api!UIExtension:interface"
|
|
723
|
-
},
|
|
724
|
-
{
|
|
725
|
-
"kind": "Content",
|
|
726
|
-
"text": "[]>"
|
|
727
|
-
},
|
|
728
|
-
{
|
|
729
|
-
"kind": "Content",
|
|
730
|
-
"text": ";"
|
|
731
|
-
}
|
|
732
|
-
],
|
|
733
|
-
"isOptional": false,
|
|
734
|
-
"returnTypeTokenRange": {
|
|
735
|
-
"startIndex": 3,
|
|
736
|
-
"endIndex": 7
|
|
737
|
-
},
|
|
738
|
-
"releaseTag": "Beta",
|
|
739
|
-
"overloadIndex": 1,
|
|
740
|
-
"parameters": [
|
|
741
|
-
{
|
|
742
|
-
"parameterName": "name",
|
|
743
|
-
"parameterTypeTokenRange": {
|
|
744
|
-
"startIndex": 1,
|
|
745
|
-
"endIndex": 2
|
|
746
|
-
},
|
|
747
|
-
"isOptional": false
|
|
748
|
-
}
|
|
749
|
-
],
|
|
750
|
-
"name": "list"
|
|
751
|
-
}
|
|
752
|
-
],
|
|
753
|
-
"extendsTokenRanges": []
|
|
754
|
-
}
|
|
755
|
-
]
|
|
756
|
-
}
|
|
757
|
-
]
|
|
758
|
-
}
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
## API Report File for "@xwiki/cristal-uiextension-api"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import { Component } from 'vue';
|
|
8
|
-
import { ComposerTranslation } from 'vue-i18n';
|
|
9
|
-
|
|
10
|
-
// @beta
|
|
11
|
-
export abstract class AbstractUIExtension implements UIExtension {
|
|
12
|
-
constructor(messages: Record<string, Record<string, string>>);
|
|
13
|
-
// (undocumented)
|
|
14
|
-
abstract component(): Promise<Component>;
|
|
15
|
-
// (undocumented)
|
|
16
|
-
abstract enabled(): Promise<boolean>;
|
|
17
|
-
// (undocumented)
|
|
18
|
-
abstract id: string;
|
|
19
|
-
// (undocumented)
|
|
20
|
-
abstract order: number;
|
|
21
|
-
// (undocumented)
|
|
22
|
-
abstract parameters: {
|
|
23
|
-
[key: string]: unknown;
|
|
24
|
-
};
|
|
25
|
-
// (undocumented)
|
|
26
|
-
protected t: ComposerTranslation;
|
|
27
|
-
// (undocumented)
|
|
28
|
-
abstract uixpName: string;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
// @beta
|
|
32
|
-
export interface UIExtension {
|
|
33
|
-
component(): Promise<Component>;
|
|
34
|
-
enabled(): Promise<boolean>;
|
|
35
|
-
id: string;
|
|
36
|
-
order: number;
|
|
37
|
-
parameters: {
|
|
38
|
-
[key: string]: unknown;
|
|
39
|
-
};
|
|
40
|
-
uixpName: string;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
// @beta (undocumented)
|
|
44
|
-
export interface UIExtensionsManager {
|
|
45
|
-
// (undocumented)
|
|
46
|
-
list(name: string): Promise<UIExtension[]>;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
// (No @packageDocumentation comment for this package)
|
|
50
|
-
|
|
51
|
-
```
|
package/unit-tests.xml
DELETED