Purple supports showing a custom HTML page on the first start of the app. This feature is called onboarding.
Configuration
The onboarding can be configured with two properties:
| Name | Type | Default | Available since Template | Description |
|---|---|---|---|---|
| app_onboarding_enabled | boolean | false | 3.10.0 | This property enables the onboarding screen. |
| app_onboarding_url | String | resource://dynamic/onboarding/index.html | 3.10.0 | This property defines the page to display on the onboarding screen. |
Updates to the onboarding
Starting with Standard 5.2.0 it is possible to make the onboarding appear again using the dynamic config file. The app evaluates the value of onboarding_version on every app start and compares it with the previously shown version. If the version does not match, the onboarding is shown again.
Onboarding JavaScript-API
The onboarding screen provides a custom API to close the onboarding screen and continue with the app start process. The Purple customer can decide to show the onboarding page again on the next app start, e.g. to skip the onboarding tutorial.
Please see the JavaScript-API documentation pages for details on the API.