Skip to content
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.

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

Allow plugins to inject top-level navigation menu items #9071

Closed
jeremystretch opened this issue Apr 7, 2022 · 3 comments · Fixed by #10441
Closed

Allow plugins to inject top-level navigation menu items #9071

jeremystretch opened this issue Apr 7, 2022 · 3 comments · Fixed by #10441
Assignees
Labels
status: accepted This issue has been accepted for implementation topic: plugins Relates to the plugins framework type: feature Introduction of new functionality to the application
Milestone

Comments

@jeremystretch
Copy link
Member

NetBox version

v3.2.0

Feature type

Change to existing functionality

Proposed functionality

Currently, plugins can define menu items only under the "Plugins" header within the navigation menu. Several plugin authors have proposed the ability for a plugin to "register" its own top-level section in the menu.

IMO the simplest approach would be to allow a plugin to define a menu heading with a title and icon. If defined, its menu items will appear there; if not, they will appear under the general "Plugins" heading.

We'd also want to give some thought to influencing the ordering of top-level menu items; assigning a "weight" to each item might suffice.

Use case

Greater visibility for plugin functions; control over order of placement (potentially?)

Database changes

No response

External dependencies

No response

@jeremystretch jeremystretch added type: feature Introduction of new functionality to the application status: under review Further discussion is needed to determine this issue's scope and/or implementation topic: plugins Relates to the plugins framework labels Apr 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jun 7, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@github-actions github-actions bot added the pending closure Requires immediate attention to avoid being closed for inactivity label Jun 7, 2022
@jeremystretch jeremystretch added needs milestone Awaiting prioritization for inclusion with a future NetBox release and removed status: under review Further discussion is needed to determine this issue's scope and/or implementation pending closure Requires immediate attention to avoid being closed for inactivity labels Jun 9, 2022
@peteeckel
Copy link
Contributor

I thought I'd revisit this now that a couple of months have passed and I implemented our plugin at two customers and in my own environment.

A complaint that I hear quite often is that access to plugins is somewhat hidden from view, which tends to confuse casual users. So I think the option of optionally "promoting" a plugin to be a first class menu entry is still on the wish list.

@abhi1693
Copy link
Member

abhi1693 commented Jul 2, 2022

There should also be the ability to add our plugin menu under the existing headers like Virtualization or Devices etc. I have a few plugins that would be much suited under the existing ones rather than creating them as suggested in the description.

@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed needs milestone Awaiting prioritization for inclusion with a future NetBox release labels Aug 24, 2022
@jeremystretch jeremystretch added this to the v3.4 milestone Aug 24, 2022
@arthanson arthanson self-assigned this Sep 21, 2022
@jeremystretch jeremystretch self-assigned this Sep 28, 2022
jeremystretch added a commit that referenced this issue Sep 28, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation topic: plugins Relates to the plugins framework type: feature Introduction of new functionality to the application
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants