Ability to specify a menu logo (top left corner) via a config setting (…

…#184) * add ability to specify a menu logo (top left corner) via a config setting * add PR number
FlexMeasures · Sep 16, 2021 · 19896bd · 19896bd
1 parent f7c7fba
commit 19896bd
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 2 deletions.
diff --git a/documentation/changelog.rst b/documentation/changelog.rst
@@ -9,6 +9,8 @@ v0.7.0 | October XX, 2021
 
 New features
 -----------
+* Set a logo for the top left corner with the new FLEXMEASURES_MENU_LOGO_PATH setting [see `PR #184 <http://www.github.com/SeitaBV/flexmeasures/pull/184>`_]
+
 
 Bugfixes
 -----------

diff --git a/documentation/configuration.rst b/documentation/configuration.rst
@@ -106,6 +106,15 @@ For example, ``("MyMDCApp", ["MDC"]), "MyApp"]`` would show the name "MyMDCApp"
 Default: ``"FlexMeasures"``
 
 
+FLEXMEASURES_MENU_LOGO_PATH
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A URL path to identify an image being used as logo in the upper left corner (replacing some generic text made from platform name and the page title).
+The path can be a complete URL or a relative from the app root. 
+
+Default: ""
+
+
 FLEXMEASURES_ROOT_VIEW
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/flexmeasures/ui/static/css/flexmeasures.css b/flexmeasures/ui/static/css/flexmeasures.css
@@ -2,6 +2,11 @@ body {
     padding-top: 100px;  /* This default is overridden by flexmeasures.js to support a fluid navbar */
 }
 
+#menu-logo {
+    height: 50px;
+    position: fixed; top: 0; left: 0;
+}
+
 #alerts {
     position: absolute;
     right: 10px;

diff --git a/flexmeasures/ui/templates/base.html b/flexmeasures/ui/templates/base.html
@@ -63,7 +63,15 @@
                     <span class="icon-bar"></span>
                 </button>
                 <span class="navbar-brand">
-                    <a href="/"><span class="navbar-tool-name">{{ FLEXMEASURES_PLATFORM_NAME }} {% if not "Error" in self.title() %} - {{ self.title() }} {% endif %}</span></a>
+                    <a href="/">
+                        <span class="navbar-tool-name">
+                        {% if menu_logo %}
+                            <img id="menu-logo" src="{{menu_logo}}"/>
+                        {% else %}
+                            {{ FLEXMEASURES_PLATFORM_NAME }} {% if not "Error" in self.title() %} - {{ self.title() }} {% endif %}
+                        {% endif %}
+                        </span>
+                    </a>
                 </span>
             </div>
             <div class="collapse navbar-collapse  navbar-right" id="bs-example-navbar-collapse-1">

diff --git a/flexmeasures/ui/utils/view_utils.py b/flexmeasures/ui/utils/view_utils.py
@@ -89,6 +89,8 @@ def render_flexmeasures_template(html_filename: str, **variables):
     )
     variables["js_versions"] = current_app.config.get("FLEXMEASURES_JS_VERSIONS")
 
+    variables["menu_logo"] = current_app.config.get("FLEXMEASURES_MENU_LOGO_PATH")
+
     return render_template(html_filename, **variables)
 
 

diff --git a/setup.py b/setup.py
@@ -16,7 +16,7 @@ def load_requirements(use_case):
 
 setup(
     name="flexmeasures",
-    description="FlexMeasures - A free platform for real-time optimization of flexible energy.",
+    description="FlexMeasures - A free platform to build services for real-time optimization of flexible energy.",
     author="Seita BV",
     author_email="nicolas@seita.nl",
     url="https://github.com/seitabv/flexmeasures",