Skip to content

Refine dialogs#470

Draft
janfaracik wants to merge 14 commits intojenkinsci:masterfrom
janfaracik:refine-dialogs
Draft

Refine dialogs#470
janfaracik wants to merge 14 commits intojenkinsci:masterfrom
janfaracik:refine-dialogs

Conversation

@janfaracik
Copy link
Copy Markdown
Member

@janfaracik janfaracik commented Mar 29, 2026

Relates to jenkinsci/jenkins#26475 and jenkinsci/jenkins#26514

This PR updates the Dialogs page in the Design Library. The intention is to push developers to using the new data-type="dialog-opener" approach to dialogs, this has several advantages:

  • Keeps the dialog code nice and separate
  • Allows us to defer loading of it until its needed
  • Will support subsequent dialogs (i.e. a wizard)
  • Developers don't need to write Javascript

I've removed the mentions of prompts and modals. Done some generic tidying up and added a fade to the code component.

GitHub has butchered the below image, click it to see it in the right aspect ratio.

dialogs

Testing done

N/A.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests that demonstrate the feature works or the issue is fixed

@janfaracik janfaracik marked this pull request as ready for review March 29, 2026 18:16
@janfaracik janfaracik requested a review from a team as a code owner March 29, 2026 18:16
@Override
public String getSince() {
return "2.426.1";
return "2.558";
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Noting this doesn't exist yet.

Not sure if this is misleading or not as dialogs have been around for awhile but the first technique is new.

Shouldn't this PR also document wizards as those PRs are introducing the feature? WDYT?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Not sure if this is misleading or not as dialogs have been around for awhile but the first technique is new.

A little misleading but dialogs haven't been implemented that much by plugins anyway, I think there'll be a big push for them once the experimental flags are on by default.

Shouldn't this PR also document wizards as those PRs are introducing the feature? WDYT?

Once they're used in core for sure.

</div>

<s:section title="Customizing the appearance and behaviour">
<s:section title="${%Customizing the appearance and behaviour}">
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There's also preventCloseOnOutsideClick could be a good time to document it?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good idea - added it

@timja timja marked this pull request as draft March 30, 2026 09:53
@timja
Copy link
Copy Markdown
Member

timja commented Mar 30, 2026

Converted to draft until core change is merged to prevent accidental merging

Comment thread pom.xml Outdated
<jenkins.baseline>2.479</jenkins.baseline>
<jenkins.version>2.541</jenkins.version>
<jenkins.baseline>2.528</jenkins.baseline>
<jenkins.version>2.557-rc38119.74eb_a_b_c6c579</jenkins.version>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

needs reverting before merge

Comment thread pom.xml
<!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
<jenkins.baseline>2.479</jenkins.baseline>
<jenkins.version>2.541</jenkins.version>
<jenkins.baseline>2.528</jenkins.baseline>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should use the latest baseline:

Suggested change
<jenkins.baseline>2.528</jenkins.baseline>
<jenkins.baseline>2.541</jenkins.baseline>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants