Source code for town6.theme.town_theme

import os

from onegov.foundation6 import BaseTheme
from onegov.core.utils import module_path


from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
    from collections.abc import Sequence



[docs]
HELVETICA = '"Helvetica Neue", Helvetica, Roboto, Arial, sans-serif !default'


[docs]
ARIAL = 'Arial, sans-serif !default'


[docs]
VERDANA = 'Verdana, Geneva, sans-serif !default'


[docs]
COURIER_NEW = '"Courier New", Courier, monospace !default'     # monospace


[docs]
ROBOTO_CONDENSED = '"Roboto Condensed", sans-serif !default'


[docs]
MERRIWEATHER = 'Merriweather, sans-serif !default'


# "Merriweather","Helvetica Neue",Helvetica,Roboto,Arial,sans-serif
# options editable by the user

[docs]
user_options = {
    'primary-color-ui': '#006fba',
    'body-font-family-ui': MERRIWEATHER,
    'header-font-family-ui': ROBOTO_CONDENSED
}



[docs]
default_font_families = {
    'Roboto Condensed': ROBOTO_CONDENSED,
    'Helvetica': HELVETICA,
    'Arial': ARIAL,
    'Verdana': VERDANA,
    'Courier New': COURIER_NEW,
}




[docs]
class TownTheme(BaseTheme):

[docs]
    name = 'onegov.town6.foundation'



[docs]
    _force_compile = False


[docs]
    use_flex = True


[docs]
    include_motion_ui = True


    @property

[docs]
    def default_options(self) -> dict[str, Any]:
        return user_options


    @property

[docs]
    def foundation_styles(self) -> 'Sequence[str]':
        return 'global-styles', 'forms', 'typography'


    @property

[docs]
    def foundation_components(self) -> tuple[str, ...]:
        return (
            'button',
            'button-group',
            'close-button',
            'label',
            # 'progress-bar',
            # 'slider',
            # 'switch',
            'table',
            # 'badge',
            'breadcrumbs',
            'callout',
            'card',
            'dropdown',
            'pagination',
            'tooltip',
            'accordion',
            'media-object',
            'orbit',
            'responsive-embed',
            'tabs',
            'thumbnail',
            'menu',
            'menu-icon',
            'accordion-menu',
            'drilldown-menu',
            'dropdown-menu',
            'off-canvas',
            'reveal',
            'sticky',
            'title-bar',
            'top-bar',
        )


    @property

[docs]
    def pre_imports(self) -> list[str]:
        return [
            'foundation-mods',
            *self.additional_font_families
        ]


    @property

[docs]
    def post_imports(self) -> list[str]:
        """Our scss code split into various files"""
        return [
            'custom_mixins',
            'typography',
            'header',
            'town6',
            'sortable',
            'sidebars',
            'forms',
            'formcode',
            'panels',
            'sliders',
            'org-settings',
            'helpers',
            'footer',
            'chosen',
            'news',
            'events',
            'homepage-tiles',
            'tickets',
            'user',
            'timeline',
            'upload',
            'files',
            'publication_signature',
            'image-grid',
            'widgets',
            'popup',
            'fullcalendar',
            'alert',
            'redactor',
            'directories',
            'daypicker',
            'payment',
            'person',
            'newsletter',
            'search',
            'hints',
            'allocations',
            'homepage',
            'progress_indicator',
            'healthcheck',
            'qrcode',
            'leaflet',
            'tags',
            'print',
            'chat',
            'bar-graph',
        ]


    @property

[docs]
    def extra_search_paths(self) -> list[str]:
        return [
            *super().extra_search_paths,
            module_path('onegov.town6.theme', 'styles'),
            self.font_search_path
        ]


    @property

[docs]
    def font_search_path(self) -> str:
        """ Load fonts of the current theme folder and ignore fonts from
        parent applications if OrgTheme is inherited. """
        module = self.name.replace('foundation', 'theme')
        return module_path(module, 'fonts')


    @property

[docs]
    def font_families(self) -> dict[str, str]:
        families = default_font_families.copy()
        families.update(self.additional_font_families)
        return families


    @property

[docs]
    def additional_font_families(self) -> dict[str, str]:
        """ Returns the filenames as they are to use as label in the settings
        as well as to construct the font-family string.
        Only sans-serif fonts are supported by now.
        """
        if not os.path.exists(self.font_search_path):
            return {}

        return {
            parts[0]: f'"{parts[0]}", {HELVETICA}'
            for filename in os.listdir(self.font_search_path)
            if (parts := filename.rpartition('.'))
            and parts[2] in ('css', 'scss')
        }