https://github.com/rust-lang/rust http://git.dreamy.place/mirrors/rust/atom?h=1.77.2 2024-01-08T16:54:05+00:00 2024-01-08T16:54:05+00:00 Michael Howell michael@notriddle.com 2024-01-08T16:27:52+00:00 urn:sha1:8b52275ee34c829a29bbb677fffd7da48d242616 Follow-up for https://github.com/rust-lang/rust/pull/119477#discussion_r1439085011 2023-12-31T15:32:15+00:00 bors bors@rust-lang.org 2023-12-31T15:32:15+00:00 urn:sha1:67b6975051b83ef2bd28f06e8467470d570aceb3 rustdoc: clean up source sidebar hide button This is a redesign of the feature, with parts pulled from https://github.com/rust-lang/rust/pull/119049 but with a button that looks more like a button and matches the one used on other sidebar pages. Preview: * http://notriddle.com/rustdoc-html-demo-8/source-sidebar-resize/src/std/lib.rs.html * http://notriddle.com/rustdoc-html-demo-8/source-sidebar-resize/std/index.html | | Before | After | |--|--|--| | Closed |  |  | Open |  |  | Mobile Closed |  |  | Mobile Open |  |  2023-12-26T21:14:28+00:00 Michael Howell michael@notriddle.com 2023-12-26T20:48:56+00:00 urn:sha1:624885d242fb8ecefa5993e834f429a635b86178 Fixes #119219 2023-12-20T02:50:53+00:00 Michael Howell michael@notriddle.com 2023-12-20T01:22:38+00:00 urn:sha1:9566db1e496e6a834529e0ffbe3397b0c0d6803a 2023-12-18T06:06:31+00:00 Michael Howell michael@notriddle.com 2023-12-18T06:06:31+00:00 urn:sha1:859bbc5deffbee7870433c541cdbeb4a4a23780f This is a redesign of the feature, with parts pulled from https://github.com/rust-lang/rust/pull/119049 but with a button that looks more like a button and matches the one used on other sidebar pages. 2023-12-15T10:51:23+00:00 Guillaume Gomez guillaume1.gomez@gmail.com 2023-12-15T10:51:23+00:00 urn:sha1:f8b92697a1c444eea01ae9e723c40a35e42ad42c rustdoc: allow resizing the sidebar / hiding the top bar Fixes #97306 Preview: http://notriddle.com/rustdoc-html-demo-4/sidebar-resize/std/index.html  ## Summary This feature adds: 1. A checkbox to the Settings popover to hide the persistent navigation bar (the sidebar on large viewports and the top bar on small ones). 2. On large viewports, it adds a resize handle to the persistent sidebar. Resizing it into nothing is equivalent to turning off the persistent navigation bar checkbox in Settings. 3. If the navigation bar is hidden, a toolbar button to the left of the search appears. Clicking it brings the navigation bar back. ## Motivation While "mobile mode" is definitely a good default, it's not the only reason people have wanted to hide the sidebar: * Some people use tiling window managers, and don't like rustdoc's current breakpoints. Changing the breakpoints might help with that, but there's no perfect solution, because there's a gap between "huge screen" and "smartphone" where reasonable people can disagree about whether it makes sense for the sidebar to be on-screen. https://github.com/rust-lang/rust/issues/97306 * Some people ask for ways to reduce on-screen clutter because it makes it easier to focus. There's not a media query for that (and if there was, privacy-conscious users would turn it off). https://github.com/rust-lang/rust/issues/59829 This feature is designed to avoid these problems. Resizing the sidebar especially helps, because it provides a way to hide the sidebar without adding a new top-level button (which would add clutter), and it provides a way to make rustdoc play nicer in complex, custom screen layouts. ## Guide and Reference-level explanation On a desktop or laptop with a mouse, resize the sidebar by dragging its right edge. On any browser, including mobile phones, the sticky top bar or side bar can be hidden from the Settings area (the button with the cog wheel, next to the search bar). When it's hidden, a convenient button will appear on the search bar's left. ## Drawbacks This adds more JavaScript code to the render blocking area. ## Rationale and alternatives The most obvious way to allow people to hide the sidebar would have been to let them "manually enter mobile mode." The upside is that it's a feature we already have. The downside is that it's actually really hard to come up with a terse description. Is it: * A Setting that forces desktop viewers to always have the mobile-style top bar? If so, how do we label it? Should it be visible on mobile, and, if so, does it just not do anything? * A persistent hide/show sidebar button, present on desktop, just like on mobile? That's clutter that I'd like to avoid. ## Prior art * The new file browser in GitHub uses a similar divider with a mouse-over indicator * mdBook and macOS Finder both allow you to resize the sidebar to nothing as a gesture to hide it * https://www.nngroup.com/articles/drag-drop/ ## Future possibilities https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/Table.20of.20contents proposes a new, second sidebar (a table of contents). How should it fit in with this feature? Should it be resizeable? Hideable? Can it be accessed on mobile? 2023-11-27T07:21:19+00:00 Matthias Krüger matthias.krueger@famsik.de 2023-11-27T07:21:19+00:00 urn:sha1:828db2860f275d3e0ce07f746fca6ffce089da68 Fix Rustdoc search docs link This link has been outdated since #112725 moved the search docs to their own page 2023-11-26T16:22:43+00:00 clubby789 jamie@hill-daniel.co.uk 2023-11-26T16:22:43+00:00 urn:sha1:4d9344d26ebe8ac6ede26ca054a57334be4299ad 2023-11-25T19:33:04+00:00 Michael Howell michael@notriddle.com 2023-11-25T19:20:03+00:00 urn:sha1:bdcf91605caf75969919ae366e5e0561dcd85ea5 According to [MDN], this function is compatible with: * Chrome 16 and Edge 12 * Firefox 9 * Safari 1.1 and iOS Safari 1 These browsers are well within our [support matrix], which requires compatibility with Chrome 118, Firefox 115, Safari 17, and Edge 119. [MDN]: https://developer.mozilla.org/en-US/docs/Web/API/Node/contains#browser_compatibility [support matrix]: https://browsersl.ist/#q=last+2+Chrome+versions%2C+last+1+Firefox+version%2C+Firefox+ESR%2C+last+1+Safari+version%2C+last+1+iOS+version%2C+last+1+Edge+version%2C+last+1+UCAndroid+version 2023-11-13T06:21:21+00:00 Michael Howell michael@notriddle.com 2023-11-13T06:21:21+00:00 urn:sha1:8b1bcc8d5ba65ecf6741436246ed27f74a71d40c This didn't show up in our local tests, because the problem is actually caused by docs.rs rewritten HTML (which relocates the classes that this code looked for from the body tag to a child div). Fixes #117290