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

Add Copy Button to Script Output Window #11652

New Issue
Closed
opened 2025-12-29 21:48:06 +01:00 by adam · 6 comments
adam commented 2025-12-29 21:48:06 +01:00
Owner
Copy Link

Originally created by @dmismirn on GitHub (Sep 25, 2025).

Originally assigned to: @dmismirn on GitHub.

NetBox version

v4.4.1

Feature type

New functionality

Proposed functionality

Sometimes it is convenient to copy the long output of script to work with it in the editor. The Copy button could be placed next to the download button.

Use case

Pick up a large output to:

  • work in the editor;

  • apply generated config on network equipment.

Database changes

not required

External dependencies

not required

Originally created by @dmismirn on GitHub (Sep 25, 2025). Originally assigned to: @dmismirn on GitHub. ### NetBox version v4.4.1 ### Feature type New functionality ### Proposed functionality Sometimes it is convenient to copy the long output of script to work with it in the editor. The Copy button could be placed next to the download button. ### Use case Pick up a large output to: - work in the editor; - apply generated config on network equipment. ### Database changes not required ### External dependencies not required
adam added the status: acceptedtype: featurecomplexity: low labels 2025-12-29 21:48:06 +01:00
adam closed this issue 2025-12-29 21:48:06 +01:00
adam commented 2025-12-29 21:48:07 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Sep 29, 2025):

@dmismirn , is this something you would be interested in contributing?

@jnovinger commented on GitHub (Sep 29, 2025): @dmismirn , is this something you would be interested in contributing?
adam commented 2025-12-29 21:48:07 +01:00
Author
Owner
Copy Link

@dmismirn commented on GitHub (Sep 29, 2025):

@jnovinger I have limited Django experience but I ready to try.

@dmismirn commented on GitHub (Sep 29, 2025): @jnovinger I have limited Django experience but I ready to try.
adam commented 2025-12-29 21:48:08 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Sep 29, 2025):

Thanks @dmismirn , assigning to you. Here's some guidance.

NetBox uses a well-established pattern for copy-to-clipboard functionality that you can follow for the script output feature.

How NetBox implements copy-to-clipboard:

  1. Django Template Tag: {% copy_content "target_id" %} - renders a button with clipboard functionality
  2. JavaScript Library: Uses clipboard.js to handle the actual clipboard operations
  3. Target Element: Requires the content element to have an id attribute that matches the template tag parameter

For this issue, you need to make a couple small changes, probably in netbox/templates/extras/htmx/script_result.html:

  1. Add an ID to the DOM element containing the script output
  2. Add the copy template tag after the existing download button

Take a look at netbox/templates/extras/object_render_config.html:55-64 for the pattern. Note how the DOM element id attribute and the argument to the copy_content template tag match, that's important.

Before doing that, it's would be useful to read up on how Django templates and template tags work. You don't need to fully grok all of this, but it definitely helps to understand how templates and template tags work together.

Testing Your Changes:

  1. Run a NetBox script that produces output
  2. Verify you see both Download and Copy buttons
  3. Test that the Copy button copies the script output to your clipboard

The copy functionality is already implemented in NetBox - you're just connecting it to the script output content. No JavaScript or Python changes should be needed.

@jnovinger commented on GitHub (Sep 29, 2025): Thanks @dmismirn , assigning to you. Here's some guidance. NetBox uses a well-established pattern for copy-to-clipboard functionality that you can follow for the script output feature. How NetBox implements copy-to-clipboard: 1. **Django Template Tag**: `{% copy_content "target_id" %}` - renders a button with clipboard functionality 2. **JavaScript Library**: Uses [clipboard.js](https://clipboardjs.com/) to handle the actual clipboard operations 3. **Target Element**: Requires the content element to have an `id` attribute that matches the template tag parameter For this issue, you need to make a couple small changes, probably in `netbox/templates/extras/htmx/script_result.html`: 1. **Add an ID** to the DOM element containing the script output 2. **Add the copy template tag** after the existing download button Take a look at [`netbox/templates/extras/object_render_config.html:55-64`](https://github.com/netbox-community/netbox/blob/0b7baae23cf982c7fd9501d55974c5dc43e23835/netbox/templates/extras/object_render_config.html#L55-L64) for the pattern. Note how the DOM element `id` attribute and the argument to the `copy_content` template tag match, that's important. Before doing that, it's would be useful to read up on how Django templates and template tags work. You don't need to fully grok all of this, but it definitely helps to understand how templates and template tags work together. - [Django Template Tags Documentation](https://docs.djangoproject.com/en/stable/howto/custom-template-tags/) - [Django Templates Documentation](https://docs.djangoproject.com/en/stable/topics/templates/) Testing Your Changes: 1. Run a NetBox script that produces output 2. Verify you see both Download and Copy buttons 3. Test that the Copy button copies the script output to your clipboard The copy functionality is already implemented in NetBox - you're just connecting it to the script output content. No JavaScript or Python changes should be needed.
adam commented 2025-12-29 21:48:08 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Sep 29, 2025):

When you're done and ready to submit your work, make sure your pull request targets the main branch.

@jnovinger commented on GitHub (Sep 29, 2025): When you're done and ready to submit your work, make sure your pull request targets the `main` branch.
adam commented 2025-12-29 21:48:08 +01:00
Author
Owner
Copy Link

@dmismirn commented on GitHub (Oct 2, 2025):

@jnovinger, thanks for detailed instructions, this is my result (it tested):

...
            <div>
              <a href="?export=output" class="btn btn-sm btn-primary" role="button">
                <i class="mdi mdi-download" aria-hidden="true"></i> {% trans "Download" %}
              </a>
              {% copy_content "job_data_output" %}
            </div>
          {% endif %}
        </h2>
        {% if job.data.output %}
          <pre class="card-body font-monospace" id="job_data_output">{{ job.data.output }}</pre>
...

But I wasn't able to make pull request. I did - clone repo, add branch, commit fix in branch after that I try push to github. Actual I don't know how to push my branch to github. My local repo looks like:

$ git branch -a
  20426-add-copy-button-to-script-output-window
* main
  remotes/origin/11507-show-aggregate-and-rir-on-api
  remotes/origin/19275-fixes-interface-bulk-edit
...
@dmismirn commented on GitHub (Oct 2, 2025): @jnovinger, thanks for detailed instructions, this is my result (it tested): ``` ... <div> <a href="?export=output" class="btn btn-sm btn-primary" role="button"> <i class="mdi mdi-download" aria-hidden="true"></i> {% trans "Download" %} </a> {% copy_content "job_data_output" %} </div> {% endif %} </h2> {% if job.data.output %} <pre class="card-body font-monospace" id="job_data_output">{{ job.data.output }}</pre> ... ``` But I wasn't able to make pull request. I did - clone repo, add branch, commit fix in branch after that I try push to github. Actual I don't know how to push my branch to github. My local repo looks like: ``` $ git branch -a 20426-add-copy-button-to-script-output-window * main remotes/origin/11507-show-aggregate-and-rir-on-api remotes/origin/19275-fixes-interface-bulk-edit ... ```
adam commented 2025-12-29 21:48:09 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Oct 2, 2025):

@dmismirn , so close! From the git output you pasted, it looks maybe you skipped the "fork the repo" step in getting setup. You can read about it in our Development -> Getting Started docs. Github also has a good guide for contributing that covers forking as well.

@jnovinger commented on GitHub (Oct 2, 2025): @dmismirn , so close! From the git output you pasted, it looks maybe you skipped the "fork the repo" step in getting setup. You can read about it in our [Development -> Getting Started](https://netboxlabs.com/docs/netbox/development/getting-started/#1-fork-the-repo) docs. Github also has a good guide for contributing that [covers forking](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project#about-forking) as well.
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 complexity: low 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#11652
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?