Improved docs for how to register dashboard widgets

This commit is contained in:
Mattias Loverot 2024-01-24 09:13:55 +01:00
parent fea8efa149
commit 8c9c9c5dac

View File

@ -47,3 +47,14 @@ class ReminderWidget(DashboardWidget):
def render(self, request):
return self.config.get('content')
```
## Initialization
To register the widget, it becomes essential to import the widget module. The recommended approach is to accomplish this within the `ready` method situated in your `PluginConfig`:
```python
class FooBarConfig(PluginConfig):
def ready(self):
super().ready()
from . import widgets # point this to the above widget module you created
```