feat(ui): Add option to define custom css and js

kiblik · kiblik · commit 1172bac8863d · 2025-01-16T22:51:38.000+01:00
diff --git a/dojo/context_processors.py b/dojo/context_processors.py
@@ -26,6 +26,8 @@ def globalize_vars(request):
         "DOCUMENTATION_URL": settings.DOCUMENTATION_URL,
         "API_TOKENS_ENABLED": settings.API_TOKENS_ENABLED,
         "API_TOKEN_AUTH_ENDPOINT_ENABLED": settings.API_TOKEN_AUTH_ENDPOINT_ENABLED,
+        "CUSTOM_CSS": settings.CUSTOM_CSS,
+        "CUSTOM_JS": settings.CUSTOM_JS,
     }
 
 
diff --git a/dojo/settings/settings.dist.py b/dojo/settings/settings.dist.py
@@ -304,6 +304,9 @@
     # For HTTP requests, how long connection is open before timeout
     # This settings apply only on requests performed by "requests" lib used in Dojo code (if some included lib is using "requests" as well, this does not apply there)
     DD_REQUESTS_TIMEOUT=(int, 30),
+    # Add custom styles and/or scripts to UI. All files need to be stored in "static" dir and path need to relative to this dir
+    DD_CUSTOM_CSS=(list, []),
+    DD_CUSTOM_JS=(list, []),
 )
 
 
@@ -820,6 +823,14 @@ def generate_url(scheme, double_slashes, user, password, host, port, path, param
     },
 ]
 
+# ------------------------------------------------------------------------------
+# UI
+# ------------------------------------------------------------------------------
+
+# Add custom styles and/or scripts to UI
+CUSTOM_CSS = env("DD_CUSTOM_CSS")
+CUSTOM_JS = env("DD_CUSTOM_JS")
+
 # ------------------------------------------------------------------------------
 # APPS
 # ------------------------------------------------------------------------------
diff --git a/dojo/templates/base.html b/dojo/templates/base.html
@@ -61,6 +61,13 @@
 
         <script src="{% static "jszip/dist/jszip.min.js" %}"></script>
 
+        {% if CUSTOM_JS %}
+        <!-- Custom JS -->
+            {% for one_js in CUSTOM_JS %}
+                <script src="{% static one_js %}"></script>
+            {% endfor %}
+         {% endif %}
+
         <!-- Bootstrap Core CSS -->
         <link href="{% static "bootstrap/dist/css/bootstrap.min.css" %}" rel="stylesheet">
 
@@ -96,6 +103,14 @@
             {% block add_styles %}
             {% endblock %}
         </style>
+
+        {% if CUSTOM_CSS %}
+        <!-- Custom CSS -->
+            {% for one_css in CUSTOM_CSS %}
+                <link rel="stylesheet" href="{% static one_css %}">
+            {% endfor %}
+        {% endif %}
+
     </head>
     <body class="{% dojo_body_class %}">
         <div id="wrapper">

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ def globalize_vars(request):`
`26`	`26`	`"DOCUMENTATION_URL": settings.DOCUMENTATION_URL,`
`27`	`27`	`"API_TOKENS_ENABLED": settings.API_TOKENS_ENABLED,`
`28`	`28`	`"API_TOKEN_AUTH_ENDPOINT_ENABLED": settings.API_TOKEN_AUTH_ENDPOINT_ENABLED,`
	`29`	`+ "CUSTOM_CSS": settings.CUSTOM_CSS,`
	`30`	`+ "CUSTOM_JS": settings.CUSTOM_JS,`
`29`	`31`	`}`
`30`	`32`
`31`	`33`