fsi.theme

Attributes

user_options

Classes

FsiTheme

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

Package Contents

fsi.theme.user_options[source]
class fsi.theme.FsiTheme(compress: bool = True)[source]

Bases: onegov.town6.theme.TownTheme

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 (but after the _settings.scss) before it is compiled:

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

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

If use_flex is set to False on the theme itself, the float grid is used instead.

If $xy-grid is set to false by the subclassing theme, the flex grid is used.

name = 'onegov.fsi.theme'[source]

The name of the theme, must be unique.

property post_imports: list[str][source]

Our scss code split into various files

property pre_imports: list[str][source]

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 extra_search_paths: list[str][source]

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