Skip to content

Commit

Permalink
added docs for app banner (#9872)
Browse files Browse the repository at this point in the history
* added docs

* added changelog

* added to empty example json

* Update docs/theming/_index.md

Co-authored-by: Jannik Stehle <[email protected]>
Co-authored-by: Jan <[email protected]>
  • Loading branch information
3 people committed Dec 13, 2023
1 parent 50d6396 commit e2acde5
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
2 changes: 2 additions & 0 deletions changelog/unreleased/enhancement-app-banner
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ Enhancement: Added app banner for mobile devices
We've added an app banner at the top of the web view for mobile devices asking the user whether they want to continue working in the app. By dismissing it, it will not show again until a new session is started, e.g. by opening a new tab.

https://github.com/owncloud/web/pull/9696
https://github.com/owncloud/web/pull/9872

28 changes: 28 additions & 0 deletions docs/theming/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,26 @@ Spacing variables get prepended with `--oc-space-`, so e.g. _"xlarge"_ creates t
}
```

### App Banner
To configure the app banner shown on mobile devices, you can use the following settings:

```json
{
"appBanner": {
"title": "ownCloud",
"publisher": "ownCloud GmbH",
"additionalInformation": "",
"ctaText": "OPEN",
"icon": "themes/owncloud/assets/owncloud-app-icon.png",
"appScheme": "owncloud"
}
}
```

`title` is usually your app's name as shown in the App Store or Google Play. `publisher` is the app developer's name.
`additionalInformation` can be used to specify pricing information, such as "FREE" or a catchphrase like "Don't miss out on our awesome app!".
`ctaText` refers to the text in the call to action button on the right side. The `icon` directive may be used to specify your own app icon. `appScheme` is the first part of the URL that is used to tell the mobile OS which app to open, so using `ownCloud` will generate links such as `owncloud://yourdomain.com/f/2b61b822...`.

## Example theme

An empty template for your custom theme is provided below, and you can use the instructions above to set it up according to your needs. Please note that since changing themes at runtime is not yet supported it only consists of a `default` theme.
Expand All @@ -277,6 +297,14 @@ An empty template for your custom theme is provided below, and you can use the i
"name": "",
"slogan": ""
},
"appBanner": {
"title": "",
"publisher": "",
"additionalInformation": "",
"ctaText": "",
"icon": "",
"appScheme": ""
},
"logo": {
"topbar": "",
"favicon": "",
Expand Down

0 comments on commit e2acde5

Please sign in to comment.