From 1e2854df9368d49b9e15d77e2b3c565babcea614 Mon Sep 17 00:00:00 2001
From: Chris Nielsen <nielsen.chris@gmail.com>
Date: Thu, 8 Jun 2023 15:49:36 +0000
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20How=20to=20register=20a=20widget?=
 =?UTF-8?q?.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/development-guides.md | 28 +++++-----------------------
 1 file changed, 5 insertions(+), 23 deletions(-)

diff --git a/docs/development-guides.md b/docs/development-guides.md
index 3c5595ae..0d629412 100644
--- a/docs/development-guides.md
+++ b/docs/development-guides.md
@@ -426,34 +426,16 @@ For examples of finished widget components, see the [Widgets](https://github.com
 
 ### Step 3 - Register
 
-Next, import and register your new widget, in [`WidgetBase.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/WidgetBase.vue). In this file, you'll need to add the following:
-
-Import your widget file
+Next, register your new widget in [`WidgetBase.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/WidgetBase.vue). In this file, you'll need to add the following:
 
 ```javascript
-import ExampleWidget from '@/components/Widgets/ExampleWidget.vue';
-```
-
-Then register the component
-
-```javascript
-components: {
+const COMPAT = {
   ...
-  ExampleWidget,
-},
+  'example-widget': 'ExampleWidget',
+};
 ```
 
-Finally, add the markup to render it. The only attribute you need to change here is, setting `widgetType === 'example'` to your widget's name.
-
-```vue
-<ExampleWidget
-  v-else-if="widgetType === 'example'"
-  :options="widgetOptions"
-  @loading="setLoaderState"
-  @error="handleError"
-  :ref="widgetRef"
-/>
-```
+Here, the `example-widget` property name will be used to identify the widget when parsing the `type` property in a configuration file. The `ExampleWidget` string is used to dynamically import the widget, and therefore must match the widget's filename as it exists in the `components/widgets` folder.
 
 ### Step 4 - Docs