org.theme.org_theme

Module Contents

Classes

OrgTheme

Base class for Zurb Foundation based themes. Use this class to

Attributes

HELVETICA
ARIAL
VERDANA
COURIER_NEW
user_options
default_font_families

org.theme.org_theme.HELVETICA = '"Helvetica Neue", Helvetica, Roboto, Arial, sans-serif !default;'

org.theme.org_theme.ARIAL = 'Arial, sans-serif !default;'

org.theme.org_theme.VERDANA = 'Verdana, Geneva, sans-serif !default;'

org.theme.org_theme.COURIER_NEW = '"Courier New", Courier, monospace !default;'

org.theme.org_theme.user_options

org.theme.org_theme.default_font_families

class org.theme.org_theme.OrgTheme(compress: bool = True)

Bases: onegov.foundation.BaseTheme

Base class for Zurb Foundation based themes. Use this class to create a theme that customizes Zurb Foundation somehow.

If you don’t want to customize it at all, use Theme.

To customize start like this:

from onegov.foundation import BaseTheme

class MyTheme(BaseTheme):
    name = 'my-theme'
    version = '1.0'

You can then add paths with your own scss files, as well as imports that should be added before the foundation theme, and imports that should be added after the foundation theme.

Finally, options passed to the compile() function take this form:

options = {
    'rowWidth': '1000px',
    'columnGutter': '30px'
}

Those options result in variables added at the very top of the sass source before it is compiled:

@import 'foundation/functions';

$rowWidth: 1000px;
$columnGutter: 30px;

If your variables rely on a certain order you need to pass an ordered dict.

property default_options: dict[str, Any]

Default options used when compiling the theme.

property foundation_components: Sequence[str]

All used foundation components.

property pre_imports: list[str]

Imports added before the foundation import. The imports must be found in one of the paths (see extra_search_paths).

The form of a single import is ‘example’ (which would search for files named ‘example.scss’)

property post_imports: list[str]

Imports added after the foundation import. The imports must be found in one of the paths (see extra_search_paths).

The form of a single import is ‘example’ (which would search for files named ‘example.scss’)

property extra_search_paths: list[str]

A list of absolute search paths added before the actual foundation search path.

property font_search_path: str

Load fonts of the current theme folder and ignore fonts from parent applications if OrgTheme is inherited.

property font_families: dict[str, str]

property additional_font_families: 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.

name = 'onegov.org.foundation'

_force_compile = False