added docs for app banner (#9872)

* 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]>
owncloud · Nov 8, 2023 · 2023b84 · 2023b84
1 parent 7390d9f
commit 2023b84
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/theming/_index.md b/theming/_index.md
@@ -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.
@@ -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": "",