Skip to content

Latest commit

 

History

History
351 lines (207 loc) · 7.44 KB

File metadata and controls

351 lines (207 loc) · 7.44 KB

DeprecatedConfiguration Options

The following tables show deprecatedconfiguration options.

Note:

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.

Note:

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 following configuration options are deprecated and should no longer be used in future-proof coding:

Option

Description

by URL parameter

by API

animation

(deprecated)

Type: boolean

Default value: true

For all controls that implement the animation parameter, the animation-mode is set as follows:

  • If animation is set to true, this is interpreted as animation-mode full

  • If animation is set to false, this is interpreted as animation-mode minimal

YES

YES

areas

(deprecated)

Type: string[]

Default value: null

This configuration parameter defines UI areas that shall be created in advance.

NO

NO

auto-aria-body-role

(deprecated)

Type: boolean

Default value: false

Determines whether the framework automatically adds the ARIA role application to the HTML body.

As of SAPUI5 version 1.78, autoAriaBodyRole has a default value false in order to conform to the ARIA 1.1 recommendations. Role application on body level is not recommended, as the screen reader would then interpret the entire application as one big custom control.

NO

NO

binding-syntax

(deprecated)

Type: string

Default value: complex

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 an XML view.

NO

NO

format-settings

(deprecated)

Type: sap.ui.core.Configuration.FormatSettings

Encapsulates configuration settings that are related to data formatting / parsing. When format configuration settings are modified through this class, UI5 only ensures that formatter objects created after that point in time will honor the modifications. To be on the safe side, applications should do any modifications early in their lifecycle or recreate any model/UI that is locale dependent.

Example usage: sap.ui.getCore().getConfiguration().getFormatSettings().setCustomUnits(...)

For more information, see the API Reference: sap.ui.core.Configuration.FormatSettings

NO

YES

manifest-first

(deprecated)

Type: boolean

Default value: false

Modifiable at runtime by using the sap.ui.core.Component.create component factory.

If set to true, the descriptor for a component is read and evaluated first, before loading the component code (Component.js).

For more information, see: sap.ui.core.Component.create

YES

YES

no-duplicate-ids

(deprecated)

Type: boolean

Default value: true

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.

YES

NO

origin-info

(deprecated)

Type: boolean

Default value: false

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

YES

NO

preload

(deprecated)

Type: string

Default value: auto

Defines the loading behaviour of the so-called preload files. They contain all modules of a library. The contained modules are only loaded, but not executed until they are used by the application.

The values are used as follows:

  • When set to auto, the runtime loads preload files asynchronously if the bootstrap configuration parameter async is set as async=true. We recommend to use the async=true configuration parameter in the bootstrap, as it switches many module-related APIs to async, including the loading behaviour of the preload files.
  • Preload files for the declared libraries are loaded synchronously when the async bootstrap configuration parameter is set tofalse (async=false) or not set at all. Best practices discourage such behavior.
  • For any other value (for example blank), the preload feature is deactivated and modules are loaded on demand.

NO

NO

trace

(deprecated)

Type: boolean

Default value: false

Defines whether a trace view should be shown.

Has only an effect when the sap-ui-debug.js module has been loaded, either explicitly or by setting the debug option to true.

NO

NO