Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better document lib.hudson.widget-refresh #10237

Merged
merged 3 commits into from
Feb 9, 2025
Merged

Better document lib.hudson.widget-refresh #10237

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11d1fa7
Better document lib.hudson.widget-refresh
daniel-beck Feb 4, 2025
3b3c41c
Remove comment due to duplicate declaration warning
daniel-beck Feb 7, 2025
a68c9a1
Merge branch 'master' into document-widget-refresh
krisstern Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions core/src/main/resources/lib/hudson/widget-refresh.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
/**
* Use the `widget-refresh-reference` class on an element with `data-id` and `data-url` attributes.
* The content from the URL will be used to replace the element with the specified ID.
* Usually the URL content is an element with the same ID as specified here, to allow continuous updates.
* This is primarily used for sidepanel widgets, but not exclusively.
*/
Behaviour.specify(
".widget-refresh-reference",
"widget-refresh",
0,
function (e) {
var id = e.getAttribute("data-id");
var url = e.getAttribute("data-url");
let id = e.getAttribute("data-id");
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switching from var to let improves code safety

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that extra change would suit the scope for this PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR changes from var to let already, so I'm interpreting this comment as a confirmation of the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see! Thanks for clarifying.

let url = e.getAttribute("data-url");
refreshPart(id, url);
},
);
Loading