adminlte4
Version:
1,022 lines (987 loc) • 45.9 kB
HTML
<html lang="en">
<!--begin::Head-->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Pushmenu Plugin | AdminLTE 4</title>
<!--begin::Accessibility Meta Tags-->
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<meta name="color-scheme" content="light dark" />
<meta name="theme-color" content="#007bff" media="(prefers-color-scheme: light)" />
<meta name="theme-color" content="#1a1a1a" media="(prefers-color-scheme: dark)" />
<!--end::Accessibility Meta Tags-->
<!--begin::Primary Meta Tags-->
<meta name="title" content="Pushmenu Plugin | AdminLTE 4" />
<meta name="author" content="ColorlibHQ" />
<meta
name="description"
content="AdminLTE is a Free Bootstrap 5 Admin Dashboard, 30 example pages using Vanilla JS. Fully accessible with WCAG 2.1 AA compliance."
/>
<meta
name="keywords"
content="bootstrap 5, bootstrap, bootstrap 5 admin dashboard, bootstrap 5 dashboard, bootstrap 5 charts, bootstrap 5 calendar, bootstrap 5 datepicker, bootstrap 5 tables, bootstrap 5 datatable, vanilla js datatable, colorlibhq, colorlibhq dashboard, colorlibhq admin dashboard, accessible admin panel, WCAG compliant"
/>
<!--end::Primary Meta Tags-->
<!--begin::Accessibility Features-->
<!-- Skip links will be dynamically added by accessibility.js -->
<meta name="supported-color-schemes" content="light dark" />
<link rel="preload" href="../../css/adminlte.css" as="style" />
<!--end::Accessibility Features-->
<!--begin::Fonts-->
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/@fontsource/source-sans-3@5.0.12/index.css"
integrity="sha256-tXJfXfp6Ewt1ilPzLDtQnJV4hclT9XuaZUKyUvmyr+Q="
crossorigin="anonymous"
media="print"
onload="this.media = 'all'"
/>
<!--end::Fonts-->
<!--begin::Third Party Plugin(OverlayScrollbars)-->
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/styles/overlayscrollbars.min.css"
crossorigin="anonymous"
/>
<!--end::Third Party Plugin(OverlayScrollbars)-->
<!--begin::Third Party Plugin(Bootstrap Icons)-->
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.13.1/font/bootstrap-icons.min.css"
crossorigin="anonymous"
/>
<!--end::Third Party Plugin(Bootstrap Icons)-->
<!--begin::Required Plugin(AdminLTE)-->
<link rel="stylesheet" href="../../css/adminlte.css" />
<!--end::Required Plugin(AdminLTE)-->
</head>
<!--end::Head-->
<!--begin::Body-->
<body class="layout-fixed sidebar-expand-lg bg-body-tertiary docs-page">
<!--begin::App Wrapper-->
<div class="app-wrapper">
<!--begin::Header-->
<nav class="app-header navbar navbar-expand bg-body">
<!--begin::Container-->
<div class="container-fluid">
<!--begin::Start Navbar Links-->
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" data-lte-toggle="sidebar" href="#" role="button">
<i class="bi bi-list"></i>
</a>
</li>
<li class="nav-item d-none d-md-block">
<a href="../../docs/introduction.html" class="nav-link">
<i class="bi bi-book me-1" aria-hidden="true"></i>
Documentation
</a>
</li>
<li class="nav-item d-none d-md-block">
<a href="../../index.html" class="nav-link">
<i class="bi bi-arrow-left me-1" aria-hidden="true"></i>
Back to live preview
</a>
</li>
</ul>
<!--end::Start Navbar Links-->
<!--begin::End Navbar Links-->
<ul class="navbar-nav ms-auto">
<!--begin::Navbar Search-->
<li class="nav-item">
<a class="nav-link" data-widget="navbar-search" href="#" role="button">
<i class="bi bi-search"></i>
</a>
</li>
<!--end::Navbar Search-->
<!--begin::Messages Dropdown Menu-->
<li class="nav-item dropdown">
<a class="nav-link" data-bs-toggle="dropdown" href="#">
<i class="bi bi-chat-text"></i>
<span class="navbar-badge badge text-bg-danger">3</span>
</a>
<div class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
<a href="#" class="dropdown-item">
<!--begin::Message-->
<div class="d-flex">
<div class="flex-shrink-0">
<img
src="../../assets/img/user1-128x128.jpg"
alt="User Avatar"
class="img-size-50 rounded-circle me-3"
/>
</div>
<div class="flex-grow-1">
<h3 class="dropdown-item-title">
Brad Diesel
<span class="float-end fs-7 text-danger"
><i class="bi bi-star-fill"></i
></span>
</h3>
<p class="fs-7">Call me whenever you can...</p>
<p class="fs-7 text-secondary">
<i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
</p>
</div>
</div>
<!--end::Message-->
</a>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item">
<!--begin::Message-->
<div class="d-flex">
<div class="flex-shrink-0">
<img
src="../../assets/img/user8-128x128.jpg"
alt="User Avatar"
class="img-size-50 rounded-circle me-3"
/>
</div>
<div class="flex-grow-1">
<h3 class="dropdown-item-title">
John Pierce
<span class="float-end fs-7 text-secondary">
<i class="bi bi-star-fill"></i>
</span>
</h3>
<p class="fs-7">I got your message bro</p>
<p class="fs-7 text-secondary">
<i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
</p>
</div>
</div>
<!--end::Message-->
</a>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item">
<!--begin::Message-->
<div class="d-flex">
<div class="flex-shrink-0">
<img
src="../../assets/img/user3-128x128.jpg"
alt="User Avatar"
class="img-size-50 rounded-circle me-3"
/>
</div>
<div class="flex-grow-1">
<h3 class="dropdown-item-title">
Nora Silvester
<span class="float-end fs-7 text-warning">
<i class="bi bi-star-fill"></i>
</span>
</h3>
<p class="fs-7">The subject goes here</p>
<p class="fs-7 text-secondary">
<i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
</p>
</div>
</div>
<!--end::Message-->
</a>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item dropdown-footer">See All Messages</a>
</div>
</li>
<!--end::Messages Dropdown Menu-->
<!--begin::Notifications Dropdown Menu-->
<li class="nav-item dropdown">
<a class="nav-link" data-bs-toggle="dropdown" href="#">
<i class="bi bi-bell-fill"></i>
<span class="navbar-badge badge text-bg-warning">15</span>
</a>
<div class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
<span class="dropdown-item dropdown-header">15 Notifications</span>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item">
<i class="bi bi-envelope me-2"></i> 4 new messages
<span class="float-end text-secondary fs-7">3 mins</span>
</a>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item">
<i class="bi bi-people-fill me-2"></i> 8 friend requests
<span class="float-end text-secondary fs-7">12 hours</span>
</a>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item">
<i class="bi bi-file-earmark-fill me-2"></i> 3 new reports
<span class="float-end text-secondary fs-7">2 days</span>
</a>
<div class="dropdown-divider"></div>
<a href="#" class="dropdown-item dropdown-footer"> See All Notifications </a>
</div>
</li>
<!--end::Notifications Dropdown Menu-->
<!--begin::Fullscreen Toggle-->
<li class="nav-item">
<a class="nav-link" href="#" data-lte-toggle="fullscreen">
<i data-lte-icon="maximize" class="bi bi-arrows-fullscreen"></i>
<i data-lte-icon="minimize" class="bi bi-fullscreen-exit d-none"></i>
</a>
</li>
<!--end::Fullscreen Toggle-->
<!--begin::Color Mode Toggle (#6010)-->
<li class="nav-item dropdown">
<a
class="nav-link"
href="#"
id="bd-theme"
aria-label="Toggle color scheme"
data-bs-toggle="dropdown"
aria-expanded="false"
>
<i class="bi bi-sun-fill" data-lte-theme-icon="light"></i>
<i class="bi bi-moon-fill d-none" data-lte-theme-icon="dark"></i>
<i class="bi bi-circle-half d-none" data-lte-theme-icon="auto"></i>
</a>
<ul
class="dropdown-menu dropdown-menu-end"
aria-labelledby="bd-theme"
style="--bs-dropdown-min-width: 8rem"
>
<li>
<button
type="button"
class="dropdown-item d-flex align-items-center"
data-bs-theme-value="light"
aria-pressed="false"
>
<i class="bi bi-sun-fill me-2"></i>
Light
<i class="bi bi-check-lg ms-auto d-none"></i>
</button>
</li>
<li>
<button
type="button"
class="dropdown-item d-flex align-items-center"
data-bs-theme-value="dark"
aria-pressed="false"
>
<i class="bi bi-moon-fill me-2"></i>
Dark
<i class="bi bi-check-lg ms-auto d-none"></i>
</button>
</li>
<li>
<button
type="button"
class="dropdown-item d-flex align-items-center active"
data-bs-theme-value="auto"
aria-pressed="true"
>
<i class="bi bi-circle-half me-2"></i>
Auto
<i class="bi bi-check-lg ms-auto d-none"></i>
</button>
</li>
</ul>
</li>
<!--end::Color Mode Toggle-->
<!--begin::User Menu Dropdown-->
<li class="nav-item dropdown user-menu">
<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown">
<img
src="../../assets/img/user2-160x160.jpg"
class="user-image rounded-circle shadow"
alt="User Image"
/>
<span class="d-none d-md-inline">Alexander Pierce</span>
</a>
<ul class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
<!--begin::User Image-->
<li class="user-header text-bg-primary">
<img
src="../../assets/img/user2-160x160.jpg"
class="rounded-circle shadow"
alt="User Image"
/>
<p>
Alexander Pierce - Web Developer
<small>Member since Nov. 2023</small>
</p>
</li>
<!--end::User Image-->
<!--begin::Menu Body-->
<li class="user-body">
<!--begin::Row-->
<div class="row">
<div class="col-4 text-center">
<a href="#">Followers</a>
</div>
<div class="col-4 text-center">
<a href="#">Sales</a>
</div>
<div class="col-4 text-center">
<a href="#">Friends</a>
</div>
</div>
<!--end::Row-->
</li>
<!--end::Menu Body-->
<!--begin::Menu Footer-->
<li class="user-footer">
<a href="#" class="btn btn-outline-secondary">Profile</a>
<a href="#" class="btn btn-outline-danger float-end">Sign out</a>
</li>
<!--end::Menu Footer-->
</ul>
</li>
<!--end::User Menu Dropdown-->
</ul>
<!--end::End Navbar Links-->
</div>
<!--end::Container-->
</nav>
<!--end::Header-->
<!--begin::Sidebar (docs mode)-->
<aside class="app-sidebar bg-body-secondary shadow" data-bs-theme="dark">
<!--begin::Sidebar Brand-->
<div class="sidebar-brand">
<a href="../../docs/introduction.html" class="brand-link">
<img
src="../../assets/img/AdminLTELogo.png"
alt="AdminLTE Logo"
class="brand-image opacity-75 shadow"
/>
<span class="brand-text fw-light">
AdminLTE 4 <span class="opacity-75">· Docs</span>
</span>
</a>
</div>
<!--end::Sidebar Brand-->
<!--begin::Sidebar Wrapper-->
<div class="sidebar-wrapper">
<nav class="mt-2">
<!-- Back to preview CTA -->
<div class="px-3 pb-2">
<a
href="../../index.html"
class="btn btn-sm btn-outline-light w-100 d-flex align-items-center justify-content-center gap-2"
>
<i class="bi bi-arrow-left" aria-hidden="true"></i>
Back to live preview
</a>
</div>
<!--begin::Sidebar Menu-->
<ul
class="nav sidebar-menu flex-column"
data-lte-toggle="treeview"
role="navigation"
aria-label="Documentation navigation"
data-accordion="false"
id="docs-navigation"
>
<li class="nav-header">START HERE</li>
<li class="nav-item">
<a href="../../docs/introduction.html" class="nav-link">
<i class="nav-icon bi bi-download"></i>
<p>Installation</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/getting-started.html" class="nav-link">
<i class="nav-icon bi bi-rocket-takeoff"></i>
<p>Getting Started</p>
</a>
</li>
<li class="nav-header">FOUNDATIONS</li>
<li class="nav-item">
<a href="../../docs/layout.html" class="nav-link">
<i class="nav-icon bi bi-grip-horizontal"></i>
<p>Layout Classes</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/layout-blueprint.html" class="nav-link">
<i class="nav-icon bi bi-diagram-3"></i>
<p>Layout Blueprint</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/customization.html" class="nav-link">
<i class="nav-icon bi bi-palette"></i>
<p>Customization</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/color-mode.html" class="nav-link">
<i class="nav-icon bi bi-star-half"></i>
<p>Color Mode</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/rtl.html" class="nav-link">
<i class="nav-icon bi bi-text-paragraph"></i>
<p>RTL Support</p>
</a>
</li>
<li class="nav-header">BUILDING</li>
<li class="nav-item">
<a href="../../docs/recipes.html" class="nav-link">
<i class="nav-icon bi bi-clipboard-check"></i>
<p>Recipes</p>
</a>
</li>
<li class="nav-item">
<a href="#" class="nav-link">
<i class="nav-icon bi bi-ui-checks-grid"></i>
<p>
Components
<i class="nav-arrow bi bi-chevron-right"></i>
</p>
</a>
<ul class="nav nav-treeview">
<li class="nav-item">
<a href="../../docs/components/main-header.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Main Header</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/components/main-sidebar.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Main Sidebar</p>
</a>
</li>
</ul>
</li>
<li class="nav-item menu-open">
<a href="#" class="nav-link active">
<i class="nav-icon bi bi-filetype-js"></i>
<p>
JavaScript Plugins
<i class="nav-arrow bi bi-chevron-right"></i>
</p>
</a>
<ul class="nav nav-treeview">
<li class="nav-item">
<a href="../../docs/javascript/plugins-overview.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Overview</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/layout.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Layout</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/pushmenu.html" class="nav-link active">
<i class="nav-icon bi bi-circle"></i>
<p>PushMenu</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/treeview.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Treeview</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/card-widget.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Card Widget</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/direct-chat.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Direct Chat</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/fullscreen.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Fullscreen</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/javascript/accessibility.html" class="nav-link">
<i class="nav-icon bi bi-circle"></i>
<p>Accessibility</p>
</a>
</li>
</ul>
</li>
<li class="nav-item">
<a href="../../docs/integrations.html" class="nav-link">
<i class="nav-icon bi bi-puzzle"></i>
<p>Integrations</p>
</a>
</li>
<li class="nav-header">SHIPPING</li>
<li class="nav-item">
<a href="../../docs/migration.html" class="nav-link">
<i class="nav-icon bi bi-arrow-up-right-square"></i>
<p>Migration from v3</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/deployment.html" class="nav-link">
<i class="nav-icon bi bi-cloud-upload"></i>
<p>Deployment</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/browser-support.html" class="nav-link">
<i class="nav-icon bi bi-browser-chrome"></i>
<p>Browser Support</p>
</a>
</li>
<li class="nav-header">RESOURCES</li>
<li class="nav-item">
<a href="../../docs/faq.html" class="nav-link">
<i class="nav-icon bi bi-question-circle"></i>
<p>FAQ</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/how-to-contribute.html" class="nav-link">
<i class="nav-icon bi bi-people"></i>
<p>Contributing</p>
</a>
</li>
<li class="nav-item">
<a href="../../docs/license.html" class="nav-link">
<i class="nav-icon bi bi-patch-check"></i>
<p>License</p>
</a>
</li>
<li class="nav-item">
<a
href="https://github.com/ColorlibHQ/AdminLTE"
target="_blank"
rel="noopener"
class="nav-link"
>
<i class="nav-icon bi bi-github"></i>
<p>
GitHub
<i class="bi bi-box-arrow-up-right ms-1" aria-hidden="true"></i>
</p>
</a>
</li>
</ul>
<!--end::Sidebar Menu-->
</nav>
</div>
<!--end::Sidebar Wrapper-->
</aside>
<!--end::Sidebar (docs mode)-->
<!--begin::App Main-->
<main class="app-main">
<!--begin::App Content Header-->
<div class="app-content-header">
<!--begin::Container-->
<div class="container-fluid">
<!--begin::Row-->
<div class="row">
<div class="col-sm-6">
<h3 class="mb-0">Pushmenu Plugin</h3>
</div>
<div class="col-sm-6">
<ol class="breadcrumb float-sm-end">
<li class="breadcrumb-item"><a href="#">Docs</a></li>
<li class="breadcrumb-item active" aria-current="page">Pushmenu Plugin</li>
</ol>
</div>
</div>
<!--end::Row-->
</div>
<!--end::Container-->
</div>
<!--end::App Content Header-->
<!--begin::App Content-->
<div class="app-content">
<!--begin::Container-->
<div class="container-fluid">
<div class="row">
<div class="col-12">
<div class="card">
<div class="card-body">
<p>
The PushMenu plugin toggles the sidebar between expanded and collapsed states.
It handles responsive behavior, optional localStorage persistence, and overlay
management on mobile.
</p>
<h5 id="usage">Usage</h5>
<p>
This plugin is activated via data attributes on the sidebar element and toggle
buttons.
</p>
<p><strong>Data API</strong></p>
<p>
Add <code>data-lte-toggle="sidebar"</code> to any button or link to
toggle the sidebar.
</p>
<pre
class="astro-code dark-plus"
style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
tabindex="0"
data-language="html"
><code><span class="line"><span style="color:#808080"><</span><span style="color:#569CD6">a</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">"#"</span><span style="color:#9CDCFE"> data-lte-toggle</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">"sidebar"</span><span style="color:#808080">></span><span style="color:#D4D4D4">Toggle Sidebar</span><span style="color:#808080"></</span><span style="color:#569CD6">a</span><span style="color:#808080">></span></span></code></pre>
<h5 id="configuration">Configuration</h5>
<p>
Configure the sidebar via data attributes on the
<code>.app-sidebar</code> element:
</p>
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>data-sidebar-breakpoint</code></td>
<td><code>992</code></td>
<td>Screen width (px) below which the sidebar is considered mobile.</td>
</tr>
<tr>
<td><code>data-enable-persistence</code></td>
<td><code>false</code></td>
<td>Save sidebar state to localStorage across page loads.</td>
</tr>
</tbody>
</table>
<pre
class="astro-code dark-plus"
style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
tabindex="0"
data-language="html"
><code><span class="line"><span style="color:#808080"><</span><span style="color:#569CD6">aside</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">"app-sidebar"</span><span style="color:#9CDCFE"> data-enable-persistence</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">"true"</span><span style="color:#9CDCFE"> data-sidebar-breakpoint</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">"768"</span><span style="color:#808080">></span></span>
<span class="line"><span style="color:#6A9955"> <!-- sidebar content --></span></span>
<span class="line"><span style="color:#808080"></</span><span style="color:#569CD6">aside</span><span style="color:#808080">></span></span></code></pre>
<h5 id="responsive-behavior">Responsive Behavior</h5>
<ul>
<li>
<strong>Desktop</strong> (above breakpoint): Sidebar is expanded by default.
Collapse is remembered if persistence is enabled.
</li>
<li>
<strong>Mobile</strong> (at or below breakpoint): Sidebar is collapsed by
default. An overlay appears when the sidebar is open, clicking it collapses
the sidebar.
</li>
</ul>
<h5 id="css-classes">CSS Classes</h5>
<table>
<thead>
<tr>
<th>Class</th>
<th>Applied to</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>sidebar-collapse</code></td>
<td><code><body></code></td>
<td>Sidebar is collapsed.</td>
</tr>
<tr>
<td><code>sidebar-open</code></td>
<td><code><body></code></td>
<td>Sidebar is explicitly open on mobile.</td>
</tr>
<tr>
<td><code>sidebar-mini</code></td>
<td><code><body></code></td>
<td>Enables mini sidebar mode (icons only when collapsed).</td>
</tr>
<tr>
<td><code>sidebar-without-hover</code></td>
<td><code><body></code></td>
<td>Prevents collapsed sidebar from expanding on hover.</td>
</tr>
<tr>
<td><code>sidebar-expand-{breakpoint}</code></td>
<td><code><body></code></td>
<td>
Sets the responsive breakpoint (<code>sm</code>, <code>md</code>,
<code>lg</code>, <code>xl</code>, <code>xxl</code>).
</td>
</tr>
</tbody>
</table>
<h5 id="events">Events</h5>
<table>
<thead>
<tr>
<th>Event</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>open.lte.push-menu</code></td>
<td>Fired when the sidebar is expanded.</td>
</tr>
<tr>
<td><code>collapse.lte.push-menu</code></td>
<td>Fired when the sidebar is collapsed.</td>
</tr>
</tbody>
</table>
<p>Both events bubble. Listen on <code>document</code> for a global hook:</p>
<pre
class="astro-code dark-plus"
style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
tabindex="0"
data-language="js"
><code><span class="line"><span style="color:#9CDCFE">document</span><span style="color:#D4D4D4">.</span><span style="color:#DCDCAA">addEventListener</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">"open.lte.push-menu"</span><span style="color:#D4D4D4">, () </span><span style="color:#569CD6">=></span><span style="color:#D4D4D4"> {</span></span>
<span class="line"><span style="color:#9CDCFE"> console</span><span style="color:#D4D4D4">.</span><span style="color:#DCDCAA">log</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">"Sidebar opened"</span><span style="color:#D4D4D4">)</span></span>
<span class="line"><span style="color:#D4D4D4">})</span></span></code></pre>
<h5 id="programmatic-api">Programmatic API</h5>
<p>
Import the class and instantiate it on any element (typically the sidebar
toggle button or <code>document.body</code>):
</p>
<pre
class="astro-code dark-plus"
style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
tabindex="0"
data-language="js"
><code><span class="line"><span style="color:#C586C0">import</span><span style="color:#D4D4D4"> { </span><span style="color:#9CDCFE">PushMenu</span><span style="color:#D4D4D4"> } </span><span style="color:#C586C0">from</span><span style="color:#CE9178"> "admin-lte"</span></span>
<span class="line"></span>
<span class="line"><span style="color:#569CD6">const</span><span style="color:#4FC1FF"> sidebar</span><span style="color:#D4D4D4"> = </span><span style="color:#569CD6">new</span><span style="color:#DCDCAA"> PushMenu</span><span style="color:#D4D4D4">(</span><span style="color:#9CDCFE">document</span><span style="color:#D4D4D4">.</span><span style="color:#DCDCAA">querySelector</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">'[data-lte-toggle="sidebar"]'</span><span style="color:#D4D4D4">), {</span></span>
<span class="line"><span style="color:#9CDCFE"> sidebarBreakpoint:</span><span style="color:#B5CEA8"> 992</span><span style="color:#D4D4D4">,</span></span>
<span class="line"><span style="color:#9CDCFE"> enablePersistence:</span><span style="color:#569CD6"> false</span></span>
<span class="line"><span style="color:#D4D4D4">})</span></span></code></pre>
<h6 id="methods">Methods</h6>
<table>
<thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>toggle()</code></td>
<td><code>void</code></td>
<td>
Expands or collapses the sidebar based on current state. Persists state
if <code>enablePersistence</code> is <code>true</code>.
</td>
</tr>
<tr>
<td><code>expand()</code></td>
<td><code>void</code></td>
<td>Expands the sidebar. Fires <code>open.lte.push-menu</code>.</td>
</tr>
<tr>
<td><code>collapse()</code></td>
<td><code>void</code></td>
<td>Collapses the sidebar. Fires <code>collapse.lte.push-menu</code>.</td>
</tr>
<tr>
<td><code>isCollapsed()</code></td>
<td><code>boolean</code></td>
<td>
<code>true</code> if <code><body></code> has
<code>sidebar-collapse</code> class.
</td>
</tr>
<tr>
<td><code>isExplicitlyOpen()</code></td>
<td><code>boolean</code></td>
<td>
<code>true</code> if <code><body></code> has
<code>sidebar-open</code> (mobile, user opened it).
</td>
</tr>
<tr>
<td><code>isMiniMode()</code></td>
<td><code>boolean</code></td>
<td>
<code>true</code> if <code><body></code> has
<code>sidebar-mini</code>.
</td>
</tr>
<tr>
<td><code>isMobileSize()</code></td>
<td><code>boolean</code></td>
<td>
<code>true</code> if <code>window.innerWidth ≤ sidebarBreakpoint</code>.
</td>
</tr>
<tr>
<td><code>saveSidebarState(state)</code></td>
<td><code>void</code></td>
<td>
Manually save state to localStorage (<code
>"sidebar-open"</code
>
or <code>"sidebar-collapse"</code>).
</td>
</tr>
<tr>
<td><code>loadSidebarState()</code></td>
<td><code>void</code></td>
<td>Read state from localStorage and apply it.</td>
</tr>
<tr>
<td><code>clearSidebarState()</code></td>
<td><code>void</code></td>
<td>Remove saved state from localStorage.</td>
</tr>
<tr>
<td><code>updateStateByResponsiveLogic()</code></td>
<td><code>void</code></td>
<td>
Recompute correct state based on viewport size (collapse on mobile,
expand on desktop unless mini). Called automatically on resize.
</td>
</tr>
</tbody>
</table>
<h6 id="storage-key">Storage key</h6>
<p>
When <code>enablePersistence</code> is enabled, the plugin reads/writes
<code>localStorage.getItem("lte.sidebar.state")</code>. The stored
value is one of:
</p>
<ul>
<li>
<code>"sidebar-open"</code> — user wants the sidebar expanded
</li>
<li><code>"sidebar-collapse"</code> — user wants it collapsed</li>
</ul>
<h5 id="example">Example</h5>
<a href="#" data-lte-toggle="sidebar">Toggle Sidebar</a>
</div>
</div>
</div>
</div>
</div>
<!--end::Container-->
</div>
<!--end::App Content-->
</main>
<!--end::App Main-->
<!--begin::Footer-->
<footer class="app-footer">
<!--begin::To the end-->
<div class="float-end d-none d-sm-inline">Anything you want</div>
<!--end::To the end-->
<!--begin::Copyright-->
<strong>
Copyright © 2014-2026
<a href="https://adminlte.io" class="text-decoration-none">AdminLTE.io</a>.
</strong>
All rights reserved.
<!--end::Copyright-->
</footer>
<!--end::Footer-->
</div>
<!--end::App Wrapper-->
<!--begin::Script-->
<!--begin::Third Party Plugin(OverlayScrollbars)-->
<script
src="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/browser/overlayscrollbars.browser.es6.min.js"
crossorigin="anonymous"
></script>
<!--end::Third Party Plugin(OverlayScrollbars)--><!--begin::Required Plugin(popperjs for Bootstrap 5)-->
<script
src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js"
crossorigin="anonymous"
></script>
<!--end::Required Plugin(popperjs for Bootstrap 5)--><!--begin::Required Plugin(Bootstrap 5)-->
<script
src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/js/bootstrap.min.js"
crossorigin="anonymous"
></script>
<!--end::Required Plugin(Bootstrap 5)--><!--begin::Required Plugin(AdminLTE)-->
<script src="../../js/adminlte.js"></script>
<!--end::Required Plugin(AdminLTE)--><!--begin::OverlayScrollbars Configure-->
<script>
const SELECTOR_SIDEBAR_WRAPPER = '.sidebar-wrapper';
const Default = {
scrollbarTheme: 'os-theme-light',
scrollbarAutoHide: 'leave',
scrollbarClickScroll: true,
};
document.addEventListener('DOMContentLoaded', function () {
const sidebarWrapper = document.querySelector(SELECTOR_SIDEBAR_WRAPPER);
// Disable OverlayScrollbars on mobile devices to prevent touch interference
const isMobile = window.innerWidth <= 992;
if (
sidebarWrapper &&
OverlayScrollbarsGlobal?.OverlayScrollbars !== undefined &&
!isMobile
) {
OverlayScrollbarsGlobal.OverlayScrollbars(sidebarWrapper, {
scrollbars: {
theme: Default.scrollbarTheme,
autoHide: Default.scrollbarAutoHide,
clickScroll: Default.scrollbarClickScroll,
},
});
}
});
</script>
<!--end::OverlayScrollbars Configure--><!--begin::Color Mode Toggle (#6010)-->
<script>
(() => {
'use strict';
const STORAGE_KEY = 'lte-theme';
const getStoredTheme = () => localStorage.getItem(STORAGE_KEY);
const setStoredTheme = (theme) => localStorage.setItem(STORAGE_KEY, theme);
const prefersDark = () => globalThis.matchMedia('(prefers-color-scheme: dark)').matches;
const getPreferredTheme = () => {
const stored = getStoredTheme();
if (stored) return stored;
return prefersDark() ? 'dark' : 'light';
};
const setTheme = (theme) => {
const resolved = theme === 'auto' ? (prefersDark() ? 'dark' : 'light') : theme;
document.documentElement.setAttribute('data-bs-theme', resolved);
};
setTheme(getPreferredTheme());
const showActiveTheme = (theme) => {
// Highlight the active dropdown option
document.querySelectorAll('[data-bs-theme-value]').forEach((el) => {
el.classList.remove('active');
el.setAttribute('aria-pressed', 'false');
const check = el.querySelector('.bi-check-lg');
if (check) check.classList.add('d-none');
});
const active = document.querySelector(`[data-bs-theme-value="${theme}"]`);
if (active) {
active.classList.add('active');
active.setAttribute('aria-pressed', 'true');
const check = active.querySelector('.bi-check-lg');
if (check) check.classList.remove('d-none');
}
// Sync the topbar trigger icon
document.querySelectorAll('[data-lte-theme-icon]').forEach((icon) => {
icon.classList.toggle('d-none', icon.dataset.lteThemeIcon !== theme);
});
};
globalThis.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
const stored = getStoredTheme();
if (!stored || stored === 'auto') setTheme(getPreferredTheme());
});
document.addEventListener('DOMContentLoaded', () => {
showActiveTheme(getPreferredTheme());
document.querySelectorAll('[data-bs-theme-value]').forEach((toggle) => {
toggle.addEventListener('click', () => {
const theme = toggle.getAttribute('data-bs-theme-value');
setStoredTheme(theme);
setTheme(theme);
showActiveTheme(theme);
});
});
});
})();
</script>
<!--end::Color Mode Toggle-->
<!--end::Script-->
</body>
<!--end::Body-->
</html>