I have an UI5-based app (1.66+), which works correctly, but there are huge empty spaces on the left and right sides of the screen (aka letterboxing is on):
I want to disable letterboxing to use the entire screen space.
I tried the following approaches so far:
"fullWidth": true
in sap.ui
section of manifest.json<html class="sap-desktop sapUiMedia-Std-Desktop sapUiMedia-StdExt-LargeDesktop">
appWidthLimited: false
to index.html:<script>
sap.ui.getCore().attachInit(function () {
new sap.m.Shell({
app: new sap.ui.core.ComponentContainer({
height: "100%",
name: "APPNAME"
}),
appWidthLimited: false
}).placeAt("content");
});
</script>
Just like it is described in «How to customise Shell container in SAPUI5».
But none of them works for me.
Update:
I succeeded to solve the issue via a static XML-template — just add <Shell id="shell" appWidthLimited="false">
to the main XML-template, but now I want to understand how to implement it via JS in new sap.m.Shell(…)
definition.
The starting point for code experiments is below.
index.html:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>widescreen</title>
<script id="sap-ui-bootstrap"
src="../../resources/sap-ui-core.js"
data-sap-ui-theme="sap_fiori_3"
data-sap-ui-resourceroots='{"letterboxing.widescreen": "./"}'
data-sap-ui-compatVersion="edge"
data-sap-ui-oninit="module:sap/ui/core/ComponentSupport"
data-sap-ui-async="true"
data-sap-ui-frameOptions="trusted">
</script>
</head>
<body class="sapUiBody">
<div data-sap-ui-component data-name="letterboxing.widescreen" data-id="container" data-settings='{"id" : "widescreen"}' id="content"></div>
</body>
</html>
Component.js:
sap.ui.define([
"sap/ui/core/UIComponent",
"sap/ui/Device",
"letterboxing/widescreen/model/models"
], function (UIComponent, Device, models) {
"use strict";
return UIComponent.extend("letterboxing.widescreen.Component", {
metadata: {
manifest: "json"
},
init: function () {
// call the base component's init function
UIComponent.prototype.init.apply(this, arguments);
// enable routing
this.getRouter().initialize();
// set the device model
this.setModel(models.createDeviceModel(), "device");
}
});
});
Ok, so there seems to be many similar questions regarding how to disable/enable letterboxing. This answer should provide a solution for each case:
Look for the instantiation of sap.m.Shell
in your project and configure its appWidthLimited
property accordingly.
For example:
index.html
or in a module assigned to data-sap-ui-on-init
sap.ui.require([
"sap/m/Shell",
"sap/ui/core/ComponentContainer",
], (Shell, ComponentContainer) => new Shell({
appWidthLimited: false|true, // <-- default: true
// ...
}).placeAt("content"));
<Shell xmlns="sap.m" appWidthLimited="false|true">
<App>
<!-- ... -->
Of course, the Shell
can be configured dynamically in JS too with myShell.setAppWidthLimited
.
Note: if the letterboxing is not required, consider removing sap.m.Shell
entirely. There is no real purpose of sap.m.Shell
if the application always runs with full width or embedded in FLP.
API reference: sap.m.Shell
UX guideline: Letterboxing
The app or component …:
sap.m.Shell
anywhere (please check the root view).index.html
).manifest.json
"sap.ui": {
"fullWidth": true|false
Documentation: Descriptor for Applications, Components, and Libraries
// AppConfiguration required from "sap/ushell/services/AppConfiguration"
AppConfiguration.setApplicationFullWidth(true|false); //*
According to SAP Fiori design guidelines, switching the letterbox state during runtime is allowed:
Letterboxing can be switched on or off [...] for individual pages within an application. [...]
In some cases, applications may need to have the flexibility to change the width at runtime for different views. [...] Apps can change the width in the
AppConfiguration
service at runtime for different views.
* The API setApplicationFullWidth
, however, is deprecated since UI5 1.120. If you really need switching the letterbox state during the application runtime, please create a new customer ticket at https://me.sap.com/getsupport with the component CA-FLP-FE-UI.
API reference: sap.ushell.services.AppConfiguration
UX guideline: Letterboxing
Currently, the static fullWidth setting has no effect in: