@ui5/webcomponents-base
Advanced tools
Changelog
2.0.0-rc.0 (2024-04-09)
busy
property of the ui5-list
is renamed.
If you have previously used the busy
, busyDelay
properties:<ui5-list busy busy-delay="500"></ui5-list>
now you must use loading
and loadingDelay
properties:
<ui5-list loading loading-delay="500"></ui5-list>
disabled
property of the ui5-progress-indicator
is removed.
If you have previously used the disabled
property, it won't take effect:<ui5-progress-indicator disabled value="60"></ui5-progress-indicator>
Related to https://github.com/SAP/ui5-webcomponents/issues/8461, https://github.com/SAP/ui5-webcomponents/issues/7887
selectionMode
property no longer accepts "Delete" as value.
If you have previously used it:<ui5-upload-collection selection-mode="Delete"></ui5-upload-collection>
Now omit it completely and use hide-delete-button
onto the ui5-upload-collection:
<ui5-upload-collection>
<ui5-upload-collection-item hide-delete-button> </ui5-upload-collection-item>
</ui5-upload-collection>
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
mode
property and the ListMode
enum have been renamed.
If you have previously used the mode
property and the ListMode
values:<ui5-list class="list" mode="SingleSelect">
<ui5-list class="list" mode="MultiSelect">
<ui5-upload-collection mode="SingleSelectBegin">
<ui5-upload-collection mode="SingleSelectEnd">
<ui5-tree mode="SingleSelectAuto" >
<ui5-tree mode="None" >
Now use selectionMode
and Single
, Multiple
instead:
<ui5-list class="list" selection-mode="Single">
<ui5-list class="list" selection-mode="Multiple">
<ui5-upload-collection selection-mode="SingleStart">
<ui5-upload-collection selection-mode="SingleEnd">
<ui5-tree selection-mode="SingleAuto">
<ui5-tree selection-mode="None">
Related to https://github.com/SAP/ui5-webcomponents/issues/8461, https://github.com/SAP/ui5-webcomponents/issues/7887
someTab.getTabInsStripDomRef();
someTabSeparator.getTabInsStripDomRef();
Now use:
someTab.getDomRefInStrip();
someTabSeparator.getDomRefInStrip();
Related to: https://github.com/SAP/ui5-webcomponents/issues/8461
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
CSP.js
module and the creation of <style>
and <link>
tags, as all browsers now support adoptedStyleSheets. The following APIs are not available any more and should not be used:import { setUseLinks } from "@ui5/webcomponents-base/dist/CSP.js"
import { setPackageCSSRoot } from "@ui5/webcomponents-base/dist/CSP.js"
import { setPreloadLinks } from "@ui5/webcomponents-base/dist/CSP.js"
ICardHeader
interface. If you previously used the interfaceimport type { ICardHeader } from "@ui5/webcomponents-base/dist/Card.js"
Use the CardHeader type instead:
import type CardHeader from "@ui5/webcomponents-base/dist/CardHeader.js"
IUploadCollectionItem
interface. If you previously used the interface:import type { IUploadCollectionItem} from "@ui5/webcomponents-fiori/dist/UploadCollection.js"
Use the UploadCollectionItem
type instead:
import type UploadCollectionItem from "@ui5/webcomponents-fiori/dist/UploadCollectionItem.js"
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
size
property now accepts different values. If you previously used it like:<ui5-busy-indicator size="Small"></ui5-busy-indicator>
Now use the new values instead:
<ui5-busy-indicator size="S"></ui5-busy-indicator>
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
status
property and its shadow part have been renamed. If you previously used them:<style>
.cardHeader::part(status) { ... }
</style>
<ui5-card-header status="3 of 10"></ui5-popover>
Now use additionalText
instead:
<style>
.cardHeader::part(additional-text) { ... }
</style>
<ui5-card-header class="cardHeader" additional-text="3 of 10"></ui5-card-header>
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
pageIndicatorStyle
no longer exists. If you previously used it like:<ui5-carousel page-indicator-style="Numeric"></ui5-carousel>
Now you should use pageIndicatorType
instead:
<ui5-carousel page-indicator-type="Numeric"></ui5-carousel>
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
UI5Element#render
method in favour of UI5Element#renderer
. If you previously used "render"class MyClass extends UI5Element {
static get render() {
return litRenderer;
}
}
start using "renderer"
class MyClass extends UI5Element {
static get renderer() {
return litRenderer;
}
}
npm init @ui5/webcomponents-package
used to create JS-based project, however now it will be TypeScript-based project.
If you previously used npm init @ui5/webcomponents-package --enable-typescript
to create TypeScript-based project, now it's by default, e.g npm init @ui5/webcomponents-package
and --enable-typescript
is removed.Left
and Right
options option have been renamed. If you previously used them to set the placement or the alignment of the popover:<ui5-popover horizontal-align="Left" placement-type="Left"></ui5-popover>
Now use Start
or End
instead:
<ui5-popover horizontal-align="Start" placement-type="Start"></ui5-popover>
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
soccor
icon. Use soccer
instead.add-polygone
icon. Use add-polygon
instead.ui5-package/dist/api.json file
, you can now use ui5-package/dist/custom-elements.json
import "@ui5/webcomponents/dist/Assets-static.js";
import "@ui5/webcomponents-icons/dist/Assets-static.js"
use the dynamic equivalent of it:
import "@ui5/webcomponents/dist/Assets.js";
import "@ui5/webcomponents-icons/dist/Assets.js"
Related to: https://github.com/SAP/ui5-webcomponents/issues/8461
selected-dates-change
is renamed to selection-change
. In addition the event details
values
and dates
are renamed to selectedValues
and selectedDateValues
. If you previously used the Calendar event as follows:myCalendar.addEventListener("selected-dates-change", () => {
const values = e.detail.values;
const dates = e.detail.dates;
})
Now you have to use the new event name and details:
myCalendar.addEventListener("selection-change", () => {
const values = event.detail.selectedValues;
const dates = event.detail.selectedDateValues;
})
Related to: https://github.com/SAP/ui5-webcomponents/issues/8461
color
is renamed to value
. If you previously used the change event of the ColorPicker as follows:<ui5-color-picker color="red"></ui5-color-picker>
Now you have to use it like this:
<ui5-color-picker value="red"></ui5-color-picker>
Related to: https://github.com/SAP/ui5-webcomponents/issues/8461
openPopover
and showAt
methods are removed in favor of open
and opener
properties. If you previously used the imperative API:button.addEventListener("click", function(event) {
colorPalettePopover.showAt(this);
});
Now the declarative API should be used instead:
<ui5-button id="opener">Open</ui5-button>
<ui5-color-palette-popover opener="opener">
button.addEventListener("click", function(event) {
colorPalettePopover.open = !colorPalettePopover.open;
});
ui5-bar
component is now in main
library. If you previously imported the ui5-bar
from fiori
:import "@ui5/webcomponents-fiori/dist/Bar.js;
Now, import the ui5-bar
from main
:
import "@ui5/webcomponents/dist/Bar.js";
Related to: https://github.com/SAP/ui5-webcomponents/issues/8461
<ui5-tab id="nestedTab" slot="subTabs"></ui5-tab>
Now use:
<ui5-tab id="nestedTab" slot="items"></ui5-tab>
Relates to https://github.com/SAP/ui5-webcomponents/issues/8461
<ui5-tabcontainer tabs-overflow-mode="StartAndEnd"></ui5-tabcontainer>
Now use:
<ui5-tabcontainer overflow-mode="StartAndEnd"></ui5-tabcontainer>
Relates to https://github.com/SAP/ui5-webcomponents/issues/8461
TabContainerBackgroundDesign
, use BackgroundDesign
instead.Relates to https://github.com/SAP/ui5-webcomponents/issues/8461
<ui5-tabcontainer show-overflow></ui5-tabcontainer>
now use the overflowButton slot:
<ui5-tabcontainer>
<ui5-button slot="startOverflowButton" id="startOverflowButton">Start</ui5-button>
<ui5-button slot="overflowButton" id="endOverflowButton">End</ui5-button>
</ui5-tabcontainer>
Relates to https://github.com/SAP/ui5-webcomponents/issues/8461
placementType
property and the PopoverPlacementType
enum have been renamed.
If you have previously used the placementType
property and the PopoverPlacementType
<ui5-popover placement-type="Bottom"></ui5-popover>
import PopoverPlacementType from "@ui5/webcomponents/dist/types/PopoverPlacementType.js";
Now use placement
instead:
<ui5-placement="Bottom"></ui5-popover>
import PopoverPlacementType from "@ui5/webcomponents/dist/types/PopoverPlacement.js";
Related to https://github.com/SAP/ui5-webcomponents/issues/8461
size
property of the ui5--illustrated-message
is renamed to design
.
If you have previously used the size
property:<ui5-illustrated-message size="Dialog">
Now use design
instead:
<ui5-illustrated-message design="Dialog">
Related to https://github.com/SAP/ui5-webcomponents/issues/8461, https://github.com/SAP/ui5-webcomponents/issues/7887
separator-style
property is renamed to separators
and the BreadcrumbsSeparatorStyle
enum is renamed to BreadcrumbsSeparator
.
If you have previously used the separator-style
property:<ui5-breadcrumbs separator-style="Slash">
Now use separators
instead:
<ui5-breadcrumbs separators="Slash">
Related to https://github.com/SAP/ui5-webcomponents/issues/8461, https://github.com/SAP/ui5-webcomponents/issues/7887
disabled
property of the ui5-option
is removed.
If you have previously used the disabled
property:<ui5-option disabled>Option</ui5-option>
it will no longer work for the component.
Related to https://github.com/SAP/ui5-webcomponents/issues/8461, https://github.com/SAP/ui5-webcomponents/issues/7887
ITab
interface. TabContainer is designed to work only with Tab and TabSeparator classes, so the interface was obsolete.Changelog
1.24.0-rc.4 (2024-04-04)
Changelog
1.24.0-rc.3 (2024-03-28)
Changelog
1.24.0-rc.0 (2024-03-14)