NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 09:51:22 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Closes #17424: Add custom visibility toggle to ViewTab

Browse Source
This commit is contained in:
Jeremy Stretch 2025-02-27 09:30:52 -05:00
parent b9b42cd3b4
commit cf7e2c8dc9
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
netbox/utilities/views.py
View File

@ -206,22 +206,30 @@ class ViewTab:
Args: Args:
label: Human-friendly text label: Human-friendly text
visible: A callable which determines whether the tab should be displayed. This callable must accept exactly one
argument: the object instance. If a callable is not specified, the tab's visibility will be determined by
its badge (if any) and the value of `hide_if_empty`.
badge: A static value or callable to display alongside the label (optional). If a callable is used, it must badge: A static value or callable to display alongside the label (optional). If a callable is used, it must
accept a single argument representing the object being viewed. accept a single argument representing the object being viewed.
weight: Numeric weight to influence ordering among other tabs (default: 1000) weight: Numeric weight to influence ordering among other tabs (default: 1000)
permission: The permission required to display the tab (optional). permission: The permission required to display the tab (optional).
hide_if_empty: If true, the tab will be displayed only if its badge has a meaningful value. (Tabs without a hide_if_empty: If true, the tab will be displayed only if its badge has a meaningful value. (This parameter is
badge are always displayed.) evaluated only if the tab is permitted to be displayed according to the `visible` parameter.)
""" """
def __init__(self, label, badge=None, weight=1000, permission=None, hide_if_empty=False): def __init__(self, label, visible=None, badge=None, weight=1000, permission=None, hide_if_empty=False):
self.label = label self.label = label
self.visible = visible
self.badge = badge self.badge = badge
self.weight = weight self.weight = weight
self.permission = permission self.permission = permission
self.hide_if_empty = hide_if_empty self.hide_if_empty = hide_if_empty
def render(self, instance): def render(self, instance):
"""Return the attributes needed to render a tab in HTML.""" """
Return the attributes needed to render a tab in HTML if the tab should be displayed. Otherwise, return None.
"""
if self.visible is not None and not self.visible(instance):
return None
badge_value = self._get_badge_value(instance) badge_value = self._get_badge_value(instance)
if self.badge and self.hide_if_empty and not badge_value: if self.badge and self.hide_if_empty and not badge_value:
return None return None