The following tables show available configuration options.
Note:
In earlier framework versions, the configuration options available in OpenUI5 could be found in the API Reference via the
sap.ui.core.Configuration
. This legacy module has been deprecated with OpenUI5 1.120 and replaced by a modular, future-proof solution for configuration handling.
Note:
The OpenUI5 configuration options now follow a consistent naming scheme based on kebab-case notation. Configuration options in older framework versions or code samples (especially those from before OpenUI5 1.120) may follow the former camelCase notation. Typically, you should now use (or search for) the newer names, e.g.
log-level
instead oflogLevel
.
The available configuration options are given below the topic they belong to, e.g. Localization, Theming, etc. Often, these topics correspond to modules with the same name, which provide methods to retrieve and set the values of their associated configuration options.
Some configuration options can also be set via URL parameters, which is indicated by an entry in the corresponding column in the tables below. URL parameter names are composed of the sap-ui-
prefix together with the name of the configuration option, for example: sap-ui-log-level=ALL
. An application may set the ignore-url-parameters
option to true
to disable configuration URL parameters.
Typically, configuration options are evaluated when booting OpenUI5. After that, all changes to these options are ignored. For some configuration options, specific APIs exist that allow you to modify their values at runtime. This is indicated by an entry in the corresponding column in the tables below, which usually also provides a link to the respective API method.
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`active-terminologies` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `undefined` List of active terminologies provided via URL parameter, bootstrap or [`sap.ui.core.Component.create`](https://ui5.sap.com/#/api/sap.ui.core.Component%23methods/sap.ui.core.Component.create) API. |  |  |
`language` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `user settings / language` Defines the language that shall be used for localized texts, formatting, and so on. For more information, see [Identifying the Language Code / Locale](/docs/04_Essentials/identifying-the-language-code-locale-91f21f1.html). |  |  [`Localization.setLanguage`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setLanguage) |
`rtl` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: RTL derived from user locale If set to `true`, all controls are rendered in right-to-left \(RTL\) mode. Typically, the RTL mode is derived from the current language, which is usually picked automatically based on the locale configuration of the user's browser or profile data. Particularly for testing purposes, it might be handy to set the mode explicitly. Modifiable at runtime with restrictions. For more information, see the [API Reference: `Localization.setLanguage`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setLanguage) . |  |  [`Localization.setRTL`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setRTL) |
`timezone` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: the browser's local time zone The configured time zone is used for `sap.ui.core.date.UI5Date` instances and to convert dates when using `sap.ui.core.format.DateFormat` instances. The time zone should be an IANA time zone ID, e.g. "America/New\_York". In addition to the `sap-ui-timezone` URL parameter, an alternative `sap-timezone` parameter can also be used to set the time zone. For more information, see [Date Format](/docs/04_Essentials/date-format-91f2eba.html). > ### Caution: > Setting the time zone via the configuration API has to be done at the earliest possible point in time when launching an OpenUI5 application. It is preferably even set by shells or launchpads, such as the SAP Fiori launchpad, before launching the application. Using the API in running applications can lead to unexpected data inconsistencies, because any created date objects could still be related to the previously configured time zone. Generally, **an app should be completely restarted after changing the time zone**. > > The OpenUI5 configuration is applied globally and not application-specific; it therefore affects **all** apps inside the shell or launchpad, for example. |  |  [`Localization.setTimezone`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setTimezone) |
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`calendar-type` | Type: [`sap/base/18n/date/CalendarType`](https://ui5.sap.com/#/api/module:sap/base/18n/date/CalendarType) Default value: If there is no value defined, the actual value is determined from the locale data for the configured locale. Defines the calendar type that is used for locale-dependent, date-related features \(for example, formatting or parsing date and time\). |  |  [`Formatting.setCalendarType`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCalendarType) |
`calendar-week-numbering` | Type: [`sap/base/18n/date/CalendarWeekNumbering`](https://ui5.sap.com/#/api/module:sap/base/18n/date/CalendarWeekNumbering) Default value: `Default` Defines the calendar week numbering algorithm that is used to determine the first day of the week and the first calendar week of the year. For more information, see the [API Reference: `sap/base/18n/date/CalendarWeekNumbering`](https://ui5.sap.com/#/api/module:sap/base/18n/date/CalendarWeekNumbering) |  |  [`Formatting.setCalendarWeekNumbering`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCalendarWeekNumbering) |
`format-locale` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: Derived from the language Defines the locale used for formatting purposes; the default values for the locale are derived from the language. |  |  [`Formatting.setLanguageTag`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setLanguageTag) |
`trailing-currency-code` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `true` By default the currency codes are shown after the amount. If set to `false`, the currency code will be shown as configured by the locale-specific patterns of the Common Locale Data Repository \(CLDR\). |  |  [`Formatting.setTrailingCurrencyCode`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setTrailingCurrencyCode) |
`ABAP-date-format` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `''` Specifies one of the ABAP date formats. |  |  [`Formatting.setABAPDateFormat`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.ABAPDateFormat) |
`ABAP-time-format` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `''` Specifies one of the ABAP time formats. |  |  [`Formatting.setABAPTimeFormat`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setABAPTimeFormat) |
`ABAP-number-format` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `''` Specifies one of the ABAP number formats. |  |  [`Formatting.setABAPNumberFormat`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setABAPNumberFormat) |
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`favicon` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean | string` Default value: undefined Defines whether a favicon is used. If set to `true`, a favicon, defined as part of a custom theme, is used. If no custom favicon has been defined or if the theme is an SAP standard theme, the SAP logo is used as favicon. You can also provide a relative path to a favicon as a string, e.g. to specify a favicon for a dedicated application. Absolute URLs are not allowed as origin for a favicon. |  |  [`Theming.setFavicon`](https://ui5.sap.com/#/api/module:sap/ui/core/Theming%23methods/sap/ui/core/Theming.setFavicon) |
`theme` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: The default theme of the used UI5 version Defines the theme that shall be used. **Theme Root:** When the theme string contains an at-sign \(`@`\), anything before the `@` is assumed to denote the ID of the theme, while anything after the `@` is assumed to represent the URL location of the theme. To defend against XSS attacks, only origins maintained in `sap-allowed-theme-origins` are accepted. For more information, see [Theme Origin Allowlist](/docs/04_Essentials/setting-themes-e9fc648.html#loioe9fc648661d84ed89360bbec3ae02611__section_TOA). |  |  [`Theming.setTheme`](https://ui5.sap.com/#/api/module:sap/ui/core/Theming%23methods/sap/ui/core/Theming.setTheme) |
`theme-roots` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `{}` Default value: undefined Defines the location of themes. |  |  |
`preload-lib-css` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `{}` Specifies a list of UI libraries using the same syntax as the `libs` property, for which the OpenUI5 core does not include the `library.css` stylesheet in the head of the page. If the list starts with an exclamation mark \(!\), no stylesheet is loaded at all for the specified libs. In this case, it is assumed that the application takes care of loading CSS, for example, a manually merged, single CSS file. Otherwise, the framework instructs the back end to create a merged CSS for the specified libs. In both cases, if the first libraries name is an asterisk \(\*\), it will be expanded to the list of already configured libraries. |  |  |
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`accessibility` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `true` If set to `true`, the OpenUI5 controls are rendered for or running in accessibility mode. |  |  |
`animation-mode` | Type: [`sap/ui/core/AnimationMode`](https://ui5.sap.com/#/api/module:sap/ui/core/AnimationMode) Default value: `full` Sets the animation behavior according to the values and description provided by the [`AnimationMode`](https://ui5.sap.com/#/api/module:sap/ui/core/AnimationMode) enumeration, e.g. `full`, `basic`, `minimal` or `none`. |  |  [`ControlBehavior.setAnimationMode`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior%23methods/sap/ui/core/ControlBehavior.setAnimationMode) |
`uid-prefix` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: '\_\_' \(i.e. two underscore characters\) Prefix to be used for automatically generated control IDs; must be chosen carefully to avoid conflicts with IDs defined by the application or DOM IDs. |  |  |
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`allowlist-service` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `""` URL to an allowlist service; see [Allowlist Service](/docs/05_Developing_Apps/allowlist-service-d04a6d4.html). |  |  |
`frame-options` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `allow` Frame options mode; for more information, see [Frame Options](/docs/05_Developing_Apps/frame-options-62d9c4d.html). |  |  |
`frame-options-config` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `{}` Default value: undefined Advanced frame options configuration; for more information, see [Frame Options](/docs/05_Developing_Apps/frame-options-62d9c4d.html). |  |  |
`security-token-handlers` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `[]` Each of these functions is called by the OData V4 model to retrieve the security tokens instead of using the default "X-CSRF-Token". For more information, see [Security Token Handling](/docs/04_Essentials/model-instantiation-and-data-access-9613f1f.html#loio9613f1f2d88747cab21896f7216afdac__section_STH). |  |  [`Security.setSecurityTokenHandlers`](https://ui5.sap.com/#/api/module:sap/ui/security/Security%23methods/sap/ui/security/Security.setSecurityTokenHandlers) |
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`debug` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean | string` Default value: `false` If set to `true`, the debug sources are loaded; if the bootstrap code is loaded from an optimized source, the bootstrap will be aborted and start anew from a debug source. You can also specify a comma-separated list as a `string` that contains all modules that should be loaded as debug source. Example: `index.html?sap-ui-debug=sap/ui/model/odata/v2/` will load all debug sources for all modules of the OData V2 model. All others modules will be taken from the preload \(if preload is active\). You can use the following patterns: - A trailing slash \(`/`\) means that the complete package should be included \(shortcut for `/**/*`\) Example: `sap/ui/model/odata/v2/` loads everything from the `sap/ui/model/odata/v2/` package as debug source \(also nested packages `sap/ui/model/odata/v2/**/*`\). - `**/` matches any package or sequence of packages Example: `**/v2/` loads any package named `v2` as debug sources like `odata/v2`, `json/v2/` etc. - `*` matches any part of a simple name Example: `sap/ui/model/*` matches all files directly contained in the model package, but not in nested packages \(for example, not `v2` or `v4`\) > ### Note: > You can also select the debug sources in the Technical Information Dialog. For more information, see [Technical Information Dialog](/docs/04_Essentials/technical-information-dialog-616a3ef.html#loio616a3ef07f554e20a3adf749c11f64e9). |  |  |
`ignore-url-params` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `false` Security-relevant parameter that allows applications to disable configuration modifications via URL parameters. |  |  |
`inspect` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `false` If set to `true`, the `sap-ui-debug.js` module is included and provides some supportability features. |  |  |
`log-level` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string` Default value: `ERROR` This configuration parameter sets the log level to the given value; for minified \(productive\) sources, the default level is `ERROR`, for debug sources it is `DEBUG`. At runtime, you can modify the log level by using the `sap/base/Log.setLevel` method. Options: `0|1|2|3|4|5|6|NONE|FATAL|ERROR|WARNING|INFO|DEBUG|ALL` |  |  [`Log.setLevel`](https://ui5.sap.com/#/api/module:sap/base/Log%23methods/sap/base/Log.setLevel) |
`statistics` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `false` Activates end-to-end traces and measurement of response times For more information, see [Interaction Tracking for Performance Measurement](/docs/04_Essentials/interaction-tracking-for-performance-measurement-b2825ea.html). |  |  |
`support` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `null` Whether support mode is enabled. For more information, see [Support Assistant](/docs/04_Essentials/support-assistant-57ccd7d.html). Options: `true | silent | window` |  |  |
`test-recorder` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `null` Whether test tools are enabled. For more information, see [Test Recorder](/docs/04_Essentials/test-recorder-2535ef9.html). Options: `true | silent | window` |  |  |
Option | Description | by URL parameter | [by API](/docs/04_Essentials/configuration-of-the-openui5-runtime-91f08de.html#loio91f08de06f4d1014b6dd926db0e91070__section_ACO) |
---|---|---|---|
`app-cache-buster` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `[]` Modifiable at runtime via the `AppCacheBuster` API \(see [Application Cache Buster: Enhanced Concept](/docs/04_Essentials/application-cache-buster-enhanced-concept-94e0c33.html)\). If set to a non-empty list of URLs, the `AppCacheBuster` will be activated and will load component version info files from the configured set of URLs \(see [Application Cache Buster](/docs/04_Essentials/application-cache-buster-ff7aced.html)\). |  |  |
`async` | Type: `boolean` Default value: `false` This configuration setting enables the module loader to load both modules and library-preload files asynchronously. Activating this feature requires intensive application-side cooperation and testing to ensure a stable and fully working application. In case you encounter issues, or if you want to prepare your application in advance, see [Is Your Application Ready for Asynchronous Loading?](/docs/03_Get-Started/is-your-application-ready-for-asynchronous-loading-493a15a.html) |  |  |
`compat-version` | Type: `string` Default value: `1.14` > ### Note: > Applications must set this option to `edge`. **Other version definitions are deprecated.** For more information, see [Compatibility Version Information](/docs/04_Essentials/compatibility-version-information-9feb96d.html). |  |  |
`excludejquerycompat` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `false` A compatibility layer restores several incompatibly changed APIs in jQuery v3 back to their old behavior in jQuery v2. It may be excluded via this setting. For more information, see [Upgrading from a Version Below 1.82](/docs/02_Read-Me-First/upgrading-from-a-version-below-1-82-147eef9.html). |  |  |
`libs` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `[]` Defines a list of libraries that shall be loaded initially. To load further libraries, the `Lib.load()` method may be used. For more information, see: [Lib.load](https://ui5.sap.com/#/api/sap.ui.core.Lib%23methods/sap.ui.core.Lib.load) All libraries provided using the configuration option `libs` are merged into the configuration option `modules`. |  |  |
`modules` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string[]` Default value: `[]` Defines a list of JavaScript modules that shall be loaded after the core has been initialized. |  |  |
`no-conflict` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `boolean` Default value: `false` If set to `true`, OpenUI5 forces jQuery into `noConflict` mode. |  |  |
`on-init` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `string|function` Default value: `undefined` Defines code that has to be executed after the initialization. In case a string is provided, this must be either the name of a module indicated by the prefix `module:` \(like [`module:sap/ui/core/ComponentSupport`](https://ui5.sap.com/#/api/module:sap/ui/core/ComponentSupport)\) or the name of a property within the `globalThis` object containing a function. The provided module will be loaded and executed after initialization. Within `globalThis["sap-ui-config"]["on-init"]` it is also possible to provide a function directly. > ### Caution: > For productive scenarios, only the usage of a module is supported. Functions or function references to the `globalThis` object are only intended to be used within non-productive scenarios, such as testing, web-based debugging, or sharing minimal samples. **Deprecation:** As of UI5 1.120, only module names should be provided for **productive** scenarios. Only for **non-productive** scenarios, references to functions available on the `globalThis` object might also be used. |  |  |
`resource-roots` | [Type](/docs/04_Essentials/configuration-options-and-url-parameters-91f2d03.html#loio91f2d03b6f4d1014b6dd926db0e91070__section_TVT): `object` Default value: undefined With `sap.ui.loader.config({paths: ...})` a map can be used to define locations for resources. See the [API Reference: `sap.ui.loader`](https://ui5.sap.com/#/api/sap.ui.loader) To provide a URL location that is **not** overwritten by a component later on, `final` can be set to `true`, for example: `{url: '/that/is/the/prefix/', final: true}` For more information, see the [API Reference: `sap.ui.loader.config`](https://ui5.sap.com/#/api/sap.ui.loader/methods/sap.ui.loader.config) |  |  |
The table below lists the possible types for configuration options and their corresponding valid values.
Note:
Some of the configuration options listed on this page, as well as the ones listed under Deprecated Configuration Options, might have more restrictions on the allowed values. Please refer to the corresponding entry for more details.