Skip to content

Scaladoc: CSS fixes #12461

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 3 commits into from
Jun 16, 2021
Merged

Scaladoc: CSS fixes #12461

merged 3 commits into from
Jun 16, 2021

Conversation

pikinier20
Copy link
Contributor

@pikinier20 pikinier20 commented May 13, 2021

closes #12335
closes #12098

Current output will be uploaded to our server as a part of CI so I'll paste the link to it there.

@Katrix @nicolasstucki

@pikinier20
Copy link
Contributor Author

Copy link
Contributor

@romanowski romanowski left a comment

Choose a reason for hiding this comment

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

The only isssue I see is that search and menu button should be sticky.

Is that intentional that on narrower screen search button loose the red gradient background?

@pikinier20
Copy link
Contributor Author

The only issue I see is that search and menu button should be sticky.

Is that intentional that on narrower screen search button loose the red gradient background?

Yes, it's intentional. I'm not an author of this CSS rule, though.

I'm gonna take a look at search button because it hides halfway on scroll.

@TheElectronWill
Copy link
Contributor

TheElectronWill commented May 25, 2021

The word-wrapping in the sidebar is a bit inconsistent, see the "Other Changed Features" here:

Screenshot_20210525-133131~2.png

Screenshot_20210525-133159~2.png

Otherwise LGTM :)

@BarkingBad BarkingBad linked an issue May 27, 2021 that may be closed by this pull request
@pikinier20 pikinier20 force-pushed the scaladoc/site-css-fix branch from b6da347 to e7fae8a Compare May 27, 2021 10:47
@pikinier20
Copy link
Contributor Author

@TheElectronWill Could you take a look at my latest commit?

Copy link
Contributor

@TheElectronWill TheElectronWill left a comment

Choose a reason for hiding this comment

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

I've found a fix for the wrapping difference between selected and unselected entries (see suggestions). It would be cleaner to use ch instead of ex but that's good enough (and slightly more portable).

Word-wrapping seem to work fine in Firefox and Chrome without all the hints generated by Ux, I think it can be safely removed.
The new footer LGTM :)

@pikinier20
Copy link
Contributor Author

pikinier20 commented May 30, 2021

Word-wrapping seem to work fine in Firefox and Chrome without all the hints generated by Ux, I think it can be safely removed.

But it doesn't work properly for package names and long class names because there's no spaces and browser wraps text in random place. Wrapping before dots and upper cases looks better for me

@pikinier20 pikinier20 force-pushed the scaladoc/site-css-fix branch from e7fae8a to 8968013 Compare May 31, 2021 07:14
@Katrix
Copy link
Contributor

Katrix commented May 31, 2021

Wrapping looks good in theory, but not sure I'm a fan of how much wrapping there is. Feel like for any Scaladoc generated like this will see wrapping, and that is to me a sign that the sidebar should maybe be a bit wider? For comparision, Scaladoc for 2.13 is a tree, so it doesn't have to worry too much about it. Javadoc in the sidebar (that they no longer generate sadly) uses fontsize 12 (think Scaladoc's font size is better here) and a sidebar width of 30%.

For me a width of 20% looks good, but that would have to be tweaked on smaller screens.

@TheElectronWill
Copy link
Contributor

Word-wrapping seem to work fine in Firefox and Chrome without all the hints generated by Ux, I think it can be safely removed.

But it doesn't work properly for package names and long class names because there's no spaces and browser wraps text in random place. Wrapping before dots and upper cases looks better for me

Oh so that was the point! In that case yes, it's useful.

@pikinier20 pikinier20 force-pushed the scaladoc/site-css-fix branch from 0b1a5db to 9a20975 Compare June 15, 2021 22:41
@pikinier20 pikinier20 linked an issue Jun 15, 2021 that may be closed by this pull request
@pikinier20 pikinier20 merged commit b5def4d into master Jun 16, 2021
@pikinier20 pikinier20 deleted the scaladoc/site-css-fix branch June 16, 2021 09:23
@Kordyjan Kordyjan added this to the 3.0.2 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scaladoc's search is not usable on iPhone On narrow screens with Scaladoc, close sidebar and search can overlap Navigation items in docs overflow
5 participants