Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ“ How to register a widget.

Chris Nielsen1e2854df9368
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
-
-```javascript
-import ExampleWidget from '@/components/Widgets/ExampleWidget.vue';
-```
-
-Then register the component
+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
-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