@ui5/webcomponents-compat 0.0.0-0dd36ca4b → 0.0.0-38f83ffef
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/.env.testing +4 -0
- package/CHANGELOG.md +613 -0
- package/README.md +1 -4
- package/cypress.config.js +3 -0
- package/dist/Table.d.ts +22 -27
- package/dist/Table.js +128 -76
- package/dist/Table.js.map +1 -1
- package/dist/TableCell.d.ts +0 -1
- package/dist/TableCell.js +21 -6
- package/dist/TableCell.js.map +1 -1
- package/dist/TableCellTemplate.d.ts +2 -0
- package/dist/TableCellTemplate.js +5 -0
- package/dist/TableCellTemplate.js.map +1 -0
- package/dist/TableColumn.d.ts +3 -3
- package/dist/TableColumn.js +47 -7
- package/dist/TableColumn.js.map +1 -1
- package/dist/TableColumnTemplate.d.ts +2 -0
- package/dist/TableColumnTemplate.js +5 -0
- package/dist/TableColumnTemplate.js.map +1 -0
- package/dist/TableGroupRow.d.ts +6 -4
- package/dist/TableGroupRow.js +26 -21
- package/dist/TableGroupRow.js.map +1 -1
- package/dist/TableGroupRowTemplate.d.ts +2 -0
- package/dist/TableGroupRowTemplate.js +5 -0
- package/dist/TableGroupRowTemplate.js.map +1 -0
- package/dist/TableRow.d.ts +14 -9
- package/dist/TableRow.js +101 -43
- package/dist/TableRow.js.map +1 -1
- package/dist/TableRowTemplate.d.ts +2 -0
- package/dist/TableRowTemplate.js +15 -0
- package/dist/TableRowTemplate.js.map +1 -0
- package/dist/TableTemplate.d.ts +2 -0
- package/dist/TableTemplate.js +20 -0
- package/dist/TableTemplate.js.map +1 -0
- package/dist/bundle.esm.d.ts +1 -1
- package/dist/bundle.esm.js +13 -7
- package/dist/bundle.esm.js.map +1 -1
- package/dist/bundle.scoped.config.d.ts +1 -0
- package/dist/bundle.scoped.config.js +5 -0
- package/dist/bundle.scoped.config.js.map +1 -0
- package/dist/bundle.scoped.esm.d.ts +1 -0
- package/dist/bundle.scoped.esm.js +1 -4
- package/dist/bundle.scoped.esm.js.map +1 -1
- package/dist/css/themes/GrowingButton.css +1 -1
- package/dist/css/themes/Table.css +1 -1
- package/dist/css/themes/TableCell.css +1 -1
- package/dist/css/themes/TableColumn.css +1 -1
- package/dist/css/themes/TableGroupRow.css +1 -1
- package/dist/css/themes/TableRow.css +1 -1
- package/dist/css/themes/sap_fiori_3/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_fiori_3_dark/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_fiori_3_hcb/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_fiori_3_hcw/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon_dark/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon_hcb/parameters-bundle.css +1 -1
- package/dist/css/themes/sap_horizon_hcw/parameters-bundle.css +1 -1
- package/dist/custom-elements-internal.json +2462 -154
- package/dist/custom-elements.json +2312 -58
- package/dist/generated/assets/i18n/messagebundle_ca.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_cs.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_cy.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_en_US_sappsd.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_en_US_saptrc.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_fi.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_fr.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_fr_CA.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_id.json +1 -0
- package/dist/generated/assets/i18n/messagebundle_it.json +1 -1
- package/dist/generated/assets/i18n/messagebundle_lv.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3_dark/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3_hcb/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_fiori_3_hcw/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_dark/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_hcb/parameters-bundle.css.json +1 -1
- package/dist/generated/assets/themes/sap_horizon_hcw/parameters-bundle.css.json +1 -1
- package/dist/generated/i18n/i18n-defaults.d.ts +1 -1
- package/dist/generated/i18n/i18n-defaults.js +2 -3
- package/dist/generated/i18n/i18n-defaults.js.map +1 -1
- package/dist/generated/json-imports/Themes-fetch.d.ts +1 -0
- package/dist/generated/json-imports/Themes-fetch.js +25 -0
- package/dist/generated/json-imports/Themes-fetch.js.map +1 -0
- package/dist/generated/json-imports/Themes-node.d.ts +1 -0
- package/dist/generated/json-imports/Themes-node.js +25 -0
- package/dist/generated/json-imports/Themes-node.js.map +1 -0
- package/dist/generated/json-imports/Themes.js.map +1 -1
- package/dist/generated/json-imports/i18n-fetch.d.ts +1 -0
- package/dist/generated/json-imports/i18n-fetch.js +120 -0
- package/dist/generated/json-imports/i18n-fetch.js.map +1 -0
- package/dist/generated/json-imports/i18n-node.d.ts +1 -0
- package/dist/generated/json-imports/i18n-node.js +120 -0
- package/dist/generated/json-imports/i18n-node.js.map +1 -0
- package/dist/generated/json-imports/i18n.js +2 -2
- package/dist/generated/json-imports/i18n.js.map +1 -1
- package/dist/generated/themes/GrowingButton.css.d.ts +2 -3
- package/dist/generated/themes/GrowingButton.css.js +2 -3
- package/dist/generated/themes/GrowingButton.css.js.map +1 -1
- package/dist/generated/themes/Table.css.d.ts +2 -3
- package/dist/generated/themes/Table.css.js +2 -3
- package/dist/generated/themes/Table.css.js.map +1 -1
- package/dist/generated/themes/TableCell.css.d.ts +2 -3
- package/dist/generated/themes/TableCell.css.js +2 -3
- package/dist/generated/themes/TableCell.css.js.map +1 -1
- package/dist/generated/themes/TableColumn.css.d.ts +2 -3
- package/dist/generated/themes/TableColumn.css.js +2 -3
- package/dist/generated/themes/TableColumn.css.js.map +1 -1
- package/dist/generated/themes/TableGroupRow.css.d.ts +2 -3
- package/dist/generated/themes/TableGroupRow.css.js +2 -3
- package/dist/generated/themes/TableGroupRow.css.js.map +1 -1
- package/dist/generated/themes/TableRow.css.d.ts +2 -3
- package/dist/generated/themes/TableRow.css.js +2 -3
- package/dist/generated/themes/TableRow.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_fiori_3/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_fiori_3/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3_dark/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_fiori_3_dark/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_fiori_3_dark/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3_hcb/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_fiori_3_hcb/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_fiori_3_hcb/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_fiori_3_hcw/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_fiori_3_hcw/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_fiori_3_hcw/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_horizon/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_horizon/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_dark/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_horizon_dark/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_horizon_dark/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_hcb/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_horizon_hcb/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_horizon_hcb/parameters-bundle.css.js.map +1 -1
- package/dist/generated/themes/sap_horizon_hcw/parameters-bundle.css.d.ts +2 -3
- package/dist/generated/themes/sap_horizon_hcw/parameters-bundle.css.js +2 -3
- package/dist/generated/themes/sap_horizon_hcw/parameters-bundle.css.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/dist/web-types.json +11 -11
- package/package-scripts.cjs +4 -0
- package/package.json +13 -8
- package/src/TableCellTemplate.tsx +13 -0
- package/src/TableColumnTemplate.tsx +13 -0
- package/src/TableGroupRowTemplate.tsx +17 -0
- package/src/TableRowTemplate.tsx +92 -0
- package/src/TableTemplate.tsx +129 -0
- package/src/i18n/messagebundle_ca.properties +1 -1
- package/src/i18n/messagebundle_cs.properties +1 -1
- package/src/i18n/messagebundle_cy.properties +1 -1
- package/src/i18n/messagebundle_en_US_sappsd.properties +5 -296
- package/src/i18n/messagebundle_en_US_saptrc.properties +10 -301
- package/src/i18n/messagebundle_fi.properties +2 -2
- package/src/i18n/messagebundle_fr.properties +3 -3
- package/src/i18n/messagebundle_fr_CA.properties +3 -3
- package/src/i18n/messagebundle_it.properties +1 -1
- package/src/i18n/messagebundle_lv.properties +1 -1
- package/src/themes/GrowingButton.css +12 -12
- package/src/themes/Table.css +15 -22
- package/src/themes/TableGroupRow.css +1 -1
- package/src/themes/TableRow.css +37 -2
- package/src/themes/base/Table-parameters.css +1 -0
- package/src/themes/base/sizes-parameters.css +0 -1
- package/src/themes/sap_horizon/Table-parameters.css +1 -2
- package/src/themes/sap_horizon/parameters-bundle.css +0 -1
- package/src/themes/sap_horizon_dark/Table-parameters.css +1 -2
- package/src/themes/sap_horizon_dark/parameters-bundle.css +0 -1
- package/src/themes/sap_horizon_hcb/Table-parameters.css +1 -2
- package/src/themes/sap_horizon_hcw/Table-parameters.css +1 -2
- package/tsconfig.json +34 -26
- package/dist/generated/assets/i18n/messagebundle_in.json +0 -1
- package/dist/generated/templates/TableCellTemplate.lit.d.ts +0 -4
- package/dist/generated/templates/TableCellTemplate.lit.js +0 -5
- package/dist/generated/templates/TableCellTemplate.lit.js.map +0 -1
- package/dist/generated/templates/TableColumnTemplate.lit.d.ts +0 -4
- package/dist/generated/templates/TableColumnTemplate.lit.js +0 -5
- package/dist/generated/templates/TableColumnTemplate.lit.js.map +0 -1
- package/dist/generated/templates/TableGroupRowTemplate.lit.d.ts +0 -4
- package/dist/generated/templates/TableGroupRowTemplate.lit.js +0 -5
- package/dist/generated/templates/TableGroupRowTemplate.lit.js.map +0 -1
- package/dist/generated/templates/TableRowTemplate.lit.d.ts +0 -4
- package/dist/generated/templates/TableRowTemplate.lit.js +0 -16
- package/dist/generated/templates/TableRowTemplate.lit.js.map +0 -1
- package/dist/generated/templates/TableTemplate.lit.d.ts +0 -4
- package/dist/generated/templates/TableTemplate.lit.js +0 -15
- package/dist/generated/templates/TableTemplate.lit.js.map +0 -1
- package/src/Table.hbs +0 -121
- package/src/TableCell.hbs +0 -7
- package/src/TableColumn.hbs +0 -7
- package/src/TableGroupRow.hbs +0 -11
- package/src/TableRow.hbs +0 -85
- package/src/i18n/messagebundle_in.properties +0 -172
- package/src/themes/sap_horizon/TableColumn-parameters.css +0 -5
- package/src/themes/sap_horizon_dark/TableColumn-parameters.css +0 -5
@@ -246,36 +246,33 @@
|
|
246
246
|
"kind": "field",
|
247
247
|
"name": "noDataText",
|
248
248
|
"type": {
|
249
|
-
"text": "string"
|
249
|
+
"text": "string | undefined"
|
250
250
|
},
|
251
251
|
"description": "Defines the text that will be displayed when there is no data and `hideNoData` is not present.",
|
252
|
-
"default": "
|
253
|
-
"privacy": "public"
|
254
|
-
"_ui5validator": "String"
|
252
|
+
"default": "undefined",
|
253
|
+
"privacy": "public"
|
255
254
|
},
|
256
255
|
{
|
257
256
|
"kind": "field",
|
258
257
|
"name": "growingButtonText",
|
259
258
|
"type": {
|
260
|
-
"text": "string"
|
259
|
+
"text": "string | undefined"
|
261
260
|
},
|
262
261
|
"description": "Defines the text that will be displayed inside the growing button at the bottom of the table,\nmeant for loading more rows upon press.\n\n**Note:** If not specified a built-in text will be displayed.\n\n**Note:** This property takes effect if `growing` is set to `Button`.",
|
263
|
-
"default": "
|
262
|
+
"default": "undefined",
|
264
263
|
"privacy": "public",
|
265
|
-
"_ui5since": "2.0.0"
|
266
|
-
"_ui5validator": "String"
|
264
|
+
"_ui5since": "2.0.0"
|
267
265
|
},
|
268
266
|
{
|
269
267
|
"kind": "field",
|
270
268
|
"name": "growingButtonSubtext",
|
271
269
|
"type": {
|
272
|
-
"text": "string"
|
270
|
+
"text": "string | undefined"
|
273
271
|
},
|
274
272
|
"description": "Defines the subtext that will be displayed under the `growingButtonText`.\n\n**Note:** This property takes effect if `growing` is set to `Button`.",
|
275
|
-
"default": "
|
273
|
+
"default": "undefined",
|
276
274
|
"privacy": "public",
|
277
|
-
"_ui5since": "2.0.0"
|
278
|
-
"_ui5validator": "String"
|
275
|
+
"_ui5since": "2.0.0"
|
279
276
|
},
|
280
277
|
{
|
281
278
|
"kind": "field",
|
@@ -283,11 +280,10 @@
|
|
283
280
|
"type": {
|
284
281
|
"text": "boolean"
|
285
282
|
},
|
286
|
-
"description": "Defines if the value of `noDataText` will be diplayed when there is no rows present in the table.",
|
287
283
|
"default": "false",
|
284
|
+
"description": "Defines if the value of `noDataText` will be diplayed when there is no rows present in the table.",
|
288
285
|
"privacy": "public",
|
289
|
-
"_ui5since": "2.0.0"
|
290
|
-
"_ui5validator": "Boolean"
|
286
|
+
"_ui5since": "2.0.0"
|
291
287
|
},
|
292
288
|
{
|
293
289
|
"kind": "field",
|
@@ -302,11 +298,10 @@
|
|
302
298
|
}
|
303
299
|
]
|
304
300
|
},
|
305
|
-
"description": "Defines whether the table will have growing capability either by pressing a `More` button,\nor via user scroll. In both cases `load-more` event is fired.\n\nAvailable options:\n\n`Button` - Shows a `More` button at the bottom of the table, pressing of which triggers the `load-more` event.\n\n`Scroll` - The `load-more` event is triggered when the user scrolls to the bottom of the table;\n\n`None` (default) - The growing is off.\n\n**Restrictions:** `growing=\"Scroll\"` is not supported for Internet Explorer,\nand the component will fallback to `growing=\"Button\"`.",
|
306
301
|
"default": "\"None\"",
|
302
|
+
"description": "Defines whether the table will have growing capability either by pressing a `More` button,\nor via user scroll. In both cases `load-more` event is fired.\n\nAvailable options:\n\n`Button` - Shows a `More` button at the bottom of the table, pressing of which triggers the `load-more` event.\n\n`Scroll` - The `load-more` event is triggered when the user scrolls to the bottom of the table;\n\n`None` (default) - The growing is off.\n\n**Restrictions:** `growing=\"Scroll\"` is not supported for Internet Explorer,\nand the component will fallback to `growing=\"Button\"`.",
|
307
303
|
"privacy": "public",
|
308
|
-
"_ui5since": "2.0.0"
|
309
|
-
"_ui5validator": "TableGrowingMode"
|
304
|
+
"_ui5since": "2.0.0"
|
310
305
|
},
|
311
306
|
{
|
312
307
|
"kind": "field",
|
@@ -314,11 +309,10 @@
|
|
314
309
|
"type": {
|
315
310
|
"text": "boolean"
|
316
311
|
},
|
317
|
-
"description": "Defines if the table is in busy state.\n\nIn this state the component's opacity is reduced\nand busy indicator is displayed at the bottom of the table.",
|
318
312
|
"default": "false",
|
313
|
+
"description": "Defines if the table is in busy state.\n\nIn this state the component's opacity is reduced\nand busy indicator is displayed at the bottom of the table.",
|
319
314
|
"privacy": "public",
|
320
|
-
"_ui5since": "2.0.0"
|
321
|
-
"_ui5validator": "Boolean"
|
315
|
+
"_ui5since": "2.0.0"
|
322
316
|
},
|
323
317
|
{
|
324
318
|
"kind": "field",
|
@@ -326,10 +320,9 @@
|
|
326
320
|
"type": {
|
327
321
|
"text": "number"
|
328
322
|
},
|
329
|
-
"description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.",
|
330
323
|
"default": "1000",
|
331
|
-
"
|
332
|
-
"
|
324
|
+
"description": "Defines the delay in milliseconds, after which the busy indicator will show up for this component.",
|
325
|
+
"privacy": "public"
|
333
326
|
},
|
334
327
|
{
|
335
328
|
"kind": "field",
|
@@ -337,10 +330,9 @@
|
|
337
330
|
"type": {
|
338
331
|
"text": "boolean"
|
339
332
|
},
|
340
|
-
"description": "Determines whether the column headers remain fixed at the top of the page during\nvertical scrolling as long as the Web Component is in the viewport.\n\n**Restrictions:**\n\n- Browsers that do not support this feature:\n\n- Internet Explorer\n- Microsoft Edge lower than version 41 (EdgeHTML 16)\n- Mozilla Firefox lower than version 59\n\n- Scrolling behavior:\n\n- If the Web Component is placed in layout containers that have the `overflow: hidden`\nor `overflow: auto` style definition, this can\nprevent the sticky elements of the Web Component from becoming fixed at the top of the viewport.",
|
341
333
|
"default": "false",
|
342
|
-
"
|
343
|
-
"
|
334
|
+
"description": "Determines whether the column headers remain fixed at the top of the page during\nvertical scrolling as long as the Web Component is in the viewport.\n\n**Restrictions:**\n\n- Browsers that do not support this feature:\n\n- Internet Explorer\n- Microsoft Edge lower than version 41 (EdgeHTML 16)\n- Mozilla Firefox lower than version 59\n\n- Scrolling behavior:\n\n- If the Web Component is placed in layout containers that have the `overflow: hidden`\nor `overflow: auto` style definition, this can\nprevent the sticky elements of the Web Component from becoming fixed at the top of the viewport.",
|
335
|
+
"privacy": "public"
|
344
336
|
},
|
345
337
|
{
|
346
338
|
"kind": "field",
|
@@ -355,11 +347,10 @@
|
|
355
347
|
}
|
356
348
|
]
|
357
349
|
},
|
358
|
-
"description": "Defines the mode of the component.",
|
359
350
|
"default": "\"None\"",
|
351
|
+
"description": "Defines the mode of the component.",
|
360
352
|
"privacy": "public",
|
361
|
-
"_ui5since": "2.0.0"
|
362
|
-
"_ui5validator": "TableMode"
|
353
|
+
"_ui5since": "2.0.0"
|
363
354
|
},
|
364
355
|
{
|
365
356
|
"kind": "field",
|
@@ -370,20 +361,480 @@
|
|
370
361
|
"description": "Defines the accessible ARIA name of the component.",
|
371
362
|
"default": "undefined",
|
372
363
|
"privacy": "public",
|
373
|
-
"_ui5since": "2.0.0"
|
374
|
-
"_ui5validator": "String"
|
364
|
+
"_ui5since": "2.0.0"
|
375
365
|
},
|
376
366
|
{
|
377
367
|
"kind": "field",
|
378
368
|
"name": "accessibleNameRef",
|
379
369
|
"type": {
|
380
|
-
"text": "string"
|
370
|
+
"text": "string | undefined"
|
381
371
|
},
|
382
372
|
"description": "Receives id(or many ids) of the elements that label the component.",
|
383
|
-
"default": "
|
373
|
+
"default": "undefined",
|
384
374
|
"privacy": "public",
|
385
|
-
"_ui5since": "2.0.0"
|
386
|
-
|
375
|
+
"_ui5since": "2.0.0"
|
376
|
+
},
|
377
|
+
{
|
378
|
+
"kind": "method",
|
379
|
+
"name": "onBeforeRendering",
|
380
|
+
"return": {
|
381
|
+
"type": {
|
382
|
+
"text": "void"
|
383
|
+
}
|
384
|
+
},
|
385
|
+
"description": "Called every time before the component renders.",
|
386
|
+
"privacy": "public",
|
387
|
+
"inheritedFrom": {
|
388
|
+
"name": "UI5Element",
|
389
|
+
"package": "@ui5/webcomponents-base",
|
390
|
+
"module": "dist/UI5Element.js"
|
391
|
+
}
|
392
|
+
},
|
393
|
+
{
|
394
|
+
"kind": "method",
|
395
|
+
"name": "onAfterRendering",
|
396
|
+
"return": {
|
397
|
+
"type": {
|
398
|
+
"text": "void"
|
399
|
+
}
|
400
|
+
},
|
401
|
+
"description": "Called every time after the component renders.",
|
402
|
+
"privacy": "public",
|
403
|
+
"inheritedFrom": {
|
404
|
+
"name": "UI5Element",
|
405
|
+
"package": "@ui5/webcomponents-base",
|
406
|
+
"module": "dist/UI5Element.js"
|
407
|
+
}
|
408
|
+
},
|
409
|
+
{
|
410
|
+
"kind": "method",
|
411
|
+
"name": "onEnterDOM",
|
412
|
+
"return": {
|
413
|
+
"type": {
|
414
|
+
"text": "void"
|
415
|
+
}
|
416
|
+
},
|
417
|
+
"description": "Called on connectedCallback - added to the DOM.",
|
418
|
+
"privacy": "public",
|
419
|
+
"inheritedFrom": {
|
420
|
+
"name": "UI5Element",
|
421
|
+
"package": "@ui5/webcomponents-base",
|
422
|
+
"module": "dist/UI5Element.js"
|
423
|
+
}
|
424
|
+
},
|
425
|
+
{
|
426
|
+
"kind": "method",
|
427
|
+
"name": "onExitDOM",
|
428
|
+
"return": {
|
429
|
+
"type": {
|
430
|
+
"text": "void"
|
431
|
+
}
|
432
|
+
},
|
433
|
+
"description": "Called on disconnectedCallback - removed from the DOM.",
|
434
|
+
"privacy": "public",
|
435
|
+
"inheritedFrom": {
|
436
|
+
"name": "UI5Element",
|
437
|
+
"package": "@ui5/webcomponents-base",
|
438
|
+
"module": "dist/UI5Element.js"
|
439
|
+
}
|
440
|
+
},
|
441
|
+
{
|
442
|
+
"kind": "method",
|
443
|
+
"name": "attachInvalidate",
|
444
|
+
"return": {
|
445
|
+
"type": {
|
446
|
+
"text": "void"
|
447
|
+
}
|
448
|
+
},
|
449
|
+
"parameters": [
|
450
|
+
{
|
451
|
+
"name": "callback",
|
452
|
+
"type": {
|
453
|
+
"text": "(param: InvalidationInfo) => void"
|
454
|
+
},
|
455
|
+
"_ui5privacy": "public"
|
456
|
+
}
|
457
|
+
],
|
458
|
+
"description": "Attach a callback that will be executed whenever the component is invalidated",
|
459
|
+
"privacy": "public",
|
460
|
+
"inheritedFrom": {
|
461
|
+
"name": "UI5Element",
|
462
|
+
"package": "@ui5/webcomponents-base",
|
463
|
+
"module": "dist/UI5Element.js"
|
464
|
+
}
|
465
|
+
},
|
466
|
+
{
|
467
|
+
"kind": "method",
|
468
|
+
"name": "detachInvalidate",
|
469
|
+
"return": {
|
470
|
+
"type": {
|
471
|
+
"text": "void"
|
472
|
+
}
|
473
|
+
},
|
474
|
+
"parameters": [
|
475
|
+
{
|
476
|
+
"name": "callback",
|
477
|
+
"type": {
|
478
|
+
"text": "(param: InvalidationInfo) => void"
|
479
|
+
},
|
480
|
+
"_ui5privacy": "public"
|
481
|
+
}
|
482
|
+
],
|
483
|
+
"description": "Detach the callback that is executed whenever the component is invalidated",
|
484
|
+
"privacy": "public",
|
485
|
+
"inheritedFrom": {
|
486
|
+
"name": "UI5Element",
|
487
|
+
"package": "@ui5/webcomponents-base",
|
488
|
+
"module": "dist/UI5Element.js"
|
489
|
+
}
|
490
|
+
},
|
491
|
+
{
|
492
|
+
"kind": "method",
|
493
|
+
"name": "onInvalidation",
|
494
|
+
"return": {
|
495
|
+
"type": {
|
496
|
+
"text": "void"
|
497
|
+
}
|
498
|
+
},
|
499
|
+
"parameters": [
|
500
|
+
{
|
501
|
+
"name": "changeInfo",
|
502
|
+
"type": {
|
503
|
+
"text": "ChangeInfo",
|
504
|
+
"references": [
|
505
|
+
{
|
506
|
+
"name": "ChangeInfo",
|
507
|
+
"package": "@ui5/webcomponents-base",
|
508
|
+
"module": "dist/UI5Element.js"
|
509
|
+
}
|
510
|
+
]
|
511
|
+
},
|
512
|
+
"description": "An object with information about the change that caused invalidation.\nThe object can have the following properties:\n- type: (property|slot) tells what caused the invalidation\n1) property: a property value was changed either directly or as a result of changing the corresponding attribute\n2) slot: a slotted node(nodes) changed in one of several ways (see \"reason\")\n\n- name: the name of the property or slot that caused the invalidation\n\n- reason: (children|textcontent|childchange|slotchange) relevant only for type=\"slot\" only and tells exactly what changed in the slot\n1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot\n2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of \"type: Node\"\n3) slotchange: a slot element, slotted inside that slot had its \"slotchange\" event listener called. This practically means that transitively slotted children changed.\nCan only trigger if the child of a slot is a slot element itself.\n4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.\nCan only trigger for slots with \"invalidateOnChildChange\" metadata descriptor\n\n- newValue: the new value of the property (for type=\"property\" only)\n\n- oldValue: the old value of the property (for type=\"property\" only)\n\n- child the child that was changed (for type=\"slot\" and reason=\"childchange\" only)",
|
513
|
+
"_ui5privacy": "public"
|
514
|
+
}
|
515
|
+
],
|
516
|
+
"description": "A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)",
|
517
|
+
"privacy": "public",
|
518
|
+
"inheritedFrom": {
|
519
|
+
"name": "UI5Element",
|
520
|
+
"package": "@ui5/webcomponents-base",
|
521
|
+
"module": "dist/UI5Element.js"
|
522
|
+
}
|
523
|
+
},
|
524
|
+
{
|
525
|
+
"kind": "method",
|
526
|
+
"name": "getDomRef",
|
527
|
+
"return": {
|
528
|
+
"type": {
|
529
|
+
"text": "HTMLElement | undefined"
|
530
|
+
}
|
531
|
+
},
|
532
|
+
"description": "Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template\n*Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option\nUse this method instead of \"this.shadowRoot\" to read the Shadow DOM, if ever necessary",
|
533
|
+
"privacy": "public",
|
534
|
+
"inheritedFrom": {
|
535
|
+
"name": "UI5Element",
|
536
|
+
"package": "@ui5/webcomponents-base",
|
537
|
+
"module": "dist/UI5Element.js"
|
538
|
+
}
|
539
|
+
},
|
540
|
+
{
|
541
|
+
"kind": "method",
|
542
|
+
"name": "getFocusDomRef",
|
543
|
+
"return": {
|
544
|
+
"type": {
|
545
|
+
"text": "HTMLElement | undefined"
|
546
|
+
}
|
547
|
+
},
|
548
|
+
"description": "Returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
549
|
+
"privacy": "public",
|
550
|
+
"inheritedFrom": {
|
551
|
+
"name": "UI5Element",
|
552
|
+
"package": "@ui5/webcomponents-base",
|
553
|
+
"module": "dist/UI5Element.js"
|
554
|
+
}
|
555
|
+
},
|
556
|
+
{
|
557
|
+
"kind": "method",
|
558
|
+
"name": "getFocusDomRefAsync",
|
559
|
+
"return": {
|
560
|
+
"type": {
|
561
|
+
"text": "Promise<HTMLElement | undefined>"
|
562
|
+
}
|
563
|
+
},
|
564
|
+
"description": "Waits for dom ref and then returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
565
|
+
"privacy": "public",
|
566
|
+
"inheritedFrom": {
|
567
|
+
"name": "UI5Element",
|
568
|
+
"package": "@ui5/webcomponents-base",
|
569
|
+
"module": "dist/UI5Element.js"
|
570
|
+
}
|
571
|
+
},
|
572
|
+
{
|
573
|
+
"kind": "method",
|
574
|
+
"name": "focus",
|
575
|
+
"return": {
|
576
|
+
"type": {
|
577
|
+
"text": "Promise<void>"
|
578
|
+
}
|
579
|
+
},
|
580
|
+
"parameters": [
|
581
|
+
{
|
582
|
+
"name": "focusOptions",
|
583
|
+
"optional": true,
|
584
|
+
"type": {
|
585
|
+
"text": "FocusOptions"
|
586
|
+
},
|
587
|
+
"description": "additional options for the focus",
|
588
|
+
"_ui5privacy": "public"
|
589
|
+
}
|
590
|
+
],
|
591
|
+
"description": "Set the focus to the element, returned by \"getFocusDomRef()\" (marked by \"data-sap-focus-ref\")",
|
592
|
+
"privacy": "public",
|
593
|
+
"inheritedFrom": {
|
594
|
+
"name": "UI5Element",
|
595
|
+
"package": "@ui5/webcomponents-base",
|
596
|
+
"module": "dist/UI5Element.js"
|
597
|
+
}
|
598
|
+
},
|
599
|
+
{
|
600
|
+
"kind": "method",
|
601
|
+
"name": "fireEvent",
|
602
|
+
"return": {
|
603
|
+
"type": {
|
604
|
+
"text": "boolean"
|
605
|
+
},
|
606
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
607
|
+
},
|
608
|
+
"parameters": [
|
609
|
+
{
|
610
|
+
"name": "name",
|
611
|
+
"type": {
|
612
|
+
"text": "string"
|
613
|
+
},
|
614
|
+
"description": "name of the event",
|
615
|
+
"_ui5privacy": "public"
|
616
|
+
},
|
617
|
+
{
|
618
|
+
"name": "data",
|
619
|
+
"optional": true,
|
620
|
+
"type": {
|
621
|
+
"text": "T"
|
622
|
+
},
|
623
|
+
"description": "additional data for the event",
|
624
|
+
"_ui5privacy": "public"
|
625
|
+
},
|
626
|
+
{
|
627
|
+
"name": "cancelable",
|
628
|
+
"default": "false",
|
629
|
+
"description": "true, if the user can call preventDefault on the event object",
|
630
|
+
"_ui5privacy": "public"
|
631
|
+
},
|
632
|
+
{
|
633
|
+
"name": "bubbles",
|
634
|
+
"default": "true",
|
635
|
+
"description": "true, if the event bubbles",
|
636
|
+
"_ui5privacy": "public"
|
637
|
+
}
|
638
|
+
],
|
639
|
+
"privacy": "public",
|
640
|
+
"deprecated": "use fireDecoratorEvent instead",
|
641
|
+
"inheritedFrom": {
|
642
|
+
"name": "UI5Element",
|
643
|
+
"package": "@ui5/webcomponents-base",
|
644
|
+
"module": "dist/UI5Element.js"
|
645
|
+
}
|
646
|
+
},
|
647
|
+
{
|
648
|
+
"kind": "method",
|
649
|
+
"name": "fireDecoratorEvent",
|
650
|
+
"return": {
|
651
|
+
"type": {
|
652
|
+
"text": "boolean"
|
653
|
+
},
|
654
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
655
|
+
},
|
656
|
+
"parameters": [
|
657
|
+
{
|
658
|
+
"name": "name",
|
659
|
+
"type": {
|
660
|
+
"text": "N"
|
661
|
+
},
|
662
|
+
"description": "name of the event",
|
663
|
+
"_ui5privacy": "public"
|
664
|
+
},
|
665
|
+
{
|
666
|
+
"name": "data",
|
667
|
+
"optional": true,
|
668
|
+
"type": {
|
669
|
+
"text": "this[\"eventDetails\"][N] | undefined"
|
670
|
+
},
|
671
|
+
"description": "additional data for the event",
|
672
|
+
"_ui5privacy": "public"
|
673
|
+
}
|
674
|
+
],
|
675
|
+
"description": "Fires a custom event, configured via the \"event\" decorator.",
|
676
|
+
"privacy": "public",
|
677
|
+
"inheritedFrom": {
|
678
|
+
"name": "UI5Element",
|
679
|
+
"package": "@ui5/webcomponents-base",
|
680
|
+
"module": "dist/UI5Element.js"
|
681
|
+
}
|
682
|
+
},
|
683
|
+
{
|
684
|
+
"kind": "method",
|
685
|
+
"name": "getSlottedNodes",
|
686
|
+
"return": {
|
687
|
+
"type": {
|
688
|
+
"text": "Array<T>"
|
689
|
+
}
|
690
|
+
},
|
691
|
+
"description": "Returns the actual children, associated with a slot.\nUseful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.",
|
692
|
+
"privacy": "public",
|
693
|
+
"inheritedFrom": {
|
694
|
+
"name": "UI5Element",
|
695
|
+
"package": "@ui5/webcomponents-base",
|
696
|
+
"module": "dist/UI5Element.js"
|
697
|
+
}
|
698
|
+
},
|
699
|
+
{
|
700
|
+
"kind": "method",
|
701
|
+
"name": "attachComponentStateFinalized",
|
702
|
+
"return": {
|
703
|
+
"type": {
|
704
|
+
"text": "void"
|
705
|
+
}
|
706
|
+
},
|
707
|
+
"parameters": [
|
708
|
+
{
|
709
|
+
"name": "callback",
|
710
|
+
"type": {
|
711
|
+
"text": "() => void"
|
712
|
+
},
|
713
|
+
"_ui5privacy": "public"
|
714
|
+
}
|
715
|
+
],
|
716
|
+
"description": "Attach a callback that will be executed whenever the component's state is finalized",
|
717
|
+
"privacy": "public",
|
718
|
+
"inheritedFrom": {
|
719
|
+
"name": "UI5Element",
|
720
|
+
"package": "@ui5/webcomponents-base",
|
721
|
+
"module": "dist/UI5Element.js"
|
722
|
+
}
|
723
|
+
},
|
724
|
+
{
|
725
|
+
"kind": "method",
|
726
|
+
"name": "detachComponentStateFinalized",
|
727
|
+
"return": {
|
728
|
+
"type": {
|
729
|
+
"text": "void"
|
730
|
+
}
|
731
|
+
},
|
732
|
+
"parameters": [
|
733
|
+
{
|
734
|
+
"name": "callback",
|
735
|
+
"type": {
|
736
|
+
"text": "() => void"
|
737
|
+
},
|
738
|
+
"_ui5privacy": "public"
|
739
|
+
}
|
740
|
+
],
|
741
|
+
"description": "Detach the callback that is executed whenever the component's state is finalized",
|
742
|
+
"privacy": "public",
|
743
|
+
"inheritedFrom": {
|
744
|
+
"name": "UI5Element",
|
745
|
+
"package": "@ui5/webcomponents-base",
|
746
|
+
"module": "dist/UI5Element.js"
|
747
|
+
}
|
748
|
+
},
|
749
|
+
{
|
750
|
+
"kind": "field",
|
751
|
+
"name": "effectiveDir",
|
752
|
+
"type": {
|
753
|
+
"text": "string | undefined"
|
754
|
+
},
|
755
|
+
"description": "Determines whether the component should be rendered in RTL mode or not.\nReturns: \"rtl\", \"ltr\" or undefined",
|
756
|
+
"privacy": "public",
|
757
|
+
"default": "undefined",
|
758
|
+
"readonly": true,
|
759
|
+
"inheritedFrom": {
|
760
|
+
"name": "UI5Element",
|
761
|
+
"package": "@ui5/webcomponents-base",
|
762
|
+
"module": "dist/UI5Element.js"
|
763
|
+
}
|
764
|
+
},
|
765
|
+
{
|
766
|
+
"kind": "field",
|
767
|
+
"name": "isUI5Element",
|
768
|
+
"type": {
|
769
|
+
"text": "boolean"
|
770
|
+
},
|
771
|
+
"description": "Used to duck-type UI5 elements without using instanceof",
|
772
|
+
"privacy": "public",
|
773
|
+
"default": "true",
|
774
|
+
"readonly": true,
|
775
|
+
"inheritedFrom": {
|
776
|
+
"name": "UI5Element",
|
777
|
+
"package": "@ui5/webcomponents-base",
|
778
|
+
"module": "dist/UI5Element.js"
|
779
|
+
}
|
780
|
+
},
|
781
|
+
{
|
782
|
+
"kind": "method",
|
783
|
+
"name": "getUniqueDependencies",
|
784
|
+
"static": true,
|
785
|
+
"return": {
|
786
|
+
"type": {
|
787
|
+
"text": "Array<typeof UI5Element>"
|
788
|
+
}
|
789
|
+
},
|
790
|
+
"description": "Returns a list of the unique dependencies for this UI5 Web Component",
|
791
|
+
"privacy": "public",
|
792
|
+
"inheritedFrom": {
|
793
|
+
"name": "UI5Element",
|
794
|
+
"package": "@ui5/webcomponents-base",
|
795
|
+
"module": "dist/UI5Element.js"
|
796
|
+
}
|
797
|
+
},
|
798
|
+
{
|
799
|
+
"kind": "method",
|
800
|
+
"name": "define",
|
801
|
+
"static": true,
|
802
|
+
"return": {
|
803
|
+
"type": {
|
804
|
+
"text": "typeof UI5Element"
|
805
|
+
}
|
806
|
+
},
|
807
|
+
"description": "Registers a UI5 Web Component in the browser window object",
|
808
|
+
"privacy": "public",
|
809
|
+
"inheritedFrom": {
|
810
|
+
"name": "UI5Element",
|
811
|
+
"package": "@ui5/webcomponents-base",
|
812
|
+
"module": "dist/UI5Element.js"
|
813
|
+
}
|
814
|
+
},
|
815
|
+
{
|
816
|
+
"kind": "method",
|
817
|
+
"name": "getMetadata",
|
818
|
+
"static": true,
|
819
|
+
"return": {
|
820
|
+
"type": {
|
821
|
+
"text": "UI5ElementMetadata",
|
822
|
+
"references": [
|
823
|
+
{
|
824
|
+
"name": "UI5ElementMetadata",
|
825
|
+
"package": "@ui5/webcomponents-base",
|
826
|
+
"module": "dist/UI5ElementMetadata.js"
|
827
|
+
}
|
828
|
+
]
|
829
|
+
}
|
830
|
+
},
|
831
|
+
"description": "Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')\nNote: not to be confused with the \"get metadata()\" method, which returns an object for this class's metadata only",
|
832
|
+
"privacy": "public",
|
833
|
+
"inheritedFrom": {
|
834
|
+
"name": "UI5Element",
|
835
|
+
"package": "@ui5/webcomponents-base",
|
836
|
+
"module": "dist/UI5Element.js"
|
837
|
+
}
|
387
838
|
}
|
388
839
|
],
|
389
840
|
"events": [
|
@@ -401,6 +852,9 @@
|
|
401
852
|
]
|
402
853
|
},
|
403
854
|
"description": "Fired when a row in `Active` mode is clicked or `Enter` key is pressed.",
|
855
|
+
"_ui5Cancelable": false,
|
856
|
+
"_ui5allowPreventDefault": false,
|
857
|
+
"_ui5Bubbles": true,
|
404
858
|
"_ui5parameters": [
|
405
859
|
{
|
406
860
|
"type": {
|
@@ -426,6 +880,9 @@
|
|
426
880
|
]
|
427
881
|
},
|
428
882
|
"description": "Fired when `ui5-table-column` is shown as a pop-in instead of hiding it.",
|
883
|
+
"_ui5Cancelable": false,
|
884
|
+
"_ui5allowPreventDefault": false,
|
885
|
+
"_ui5Bubbles": true,
|
429
886
|
"_ui5since": "2.0.0",
|
430
887
|
"_ui5parameters": [
|
431
888
|
{
|
@@ -445,6 +902,9 @@
|
|
445
902
|
"text": "CustomEvent"
|
446
903
|
},
|
447
904
|
"description": "Fired when the user presses the `More` button or scrolls to the table's end.\n\n**Note:** The event will be fired if `growing` is set to `Button` or `Scroll`.",
|
905
|
+
"_ui5Cancelable": false,
|
906
|
+
"_ui5allowPreventDefault": false,
|
907
|
+
"_ui5Bubbles": true,
|
448
908
|
"_ui5since": "2.0.0"
|
449
909
|
},
|
450
910
|
{
|
@@ -461,6 +921,9 @@
|
|
461
921
|
]
|
462
922
|
},
|
463
923
|
"description": "Fired when selection is changed by user interaction\nin `SingleSelect` and `MultiSelect` modes.",
|
924
|
+
"_ui5Cancelable": false,
|
925
|
+
"_ui5allowPreventDefault": false,
|
926
|
+
"_ui5Bubbles": true,
|
464
927
|
"_ui5since": "2.0.0",
|
465
928
|
"_ui5parameters": [
|
466
929
|
{
|
@@ -486,28 +949,28 @@
|
|
486
949
|
{
|
487
950
|
"description": "Defines the text that will be displayed when there is no data and `hideNoData` is not present.",
|
488
951
|
"name": "no-data-text",
|
489
|
-
"default": "
|
952
|
+
"default": "undefined",
|
490
953
|
"fieldName": "noDataText",
|
491
954
|
"type": {
|
492
|
-
"text": "string"
|
955
|
+
"text": "string | undefined"
|
493
956
|
}
|
494
957
|
},
|
495
958
|
{
|
496
959
|
"description": "Defines the text that will be displayed inside the growing button at the bottom of the table,\nmeant for loading more rows upon press.\n\n**Note:** If not specified a built-in text will be displayed.\n\n**Note:** This property takes effect if `growing` is set to `Button`.",
|
497
960
|
"name": "growing-button-text",
|
498
|
-
"default": "
|
961
|
+
"default": "undefined",
|
499
962
|
"fieldName": "growingButtonText",
|
500
963
|
"type": {
|
501
|
-
"text": "string"
|
964
|
+
"text": "string | undefined"
|
502
965
|
}
|
503
966
|
},
|
504
967
|
{
|
505
968
|
"description": "Defines the subtext that will be displayed under the `growingButtonText`.\n\n**Note:** This property takes effect if `growing` is set to `Button`.",
|
506
969
|
"name": "growing-button-subtext",
|
507
|
-
"default": "
|
970
|
+
"default": "undefined",
|
508
971
|
"fieldName": "growingButtonSubtext",
|
509
972
|
"type": {
|
510
|
-
"text": "string"
|
973
|
+
"text": "string | undefined"
|
511
974
|
}
|
512
975
|
},
|
513
976
|
{
|
@@ -576,10 +1039,10 @@
|
|
576
1039
|
{
|
577
1040
|
"description": "Receives id(or many ids) of the elements that label the component.",
|
578
1041
|
"name": "accessible-name-ref",
|
579
|
-
"default": "
|
1042
|
+
"default": "undefined",
|
580
1043
|
"fieldName": "accessibleNameRef",
|
581
1044
|
"type": {
|
582
|
-
"text": "string"
|
1045
|
+
"text": "string | undefined"
|
583
1046
|
}
|
584
1047
|
}
|
585
1048
|
],
|
@@ -644,103 +1107,1025 @@
|
|
644
1107
|
},
|
645
1108
|
"tagName": "ui5-table-cell",
|
646
1109
|
"customElement": true,
|
647
|
-
"_ui5privacy": "public"
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
1110
|
+
"_ui5privacy": "public",
|
1111
|
+
"members": [
|
1112
|
+
{
|
1113
|
+
"kind": "method",
|
1114
|
+
"name": "onBeforeRendering",
|
1115
|
+
"return": {
|
1116
|
+
"type": {
|
1117
|
+
"text": "void"
|
1118
|
+
}
|
1119
|
+
},
|
1120
|
+
"description": "Called every time before the component renders.",
|
1121
|
+
"privacy": "public",
|
1122
|
+
"inheritedFrom": {
|
1123
|
+
"name": "UI5Element",
|
1124
|
+
"package": "@ui5/webcomponents-base",
|
1125
|
+
"module": "dist/UI5Element.js"
|
1126
|
+
}
|
1127
|
+
},
|
1128
|
+
{
|
1129
|
+
"kind": "method",
|
1130
|
+
"name": "onAfterRendering",
|
1131
|
+
"return": {
|
1132
|
+
"type": {
|
1133
|
+
"text": "void"
|
1134
|
+
}
|
1135
|
+
},
|
1136
|
+
"description": "Called every time after the component renders.",
|
1137
|
+
"privacy": "public",
|
1138
|
+
"inheritedFrom": {
|
1139
|
+
"name": "UI5Element",
|
1140
|
+
"package": "@ui5/webcomponents-base",
|
1141
|
+
"module": "dist/UI5Element.js"
|
1142
|
+
}
|
1143
|
+
},
|
1144
|
+
{
|
1145
|
+
"kind": "method",
|
1146
|
+
"name": "onEnterDOM",
|
1147
|
+
"return": {
|
1148
|
+
"type": {
|
1149
|
+
"text": "void"
|
1150
|
+
}
|
1151
|
+
},
|
1152
|
+
"description": "Called on connectedCallback - added to the DOM.",
|
1153
|
+
"privacy": "public",
|
1154
|
+
"inheritedFrom": {
|
1155
|
+
"name": "UI5Element",
|
1156
|
+
"package": "@ui5/webcomponents-base",
|
1157
|
+
"module": "dist/UI5Element.js"
|
1158
|
+
}
|
1159
|
+
},
|
1160
|
+
{
|
1161
|
+
"kind": "method",
|
1162
|
+
"name": "onExitDOM",
|
1163
|
+
"return": {
|
1164
|
+
"type": {
|
1165
|
+
"text": "void"
|
1166
|
+
}
|
1167
|
+
},
|
1168
|
+
"description": "Called on disconnectedCallback - removed from the DOM.",
|
1169
|
+
"privacy": "public",
|
1170
|
+
"inheritedFrom": {
|
1171
|
+
"name": "UI5Element",
|
1172
|
+
"package": "@ui5/webcomponents-base",
|
1173
|
+
"module": "dist/UI5Element.js"
|
1174
|
+
}
|
1175
|
+
},
|
1176
|
+
{
|
1177
|
+
"kind": "method",
|
1178
|
+
"name": "attachInvalidate",
|
1179
|
+
"return": {
|
1180
|
+
"type": {
|
1181
|
+
"text": "void"
|
1182
|
+
}
|
1183
|
+
},
|
1184
|
+
"parameters": [
|
1185
|
+
{
|
1186
|
+
"name": "callback",
|
1187
|
+
"type": {
|
1188
|
+
"text": "(param: InvalidationInfo) => void"
|
1189
|
+
},
|
1190
|
+
"_ui5privacy": "public"
|
1191
|
+
}
|
1192
|
+
],
|
1193
|
+
"description": "Attach a callback that will be executed whenever the component is invalidated",
|
1194
|
+
"privacy": "public",
|
1195
|
+
"inheritedFrom": {
|
1196
|
+
"name": "UI5Element",
|
1197
|
+
"package": "@ui5/webcomponents-base",
|
1198
|
+
"module": "dist/UI5Element.js"
|
1199
|
+
}
|
1200
|
+
},
|
1201
|
+
{
|
1202
|
+
"kind": "method",
|
1203
|
+
"name": "detachInvalidate",
|
1204
|
+
"return": {
|
1205
|
+
"type": {
|
1206
|
+
"text": "void"
|
1207
|
+
}
|
1208
|
+
},
|
1209
|
+
"parameters": [
|
1210
|
+
{
|
1211
|
+
"name": "callback",
|
1212
|
+
"type": {
|
1213
|
+
"text": "(param: InvalidationInfo) => void"
|
1214
|
+
},
|
1215
|
+
"_ui5privacy": "public"
|
1216
|
+
}
|
1217
|
+
],
|
1218
|
+
"description": "Detach the callback that is executed whenever the component is invalidated",
|
1219
|
+
"privacy": "public",
|
1220
|
+
"inheritedFrom": {
|
1221
|
+
"name": "UI5Element",
|
1222
|
+
"package": "@ui5/webcomponents-base",
|
1223
|
+
"module": "dist/UI5Element.js"
|
1224
|
+
}
|
1225
|
+
},
|
1226
|
+
{
|
1227
|
+
"kind": "method",
|
1228
|
+
"name": "onInvalidation",
|
1229
|
+
"return": {
|
1230
|
+
"type": {
|
1231
|
+
"text": "void"
|
1232
|
+
}
|
1233
|
+
},
|
1234
|
+
"parameters": [
|
1235
|
+
{
|
1236
|
+
"name": "changeInfo",
|
1237
|
+
"type": {
|
1238
|
+
"text": "ChangeInfo",
|
1239
|
+
"references": [
|
1240
|
+
{
|
1241
|
+
"name": "ChangeInfo",
|
1242
|
+
"package": "@ui5/webcomponents-base",
|
1243
|
+
"module": "dist/UI5Element.js"
|
1244
|
+
}
|
1245
|
+
]
|
1246
|
+
},
|
1247
|
+
"description": "An object with information about the change that caused invalidation.\nThe object can have the following properties:\n- type: (property|slot) tells what caused the invalidation\n1) property: a property value was changed either directly or as a result of changing the corresponding attribute\n2) slot: a slotted node(nodes) changed in one of several ways (see \"reason\")\n\n- name: the name of the property or slot that caused the invalidation\n\n- reason: (children|textcontent|childchange|slotchange) relevant only for type=\"slot\" only and tells exactly what changed in the slot\n1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot\n2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of \"type: Node\"\n3) slotchange: a slot element, slotted inside that slot had its \"slotchange\" event listener called. This practically means that transitively slotted children changed.\nCan only trigger if the child of a slot is a slot element itself.\n4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.\nCan only trigger for slots with \"invalidateOnChildChange\" metadata descriptor\n\n- newValue: the new value of the property (for type=\"property\" only)\n\n- oldValue: the old value of the property (for type=\"property\" only)\n\n- child the child that was changed (for type=\"slot\" and reason=\"childchange\" only)",
|
1248
|
+
"_ui5privacy": "public"
|
1249
|
+
}
|
1250
|
+
],
|
1251
|
+
"description": "A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)",
|
1252
|
+
"privacy": "public",
|
1253
|
+
"inheritedFrom": {
|
1254
|
+
"name": "UI5Element",
|
1255
|
+
"package": "@ui5/webcomponents-base",
|
1256
|
+
"module": "dist/UI5Element.js"
|
1257
|
+
}
|
1258
|
+
},
|
1259
|
+
{
|
1260
|
+
"kind": "method",
|
1261
|
+
"name": "getDomRef",
|
1262
|
+
"return": {
|
1263
|
+
"type": {
|
1264
|
+
"text": "HTMLElement | undefined"
|
1265
|
+
}
|
1266
|
+
},
|
1267
|
+
"description": "Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template\n*Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option\nUse this method instead of \"this.shadowRoot\" to read the Shadow DOM, if ever necessary",
|
1268
|
+
"privacy": "public",
|
1269
|
+
"inheritedFrom": {
|
1270
|
+
"name": "UI5Element",
|
1271
|
+
"package": "@ui5/webcomponents-base",
|
1272
|
+
"module": "dist/UI5Element.js"
|
1273
|
+
}
|
1274
|
+
},
|
1275
|
+
{
|
1276
|
+
"kind": "method",
|
1277
|
+
"name": "getFocusDomRef",
|
1278
|
+
"return": {
|
1279
|
+
"type": {
|
1280
|
+
"text": "HTMLElement | undefined"
|
1281
|
+
}
|
1282
|
+
},
|
1283
|
+
"description": "Returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
1284
|
+
"privacy": "public",
|
1285
|
+
"inheritedFrom": {
|
1286
|
+
"name": "UI5Element",
|
1287
|
+
"package": "@ui5/webcomponents-base",
|
1288
|
+
"module": "dist/UI5Element.js"
|
1289
|
+
}
|
1290
|
+
},
|
1291
|
+
{
|
1292
|
+
"kind": "method",
|
1293
|
+
"name": "getFocusDomRefAsync",
|
1294
|
+
"return": {
|
1295
|
+
"type": {
|
1296
|
+
"text": "Promise<HTMLElement | undefined>"
|
1297
|
+
}
|
1298
|
+
},
|
1299
|
+
"description": "Waits for dom ref and then returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
1300
|
+
"privacy": "public",
|
1301
|
+
"inheritedFrom": {
|
1302
|
+
"name": "UI5Element",
|
1303
|
+
"package": "@ui5/webcomponents-base",
|
1304
|
+
"module": "dist/UI5Element.js"
|
1305
|
+
}
|
1306
|
+
},
|
1307
|
+
{
|
1308
|
+
"kind": "method",
|
1309
|
+
"name": "focus",
|
1310
|
+
"return": {
|
1311
|
+
"type": {
|
1312
|
+
"text": "Promise<void>"
|
1313
|
+
}
|
1314
|
+
},
|
1315
|
+
"parameters": [
|
1316
|
+
{
|
1317
|
+
"name": "focusOptions",
|
1318
|
+
"optional": true,
|
1319
|
+
"type": {
|
1320
|
+
"text": "FocusOptions"
|
1321
|
+
},
|
1322
|
+
"description": "additional options for the focus",
|
1323
|
+
"_ui5privacy": "public"
|
1324
|
+
}
|
1325
|
+
],
|
1326
|
+
"description": "Set the focus to the element, returned by \"getFocusDomRef()\" (marked by \"data-sap-focus-ref\")",
|
1327
|
+
"privacy": "public",
|
1328
|
+
"inheritedFrom": {
|
1329
|
+
"name": "UI5Element",
|
1330
|
+
"package": "@ui5/webcomponents-base",
|
1331
|
+
"module": "dist/UI5Element.js"
|
1332
|
+
}
|
1333
|
+
},
|
1334
|
+
{
|
1335
|
+
"kind": "method",
|
1336
|
+
"name": "fireEvent",
|
1337
|
+
"return": {
|
1338
|
+
"type": {
|
1339
|
+
"text": "boolean"
|
1340
|
+
},
|
1341
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
1342
|
+
},
|
1343
|
+
"parameters": [
|
1344
|
+
{
|
1345
|
+
"name": "name",
|
1346
|
+
"type": {
|
1347
|
+
"text": "string"
|
1348
|
+
},
|
1349
|
+
"description": "name of the event",
|
1350
|
+
"_ui5privacy": "public"
|
1351
|
+
},
|
1352
|
+
{
|
1353
|
+
"name": "data",
|
1354
|
+
"optional": true,
|
1355
|
+
"type": {
|
1356
|
+
"text": "T"
|
1357
|
+
},
|
1358
|
+
"description": "additional data for the event",
|
1359
|
+
"_ui5privacy": "public"
|
1360
|
+
},
|
1361
|
+
{
|
1362
|
+
"name": "cancelable",
|
1363
|
+
"default": "false",
|
1364
|
+
"description": "true, if the user can call preventDefault on the event object",
|
1365
|
+
"_ui5privacy": "public"
|
1366
|
+
},
|
1367
|
+
{
|
1368
|
+
"name": "bubbles",
|
1369
|
+
"default": "true",
|
1370
|
+
"description": "true, if the event bubbles",
|
1371
|
+
"_ui5privacy": "public"
|
1372
|
+
}
|
1373
|
+
],
|
1374
|
+
"privacy": "public",
|
1375
|
+
"deprecated": "use fireDecoratorEvent instead",
|
1376
|
+
"inheritedFrom": {
|
1377
|
+
"name": "UI5Element",
|
1378
|
+
"package": "@ui5/webcomponents-base",
|
1379
|
+
"module": "dist/UI5Element.js"
|
1380
|
+
}
|
1381
|
+
},
|
1382
|
+
{
|
1383
|
+
"kind": "method",
|
1384
|
+
"name": "fireDecoratorEvent",
|
1385
|
+
"return": {
|
1386
|
+
"type": {
|
1387
|
+
"text": "boolean"
|
1388
|
+
},
|
1389
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
1390
|
+
},
|
1391
|
+
"parameters": [
|
1392
|
+
{
|
1393
|
+
"name": "name",
|
1394
|
+
"type": {
|
1395
|
+
"text": "N"
|
1396
|
+
},
|
1397
|
+
"description": "name of the event",
|
1398
|
+
"_ui5privacy": "public"
|
1399
|
+
},
|
1400
|
+
{
|
1401
|
+
"name": "data",
|
1402
|
+
"optional": true,
|
1403
|
+
"type": {
|
1404
|
+
"text": "this[\"eventDetails\"][N] | undefined"
|
1405
|
+
},
|
1406
|
+
"description": "additional data for the event",
|
1407
|
+
"_ui5privacy": "public"
|
1408
|
+
}
|
1409
|
+
],
|
1410
|
+
"description": "Fires a custom event, configured via the \"event\" decorator.",
|
1411
|
+
"privacy": "public",
|
1412
|
+
"inheritedFrom": {
|
1413
|
+
"name": "UI5Element",
|
1414
|
+
"package": "@ui5/webcomponents-base",
|
1415
|
+
"module": "dist/UI5Element.js"
|
1416
|
+
}
|
1417
|
+
},
|
1418
|
+
{
|
1419
|
+
"kind": "method",
|
1420
|
+
"name": "getSlottedNodes",
|
1421
|
+
"return": {
|
1422
|
+
"type": {
|
1423
|
+
"text": "Array<T>"
|
1424
|
+
}
|
1425
|
+
},
|
1426
|
+
"description": "Returns the actual children, associated with a slot.\nUseful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.",
|
1427
|
+
"privacy": "public",
|
1428
|
+
"inheritedFrom": {
|
1429
|
+
"name": "UI5Element",
|
1430
|
+
"package": "@ui5/webcomponents-base",
|
1431
|
+
"module": "dist/UI5Element.js"
|
1432
|
+
}
|
1433
|
+
},
|
1434
|
+
{
|
1435
|
+
"kind": "method",
|
1436
|
+
"name": "attachComponentStateFinalized",
|
1437
|
+
"return": {
|
1438
|
+
"type": {
|
1439
|
+
"text": "void"
|
1440
|
+
}
|
1441
|
+
},
|
1442
|
+
"parameters": [
|
1443
|
+
{
|
1444
|
+
"name": "callback",
|
1445
|
+
"type": {
|
1446
|
+
"text": "() => void"
|
1447
|
+
},
|
1448
|
+
"_ui5privacy": "public"
|
1449
|
+
}
|
1450
|
+
],
|
1451
|
+
"description": "Attach a callback that will be executed whenever the component's state is finalized",
|
1452
|
+
"privacy": "public",
|
1453
|
+
"inheritedFrom": {
|
1454
|
+
"name": "UI5Element",
|
1455
|
+
"package": "@ui5/webcomponents-base",
|
1456
|
+
"module": "dist/UI5Element.js"
|
1457
|
+
}
|
1458
|
+
},
|
1459
|
+
{
|
1460
|
+
"kind": "method",
|
1461
|
+
"name": "detachComponentStateFinalized",
|
1462
|
+
"return": {
|
1463
|
+
"type": {
|
1464
|
+
"text": "void"
|
1465
|
+
}
|
1466
|
+
},
|
1467
|
+
"parameters": [
|
1468
|
+
{
|
1469
|
+
"name": "callback",
|
1470
|
+
"type": {
|
1471
|
+
"text": "() => void"
|
1472
|
+
},
|
1473
|
+
"_ui5privacy": "public"
|
1474
|
+
}
|
1475
|
+
],
|
1476
|
+
"description": "Detach the callback that is executed whenever the component's state is finalized",
|
1477
|
+
"privacy": "public",
|
1478
|
+
"inheritedFrom": {
|
1479
|
+
"name": "UI5Element",
|
1480
|
+
"package": "@ui5/webcomponents-base",
|
1481
|
+
"module": "dist/UI5Element.js"
|
1482
|
+
}
|
1483
|
+
},
|
1484
|
+
{
|
1485
|
+
"kind": "field",
|
1486
|
+
"name": "effectiveDir",
|
1487
|
+
"type": {
|
1488
|
+
"text": "string | undefined"
|
1489
|
+
},
|
1490
|
+
"description": "Determines whether the component should be rendered in RTL mode or not.\nReturns: \"rtl\", \"ltr\" or undefined",
|
1491
|
+
"privacy": "public",
|
1492
|
+
"default": "undefined",
|
1493
|
+
"readonly": true,
|
1494
|
+
"inheritedFrom": {
|
1495
|
+
"name": "UI5Element",
|
1496
|
+
"package": "@ui5/webcomponents-base",
|
1497
|
+
"module": "dist/UI5Element.js"
|
1498
|
+
}
|
1499
|
+
},
|
1500
|
+
{
|
1501
|
+
"kind": "field",
|
1502
|
+
"name": "isUI5Element",
|
1503
|
+
"type": {
|
1504
|
+
"text": "boolean"
|
1505
|
+
},
|
1506
|
+
"description": "Used to duck-type UI5 elements without using instanceof",
|
1507
|
+
"privacy": "public",
|
1508
|
+
"default": "true",
|
1509
|
+
"readonly": true,
|
1510
|
+
"inheritedFrom": {
|
1511
|
+
"name": "UI5Element",
|
1512
|
+
"package": "@ui5/webcomponents-base",
|
1513
|
+
"module": "dist/UI5Element.js"
|
1514
|
+
}
|
1515
|
+
},
|
1516
|
+
{
|
1517
|
+
"kind": "method",
|
1518
|
+
"name": "getUniqueDependencies",
|
1519
|
+
"static": true,
|
1520
|
+
"return": {
|
1521
|
+
"type": {
|
1522
|
+
"text": "Array<typeof UI5Element>"
|
1523
|
+
}
|
1524
|
+
},
|
1525
|
+
"description": "Returns a list of the unique dependencies for this UI5 Web Component",
|
1526
|
+
"privacy": "public",
|
1527
|
+
"inheritedFrom": {
|
1528
|
+
"name": "UI5Element",
|
1529
|
+
"package": "@ui5/webcomponents-base",
|
1530
|
+
"module": "dist/UI5Element.js"
|
1531
|
+
}
|
1532
|
+
},
|
1533
|
+
{
|
1534
|
+
"kind": "method",
|
1535
|
+
"name": "define",
|
1536
|
+
"static": true,
|
1537
|
+
"return": {
|
1538
|
+
"type": {
|
1539
|
+
"text": "typeof UI5Element"
|
1540
|
+
}
|
1541
|
+
},
|
1542
|
+
"description": "Registers a UI5 Web Component in the browser window object",
|
1543
|
+
"privacy": "public",
|
1544
|
+
"inheritedFrom": {
|
1545
|
+
"name": "UI5Element",
|
1546
|
+
"package": "@ui5/webcomponents-base",
|
1547
|
+
"module": "dist/UI5Element.js"
|
1548
|
+
}
|
1549
|
+
},
|
1550
|
+
{
|
1551
|
+
"kind": "method",
|
1552
|
+
"name": "getMetadata",
|
1553
|
+
"static": true,
|
1554
|
+
"return": {
|
1555
|
+
"type": {
|
1556
|
+
"text": "UI5ElementMetadata",
|
1557
|
+
"references": [
|
1558
|
+
{
|
1559
|
+
"name": "UI5ElementMetadata",
|
1560
|
+
"package": "@ui5/webcomponents-base",
|
1561
|
+
"module": "dist/UI5ElementMetadata.js"
|
1562
|
+
}
|
1563
|
+
]
|
1564
|
+
}
|
1565
|
+
},
|
1566
|
+
"description": "Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')\nNote: not to be confused with the \"get metadata()\" method, which returns an object for this class's metadata only",
|
1567
|
+
"privacy": "public",
|
1568
|
+
"inheritedFrom": {
|
1569
|
+
"name": "UI5Element",
|
1570
|
+
"package": "@ui5/webcomponents-base",
|
1571
|
+
"module": "dist/UI5Element.js"
|
1572
|
+
}
|
1573
|
+
}
|
1574
|
+
]
|
1575
|
+
}
|
1576
|
+
],
|
1577
|
+
"exports": [
|
1578
|
+
{
|
1579
|
+
"kind": "js",
|
1580
|
+
"name": "default",
|
1581
|
+
"declaration": {
|
1582
|
+
"name": "TableCell",
|
1583
|
+
"module": "dist/TableCell.js"
|
1584
|
+
}
|
1585
|
+
},
|
1586
|
+
{
|
1587
|
+
"kind": "custom-element-definition",
|
1588
|
+
"name": "ui5-table-cell",
|
1589
|
+
"declaration": {
|
1590
|
+
"name": "TableCell",
|
1591
|
+
"module": "dist/TableCell.js"
|
1592
|
+
}
|
1593
|
+
}
|
1594
|
+
]
|
1595
|
+
},
|
1596
|
+
{
|
1597
|
+
"kind": "javascript-module",
|
1598
|
+
"path": "dist/TableColumn.js",
|
1599
|
+
"declarations": [
|
1600
|
+
{
|
1601
|
+
"kind": "class",
|
1602
|
+
"description": "### Overview\n\nThe `ui5-table-column` component allows to define column specific properties that are applied\nwhen rendering the `ui5-table` component.",
|
1603
|
+
"name": "TableColumn",
|
1604
|
+
"cssParts": [
|
1605
|
+
{
|
1606
|
+
"description": "Used to style the native `th` element",
|
1607
|
+
"name": "column"
|
1608
|
+
}
|
1609
|
+
],
|
1610
|
+
"slots": [
|
1611
|
+
{
|
1612
|
+
"description": "Defines the content of the column header",
|
1613
|
+
"name": "default",
|
1614
|
+
"_ui5privacy": "public",
|
1615
|
+
"_ui5type": {
|
1616
|
+
"text": "Array<Node>"
|
1617
|
+
}
|
1618
|
+
}
|
1619
|
+
],
|
1620
|
+
"members": [
|
1621
|
+
{
|
1622
|
+
"kind": "field",
|
1623
|
+
"name": "minWidth",
|
1624
|
+
"type": {
|
1625
|
+
"text": "number"
|
1626
|
+
},
|
1627
|
+
"default": "Infinity",
|
1628
|
+
"description": "Defines the minimum table width required to display this column. By default it is always displayed.\n\nThe responsive behavior of the `ui5-table` is determined by this property. As an example, by setting\n`minWidth` property to `400` sets the minimum width to 400 pixels, and\tshows this column on tablet (and desktop) but hides it on mobile.\n\nFor further responsive design options, see `demandPopin` property.",
|
1629
|
+
"privacy": "public"
|
1630
|
+
},
|
1631
|
+
{
|
1632
|
+
"kind": "field",
|
1633
|
+
"name": "popinText",
|
1634
|
+
"type": {
|
1635
|
+
"text": "string | undefined"
|
1636
|
+
},
|
1637
|
+
"description": "The text for the column when it pops in.",
|
1638
|
+
"default": "undefined",
|
1639
|
+
"privacy": "public"
|
1640
|
+
},
|
1641
|
+
{
|
1642
|
+
"kind": "field",
|
1643
|
+
"name": "demandPopin",
|
1644
|
+
"type": {
|
1645
|
+
"text": "boolean"
|
1646
|
+
},
|
1647
|
+
"default": "false",
|
1648
|
+
"description": "According to your `minWidth` settings, the component can be hidden\nin different screen sizes.\n\nSetting this property to `true`, shows this column as pop-in instead of hiding it.",
|
1649
|
+
"privacy": "public"
|
1650
|
+
},
|
1651
|
+
{
|
1652
|
+
"kind": "field",
|
1653
|
+
"name": "popinDisplay",
|
1654
|
+
"type": {
|
1655
|
+
"text": "TableColumnPopinDisplay",
|
1656
|
+
"references": [
|
1657
|
+
{
|
1658
|
+
"name": "TableColumnPopinDisplay",
|
1659
|
+
"package": "@ui5/webcomponents-compat",
|
1660
|
+
"module": "dist/types/TableColumnPopinDisplay.js"
|
1661
|
+
}
|
1662
|
+
]
|
1663
|
+
},
|
1664
|
+
"default": "\"Block\"",
|
1665
|
+
"description": "Defines how the popin row is displayed.\n\n**The available values are:**\n\n- `Block`\n- `Inline`",
|
1666
|
+
"privacy": "public"
|
1667
|
+
},
|
1668
|
+
{
|
1669
|
+
"kind": "method",
|
1670
|
+
"name": "onBeforeRendering",
|
1671
|
+
"return": {
|
1672
|
+
"type": {
|
1673
|
+
"text": "void"
|
1674
|
+
}
|
1675
|
+
},
|
1676
|
+
"description": "Called every time before the component renders.",
|
1677
|
+
"privacy": "public",
|
1678
|
+
"inheritedFrom": {
|
1679
|
+
"name": "UI5Element",
|
1680
|
+
"package": "@ui5/webcomponents-base",
|
1681
|
+
"module": "dist/UI5Element.js"
|
1682
|
+
}
|
1683
|
+
},
|
1684
|
+
{
|
1685
|
+
"kind": "method",
|
1686
|
+
"name": "onAfterRendering",
|
1687
|
+
"return": {
|
1688
|
+
"type": {
|
1689
|
+
"text": "void"
|
1690
|
+
}
|
1691
|
+
},
|
1692
|
+
"description": "Called every time after the component renders.",
|
1693
|
+
"privacy": "public",
|
1694
|
+
"inheritedFrom": {
|
1695
|
+
"name": "UI5Element",
|
1696
|
+
"package": "@ui5/webcomponents-base",
|
1697
|
+
"module": "dist/UI5Element.js"
|
1698
|
+
}
|
1699
|
+
},
|
1700
|
+
{
|
1701
|
+
"kind": "method",
|
1702
|
+
"name": "onEnterDOM",
|
1703
|
+
"return": {
|
1704
|
+
"type": {
|
1705
|
+
"text": "void"
|
1706
|
+
}
|
1707
|
+
},
|
1708
|
+
"description": "Called on connectedCallback - added to the DOM.",
|
1709
|
+
"privacy": "public",
|
1710
|
+
"inheritedFrom": {
|
1711
|
+
"name": "UI5Element",
|
1712
|
+
"package": "@ui5/webcomponents-base",
|
1713
|
+
"module": "dist/UI5Element.js"
|
1714
|
+
}
|
1715
|
+
},
|
1716
|
+
{
|
1717
|
+
"kind": "method",
|
1718
|
+
"name": "onExitDOM",
|
1719
|
+
"return": {
|
1720
|
+
"type": {
|
1721
|
+
"text": "void"
|
1722
|
+
}
|
1723
|
+
},
|
1724
|
+
"description": "Called on disconnectedCallback - removed from the DOM.",
|
1725
|
+
"privacy": "public",
|
1726
|
+
"inheritedFrom": {
|
1727
|
+
"name": "UI5Element",
|
1728
|
+
"package": "@ui5/webcomponents-base",
|
1729
|
+
"module": "dist/UI5Element.js"
|
1730
|
+
}
|
1731
|
+
},
|
1732
|
+
{
|
1733
|
+
"kind": "method",
|
1734
|
+
"name": "attachInvalidate",
|
1735
|
+
"return": {
|
1736
|
+
"type": {
|
1737
|
+
"text": "void"
|
1738
|
+
}
|
1739
|
+
},
|
1740
|
+
"parameters": [
|
1741
|
+
{
|
1742
|
+
"name": "callback",
|
1743
|
+
"type": {
|
1744
|
+
"text": "(param: InvalidationInfo) => void"
|
1745
|
+
},
|
1746
|
+
"_ui5privacy": "public"
|
1747
|
+
}
|
1748
|
+
],
|
1749
|
+
"description": "Attach a callback that will be executed whenever the component is invalidated",
|
1750
|
+
"privacy": "public",
|
1751
|
+
"inheritedFrom": {
|
1752
|
+
"name": "UI5Element",
|
1753
|
+
"package": "@ui5/webcomponents-base",
|
1754
|
+
"module": "dist/UI5Element.js"
|
1755
|
+
}
|
1756
|
+
},
|
1757
|
+
{
|
1758
|
+
"kind": "method",
|
1759
|
+
"name": "detachInvalidate",
|
1760
|
+
"return": {
|
1761
|
+
"type": {
|
1762
|
+
"text": "void"
|
1763
|
+
}
|
1764
|
+
},
|
1765
|
+
"parameters": [
|
1766
|
+
{
|
1767
|
+
"name": "callback",
|
1768
|
+
"type": {
|
1769
|
+
"text": "(param: InvalidationInfo) => void"
|
1770
|
+
},
|
1771
|
+
"_ui5privacy": "public"
|
1772
|
+
}
|
1773
|
+
],
|
1774
|
+
"description": "Detach the callback that is executed whenever the component is invalidated",
|
1775
|
+
"privacy": "public",
|
1776
|
+
"inheritedFrom": {
|
1777
|
+
"name": "UI5Element",
|
1778
|
+
"package": "@ui5/webcomponents-base",
|
1779
|
+
"module": "dist/UI5Element.js"
|
1780
|
+
}
|
1781
|
+
},
|
1782
|
+
{
|
1783
|
+
"kind": "method",
|
1784
|
+
"name": "onInvalidation",
|
1785
|
+
"return": {
|
1786
|
+
"type": {
|
1787
|
+
"text": "void"
|
1788
|
+
}
|
1789
|
+
},
|
1790
|
+
"parameters": [
|
1791
|
+
{
|
1792
|
+
"name": "changeInfo",
|
1793
|
+
"type": {
|
1794
|
+
"text": "ChangeInfo",
|
1795
|
+
"references": [
|
1796
|
+
{
|
1797
|
+
"name": "ChangeInfo",
|
1798
|
+
"package": "@ui5/webcomponents-base",
|
1799
|
+
"module": "dist/UI5Element.js"
|
1800
|
+
}
|
1801
|
+
]
|
1802
|
+
},
|
1803
|
+
"description": "An object with information about the change that caused invalidation.\nThe object can have the following properties:\n- type: (property|slot) tells what caused the invalidation\n1) property: a property value was changed either directly or as a result of changing the corresponding attribute\n2) slot: a slotted node(nodes) changed in one of several ways (see \"reason\")\n\n- name: the name of the property or slot that caused the invalidation\n\n- reason: (children|textcontent|childchange|slotchange) relevant only for type=\"slot\" only and tells exactly what changed in the slot\n1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot\n2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of \"type: Node\"\n3) slotchange: a slot element, slotted inside that slot had its \"slotchange\" event listener called. This practically means that transitively slotted children changed.\nCan only trigger if the child of a slot is a slot element itself.\n4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.\nCan only trigger for slots with \"invalidateOnChildChange\" metadata descriptor\n\n- newValue: the new value of the property (for type=\"property\" only)\n\n- oldValue: the old value of the property (for type=\"property\" only)\n\n- child the child that was changed (for type=\"slot\" and reason=\"childchange\" only)",
|
1804
|
+
"_ui5privacy": "public"
|
1805
|
+
}
|
1806
|
+
],
|
1807
|
+
"description": "A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)",
|
1808
|
+
"privacy": "public",
|
1809
|
+
"inheritedFrom": {
|
1810
|
+
"name": "UI5Element",
|
1811
|
+
"package": "@ui5/webcomponents-base",
|
1812
|
+
"module": "dist/UI5Element.js"
|
1813
|
+
}
|
1814
|
+
},
|
1815
|
+
{
|
1816
|
+
"kind": "method",
|
1817
|
+
"name": "getDomRef",
|
1818
|
+
"return": {
|
1819
|
+
"type": {
|
1820
|
+
"text": "HTMLElement | undefined"
|
1821
|
+
}
|
1822
|
+
},
|
1823
|
+
"description": "Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template\n*Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option\nUse this method instead of \"this.shadowRoot\" to read the Shadow DOM, if ever necessary",
|
1824
|
+
"privacy": "public",
|
1825
|
+
"inheritedFrom": {
|
1826
|
+
"name": "UI5Element",
|
1827
|
+
"package": "@ui5/webcomponents-base",
|
1828
|
+
"module": "dist/UI5Element.js"
|
1829
|
+
}
|
1830
|
+
},
|
1831
|
+
{
|
1832
|
+
"kind": "method",
|
1833
|
+
"name": "getFocusDomRef",
|
1834
|
+
"return": {
|
1835
|
+
"type": {
|
1836
|
+
"text": "HTMLElement | undefined"
|
1837
|
+
}
|
1838
|
+
},
|
1839
|
+
"description": "Returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
1840
|
+
"privacy": "public",
|
1841
|
+
"inheritedFrom": {
|
1842
|
+
"name": "UI5Element",
|
1843
|
+
"package": "@ui5/webcomponents-base",
|
1844
|
+
"module": "dist/UI5Element.js"
|
1845
|
+
}
|
1846
|
+
},
|
1847
|
+
{
|
1848
|
+
"kind": "method",
|
1849
|
+
"name": "getFocusDomRefAsync",
|
1850
|
+
"return": {
|
1851
|
+
"type": {
|
1852
|
+
"text": "Promise<HTMLElement | undefined>"
|
1853
|
+
}
|
1854
|
+
},
|
1855
|
+
"description": "Waits for dom ref and then returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
1856
|
+
"privacy": "public",
|
1857
|
+
"inheritedFrom": {
|
1858
|
+
"name": "UI5Element",
|
1859
|
+
"package": "@ui5/webcomponents-base",
|
1860
|
+
"module": "dist/UI5Element.js"
|
1861
|
+
}
|
1862
|
+
},
|
1863
|
+
{
|
1864
|
+
"kind": "method",
|
1865
|
+
"name": "focus",
|
1866
|
+
"return": {
|
1867
|
+
"type": {
|
1868
|
+
"text": "Promise<void>"
|
1869
|
+
}
|
1870
|
+
},
|
1871
|
+
"parameters": [
|
1872
|
+
{
|
1873
|
+
"name": "focusOptions",
|
1874
|
+
"optional": true,
|
1875
|
+
"type": {
|
1876
|
+
"text": "FocusOptions"
|
1877
|
+
},
|
1878
|
+
"description": "additional options for the focus",
|
1879
|
+
"_ui5privacy": "public"
|
1880
|
+
}
|
1881
|
+
],
|
1882
|
+
"description": "Set the focus to the element, returned by \"getFocusDomRef()\" (marked by \"data-sap-focus-ref\")",
|
1883
|
+
"privacy": "public",
|
1884
|
+
"inheritedFrom": {
|
1885
|
+
"name": "UI5Element",
|
1886
|
+
"package": "@ui5/webcomponents-base",
|
1887
|
+
"module": "dist/UI5Element.js"
|
1888
|
+
}
|
1889
|
+
},
|
1890
|
+
{
|
1891
|
+
"kind": "method",
|
1892
|
+
"name": "fireEvent",
|
1893
|
+
"return": {
|
1894
|
+
"type": {
|
1895
|
+
"text": "boolean"
|
1896
|
+
},
|
1897
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
1898
|
+
},
|
1899
|
+
"parameters": [
|
1900
|
+
{
|
1901
|
+
"name": "name",
|
1902
|
+
"type": {
|
1903
|
+
"text": "string"
|
1904
|
+
},
|
1905
|
+
"description": "name of the event",
|
1906
|
+
"_ui5privacy": "public"
|
1907
|
+
},
|
1908
|
+
{
|
1909
|
+
"name": "data",
|
1910
|
+
"optional": true,
|
1911
|
+
"type": {
|
1912
|
+
"text": "T"
|
1913
|
+
},
|
1914
|
+
"description": "additional data for the event",
|
1915
|
+
"_ui5privacy": "public"
|
1916
|
+
},
|
1917
|
+
{
|
1918
|
+
"name": "cancelable",
|
1919
|
+
"default": "false",
|
1920
|
+
"description": "true, if the user can call preventDefault on the event object",
|
1921
|
+
"_ui5privacy": "public"
|
1922
|
+
},
|
1923
|
+
{
|
1924
|
+
"name": "bubbles",
|
1925
|
+
"default": "true",
|
1926
|
+
"description": "true, if the event bubbles",
|
1927
|
+
"_ui5privacy": "public"
|
1928
|
+
}
|
1929
|
+
],
|
1930
|
+
"privacy": "public",
|
1931
|
+
"deprecated": "use fireDecoratorEvent instead",
|
1932
|
+
"inheritedFrom": {
|
1933
|
+
"name": "UI5Element",
|
1934
|
+
"package": "@ui5/webcomponents-base",
|
1935
|
+
"module": "dist/UI5Element.js"
|
1936
|
+
}
|
1937
|
+
},
|
1938
|
+
{
|
1939
|
+
"kind": "method",
|
1940
|
+
"name": "fireDecoratorEvent",
|
1941
|
+
"return": {
|
1942
|
+
"type": {
|
1943
|
+
"text": "boolean"
|
1944
|
+
},
|
1945
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
1946
|
+
},
|
1947
|
+
"parameters": [
|
1948
|
+
{
|
1949
|
+
"name": "name",
|
1950
|
+
"type": {
|
1951
|
+
"text": "N"
|
1952
|
+
},
|
1953
|
+
"description": "name of the event",
|
1954
|
+
"_ui5privacy": "public"
|
1955
|
+
},
|
1956
|
+
{
|
1957
|
+
"name": "data",
|
1958
|
+
"optional": true,
|
1959
|
+
"type": {
|
1960
|
+
"text": "this[\"eventDetails\"][N] | undefined"
|
1961
|
+
},
|
1962
|
+
"description": "additional data for the event",
|
1963
|
+
"_ui5privacy": "public"
|
1964
|
+
}
|
1965
|
+
],
|
1966
|
+
"description": "Fires a custom event, configured via the \"event\" decorator.",
|
1967
|
+
"privacy": "public",
|
1968
|
+
"inheritedFrom": {
|
1969
|
+
"name": "UI5Element",
|
1970
|
+
"package": "@ui5/webcomponents-base",
|
1971
|
+
"module": "dist/UI5Element.js"
|
1972
|
+
}
|
1973
|
+
},
|
678
1974
|
{
|
679
|
-
"
|
680
|
-
"name": "
|
681
|
-
|
682
|
-
|
683
|
-
|
1975
|
+
"kind": "method",
|
1976
|
+
"name": "getSlottedNodes",
|
1977
|
+
"return": {
|
1978
|
+
"type": {
|
1979
|
+
"text": "Array<T>"
|
1980
|
+
}
|
1981
|
+
},
|
1982
|
+
"description": "Returns the actual children, associated with a slot.\nUseful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.",
|
1983
|
+
"privacy": "public",
|
1984
|
+
"inheritedFrom": {
|
1985
|
+
"name": "UI5Element",
|
1986
|
+
"package": "@ui5/webcomponents-base",
|
1987
|
+
"module": "dist/UI5Element.js"
|
1988
|
+
}
|
1989
|
+
},
|
684
1990
|
{
|
685
|
-
"
|
686
|
-
"name": "
|
687
|
-
"
|
688
|
-
|
689
|
-
|
1991
|
+
"kind": "method",
|
1992
|
+
"name": "attachComponentStateFinalized",
|
1993
|
+
"return": {
|
1994
|
+
"type": {
|
1995
|
+
"text": "void"
|
1996
|
+
}
|
1997
|
+
},
|
1998
|
+
"parameters": [
|
1999
|
+
{
|
2000
|
+
"name": "callback",
|
2001
|
+
"type": {
|
2002
|
+
"text": "() => void"
|
2003
|
+
},
|
2004
|
+
"_ui5privacy": "public"
|
2005
|
+
}
|
2006
|
+
],
|
2007
|
+
"description": "Attach a callback that will be executed whenever the component's state is finalized",
|
2008
|
+
"privacy": "public",
|
2009
|
+
"inheritedFrom": {
|
2010
|
+
"name": "UI5Element",
|
2011
|
+
"package": "@ui5/webcomponents-base",
|
2012
|
+
"module": "dist/UI5Element.js"
|
690
2013
|
}
|
691
|
-
}
|
692
|
-
],
|
693
|
-
"members": [
|
2014
|
+
},
|
694
2015
|
{
|
695
|
-
"kind": "
|
696
|
-
"name": "
|
697
|
-
"
|
698
|
-
"
|
2016
|
+
"kind": "method",
|
2017
|
+
"name": "detachComponentStateFinalized",
|
2018
|
+
"return": {
|
2019
|
+
"type": {
|
2020
|
+
"text": "void"
|
2021
|
+
}
|
699
2022
|
},
|
700
|
-
"
|
701
|
-
|
2023
|
+
"parameters": [
|
2024
|
+
{
|
2025
|
+
"name": "callback",
|
2026
|
+
"type": {
|
2027
|
+
"text": "() => void"
|
2028
|
+
},
|
2029
|
+
"_ui5privacy": "public"
|
2030
|
+
}
|
2031
|
+
],
|
2032
|
+
"description": "Detach the callback that is executed whenever the component's state is finalized",
|
702
2033
|
"privacy": "public",
|
703
|
-
"
|
2034
|
+
"inheritedFrom": {
|
2035
|
+
"name": "UI5Element",
|
2036
|
+
"package": "@ui5/webcomponents-base",
|
2037
|
+
"module": "dist/UI5Element.js"
|
2038
|
+
}
|
704
2039
|
},
|
705
2040
|
{
|
706
2041
|
"kind": "field",
|
707
|
-
"name": "
|
2042
|
+
"name": "effectiveDir",
|
708
2043
|
"type": {
|
709
|
-
"text": "string"
|
2044
|
+
"text": "string | undefined"
|
710
2045
|
},
|
711
|
-
"description": "
|
712
|
-
"default": "\"\"",
|
2046
|
+
"description": "Determines whether the component should be rendered in RTL mode or not.\nReturns: \"rtl\", \"ltr\" or undefined",
|
713
2047
|
"privacy": "public",
|
714
|
-
"
|
2048
|
+
"default": "undefined",
|
2049
|
+
"readonly": true,
|
2050
|
+
"inheritedFrom": {
|
2051
|
+
"name": "UI5Element",
|
2052
|
+
"package": "@ui5/webcomponents-base",
|
2053
|
+
"module": "dist/UI5Element.js"
|
2054
|
+
}
|
715
2055
|
},
|
716
2056
|
{
|
717
2057
|
"kind": "field",
|
718
|
-
"name": "
|
2058
|
+
"name": "isUI5Element",
|
719
2059
|
"type": {
|
720
2060
|
"text": "boolean"
|
721
2061
|
},
|
722
|
-
"description": "
|
723
|
-
"default": "false",
|
2062
|
+
"description": "Used to duck-type UI5 elements without using instanceof",
|
724
2063
|
"privacy": "public",
|
725
|
-
"
|
2064
|
+
"default": "true",
|
2065
|
+
"readonly": true,
|
2066
|
+
"inheritedFrom": {
|
2067
|
+
"name": "UI5Element",
|
2068
|
+
"package": "@ui5/webcomponents-base",
|
2069
|
+
"module": "dist/UI5Element.js"
|
2070
|
+
}
|
726
2071
|
},
|
727
2072
|
{
|
728
|
-
"kind": "
|
729
|
-
"name": "
|
730
|
-
"
|
731
|
-
|
732
|
-
"
|
733
|
-
|
734
|
-
|
735
|
-
"package": "@ui5/webcomponents-compat",
|
736
|
-
"module": "dist/types/TableColumnPopinDisplay.js"
|
737
|
-
}
|
738
|
-
]
|
2073
|
+
"kind": "method",
|
2074
|
+
"name": "getUniqueDependencies",
|
2075
|
+
"static": true,
|
2076
|
+
"return": {
|
2077
|
+
"type": {
|
2078
|
+
"text": "Array<typeof UI5Element>"
|
2079
|
+
}
|
739
2080
|
},
|
740
|
-
"description": "
|
741
|
-
"
|
2081
|
+
"description": "Returns a list of the unique dependencies for this UI5 Web Component",
|
2082
|
+
"privacy": "public",
|
2083
|
+
"inheritedFrom": {
|
2084
|
+
"name": "UI5Element",
|
2085
|
+
"package": "@ui5/webcomponents-base",
|
2086
|
+
"module": "dist/UI5Element.js"
|
2087
|
+
}
|
2088
|
+
},
|
2089
|
+
{
|
2090
|
+
"kind": "method",
|
2091
|
+
"name": "define",
|
2092
|
+
"static": true,
|
2093
|
+
"return": {
|
2094
|
+
"type": {
|
2095
|
+
"text": "typeof UI5Element"
|
2096
|
+
}
|
2097
|
+
},
|
2098
|
+
"description": "Registers a UI5 Web Component in the browser window object",
|
2099
|
+
"privacy": "public",
|
2100
|
+
"inheritedFrom": {
|
2101
|
+
"name": "UI5Element",
|
2102
|
+
"package": "@ui5/webcomponents-base",
|
2103
|
+
"module": "dist/UI5Element.js"
|
2104
|
+
}
|
2105
|
+
},
|
2106
|
+
{
|
2107
|
+
"kind": "method",
|
2108
|
+
"name": "getMetadata",
|
2109
|
+
"static": true,
|
2110
|
+
"return": {
|
2111
|
+
"type": {
|
2112
|
+
"text": "UI5ElementMetadata",
|
2113
|
+
"references": [
|
2114
|
+
{
|
2115
|
+
"name": "UI5ElementMetadata",
|
2116
|
+
"package": "@ui5/webcomponents-base",
|
2117
|
+
"module": "dist/UI5ElementMetadata.js"
|
2118
|
+
}
|
2119
|
+
]
|
2120
|
+
}
|
2121
|
+
},
|
2122
|
+
"description": "Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')\nNote: not to be confused with the \"get metadata()\" method, which returns an object for this class's metadata only",
|
742
2123
|
"privacy": "public",
|
743
|
-
"
|
2124
|
+
"inheritedFrom": {
|
2125
|
+
"name": "UI5Element",
|
2126
|
+
"package": "@ui5/webcomponents-base",
|
2127
|
+
"module": "dist/UI5Element.js"
|
2128
|
+
}
|
744
2129
|
}
|
745
2130
|
],
|
746
2131
|
"attributes": [
|
@@ -756,10 +2141,10 @@
|
|
756
2141
|
{
|
757
2142
|
"description": "The text for the column when it pops in.",
|
758
2143
|
"name": "popin-text",
|
759
|
-
"default": "
|
2144
|
+
"default": "undefined",
|
760
2145
|
"fieldName": "popinText",
|
761
2146
|
"type": {
|
762
|
-
"text": "string"
|
2147
|
+
"text": "string | undefined"
|
763
2148
|
}
|
764
2149
|
},
|
765
2150
|
{
|
@@ -820,34 +2205,498 @@
|
|
820
2205
|
"name": "TableGroupRow",
|
821
2206
|
"cssParts": [
|
822
2207
|
{
|
823
|
-
"description": "Used to style the native `tr` element",
|
824
|
-
"name": "group-row"
|
825
|
-
}
|
826
|
-
],
|
827
|
-
"slots": [
|
2208
|
+
"description": "Used to style the native `tr` element",
|
2209
|
+
"name": "group-row"
|
2210
|
+
}
|
2211
|
+
],
|
2212
|
+
"slots": [
|
2213
|
+
{
|
2214
|
+
"description": "Defines the text of the component.\n\n**Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.",
|
2215
|
+
"name": "default",
|
2216
|
+
"_ui5privacy": "public",
|
2217
|
+
"_ui5type": {
|
2218
|
+
"text": "Array<Node>"
|
2219
|
+
}
|
2220
|
+
}
|
2221
|
+
],
|
2222
|
+
"superclass": {
|
2223
|
+
"name": "UI5Element",
|
2224
|
+
"package": "@ui5/webcomponents-base",
|
2225
|
+
"module": "dist/UI5Element.js"
|
2226
|
+
},
|
2227
|
+
"tagName": "ui5-table-group-row",
|
2228
|
+
"customElement": true,
|
2229
|
+
"_ui5since": "2.0.0",
|
2230
|
+
"_ui5privacy": "public",
|
2231
|
+
"_ui5implements": [
|
2232
|
+
{
|
2233
|
+
"name": "ITableRow",
|
2234
|
+
"package": "@ui5/webcomponents-compat",
|
2235
|
+
"module": "dist/Table.js"
|
2236
|
+
}
|
2237
|
+
],
|
2238
|
+
"members": [
|
2239
|
+
{
|
2240
|
+
"kind": "method",
|
2241
|
+
"name": "onBeforeRendering",
|
2242
|
+
"return": {
|
2243
|
+
"type": {
|
2244
|
+
"text": "void"
|
2245
|
+
}
|
2246
|
+
},
|
2247
|
+
"description": "Called every time before the component renders.",
|
2248
|
+
"privacy": "public",
|
2249
|
+
"inheritedFrom": {
|
2250
|
+
"name": "UI5Element",
|
2251
|
+
"package": "@ui5/webcomponents-base",
|
2252
|
+
"module": "dist/UI5Element.js"
|
2253
|
+
}
|
2254
|
+
},
|
2255
|
+
{
|
2256
|
+
"kind": "method",
|
2257
|
+
"name": "onAfterRendering",
|
2258
|
+
"return": {
|
2259
|
+
"type": {
|
2260
|
+
"text": "void"
|
2261
|
+
}
|
2262
|
+
},
|
2263
|
+
"description": "Called every time after the component renders.",
|
2264
|
+
"privacy": "public",
|
2265
|
+
"inheritedFrom": {
|
2266
|
+
"name": "UI5Element",
|
2267
|
+
"package": "@ui5/webcomponents-base",
|
2268
|
+
"module": "dist/UI5Element.js"
|
2269
|
+
}
|
2270
|
+
},
|
2271
|
+
{
|
2272
|
+
"kind": "method",
|
2273
|
+
"name": "onEnterDOM",
|
2274
|
+
"return": {
|
2275
|
+
"type": {
|
2276
|
+
"text": "void"
|
2277
|
+
}
|
2278
|
+
},
|
2279
|
+
"description": "Called on connectedCallback - added to the DOM.",
|
2280
|
+
"privacy": "public",
|
2281
|
+
"inheritedFrom": {
|
2282
|
+
"name": "UI5Element",
|
2283
|
+
"package": "@ui5/webcomponents-base",
|
2284
|
+
"module": "dist/UI5Element.js"
|
2285
|
+
}
|
2286
|
+
},
|
2287
|
+
{
|
2288
|
+
"kind": "method",
|
2289
|
+
"name": "onExitDOM",
|
2290
|
+
"return": {
|
2291
|
+
"type": {
|
2292
|
+
"text": "void"
|
2293
|
+
}
|
2294
|
+
},
|
2295
|
+
"description": "Called on disconnectedCallback - removed from the DOM.",
|
2296
|
+
"privacy": "public",
|
2297
|
+
"inheritedFrom": {
|
2298
|
+
"name": "UI5Element",
|
2299
|
+
"package": "@ui5/webcomponents-base",
|
2300
|
+
"module": "dist/UI5Element.js"
|
2301
|
+
}
|
2302
|
+
},
|
2303
|
+
{
|
2304
|
+
"kind": "method",
|
2305
|
+
"name": "attachInvalidate",
|
2306
|
+
"return": {
|
2307
|
+
"type": {
|
2308
|
+
"text": "void"
|
2309
|
+
}
|
2310
|
+
},
|
2311
|
+
"parameters": [
|
2312
|
+
{
|
2313
|
+
"name": "callback",
|
2314
|
+
"type": {
|
2315
|
+
"text": "(param: InvalidationInfo) => void"
|
2316
|
+
},
|
2317
|
+
"_ui5privacy": "public"
|
2318
|
+
}
|
2319
|
+
],
|
2320
|
+
"description": "Attach a callback that will be executed whenever the component is invalidated",
|
2321
|
+
"privacy": "public",
|
2322
|
+
"inheritedFrom": {
|
2323
|
+
"name": "UI5Element",
|
2324
|
+
"package": "@ui5/webcomponents-base",
|
2325
|
+
"module": "dist/UI5Element.js"
|
2326
|
+
}
|
2327
|
+
},
|
2328
|
+
{
|
2329
|
+
"kind": "method",
|
2330
|
+
"name": "detachInvalidate",
|
2331
|
+
"return": {
|
2332
|
+
"type": {
|
2333
|
+
"text": "void"
|
2334
|
+
}
|
2335
|
+
},
|
2336
|
+
"parameters": [
|
2337
|
+
{
|
2338
|
+
"name": "callback",
|
2339
|
+
"type": {
|
2340
|
+
"text": "(param: InvalidationInfo) => void"
|
2341
|
+
},
|
2342
|
+
"_ui5privacy": "public"
|
2343
|
+
}
|
2344
|
+
],
|
2345
|
+
"description": "Detach the callback that is executed whenever the component is invalidated",
|
2346
|
+
"privacy": "public",
|
2347
|
+
"inheritedFrom": {
|
2348
|
+
"name": "UI5Element",
|
2349
|
+
"package": "@ui5/webcomponents-base",
|
2350
|
+
"module": "dist/UI5Element.js"
|
2351
|
+
}
|
2352
|
+
},
|
2353
|
+
{
|
2354
|
+
"kind": "method",
|
2355
|
+
"name": "onInvalidation",
|
2356
|
+
"return": {
|
2357
|
+
"type": {
|
2358
|
+
"text": "void"
|
2359
|
+
}
|
2360
|
+
},
|
2361
|
+
"parameters": [
|
2362
|
+
{
|
2363
|
+
"name": "changeInfo",
|
2364
|
+
"type": {
|
2365
|
+
"text": "ChangeInfo",
|
2366
|
+
"references": [
|
2367
|
+
{
|
2368
|
+
"name": "ChangeInfo",
|
2369
|
+
"package": "@ui5/webcomponents-base",
|
2370
|
+
"module": "dist/UI5Element.js"
|
2371
|
+
}
|
2372
|
+
]
|
2373
|
+
},
|
2374
|
+
"description": "An object with information about the change that caused invalidation.\nThe object can have the following properties:\n- type: (property|slot) tells what caused the invalidation\n1) property: a property value was changed either directly or as a result of changing the corresponding attribute\n2) slot: a slotted node(nodes) changed in one of several ways (see \"reason\")\n\n- name: the name of the property or slot that caused the invalidation\n\n- reason: (children|textcontent|childchange|slotchange) relevant only for type=\"slot\" only and tells exactly what changed in the slot\n1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot\n2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of \"type: Node\"\n3) slotchange: a slot element, slotted inside that slot had its \"slotchange\" event listener called. This practically means that transitively slotted children changed.\nCan only trigger if the child of a slot is a slot element itself.\n4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.\nCan only trigger for slots with \"invalidateOnChildChange\" metadata descriptor\n\n- newValue: the new value of the property (for type=\"property\" only)\n\n- oldValue: the old value of the property (for type=\"property\" only)\n\n- child the child that was changed (for type=\"slot\" and reason=\"childchange\" only)",
|
2375
|
+
"_ui5privacy": "public"
|
2376
|
+
}
|
2377
|
+
],
|
2378
|
+
"description": "A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)",
|
2379
|
+
"privacy": "public",
|
2380
|
+
"inheritedFrom": {
|
2381
|
+
"name": "UI5Element",
|
2382
|
+
"package": "@ui5/webcomponents-base",
|
2383
|
+
"module": "dist/UI5Element.js"
|
2384
|
+
}
|
2385
|
+
},
|
2386
|
+
{
|
2387
|
+
"kind": "method",
|
2388
|
+
"name": "getDomRef",
|
2389
|
+
"return": {
|
2390
|
+
"type": {
|
2391
|
+
"text": "HTMLElement | undefined"
|
2392
|
+
}
|
2393
|
+
},
|
2394
|
+
"description": "Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template\n*Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option\nUse this method instead of \"this.shadowRoot\" to read the Shadow DOM, if ever necessary",
|
2395
|
+
"privacy": "public",
|
2396
|
+
"inheritedFrom": {
|
2397
|
+
"name": "UI5Element",
|
2398
|
+
"package": "@ui5/webcomponents-base",
|
2399
|
+
"module": "dist/UI5Element.js"
|
2400
|
+
}
|
2401
|
+
},
|
2402
|
+
{
|
2403
|
+
"kind": "method",
|
2404
|
+
"name": "getFocusDomRef",
|
2405
|
+
"return": {
|
2406
|
+
"type": {
|
2407
|
+
"text": "HTMLElement | undefined"
|
2408
|
+
}
|
2409
|
+
},
|
2410
|
+
"description": "Returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
2411
|
+
"privacy": "public",
|
2412
|
+
"inheritedFrom": {
|
2413
|
+
"name": "UI5Element",
|
2414
|
+
"package": "@ui5/webcomponents-base",
|
2415
|
+
"module": "dist/UI5Element.js"
|
2416
|
+
}
|
2417
|
+
},
|
2418
|
+
{
|
2419
|
+
"kind": "method",
|
2420
|
+
"name": "getFocusDomRefAsync",
|
2421
|
+
"return": {
|
2422
|
+
"type": {
|
2423
|
+
"text": "Promise<HTMLElement | undefined>"
|
2424
|
+
}
|
2425
|
+
},
|
2426
|
+
"description": "Waits for dom ref and then returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
2427
|
+
"privacy": "public",
|
2428
|
+
"inheritedFrom": {
|
2429
|
+
"name": "UI5Element",
|
2430
|
+
"package": "@ui5/webcomponents-base",
|
2431
|
+
"module": "dist/UI5Element.js"
|
2432
|
+
}
|
2433
|
+
},
|
2434
|
+
{
|
2435
|
+
"kind": "method",
|
2436
|
+
"name": "focus",
|
2437
|
+
"return": {
|
2438
|
+
"type": {
|
2439
|
+
"text": "Promise<void>"
|
2440
|
+
}
|
2441
|
+
},
|
2442
|
+
"parameters": [
|
2443
|
+
{
|
2444
|
+
"name": "focusOptions",
|
2445
|
+
"optional": true,
|
2446
|
+
"type": {
|
2447
|
+
"text": "FocusOptions"
|
2448
|
+
},
|
2449
|
+
"description": "additional options for the focus",
|
2450
|
+
"_ui5privacy": "public"
|
2451
|
+
}
|
2452
|
+
],
|
2453
|
+
"description": "Set the focus to the element, returned by \"getFocusDomRef()\" (marked by \"data-sap-focus-ref\")",
|
2454
|
+
"privacy": "public",
|
2455
|
+
"inheritedFrom": {
|
2456
|
+
"name": "UI5Element",
|
2457
|
+
"package": "@ui5/webcomponents-base",
|
2458
|
+
"module": "dist/UI5Element.js"
|
2459
|
+
}
|
2460
|
+
},
|
2461
|
+
{
|
2462
|
+
"kind": "method",
|
2463
|
+
"name": "fireEvent",
|
2464
|
+
"return": {
|
2465
|
+
"type": {
|
2466
|
+
"text": "boolean"
|
2467
|
+
},
|
2468
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
2469
|
+
},
|
2470
|
+
"parameters": [
|
2471
|
+
{
|
2472
|
+
"name": "name",
|
2473
|
+
"type": {
|
2474
|
+
"text": "string"
|
2475
|
+
},
|
2476
|
+
"description": "name of the event",
|
2477
|
+
"_ui5privacy": "public"
|
2478
|
+
},
|
2479
|
+
{
|
2480
|
+
"name": "data",
|
2481
|
+
"optional": true,
|
2482
|
+
"type": {
|
2483
|
+
"text": "T"
|
2484
|
+
},
|
2485
|
+
"description": "additional data for the event",
|
2486
|
+
"_ui5privacy": "public"
|
2487
|
+
},
|
2488
|
+
{
|
2489
|
+
"name": "cancelable",
|
2490
|
+
"default": "false",
|
2491
|
+
"description": "true, if the user can call preventDefault on the event object",
|
2492
|
+
"_ui5privacy": "public"
|
2493
|
+
},
|
2494
|
+
{
|
2495
|
+
"name": "bubbles",
|
2496
|
+
"default": "true",
|
2497
|
+
"description": "true, if the event bubbles",
|
2498
|
+
"_ui5privacy": "public"
|
2499
|
+
}
|
2500
|
+
],
|
2501
|
+
"privacy": "public",
|
2502
|
+
"deprecated": "use fireDecoratorEvent instead",
|
2503
|
+
"inheritedFrom": {
|
2504
|
+
"name": "UI5Element",
|
2505
|
+
"package": "@ui5/webcomponents-base",
|
2506
|
+
"module": "dist/UI5Element.js"
|
2507
|
+
}
|
2508
|
+
},
|
2509
|
+
{
|
2510
|
+
"kind": "method",
|
2511
|
+
"name": "fireDecoratorEvent",
|
2512
|
+
"return": {
|
2513
|
+
"type": {
|
2514
|
+
"text": "boolean"
|
2515
|
+
},
|
2516
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
2517
|
+
},
|
2518
|
+
"parameters": [
|
2519
|
+
{
|
2520
|
+
"name": "name",
|
2521
|
+
"type": {
|
2522
|
+
"text": "N"
|
2523
|
+
},
|
2524
|
+
"description": "name of the event",
|
2525
|
+
"_ui5privacy": "public"
|
2526
|
+
},
|
2527
|
+
{
|
2528
|
+
"name": "data",
|
2529
|
+
"optional": true,
|
2530
|
+
"type": {
|
2531
|
+
"text": "this[\"eventDetails\"][N] | undefined"
|
2532
|
+
},
|
2533
|
+
"description": "additional data for the event",
|
2534
|
+
"_ui5privacy": "public"
|
2535
|
+
}
|
2536
|
+
],
|
2537
|
+
"description": "Fires a custom event, configured via the \"event\" decorator.",
|
2538
|
+
"privacy": "public",
|
2539
|
+
"inheritedFrom": {
|
2540
|
+
"name": "UI5Element",
|
2541
|
+
"package": "@ui5/webcomponents-base",
|
2542
|
+
"module": "dist/UI5Element.js"
|
2543
|
+
}
|
2544
|
+
},
|
2545
|
+
{
|
2546
|
+
"kind": "method",
|
2547
|
+
"name": "getSlottedNodes",
|
2548
|
+
"return": {
|
2549
|
+
"type": {
|
2550
|
+
"text": "Array<T>"
|
2551
|
+
}
|
2552
|
+
},
|
2553
|
+
"description": "Returns the actual children, associated with a slot.\nUseful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.",
|
2554
|
+
"privacy": "public",
|
2555
|
+
"inheritedFrom": {
|
2556
|
+
"name": "UI5Element",
|
2557
|
+
"package": "@ui5/webcomponents-base",
|
2558
|
+
"module": "dist/UI5Element.js"
|
2559
|
+
}
|
2560
|
+
},
|
2561
|
+
{
|
2562
|
+
"kind": "method",
|
2563
|
+
"name": "attachComponentStateFinalized",
|
2564
|
+
"return": {
|
2565
|
+
"type": {
|
2566
|
+
"text": "void"
|
2567
|
+
}
|
2568
|
+
},
|
2569
|
+
"parameters": [
|
2570
|
+
{
|
2571
|
+
"name": "callback",
|
2572
|
+
"type": {
|
2573
|
+
"text": "() => void"
|
2574
|
+
},
|
2575
|
+
"_ui5privacy": "public"
|
2576
|
+
}
|
2577
|
+
],
|
2578
|
+
"description": "Attach a callback that will be executed whenever the component's state is finalized",
|
2579
|
+
"privacy": "public",
|
2580
|
+
"inheritedFrom": {
|
2581
|
+
"name": "UI5Element",
|
2582
|
+
"package": "@ui5/webcomponents-base",
|
2583
|
+
"module": "dist/UI5Element.js"
|
2584
|
+
}
|
2585
|
+
},
|
2586
|
+
{
|
2587
|
+
"kind": "method",
|
2588
|
+
"name": "detachComponentStateFinalized",
|
2589
|
+
"return": {
|
2590
|
+
"type": {
|
2591
|
+
"text": "void"
|
2592
|
+
}
|
2593
|
+
},
|
2594
|
+
"parameters": [
|
2595
|
+
{
|
2596
|
+
"name": "callback",
|
2597
|
+
"type": {
|
2598
|
+
"text": "() => void"
|
2599
|
+
},
|
2600
|
+
"_ui5privacy": "public"
|
2601
|
+
}
|
2602
|
+
],
|
2603
|
+
"description": "Detach the callback that is executed whenever the component's state is finalized",
|
2604
|
+
"privacy": "public",
|
2605
|
+
"inheritedFrom": {
|
2606
|
+
"name": "UI5Element",
|
2607
|
+
"package": "@ui5/webcomponents-base",
|
2608
|
+
"module": "dist/UI5Element.js"
|
2609
|
+
}
|
2610
|
+
},
|
2611
|
+
{
|
2612
|
+
"kind": "field",
|
2613
|
+
"name": "effectiveDir",
|
2614
|
+
"type": {
|
2615
|
+
"text": "string | undefined"
|
2616
|
+
},
|
2617
|
+
"description": "Determines whether the component should be rendered in RTL mode or not.\nReturns: \"rtl\", \"ltr\" or undefined",
|
2618
|
+
"privacy": "public",
|
2619
|
+
"default": "undefined",
|
2620
|
+
"readonly": true,
|
2621
|
+
"inheritedFrom": {
|
2622
|
+
"name": "UI5Element",
|
2623
|
+
"package": "@ui5/webcomponents-base",
|
2624
|
+
"module": "dist/UI5Element.js"
|
2625
|
+
}
|
2626
|
+
},
|
828
2627
|
{
|
829
|
-
"
|
830
|
-
"name": "
|
831
|
-
"
|
832
|
-
|
833
|
-
|
2628
|
+
"kind": "field",
|
2629
|
+
"name": "isUI5Element",
|
2630
|
+
"type": {
|
2631
|
+
"text": "boolean"
|
2632
|
+
},
|
2633
|
+
"description": "Used to duck-type UI5 elements without using instanceof",
|
2634
|
+
"privacy": "public",
|
2635
|
+
"default": "true",
|
2636
|
+
"readonly": true,
|
2637
|
+
"inheritedFrom": {
|
2638
|
+
"name": "UI5Element",
|
2639
|
+
"package": "@ui5/webcomponents-base",
|
2640
|
+
"module": "dist/UI5Element.js"
|
834
2641
|
}
|
835
|
-
}
|
836
|
-
],
|
837
|
-
"superclass": {
|
838
|
-
"name": "UI5Element",
|
839
|
-
"package": "@ui5/webcomponents-base",
|
840
|
-
"module": "dist/UI5Element.js"
|
841
|
-
},
|
842
|
-
"tagName": "ui5-table-group-row",
|
843
|
-
"customElement": true,
|
844
|
-
"_ui5since": "2.0.0",
|
845
|
-
"_ui5privacy": "public",
|
846
|
-
"_ui5implements": [
|
2642
|
+
},
|
847
2643
|
{
|
848
|
-
"
|
849
|
-
"
|
850
|
-
"
|
2644
|
+
"kind": "method",
|
2645
|
+
"name": "getUniqueDependencies",
|
2646
|
+
"static": true,
|
2647
|
+
"return": {
|
2648
|
+
"type": {
|
2649
|
+
"text": "Array<typeof UI5Element>"
|
2650
|
+
}
|
2651
|
+
},
|
2652
|
+
"description": "Returns a list of the unique dependencies for this UI5 Web Component",
|
2653
|
+
"privacy": "public",
|
2654
|
+
"inheritedFrom": {
|
2655
|
+
"name": "UI5Element",
|
2656
|
+
"package": "@ui5/webcomponents-base",
|
2657
|
+
"module": "dist/UI5Element.js"
|
2658
|
+
}
|
2659
|
+
},
|
2660
|
+
{
|
2661
|
+
"kind": "method",
|
2662
|
+
"name": "define",
|
2663
|
+
"static": true,
|
2664
|
+
"return": {
|
2665
|
+
"type": {
|
2666
|
+
"text": "typeof UI5Element"
|
2667
|
+
}
|
2668
|
+
},
|
2669
|
+
"description": "Registers a UI5 Web Component in the browser window object",
|
2670
|
+
"privacy": "public",
|
2671
|
+
"inheritedFrom": {
|
2672
|
+
"name": "UI5Element",
|
2673
|
+
"package": "@ui5/webcomponents-base",
|
2674
|
+
"module": "dist/UI5Element.js"
|
2675
|
+
}
|
2676
|
+
},
|
2677
|
+
{
|
2678
|
+
"kind": "method",
|
2679
|
+
"name": "getMetadata",
|
2680
|
+
"static": true,
|
2681
|
+
"return": {
|
2682
|
+
"type": {
|
2683
|
+
"text": "UI5ElementMetadata",
|
2684
|
+
"references": [
|
2685
|
+
{
|
2686
|
+
"name": "UI5ElementMetadata",
|
2687
|
+
"package": "@ui5/webcomponents-base",
|
2688
|
+
"module": "dist/UI5ElementMetadata.js"
|
2689
|
+
}
|
2690
|
+
]
|
2691
|
+
}
|
2692
|
+
},
|
2693
|
+
"description": "Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')\nNote: not to be confused with the \"get metadata()\" method, which returns an object for this class's metadata only",
|
2694
|
+
"privacy": "public",
|
2695
|
+
"inheritedFrom": {
|
2696
|
+
"name": "UI5Element",
|
2697
|
+
"package": "@ui5/webcomponents-base",
|
2698
|
+
"module": "dist/UI5Element.js"
|
2699
|
+
}
|
851
2700
|
}
|
852
2701
|
]
|
853
2702
|
}
|
@@ -921,11 +2770,10 @@
|
|
921
2770
|
}
|
922
2771
|
]
|
923
2772
|
},
|
924
|
-
"description": "Defines the visual indication and behavior of the component.\n\n**Note:** When set to `Active`, the item will provide visual response upon press,\nwhile with type `Inactive`-will not.",
|
925
2773
|
"default": "\"Inactive\"",
|
2774
|
+
"description": "Defines the visual indication and behavior of the component.\n\n**Note:** When set to `Active`, the item will provide visual response upon press,\nwhile with type `Inactive`-will not.",
|
926
2775
|
"privacy": "public",
|
927
|
-
"_ui5since": "2.0.0"
|
928
|
-
"_ui5validator": "TableRowType"
|
2776
|
+
"_ui5since": "2.0.0"
|
929
2777
|
},
|
930
2778
|
{
|
931
2779
|
"kind": "field",
|
@@ -933,11 +2781,10 @@
|
|
933
2781
|
"type": {
|
934
2782
|
"text": "boolean"
|
935
2783
|
},
|
936
|
-
"description": "Defines the row's selected state.",
|
937
2784
|
"default": "false",
|
2785
|
+
"description": "Defines the row's selected state.",
|
938
2786
|
"privacy": "public",
|
939
|
-
"_ui5since": "2.0.0"
|
940
|
-
"_ui5validator": "Boolean"
|
2787
|
+
"_ui5since": "2.0.0"
|
941
2788
|
},
|
942
2789
|
{
|
943
2790
|
"kind": "field",
|
@@ -945,11 +2792,472 @@
|
|
945
2792
|
"type": {
|
946
2793
|
"text": "boolean"
|
947
2794
|
},
|
948
|
-
"description": "Indicates if the table row is navigated.",
|
949
2795
|
"default": "false",
|
2796
|
+
"description": "Indicates if the table row is navigated.",
|
950
2797
|
"privacy": "public",
|
951
|
-
"_ui5since": "2.0.0"
|
952
|
-
|
2798
|
+
"_ui5since": "2.0.0"
|
2799
|
+
},
|
2800
|
+
{
|
2801
|
+
"kind": "method",
|
2802
|
+
"name": "onBeforeRendering",
|
2803
|
+
"return": {
|
2804
|
+
"type": {
|
2805
|
+
"text": "void"
|
2806
|
+
}
|
2807
|
+
},
|
2808
|
+
"description": "Called every time before the component renders.",
|
2809
|
+
"privacy": "public",
|
2810
|
+
"inheritedFrom": {
|
2811
|
+
"name": "UI5Element",
|
2812
|
+
"package": "@ui5/webcomponents-base",
|
2813
|
+
"module": "dist/UI5Element.js"
|
2814
|
+
}
|
2815
|
+
},
|
2816
|
+
{
|
2817
|
+
"kind": "method",
|
2818
|
+
"name": "onAfterRendering",
|
2819
|
+
"return": {
|
2820
|
+
"type": {
|
2821
|
+
"text": "void"
|
2822
|
+
}
|
2823
|
+
},
|
2824
|
+
"description": "Called every time after the component renders.",
|
2825
|
+
"privacy": "public",
|
2826
|
+
"inheritedFrom": {
|
2827
|
+
"name": "UI5Element",
|
2828
|
+
"package": "@ui5/webcomponents-base",
|
2829
|
+
"module": "dist/UI5Element.js"
|
2830
|
+
}
|
2831
|
+
},
|
2832
|
+
{
|
2833
|
+
"kind": "method",
|
2834
|
+
"name": "onEnterDOM",
|
2835
|
+
"return": {
|
2836
|
+
"type": {
|
2837
|
+
"text": "void"
|
2838
|
+
}
|
2839
|
+
},
|
2840
|
+
"description": "Called on connectedCallback - added to the DOM.",
|
2841
|
+
"privacy": "public",
|
2842
|
+
"inheritedFrom": {
|
2843
|
+
"name": "UI5Element",
|
2844
|
+
"package": "@ui5/webcomponents-base",
|
2845
|
+
"module": "dist/UI5Element.js"
|
2846
|
+
}
|
2847
|
+
},
|
2848
|
+
{
|
2849
|
+
"kind": "method",
|
2850
|
+
"name": "onExitDOM",
|
2851
|
+
"return": {
|
2852
|
+
"type": {
|
2853
|
+
"text": "void"
|
2854
|
+
}
|
2855
|
+
},
|
2856
|
+
"description": "Called on disconnectedCallback - removed from the DOM.",
|
2857
|
+
"privacy": "public",
|
2858
|
+
"inheritedFrom": {
|
2859
|
+
"name": "UI5Element",
|
2860
|
+
"package": "@ui5/webcomponents-base",
|
2861
|
+
"module": "dist/UI5Element.js"
|
2862
|
+
}
|
2863
|
+
},
|
2864
|
+
{
|
2865
|
+
"kind": "method",
|
2866
|
+
"name": "attachInvalidate",
|
2867
|
+
"return": {
|
2868
|
+
"type": {
|
2869
|
+
"text": "void"
|
2870
|
+
}
|
2871
|
+
},
|
2872
|
+
"parameters": [
|
2873
|
+
{
|
2874
|
+
"name": "callback",
|
2875
|
+
"type": {
|
2876
|
+
"text": "(param: InvalidationInfo) => void"
|
2877
|
+
},
|
2878
|
+
"_ui5privacy": "public"
|
2879
|
+
}
|
2880
|
+
],
|
2881
|
+
"description": "Attach a callback that will be executed whenever the component is invalidated",
|
2882
|
+
"privacy": "public",
|
2883
|
+
"inheritedFrom": {
|
2884
|
+
"name": "UI5Element",
|
2885
|
+
"package": "@ui5/webcomponents-base",
|
2886
|
+
"module": "dist/UI5Element.js"
|
2887
|
+
}
|
2888
|
+
},
|
2889
|
+
{
|
2890
|
+
"kind": "method",
|
2891
|
+
"name": "detachInvalidate",
|
2892
|
+
"return": {
|
2893
|
+
"type": {
|
2894
|
+
"text": "void"
|
2895
|
+
}
|
2896
|
+
},
|
2897
|
+
"parameters": [
|
2898
|
+
{
|
2899
|
+
"name": "callback",
|
2900
|
+
"type": {
|
2901
|
+
"text": "(param: InvalidationInfo) => void"
|
2902
|
+
},
|
2903
|
+
"_ui5privacy": "public"
|
2904
|
+
}
|
2905
|
+
],
|
2906
|
+
"description": "Detach the callback that is executed whenever the component is invalidated",
|
2907
|
+
"privacy": "public",
|
2908
|
+
"inheritedFrom": {
|
2909
|
+
"name": "UI5Element",
|
2910
|
+
"package": "@ui5/webcomponents-base",
|
2911
|
+
"module": "dist/UI5Element.js"
|
2912
|
+
}
|
2913
|
+
},
|
2914
|
+
{
|
2915
|
+
"kind": "method",
|
2916
|
+
"name": "onInvalidation",
|
2917
|
+
"return": {
|
2918
|
+
"type": {
|
2919
|
+
"text": "void"
|
2920
|
+
}
|
2921
|
+
},
|
2922
|
+
"parameters": [
|
2923
|
+
{
|
2924
|
+
"name": "changeInfo",
|
2925
|
+
"type": {
|
2926
|
+
"text": "ChangeInfo",
|
2927
|
+
"references": [
|
2928
|
+
{
|
2929
|
+
"name": "ChangeInfo",
|
2930
|
+
"package": "@ui5/webcomponents-base",
|
2931
|
+
"module": "dist/UI5Element.js"
|
2932
|
+
}
|
2933
|
+
]
|
2934
|
+
},
|
2935
|
+
"description": "An object with information about the change that caused invalidation.\nThe object can have the following properties:\n- type: (property|slot) tells what caused the invalidation\n1) property: a property value was changed either directly or as a result of changing the corresponding attribute\n2) slot: a slotted node(nodes) changed in one of several ways (see \"reason\")\n\n- name: the name of the property or slot that caused the invalidation\n\n- reason: (children|textcontent|childchange|slotchange) relevant only for type=\"slot\" only and tells exactly what changed in the slot\n1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot\n2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of \"type: Node\"\n3) slotchange: a slot element, slotted inside that slot had its \"slotchange\" event listener called. This practically means that transitively slotted children changed.\nCan only trigger if the child of a slot is a slot element itself.\n4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.\nCan only trigger for slots with \"invalidateOnChildChange\" metadata descriptor\n\n- newValue: the new value of the property (for type=\"property\" only)\n\n- oldValue: the old value of the property (for type=\"property\" only)\n\n- child the child that was changed (for type=\"slot\" and reason=\"childchange\" only)",
|
2936
|
+
"_ui5privacy": "public"
|
2937
|
+
}
|
2938
|
+
],
|
2939
|
+
"description": "A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)",
|
2940
|
+
"privacy": "public",
|
2941
|
+
"inheritedFrom": {
|
2942
|
+
"name": "UI5Element",
|
2943
|
+
"package": "@ui5/webcomponents-base",
|
2944
|
+
"module": "dist/UI5Element.js"
|
2945
|
+
}
|
2946
|
+
},
|
2947
|
+
{
|
2948
|
+
"kind": "method",
|
2949
|
+
"name": "getDomRef",
|
2950
|
+
"return": {
|
2951
|
+
"type": {
|
2952
|
+
"text": "HTMLElement | undefined"
|
2953
|
+
}
|
2954
|
+
},
|
2955
|
+
"description": "Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template\n*Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option\nUse this method instead of \"this.shadowRoot\" to read the Shadow DOM, if ever necessary",
|
2956
|
+
"privacy": "public",
|
2957
|
+
"inheritedFrom": {
|
2958
|
+
"name": "UI5Element",
|
2959
|
+
"package": "@ui5/webcomponents-base",
|
2960
|
+
"module": "dist/UI5Element.js"
|
2961
|
+
}
|
2962
|
+
},
|
2963
|
+
{
|
2964
|
+
"kind": "method",
|
2965
|
+
"name": "getFocusDomRef",
|
2966
|
+
"return": {
|
2967
|
+
"type": {
|
2968
|
+
"text": "HTMLElement | undefined"
|
2969
|
+
}
|
2970
|
+
},
|
2971
|
+
"description": "Returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
2972
|
+
"privacy": "public",
|
2973
|
+
"inheritedFrom": {
|
2974
|
+
"name": "UI5Element",
|
2975
|
+
"package": "@ui5/webcomponents-base",
|
2976
|
+
"module": "dist/UI5Element.js"
|
2977
|
+
}
|
2978
|
+
},
|
2979
|
+
{
|
2980
|
+
"kind": "method",
|
2981
|
+
"name": "getFocusDomRefAsync",
|
2982
|
+
"return": {
|
2983
|
+
"type": {
|
2984
|
+
"text": "Promise<HTMLElement | undefined>"
|
2985
|
+
}
|
2986
|
+
},
|
2987
|
+
"description": "Waits for dom ref and then returns the DOM Element marked with \"data-sap-focus-ref\" inside the template.\nThis is the element that will receive the focus by default.",
|
2988
|
+
"privacy": "public",
|
2989
|
+
"inheritedFrom": {
|
2990
|
+
"name": "UI5Element",
|
2991
|
+
"package": "@ui5/webcomponents-base",
|
2992
|
+
"module": "dist/UI5Element.js"
|
2993
|
+
}
|
2994
|
+
},
|
2995
|
+
{
|
2996
|
+
"kind": "method",
|
2997
|
+
"name": "focus",
|
2998
|
+
"return": {
|
2999
|
+
"type": {
|
3000
|
+
"text": "Promise<void>"
|
3001
|
+
}
|
3002
|
+
},
|
3003
|
+
"parameters": [
|
3004
|
+
{
|
3005
|
+
"name": "focusOptions",
|
3006
|
+
"optional": true,
|
3007
|
+
"type": {
|
3008
|
+
"text": "FocusOptions"
|
3009
|
+
},
|
3010
|
+
"description": "additional options for the focus",
|
3011
|
+
"_ui5privacy": "public"
|
3012
|
+
}
|
3013
|
+
],
|
3014
|
+
"description": "Set the focus to the element, returned by \"getFocusDomRef()\" (marked by \"data-sap-focus-ref\")",
|
3015
|
+
"privacy": "public",
|
3016
|
+
"inheritedFrom": {
|
3017
|
+
"name": "UI5Element",
|
3018
|
+
"package": "@ui5/webcomponents-base",
|
3019
|
+
"module": "dist/UI5Element.js"
|
3020
|
+
}
|
3021
|
+
},
|
3022
|
+
{
|
3023
|
+
"kind": "method",
|
3024
|
+
"name": "fireEvent",
|
3025
|
+
"return": {
|
3026
|
+
"type": {
|
3027
|
+
"text": "boolean"
|
3028
|
+
},
|
3029
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
3030
|
+
},
|
3031
|
+
"parameters": [
|
3032
|
+
{
|
3033
|
+
"name": "name",
|
3034
|
+
"type": {
|
3035
|
+
"text": "string"
|
3036
|
+
},
|
3037
|
+
"description": "name of the event",
|
3038
|
+
"_ui5privacy": "public"
|
3039
|
+
},
|
3040
|
+
{
|
3041
|
+
"name": "data",
|
3042
|
+
"optional": true,
|
3043
|
+
"type": {
|
3044
|
+
"text": "T"
|
3045
|
+
},
|
3046
|
+
"description": "additional data for the event",
|
3047
|
+
"_ui5privacy": "public"
|
3048
|
+
},
|
3049
|
+
{
|
3050
|
+
"name": "cancelable",
|
3051
|
+
"default": "false",
|
3052
|
+
"description": "true, if the user can call preventDefault on the event object",
|
3053
|
+
"_ui5privacy": "public"
|
3054
|
+
},
|
3055
|
+
{
|
3056
|
+
"name": "bubbles",
|
3057
|
+
"default": "true",
|
3058
|
+
"description": "true, if the event bubbles",
|
3059
|
+
"_ui5privacy": "public"
|
3060
|
+
}
|
3061
|
+
],
|
3062
|
+
"privacy": "public",
|
3063
|
+
"deprecated": "use fireDecoratorEvent instead",
|
3064
|
+
"inheritedFrom": {
|
3065
|
+
"name": "UI5Element",
|
3066
|
+
"package": "@ui5/webcomponents-base",
|
3067
|
+
"module": "dist/UI5Element.js"
|
3068
|
+
}
|
3069
|
+
},
|
3070
|
+
{
|
3071
|
+
"kind": "method",
|
3072
|
+
"name": "fireDecoratorEvent",
|
3073
|
+
"return": {
|
3074
|
+
"type": {
|
3075
|
+
"text": "boolean"
|
3076
|
+
},
|
3077
|
+
"description": "false, if the event was cancelled (preventDefault called), true otherwise"
|
3078
|
+
},
|
3079
|
+
"parameters": [
|
3080
|
+
{
|
3081
|
+
"name": "name",
|
3082
|
+
"type": {
|
3083
|
+
"text": "N"
|
3084
|
+
},
|
3085
|
+
"description": "name of the event",
|
3086
|
+
"_ui5privacy": "public"
|
3087
|
+
},
|
3088
|
+
{
|
3089
|
+
"name": "data",
|
3090
|
+
"optional": true,
|
3091
|
+
"type": {
|
3092
|
+
"text": "this[\"eventDetails\"][N] | undefined"
|
3093
|
+
},
|
3094
|
+
"description": "additional data for the event",
|
3095
|
+
"_ui5privacy": "public"
|
3096
|
+
}
|
3097
|
+
],
|
3098
|
+
"description": "Fires a custom event, configured via the \"event\" decorator.",
|
3099
|
+
"privacy": "public",
|
3100
|
+
"inheritedFrom": {
|
3101
|
+
"name": "UI5Element",
|
3102
|
+
"package": "@ui5/webcomponents-base",
|
3103
|
+
"module": "dist/UI5Element.js"
|
3104
|
+
}
|
3105
|
+
},
|
3106
|
+
{
|
3107
|
+
"kind": "method",
|
3108
|
+
"name": "getSlottedNodes",
|
3109
|
+
"return": {
|
3110
|
+
"type": {
|
3111
|
+
"text": "Array<T>"
|
3112
|
+
}
|
3113
|
+
},
|
3114
|
+
"description": "Returns the actual children, associated with a slot.\nUseful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.",
|
3115
|
+
"privacy": "public",
|
3116
|
+
"inheritedFrom": {
|
3117
|
+
"name": "UI5Element",
|
3118
|
+
"package": "@ui5/webcomponents-base",
|
3119
|
+
"module": "dist/UI5Element.js"
|
3120
|
+
}
|
3121
|
+
},
|
3122
|
+
{
|
3123
|
+
"kind": "method",
|
3124
|
+
"name": "attachComponentStateFinalized",
|
3125
|
+
"return": {
|
3126
|
+
"type": {
|
3127
|
+
"text": "void"
|
3128
|
+
}
|
3129
|
+
},
|
3130
|
+
"parameters": [
|
3131
|
+
{
|
3132
|
+
"name": "callback",
|
3133
|
+
"type": {
|
3134
|
+
"text": "() => void"
|
3135
|
+
},
|
3136
|
+
"_ui5privacy": "public"
|
3137
|
+
}
|
3138
|
+
],
|
3139
|
+
"description": "Attach a callback that will be executed whenever the component's state is finalized",
|
3140
|
+
"privacy": "public",
|
3141
|
+
"inheritedFrom": {
|
3142
|
+
"name": "UI5Element",
|
3143
|
+
"package": "@ui5/webcomponents-base",
|
3144
|
+
"module": "dist/UI5Element.js"
|
3145
|
+
}
|
3146
|
+
},
|
3147
|
+
{
|
3148
|
+
"kind": "method",
|
3149
|
+
"name": "detachComponentStateFinalized",
|
3150
|
+
"return": {
|
3151
|
+
"type": {
|
3152
|
+
"text": "void"
|
3153
|
+
}
|
3154
|
+
},
|
3155
|
+
"parameters": [
|
3156
|
+
{
|
3157
|
+
"name": "callback",
|
3158
|
+
"type": {
|
3159
|
+
"text": "() => void"
|
3160
|
+
},
|
3161
|
+
"_ui5privacy": "public"
|
3162
|
+
}
|
3163
|
+
],
|
3164
|
+
"description": "Detach the callback that is executed whenever the component's state is finalized",
|
3165
|
+
"privacy": "public",
|
3166
|
+
"inheritedFrom": {
|
3167
|
+
"name": "UI5Element",
|
3168
|
+
"package": "@ui5/webcomponents-base",
|
3169
|
+
"module": "dist/UI5Element.js"
|
3170
|
+
}
|
3171
|
+
},
|
3172
|
+
{
|
3173
|
+
"kind": "field",
|
3174
|
+
"name": "effectiveDir",
|
3175
|
+
"type": {
|
3176
|
+
"text": "string | undefined"
|
3177
|
+
},
|
3178
|
+
"description": "Determines whether the component should be rendered in RTL mode or not.\nReturns: \"rtl\", \"ltr\" or undefined",
|
3179
|
+
"privacy": "public",
|
3180
|
+
"default": "undefined",
|
3181
|
+
"readonly": true,
|
3182
|
+
"inheritedFrom": {
|
3183
|
+
"name": "UI5Element",
|
3184
|
+
"package": "@ui5/webcomponents-base",
|
3185
|
+
"module": "dist/UI5Element.js"
|
3186
|
+
}
|
3187
|
+
},
|
3188
|
+
{
|
3189
|
+
"kind": "field",
|
3190
|
+
"name": "isUI5Element",
|
3191
|
+
"type": {
|
3192
|
+
"text": "boolean"
|
3193
|
+
},
|
3194
|
+
"description": "Used to duck-type UI5 elements without using instanceof",
|
3195
|
+
"privacy": "public",
|
3196
|
+
"default": "true",
|
3197
|
+
"readonly": true,
|
3198
|
+
"inheritedFrom": {
|
3199
|
+
"name": "UI5Element",
|
3200
|
+
"package": "@ui5/webcomponents-base",
|
3201
|
+
"module": "dist/UI5Element.js"
|
3202
|
+
}
|
3203
|
+
},
|
3204
|
+
{
|
3205
|
+
"kind": "method",
|
3206
|
+
"name": "getUniqueDependencies",
|
3207
|
+
"static": true,
|
3208
|
+
"return": {
|
3209
|
+
"type": {
|
3210
|
+
"text": "Array<typeof UI5Element>"
|
3211
|
+
}
|
3212
|
+
},
|
3213
|
+
"description": "Returns a list of the unique dependencies for this UI5 Web Component",
|
3214
|
+
"privacy": "public",
|
3215
|
+
"inheritedFrom": {
|
3216
|
+
"name": "UI5Element",
|
3217
|
+
"package": "@ui5/webcomponents-base",
|
3218
|
+
"module": "dist/UI5Element.js"
|
3219
|
+
}
|
3220
|
+
},
|
3221
|
+
{
|
3222
|
+
"kind": "method",
|
3223
|
+
"name": "define",
|
3224
|
+
"static": true,
|
3225
|
+
"return": {
|
3226
|
+
"type": {
|
3227
|
+
"text": "typeof UI5Element"
|
3228
|
+
}
|
3229
|
+
},
|
3230
|
+
"description": "Registers a UI5 Web Component in the browser window object",
|
3231
|
+
"privacy": "public",
|
3232
|
+
"inheritedFrom": {
|
3233
|
+
"name": "UI5Element",
|
3234
|
+
"package": "@ui5/webcomponents-base",
|
3235
|
+
"module": "dist/UI5Element.js"
|
3236
|
+
}
|
3237
|
+
},
|
3238
|
+
{
|
3239
|
+
"kind": "method",
|
3240
|
+
"name": "getMetadata",
|
3241
|
+
"static": true,
|
3242
|
+
"return": {
|
3243
|
+
"type": {
|
3244
|
+
"text": "UI5ElementMetadata",
|
3245
|
+
"references": [
|
3246
|
+
{
|
3247
|
+
"name": "UI5ElementMetadata",
|
3248
|
+
"package": "@ui5/webcomponents-base",
|
3249
|
+
"module": "dist/UI5ElementMetadata.js"
|
3250
|
+
}
|
3251
|
+
]
|
3252
|
+
}
|
3253
|
+
},
|
3254
|
+
"description": "Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')\nNote: not to be confused with the \"get metadata()\" method, which returns an object for this class's metadata only",
|
3255
|
+
"privacy": "public",
|
3256
|
+
"inheritedFrom": {
|
3257
|
+
"name": "UI5Element",
|
3258
|
+
"package": "@ui5/webcomponents-base",
|
3259
|
+
"module": "dist/UI5Element.js"
|
3260
|
+
}
|
953
3261
|
}
|
954
3262
|
],
|
955
3263
|
"attributes": [
|