Skip to content

feat: Sidebar toggle. #761

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

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ module.exports = {
}
],
sidebar: {
toggle: {
hideText: 'Hide sidebar',
showText: 'Show sidebar'
},
'/guide/': genSidebarConfig('Guide')
}
},
Expand Down Expand Up @@ -98,6 +102,10 @@ module.exports = {
}
],
sidebar: {
toggle: {
hideText: '隐藏边栏',
showText: '显示侧边栏'
},
'/zh/guide/': genSidebarConfig('指南')
}
}
Expand Down
1 change: 1 addition & 0 deletions lib/default-theme/Layout.vue
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
<Page
v-else
:sidebar-items="sidebarItems"
ref="page"
>
<slot
name="page-top"
Expand Down
4 changes: 3 additions & 1 deletion lib/default-theme/Sidebar.vue
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,19 @@
</li>
</ul>
<slot name="bottom"/>
<SidebarToggle/>
</div>
</template>

<script>
import SidebarGroup from './SidebarGroup.vue'
import SidebarLink from './SidebarLink.vue'
import SidebarToggle from './SidebarToggle.vue'
import NavLinks from './NavLinks.vue'
import { isActive } from './util'

export default {
components: { SidebarGroup, SidebarLink, NavLinks },
components: { SidebarGroup, SidebarLink, SidebarToggle, NavLinks },

props: ['items'],

Expand Down
128 changes: 128 additions & 0 deletions lib/default-theme/SidebarToggle.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
<template>
<div
class="sidebar__toggle"
v-if="!isToggleHidden">
<span class="arrow"
:class="[isSidebarHidden ? 'right' : 'left']"/>
<span class="sidebar__toggle-label" @click="toggleSidebar()">
{{ isSidebarHidden ? this.showTextLabel : this.hideTextLabel }}
</span>
</div>
</template>

<script>
export default {
data () {
return {
isSidebarHidden: false,
isToggleHidden: false,
pageClassList: null,
sidebarClassList: null,
showTextLabel: null,
hideTextLabel: null
}
},
methods: {
getSidebarToggleLabels () {
try {
this.showTextLabel = this.$themeLocaleConfig.sidebar.toggle.showText
this.hideTextLabel = this.$themeLocaleConfig.sidebar.toggle.hideText
}
catch {
this.showTextLabel = 'Show sidebar'
this.hideTextLabel = 'Hide sidebar'
}
},
setPageClassList () {
this.pageClassList = this.$parent.$parent.$refs.page.$el.classList
},
setSidebarClassList () {
this.sidebarClassList = this.$parent.$el.classList
},
toggleSidebar () {
this.setPageClassList()
this.setSidebarClassList()

if (this.isSidebarHidden) {
this.sidebarClassList.remove('shrink')
this.pageClassList.remove('widen')
} else {
this.sidebarClassList.add('shrink')
this.pageClassList.add('widen')
}

this.isSidebarHidden = !this.isSidebarHidden
},
},
mounted () {
this.getSidebarToggleLabels()
},
watch: {
'$route' () {
if (!Object.keys(this.$site.themeConfig.locales).includes(this.$route.path)) {
this.setPageClassList()
this.setSidebarClassList()
this.getSidebarToggleLabels()
if (this.sidebarClassList.contains('shrink')) {
this.pageClassList.add('widen')
}
}
}
}
}
</script>

<style lang="stylus">
@import './styles/config.styl'

.page
transition all .2s ease
&.widen
padding-left 0rem

.content
position relative

.sidebar
white-space nowrap
transition all .2s ease

&__toggle
transition all .2s ease
padding-right .25rem
display inline-block
position fixed
top 0
left 16.4rem
height 100%
writing-mode vertical-lr
text-align center
@media (min-width: $MQNarrow)
left 20rem

&-label
cursor pointer
font-size small
font-weight 500
color lighten($textColor, 25%)
margin-left .25rem

&.shrink
margin-left -16.4rem
@media (min-width: $MQNarrow)
margin-left -20rem
& > ^[0]__toggle
transition all .2s ease
left 0


::-webkit-scrollbar
width 5px
height @width

::-webkit-scrollbar-track
background $borderColor

::-webkit-scrollbar-thumb
background $accentColor
</style>