0.11.x -> 1.0.0

OpenUI5

We decided not to include the OpenUI5 runtime into the ui5strap repository anymore. The example apps use now an online version of the runtime.

Structure

We have split the "ui5strap" library into 5 separate libraries:

Name	Description	Dependecies
pks.ui5strap.core	Base classes and utilities	sap.ui.core
pks.ui5strap.bs3	Bootstrap 3 controls	pks.ui5strap.core
pks.ui5strap.ex	Optional expensive controls	pks.ui5strap.core
pks.ui5strap.viewer	Ui5Strap viewer and app	pks.ui5strap.core
pks.ui5strap.task	Task modules	pks.ui5strap.core, pks.ui5strap.viewer

New

We created new classes:

Name	Purpose
pks.ui5strap.core.RenderUtils	Render utilities previously included in the ui5strap main library file.
pks.ui5strap.core.Utils	General utilities previously included in the ui5strap main library file.
pks.ui5strap.core.Layer	Layer helper previously included in the ui5strap main library file.

Deleted

We have deleted some classes:

Old Name	Reason
ui5strap.PageHeader	This control does not provide useful functionality.
ui5strap.Item	We use sap.ui.core.Item instead.
ui5strap.Label	Functionality is covered by pks.ui5strap.bs3.Text control.
ui5strap.Sidebar	Functionality is covered by pks.ui5strap.bs3.Bar control.

Renamed

We have renamed (and moved) some classes:

Old Name	New Name	Comment
ui5strap.Break	pks.ui5strap.core.LineBreak	Semantic
ui5strap.Line	pks.ui5strap.core.ThematicBreak	Semantic
ui5strap.List	pks.ui5strap.core.PlainList	Semantic
ui5strap.ListItem	pks.ui5strap.core.PlainListItem	Semantic
ui5strap.ListDropdownMenu	pks.ui5strap.bs3.DropdownMenu	Readability
ui5strap.ListNavItem	pks.ui5strap.bs3.NavItem	Semantic
ui5strap.ListMedia	pks.ui5strap.bs3.MediaList	Semantic
ui5strap.ListMediaItem	pks.ui5strap.bs3.MediaListItem	Semantic
ui5strap.TableColumn	pks.ui5strap.bs3.TableCell	This control represents a table cell, not a column.
ui5strap.AppSystem	pks.ui5strap.viewer.SystemApp	Readability
ui5strap.AppSandbox	pks.ui5strap.viewer.SandboxApp	Readability
ui5strap.AppConsole	pks.ui5strap.viewer.ConsoleApp	Readability
ui5strap.ActionModule	pks.ui5strap.viewer.Task	Semantic
ui5strap.task.Navigate	pks.ui5strap.task.NavigateTask	Semantic and Readability
ui5strap.task.Switch	pks.ui5strap.task.SwitchActionTask	Semantic and Readability
ui5strap.AM*	pks.ui5strap.task.*Task	Semantic and Readability

Moved

We have moved some classes:

Old Name	New Name	Comment
ui5strap.BarMenu	pks.ui5strap.ex.BarMenu	Restructuring
ui5strap.BarMenuItem	pks.ui5strap.ex.BarMenuItem	Restructuring
ui5strap.BarNavContainer	pks.ui5strap.ex.BarNavContainer	Restructuring
ui5strap.BaseSupport	pks.ui5strap.core.BaseSupport	Restructuring
ui5strap.ControlBase	pks.ui5strap.core.ControlBase	Restructuring
ui5strap.ElementBase	pks.ui5strap.core.ElementBase	Restructuring
ui5strap.ListItemBase	pks.ui5strap.core.ListItemBase	Restructuring
ui5strap.ListSelectionSupport	pks.ui5strap.core.ListSelectionSupport	Restructuring
ui5strap.NavContainer	pks.ui5strap.core.NavContainer	Restructuring
ui5strap.OptionsSupport	pks.ui5strap.core.OptionsSupport	Restructuring
ui5strap.ResponsiveTransition	pks.ui5strap.core.ResponsiveTransition	Restructuring
ui5strap.ScrollContainer	pks.ui5strap.core.ScrollContainer	Restructuring
ui5strap.SelectableSupport	pks.ui5strap.core.SelectableSupport	Restructuring
ui5strap.Action	pks.ui5strap.viewer.Action	Restructuring
ui5strap.ActionContext	pks.ui5strap.viewer.ActionContext	Restructuring
ui5strap.ActionController	pks.ui5strap.viewer.ActionController	Restructuring
ui5strap.App	pks.ui5strap.viewer.App	Restructuring
ui5strap.AppBase	pks.ui5strap.viewer.AppBase	Restructuring
ui5strap.AppComponent	pks.ui5strap.viewer.AppComponent	Restructuring
ui5strap.AppConfig	pks.ui5strap.viewer.AppConfig	Restructuring
ui5strap.AppFrame	pks.ui5strap.viewer.AppFrame	Restructuring
ui5strap.Console	pks.ui5strap.viewer.Console	Restructuring
ui5strap.Controller	pks.ui5strap.viewer.Controller	Restructuring
ui5strap.Manager	pks.ui5strap.viewer.Manager	Restructuring
ui5strap.RestClient	pks.ui5strap.viewer.RestClient	Restructuring
ui5strap.RootComponent	pks.ui5strap.viewer.RootComponent	Restructuring
ui5strap.Sandbox	pks.ui5strap.viewer.Sandbox	Restructuring
ui5strap.Viewer	pks.ui5strap.viewer.Viewer	Restructuring
ui5strap.ViewerBase	pks.ui5strap.viewer.ViewerBase	Restructuring

Theme Building

We use now grunt-openui5 to build themes.

index.html

The index.html for launching Ui5Strap apps (using pks.ui5strap.viewer.AppBase) has changed:

The styling rules that werde previously inside the preload.css are now part of the pks.ui5strap.core library theme. If you included the preload.css in your index.html file, you should include now the core library theme file instead.
The HTML structure is now smaller and easier. See the example index.html for details.
You must now define a root container and pass its id to the viewer options. The root container must be relative or absolute in position.

Configuration

The structure of configuration (app.json) has slightly changed:

Old	New	Reason
CONFIG.views	CONFIG.pages	Semantic. Please note that CONFIG.pages must be an array of objects. Each object must contain an "id" attribute.
CONFIG.rootNavigation.initialViews	CONFIG.rootNavigation.initialPages	Semantic.

API Changes

The method pks.ui5strap.viewer.AppBase.prototype.getViewConfig has been deleted. Use pks.ui5strap.viewer.AppConfig.prototype.getPageConfig instead.
The method pks.ui5strap.viewer.AppBase.prototype.createView has been renamed to pks.ui5strap.viewer.AppBase.prototype.createPage due to semantic reasons.
The method pks.ui5strap.viewer.AppConfig.prototype.getViewConfig has been renamed to pks.ui5strap.viewer.AppConfig.prototype.getPageConfig due to semantic reasons.
The method pks.ui5strap.viewer.AppConfig.prototype.createPage has now a callback function as second argument. Do not use the returned value but the first parameter of the callback function instead.
The method pks.ui5strap.viewer.AppConfig.prototype.getPageConfig does require a "id" property in the first argument map in order to load the page definitions from the config. This means you cannot load page configurations by just passing the view name anymore.
The pks.ui5strap.bs3.SelectBox control does now use sap.ui.core.Item instead of ui5strap.Item (deleted).

Table of Contents

Basics

Appendix