Skip to content

feat(theme): add sidebar collapse functionality #5105

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
Sepush wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(theme): add sidebar collapse functionality #5105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 4 additions & 2 deletions src/client/theme-default/Layout.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@ import VPSidebar from './components/VPSidebar.vue'
import VPSkipLink from './components/VPSkipLink.vue'
import { useData } from './composables/data'
import { layoutInfoInjectionKey, registerWatchers } from './composables/layout'
import { useSidebarControl } from './composables/sidebar'
import { useSidebarControl, useSidebarCollapse } from './composables/sidebar'

const {
isOpen: isSidebarOpen,
open: openSidebar,
close: closeSidebar
} = useSidebarControl()

const { isCollapsed: isSidebarCollapsed } = useSidebarCollapse()

registerWatchers({ closeSidebar })

const { frontmatter } = useData()
Expand All @@ -31,7 +33,7 @@ provide(layoutInfoInjectionKey, { heroImageSlotExists })
<div
v-if="frontmatter.layout !== false"
class="Layout"
:class="frontmatter.pageClass"
:class="[frontmatter.pageClass, { 'sidebar-collapsed': isSidebarCollapsed }]"
>
<slot name="layout-top" />
<VPSkipLink />
Expand Down
13 changes: 12 additions & 1 deletion src/client/theme-default/components/VPContent.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@
import NotFound from '../NotFound.vue'
import { useData } from '../composables/data'
import { useLayout } from '../composables/layout'
import { useSidebarCollapse } from '../composables/sidebar'
import VPDoc from './VPDoc.vue'
import VPHome from './VPHome.vue'
import VPPage from './VPPage.vue'

const { page, frontmatter } = useData()
const { isHome, hasSidebar } = useLayout()
const { isCollapsed } = useSidebarCollapse()
</script>

<template>
<div
class="VPContent"
id="VPContent"
:class="{ 'has-sidebar': hasSidebar, 'is-home': isHome }"
:class="{ 'has-sidebar': hasSidebar, 'is-home': isHome, 'sidebar-collapsed': isCollapsed }"
>
<slot name="not-found" v-if="page.isNotFound"><NotFound /></slot>

Expand Down Expand Up @@ -83,6 +85,11 @@ const { isHome, hasSidebar } = useLayout()
.VPContent.has-sidebar {
margin: var(--vp-layout-top-height, 0px) 0 0;
padding-left: var(--vp-sidebar-width);
transition: padding-left 0.25s;
}

.VPContent.has-sidebar.sidebar-collapsed {
padding-left: 0;
}
}

Expand All @@ -91,5 +98,9 @@ const { isHome, hasSidebar } = useLayout()
padding-right: calc((100% - var(--vp-layout-max-width)) / 2);
padding-left: calc((100% - var(--vp-layout-max-width)) / 2 + var(--vp-sidebar-width));
}

.VPContent.has-sidebar.sidebar-collapsed {
padding-left: calc((100% - var(--vp-layout-max-width)) / 2);
}
}
</style>
8 changes: 8 additions & 0 deletions src/client/theme-default/components/VPLocalNav.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { useWindowScroll } from '@vueuse/core'
import { computed, onMounted, ref } from 'vue'
import { useData } from '../composables/data'
import { useLayout } from '../composables/layout'
import { useSidebarCollapse } from '../composables/sidebar'
import VPLocalNavOutlineDropdown from './VPLocalNavOutlineDropdown.vue'

defineProps<{
Expand All @@ -15,6 +16,7 @@ defineEmits<{

const { theme } = useData()
const { isHome, hasSidebar, headers, hasLocalNav } = useLayout()
const { isCollapsed } = useSidebarCollapse()
const { y } = useWindowScroll()

const navHeight = ref(0)
Expand All @@ -31,6 +33,7 @@ const classes = computed(() => {
return {
VPLocalNav: true,
'has-sidebar': hasSidebar.value,
'sidebar-collapsed': isCollapsed.value,
empty: !hasLocalNav.value,
fixed: !hasLocalNav.value && !hasSidebar.value
}
Expand Down Expand Up @@ -85,6 +88,11 @@ const classes = computed(() => {

.VPLocalNav.has-sidebar {
padding-left: var(--vp-sidebar-width);
transition: padding-left 0.3s ease;
}

.VPLocalNav.has-sidebar.sidebar-collapsed {
padding-left: 0;
}

.VPLocalNav.empty {
Expand Down
135 changes: 133 additions & 2 deletions src/client/theme-default/components/VPNavBar.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import { useWindowScroll } from '@vueuse/core'
import { ref, watchPostEffect } from 'vue'
import { useLayout } from '../composables/layout'
import { useSidebarCollapse } from '../composables/sidebar'
import VPNavBarAppearance from './VPNavBarAppearance.vue'
import VPNavBarExtra from './VPNavBarExtra.vue'
import VPNavBarHamburger from './VPNavBarHamburger.vue'
Expand All @@ -21,17 +22,29 @@ defineEmits<{

const { y } = useWindowScroll()
const { isHome, hasSidebar } = useLayout()
const { isCollapsed, expand } = useSidebarCollapse()

const searchRef = ref<InstanceType<typeof VPNavBarSearch> | null>(null)

const classes = ref<Record<string, boolean>>({})

watchPostEffect(() => {
classes.value = {
'has-sidebar': hasSidebar.value,
'sidebar-collapsed': isCollapsed.value,
'home': isHome.value,
'top': y.value === 0,
'screen-open': props.isScreenOpen
}
})

function handleExpand() {
expand()
}

function handleCapsuleSearch() {
searchRef.value?.openSearch()
}
</script>

<template>
Expand All @@ -43,12 +56,31 @@ watchPostEffect(() => {
<template #nav-bar-title-before><slot name="nav-bar-title-before" /></template>
<template #nav-bar-title-after><slot name="nav-bar-title-after" /></template>
</VPNavBarTitle>
<div v-if="hasSidebar && isCollapsed" class="expand-capsule">
<button
class="capsule-btn expand-btn"
@click="handleExpand"
aria-label="Expand sidebar"
title="Expand sidebar"
>
<span class="vpi-sidebar-expand capsule-icon" />
</button>
<div class="capsule-divider" />
<button
class="capsule-btn search-btn"
@click="handleCapsuleSearch"
aria-label="Search"
title="Search"
>
<span class="vpi-search capsule-icon" />
</button>
</div>
</div>

<div class="content">
<div class="content-body">
<slot name="nav-bar-content-before" />
<VPNavBarSearch class="search" />
<VPNavBarSearch ref="searchRef" :icon-only="hasSidebar && isCollapsed" class="search" />
<VPNavBarMenu class="menu" />
<VPNavBarTranslations class="translations" />
<VPNavBarAppearance class="appearance" />
Expand Down Expand Up @@ -140,6 +172,8 @@ watchPostEffect(() => {
flex-shrink: 0;
height: calc(var(--vp-nav-height) - 1px);
transition: background-color 0.5s;
display: flex;
align-items: center;
}

@media (min-width: 960px) {
Expand All @@ -152,6 +186,16 @@ watchPostEffect(() => {
width: var(--vp-sidebar-width);
height: var(--vp-nav-height);
background-color: transparent;
transition: width 0.3s ease, padding 0.3s ease;
}

.VPNavBar.has-sidebar.sidebar-collapsed .title {
padding-left: 24px;
width: auto;
}

.VPNavBar.has-sidebar.sidebar-collapsed .title :deep(.VPNavBarTitle) {
display: none;
}
}

Expand All @@ -160,6 +204,15 @@ watchPostEffect(() => {
padding-left: max(32px, calc((100% - (var(--vp-layout-max-width) - 64px)) / 2));
width: calc((100% - (var(--vp-layout-max-width) - 64px)) / 2 + var(--vp-sidebar-width) - 32px);
}

.VPNavBar.has-sidebar.sidebar-collapsed .title {
padding-left: 24px;
width: auto;
}

.VPNavBar.has-sidebar.sidebar-collapsed .title :deep(.VPNavBarTitle) {
display: none;
}
}

.content {
Expand All @@ -172,6 +225,12 @@ watchPostEffect(() => {
z-index: 1;
padding-left: var(--vp-sidebar-width);
padding-right: 32px;
transition: padding-left 0.3s ease;
}

.VPNavBar.has-sidebar.sidebar-collapsed .content {
padding-left: 0;
background-color: var(--vp-nav-bg-color);
}
}

Expand All @@ -180,6 +239,11 @@ watchPostEffect(() => {
padding-left: calc((100% - var(--vp-layout-max-width)) / 2 + var(--vp-sidebar-width));
padding-right: calc((100% - var(--vp-layout-max-width)) / 2 + 32px);
}

.VPNavBar.has-sidebar.sidebar-collapsed .content {
padding-left: 0;
background-color: var(--vp-nav-bg-color);
}
}

.content-body {
Expand All @@ -204,6 +268,11 @@ watchPostEffect(() => {
margin-right: -100vw;
padding-right: 100vw;
}

.VPNavBar.has-sidebar.sidebar-collapsed .content-body {
margin-left: -32px;
padding-left: 32px;
}
}

@media (max-width: 767px) {
Expand Down Expand Up @@ -238,6 +307,55 @@ watchPostEffect(() => {
margin-right: -8px;
}

/* Sidebar expand capsule - only show on desktop */
.expand-capsule {
display: none;
}

@media (min-width: 960px) {
.expand-capsule {
display: flex;
align-items: center;
border: 1px solid var(--vp-c-divider);
border-radius: 20px;
background: var(--vp-c-bg);
padding: 4px;
margin-left: 12px;
gap: 2px;
box-shadow: var(--vp-shadow-1);
}

.capsule-btn {
display: flex;
align-items: center;
justify-content: center;
width: 28px;
height: 28px;
border: none;
border-radius: 50%;
background: transparent;
color: var(--vp-c-text-2);
cursor: pointer;
transition: color 0.25s, background-color 0.25s;
}

.capsule-btn:hover {
color: var(--vp-c-text-1);
background: var(--vp-c-default-soft);
}

.capsule-icon {
width: 18px;
height: 18px;
}

.capsule-divider {
width: 1px;
height: 16px;
background: var(--vp-c-divider);
}
}

.divider {
width: 100%;
height: 1px;
Expand All @@ -246,12 +364,25 @@ watchPostEffect(() => {
@media (min-width: 960px) {
.VPNavBar.has-sidebar .divider {
padding-left: var(--vp-sidebar-width);
transition: padding-left 0.3s ease;
}

.VPNavBar.has-sidebar.sidebar-collapsed .divider {
padding-left: 0;
}

.VPNavBar.has-sidebar.sidebar-collapsed .divider-line {
background-color: var(--vp-c-gutter);
}
}

@media (min-width: 1440px) {
.VPNavBar.has-sidebar .divider {
padding-left: calc((100% - var(--vp-layout-max-width)) / 2 + var(--vp-sidebar-width));
padding-left: calc((100% - (var(--vp-layout-max-width) - 64px)) / 2 + var(--vp-sidebar-width) - 32px);
}

.VPNavBar.has-sidebar.sidebar-collapsed .divider {
padding-left: 0;
}
}

Expand Down
Loading
Loading