Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added docs for app banner #9872

Merged
merged 4 commits into from
Nov 8, 2023
Merged

added docs for app banner #9872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5844b8b
added docs
grimmoc Oct 26, 2023
0ebe5d8
added changelog
grimmoc Oct 26, 2023
3abb510
added to empty example json
grimmoc Oct 27, 2023
fdc3320
Update docs/theming/_index.md
JammingBen Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog/unreleased/enhancement-app-banner
View file
Open in desktop
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
View file
Open in desktop
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"
}
}
grimmoc marked this conversation as resolved.
Show resolved Hide resolved
```

`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