Skip to content

feat: add sidebar toggle to package code browser #2352

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

Draft
jfernsio wants to merge 5 commits into
base: main
Choose a base branch
from
+130 −0
Draft

feat: add sidebar toggle to package code browser #2352

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
60a722b
feat:add splitpane functionality to hide sidebar
jfernsio Mar 31, 2026
4ce9fea
chore(i18n): remove unused keys reported by i18n:report
jfernsio Apr 1, 2026
0aaefd8
Merge branch 'main' into add-splitpane-functionality
jfernsio Apr 1, 2026
3efdba1
fix(sidebar): add ARIA attributes to toggle button
jfernsio Apr 2, 2026
22fee07
Merge branch 'main' into add-splitpane-functionality
jfernsio Apr 2, 2026
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
32 changes: 32 additions & 0 deletions app/pages/package-code/[[org]]/[packageName]/v/[version]/[...filePath].vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,23 @@ defineOgImageComponent('Default', {
description: () => pkg.value?.license ?? '',
primaryColor: '#60a5fa',
})

// Sidebar visibility
const { settings } = useSettings()
const isSidebarCollapsed = computed({
get: () => settings.value.sidebar.collapsed.includes('code'),
set: value => {
const collapsed = settings.value.sidebar.collapsed.filter(id => id !== 'code')
if (value) {
collapsed.push('code')
}
settings.value.sidebar.collapsed = collapsed
},
})

function toggleSidebar() {
isSidebarCollapsed.value = !isSidebarCollapsed.value
}
</script>

<template>
Expand Down Expand Up @@ -349,6 +366,7 @@ defineOgImageComponent('Default', {
<div v-else-if="fileTree" class="flex flex-1" dir="ltr">
<!-- File tree sidebar - sticky with internal scroll -->
<aside
v-show="!isSidebarCollapsed"
class="w-64 lg:w-72 border-ie border-border shrink-0 hidden md:block bg-bg-subtle sticky top-25 self-start h-[calc(100vh-7rem)] overflow-y-auto"
>
Comment on lines 362 to 370
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 2, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Duplicate class attribute causes build failure.

The <aside> element has two class attributes (lines 366 and 368), which is invalid HTML and is causing the Storybook/Chromatic build to fail with "Duplicate attribute" error. You need to merge these into a single class attribute.

🐛 Proposed fix to merge the duplicate class attributes 
       <aside
         id="file-tree-sidebar"
         v-show="!isSidebarCollapsed"
-        class="w-64 lg:w-72 border-ie border-border shrink-0 hidden md:block bg-bg-subtle sticky top-25 self-start h-[calc(100vh-7rem)] overflow-y-auto"
-
-        class="sticky top-25 w-64 lg:w-72 hidden md:block h-[calc(100vh-10.5rem)] shrink-0 self-start bg-bg-subtle border-ie border-border"
-
+        class="sticky top-25 w-64 lg:w-72 hidden md:block h-[calc(100vh-10.5rem)] shrink-0 self-start bg-bg-subtle border-ie border-border overflow-y-auto"
       >
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<aside
id="file-tree-sidebar"
v-show="!isSidebarCollapsed"
class="w-64 lg:w-72 border-ie border-border shrink-0 hidden md:block bg-bg-subtle sticky top-25 self-start h-[calc(100vh-7rem)] overflow-y-auto"
class="sticky top-25 w-64 lg:w-72 hidden md:block h-[calc(100vh-10.5rem)] shrink-0 self-start bg-bg-subtle border-ie border-border"
>
<aside
id="file-tree-sidebar"
v-show="!isSidebarCollapsed"
class="sticky top-25 w-64 lg:w-72 hidden md:block h-[calc(100vh-10.5rem)] shrink-0 self-start bg-bg-subtle border-ie border-border overflow-y-auto"
>
🧰 Tools
🪛 GitHub Actions: chromatic

[error] 368-368: Storybook build failed (plugin vite:vue). RolldownError/SyntaxError: Duplicate attribute.

<CodeFileTree
Expand All @@ -365,6 +383,20 @@ defineOgImageComponent('Default', {
class="sticky z-5 top-25 bg-bg border-b border-border px-4 py-2 flex items-center justify-between gap-2 text-nowrap overflow-x-auto max-w-full"
>
<div class="flex items-center gap-2">
<!-- Sidebar toggle button -->
<button
Copy link
Copy Markdown
Contributor

@graphieros graphieros Apr 2, 2026

Choose a reason for hiding this comment

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

Consider adding aria-expanded and aria-controls to this button

Copy link
Copy Markdown
Author

@jfernsio jfernsio Apr 2, 2026

Choose a reason for hiding this comment

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

sure will add those 👍

type="button"
class="hidden md:flex items-center justify-center w-8 h-8 text-fg-subtle hover:text-fg transition-colors focus-visible:outline-accent/70 rounded"
:aria-label="$t(isSidebarCollapsed ? 'code.show_sidebar' : 'code.hide_sidebar')"
@click="toggleSidebar"
>
<span
class="w-4 h-4"
:class="isSidebarCollapsed ? 'i-lucide:sidebar-open' : 'i-lucide:sidebar-close'"
aria-hidden="true"
/>
</button>

<div
v-if="fileContent?.markdownHtml"
class="flex items-center gap-1 p-0.5 bg-bg-subtle border border-border-subtle rounded-md overflow-x-auto"
Expand Down
4 changes: 3 additions & 1 deletion i18n/locales/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,9 @@
},
"file_path": "File path",
"binary_file": "Binary file",
"binary_rendering_warning": "File type \"{contentType}\" is not supported for preview."
"binary_rendering_warning": "File type \"{contentType}\" is not supported for preview.",
"show_sidebar": "Show sidebar",
"hide_sidebar": "Hide sidebar"
},
"badges": {
"provenance": {
Expand Down
Loading