New: Added favicon support (fixes #306) (#396)

adaptlearning · Mar 8, 2023 · fe46c7e · fe46c7e
1 parent 0748700
commit fe46c7e
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 1 deletion.
diff --git a/example.json b/example.json
@@ -1,6 +1,13 @@
 // Available properties
 // --------------------------------------------------
 
+// course.json
+"_vanilla": {
+    "_favIcon": {
+        "_src": ""
+    }
+},
+
 // contentObjects.json
 "_vanilla": {
     "_backgroundImage": {

diff --git a/js/theme.js b/js/theme.js
@@ -16,6 +16,17 @@ class Theme extends Backbone.Controller {
 
   onDataReady() {
     $('html').addClass(Adapt.course.get('_courseStyle'));
+    this.addFavIcon();
+  }
+
+  addFavIcon() {
+    const theme = Adapt.course.get('_vanilla');
+    if (!theme._favIcon._src) return;
+    const $linkStandard = $(`<link rel="icon" href="${theme._favIcon._src}" size="192x192" />`);
+    const $linkApple = $(`<link rel="apple-touch-icon" href="${theme._favIcon._src}" />`);
+    $('head')
+      .append($linkStandard)
+      .append($linkApple);
   }
 
   onPostRender(view) {

diff --git a/properties.schema b/properties.schema
@@ -698,7 +698,30 @@
           "type": "object"
         },
         "course": {
-          "type": "object"
+          "type": "object",
+          "properties": {
+            "_vanilla": {
+              "type": "object",
+              "required": false,
+              "properties": {
+                "_favIcon": {
+                  "type": "object",
+                  "required": false,
+                  "legend": "FavIcon",
+                  "properties": {
+                    "_src": {
+                      "type": "string",
+                      "required": false,
+                      "default": "",
+                      "inputType": "Asset:image",
+                      "validators": [],
+                      "help": "Select a favicon to improve user experience and enforce brand consistency. This will be displayed in places like your browser's address bar, page tabs and bookmarks menu. Usually, a favicon is 16 x 16 pixels in size and stored in the GIF, PNG, or ICO file format."
+                    }
+                  }
+                }
+              }
+            }
+          }
         },
         "contentobject": {
           "type": "object",

diff --git a/schema/course.schema.json b/schema/course.schema.json
@@ -0,0 +1,39 @@
+{
+  "$anchor": "vanilla-course",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "$patch": {
+    "source": {
+      "$ref": "course"
+    },
+    "with": {
+      "properties": {
+        "_vanilla": {
+          "type": "object",
+          "title": "Theme",
+          "default": {},
+          "properties": {
+            "_favIcon": {
+              "type": "object",
+              "default": {},
+              "title": "Favicon",
+              "properties": {
+                "_src": {
+                  "type": "string",
+                  "isObjectId": true,
+                  "title": "Image",
+                  "description": "Select a favicon to improve user experience and enforce brand consistency. This will be displayed in places like your browser's address bar, page tabs and bookmarks menu. Usually, a favicon is 16 x 16 pixels in size and stored in the GIF, PNG, or ICO file format.",
+                  "default": "",
+                  "_backboneForms": {
+                    "type": "Asset",
+                    "media": "image"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}