Skip to content

Make sidebar slide in and slide out #698

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 11 commits into
base: master
Choose a base branch
from
Open

Make sidebar slide in and slide out #698

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
df4b1d5
Make sidebar slide in and slide out
dojutsu-user Nov 4, 2018
3eb5328
Add swiping functionality
dojutsu-user Nov 6, 2018
30a32e4
Hide overflow-x
dojutsu-user Nov 6, 2018
c6be05e
Add improvements
dojutsu-user Nov 6, 2018
6d2d3ea
Add 'prefixer' mixin in _theme_badge
dojutsu-user Nov 6, 2018
9f890fe
Remove transform:
dojutsu-user Dec 7, 2018
677363b
Make sidebar swipe with native js
dojutsu-user Dec 7, 2018
d7cefb9
Update the if condition
jessetan Dec 7, 2018
d2d53a0
Revert back the if-check
dojutsu-user Dec 7, 2018
4a4e99d
condition on if check
dojutsu-user Dec 19, 2018
68d3109
Merge branch 'master' into sidebar-responsive-sliding
dojutsu-user Jan 17, 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
30 changes: 30 additions & 0 deletions js/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,33 @@ if (typeof(window) != 'undefined') {
clearTimeout(id);
};
}());

// function for opening/closing sidebar on
// swiping right/close.
(function () {
var start = null;
window.addEventListener("touchstart",function(event){
if(event.touches.length === 1){
start = event.touches.item(0).clientX;
} else {
start = null;
}
});

window.addEventListener("touchend",function(event){
var offset = 100;
if(start) {
var end = event.changedTouches.item(0).clientX;
if(end > start + offset) {
document.getElementById("shift-nav-side").classList.add("shift");
document.getElementById("shift-nav-content-side").classList.add("shift");
document.getElementById("rst-versions-id").classList.add("shift");
}
if(end < start - offset ){
document.getElementById("shift-nav-side").classList.remove("shift");
document.getElementById("shift-nav-content-side").classList.remove("shift");
document.getElementById("rst-versions-id").classList.remove("shift");
}
}
});
}())
5 changes: 4 additions & 1 deletion sass/_theme_badge.sass
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@
+media($tablet)
.rst-versions
width: 85%
display: none
transform: $sidebar-transform-hide
transition: $sidebar-transition
&.shift
display: block
transform: $sidebar-transform-show
transition: $sidebar-transition
11 changes: 9 additions & 2 deletions sass/_theme_layout.sass
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ html
position: absolute
width: 100%
height: 100%
overflow-x: hidden

.wy-nav-side
position: fixed
Expand Down Expand Up @@ -370,12 +371,15 @@ footer
display: block
.wy-nav-side
@if $nav-desktop-position == left
left: -$nav-desktop-width
transform: $sidebar-transform-hide
transition: $sidebar-transition
@else
right: -$nav-desktop-width
&.shift
width: 85%
left: 0
transform: $sidebar-transform-show
transition: $sidebar-transition
.wy-side-scroll
width: auto
.wy-side-nav-search
Expand All @@ -384,15 +388,18 @@ footer
width: auto
.wy-nav-content-wrap
margin-left: 0
transform: $sidebar-transform-show
transition: $sidebar-transition
.wy-nav-content
padding: $gutter
&.shift
position: fixed
min-width: 100%
left: 85%
top: 0
height: 100%
overflow: hidden
transform: translateX(85%)
transition: $sidebar-transition

@media screen and (min-width: $nav-media-query)
.wy-nav-content-wrap
Expand Down
5 changes: 5 additions & 0 deletions sass/_theme_variables.sass
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ $nav-link-color-visited: $purple
$nav-link-color-hover: lighten($nav-link-color, 6%) !default
$nav-link-color-alt: hsl(33, 100%, 51%)

// Sidebar
$sidebar-transform-hide: translateX(-100%)
$sidebar-transform-show: translateX(0%)
$sidebar-transition: transform 0.3s ease

// Sidebar colors
$sidebar-background-color: $table-stripe-color
$sidebar-border-color: $table-border-color
Expand Down
4 changes: 2 additions & 2 deletions sphinx_rtd_theme/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<div class="wy-grid-for-nav">

{# SIDE NAV, TOGGLES ON MOBILE #}
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<nav data-toggle="wy-nav-shift" class="wy-nav-side" id="shift-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
{% block sidebartitle %}
Expand Down Expand Up @@ -145,7 +145,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap" id="shift-nav-content-side">

{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
<nav class="wy-nav-top" aria-label="top navigation">
Expand Down
2 changes: 1 addition & 1 deletion sphinx_rtd_theme/versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% if READTHEDOCS %}
{# Add rst-badge after rst-versions for small badge style. #}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions" id="rst-versions-id">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: {{ current_version }}
Expand Down