NavGroup now marked as active if any item URLs are active (#105)

Author: joshuadavidthomas

CHANGELOG.md

@@ -34,6 +34,7 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 - `Nav.get_items` now returns a list of `NavGroup` or `NavItem`, instead of a list of `RenderedNavItem`.
 - Check for the existence of a user attached to the `request` object passed in to `django_simple_nav.permissions.check_item_permissions` has been moved to allow for an early return if there is no user. There are instances where the `django.contrib.auth` app can be installed, but no user is attached to the request object. This change will allow this function to correctly be used in those instances.
 - Now using v2024.20 of `django-twc-package`.
+- `NavGroup` is now marked as active if the request path matches it's URL (if set) **or** and of its items' URLs.
 
 ### Removed
 

src/django_simple_nav/nav.py

@@ -199,6 +199,15 @@ def get_url(self) -> str:
             return ""
         return url
 
+    @override
+    def get_active(self, request: HttpRequest) -> bool:
+        is_active = super().get_active(request)
+
+        items = self.get_items(request)
+        item_is_active = any([item.get_active(request) for item in items])
+
+        return is_active or item_is_active
+
     @override
     def check_permissions(self, request: HttpRequest) -> bool:
         has_perm = super().check_permissions(request)

tests/test_navgroup.py

@@ -192,6 +192,29 @@ def get_url(self):
         group.get_url()
 
 
+@pytest.mark.parametrize(
+    "url,expected",
+    [
+        ("/test/", True),
+        ("/test/active/", True),
+        ("/foo/", False),
+    ],
+)
+def test_get_active(url, expected, req):
+    group = NavGroup(
+        title=...,
+        url="/test/",
+        items=[
+            NavItem(title=..., url="/test/active/"),
+            NavItem(title=..., url="/test/not-active/"),
+        ],
+    )
+
+    req.path = url
+
+    assert group.get_active(req) is expected
+
+
 @pytest.mark.parametrize(
     "url,items,expected",
     [