Skip to content

Decouple menu expand and collapse from active item #692

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Decouple menu expand and collapse from active item #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8c6c503
Decouple menu expand and collapse from active item
jessetan Oct 26, 2018
597655c
Merge branch 'master' into decouple-menu-current-and-expand
jessetan Dec 7, 2018
3d2d0ea
Remove commented out code
jessetan Feb 27, 2019
aa56a59
Merge branch 'master' into decouple-menu-current-and-expand
jessetan Feb 27, 2019
b79bb2c
Merge branch 'master' into decouple-menu-current-and-expand
jessetan Jul 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,21 @@ Changelog
master
======

:Date: TBD

New Features
-------------

Fixes
-----

* Clicking active menu item no longer makes it look inactive (#306)
* Fix definition lists looking different with Sphinx 2.0+

Other Changes
--------------

* Menu items can now expand and collapse regardless of active item
* Add the ``navigation`` template block around the navigation area.

0.4.3
Expand All @@ -26,6 +30,7 @@ Other Changes
New Features
-------------


Fixes
-----

Expand All @@ -34,7 +39,6 @@ Fixes
* Fix inconsistent font size and line height for autodoc "raises" and "returns" (#267)
* Fix last_updated notice appearing in same line as copyright notice (#704)


Other Changes
--------------

Expand Down
36 changes: 25 additions & 11 deletions js/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ function ThemeNav () {
$("[data-toggle='wy-nav-shift']").removeClass("shift");
$("[data-toggle='rst-versions']").toggleClass("shift");
// Handle dynamic display of l3 and l4 nav lists
self.toggleCurrent(target);
self.setCurrent(target);
self.toggleExpanded(target, true);
self.hashChange();
})
.on('click', "[data-toggle='rst-current-version']", function() {
Expand All @@ -114,7 +115,7 @@ function ThemeNav () {
var link = $(this);
expand = $('<span class="toctree-expand"></span>');
expand.on('click', function (ev) {
self.toggleCurrent(link);
self.toggleExpanded(link);
ev.stopPropagation();
return false;
Copy link

Choose a reason for hiding this comment

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

false

});
Expand Down Expand Up @@ -146,12 +147,14 @@ function ThemeNav () {
if (link.length > 0) {
$('.wy-menu-vertical .current').removeClass('current');
link.addClass('current');
link.closest('li.toctree-l1').addClass('current');
link.closest('li.toctree-l1').parent().addClass('current');
link.closest('li.toctree-l1').addClass('current');
link.closest('li.toctree-l2').addClass('current');
link.closest('li.toctree-l3').addClass('current');
link.closest('li.toctree-l4').addClass('current');

link.closest('li.toctree-l1').addClass('current expanded');
link.closest('li.toctree-l1').parent().addClass('current expanded');
link.closest('li.toctree-l1').addClass('current expanded');
link.closest('li.toctree-l2').addClass('current expanded');
link.closest('li.toctree-l3').addClass('current expanded');
link.closest('li.toctree-l4').addClass('current expanded');

link[0].scrollIntoView();
}
}
Expand Down Expand Up @@ -187,13 +190,24 @@ function ThemeNav () {
});
};

nav.toggleCurrent = function (elem) {
nav.toggleExpanded = function (elem, forceExpanded) {
var parent_li = elem.closest('li');
if (forceExpanded) {
parent_li.addClass('expanded');
} else {
parent_li.toggleClass('expanded');
}
};

nav.setCurrent = function (elem) {
var parent_li = elem.closest('li');
// Remove 'current' status from all li at parent level and lower
parent_li.siblings('li.current').removeClass('current');
parent_li.siblings().find('li.current').removeClass('current');
parent_li.find('> ul li.current').removeClass('current');
parent_li.toggleClass('current');
}
// Make our parent 'current'
parent_li.addClass('current');
};

return nav;
};
Expand Down
103 changes: 46 additions & 57 deletions sass/_theme_layout.sass
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,17 @@ html
border-bottom: solid 1px hsl(0, 0%, 25%)
&.current
background: darken($menu-vertical-background-color, 10%)
&.current
a
color: $menu-link-medium
border-right: solid 1px darken($menu-vertical-background-color, 20%)
padding: $gutter / 4 $gutter * 1.5
&:hover
background: darken($menu-vertical-background-color, 15%)
code
border: none
background: inherit
color: inherit
padding-left: 0
padding-right: 0
// Expand links

// Collapse/Expand icons
span.toctree-expand
display: block
float: left
Expand All @@ -74,76 +72,67 @@ html
font-size: .8em
line-height: 1.6em
color: darken($menu-link-medium, 20%)
&.expanded > a span.toctree-expand
@extend .fa-minus-square-o

// On state for the first level
li.on a, li.current > a
color: $menu-link-color
// Expanded state for the first level
li.expanded > a
padding: $gutter / 4 $gutter
font-weight: bold
position: relative
background: $menu-vertical-background-color
border: none
padding-left: $gutter -4px
// Current/on state for first level
li.current > a
color: $menu-link-color
font-weight: bold
background: $menu-vertical-background-color
+font-smooth
&:hover
background: $menu-vertical-background-color
span.toctree-expand
color: $menu-link-medium
span.toctree-expand
@extend .fa
@extend .fa-minus-square-o
display: block
font-size: .8em
line-height: 1.6em
color: darken($menu-link-medium, 30%)

li.toctree-l1.current > a
// Background and border for first level when both expanded and current
li.toctree-l1.current.expanded > a
border-bottom: solid 1px darken($menu-vertical-background-color, 20%)
border-top: solid 1px darken($menu-vertical-background-color, 20%)
&:hover
border-color: lighten($menu-background-color, 10%)

// This is the on state for pages beyond second level
li.toctree-l2 a, li.toctree-l3 a, li.toctree-l4 a
// Menu link color and hover behavior
li.toctree-l1.current a, li.toctree-l2.current a, li.toctree-l3.current a, li.toctree-l4.current a
color: $menu-link-color
li.toctree-l1.current li.toctree-l2, li.toctree-l2.current li.toctree-l3
&:hover
color: $menu-link-light
background-color: lighten($menu-background-color, 10%)

// Colored background when current
li.toctree-l2.current a
background: darken($menu-vertical-background-color, 20%)
li.toctree-l3.current a
background: darken($menu-vertical-background-color, 25%)

// Collapse/expand behavior
li.expanded > ul
display: block
li > ul
margin-bottom: 0
display: none
li.toctree-l1.expanded li.toctree-l2, li.toctree-l2.expanded li.toctree-l3
> ul
display: none
&.current > ul
display: block
li.toctree-l2
&.current
> a
background: darken($menu-vertical-background-color, 20%)
padding: $gutter / 4 $gutter * 1.5
li.toctree-l3 > a
&.expanded
> ul
display: block
background: darken($menu-vertical-background-color, 20%)
padding: $gutter / 4 $gutter * 2.5
a:hover span.toctree-expand
color: $menu-link-medium
span.toctree-expand
color: darken($menu-vertical-background-color, 35%)

// Font size and indentation for levels > 1
li.toctree-l2
> a
padding: $gutter / 4 $gutter * 1.5
li.toctree-l3
font-size: .9em
&.current
> a
background: darken($menu-vertical-background-color, 25%)
padding: $gutter / 4 $gutter * 2.5
li.toctree-l4 > a
display: block
background: darken($menu-vertical-background-color, 25%)
padding: $gutter / 4 $gutter * 3.5
a:hover span.toctree-expand
color: $menu-link-medium
span.toctree-expand
color: darken($menu-vertical-background-color, 40%)
> a
padding: $gutter / 4 $gutter * 2.5
li.toctree-l4
font-size: .9em
> a
padding: $gutter / 4 $gutter * 3.5

li.current ul
display: block
li ul
margin-bottom: 0
display: none
li ul li a
margin-bottom: 0
color: $menu-link-light
Expand Down