Conditional custom link inclusion #2685

New Issue

adam · 2025-12-29T18:21:06+01:00

adam commented

2025-12-29 18:21:06 +01:00

Originally created by @ktims on GitHub (Jun 21, 2019).

Environment

Python version: 3.6.3
NetBox version: 2.6.0

Proposed Functionality

A facility to filter which custom links appear on the rendered page based on the object's attributes. I think the best implementation would be to provide an optional field in custom link creation which would accept a Jinja2 'if' clause body (e.g. obj.primary_ip is not none). If not included, the link would always be rendered. If included, the link block in the final rendered template would be wrapped in {% if %} {% endif %} to avoid rendering and evaluation of the URL and link text templates.

Use Case

Currently all custom links matching the object's type will be included in the page. In many cases this may not be appropriate (es.g. rack furniture is a 'dcim / device' but wouldn't be in an NMS / devices with no IP information can't have links to their console generated / custom link may depend on an optional custom field), or may lead to rendering oddities due to the chosen template for link text. It also necessitates carefully and obnoxiously adding conditionals on attributes used in the link text and URL templates to ensure that missing attributes don't break rendering of the entire page.

Database Changes

The CustomLink model would require a new CharField to store the conditional. Defaulting to null or the empty string for existing custom links should have no change in behaviour as the suggested implementation wouldn't filter if the field is empty.

External Dependencies

None

Originally created by @ktims on GitHub (Jun 21, 2019).  ### Environment * Python version: 3.6.3 * NetBox version: 2.6.0  ### Proposed Functionality A facility to filter which custom links appear on the rendered page based on the object's attributes. I think the best implementation would be to provide an optional field in custom link creation which would accept a Jinja2 'if' clause body (e.g. `obj.primary_ip is not none`). If not included, the link would always be rendered. If included, the link block in the final rendered template would be wrapped in `{% if %} {% endif %}` to avoid rendering and evaluation of the URL and link text templates.  ### Use Case Currently all custom links matching the object's type will be included in the page. In many cases this may not be appropriate (es.g. rack furniture is a 'dcim / device' but wouldn't be in an NMS / devices with no IP information can't have links to their console generated / custom link may depend on an optional custom field), or may lead to rendering oddities due to the chosen template for link text. It also necessitates carefully and obnoxiously adding conditionals on attributes used in the link text and URL templates to ensure that missing attributes don't break rendering of the entire page.  ### Database Changes The CustomLink model would require a new CharField to store the conditional. Defaulting to null or the empty string for existing custom links should have no change in behaviour as the suggested implementation wouldn't filter if the field is empty.  ### External Dependencies None

adam added the status: accepted type: feature labels 2025-12-29 18:21:06 +01:00

adam closed this issue

2025-12-29 18:21:06 +01:00

adam commented

2025-12-29 18:21:07 +01:00

@jeremystretch commented on GitHub (Jun 21, 2019):

We can tweak the template so that the link is only included if the Jinja2 in the CustomLink's text field renders to a non-empty string. So, you could do something like this:

{% if obj.device_role.slug == 'foo' %}Clicky{% endif %}

And the custom link would be displayed only if the device's role is Foo.

@jeremystretch commented on GitHub (Jun 21, 2019): We can tweak the template so that the link is only included if the Jinja2 in the CustomLink's `text` field renders to a non-empty string. So, you could do something like this: ``` {% if obj.device_role.slug == 'foo' %}Clicky{% endif %} ``` And the custom link would be displayed only if the device's role is Foo.

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