Pop-up Notes Field #10395

New Issue

adam · 2025-12-29T21:30:52+01:00

adam commented

2025-12-29 21:30:52 +01:00

Originally created by @craigmoscardini on GitHub (Oct 23, 2024).

NetBox version

4.0.9

Feature type

New functionality

Triage priority

N/A

Proposed functionality

To ensure important information is being read many systems implement the concept of pop-up note fields.
When opening an item (for example a site) the user is presented with a pop-up box (better rendered as an object on page than an actual window) that the user must click OK or similar to close the message.

Use case

To relay important information that would not necessarily be read in the comments or other fields unless the user was looking for that information. I think this adds most value to sites but can also extend to other data models such as contacts or devices.

For example on a site a user could add note relating to access constraints "Authorised engineers only" or "ID required". Or for contacts "Do not call after 6pm".

Database changes

Additional long text field required on any object types where this is implemented.

External dependencies

Probably none

Originally created by @craigmoscardini on GitHub (Oct 23, 2024). ### NetBox version 4.0.9 ### Feature type New functionality ### Triage priority N/A ### Proposed functionality To ensure important information is being read many systems implement the concept of pop-up note fields. When opening an item (for example a site) the user is presented with a pop-up box (better rendered as an object on page than an actual window) that the user must click OK or similar to close the message. ### Use case To relay important information that would not necessarily be read in the comments or other fields unless the user was looking for that information. I think this adds most value to sites but can also extend to other data models such as contacts or devices. For example on a site a user could add note relating to access constraints "Authorised engineers only" or "ID required". Or for contacts "Do not call after 6pm". ### Database changes Additional long text field required on any object types where this is implemented. ### External dependencies Probably none

adam added the type: feature plugin candidate netbox labels 2025-12-29 21:30:52 +01:00

adam closed this issue

2025-12-29 21:30:52 +01:00

adam commented

2025-12-29 21:30:53 +01:00

@sleepinggenius2 commented on GitHub (Oct 23, 2024):

An alerts() method was added for plug-ins in v4.1 (https://netbox.readthedocs.io/en/stable/plugins/development/views/#extra-template-content) that I think gets close to what you are looking for. In our instance, we are looking to use that to fulfill the same use case that you have described. Using a plug-in would allow you to implement whatever business logic you need to in order to display the alert. The simplest would be to add a custom field to whatever object types you need to enter the alert text, then a trivial plug-in that just has a PluginTemplateExtension class that implements the alert method to look for a value in the custom field that you defined for the passed object.

@sleepinggenius2 commented on GitHub (Oct 23, 2024): An `alerts()` method was added for plug-ins in v4.1 (https://netbox.readthedocs.io/en/stable/plugins/development/views/#extra-template-content) that I think gets close to what you are looking for. In our instance, we are looking to use that to fulfill the same use case that you have described. Using a plug-in would allow you to implement whatever business logic you need to in order to display the alert. The simplest would be to add a custom field to whatever object types you need to enter the alert text, then a trivial plug-in that just has a `PluginTemplateExtension` class that implements the `alert` method to look for a value in the custom field that you defined for the passed `object`.

adam commented

2025-12-29 21:30:53 +01:00

@craigmoscardini commented on GitHub (Oct 28, 2024):

Thanks that does get close. It would be nice to implement this functionality natively though, especially since it looks like the foundations of it now exists

@craigmoscardini commented on GitHub (Oct 28, 2024): Thanks that does get close. It would be nice to implement this functionality natively though, especially since it looks like the foundations of it now exists

adam commented

2025-12-29 21:30:53 +01:00

@jeremystretch commented on GitHub (Feb 6, 2025):

IMO this use case seems to be served well by the nearly-ubiquitous "comments" field. But you could try implementing this as a plugin to see if it catches on.

@jeremystretch commented on GitHub (Feb 6, 2025): IMO this use case seems to be served well by the nearly-ubiquitous "comments" field. But you could try implementing this as a plugin to see if it catches on.

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#10395