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

Update progressiveText.jelly with documentation tag #10085

Merged
merged 2 commits into from
Dec 24, 2024
Merged

Update progressiveText.jelly with documentation tag #10085

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2437b6
Update progressiveText.jelly with documentation tag
duemir Dec 20, 2024
09d24d7
A few remaining tags with old documentation style were updated
duemir Dec 21, 2024
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: 10 additions & 0 deletions core/src/main/resources/lib/hudson/progressiveText.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ THE SOFTWARE.
-->
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
<st:documentation>
Use AJAX to load text data progressively.
This is used to achieve the effect of "tail -f"
without relying on full page reload.
<st:attribute name="href" use="required">URL that returns text data</st:attribute>
<st:attribute name="idref" use="required">ID of the HTML element in which the result is displayed</st:attribute>
duemir marked this conversation as resolved.
Show resolved Hide resolved
<st:attribute name="spinner" required="false">ID of the HTML element in which the spinner is displayed</st:attribute>
<st:attribute name="startOffset" required="false">Skip this many bytes rather than showing from start of data</st:attribute>
<st:attribute name="onFinishEvent" required="false">JS custom event to be fired when progress is finished</st:attribute>
duemir marked this conversation as resolved.
Show resolved Hide resolved
</st:documentation>
<div class="progressiveText-holder" data-href="${href}" data-idref="${idref}" data-spinner="${spinner}" data-start-offset="${startOffset}"
data-on-finish-event="${empty(onFinishEvent) ? '' : onFinishEvent}"
data-error-message="${%errorMessage}"/>
Expand Down
Loading