Custom Field information/hint button

[betadrome]

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.

collapsed information button

folded out information button

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

[jeremystretch]

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.

[betadrome]

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

[jeremystretch]

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

[decoupca]

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?

[betadrome]

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.

[decoupca]

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.

[abhi1693]

@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>

[jeremystretch]

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