Skip to content

Enums

django_rubble.utils.enums

Icon

Bases: BaseModel

Icon model for use in the application.

Parameters:

Name Type Description Default
name str

The name of the icon.

 required
snippet str

The HTML snippet for the icon.

 ''
svg str

The SVG snippet for the icon.

 ''
toolkit str | None

The toolkit for the icon.

 None
Example

Icon( name="pen-fill", snippet="<i class='bi bi-pen-fill'></i>", toolkit="bootstrap" )

Source code in django_rubble\utils\enums.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class Icon(BaseModel):
    """Icon model for use in the application.

    Example:
        `Icon(
            name="pen-fill",
            snippet="<i class='bi bi-pen-fill'></i>",
            toolkit="bootstrap"
        )`
    """

    name: str = Field(description="The name of the icon.")
    snippet: str = Field(default="", description="The HTML snippet for the icon.")
    svg: str = Field(default="", description="The SVG snippet for the icon.")
    toolkit: str | None = Field(default=None, description="The toolkit for the icon.")

    def __str__(self) -> str:
        return self.name

    @model_validator(mode="after")
    def check_snippet_or_svg(self):
        assert not (self.snippet == "" and self.svg == "")
        return self

    @model_serializer
    def serialize_model(self):
        if self.has_svg:
            return {"name": self.name, "snippet": self.svg}
        return {"name": self.name, "snippet": self.snippet}

    @property
    def has_snippet(self) -> bool:
        return self.snippet is not None

    @property
    def has_svg(self) -> bool:
        return self.svg is not None

    @property
    def html(self):
        return self.svg if self.has_svg else self.snippet

LibraryIcon

Bases: StrEnum

HTML referencing icon.

Must include library if required (e.g. for bootstrap/font-awesome/etc.)

Example include:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css" />

Attributes:

Name Type Description
PENCIL

Edit icon.
TRASH_CAN

Delete icon.
PLUS_CIRCLE

Create icon.
ENVELOPE_OPEN

Detail icon.
LIST_UL

List icon.
DATABASE_FILL_GEAR

Admin icon.
CLOCK_HISTORY

History icon.
ARROWS_COLLAPSE

Expand icon.
ARROW_CLOCKWISE

Refresh icon.
CHECK

Check icon.
X

X icon.
BOX_ARROW_UP

Check out icon.
BOX_ARROW_IN_DOWN

Check in icon.
UPDATE

Edit icon.
ADMIN

Admin icon.
DELETE

Delete icon.
CREATE

Create icon.
DETAIL

Detail icon.
LIST

List icon.
HISTORY

History icon.
CHECKOUT

Check out icon.
CHECKIN

Check in icon.
Source code in django_rubble\utils\enums.py 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class LibraryIcon(StrEnum):
    """HTML referencing icon.

    Must include library if required (e.g. for bootstrap/font-awesome/etc.)


    Example include:
    ```
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css" />
    ```

    Attributes:
        PENCIL: Edit icon.
        TRASH_CAN: Delete icon.
        PLUS_CIRCLE: Create icon.
        ENVELOPE_OPEN: Detail icon.
        LIST_UL: List icon.
        DATABASE_FILL_GEAR: Admin icon.
        CLOCK_HISTORY: History icon.
        ARROWS_COLLAPSE: Expand icon.
        ARROW_CLOCKWISE: Refresh icon.
        CHECK: Check icon.
        X: X icon.
        BOX_ARROW_UP: Check out icon.
        BOX_ARROW_IN_DOWN: Check in icon.
        UPDATE: Edit icon.
        ADMIN: Admin icon.
        DELETE: Delete icon.
        CREATE: Create icon.
        DETAIL: Detail icon.
        LIST: List icon.
        HISTORY: History icon.
        CHECKOUT: Check out icon.
        CHECKIN: Check in icon.
    """  # noqa: E501

    PENCIL = PENCIL.snippet
    TRASH_CAN = "<i class='bi bi-trash2'></i>"
    PLUS_CIRCLE = '<i class="bi bi-plus-circle"></i>'
    ENVELOPE_OPEN = '<i class="bi bi-envelope-open"></i>'
    LIST_UL = '<i class="bi bi-list-ul"></i>'
    DATABASE_FILL_GEAR = '<i class="bi bi-database-fill-gear"></i>'
    CLOCK_HISTORY = CLOCK_HISTORY.snippet
    ARROWS_COLLAPSE = ARROWS_COLLAPSE.snippet
    ARROW_CLOCKWISE = '<i class="bi bi-arrow-clockwise"></i>'
    CHECK = '<i class="bi bi-check2-square">'
    X = '<i class="bi bi-x"></i>'
    BOX_ARROW_UP = '<i class="bi bi-box-arrow-up"></i>'
    BOX_ARROW_IN_DOWN = '<i class="bi bi-box-arrow-in-down"></i>'

    UPDATE = PENCIL
    ADMIN = DATABASE_FILL_GEAR
    DELETE = TRASH_CAN
    CREATE = PLUS_CIRCLE
    DETAIL = ENVELOPE_OPEN
    LIST = LIST_UL
    HISTORY = CLOCK_HISTORY
    CHECKOUT = BOX_ARROW_UP
    CHECKIN = BOX_ARROW_IN_DOWN