Skip to content

Fix clicking on anchors inside summary tags #91188

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

Merged
merged 1 commit into from
Nov 24, 2021

Conversation

jsha
Copy link
Contributor

@jsha jsha commented Nov 24, 2021

Fixes #91184

r? @camelid

@jsha jsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Nov 24, 2021
@rust-highfive
Copy link
Contributor

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 24, 2021
@Manishearth
Copy link
Member

@bors r+

@bors
Copy link
Collaborator

bors commented Nov 24, 2021

📌 Commit 04cb0dc has been approved by Manishearth

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 24, 2021
@@ -888,7 +888,7 @@ function hideThemeButtonState() {

onEachLazy(document.querySelectorAll(".rustdoc-toggle > summary:not(.hideme)"), function(el) {
el.addEventListener("click", function(e) {
if (e.target.tagName != "SUMMARY") {
if (e.target.tagName != "SUMMARY" && e.target.tagName != "A") {
Copy link
Member

Choose a reason for hiding this comment

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

This is definitely an improvement, but it seems somewhat fragile. Are there other tags that are used as click targets?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Buttons and forms have a default behavior on click, but those don't show up in our summaries. You're right that this feels fragile, though. Perhaps as a followup we should flip the logic and say "preventDefault if the click target is h3, h4, etc". That seems to be the usual click target in these when it's not the anchor, but need to do a little testing to confirm.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A quick check shows we'd also have to cover <div class="stab unstable"> and friends - the item-info divs.

Copy link
Member

Choose a reason for hiding this comment

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

but those don't show up in our summaries.

A quick check shows we'd also have to cover <div class="stab unstable"> and friends - the item-info divs.

I thought item-infos don't show up in the summaries either? Or do they and I'm misunderstanding?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

item-infos are currently inside the summary. The idea is that they should be shown even when the whole document is collapsed, so you can see at a glance what is deprecated, unstable, platform-specific, etc.

Those and the "notable traits" hover div are the main surprising things that are inside summaries right now.

@camelid camelid assigned Manishearth and unassigned camelid Nov 24, 2021
@camelid
Copy link
Member

camelid commented Nov 24, 2021

We want this to get in before nightly becomes beta: @bors p=1

@bors
Copy link
Collaborator

bors commented Nov 24, 2021

⌛ Testing commit 04cb0dc with merge b426445...

@bors
Copy link
Collaborator

bors commented Nov 24, 2021

☀️ Test successful - checks-actions
Approved by: Manishearth
Pushing b426445 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Nov 24, 2021
@bors bors merged commit b426445 into rust-lang:master Nov 24, 2021
@rustbot rustbot added this to the 1.58.0 milestone Nov 24, 2021
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (b426445): comparison url.

Summary: This benchmark run did not return any relevant changes.

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdoc: Can't click any links in methods that use details
7 participants