Skip to content
Open
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
18 changes: 18 additions & 0 deletions assets/js/sidebar-load-width.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
(function () {
try {
var leftWidth = localStorage.getItem("left-sidebar-width");
var tocWidth = localStorage.getItem("toc-width");
var cssStyles = "";

if (leftWidth) cssStyles += "--left-sidebar-width: " + leftWidth + "px;";
if (tocWidth) cssStyles += "--toc-width: " + tocWidth + "px;";
Comment thread
banana-three-join marked this conversation as resolved.

if (cssStyles) {
var styleTag = document.createElement("style");
styleTag.innerHTML = ".td-resizable-grid .td-main > .row.flex-xl-nowrap {" + cssStyles + "}";
document.head.appendChild(styleTag);
}
} catch (e) {
console.warn("LocalStorage blocked or unavailable:", e);
}
})();
114 changes: 114 additions & 0 deletions assets/js/sidebar-resizer.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
(function () {
document.addEventListener("DOMContentLoaded", () => {
const gridContainer = document.querySelector(".td-resizable-grid .td-main > .row.flex-xl-nowrap");
const leftResizer = document.getElementById("left-resizer");
const rightResizer = document.getElementById("right-resizer");

if (!gridContainer) return;

const LEFT_SIDEBAR_KEY = "left-sidebar-width";
const TOC_KEY = "toc-width";

const storage = {
get: (key) => {
try { return localStorage.getItem(key); }
catch (e) { return null; }
},
set: (key, value) => {
try { localStorage.setItem(key, value); }
catch (e) { return null; }
}
};

function setupResizer(resizer, type) {
resizer.addEventListener("pointerdown", (e) => {
e.preventDefault();

resizer.setPointerCapture(e.pointerId);
resizer.classList.add("is-dragging");

document.body.style.cursor = "col-resize";
document.body.style.userSelect = "none";

const startX = e.clientX;
const styles = window.getComputedStyle(gridContainer);
const gridColumns = styles.gridTemplateColumns ? styles.gridTemplateColumns.split(" ") : [];

/*
grid-template-columns over in _styles_project.scss has the following structure:

--left-sidebar-width --sidebar-resize-width 1fr --sidebar-resize-width --toc-width;

so gridcolumns[0] targets the left sidebar and gridcolumns[4] targets the toc

*/

let initialLeftSidebarWidth, initialTocWidth;
if (gridColumns.length >= 5 && gridColumns[0] !== "none") {
initialLeftSidebarWidth = parseInt(gridColumns[0], 10);
initialTocWidth = parseInt(gridColumns[4], 10);
} else {
initialLeftSidebarWidth = parseInt(styles.getPropertyValue('--left-sidebar-width'), 10);
initialTocWidth = parseInt(styles.getPropertyValue('--toc-width'), 10);
}

const minWidth = parseInt(styles.getPropertyValue(type === "left" ? '--left-sidebar-min-width' : '--toc-min-width'), 10);

const cssMaxWidth = parseInt(styles.getPropertyValue(type === "left" ? '--left-sidebar-max-width' : '--toc-max-width'), 10);
const maxAllowedByScreen = Math.floor(window.innerWidth * 0.4);
const maxWidth = Math.min(cssMaxWidth, maxAllowedByScreen);
Comment thread
banana-three-join marked this conversation as resolved.

let currentWidth = type === "left" ? initialLeftSidebarWidth : initialTocWidth;
let ticking = false;
let animationFrameId = null;

function onPointerMove(moveEvent) {
const deltaX = moveEvent.clientX - startX;

if (type === "left") {
currentWidth = Math.max(minWidth, Math.min(maxWidth, initialLeftSidebarWidth + deltaX));
} else if (type === "right") {
currentWidth = Math.max(minWidth, Math.min(maxWidth, initialTocWidth - deltaX));
}

if (!ticking) {
animationFrameId = window.requestAnimationFrame(() => {
const varName = type === "left" ? "--left-sidebar-width" : "--toc-width";
gridContainer.style.setProperty(varName, `${currentWidth}px`);
ticking = false;
});
ticking = true;
}
}

function onPointerUp(upEvent) {
if (animationFrameId) {
window.cancelAnimationFrame(animationFrameId);
animationFrameId = null;
ticking = false;
}

resizer.releasePointerCapture(upEvent.pointerId);
resizer.classList.remove("is-dragging");

document.body.style.cursor = "";
document.body.style.userSelect = "";

const storageKey = type === "left" ? LEFT_SIDEBAR_KEY : TOC_KEY;
storage.set(storageKey, currentWidth);

document.removeEventListener("pointermove", onPointerMove);
document.removeEventListener("pointerup", onPointerUp);
document.removeEventListener("pointercancel", onPointerUp);
}

document.addEventListener("pointermove", onPointerMove);
document.addEventListener("pointerup", onPointerUp);
document.addEventListener("pointercancel", onPointerUp);
});
}

if (leftResizer) setupResizer(leftResizer, "left");
if (rightResizer) setupResizer(rightResizer, "right");
});
})();
77 changes: 77 additions & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,83 @@ a:not([href]):not([class]):hover {
}
}

// Left sidebar & Right sidebar Resize
:root {
--left-sidebar-width: 240px;
--toc-width: 240px;

--left-sidebar-min-width: 180px;
--left-sidebar-max-width: 500px;

--toc-min-width: 180px;
--toc-max-width: 400px;

--sidebar-resize-width: 5px;
}

@media (min-width: 1200px) {
.td-resizable-grid .td-main > .row.flex-xl-nowrap {
display: grid;
grid-template-columns:
var(--left-sidebar-width)
var(--sidebar-resize-width)
1fr
var(--sidebar-resize-width)
var(--toc-width);
}

.td-sidebar {
grid-column: 1;
grid-row: 1;
}

#left-resizer {
grid-column: 2;
grid-row: 1;
padding-left: 0 !important;
padding-right: 0 !important;
box-sizing: border-box;
}

main[role="main"] {
grid-column: 3;
grid-row: 1;
}

#right-resizer {
grid-column: 4;
grid-row: 1;
padding-left: 0 !important;
padding-right: 0 !important;
box-sizing: border-box;
}

.td-sidebar-toc {
grid-column: 5;
grid-row: 1;
}

.td-resizable-grid .td-sidebar,
.td-resizable-grid .td-sidebar-toc,
.td-resizable-grid main[role="main"] {
width: auto;
}

//change the colors to something of meshery?
.layout-resizer {
width: var(--sidebar-resize-width);
cursor: col-resize;
background-color: rgba(0, 0, 0, 0.03);
transition: background-color 0.15s ease;
z-index: 1; //Must be lower than the sticky header
}

.layout-resizer:hover,
.layout-resizer.is-dragging {
background-color: var(--primary, #007bff);
}
}

// pageinfo
.pageinfo {
font-weight: $font-weight-medium;
Expand Down
15 changes: 12 additions & 3 deletions layouts/docs/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,23 @@

<body class="td-{{ .Kind }}{{ with .Page.Params.body_class }} {{ . }}{{ end }}">
<header>{{ partial "navbar.html" . }}</header>
<div class="container-fluid td-outer">
<div class="container-fluid td-outer td-resizable-grid">
<div class="td-main">
<div class="row flex-xl-nowrap">
<aside class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
{{ partial "sidebar.html" . }}
</aside>

<div class="layout-resizer d-none d-xl-block" id="left-resizer"></div>

<div class="layout-resizer d-none d-xl-block" id="right-resizer"></div>

<aside class="d-none d-xl-block col-xl-2 td-sidebar-toc d-print-none">
{{ partial "page-meta-links.html" . }}
{{ partial "toc.html" . }}
{{ partial "page-meta-links.html" . }}
{{ partial "toc.html" . }}
{{ partial "taxonomy_terms_clouds.html" . }}
</aside>

<main class="col-12 col-md-9 col-xl-8" role="main">
{{ partial "version-banner.html" . }}
<div class="page-header d-flex justify-content-between align-items-center">
Expand All @@ -32,11 +38,14 @@
</div>
{{ block "main" . }}{{ end }}
</main>

{{ partial "load-sidebars-width.html" . }}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

This partial should be removed from the body and placed inside the <head> element (e.g., right after {{ partial "head.html" . }}) to ensure the saved sidebar widths are loaded and applied before the page is rendered, preventing layout shift.

</div>
</div>
{{ partial "footer.html" . }}
</div>
{{ partial "scripts.html" . }}
{{ partial "sidebar-resize-script.html" }}
{{ partial "image-modal.html" . }}
</body>

Expand Down
2 changes: 2 additions & 0 deletions layouts/partials/load-sidebars-width.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{{ $resizerScript := resources.Get "js/sidebar-load-width.js" | minify | fingerprint }}
<script src="{{ $resizerScript.RelPermalink }}" defer></script>
Comment on lines +1 to +2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

To prevent a Flicker of Unstyled Content (FOUC) or layout shift, the sidebar widths should be loaded and applied synchronously before the page starts rendering. Removing the defer attribute and moving the {{ partial "load-sidebars-width.html" . }} call to the <head> of the document (e.g., in layouts/docs/baseof.html or layouts/partials/head.html) ensures that the saved widths are applied immediately, avoiding any visual jump.

Suggested change
{{ $resizerScript := resources.Get "js/sidebar-load-width.js" | minify | fingerprint }}
<script src="{{ $resizerScript.RelPermalink }}" defer></script>
{{ $resizerScript := resources.Get "js/sidebar-load-width.js" | minify | fingerprint }}
<script src="{{ $resizerScript.RelPermalink }}"></script>

2 changes: 2 additions & 0 deletions layouts/partials/sidebar-resize-script.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{{ $resizerScript := resources.Get "js/sidebar-resizer.js" | minify | fingerprint }}
<script src="{{ $resizerScript.RelPermalink }}" defer></script>
30 changes: 15 additions & 15 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading