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

Bug: Docs site "return to top" button overlaps language dropdown #17646

Closed
nzakas opened this issue Oct 13, 2023 · 12 comments · Fixed by #17688
Closed

Bug: Docs site "return to top" button overlaps language dropdown #17646

nzakas opened this issue Oct 13, 2023 · 12 comments · Fixed by #17688
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation

Comments

@nzakas
Copy link
Member

nzakas commented Oct 13, 2023

On the docs site, if you scroll all the way down on a page in a desktop browser, the "return to top" button overlaps the controls on the lower-right.
Screenshot 2023-10-13 at 11-44-32 Getting Started with ESLint - ESLint - Pluggable JavaScript Linter

I'm not sure how to fix this. Maybe the button should appear to the left of that vertical line? Maybe it should stop before all of the controls in the lower right? Other ideas?

@nzakas nzakas added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Oct 13, 2023
@Tanujkanti4441
Copy link
Contributor

Tanujkanti4441 commented Oct 14, 2023

We may shift the button a bit higher so it can be placed just between the theme switcher and language switcher.

@harish-sethuraman
Copy link
Member

harish-sethuraman commented Oct 16, 2023

I'm not sure how to fix this. Maybe the button should appear to the left of that vertical line?

I also align with doing this as we do this in mobile. having it in content seems better than shifting the positions in controls. Lets once check on how the UI looks also.

@nzakas
Copy link
Member Author

nzakas commented Oct 16, 2023

@Tanujkanti4441 I think we would end up with the same problem, only the button would overlap the controls above it depending on the vertical scroll position.

@Tanujkanti4441
Copy link
Contributor

@Tanujkanti4441 I think we would end up with the same problem, only the button would overlap the controls above it depending on the vertical scroll position.

Agreed! It will somehow overlap the controls. Then if we planning to make it appear on the left of the vertical line i am with @harish-sethuraman we first should check how it is appearing there. And for mobile we can keep it's position as it is currently.

@nzakas
Copy link
Member Author

nzakas commented Oct 16, 2023

Agreed. We always want to see how things look first before making a change.

@Tanujkanti4441
Copy link
Contributor

Here are the screenshots after shifting the return to top button to the left of the vertical line.

screenshot 1

Annotation 2023-10-23 130725

screenshot 2

Annotation 2023-10-23 135328

screenshot 3

Screenshot 2023-10-23 at 13-29-16 Configuration Migration Guide - ESLint - Pluggable JavaScript Linter

screenshot for below 1024px screen size

screenshot 1

Annotation 2023-10-23 133219

screenshot 2

Annotation 2023-10-23 133340

For me it's looking good.
In this case (left of the vertical line) this button could have looked mysterious as it is somewhere in the middle of the screen but that vertical line saves it from looking such.

@nzakas
Copy link
Member Author

nzakas commented Oct 23, 2023

Thanks for putting that together. I think the button overlapping the code sample is problematic because that's the area that we have the "Open in Playground" button on the rules documentation pages. 🤔

@Tanujkanti4441
Copy link
Contributor

Thanks for putting that together. I think the button overlapping the code sample is problematic because that's the area that we have the "Open in Playground" button on the rules documentation pages. 🤔

yes, for the screen below 1024px it is overlapping the playground button, but not completely.

Annotation 2023-10-23 205748

Even if we see in mobile size it is overlapping the texts or playground button. and in these cases users just have to scroll a bit.

Or alternatively we can shift that button to the right of the screen.

@nzakas
Copy link
Member Author

nzakas commented Oct 25, 2023

I think it's okay if the button overlaps things you can't click, I just don't want it overlapping things you can click. Maybe something like this?
Screenshot 2023-10-25 at 17-01-12 Documentation - ESLint - Pluggable JavaScript Linter

@Tanujkanti4441
Copy link
Contributor

I think it's okay if the button overlaps things you can't click, I just don't want it overlapping things you can click. Maybe something like this?

if this is the case we can shift button's position on different frame size easily. but not sure about if we compromising with UI.

i have also tried an approach please have a look.

we can place that button to the corner of the right side like this

Screenshot 2023-10-26 at 16-56-30 no-console - ESLint - Pluggable JavaScript Linter

and can increase it's width on hovering.

Screenshot 2023-10-26 at 17-02-21 no-console - ESLint - Pluggable JavaScript Linter

even if we apply it for the mobile also then it will prevent the playground button to be overlapped.

Screenshot 2023-10-26 at 17-07-43 no-console - ESLint - Pluggable JavaScript Linter

@nzakas
Copy link
Member Author

nzakas commented Oct 26, 2023

Hmmm, I'm not a fan of attaching the button to the right margin. It's too easy to miss.

@Tanujkanti4441
Copy link
Contributor

It's too easy to miss.

Possible!
Then i make PR based on above discussion.

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 2, 2024
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label May 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants