Skip to content

Closes #13638: Add optional staff_only attribute to MenuItem #13639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 31, 2023
Merged

Closes #13638: Add optional staff_only attribute to MenuItem #13639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0b1fac
Closes #13638: Add optional staff_only attribute to MenuItem
jeremystretch Aug 31, 2023
b23f7b7
Add missing file
jeremystretch Aug 31, 2023
b7decfa
Add release note
jeremystretch Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/plugins/development/navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,15 @@ item1 = PluginMenuItem(

A `PluginMenuItem` has the following attributes:

| Attribute | Required | Description |
|---------------|----------|------------------------------------------------------|
| `link` | Yes | Name of the URL path to which this menu item links |
| `link_text` | Yes | The text presented to the user |
| `permissions` | - | A list of permissions required to display this link |
| `buttons` | - | An iterable of PluginMenuButton instances to include |
| Attribute | Required | Description |
|---------------|----------|----------------------------------------------------------------------------------------------------------|
| `link` | Yes | Name of the URL path to which this menu item links |
| `link_text` | Yes | The text presented to the user |
| `permissions` | - | A list of permissions required to display this link |
| `staff_only` | - | Display only for users who have `is_staff` set to true (any specified permissions will also be required) |
| `buttons` | - | An iterable of PluginMenuButton instances to include |

!!! info "The `staff_only` attribute was introduced in NetBox v3.6.1."

## Menu Buttons

Expand Down
3 changes: 2 additions & 1 deletion netbox/extras/plugins/navigation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ class PluginMenuItem:
permissions = []
buttons = []

def __init__(self, link, link_text, permissions=None, buttons=None):
def __init__(self, link, link_text, staff_only=False, permissions=None, buttons=None):
self.link = link
self.link_text = link_text
self.staff_only = staff_only
if permissions is not None:
if type(permissions) not in (list, tuple):
raise TypeError("Permissions must be passed as a tuple or list.")
Expand Down
1 change: 1 addition & 0 deletions netbox/netbox/navigation/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ class MenuItem:
link: str
link_text: str
permissions: Optional[Sequence[str]] = ()
staff_only: Optional[bool] = False
buttons: Optional[Sequence[MenuItemButton]] = ()


Expand Down
13 changes: 8 additions & 5 deletions netbox/utilities/templatetags/navigation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,14 @@ def nav(context: Context) -> Dict:
for group in menu.groups:
items = []
for item in group.items:
if user.has_perms(item.permissions):
buttons = [
button for button in item.buttons if user.has_perms(button.permissions)
]
items.append((item, buttons))
if not user.has_perms(item.permissions):
continue
if item.staff_only and not user.is_staff:
continue
buttons = [
button for button in item.buttons if user.has_perms(button.permissions)
]
items.append((item, buttons))
if items:
groups.append((group, items))
if groups:
Expand Down