Compatibility version flags were introduced to allow applications to react to incompatible changes in OpenUI5.
Caution:
The concept of compatibility versions has been abandoned as of OpenUI5 version 1.28. Therefore, no new compatibility version flags will be introduced in the future. If you start building a new application, please set
data-sap-ui-compat-version="edge"on your OpenUI5 bootstrap tag.This ensures that the newest behavior of all features is applied. Other version definitions, including the default value, are deprecated.
As described in the compatibility rules, changes to OpenUI5 features are compatible; see Compatibility Rules for more information. In some cases, however, it used to make sense to change the behavior of a feature, for example, in order to change the default values or to use an optimized implementation. These changes could result in incompatibilities.
Note:
We recommend adopting new feature versions as soon as possible.
The compatibility version configuration worked as follows:
The version flag had to be defined in the OpenUI5 bootstrap tag, either globally (via data-sap-ui-compat-version) or individually for each feature (for example data-sap-ui-compat-version-xyz). Example with compat-version "1.18":
<script id="sap-ui-bootstrap"
type="text/javascript"
src="resources/sap-ui-core.js"
data-sap-ui-theme="sap_horizon"
data-sap-ui-libs="sap.m"
data-sap-ui-compat-version="1.18"
data-sap-ui-compat-version-xyz="1.16"
>
</script>
edge is specified as the compatibility version, the newest behavior of the feature is applied.A fallback mechanism is implemented. The following table is an example of possible configuration options for feature “xyz”:
| data-sap-ui-compat-version | data-sap-ui-compat-version-xyz | Default feature xyz | Resulting compatibility version |
|---|---|---|---|
| \-- | \-- | 1.14 | 1.14 |
| 1.16 \(deprecated\) | \-- | 1.14 | 1.16 |
| \-- | 1.16 | 1.14 | 1.16 |
| 1.18 \(deprecated\) | 1.16 | 1.14 | 1.16 |
| edge | .. | 1.14 | 1.18 |
OpenUI5 supports the following compatibility version flags:
| Flag | Description |
|---|---|
| `data-sap-ui-compat-version-sapMeTabContainer` | The `TabContainer` was deprecated in 1.15. When the compatibility version is 1.16 or higher, an error is logged to the console indicating that `sap.m.IconTabBar` should be used instead. Default value: 1.14 |
| `data-sap-ui-compat-version-sapMeProgessIndicator` | \-- |
| `data-sap-ui-compat-version-sapMGrowingList` | \-- |
| `data-sap-ui-compat-version-sapMListAsTable` | \-- |
| `data-sap-ui-compat-version-sapMDialogWithPadding` | By default, the content area of `Dialog` had paddings. To make the padding consistent with other popups, the padding is removed for compatibility versions 1.16 or higher. If the padding is still needed inside the content area of `Dialog`, you can use the [Container Content Padding CSS Classes](/docs/04_Essentials/using-container-content-padding-css-classes-c71f6df.html). Default value: 1.14 |
Related Information