Skip to content

Use headings and nav for sidebars #696

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

Merged
merged 1 commit into from
Apr 16, 2025
Merged

Use headings and nav for sidebars #696

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
5 changes: 3 additions & 2 deletions docs/.vuepress/theme/components/LeftBar.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<template>
<aside class="left-bar">
<nav class="left-bar" aria-labelledby="main-nav-heading">
<h2 id="main-nav-heading" class="sr-only">Sidebar</h2>
<div class="wrap">
<div id="top" class="h-12 flex items-center">
<RouterLink :to="`/`" ref="siteName" class="site-name font-bold px-4 mt-1">{{ $siteTitle }}</RouterLink>
Expand Down Expand Up @@ -63,7 +64,7 @@
</div>
</transition>
</div>
</aside>
</nav>
</template>

<style lang="postcss">
Expand Down
4 changes: 3 additions & 1 deletion docs/.vuepress/theme/components/RightBar.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
<div class="switch-wrapper hidden xl:block">
<ColorModeSwitch v-on="$listeners" :on="isDark" />
</div>
<nav class="sidebar-link-wrapper">
<nav class="sidebar-link-wrapper" aria-labelledby="right-bar-nav-heading">
<SidebarLinks
:depth="depth"
:sidebar-depth="$page.frontmatter.sidebarDepth || sidebarDepth"
:items="headingItems"
fixed-heading="On this Page"
fixed-heading-id="right-bar-nav-heading"
heading-level="h2"
/>
</nav>
</div>
Expand Down
100 changes: 62 additions & 38 deletions docs/.vuepress/theme/components/SidebarGroup.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,42 @@
`depth-${depth}`,
]"
>
<RouterLink
v-if="item.path"
class="sidebar-heading clickable"
:class="{
open,
active: isActive($route, item.path),
}"
:to="item.path"
@click.native="$emit('toggle')"
<component
:id="fixedHeadingId"
:is="headingLevel"
>
<span>{{ item.title }}</span>
<span v-if="collapsible" class="arrow" :class="open ? 'down' : 'right'" />
</RouterLink>

<button
v-else-if="collapsible"
class="sidebar-heading"
:class="{ open }"
@click="$emit('toggle')"
>
<span>{{ fixedHeading || item.title }}</span>
<span class="arrow" :class="open ? 'down' : 'right'" />
</button>

<p
v-else
class="sidebar-heading"
:class="{ open }"
>
<span>{{ fixedHeading || item.title }}</span>
</p>
<RouterLink
v-if="item.path"
class="sidebar-heading clickable"
:class="{
open,
active: isActive($route, item.path),
}"
:to="item.path"
@click.native="$emit('toggle')"
>
<span>{{ item.title }}</span>
<span v-if="collapsible" class="arrow" :class="open ? 'down' : 'right'" />
</RouterLink>

<button
v-else-if="collapsible"
class="sidebar-heading"
:class="{ open }"
@click="$emit('toggle')"
>
<span>{{ fixedHeading || item.title }}</span>
<span class="arrow" :class="open ? 'down' : 'right'" />
</button>

<p
v-else
class="sidebar-heading"
:class="{ open }"
>
<span>{{ fixedHeading || item.title }}</span>
</p>
</component>

<DropdownTransition>
<SidebarLinks
Expand All @@ -64,14 +69,33 @@ export default {
DropdownTransition,
},

props: [
"item",
"open",
"collapsible",
"depth",
"sidebarDepth",
"fixedHeading",
],
props: {
item: {
type: Object
},
open: {
type: Boolean
},
collapsible: {
type: Boolean
},
depth: {
type: Number
},
sidebarDepth: {
type: Number
},
fixedHeading: {
type: String
},
fixedHeadingId: {
type: String
},
headingLevel: {
type: String,
default: 'h3'
}
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Bless your soul


// ref: https://vuejs.org/v2/guide/components-edge-cases.html#Circular-References-Between-Components
beforeCreate() {
Expand Down
8 changes: 8 additions & 0 deletions docs/.vuepress/theme/components/SidebarLinks.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
:sidebar-depth="sidebarDepth"
:depth="depth"
:fixed-heading="fixedHeading"
:fixed-heading-id="fixedHeadingId"
:heading-level="headingLevel"
@toggle="toggleGroup(i)"
/>
<ToggleSidebarGroup
Expand Down Expand Up @@ -69,6 +71,12 @@ export default {
fixedHeading: {
type: String
},
fixedHeadingId: {
type: String
},
headingLevel: {
type: String
}
},

data() {
Expand Down