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.

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

JDK-8275889: Search dialog has redundant scrollbars #16731

Closed
wants to merge 2 commits into from

Conversation

hns
Copy link
Member

@hns hns commented Nov 20, 2023

Please review a fix for multiple issues that caused a horizontal scrollbar to appear on the list of search results in JavaDoc-generated documentation even when not required by the list content. The problems are described in more detail in the JBS issue, but to summarize:

  • Our category headers contained horizontal padding which was added to the width of 100%. This is solved by adding box-sizing: border-box where necessary.
  • The selected item is shown with a negative margin and positive border to work around a browser bug, which also caused horizontal overflow. This is solved by only applying the margin and border to the vertical axis.

For the second fix it was also necessary to change the order in which stylesheets are loaded in HTML files in order to be able to override declarations in the JQuery-UI stylesheet.

I also added a little bit of vertical padding to result list items as the list looked very crammed to me. Generated documentation (top-level files only) can be viewed at the URL below. Search results should not display a horizontal scrollbar unless required by the contents of the list.

https://cr.openjdk.org/~hannesw/8275889/api.00/


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8275889: Search dialog has redundant scrollbars (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16731/head:pull/16731
$ git checkout pull/16731

Update a local copy of the PR:
$ git checkout pull/16731
$ git pull https://git.openjdk.org/jdk.git pull/16731/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16731

View PR using the GUI difftool:
$ git pr show -t 16731

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16731.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 20, 2023

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 20, 2023
@openjdk
Copy link

openjdk bot commented Nov 20, 2023

@hns The following label will be automatically applied to this pull request:

  • javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.org label Nov 20, 2023
@mlbridge
Copy link

mlbridge bot commented Nov 20, 2023

Webrevs

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

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

Ugh for the underlying problem.

@openjdk
Copy link

openjdk bot commented Nov 20, 2023

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8275889: Search dialog has redundant scrollbars

Reviewed-by: jjg

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 13 new commits pushed to the master branch:

  • a2c0fa6: 8320372: test/jdk/sun/security/x509/DNSName/LeadingPeriod.java validity check failed
  • 3aefd1c: 8320234: Merge doclint.Env.AccessKind with tool.AccessKind
  • d6d7bdc: 8319817: Charset constructor should make defensive copy of aliases
  • 0712b22: 8320147: Remove DumpSharedSpaces
  • 6e86904: 8319973: AArch64: Save and restore FPCR in the call stub
  • 04fd17e: 8320410: Reflow markdown in building.md
  • 7f23110: 8319928: Exceptions thrown by cleanup actions should be handled correctly
  • a6098e4: 8320280: RISC-V: Avoid passing t0 as temp register to MacroAssembler::lightweight_lock/unlock
  • 60c8d9c: 8320300: Adjust hs_err output in malloc/mmap error cases
  • 9f6a4a3: 8320386: Remove java/nio/channels/vthread/BlockingChannelOps.java#direct-register from ProblemList
  • ... and 3 more: https://git.openjdk.org/jdk/compare/179f505258565408fe10e9047bb5e7cf120c8f6e...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 20, 2023
@hns
Copy link
Member Author

hns commented Nov 20, 2023

/integrate

@openjdk
Copy link

openjdk bot commented Nov 20, 2023

Going to push as commit 30d8953.
Since your change was applied there have been 15 commits pushed to the master branch:

  • cee54de: 8319988: Wrong heading for inherited nested classes
  • 32098ce: 8320348: test/jdk/java/io/File/GetAbsolutePath.windowsDriveRelative fails if working directory is not on drive C
  • a2c0fa6: 8320372: test/jdk/sun/security/x509/DNSName/LeadingPeriod.java validity check failed
  • 3aefd1c: 8320234: Merge doclint.Env.AccessKind with tool.AccessKind
  • d6d7bdc: 8319817: Charset constructor should make defensive copy of aliases
  • 0712b22: 8320147: Remove DumpSharedSpaces
  • 6e86904: 8319973: AArch64: Save and restore FPCR in the call stub
  • 04fd17e: 8320410: Reflow markdown in building.md
  • 7f23110: 8319928: Exceptions thrown by cleanup actions should be handled correctly
  • a6098e4: 8320280: RISC-V: Avoid passing t0 as temp register to MacroAssembler::lightweight_lock/unlock
  • ... and 5 more: https://git.openjdk.org/jdk/compare/179f505258565408fe10e9047bb5e7cf120c8f6e...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 20, 2023
@openjdk openjdk bot closed this Nov 20, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 20, 2023
@openjdk
Copy link

openjdk bot commented Nov 20, 2023

@hns Pushed as commit 30d8953.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
2 participants