NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 01:41:22 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Improved docs for how to register dashboard widgets (#14913)

Browse Source
This commit is contained in:
Mattias L 2024-01-26 20:15:28 +01:00 committed by GitHub
parent b9cac97b73
commit ba755221bb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/plugins/development/dashboard-widgets.md
View File

@ -47,3 +47,14 @@ class ReminderWidget(DashboardWidget):
def render(self, request): def render(self, request):
return self.config.get('content') 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
```