Skip to content

breadcrumbs

django_spire.contrib.navigation.breadcrumbs

Breadcrumbs

Source code in django_spire/contrib/navigation/breadcrumbs.py 
47
48
49
def __init__(self) -> None:
    self.items: list[_Breadcrumb] = []
    self.index: int = 0

items = [] instance-attribute

index = 0 instance-attribute

__add__

Source code in django_spire/contrib/navigation/breadcrumbs.py 
51
52
53
def __add__(self, other: Breadcrumbs) -> Self:
    self.items += other.items
    return self

__iadd__

Source code in django_spire/contrib/navigation/breadcrumbs.py 
55
56
57
def __iadd__(self, other: Breadcrumbs) -> Self:
    self.items += other.items
    return self

__iter__

Source code in django_spire/contrib/navigation/breadcrumbs.py 
59
60
61
def __iter__(self) -> Breadcrumbs:
    self.index = 0
    return self

__len__

Source code in django_spire/contrib/navigation/breadcrumbs.py 
63
64
def __len__(self) -> int:
    return len(self.items)

__next__

Source code in django_spire/contrib/navigation/breadcrumbs.py 
66
67
68
69
70
71
72
def __next__(self) -> _BreadcrumbDict:
    if self.index >= len(self.items):
        raise StopIteration

    breadcrumb_item = self.items[self.index]
    self.index += 1
    return breadcrumb_item.to_dict()

__str__

Source code in django_spire/contrib/navigation/breadcrumbs.py 
74
75
def __str__(self) -> str:
    return str(self.items)

add

Source code in django_spire/contrib/navigation/breadcrumbs.py 
77
78
79
80
81
82
83
84
85
86
def add(
    self,
    name: str,
    view_name: str | None = None,
    view_kwargs: dict[str, Any] | None = None,
    href: str | None = None,
) -> None:
    self.items.append(
        _Breadcrumb(name=name, view_name=view_name, view_kwargs=view_kwargs, href=href)
    )

add_model_plural_name

Source code in django_spire/contrib/navigation/breadcrumbs.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def add_model_plural_name(
    self,
    model: type[Model] | Model,
    view_name: str | None = None,
    view_kwargs: dict[str, Any] | None = None,
    href: str | None = None,
) -> None:
    self.add(
        name=model._meta.verbose_name_plural.title(),
        view_name=view_name,
        view_kwargs=view_kwargs,
        href=href,
    )

add_model_name

Source code in django_spire/contrib/navigation/breadcrumbs.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
def add_model_name(
    self,
    model: type[Model] | Model,
    view_name: str | None = None,
    view_kwargs: dict[str, Any] | None = None,
    href: str | None = None,
) -> None:
    self.add(
        name=model._meta.verbose_name.title(),
        view_name=view_name,
        view_kwargs=view_kwargs,
        href=href,
    )

add_model_instance_string

Source code in django_spire/contrib/navigation/breadcrumbs.py 
116
117
118
119
def add_model_instance_string(
    self, model: Model, view_name: str | None = None, view_kwargs: dict[str, Any] | None = None
) -> None:
    self.add(name=str(model), view_name=view_name, view_kwargs=view_kwargs)

add_model_instance_form_action

Source code in django_spire/contrib/navigation/breadcrumbs.py 
121
122
def add_model_instance_form_action(self, model: Model) -> None:
    self.add(name=form_action_name(has_pk=model.pk is not None))

add_breadcrumb

Source code in django_spire/contrib/navigation/breadcrumbs.py 
124
125
126
127
128
129
130
131
def add_breadcrumb(
    self,
    name: str,
    view_name: str | None = None,
    view_kwargs: dict[str, Any] | None = None,
    href: str | None = None,
) -> None:
    self.add(name=name, view_name=view_name, view_kwargs=view_kwargs, href=href)

add_model_instance_breadcrumb

Source code in django_spire/contrib/navigation/breadcrumbs.py 
133
134
135
136
def add_model_instance_breadcrumb(
    self, model: Model, view_name: str | None = None, view_kwargs: dict[str, Any] | None = None
) -> None:
    self.add(name=str(model), view_name=view_name, view_kwargs=view_kwargs)

remove

Source code in django_spire/contrib/navigation/breadcrumbs.py 
138
139
140
def remove(self, index: int) -> Breadcrumbs:
    del self.items[index]
    return self

reverse

Source code in django_spire/contrib/navigation/breadcrumbs.py 
142
143
144
def reverse(self) -> Breadcrumbs:
    self.items.reverse()
    return self

as_context

Source code in django_spire/contrib/navigation/breadcrumbs.py 
146
147
def as_context(self) -> dict[str, Any]:
    return {'breadcrumbs': self.items}