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

Jump to bottom

Scaladoc: Add member position IDs to anchors in searchbar #14454

Merged
merged 3 commits into from Feb 15, 2022
Merged

Scaladoc: Add member position IDs to anchors in searchbar #14454

merged 3 commits into from Feb 15, 2022

Conversation

jchyb
Copy link
Contributor

@jchyb jchyb commented Feb 11, 2022

This PR includes following changes, each accompanied by a separate commit:

  • id location attributes were added to anchors in searchbar - this way, even if a member is located
  • searchbar will now always be closed after clicking a result - this is to keep behavior of the search result being located in a separate URL (where searchbar would always be closed) and in a different location of the same URL (where, previously, searchbar would stay open, even after snapping to a different location).
  • Linking to the internal docs via Inkuire was fixed - it felt related to the other two changes, so it's included in this PR (but I can split it up if necessary).

@jchyb
Add id attributes to anchors of members in Scaladoc searchbar
e7f7c2e 
This allows to snap to a specific member after clicking, even if it is
found under the same URL.
@jchyb
Close searchbar after clicking a result in Scaladoc
8f0640b 
Previously the searchbar would disappear automatically after going to
another URL, but would not be closed if the member was found in the
current address, even if snapped to another location. Now, both events
should result in the same outcome of searchbar closing.
@BarkingBad BarkingBad self-assigned this Feb 15, 2022
@KacperFKorban
Copy link
Member

https://scala3docstorage.blob.core.windows.net/pr-searchbar-anchors/scala3/api/index.html

KacperFKorban
KacperFKorban approved these changes Feb 15, 2022
View reviewed changes
Copy link
Member

@KacperFKorban KacperFKorban left a comment

Choose a reason for hiding this comment

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

Looks good to me. Great job 😃

scaladoc/src/dotty/tools/scaladoc/tasty/InkuireSupport.scala Outdated Show resolved Hide resolved
BarkingBad
BarkingBad approved these changes Feb 15, 2022
View reviewed changes
Copy link
Member

@BarkingBad BarkingBad left a comment

Choose a reason for hiding this comment

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

LGTM

@jchyb
Fix anchors in Inkuire results in Scaladoc
91e3e99 
Previously, non-external pages would not be linked in Scaladoc if
searched using Inkuire. Now it should behave similarly to standard
searching by symbolic name, with results linking to specific member
locations on pages.
@pikinier20
Copy link
Contributor

Good job!

@KacperFKorban KacperFKorban merged commit 37e997a into scala:main Feb 15, 2022
@Kordyjan Kordyjan added this to the 3.1.3 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BarkingBad BarkingBad BarkingBad approved these changes

@KacperFKorban KacperFKorban KacperFKorban approved these changes

Assignees

@BarkingBad BarkingBad

Labels
None yet
Projects
None yet
Milestone
3.1.3
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@jchyb @KacperFKorban @pikinier20 @BarkingBad @Kordyjan