gov-uk-dashboards 26.8.0__py3-none-any.whl → 26.26.0__py3-none-any.whl

gov_uk_dashboards/components/dash/data_quality_banner.py

@@ -0,0 +1,91 @@
+"""data_quality_banner"""
+
+from enum import Enum
+from dataclasses import dataclass
+from dash import html
+from gov_uk_dashboards.components.dash.notification_banner import notification_banner
+from gov_uk_dashboards.formatting.text_functions import create_id_from_string
+from gov_uk_dashboards.constants import (
+    NOTIFICATION_STYLE_GREEN,
+    NOTIFICATION_STYLE_ORANGE,
+    NOTIFICATION_STYLE_RED,
+    NOTIFICATION_STYLE_YELLOW,
+)
+
+
+@dataclass
+class DataQualityConfig:
+    """
+    Configuration class for defining the display and linking details of a data quality metric.
+
+    Attributes:
+        title (str): The title of the data quality metric.
+        text (str): Descriptive text or explanation of the metric.
+        style (str): The visual style or format for displaying the metric.
+        title_color (str, optional): Optional color to use for the title. Defaults to None.
+        glossary_url (str, optional): Optional URL linking to a glossary entry for this metric.
+            If not provided, a URL is automatically generated based on the title.
+
+    Methods:
+        __post_init__(): Automatically generates a glossary URL if none is provided.
+    """
+
+    title: str
+    text: str
+    style: str
+    title_color: str = None
+    glossary_url: str = None
+
+    def __post_init__(self):
+        if not self.glossary_url:
+            slug = create_id_from_string(self.title)
+            self.glossary_url = f"/glossary#data-quality-{slug}"
+
+
+class DataQualityLabels(Enum):
+    """Enumeration of standard labels used to categorize or describe data quality."""
+
+    OFFICIAL = DataQualityConfig(
+        title="OFFICIAL public data",
+        text="Use with confidence.",
+        style=NOTIFICATION_STYLE_GREEN,
+    )
+    MI = DataQualityConfig(
+        title="Management information",
+        text="Use for early insights, but with caution.",
+        style=NOTIFICATION_STYLE_YELLOW,
+        title_color="black",
+    )
+    EXPERIMENTAL_MI = DataQualityConfig(
+        title="Experimental management information",
+        text="Indicative only, requires expert guidance on use.",
+        style=NOTIFICATION_STYLE_ORANGE,
+        title_color="black",
+    )
+    OPERATIONAL = DataQualityConfig(
+        title="Operational data",
+        text="Never use in isolation, always verify independently.",
+        style=NOTIFICATION_STYLE_RED,
+    )
+
+
+def data_quality_notification_banner(label: DataQualityLabels):
+    """Return data quality notification banner based on Gov UK Design component notification
+    banner component."""
+    config = label.value
+    text = [
+        f"{config.text} Read more in our ",
+        html.A(
+            "glossary",
+            href=config.glossary_url,
+            target="_blank",
+            rel="noopener noreferrer",
+        ),
+        ".",
+    ]
+    return notification_banner(
+        title=config.title,
+        text=text,
+        style=config.style,
+        title_color=config.title_color,
+    )

gov_uk_dashboards/components/dash/download_button.py

@@ -1,41 +1,11 @@
 """download_button"""
 
 from typing import Union
-import warnings
 from dash import html
 
 from gov_uk_dashboards.constants import DOWNLOAD_BUTTON_CLASSES
 
 
-def download_button(button_text: str, button_id: str = "download-button"):
-    """
-    Return a download button which is aligned to the right
-
-    Args:
-    button_text (str): The text to display on the button.
-    button_id: (str, Optional) = id for dropdown, default to "download-button"
-    """
-    warnings.warn(
-        "Note there is an alternative function to download_button() called "
-        "create_download_button_with_icon() which includes a download icon and improved styling.",
-        Warning,
-        stacklevel=2,
-    )
-
-    return html.Div(
-        [
-            html.Button(
-                button_text,
-                id=button_id,
-                n_clicks=0,
-                className="govuk-button govuk-button--secondary",
-            ),
-        ],
-        className="govuk-button-group",
-        style={"float": "right"},
-    )
-
-
 def create_download_button_with_icon(
     button_text: str,
     button_id_name: str,

gov_uk_dashboards/components/dash/footer.py

@@ -4,7 +4,7 @@ from typing import Optional
 from dash import html
 
 
-def footer(footer_links: Optional[list[any]]):
+def footer(footer_links: Optional[list[any]], include_logos: bool = False):
     """
     HTML component for a Gov.UK standard footer.
 
@@ -30,37 +30,80 @@ def footer(footer_links: Optional[list[any]]):
                                 if footer_links
                                 else None
                             ),
-                            (
-                                html.Ul(
-                                    children=[
-                                        html.Li(
-                                            item,
-                                            className="govuk-footer__inline-list-item",
+                            html.Div(
+                                [
+                                    (
+                                        html.Ul(
+                                            children=[
+                                                html.Li(
+                                                    item,
+                                                    className="govuk-footer__inline-list-item",
+                                                )
+                                                for item in footer_links
+                                            ],
+                                            className=(
+                                                "govuk-footer__inline-list "
+                                                "govuk-!-display-none-print"
+                                            ),
                                         )
-                                        for item in footer_links
-                                    ],
-                                    className=(
-                                        "govuk-footer__inline-list "
-                                        "govuk-!-display-none-print"
+                                        if footer_links
+                                        else None
                                     ),
-                                )
-                                if footer_links
-                                else None
-                            ),
-                            html.Span(
-                                [
-                                    "All content is available under the ",
-                                    html.A(
-                                        "Open Government Licence v3.0",
-                                        rel="license",
-                                        href="https://www.nationalarchives.gov.uk/doc/"
-                                        "open-government-licence/version/3/",
-                                        className="govuk-footer__link",
-                                        target="_blank",
+                                    html.Span(
+                                        [
+                                            "All content is available under the ",
+                                            html.A(
+                                                "Open Government Licence v3.0",
+                                                rel="license",
+                                                href="https://www.nationalarchives.gov.uk/doc/"
+                                                "open-government-licence/version/3/",
+                                                className="govuk-footer__link",
+                                                target="_blank",
+                                            ),
+                                            ", except where otherwise stated",
+                                        ],
+                                        className="govuk-footer__licence-description",
+                                    ),
+                                    (
+                                        (
+                                            html.Div(
+                                                [
+                                                    html.Img(
+                                                        src="assets\\images\\CHASE_icon.svg",
+                                                        className="header-image",
+                                                        style={"maxWidth": "100px"},
+                                                    ),
+                                                    html.Div(
+                                                        [
+                                                            html.B(
+                                                                "CHASE",
+                                                                style={
+                                                                    "font-size": "36px"
+                                                                },
+                                                            ),
+                                                        ],
+                                                        style={
+                                                            "display": "flex",
+                                                            "flex-direction": "column",
+                                                            "align-items": "left",
+                                                            "color": "#707070",
+                                                            "maxWidth": "200px",
+                                                            "padding-bottom": "10px",
+                                                        },
+                                                    ),
+                                                ],
+                                                style={
+                                                    "display": "flex",
+                                                    "flex-direction": "row",
+                                                    "align-items": "center",
+                                                    "padding-top": "30px",
+                                                },
+                                            )
+                                        )
+                                        if include_logos
+                                        else None
                                     ),
-                                    ", except where otherwise stated",
-                                ],
-                                className="govuk-footer__licence-description",
+                                ]
                             ),
                         ],
                         className="govuk-footer__meta-item govuk-footer__meta-item--grow",

gov_uk_dashboards/components/dash/green_button.py

@@ -0,0 +1,25 @@
+"""green_button"""
+
+from dash import html
+
+
+def green_button(button_text: str, button_id: str):
+    """
+    Return a green button which is aligned to the right
+
+    Args:
+    button_text (str): The text to display on the button.
+    button_id: (str) = id for button
+    """
+
+    return html.Div(
+        [
+            html.Button(
+                button_text,
+                id=button_id,
+                n_clicks=0,
+                className="govuk-button",
+            ),
+        ],
+        className="govuk-button-group",
+    )

gov_uk_dashboards/components/dash/header.py

@@ -78,3 +78,47 @@ def header(
         | {"borderColor": "#000000", "backgroundColor": "rgb(0,98,94)"},
         **{"data-module": "govuk-header"},
     )
+
+
+def logo_header():
+    """
+    Create and return the application header containing the Explore Data logo.
+
+    This component renders a GOV.UK–styled header with an SVG logo.
+    The logo is loaded from the Dash assets directory and constrained
+    to a maximum height for consistent layout.
+
+    Returns
+    -------
+    dash.html.Header
+        A Dash Header component containing the styled logo container.
+    """
+    return html.Header(
+        html.Div(
+            html.Div(
+                [
+                    html.Div(
+                        [
+                            html.Img(
+                                src="/assets/images/explore_data_logo.svg",
+                                className="header-image",
+                                style={"maxHeight": "100px"},
+                            ),
+                        ],
+                        style={
+                            "display": "flex",
+                            "flexDirection": "column",
+                            "color": "#00625e",
+                            "alignItems": "center",
+                            "paddingBottom": "2px",
+                        },
+                    ),
+                ],
+                className="govuk-header__content",
+            ),
+            style={"borderBottom": "0px solid #000000", "borderColor": "#f3f2f1"},
+            className="govuk-header__container govuk-width-container",
+        ),
+        className="govuk-header",
+        style={"backgroundColor": "#f3f2f1", "borderColor": "#f3f2f1"},
+    )

gov_uk_dashboards/components/dash/main_content.py

@@ -5,7 +5,7 @@ import re
 from dash import html
 
 
-def main_content(children, id_fragment=None):
+def main_content(children, id_fragment=None, include_feedback_banner_div: bool = False):
     """
     Wrapper for the main content of the dashboard, containing visualisations.
 
@@ -29,4 +29,11 @@ def main_content(children, id_fragment=None):
             UserWarning,
             stacklevel=2,
         )
+
+    if not isinstance(children, list):
+        children = [children]
+
+    if include_feedback_banner_div:
+        children.append(html.Div(id="feedback-banner"))
+
     return html.Main(children, className="main", id=slug, role="main")

gov_uk_dashboards/components/dash/notification_banner.py

@@ -4,7 +4,11 @@ from dash import html
 
 
 def notification_banner(
-    text: str, text_class_name: str = "govuk-warning-text__text", style: dict = None
+    text: list,
+    title: str = "Important",
+    text_class_name: str = "govuk-notification-banner__heading",
+    style: dict = None,
+    title_color: str = None,
 ):
     """
     Return Gov UK Design component notification banner component.
@@ -14,9 +18,10 @@ def notification_banner(
             html.Div(
                 [
                     html.H2(
-                        ["Important"],
+                        [title],
                         className="govuk-notification-banner__title",
                         id="govuk-notification-banner-title",
+                        style={"color": title_color} if title_color else None,
                     )
                 ],
                 className="govuk-notification-banner__header",
@@ -24,9 +29,7 @@ def notification_banner(
             html.Div(
                 [
                     html.P(
-                        [
-                            text,
-                        ],
+                        text,
                         className=text_class_name,
                     )
                 ],

gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py

@@ -42,8 +42,9 @@ class LeafletChoroplethMap:
         download_chart_button_id: Optional[str] = None,
         download_data_button_id: Optional[str] = None,
         color_scale_is_discrete: bool = True,
+        colorbar_title: str = None,
         show_tile_layer: bool = False,
-    ):
+    ):  # pylint: disable=too-many-locals
         self.geojson_data = geojson
         self.df = df
         self.hover_text_columns = hover_text_columns
@@ -56,6 +57,7 @@ class LeafletChoroplethMap:
         self.download_chart_button_id = download_chart_button_id
         self.download_data_button_id = download_data_button_id
         self.color_scale_is_discrete = color_scale_is_discrete
+        self.colorbar_title = self.resolve_colorbar_title(colorbar_title)
         self.show_tile_layer = show_tile_layer
         self._add_data_to_geojson()
         self.instance_number = instance_number
@@ -198,11 +200,28 @@ class LeafletChoroplethMap:
 
     def _get_colorscale(self):
         if self.color_scale_is_discrete:
-            discrete_colours = ["#217847", "#23BBBE", "#8CCE69", "#FFEA80"]
             if len(self.df[self.column_to_plot].unique()) == 3:
-                discrete_colours.pop(1)
-            return discrete_colours
-        return ["#B0F2BC", "#257D98"]
+                return ["#080C54", "#1F9EB7", "#CDE594"]
+            if len(self.df[self.column_to_plot].unique()) == 4:
+                return ["#080C54", "#1F9EB7", "#80C6A3", "#CDE594"]
+            if len(self.df[self.column_to_plot].unique()) == 5:
+                return [
+                    "#080C54",
+                    "#186290",
+                    "#1F9EB7",
+                    "#80C6A3",
+                    "#CDE594",
+                ]
+            if len(self.df[self.column_to_plot].unique()) == 6:
+                return [
+                    "#080C54",
+                    "#186290",
+                    "#1F9EB7",
+                    "#80C6A3",
+                    "#CDE594",
+                    "#ffffcc",
+                ]
+        return ["#80C6A3", "#186290"]
 
     def _get_color_bar_categories(self):
         return (
@@ -215,10 +234,10 @@ class LeafletChoroplethMap:
         )
 
     def _get_colorbar(self):
+        top_margin = ("100px" if self.colorbar_title else None,)
         if self.color_scale_is_discrete:
-            self._get_color_bar_categories()
             return dlx.categorical_colorbar(
-                categories=self._get_color_bar_categories(),  # reversed order
+                categories=self._get_color_bar_categories(),
                 colorscale=self._get_colorscale()[::-1],
                 width=30,
                 height=200,
@@ -228,8 +247,10 @@ class LeafletChoroplethMap:
                     "backgroundColor": "white",
                     "borderRadius": "4px",
                     "fontSize": "16px",
+                    "marginTop": top_margin,
                 },
             )
+
         min_value = self.df.select(pl.min(self.column_to_plot)).item()
         colorbar_min = min(min_value, 0)
         max_value = self.df.select(pl.max(self.column_to_plot)).item()
@@ -243,9 +264,19 @@ class LeafletChoroplethMap:
             three_quarter_value,
             max_value,
         ]
+
+        tick_text = [format_number_into_thousands_or_millions(x) for x in tick_values]
+
+        # If duplicates appear in tick_text, change rounding
+        if len(set(tick_text)) < len(tick_text):
+            tick_text = [
+                format_number_into_thousands_or_millions(x, 1) for x in tick_values
+            ]
+
         tick_text = [
-            format_number_into_thousands_or_millions(x) for x in tick_values
-        ]  # Optional, for formatting
+            str(int(val)) if val < 1000 else text
+            for text, val in zip(tick_text, tick_values)
+        ]  # values less than 1000 are ints
 
         return dl.Colorbar(
             colorscale=self._get_colorscale(),
@@ -258,27 +289,35 @@ class LeafletChoroplethMap:
                 "backgroundColor": "white",
                 "padding": "5px",
                 "borderRadius": "4px",
-                "marginTop": "100px",
+                "marginTop": top_margin,
             },
             tickValues=tick_values,
             tickText=tick_text,  # Optional, makes labels look cleaner
         )
 
     def _get_colorbar_title(self, enable_zoom: bool = False):
-        if self.color_scale_is_discrete:
-            return None
-        top = "70px" if enable_zoom is False else "140px"
-        return html.Div(
-            self.hover_text_columns[0],
-            style={
-                "position": "absolute",
-                "top": top,  # Adjusted to place above the colorbar
-                "left": "10px",  # Align with the left side of the colorbar
-                "background": "white",
-                "padding": "2px 6px",
-                "borderRadius": "5px",
-                "fontWeight": "bold",
-                "fontSize": "14px",
-                "zIndex": "999",  # Ensure it appears above map elements
-            },
-        )
+        if self.colorbar_title:
+            top = "70px" if enable_zoom is False else "140px"
+            return html.Div(
+                self.colorbar_title,
+                style={
+                    "position": "absolute",
+                    "top": top,  # Adjusted to place above the colorbar
+                    "left": "10px",  # Align with the left side of the colorbar
+                    "background": "white",
+                    "padding": "2px 6px",
+                    "borderRadius": "5px",
+                    "fontWeight": "bold",
+                    "fontSize": "14px",
+                    "zIndex": "999",  # Ensure it appears above map elements
+                },
+            )
+        return None
+
+    def resolve_colorbar_title(self, colorbar_title: str):
+        """Returns text for colorbar title."""
+        if colorbar_title is None:
+            return None  # exclude title
+        if colorbar_title == "default":
+            return self.hover_text_columns[0]
+        return colorbar_title  # custom title

gov_uk_dashboards/components/plotly/enums.py

@@ -11,6 +11,8 @@ class XAxisFormat(Enum):
     MONTH_YEAR = "month_year"
     MONTH_YEAR_MONTHLY_DATA = "month_year_monthly_data"
     FINANCIAL_QUARTER = "financial_quarter"
+    WEEK = "week"
+    QUARTER = "quarter"
 
 
 class TitleDataStructure(TypedDict):