Plugins: Extend Create and Edit Object view to include custom forms. #3777

New Issue

adam · 2025-12-29T18:31:10+01:00

adam commented

2025-12-29 18:31:10 +01:00

Originally created by @minitriga on GitHub (Jun 12, 2020).

Environment

Python version: 3.7
NetBox version: 2.8.0

Proposed Functionality

Allow users to fill out plugin information within the object create/edit view. Currently, we are using Custom Fields to do this but it would be nice to have a form that ties to its own model if required as using Custom Fields means we need to keep track of what custom fields we are using.

from extras.plugins import PluginTemplateExtension
from django import forms

class NameForm(forms.Form):
    test_1 = forms.CharField(label='Test 1', max_length=100)
    test_2 = forms.CharField(label='Test 2', max_length=100)

class DeviceTypeListForm(PluginTemplateExtension):
    model = 'dcim.device_type'
    form = NameForm()
    def form(self):
        return form

template_extensions = [DeviceTypeListForm]

I'm not sure of the implementation details but let me know if this doesn't make sense.

Shouldnt need to do anything with the view template as there are already components that allow this detail to be added.

Use Case

Ability to populate models that relate within the same view as Netbox Core models.

Database Changes

None

External Dependencies

Netbox Plugins

Originally created by @minitriga on GitHub (Jun 12, 2020).  ### Environment * Python version: 3.7 * NetBox version: 2.8.0  ### Proposed Functionality Allow users to fill out plugin information within the object create/edit view. Currently, we are using Custom Fields to do this but it would be nice to have a form that ties to its own model if required as using Custom Fields means we need to keep track of what custom fields we are using. ![image](https://user-images.githubusercontent.com/26367336/84517228-e5600a00-acc6-11ea-8818-a5a41f7ff116.png) ``` from extras.plugins import PluginTemplateExtension from django import forms class NameForm(forms.Form): test_1 = forms.CharField(label='Test 1', max_length=100) test_2 = forms.CharField(label='Test 2', max_length=100) class DeviceTypeListForm(PluginTemplateExtension): model = 'dcim.device_type' form = NameForm() def form(self): return form template_extensions = [DeviceTypeListForm] ``` I'm not sure of the implementation details but let me know if this doesn't make sense. Shouldnt need to do anything with the view template as there are already components that allow this detail to be added.  ### Use Case Ability to populate models that relate within the same view as Netbox Core models.  ### Database Changes None  ### External Dependencies Netbox Plugins

adam closed this issue

2025-12-29 18:31:10 +01:00

adam commented

2025-12-29 18:31:10 +01:00

@jeremystretch commented on GitHub (Jun 12, 2020):

It's a neat idea, but this isn't something we can reasonably support in the core. Forms can be very complex, particularly with regard to validation, and trying to accommodate unknown third party extensions is a non-starter. Further, our goal is to eventually move toward an entirely API-driven UI anyway, which would obviate the need for traditional forms as they currently exist.

@jeremystretch commented on GitHub (Jun 12, 2020): It's a neat idea, but this isn't something we can reasonably support in the core. Forms can be very complex, particularly with regard to validation, and trying to accommodate unknown third party extensions is a non-starter. Further, our goal is to eventually move toward an entirely API-driven UI anyway, which would obviate the need for traditional forms as they currently exist.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3777