mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Closes #12136: Extend object count & list widgets to support filters

Browse Source
This commit is contained in:
jeremystretch
2023-04-03 15:02:11 -04:00
parent 0676ed45c7
commit 53abcc0f5c
2 changed files with 68 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -9,7 +9,7 @@ Each NetBox user can customize his or her personal dashboard by adding and remov
All dashboard widgets must inherit from NetBox's `DashboardWidget` base class. Subclasses must provide a `render()` method, and may override the base class' default characteristics.
Widgets which require configuration by a user must also include a `ConfigForm` child class. This form is used to render the user configuration options for the widget.
Widgets which require configuration by a user must also include a `ConfigForm` child class which inherits from `WidgetConfigForm`. This form is used to render the user configuration options for the widget.
::: extras.dashboard.widgets.DashboardWidget
@@ -34,7 +34,7 @@ class MyWidget2(DashboardWidget):
```python
from django import forms
from extras.dashboard.utils import register_widget
from extras.dashboard.widgets import DashboardWidget
from extras.dashboard.widgets import DashboardWidget, WidgetConfigForm
@register_widget
@@ -42,7 +42,7 @@ class ReminderWidget(DashboardWidget):
default_title = 'Reminder'
description = 'Add a virtual sticky note'
class ConfigForm(forms.Form):
class ConfigForm(WidgetConfigForm):
content = forms.CharField(
widget=forms.Textarea()
)