Skip to content

feat(drawer): rework drawer + use it for mobile docs navigation #3230

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
jpzwarte wants to merge 5 commits into
base: docs/website-v2
Choose a base branch
from
Draft

feat(drawer): rework drawer + use it for mobile docs navigation #3230

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2ad657d
feat(drawer): rework drawer + use it for mobile docs navigation
claude Apr 16, 2026
258dbb6
ci: run CI + website preview for PRs targeting docs/website-v2
claude Apr 16, 2026
41a1347
Merge branch 'docs/website-v2' into claude/mobile-sidebar-drawer-qofFy
jpzwarte Apr 16, 2026
4ddb3be
chore: update yarn.lock
claude Apr 16, 2026
eee2475
⛷
jpzwarte Apr 20, 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
105 changes: 103 additions & 2 deletions docs/website/src/css/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ body {
.site-layout {
display: grid;
grid-template-areas:
'sidebar'
'content'
'toc';
min-block-size: 100dvh;
Expand All @@ -32,10 +31,112 @@ body {
}
}

doc-sidebar {
.site-sidebar {
grid-area: sidebar;
}

/* Mobile: hide the in-grid sidebar; show the hamburger header and drawer. */
@media (width < 640px) {
.site-sidebar {
display: none;
}

.content {
padding-block-start: var(--sl-size-200);
}
}

/* Desktop: hide the mobile-only header and drawer. */
@media (width >= 640px) {
.mobile-header,
.mobile-drawer {
display: none;
}
}

.mobile-header {
align-items: center;
background: var(--sl-elevation-surface-raised-sunken);
border-block-end: var(--sl-size-borderWidth-default) solid var(--sl-color-border-plain);
display: flex;
gap: var(--sl-size-200);
padding: var(--sl-size-150) var(--sl-size-200);
position: sticky;
inset-block-start: 0;
z-index: 2;
}

.mobile-header__hamburger {
align-items: center;
background: transparent;
border: 0;
border-radius: var(--sl-size-borderRadius-sm);
color: var(--sl-color-foreground-plain);
cursor: pointer;
display: inline-flex;
font-size: var(--sl-size-300);
justify-content: center;
padding: var(--sl-size-100);

&:hover {
background: var(--sl-color-background-neutral-subtle);
}

&:focus-visible {
outline: var(--sl-color-border-focused) solid var(--sl-size-borderWidth-focusRing);
outline-offset: var(--sl-size-outlineOffset-default);
}

sl-icon {
inline-size: var(--sl-size-300);
}
}

.mobile-header__logo {
align-items: center;
display: inline-flex;
text-decoration: none;

img {
display: block;
inline-size: auto;
block-size: 2rem;
}

.logo-dark {
display: none;
}
}

[data-color-scheme='dark'] .mobile-header__logo .logo-light {
display: none;
}

[data-color-scheme='dark'] .mobile-header__logo .logo-dark {
display: block;
}

.mobile-drawer {
--sl-drawer-inline-size: 320px;
}

.mobile-drawer::part(dialog) {
background: var(--sl-elevation-surface-raised-sunken);
}

.mobile-drawer::part(body) {
padding: 0;
}

.mobile-drawer::part(header) {
padding: var(--sl-size-150) var(--sl-size-200) 0;
}

.mobile-drawer doc-sidebar {
border-inline-end: 0;
min-block-size: 100%;
}

.content {
box-sizing: border-box;
grid-area: content;
Expand Down
26 changes: 25 additions & 1 deletion docs/website/src/includes/base.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,35 @@
<link rel="stylesheet" href="/css/main.css">
</head>
<body>
{% if hasSidebar %}
<header class="mobile-header">
<button
type="button"
class="mobile-header__hamburger"
aria-label="Open navigation menu"
aria-controls="mobile-drawer"
aria-expanded="false"
>
<sl-icon name="far-bars"></sl-icon>
</button>
<a href="/" class="mobile-header__logo" aria-label="SL Design System">
<img class="logo-light" src="/assets/logo-black.svg" alt="" width="140" height="25" />
<img class="logo-dark" src="/assets/logo.svg" alt="" width="140" height="25" />
</a>
</header>
{% endif %}

<div class="site-layout">
{% if hasSidebar %}
<doc-sidebar>
<doc-sidebar class="site-sidebar">
{% include "sidebar.njk" %}
</doc-sidebar>
<sl-drawer id="mobile-drawer" class="mobile-drawer" attachment="left" aria-label="Main navigation">
<span slot="title">Menu</span>
<doc-sidebar>
{% include "sidebar.njk" %}
</doc-sidebar>
</sl-drawer>
{% endif %}

<main class="content">
Expand Down
26 changes: 24 additions & 2 deletions docs/website/src/js/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import '@webcomponents/scoped-custom-element-registry/scoped-custom-element-registry.min.js';
import './theme.js';
import './icons.js';
import { faBug, faCircleExclamation, faCode, faFileLines } from '@fortawesome/pro-regular-svg-icons';
import { faBars, faBug, faCircleExclamation, faCode, faFileLines } from '@fortawesome/pro-regular-svg-icons';
import '@sl-design-system/button/register.js';
import '@sl-design-system/button-bar/register.js';
import '@sl-design-system/badge/register.js';
import '@sl-design-system/callout/register.js';
import '@sl-design-system/dialog/register.js';
import '@sl-design-system/drawer/register.js';
import '@sl-design-system/icon/register.js';
import { Icon } from '@sl-design-system/icon';
import '@sl-design-system/tooltip/register.js';
Expand All @@ -22,7 +23,7 @@ import { NavGroup } from '@sl-design-system/doc-components/site-nav/nav-group.js
import { NavItem } from '@sl-design-system/doc-components/site-nav/nav-item.js';
import { SiteNav } from '@sl-design-system/doc-components/site-nav/site-nav.js';

Icon.register(faBug, faCircleExclamation, faCode, faFileLines);
Icon.register(faBars, faBug, faCircleExclamation, faCode, faFileLines);

customElements.define('doc-code', Code);
customElements.define('doc-code-example', CodeExample);
Expand All @@ -35,3 +36,24 @@ customElements.define('doc-open-issue-count', OpenIssueCount);
customElements.define('doc-page-toc', PageToc);
customElements.define('doc-sidebar', Sidebar);
customElements.define('doc-site-nav', SiteNav);

const hamburger = document.querySelector('.mobile-header__hamburger');
const drawer = document.querySelector('#mobile-drawer');

if (hamburger && drawer) {
hamburger.addEventListener('click', () => {
drawer.showModal();
hamburger.setAttribute('aria-expanded', 'true');
});

drawer.addEventListener('sl-close', () => {
hamburger.setAttribute('aria-expanded', 'false');
});

drawer.addEventListener('click', event => {
const link = event.target.closest('a');
if (link && drawer.contains(link)) {
drawer.close();
}
});
}
4 changes: 3 additions & 1 deletion packages/components/drawer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
},
"dependencies": {
"@sl-design-system/button": "^2.0.0",
"@sl-design-system/button-bar": "^1.5.0"
"@sl-design-system/button-bar": "^1.5.0",
"@sl-design-system/icon": "^1.4.2",
"@sl-design-system/shared": "^0.12.0"
},
"devDependencies": {
"@open-wc/scoped-elements": "^3.0.6",
Expand Down
Loading
Loading