|
| 1 | +"""Navigation infrastructure for NiceGUI sidebar. |
| 2 | +
|
| 3 | +This module provides: |
| 4 | +- NavItem: Individual navigation item dataclass |
| 5 | +- NavGroup: Group of navigation items |
| 6 | +- BaseNavBuilder: Abstract base class for module navigation builders |
| 7 | +- gui_get_nav_groups: Collect and sort navigation groups from all NavBuilders |
| 8 | +""" |
| 9 | + |
| 10 | +from abc import ABC, abstractmethod |
| 11 | +from dataclasses import dataclass, field |
| 12 | + |
| 13 | +from ._di import locate_subclasses |
| 14 | + |
| 15 | + |
| 16 | +@dataclass |
| 17 | +class NavItem: |
| 18 | + """Navigation item for sidebar. |
| 19 | +
|
| 20 | + Attributes: |
| 21 | + icon: Material icon name (e.g., 'waving_hand', 'settings'). |
| 22 | + label: Display label for the navigation item. |
| 23 | + target: URL path or external URL for the link. |
| 24 | + marker: Test marker for the item. Auto-generated from label if None. |
| 25 | + new_tab: Whether to open the link in a new tab. Defaults to False (same tab). |
| 26 | + """ |
| 27 | + |
| 28 | + icon: str |
| 29 | + label: str |
| 30 | + target: str |
| 31 | + marker: str | None = None |
| 32 | + new_tab: bool = False |
| 33 | + |
| 34 | + def __post_init__(self) -> None: |
| 35 | + """Auto-generate marker from label if not provided.""" |
| 36 | + if self.marker is None: |
| 37 | + # Convert label to SCREAMING_SNAKE_CASE marker |
| 38 | + self.marker = "LINK_" + self.label.upper().replace(" ", "_").replace("(", "").replace(")", "") |
| 39 | + |
| 40 | + |
| 41 | +@dataclass |
| 42 | +class NavGroup: |
| 43 | + """Group of navigation items from a NavBuilder. |
| 44 | +
|
| 45 | + Used internally for rendering navigation in the sidebar. |
| 46 | + """ |
| 47 | + |
| 48 | + name: str |
| 49 | + icon: str = "folder" |
| 50 | + items: list[NavItem] = field(default_factory=list) |
| 51 | + position: int = 1000 |
| 52 | + use_expansion: bool = True |
| 53 | + |
| 54 | + |
| 55 | +class BaseNavBuilder(ABC): |
| 56 | + """Base class for navigation builders. |
| 57 | +
|
| 58 | + Each module should have ONE NavBuilder that defines its navigation items. |
| 59 | + NavBuilders are auto-discovered and used to populate the sidebar. |
| 60 | +
|
| 61 | + Example: |
| 62 | + class NavBuilder(BaseNavBuilder): |
| 63 | + @staticmethod |
| 64 | + def get_nav_name() -> str: |
| 65 | + return "My Module" |
| 66 | +
|
| 67 | + @staticmethod |
| 68 | + def get_nav_items() -> list[NavItem]: |
| 69 | + return [ |
| 70 | + NavItem(icon="home", label="Home", target="/my-module"), |
| 71 | + NavItem(icon="settings", label="Settings", target="/my-module/settings"), |
| 72 | + ] |
| 73 | +
|
| 74 | + @staticmethod |
| 75 | + def get_nav_position() -> int: |
| 76 | + return 200 # Lower = higher in sidebar |
| 77 | + """ |
| 78 | + |
| 79 | + @staticmethod |
| 80 | + @abstractmethod |
| 81 | + def get_nav_name() -> str: |
| 82 | + """Return the display name for this module's navigation group. |
| 83 | +
|
| 84 | + Returns: |
| 85 | + str: Display name shown in sidebar (e.g., 'Hello World', 'System'). |
| 86 | + """ |
| 87 | + |
| 88 | + @staticmethod |
| 89 | + @abstractmethod |
| 90 | + def get_nav_items() -> list[NavItem]: |
| 91 | + """Return navigation items for the sidebar. |
| 92 | +
|
| 93 | + Items are rendered in list order within the module's group. |
| 94 | +
|
| 95 | + Returns: |
| 96 | + list[NavItem]: Navigation items for this module. |
| 97 | + """ |
| 98 | + |
| 99 | + @staticmethod |
| 100 | + def get_nav_position() -> int: |
| 101 | + """Return position in sidebar (lower = higher). |
| 102 | +
|
| 103 | + Convention: |
| 104 | + - 100-199: Core demo/example pages |
| 105 | + - 200-499: Feature modules |
| 106 | + - 500-799: Default (unspecified) |
| 107 | + - 800-899: System/admin pages |
| 108 | + - 900-999: External links (API docs, status, repo) |
| 109 | +
|
| 110 | + Returns: |
| 111 | + int: Position value. Defaults to 1000. |
| 112 | + """ |
| 113 | + return 1000 |
| 114 | + |
| 115 | + @staticmethod |
| 116 | + def get_nav_icon() -> str: |
| 117 | + """Return the icon for the navigation group expansion panel. |
| 118 | +
|
| 119 | + Uses Material Icons names. See: https://fonts.google.com/icons |
| 120 | +
|
| 121 | + Returns: |
| 122 | + str: Material icon name. Defaults to 'folder'. |
| 123 | + """ |
| 124 | + return "folder" |
| 125 | + |
| 126 | + @staticmethod |
| 127 | + def get_nav_use_expansion() -> bool: |
| 128 | + """Return whether to render items in an expansion panel. |
| 129 | +
|
| 130 | + If True, items are grouped in a collapsible expansion with get_nav_name(). |
| 131 | + If False, items are rendered flat without grouping. |
| 132 | +
|
| 133 | + Returns: |
| 134 | + bool: Use expansion panel. Defaults to True. |
| 135 | + """ |
| 136 | + return True |
| 137 | + |
| 138 | + |
| 139 | +def gui_get_nav_groups() -> list[NavGroup]: |
| 140 | + """Collect navigation groups from all NavBuilders. |
| 141 | +
|
| 142 | + Returns: |
| 143 | + list[NavGroup]: Navigation groups sorted by position. |
| 144 | + """ |
| 145 | + nav_builders = locate_subclasses(BaseNavBuilder) |
| 146 | + groups: list[NavGroup] = [] |
| 147 | + |
| 148 | + for nav_builder in nav_builders: |
| 149 | + items = nav_builder.get_nav_items() |
| 150 | + if items: # Only include builders with nav items |
| 151 | + groups.append( |
| 152 | + NavGroup( |
| 153 | + name=nav_builder.get_nav_name(), |
| 154 | + icon=nav_builder.get_nav_icon(), |
| 155 | + items=items, |
| 156 | + position=nav_builder.get_nav_position(), |
| 157 | + use_expansion=nav_builder.get_nav_use_expansion(), |
| 158 | + ) |
| 159 | + ) |
| 160 | + |
| 161 | + # Sort by position (lower = higher in sidebar) |
| 162 | + return sorted(groups, key=lambda g: g.position) |
0 commit comments