Merge branch 'release/2.1.0'

os2display · Oct 23, 2024 · 4b06b25 · 4b06b25
2 parents 3c3cde9 + 8a27b8a
commit 4b06b25
Show file tree

Hide file tree

Showing 72 changed files with 3,089 additions and 1,824 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -18,6 +18,7 @@
     "allowImportExportEverywhere": true
   },
   "rules": {
+    "react/require-default-props": "off",
     "react/jsx-filename-extension": [
       "warn",
       {

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -4,7 +4,7 @@ jobs:
   templates-build:
     name: Templates build
     runs-on: ubuntu-latest
-    container: node:14
+    container: node:20
     steps:
       - uses: actions/checkout@v2
       - name: Cache node modules
@@ -27,7 +27,7 @@ jobs:
   templates-coding-standards:
     name: Templates coding standards
     runs-on: ubuntu-latest
-    container: node:14
+    container: node:20
     steps:
       - uses: actions/checkout@v2
 
@@ -63,17 +63,17 @@ jobs:
         run: docker network create frontend
 
       - name: Install client
-        run: docker-compose run node yarn
+        run: docker compose run node yarn
 
       - name: Cypress run components
-        run: docker-compose run cypress run --component --browser ${{ matrix.browser }}
+        run: docker compose run cypress run --component --browser ${{ matrix.browser }}
 
       - name: Cypress run e2e
-        run: docker-compose run cypress run --browser ${{ matrix.browser }}
+        run: docker compose run cypress run --browser ${{ matrix.browser }}
 
       - name: Archive screenshots
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: cypress-screenhosts-${{ matrix.browser }}
           path: cypress/screenshots

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [2.1.0] - 2024-10-23
+
+- [#158](https://github.com/os2display/display-templates/pull/158)
+  - Expanded documentation for new templates.
+- [#157](https://github.com/os2display/display-templates/pull/157)
+  - Add Vimeo player template.
+- [#156](https://github.com/os2display/display-templates/pull/156)
+  - Clarified template creation.
+- [#155](https://github.com/os2display/display-templates/pull/155)
+  - Added single-booking layout to calendar template.
+  - Removed defaultProps.
 
 ## [2.0.1] - 2024-08-14
 
@@ -20,11 +30,11 @@ All notable changes to this project will be documented in this file.
 - [#148](https://github.com/os2display/display-templates/pull/148)
   - Changed theme load following API change.
   - Fixed path issue in #141.
-- [#141](https://github.com/os2display/display-templates/pull/141)
-  - Improve build for local development
 - [#146](https://github.com/os2display/display-templates/pull/146)
   - Fixed issue where image-text image cycle is not restarting when only on slide is displayed.
   - Fixed issue with slideshow default duration being 5000 s.
+- [#141](https://github.com/os2display/display-templates/pull/141)
+  - Improved build for local development
 
 ## [1.3.1] - 2023-10-26
 

diff --git a/README.md b/README.md
@@ -22,17 +22,17 @@ The docker setup serves the files in the `build/` (see build for production) fol
 ## Add a new template
 
 To add a template:
+
 * Create a folder in src with the name of the template, e.g. `my-template` that contains the following files:
   * `my-template.js` - The React component to render.
-  * `my-template.json` - The file describing the where to find the files required for the template.
-  * `my-template-dev.json` - The file describing the where to find the files required for the template in a dev context.
+  * `my-template.config.json` - The file describing the where to find the files required for the template.
   * `my-template-admin.json` - The file describing the content interface for populating the template.
-  * `my-template-content-example.json` - An example content.
-  * `my-template-schema.json` - Json Schema description of the content for the slide.
 
-Also add one or more entries to `src/slides.js` with examples of the data required for the template.
+Add one or more entries to `src/slides.js` with examples of the data required for the template. 
+
+Also import the template in `src/index.js` and add the template to `const renderSlide = {}` in `src/index.js`.
 
-To compile the template it is necessary to add it to the webpack setup.
+To compile the template it is necessary to add it to the webpack setup. This is done in `webpack.config.js`.
 
 Add it to `const entry = {}`:
 
@@ -42,6 +42,9 @@ Add it to `const entry = {}`:
 }
 ```
 
+Running the build script will build all templates and set new timestamps in the config json files.
+Only add the files relating to the new template to git.
+
 ## Build for production.
 
 To build the templates for production

diff --git a/build/book-review-config-develop.json b/build/book-review-config-develop.json
@@ -4,9 +4,9 @@
   "id": "01FP2SME0ENTXWF362XHM6Z1B4",
   "description": "Skabelon til anmeldelser.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/book-review.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/book-review-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/book-review-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/book-review.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/book-review-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/book-review-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/book-review-config-main.json b/build/book-review-config-main.json
@@ -4,9 +4,9 @@
   "id": "01FP2SME0ENTXWF362XHM6Z1B4",
   "description": "Skabelon til anmeldelser.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/book-review.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/book-review-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/book-review-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/book-review.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/book-review-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/book-review-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/book-review.js b/build/book-review.js
diff --git a/build/calendar-admin.json b/build/calendar-admin.json
@@ -44,6 +44,7 @@
     "name": "layout",
     "label": "Vælg layout",
     "required": true,
+    "helpText": "Hvis du vælge \"Enkelt lokale med booking\" virker bookingdelen IKKE i preview.",
     "formGroupClasses": "col-md-6 mb-3",
     "options": [
       {
@@ -60,6 +61,11 @@
         "key": "layout3",
         "title": "Flere resurser, flere dage",
         "value": "multipleDays"
+      },
+      {
+        "key": "layout4",
+        "title": "Enkelt lokale med booking",
+        "value": "singleBooking"
       }
     ]
   },

diff --git a/build/calendar-config-develop.json b/build/calendar-config-develop.json
@@ -4,9 +4,9 @@
   "id": "01FRJPF4XATRN8PBZ35XN84PS6",
   "description": "Mulighed for at vise et kalenderfeed.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/calendar.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/calendar-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/calendar-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/calendar.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/calendar-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/calendar-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/calendar-config-main.json b/build/calendar-config-main.json
@@ -4,9 +4,9 @@
   "id": "01FRJPF4XATRN8PBZ35XN84PS6",
   "description": "Mulighed for at vise et kalenderfeed.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/calendar.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/calendar-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/calendar-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/calendar.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/calendar-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/calendar-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/calendar.js b/build/calendar.js
diff --git a/build/contacts-config-develop.json b/build/contacts-config-develop.json
@@ -4,8 +4,8 @@
   "id": "01FPZ19YEHX7MQ5Q6ZS0WK0VEA",
   "description": "Skabelon til kontakter.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/contacts.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/contacts-admin.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/contacts.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/contacts-admin.json?ts=1723805672543",
     "schema": "",
     "assets": [],
     "options": {},

diff --git a/build/contacts-config-main.json b/build/contacts-config-main.json
@@ -4,8 +4,8 @@
   "id": "01FPZ19YEHX7MQ5Q6ZS0WK0VEA",
   "description": "Skabelon til kontakter.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/contacts.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/contacts-admin.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/contacts.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/contacts-admin.json?ts=1723805672543",
     "schema": "",
     "assets": [],
     "options": {},

diff --git a/build/contacts.js b/build/contacts.js
diff --git a/build/iframe-config-develop.json b/build/iframe-config-develop.json
@@ -4,8 +4,8 @@
   "id": "01FQBJQ2M3544ZKAADPWBXHY71",
   "description": "Skabelon til iFrame.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/iframe.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/iframe-admin.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/iframe.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/iframe-admin.json?ts=1723805672543",
     "schema": "",
     "assets": [],
     "options": {},

diff --git a/build/iframe-config-main.json b/build/iframe-config-main.json
@@ -4,8 +4,8 @@
   "id": "01FQBJQ2M3544ZKAADPWBXHY71",
   "description": "Skabelon til iFrame.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/iframe.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/iframe-admin.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/iframe.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/iframe-admin.json?ts=1723805672543",
     "schema": "",
     "assets": [],
     "options": {},

diff --git a/build/iframe.js b/build/iframe.js
diff --git a/build/image-text-config-develop.json b/build/image-text-config-develop.json
@@ -4,9 +4,9 @@
   "id": "01FP2SNGFN0BZQH03KCBXHKYHG",
   "description": "Mulighed for at sætte billede og tekst, med forskellige visninger.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/image-text.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/image-text-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/image-text-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/image-text.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/image-text-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/image-text-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/image-text-config-main.json b/build/image-text-config-main.json
@@ -4,9 +4,9 @@
   "id": "01FP2SNGFN0BZQH03KCBXHKYHG",
   "description": "Mulighed for at sætte billede og tekst, med forskellige visninger.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/image-text.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/image-text-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/image-text-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/image-text.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/image-text-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/image-text-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/image-text.js b/build/image-text.js
diff --git a/build/instagram-feed-config-develop.json b/build/instagram-feed-config-develop.json
@@ -4,9 +4,9 @@
   "id": "01FTZC0RKJYHG4JVZG5K709G46",
   "description": "Mulighed for at vise instagram indhold.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/instagram-feed.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/instagram-feed-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/instagram-feed-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/instagram-feed.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/instagram-feed-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/instagram-feed-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/instagram-feed-config-main.json b/build/instagram-feed-config-main.json
@@ -4,9 +4,9 @@
   "id": "01FTZC0RKJYHG4JVZG5K709G46",
   "description": "Mulighed for at vise instagram indhold.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/instagram-feed.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/instagram-feed-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/instagram-feed-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/instagram-feed.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/instagram-feed-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/instagram-feed-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/instagram-feed.js b/build/instagram-feed.js
diff --git a/build/poster-config-develop.json b/build/poster-config-develop.json
@@ -4,9 +4,9 @@
   "id": "01FWJZQ25A1868V63CWYYHQFKQ",
   "description": "Mulighed for at vise plakat indhold.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/poster.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/poster-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/poster-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/poster.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/poster-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/poster-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/poster-config-main.json b/build/poster-config-main.json
@@ -4,9 +4,9 @@
   "id": "01FWJZQ25A1868V63CWYYHQFKQ",
   "description": "Mulighed for at vise plakat indhold.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/poster.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/poster-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/poster-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/poster.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/poster-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/poster-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/poster.js b/build/poster.js
diff --git a/build/rss-config-develop.json b/build/rss-config-develop.json
@@ -4,9 +4,9 @@
   "id": "01FQC300GGWCA7A8H0SXY6P9FG",
   "description": "Mulighed for at vise et rss feed.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/rss.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/rss-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/rss-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/rss.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/rss-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/develop/build/rss-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/rss-config-main.json b/build/rss-config-main.json
@@ -4,9 +4,9 @@
   "id": "01FQC300GGWCA7A8H0SXY6P9FG",
   "description": "Mulighed for at vise et rss feed.",
   "resources": {
-    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/rss.js?ts=1705317070424",
-    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/rss-admin.json?ts=1705317070424",
-    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/rss-schema.json?ts=1705317070424",
+    "component": "https://raw.githubusercontent.com/os2display/display-templates/main/build/rss.js?ts=1723805672543",
+    "admin": "https://raw.githubusercontent.com/os2display/display-templates/main/build/rss-admin.json?ts=1723805672543",
+    "schema": "https://raw.githubusercontent.com/os2display/display-templates/main/build/rss-schema.json?ts=1723805672543",
     "assets": [],
     "options": {},
     "content": {}

diff --git a/build/rss.js b/build/rss.js