🔀 Merge pull request gchq#382 from Lissy93/FEATURE/basic-widget-support

[FEATURE] Widget Support
BRAVO68WEB · Dec 29, 2021 · 1f5d3f4 · 1f5d3f4
2 parents 8791ed9 + 04a91cf
commit 1f5d3f4
Show file tree

Hide file tree

Showing 81 changed files with 10,000 additions and 2,424 deletions.
diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## ✨ 1.9.4 - Widget Support [PR #382](https://github.com/Lissy93/dashy/pull/382)
+- Adds support for dynamic content, through widgets
+- Adds 30+ pre-built widgets for general info and self-hosted services
+- Writes docs on widget usage
+
 ## ⚡️ 1.9.2 - Native SSL Support + Performance Improvements [PR #326](https://github.com/Lissy93/dashy/pull/326)
 - Updates the server to use Express, removing serve-static, connect and body-parser
 - Adds native support for passing in self-signed SSL certificates and updates docs

diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -1,62 +1,64 @@
-name: Question 🤷‍♂️
-description: Got a question about Dashy, deployment, development or usage?
-title: '[QUESTION] <title>'
-labels: ['🤷‍♂️ Question']
-
-body:
-  # Filed 1 - Intro Text
-  - type: markdown
-    attributes:
-      value: >
-        Thanks for using Dashy! Questions are welcome, but in the future will be moving over to
-        [Discussions](https://github.com/Lissy93/dashy/discussions) page.
-        Quick questions should be asked [here](https://github.com/Lissy93/dashy/discussions/148) instead.
-    validations:
-      required: false
-
-  # Field 2 - The actual question
-  - type: textarea
-    id: question
-    attributes:
-      label: Question
-      description: Outline your question in a clear and concise manner
-    validations:
-      required: true
-
-  # Field 3 - Category
-  - type: dropdown
-    id: category
-    attributes:
-      label: Category
-      description: What part of the application does this relate to?
-      options:
-        - Setup and Deployment
-        - Configuration
-        - App Usage
-        - Development
-        - Documentation
-        - Alternate Views
-        - Authentication
-        - Using Icons
-        - Language Support
-        - Search & Shortcuts
-        - Status Checking
-        - Theming & Layout
-    validations:
-      required: true
-
-  # Field 4 - User has RTFM first, and agrees to code of conduct, etc
-  - type: checkboxes
-    id: idiot-check
-    attributes:
-      label: Please tick the boxes
-      description: Before submitting, please ensure that
-      options:
-        - label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
-          required: true
-        - label: You've checked that this [question hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
-          required: true
-        - label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
-          required: true
-        - label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
-          required: true
+name: Question 🤷‍♂️
+description: Got a question about Dashy, deployment, development or usage?
+title: '[QUESTION] <title>'
+labels: ['🤷‍♂️ Question']
+
+body:
+  # Filed 1 - Intro Text
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for using Dashy! Questions are welcome, but in the future will be moving over to
+        [Discussions](https://github.com/Lissy93/dashy/discussions) page.
+        Quick questions should be asked [here](https://github.com/Lissy93/dashy/discussions/148) instead.
+    validations:
+      required: false
+
+  # Field 2 - The actual question
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Outline your question in a clear and concise manner
+    validations:
+      required: true
+
+  # Field 3 - Category
+  - type: dropdown
+    id: category
+    attributes:
+      label: Category
+      description: What part of the application does this relate to?
+      options:
+        - Setup and Deployment
+        - Configuration
+        - App Usage
+        - Development
+        - Documentation
+        - Alternate Views
+        - Authentication
+        - Using Icons
+        - Widgets
+        - Actions
+        - Language Support
+        - Search & Shortcuts
+        - Status Checking
+        - Theming & Layout
+    validations:
+      required: true
+
+  # Field 4 - User has RTFM first, and agrees to code of conduct, etc
+  - type: checkboxes
+    id: idiot-check
+    attributes:
+      label: Please tick the boxes
+      description: Before submitting, please ensure that
+      options:
+        - label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
+          required: true
+        - label: You've checked that this [question hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
+          required: true
+        - label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
+          required: true
+        - label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
+          required: true
diff --git a/README.md b/README.md
@@ -40,6 +40,7 @@
   - [🎨 Theming](#theming-)
   - [🧸 Icons](#icons-)
   - [🚦 Status Indicators](#status-indicators-)
+  - [📊 Widgets](#widgets-)
   - [💂 Authentication](#authentication-)
   - [🖱️ Opening Methods](#opening-methods-%EF%B8%8F)
   - [👓 Alternate Views](#alternate-views-)
@@ -70,6 +71,7 @@
 - 🎨 Multiple built-in color themes, with UI color editor and support for custom CSS
 - 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.
 - 🚦 Status monitoring for each of your apps/links for basic availability and uptime checking
+- 📊 Use widgets to display info and dynamic content from self-hosted services
 - 💂 Optional authentication with multi-user access, configurable privileges, and SSO support
 - 🌎 Multi-language support, with 10+ human-translated languages, and more on the way
 - ☁ Optional, encrypted, free off-site cloud backup and restore feature available
@@ -235,6 +237,22 @@ Status indicators can be globally enabled by setting `appConfig.statusCheck: tru
   <img alt="Status Checks demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/status-check-demo.gif" width="600" />
 </p>
 
+**[⬆️ Back to Top](#dashy)**
+
+---
+
+## Widgets 📊
+
+> For full widget documentation, see: [**Widgets**](./docs/widgets.md)
+
+You can display dynamic content from services in the form of widgets. There are several pre-built widgets availible for showing useful info, and integrations with commonly self-hosted services, but you can also easily create your own for almost any app.
+
+
+<p align="center">
+  <img width="600" src="https://i.ibb.co/GFjXVHy/dashy-widgets.png" />
+</p>
+
+
 **[⬆️ Back to Top](#dashy)**
 
 ---