Better document lib.hudson.widget-refresh (#10237)

jenkinsci · Feb 9, 2025 · f5bbd10 · f5bbd10
2 parents 72d2b7b + a68c9a1
commit f5bbd10
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/core/src/main/resources/lib/hudson/widget-refresh.js b/core/src/main/resources/lib/hudson/widget-refresh.js
@@ -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");
+    let url = e.getAttribute("data-url");
     refreshPart(id, url);
   },
 );