Skip to content

navigation

django_spire.contrib.navigation

__all__ = ['Navigation'] module-attribute

Navigation

Source code in django_spire/contrib/navigation/navigation.py 
15
16
17
18
19
20
def __init__(self) -> None:
    self.page_title: str | None = None
    self.help_template: str | None = None
    self.icon_class: str | None = None
    self.home_url: str | None = settings.DJANGO_SPIRE_NAVIGATION_HOME_URL
    self.breadcrumbs: Breadcrumbs = Breadcrumbs()

page_title = None instance-attribute

help_template = None instance-attribute

icon_class = None instance-attribute

home_url = settings.DJANGO_SPIRE_NAVIGATION_HOME_URL instance-attribute

breadcrumbs = Breadcrumbs() instance-attribute

home_href property

set_page_title_from_model_plural_name

Source code in django_spire/contrib/navigation/navigation.py 
29
30
def set_page_title_from_model_plural_name(self, model: type[Model] | Model) -> None:
    self.page_title = str(model._meta.verbose_name_plural.title())

set_page_title_from_model_name

Source code in django_spire/contrib/navigation/navigation.py 
32
33
def set_page_title_from_model_name(self, model: type[Model] | Model) -> None:
    self.page_title = str(model._meta.verbose_name.title())

set_page_title_to_form_action_from_model_instance

Source code in django_spire/contrib/navigation/navigation.py 
35
36
37
38
def set_page_title_to_form_action_from_model_instance(self, model: Model) -> None:
    self.page_title = (
        f'{form_action_name(has_pk=model.pk is not None)} {model._meta.verbose_name.title()}'
    )

as_context

Source code in django_spire/contrib/navigation/navigation.py 
40
41
42
43
44
45
46
47
48
49
def as_context(self) -> dict[str, Any]:
    return {
        'django_spire_navigation': {
            'page_title': self.page_title,
            'home_href': self.home_href,
            'icon_class': self.icon_class,
            'help_template': self.help_template,
            **self.breadcrumbs.as_context(),
        }
    }