From e9e0738d5d35b3a1efc7583db74c0295401e1beb Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Feb 2023 15:55:56 -0500 Subject: [PATCH] Add color customization to dashboard widgets --- netbox/extras/dashboard/forms.py | 7 ++++- netbox/extras/dashboard/widgets.py | 27 +++++++------------ netbox/extras/views.py | 2 ++ netbox/templates/extras/dashboard/widget.html | 2 +- .../extras/dashboard/widget_add.html | 10 ++++++- 5 files changed, 28 insertions(+), 20 deletions(-) diff --git a/netbox/extras/dashboard/forms.py b/netbox/extras/dashboard/forms.py index 9c09e6e7b..bb962b464 100644 --- a/netbox/extras/dashboard/forms.py +++ b/netbox/extras/dashboard/forms.py @@ -2,7 +2,8 @@ from django import forms from django.urls import reverse_lazy from netbox.registry import registry -from utilities.forms import BootstrapMixin +from utilities.forms import BootstrapMixin, add_blank_choice +from utilities.choices import ButtonColorChoices __all__ = ( 'DashboardWidgetAddForm', @@ -18,6 +19,10 @@ class DashboardWidgetForm(BootstrapMixin, forms.Form): title = forms.CharField( required=False ) + color = forms.ChoiceField( + choices=add_blank_choice(ButtonColorChoices), + required=False, + ) class DashboardWidgetAddForm(DashboardWidgetForm): diff --git a/netbox/extras/dashboard/widgets.py b/netbox/extras/dashboard/widgets.py index 8987f4d06..a3d617e92 100644 --- a/netbox/extras/dashboard/widgets.py +++ b/netbox/extras/dashboard/widgets.py @@ -3,7 +3,6 @@ import uuid from django import forms from django.contrib.contenttypes.models import ContentType from django.template.loader import render_to_string -from django.utils.safestring import mark_safe from django.utils.translation import gettext as _ from utilities.forms import BootstrapMixin @@ -27,7 +26,7 @@ def get_content_type_labels(): class DashboardWidget: - title = None + default_title = None description = None width = 4 height = 3 @@ -35,11 +34,11 @@ class DashboardWidget: class ConfigForm(forms.Form): pass - def __init__(self, id=None, title=None, config=None, width=None, height=None, x=None, y=None): + def __init__(self, id=None, title=None, color=None, config=None, width=None, height=None, x=None, y=None): self.id = id or uuid.uuid4() self.config = config or {} - if title: - self.title = title + self.title = title or self.default_title + self.color = color if width: self.width = width if height: @@ -56,7 +55,7 @@ class DashboardWidget: self.y = grid_item.get('y') def render(self, request): - raise NotImplementedError("DashboardWidget subclasses must define a render() method.") + raise NotImplementedError(f"{self.__class__} must define a render() method.") @property def name(self): @@ -66,11 +65,6 @@ class DashboardWidget: @register_widget class NoteWidget(DashboardWidget): description = _('Display some arbitrary custom content. Markdown is supported.') - default_content = """ -
-
Empty
-
- """ class ConfigForm(BootstrapMixin, forms.Form): content = forms.CharField( @@ -78,14 +72,12 @@ class NoteWidget(DashboardWidget): ) def render(self, request): - if content := self.config.get('content'): - return render_markdown(content) - return mark_safe(self.default_content) + return render_markdown(self.config.get('content')) @register_widget class ObjectCountsWidget(DashboardWidget): - title = _('Objects') + default_title = _('Objects') description = _('Display a set of NetBox models and the number of objects created for each type.') template_name = 'extras/dashboard/widgets/objectcounts.html' @@ -109,10 +101,11 @@ class ObjectCountsWidget(DashboardWidget): @register_widget class ChangeLogWidget(DashboardWidget): - title = _('Change Log') + default_title = _('Change Log') + description = _('Display the most recent records from the global change log.') + template_name = 'extras/dashboard/widgets/changelog.html' width = 12 height = 4 - template_name = 'extras/dashboard/widgets/changelog.html' def render(self, request): return render_to_string(self.template_name, {}) diff --git a/netbox/extras/views.py b/netbox/extras/views.py index d303c7050..181b26b32 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -689,6 +689,7 @@ class DashboardWidgetAddView(LoginRequiredMixin, View): return redirect('home') return render(request, self.template_name, { + 'widget_class': widget_class, 'widget_form': widget_form, 'config_form': config_form, }) @@ -719,6 +720,7 @@ class DashboardWidgetAddView(LoginRequiredMixin, View): return response return render(request, self.template_name, { + 'widget_class': widget_class, 'widget_form': widget_form, 'config_form': config_form, }) diff --git a/netbox/templates/extras/dashboard/widget.html b/netbox/templates/extras/dashboard/widget.html index bf0004acd..4ed84f067 100644 --- a/netbox/templates/extras/dashboard/widget.html +++ b/netbox/templates/extras/dashboard/widget.html @@ -9,7 +9,7 @@ gs-id="{{ widget.id }}" >
-
+
{% block form %} - {% render_form widget_form %} + {% render_field widget_form.widget_class %} +
+ +
+
{{ widget_class.description|placeholder }}
+
+
+ {% render_field widget_form.color %} + {% render_field widget_form.title %} {% render_form config_form %} {% endblock form %}