Adding tab to model via plugin

[ziggekatten]

In my plugin, I have created an view that I would like to attach to the Device model, using the @register_model_view() decorator, and sure enough, I get the tab as expected:

However, clicking on the tab to get the data, that in this case is from an external source via an API request, and using the .render() function, presents the data (in my case some markdown) without changing the active tab so to speak. Visually it "overrides" the Device tab.

So, everything seems to work as expected, except for this little snag, and I have tried to figure out where the problem is, but my wizardry is yet not at that level

[candlerb]

If you can make a small self-contained plugin which demonstrates this behaviour (e.g. display a static page instead of making an API call), then:

1. We can easily reproduce it
2. We can see whether this is a bug in the Netbox plugin framework, or in the way you're using it

[markkuleinio]

I will try to make a full public example later, the rough steps for now (this is for Prefix but anyway):

Template:

{% extends 'generic/object.html' %}

{% block content %}
My content
{% endblock content %}

View:

@register_model_view(Prefix, name="mytab")
class HelloWorldView(View):
    tab = ViewTab(
        label="My Tab",
        permission="ipam.view_prefix",
    )

    def get(self, request, pk):
        prefix = Prefix.objects.get(pk=pk)
        return render(
            request,
            "my_plugin/tab.html",
            {
                "object": prefix,
                "tab": self.tab,
            },
        )

Comments:

• context["object"] is needed to be able to populate the contents in the page
• context["tab"] makes the tab work

[ziggekatten]

There we go!

Passing the self.tab to render() and it works!

I was sniffing at this somewhat but I never thought it would be that simple

[candlerb]

Definitely worth documenting at https://docs.netbox.dev/en/stable/plugins/development/views/#additional-tabs IMO.

[markkuleinio]

I will try to make a full public example later

https://github.com/markkuleinio/netbox-tab-example

[markkuleinio]

Definitely worth documenting at https://docs.netbox.dev/en/stable/plugins/development/views/#additional-tabs IMO.

#15727