In earlier framework versions, the configuration options available in SAPUI5 could
be found in the API Reference via the
sap.ui.core.Configuration
. This legacy module has been
deprecated with SAPUI5 1.120 and replaced by a modular, future-proof
solution for configuration handling.
The SAPUI5 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 SAPUI5 1.120) may follow the former camelCase notation. Typically, you
should now use (or search for) the newer names, e.g. log-level
instead of logLevel
.
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 SAPUI5. 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 |
|
---|---|---|---|
active-terminologies |
Type: Default value: List of active terminologies provided via URL parameter, bootstrap or
|
![]() |
![]() |
language |
Type: Default value: Defines the language that shall be used for localized texts, formatting, and so on. For more information, see Identifying the Language Code / Locale. |
![]() |
|
rtl |
Type: Default value: RTL derived from user locale If set to 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: |
![]() |
![]() |
timezone |
Type: Default value: the browser's local time zone The configured time zone is used for For more information, see Date Format.
Setting the time zone via the configuration API has to be done at the earliest possible point in time when launching an SAPUI5 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 SAPUI5 configuration is applied globally and not application-specific; it therefore affects all apps inside the shell or launchpad, for example. |
![]() |
![]() |
Option |
Description |
by URL parameter |
|
---|---|---|---|
calendar-type |
Type: 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). |
![]() |
![]() |
calendar-week-numbering |
Type: Default value:
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 |
![]() |
![]() |
format-locale |
Type: Default value: Derived from the language Defines the locale used for formatting purposes; the default values for the locale are derived from the language. |
![]() |
![]() |
trailing-currency-code |
Type: Default value: By default the currency codes are shown after the amount. If set to |
![]() |
![]() |
ABAP-date-format |
Type: Default value: Specifies one of the ABAP date formats. |
![]() |
![]() |
ABAP-time-format |
Type: Default value: Specifies one of the ABAP time formats. |
![]() |
![]() |
ABAP-number-format |
Type: Default value: Specifies one of the ABAP number formats. |
![]() |
![]() |
Option |
Description |
by URL parameter |
|
---|---|---|---|
favicon |
Type: Default value: undefined Defines whether a favicon is used. If set to |
![]() |
![]() |
theme |
Type: 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 ( |
![]() |
![]() |
theme-roots |
Type: Default value: undefined Defines the location of themes. |
![]() |
![]() |
preload-lib-css |
Type: Default value: Specifies a list of UI libraries using the same syntax as the |
![]() |
![]() |
Option |
Description |
by URL parameter |
|
---|---|---|---|
accessibility |
Type: Default value: If set to |
![]() |
![]() |
animation-mode |
Type: Default value: Sets the animation behavior according to the values and description provided by the
|
![]() |
![]() |
uid-prefix |
Type: 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 |
|
---|---|---|---|
|
Type: Default value: URL to an allowlist service; see Allowlist Service. |
![]() |
![]() |
|
Type: Default value: Frame options mode; for more information, see Frame Options. |
![]() |
![]() |
|
Type: Default value: undefined Advanced frame options configuration; for more information, see Frame Options. |
![]() |
![]() |
security-token-handlers |
Type: 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. |
![]() |
![]() |
Option |
Description |
by URL parameter |
|
---|---|---|---|
debug |
Type: Default value: If set to You can also specify a comma-separated list as a Example: You can use the following patterns:
You can also select the debug sources in the Technical Information Dialog. For more information, see Technical Information Dialog. |
![]() |
![]() |
ignore-url-params |
Type: Default value: Security-relevant parameter that allows applications to disable configuration modifications via URL parameters. |
![]() |
![]() |
inspect |
Type: Default value: If set to |
![]() |
![]() |
log-level |
Type: Default value: This configuration parameter sets the log level to the given value; for minified (productive) sources, the
default level is Options: |
![]() |
![]() |
statistics |
Type: Default value: Activates end-to-end traces and measurement of response times For more information, see Interaction Tracking for Performance Measurement. |
![]() |
![]() |
support |
Type: Default value: Whether support mode is enabled. For more information, see Support Assistant. Options: |
![]() |
![]() |
test-recorder |
Type: Default value: Whether test tools are enabled. For more information, see Test Recorder. Options: |
![]() |
![]() |
Option |
Description |
by URL parameter |
|
---|---|---|---|
app-cache-buster |
Type: Default value: Modifiable at runtime via the AppCacheBuster API (see Application Cache Buster: Enhanced Concept). 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). |
![]() |
![]() |
async |
Type: Default value: 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? |
![]() |
![]() |
compat-version
|
Type: Default value: Applications must set this option to |
![]() |
![]() |
excludejquerycompat |
Type: Default value: 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. |
![]() |
![]() |
flexibility-services |
Type: Default value: You can define an alternative route from where to load SAPUI5 flexibility. For more information, see Bootstrapping SAPUI5 Flexibility. |
![]() |
![]() |
libs |
Type: Default value: Defines a list of libraries that shall be loaded initially. To load further libraries, the All libraries provided using the configuration option |
![]() |
![]() |
modules |
Type: Default value: Defines a list of JavaScript modules that shall be loaded after the core has been initialized. |
![]() |
![]() |
no-conflict |
Type: Default value: If set to |
![]() |
![]() |
on-init |
Type: Default value: 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 Within
For productive scenarios, only the usage of a module is supported. Functions or function references to the 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
|
![]() |
![]() |
resource-roots |
Type: Default value: undefined With To provide a URL location that is not overwritten by a component
later on, For more information, see the API Reference: |
![]() |
![]() |
The table below lists the possible types for configuration options and their corresponding valid values.
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.
Type |
Valid Values |
---|---|
|
|
|
Any valid integer value |
|
Any valid string value |
StringArray |
An empty array
For sources where the values can only be provided via a string such as a bootstrap tag, meta tag or URL,
you'd need to provide values of type |
FunctionArray |
An empty array |
Function |
A valid function object |
Object |
A valid JavaScript object |
Enumeration |
Any value which is part of the respective enumeration for the corresponding configuration parameter. For instance,
the animation-mode parameter can take any value of the sap/ui/core/AnimationMode
enumeration, such as AnimationMode.basic , AnimationMode.full ,
AnimationMode.minimal , or AnimationMode.none . |
For a list of deprecated configuration options, see Deprecated Configuration Options.