Ui5Strap
  • About
  • Manual
  • API
  • Code Examples
  • Demos
  • License

Table of Contents

  •   Quickstart
    •   Installation
    •   Hello World
    •   Run

Basics

  •   Project Structure
    •   File Structure
    •   Binaries
    •   Build Tools
    •   Dev Server
    •   Web App Folder
  •   Bootstrapping
    •   Index File
    •   App Icons
    •   Splash Screen
    •   Initialization
  •   Configuration
    •   Overview
    •   App Settings
    •   Developers & Licenses
    •   Environments
    •   Stylesheets
    •   Root Navigation
    •   Pages
    •   Routing
    •   Libraries
    •   Models
    •   Options
    •   Components
    •   Actions
    •   Events
    •   Scripts
  •   Layout
    •   Using Controls
    •   Composing Views
    •   Fragments
  •   Styling
    •   Themes
    •   Custom Style
    •   Style Options
  •   Binding
    •   Element Binding
    •   Property Binding
    •   Aggregation Binding
    •   Formatters
  •   Logic
    •   Controllers
    •   Events
    •   Actions

Appendix

  •   Change Log
    •   0.11.x -> 1.0.0
    •   1.0.0 -> 1.0.1

  App Settings

App ID

The app id is the world unique identifier of the app. It must be specified in Java convention for full qualified package names.

To create an ID, reverse the company's domain and append your product name, separated by a dot.

  app.json
{
    "app" : {
        "id" : "com.mycompany.helloworld"
        
        ...
    }
	
    ...
}

Package (optional)

The package name is the application namespace that is used for all JavaScript classes that belong to the app.

By default, the package name is the same as the id. You can provide a shorter package name that will be used in the scripts.

  app.json
{
    "app" : {
        "id" : "com.mycompany.xyz.helloworld",
        "package" : "mycompany.helloworld"
        
        ...
    }
	
    ...
}

Name & Version (optional)

You can specify the name and version of your app. However, the name is shown on the default splash screen only, the version is not shown at all.

  app.json
{
    "app" : {
        ...
        
        "name" : "My first App",
        "version" : "0.0.1-SNAPSHOT"
    }
    
    ...
}

Main Class (optional)

You can specify the main class of the application. The main class must inherit pks.ui5strap.viewer.AppBase. If no main class is specified, the default application class pks.ui5strap.viewer.App is used.

  app.json
{
    "app" : {
    	...
        
        "type" : "pks.ui5strap.viewer.App"
    
    	...
    },
	
    ...
}

pks.ui5strap.viewer.App

The default application class with root navigation. Used when no app class is specified.

pks.ui5strap.viewer.AppBase

The abstract application class.

Transition (optional)

The transition attribute specifies the animation that should be triggered when the app is shown.

  app.json
{
    "app" : {
        ...
        
        "transition" : "zoom-in"
    }
    
    ...
}
Next: Developers & Licenses »

© 2013 - 2023 PKSoftware.de

  • Contact