Skip to content

breadcrumbs

django_spire.contrib.breadcrumb.breadcrumbs

BreadcrumbDict

Bases: TypedDict

name instance-attribute

href instance-attribute

BreadcrumbItem

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
12
13
14
def __init__(self, name: str, href: str | None = None) -> None:
    self.name = name
    self.href = href

name = name instance-attribute

href = href instance-attribute

to_dict

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
16
17
def to_dict(self) -> BreadcrumbDict:
    return {'name': self.name, 'href': self.href}

Breadcrumbs

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
21
22
23
def __init__(self) -> None:
    self.data: list[BreadcrumbItem] = []
    self.index: int = 0

data = [] instance-attribute

index = 0 instance-attribute

__add__

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
25
26
27
def __add__(self, other: Breadcrumbs) -> Breadcrumbs:
    self.data += other.data
    return self

__iter__

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
29
30
31
def __iter__(self) -> Breadcrumbs:
    self.index = 0
    return self

__len__

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
33
34
def __len__(self) -> int:
    return len(self.data)

__next__

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
36
37
38
39
40
41
42
def __next__(self) -> BreadcrumbDict:
    if self.index >= len(self.data):
        raise StopIteration

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

__str__

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
44
45
def __str__(self) -> str:
    return str(self.data)

add_base_breadcrumb

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
47
48
49
def add_base_breadcrumb(self, model: Any) -> None:
    if hasattr(model, 'base_breadcrumb'):
        self += model.base_breadcrumb()

add_breadcrumb

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
51
52
53
def add_breadcrumb(self, name: str, href: str | None = None) -> None:
    breadcrumb_item = BreadcrumbItem(name=name, href=href)
    self.data.append(breadcrumb_item)

add_form_breadcrumbs

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
55
56
57
58
59
60
61
62
def add_form_breadcrumbs(self, obj: Any) -> None:
    self.add_obj_breadcrumbs(obj)

    if obj.pk is None:
        self.add_breadcrumb(name=obj._meta.model._meta.verbose_name)
        self.add_breadcrumb(name='Create')
    else:
        self.add_breadcrumb(name='Edit')

add_obj_breadcrumbs

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
64
65
66
67
68
def add_obj_breadcrumbs(self, obj: Any) -> None:
    # It expects a breadcrumb object to be returned from the object
    if hasattr(obj, 'breadcrumbs'):
        object_breadcrumbs = obj.breadcrumbs()
        self.data += object_breadcrumbs.data

remove

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
70
71
72
def remove(self, index: int) -> Breadcrumbs:
    del self.data[index]
    return self

reverse

Source code in django_spire/contrib/breadcrumb/breadcrumbs.py 
74
75
76
def reverse(self) -> Breadcrumbs:
    self.data.reverse()
    return self