Show TOC

Configuration OptionsLocate this document in the navigation structure

The complete list of configuration options available in SAPUI5 can be found in the API reference under sap.ui.core.Configuration. The following table shows a subset of the available configuration options.

Option Type
accessibility

Type: boolean

Default value: true

URL: Yes

Modifiable at runtime: No

If set to true, the SAPUI5 controls are rendered for or running in accessibility mode.

animation

Type: boolean

Default value: Yes

URL: Yes

Modifiable at runtime: Yes

If set to true, animations are generally allowed in SAPUI5 controls.

areas

Type: string[]

Default value: null

URL: No

This configuration parameter defines UI areas that shall be created in advance; use to create new UI areas and sap.ui.getCore().getUIArea(id).destroy() to delete existing UI areas at runtime.

bindingSyntax

Type: string

Default value: default

URL: No

Modifiable at runtime: No

This configuration parameter defines whether the simple or the complex binding syntax is used. The parameter only affects bindings that are defined as strings, for example in the constructor of a control, or when specifying a binding in a declarative view, such as XML view or HTML view.

The meaning of the default value 'default' depends on the compatibility version sapCoreBindingSyntax. If the compatibility version is at least 1.26, the 'complex' binding syntax is assumed, otherwise the 'simple' binding type. In other words: applications that configured a general compatibility version of 1.26 (or higher or 'edge'), will automatically run with the 'complex' binding syntax.

debug

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

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.

formatLocale

Type: string

Default value: undefined

URL: Yes

Modifiable at runtime: No

This configuration parameter defines the locale used for formatting purposes; the default values for the locale are derived from the language.

frameOptions

Type: string

Default value: default

URL: No

Modifiable at runtime: No

Frame options mode; for more information, see Frame Options

frameOptionsConfig

Type: object

Default value: undefined

URL: No

Modifiable at runtime: No

Advanced frame options Configuration; for more information, see Frame Options

ignoreUrlParams

Type: boolean

Default value: false

URL: No

Modifiable at runtime: No

Security-relevant parameter that allows applications to disable configuration modifications via URL parameters.

inspect

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

If set to true, the sap-ui-debug.js module is included and provides some supportability features

language

Type: string

Default value: user language

URL: Yes

Modifiable at runtime: No

This configuration parameter defines the language that shall be used for localized texts, formatting, and so on.

The default value is not static, but determined from the browser or user language in the following order:

  1. navigator.language
  2. navigator.browserLanguage
  3. navigator.userLanguage
libs

Type: string[]

Default value: [ ]

URL: No

Modifiable at runtime: Yes

This configuration parameter defines a list of libraries that shall be loaded initially; use the loadLibrary() method to load further libraries.

logLevel

Type: 0|1|2|3|4|5|6|NONE|FATAL|ERROR|WARNING|INFO|DEBUG|ALL

Default value: ERROR

URL: Yes

Modifiable at runtime: Yes

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 jQuery.sap.log.setLevel method.

modules

Type: string[]

Default value: [ ]

URL: No

This configuration parameter defines a list of JavaScript modules that shall be loaded after the code has been initialized.

noConflict

Type: boolean

Default value: false

URL: No

Modifiable at runtime: No

If set to true, SAPUI5 forces jQuery into noConflict mode.

noDuplicateIds

Type: boolean

Default value: true

URL: Yes

Modifiable at runtime: No

If set to true, this configuration parameter enforces that the same IDs are not used for multiple controls; we highly recommend this check as duplicate IDs may cause unforeseeable issues and side effects.

onInit

Type: code

Default value: undefined

URL: No

Modifiable at runtime: No

This configuration setting defines if code has to be executed after the initialization.

originInfo

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

If set to true, additional information for text resources is provided that allows to determine the origin of a translated text on the UI

preload

Type: not specified, auto, sync, or async

Default value: auto

URL: No

Modifiable at runtime: No

Between loading SAPUI5 core runtime and further libraries, the so-called preload files are loaded. They contain all modules of a library. The modules are only loaded, but not executed, thus

The values are used as follows:

  • When set to auto, SAPUI5 runtime automatically uses sync when running from optimized sources.
  • When set to sync, the preload files for the declared libraries are loaded synchronously.
  • When set to async (recommended), the preload files are loaded asynchronously.
  • For any other value (for example blank), the preload feature is deactivated and modules are loaded on demand.
preloadLibCss

Type: string[]

Default value: []

URL: Yes

Modifiable at runtime: No

This configuration setting specifies a list of UI libraries using the same syntax as the libs property, for which the SAPUI5 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 Core instructs the backend 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.

Note The merge feature is currently only available for Java and only for apps that include the additional backend component resource-ext. Without the merge, applications can include their own merged CSS file and suppress the loading of the standard library.css.
resourceRoots

Type: object

Default value: undefined

URL: No

Modifiable at runtime: string can be used to define a location for all resources. jQuery.sap.registerModulePath(), sap.ui.localResources()

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}

rtl

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

If set to true, all controls are rendered in right-to-left (RTL) mode; not yet determined automatically.

theme

Type: string

Default value: base

URL: Yes

Modifiable at runtime: Yes

This configuration parameter defines the theme that shall be used for the current page; you can change the theme at runtime by calling sap.ui.getCore().applyTheme().

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 URLs that point into the SAP Theming Repository on the same server as the application are accepted. If the URL is not valid, the theme ID is also ignored.

themeRoots

Type: object

Default value: undefined

URL: No

Modifiable at runtime: sap.ui.getCore().setThemeRoot()

This configuration parameter defines the location of themes.

trace

Type: boolean

Default value: false

URL: No

Modifiable at runtime: No

If set to true, this configuration parameter activates an overlay div that contains a trace.

uidPrefix

Type: string

Default value: '--'

URL: No

Modifiable at runtime: No

Prefix to be used for automatically generated control IDs; must be choosen carefully to avoid conflicts with IDs defined by the application or DOM IDs.

versionedLibCss

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

If set to true, the version parameters are included in requests to the library theme resource (for example, the parameter library.css?version=1.0.1&sap-ui-dist-version=1.0.2 is added. version contains the library version and sap-ui-dist-version the version of the SAPUI5 distribution .

This applies to the following resources:
  • library(-RTL).css (or any other variation)

  • library-parameters.json

URLs within the CSS or parameters are not modified.
weinreId

Type: string

URL: Yes

Modifiable at runtime: No

weinreServer

Type: string

Default value:

URL: No

Modifiable at runtime: No

URL to a WEINRE server to be used for debugging purposes; if set, SAPUI5 automatically includes the WEINRE target modules.

whitelistService

Type: string

Default value:

URL: No

Modifiable at runtime: No

URL to a whitelist service; see Whitelist Service

Experimental Options

The options listed in the table below are 'experimental'. They may be removed in future versions, or their definition or behavior may change in an incompatible way. Experimental options are identified by the name prefix xx-. Experimental configuration options are used for support scenarios where SAPUI5 development needs the freedom to evolve supportability features over time. Others are related to experimental features where the underlying feature still may change. When an experimental configuration option becomes mature, the xx- prefix is removed from the definition. For compatibility reasons, the old name with the xx- prefix will still be supported.

Option Type
xx-debugModuleLoading
Note This is an experimental feature and may be modified or removed in future versions.

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

When set to true, the SAPUI5 module loading feature produces DEBUG output for every required, executed, or required but already loaded module. This can help to analyse issues with dependency order, and so on.

xx-debugRendering
Note This is an experimental feature and may be modified or removed in future versions.

Type: boolean

Default value: false

URL: Yes

Modifiable at runtime: No

When set to true, some components of the SAPUI5 rendering system (RenderManager, UIArea) create a far more verbose debug output for rendering steps, for example:

  • Which controls have to be rendered?

  • Who invalidated the control? (stacktrace)

  • Was one rendering run sufficient, or have there been multiple runs?

xx-e2e-trace
Note This is an experimental feature and may be modified or removed in future versions.

Type: boolean

Default value: false

URL: No

Modifiable at runtime: No

This configuration setting enables the end-to-end trace capability.

xx-fakeOS
Note This is an experimental feature and may be modified or removed in future versions.

Type: string

Default value: undefined

URL: Yes

Modifiable at runtime: No

You use this configuration parameter to simulate iOS, Android and BlackBerry on desktop PCs for easier development of mobile apps and controls. The following values are supported:

  • ios
  • android
  • blackberry

The parameter modifies the user-agent and runtime and theming act as the selected mobile platform. This includes browser detection mechanisms such as jQuery.browser. This configuration parameter is not handled by the SAPUI5 configuration object and is only available as URL parameter and as attribute in the bootstrap script tag.

Note This configuration parameter only works on desktop WebKit browsers, such as Chrome and Safari and Internet Explorer 10. On other browsers and on mobile devices the configuration parameter has no effect. Internet Explorer 10 only supports the Windows phone simulation and the Webkit browsers only support iOS, Android, and Blackberry simulation.
xx-loadAllMode
Note This is an experimental feature and may be modified or removed in future versions.

Type: boolean

Default value: false

URL: No

Modifiable at runtime: No

This configuration parameter is used internally by SAPUI5 runtime. To activate it, load sap-ui-core-all.js instead of sap.ui.core.js.

xx-showLoadErrors
Note This is an experimental feature and may be modified or removed in future versions.

When executing a loaded module synchronously, some browsers do not provide a proper error location. By setting this configuration parameter to true, SAPUI5 can be advised to load a failed script a second time, but asynchronously with a script tag. This usually results in an easier to understand syntax error message and a code location.

xx-supportedLanguages
Note This is an experimental feature and may be modified or removed in future versions.

Type: string[]

Default value: []

URL: Yes

Modifiable at runtime: No

With this option the client can be instructed to limit its backend requests for translatable texts to the configured set of languages. An empty value or the value * allows any language, the value default limits the requests to the set of languages that are delivered with SAPUI5.

xx-test-mobile
Note This is an experimental feature and may be modified or removed in future versions.

Type: boolean

Default value: false

Modifiable at runtime: No

This configuration parameter activates support for mobile device-specific events, such as touch events. This enables you to test standard SAPUI5 controls on mobile devices.