starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Custom Field information/hint button #7838

New Issue
Closed
opened 2025-12-29 20:28:50 +01:00 by adam · 8 comments
adam commented 2025-12-29 20:28:50 +01:00
Owner
Copy Link

Originally created by @betadrome on GitHub (Mar 31, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.4.7

Feature type

New functionality

Proposed functionality

In my opinion, an information description for a specific custom field is missing. If the Custom Field is very specific, an expandable information text would be very helpful.
The Custom Field inBackup serves as an example. In this case, a functional description can be quite helpful.

netbox-information
collapsed information button
netbox-information-open
folded out information button
netbox-information-edit
Custom Field setting

Use case

Especially new and inexperienced NetBox users would get a better overview of the special functions and backgrounds of this custom field. Users with reading rights also have no possibility to view the description during the editing process or under the tab Other.

Database changes

Nothing

External dependencies

No response

Originally created by @betadrome on GitHub (Mar 31, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.4.7 ### Feature type New functionality ### Proposed functionality In my opinion, an information description for a specific `custom field` is missing. If the `Custom Field` is very specific, an expandable information text would be very helpful. The Custom Field `inBackup` serves as an example. In this case, a functional description can be quite helpful. ![netbox-information](https://user-images.githubusercontent.com/110609354/229208168-5de3cea2-fd20-495d-934f-8325b3533ba7.png) collapsed information button ![netbox-information-open](https://user-images.githubusercontent.com/110609354/229208185-61251a95-f021-4b28-9062-fd4dc178097c.png) folded out information button ![netbox-information-edit](https://user-images.githubusercontent.com/110609354/229208191-73d75847-dda8-4bb7-885f-6d19db928da8.png) Custom Field setting ### Use case Especially new and inexperienced NetBox users would get a better overview of the special functions and backgrounds of this custom field. Users with reading rights also have no possibility to view the description during the editing process or under the tab `Other`. ### Database changes Nothing ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 20:28:50 +01:00
adam closed this issue 2025-12-29 20:28:50 +01:00
adam commented 2025-12-29 20:28:51 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 4, 2023):

While I see the value in adding a pop-up explaining the field, I would think showing the custom field's description is sufficient. I don't see a need for a separate field.

@jeremystretch commented on GitHub (Apr 4, 2023): While I see the value in adding a pop-up explaining the field, I would think showing the custom field's description is sufficient. I don't see a need for a separate field.
adam commented 2025-12-29 20:28:51 +01:00
Author
Owner
Copy Link

@betadrome commented on GitHub (Apr 5, 2023):

Hey @jeremystretch , I think so too. For my use cases it's enough if the Description field is displayed as pop up.

@betadrome commented on GitHub (Apr 5, 2023): Hey @jeremystretch , I think so too. For my use cases it's enough if the `Description` field is displayed as pop up.
adam commented 2025-12-29 20:28:52 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Apr 5, 2023):

Sounds good. Tagging this as needs owner with the understanding that no new fields are being introduced.

@jeremystretch commented on GitHub (Apr 5, 2023): Sounds good. Tagging this as `needs owner` with the understanding that no new fields are being introduced.
adam commented 2025-12-29 20:28:52 +01:00
Author
Owner
Copy Link

@decoupca commented on GitHub (Apr 5, 2023):

The description is already in the title text of the field name. Adding a blue info icon to every custom field may get cluttered. Might it be more appropriate to give a more subtle hint that more info is available by hovering over the field title, maybe a help cursor?

Screenshot 2023-04-05 at 4 27 51 PM
@decoupca commented on GitHub (Apr 5, 2023): The description is already in the title text of the field name. Adding a blue info icon to every custom field may get cluttered. Might it be more appropriate to give a more subtle hint that more info is available by hovering over the field title, maybe a help cursor? <img width="740" alt="Screenshot 2023-04-05 at 4 27 51 PM" src="https://user-images.githubusercontent.com/94914780/230216359-d05e9a84-2c13-4144-bfe2-b79d8cc543ad.png">
adam commented 2025-12-29 20:28:52 +01:00
Author
Owner
Copy Link

@betadrome commented on GitHub (Apr 11, 2023):

Hey @decoupca, I have thought about this again and see a clear hint button or hint field as very useful. In my opinion, people with little NetBox experience should also be given the opportunity to understand everything as quickly as possible. But the color and form of the hint can also be adapted. This was my first suggestion, which should not be considered as final.

@betadrome commented on GitHub (Apr 11, 2023): Hey @decoupca, I have thought about this again and see a clear hint button or hint field as very useful. In my opinion, people with little NetBox experience should also be given the opportunity to understand everything as quickly as possible. But the color and form of the hint can also be adapted. This was my first suggestion, which should not be considered as final.
adam commented 2025-12-29 20:28:52 +01:00
Author
Owner
Copy Link

@decoupca commented on GitHub (Apr 11, 2023):

Hey @decoupca, I have thought about this again and see a clear hint button or hint field as very useful. In my opinion, people with little NetBox experience should also be given the opportunity to understand everything as quickly as possible. But the color and form of the hint can also be adapted. This was my first suggestion, which should not be considered as final.

to your point, I mouseover tooltips don't work on mobile, so a clickable/tappable icon would be more accessible.

@decoupca commented on GitHub (Apr 11, 2023): > Hey @decoupca, I have thought about this again and see a clear hint button or hint field as very useful. In my opinion, people with little NetBox experience should also be given the opportunity to understand everything as quickly as possible. But the color and form of the hint can also be adapted. This was my first suggestion, which should not be considered as final. to your point, I mouseover tooltips don't work on mobile, so a clickable/tappable icon would be more accessible.
adam commented 2025-12-29 20:28:52 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (May 5, 2023):

@jeremystretch Need some clarity on this. I maybe understanding the requirement wrong. The code already has a description on the hover, should I move this to <i> with an icon just like you have done for deprecated fields?

<span title="{{ field.description|escape }}">{{ field }}</span>
@abhi1693 commented on GitHub (May 5, 2023): @jeremystretch Need some clarity on this. I maybe understanding the requirement wrong. The code already has a description on the hover, should I move this to `<i>` with an icon just like you have done for deprecated fields? ``` <span title="{{ field.description|escape }}">{{ field }}</span> ```
adam commented 2025-12-29 20:28:52 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 5, 2023):

I believe that's the intent, yes; replacing the title text with a separate icon with a Bootstrap tooltip.

@jeremystretch commented on GitHub (May 5, 2023): I believe that's the intent, yes; replacing the title text with a separate icon with a Bootstrap [tooltip](https://getbootstrap.com/docs/5.1/components/tooltips/).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7838
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?