netbox/docs/plugins/development/forms.md

Forms

Form Classes

NetBox provides several base form classes for use by plugins.

• NetBoxModelForm
• NetBoxModelCSVForm
• NetBoxModelBulkEditForm
• NetBoxModelFilterSetForm

In addition to the form fields provided by Django, NetBox provides several field classes for use within forms to handle specific types of data. These can be imported from utilities.forms.fields and are documented below.

General Purpose Fields

::: utilities.forms.ColorField

selection:
  members: false

::: utilities.forms.CommentField

selection:
  members: false

::: utilities.forms.JSONField

selection:
  members: false

::: utilities.forms.MACAddressField

selection:
  members: false

::: utilities.forms.SlugField

selection:
  members: false

Choice Fields

::: utilities.forms.ChoiceField

selection:
  members: false

::: utilities.forms.MultipleChoiceField

selection:
  members: false

Dynamic Object Fields

::: utilities.forms.DynamicModelChoiceField

selection:
  members: false

::: utilities.forms.DynamicModelMultipleChoiceField

selection:
  members: false

Content Type Fields

::: utilities.forms.ContentTypeChoiceField

selection:
  members: false

::: utilities.forms.ContentTypeMultipleChoiceField

selection:
  members: false

CSV Import Fields

::: utilities.forms.CSVChoiceField

selection:
  members: false

::: utilities.forms.CSVMultipleChoiceField

selection:
  members: false

::: utilities.forms.CSVModelChoiceField

selection:
  members: false

::: utilities.forms.CSVContentTypeField

selection:
  members: false

::: utilities.forms.CSVMultipleContentTypeField

selection:
  members: false