UNPKG

adminlte4

Version:
1,041 lines (1,018 loc) 53.2 kB
<!doctype html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Migration from v3 | 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="Migration from v3 | 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> <body class="layout-fixed sidebar-expand-lg bg-body-tertiary docs-page"> <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">&middot; 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"> <a href="#" class="nav-link"> <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"> <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 active"> <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)--> <main class="app-main"> <div class="app-content-header"> <div class="container-fluid"> <div class="row"> <div class="col-sm-6"> <h3 class="mb-0">Migration from v3</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">Migration</li> </ol> </div> </div> </div> </div> <div class="app-content"> <div class="container-fluid"> <div class="row"> <div class="col-12"> <div class="card"> <div class="card-body"> <p> AdminLTE 4 is a ground-up rewrite. It targets Bootstrap 5.3, drops jQuery, ships as TypeScript-authored vanilla JS, and reorganises the CSS class structure. If you’re upgrading an AdminLTE 3 project, the changes below are the ones most likely to bite. </p> <h5 id="the-high-level-summary">The high-level summary</h5> <table> <thead> <tr> <th></th> <th>AdminLTE 3</th> <th>AdminLTE 4</th> </tr> </thead> <tbody> <tr> <td>CSS framework</td> <td>Bootstrap 4.6</td> <td><strong>Bootstrap 5.3</strong></td> </tr> <tr> <td>JavaScript</td> <td>jQuery + vanilla</td> <td><strong>Vanilla TypeScript only</strong></td> </tr> <tr> <td>Dark mode</td> <td>Manual <code>.dark-mode</code> class</td> <td> <strong><code>data-bs-theme</code> attribute (Bootstrap-native)</strong> </td> </tr> <tr> <td>RTL</td> <td>Separate <code>rtl.css</code> build</td> <td><strong>Generated automatically via rtlcss</strong></td> </tr> <tr> <td>Browser support</td> <td>IE 11 forks available</td> <td>Modern evergreen browsers only</td> </tr> <tr> <td>Build tooling</td> <td>Gulp</td> <td><strong>Rollup + Sass + PostCSS</strong></td> </tr> <tr> <td>Icon library</td> <td>FontAwesome</td> <td> <strong>Bootstrap Icons</strong> (Lucide / Tabler Icons documented as alternatives) </td> </tr> </tbody> </table> <p> If your project relies on jQuery or IE 11, stay on AdminLTE 3 — those constraints are not reversible in v4. </p> <h5 id="class-renames">Class renames</h5> <p>The most common find-and-replace work:</p> <table> <thead> <tr> <th>AdminLTE 3</th> <th>AdminLTE 4</th> </tr> </thead> <tbody> <tr> <td><code>.wrapper</code></td> <td><code>.app-wrapper</code></td> </tr> <tr> <td><code>.main-header</code></td> <td><code>.app-header</code></td> </tr> <tr> <td><code>.main-sidebar</code></td> <td><code>.app-sidebar</code></td> </tr> <tr> <td><code>.content-wrapper</code></td> <td><code>.app-main</code></td> </tr> <tr> <td><code>.main-footer</code></td> <td><code>.app-footer</code></td> </tr> <tr> <td><code>.content-header</code></td> <td><code>.app-content-header</code></td> </tr> <tr> <td><code>.content</code></td> <td><code>.app-content</code></td> </tr> <tr> <td><code>.brand-link</code> (inside <code>.main-sidebar</code>)</td> <td><code>.sidebar-brand &gt; .brand-link</code></td> </tr> <tr> <td><code>data-widget=&quot;pushmenu&quot;</code></td> <td><code>data-lte-toggle=&quot;sidebar&quot;</code></td> </tr> <tr> <td><code>data-widget=&quot;treeview&quot;</code></td> <td> <code>data-lte-toggle=&quot;treeview&quot;</code> (on the parent menu) </td> </tr> <tr> <td><code>data-widget=&quot;card-widget&quot;</code></td> <td> <code>data-lte-toggle=&quot;card-collapse&quot;</code>, <code>card-remove</code>, <code>card-maximize</code> </td> </tr> <tr> <td><code>data-widget=&quot;fullscreen&quot;</code></td> <td><code>data-lte-toggle=&quot;fullscreen&quot;</code></td> </tr> <tr> <td><code>data-widget=&quot;control-sidebar&quot;</code></td> <td>(removed — Bootstrap offcanvas replaces this)</td> </tr> <tr> <td><code>.dark-mode</code> (on <code>&lt;body&gt;</code>)</td> <td><code>data-bs-theme=&quot;dark&quot;</code> (on any element)</td> </tr> </tbody> </table> <h5 id="bootstrap-4--5-utility-renames">Bootstrap 4 → 5 utility renames</h5> <p> These come from Bootstrap itself, not AdminLTE, but they affect every page: </p> <table> <thead> <tr> <th>Bootstrap 4</th> <th>Bootstrap 5</th> </tr> </thead> <tbody> <tr> <td><code>data-toggle</code></td> <td><code>data-bs-toggle</code></td> </tr> <tr> <td><code>data-target</code></td> <td><code>data-bs-target</code></td> </tr> <tr> <td><code>data-dismiss</code></td> <td><code>data-bs-dismiss</code></td> </tr> <tr> <td><code>data-parent</code></td> <td><code>data-bs-parent</code></td> </tr> <tr> <td><code>data-spy</code></td> <td><code>data-bs-spy</code></td> </tr> <tr> <td><code>data-ride</code></td> <td><code>data-bs-ride</code></td> </tr> <tr> <td><code>.ml-*</code>, <code>.mr-*</code></td> <td><code>.ms-*</code>, <code>.me-*</code></td> </tr> <tr> <td><code>.pl-*</code>, <code>.pr-*</code></td> <td><code>.ps-*</code>, <code>.pe-*</code></td> </tr> <tr> <td><code>.float-left</code>, <code>.float-right</code></td> <td><code>.float-start</code>, <code>.float-end</code></td> </tr> <tr> <td><code>.text-left</code>, <code>.text-right</code></td> <td><code>.text-start</code>, <code>.text-end</code></td> </tr> <tr> <td><code>.border-left</code>, <code>.border-right</code></td> <td><code>.border-start</code>, <code>.border-end</code></td> </tr> <tr> <td><code>.rounded-left</code>, <code>.rounded-right</code></td> <td><code>.rounded-start</code>, <code>.rounded-end</code></td> </tr> <tr> <td><code>.font-weight-*</code></td> <td><code>.fw-*</code></td> </tr> <tr> <td><code>.font-italic</code></td> <td><code>.fst-italic</code></td> </tr> <tr> <td><code>.text-monospace</code></td> <td><code>.font-monospace</code></td> </tr> </tbody> </table> <p> A regex find-replace handles most of this in a few minutes. The migration tool <a href="https://github.com/dbtek/bootstrap-5-migration" ><code>bootstrap-5-migration</code></a > automates the bulk. </p> <h5 id="jquery-removal">jQuery removal</h5> <p> If your app code calls AdminLTE 3 plugins via jQuery (<code>$(&#39;.sidebar&#39;).PushMenu()</code>, etc.), those calls no longer work. Replacements: </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:#6A9955">// AdminLTE 3</span></span> <span class="line"><span style="color:#DCDCAA">$</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">&#39;.sidebar-toggle&#39;</span><span style="color:#D4D4D4">).</span><span style="color:#DCDCAA">on</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">&#39;click&#39;</span><span style="color:#D4D4D4">, </span><span style="color:#569CD6">function</span><span style="color:#D4D4D4"> () {</span></span> <span class="line"><span style="color:#DCDCAA"> $</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">&#39;body&#39;</span><span style="color:#D4D4D4">).</span><span style="color:#DCDCAA">toggleClass</span><span style="color:#D4D4D4">(</span><span style="color:#CE9178">&#39;sidebar-collapse&#39;</span><span style="color:#D4D4D4">)</span></span> <span class="line"><span style="color:#D4D4D4">})</span></span></code></pre> <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:#6A9955">// AdminLTE 4 — the data-API does this for you</span></span> <span class="line"><span style="color:#6A9955">// &lt;a href=&quot;#&quot; data-lte-toggle=&quot;sidebar&quot;&gt;...&lt;/a&gt;</span></span></code></pre> <p>If you need programmatic control, import the plugin class directly:</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"> &quot;admin-lte&quot;</span></span> <span class="line"></span> <span class="line"><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">&quot;.sidebar-toggle&quot;</span><span style="color:#D4D4D4">)).</span><span style="color:#DCDCAA">toggle</span><span style="color:#D4D4D4">()</span></span></code></pre> <p> All seven JS plugins (<code>Layout</code>, <code>CardWidget</code>, <code>Treeview</code>, <code>DirectChat</code>, <code>FullScreen</code>, <code>PushMenu</code>, plus <code>initAccessibility</code>) are exported from <code>admin-lte</code>. </p> <h5 id="dark-mode">Dark mode</h5> <p> AdminLTE 3 used a <code>.dark-mode</code> class toggled on the <code>&lt;body&gt;</code>. AdminLTE 4 uses Bootstrap 5.3’s native <code>data-bs-theme=&quot;dark&quot;</code> attribute, which can be applied at any level — <code>&lt;html&gt;</code>, <code>&lt;body&gt;</code>, or a single component. </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:#6A9955">&lt;!-- AdminLTE 3 --&gt;</span></span> <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">body</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;dark-mode&quot;</span><span style="color:#808080">&gt;</span></span> <span class="line"></span> <span class="line"><span style="color:#6A9955">&lt;!-- AdminLTE 4 --&gt;</span></span> <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">html</span><span style="color:#9CDCFE"> data-bs-theme</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;dark&quot;</span><span style="color:#808080">&gt;</span></span></code></pre> <p> The included <a href="color-mode.html">Color Mode</a> widget reads/writes this attribute and persists the user’s choice in <code>localStorage</code>. See the <a href="color-mode.html">Color Mode</a> docs page for the toggle implementation. </p> <h5 id="css-variables-instead-of-bg--overrides"> CSS variables instead of <code>.bg-*</code> overrides </h5> <p> AdminLTE 3 shipped a lot of one-off colour classes (<code>.bg-navy</code>, <code>.bg-purple</code>, <code>.bg-fuchsia</code>, etc.). In v4, prefer Bootstrap 5.3’s CSS-variable model: </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:#6A9955">&lt;!-- AdminLTE 3 --&gt;</span></span> <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">div</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;card bg-navy&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">…</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span> <span class="line"></span> <span class="line"><span style="color:#6A9955">&lt;!-- AdminLTE 4 — use Bootstrap utilities + CSS variables --&gt;</span></span> <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">div</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;card text-bg-primary&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">…</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span></code></pre> <p> For full retheming, override <code>--bs-primary</code> etc. on <code>:root</code>. See <a href="customization.html">Customization</a>. </p> <h5 id="icons">Icons</h5> <p> AdminLTE 3 demos used FontAwesome 6 free. AdminLTE 4 standardises on <a href="https://icons.getbootstrap.com/">Bootstrap Icons</a> — they’re SVG, lighter, MIT-licensed, and ship with Bootstrap’s ecosystem. </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:#6A9955">&lt;!-- AdminLTE 3 --&gt;</span></span> <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">i</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;fas fa-home&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span> <span class="line"></span> <span class="line"><span style="color:#6A9955">&lt;!-- AdminLTE 4 --&gt;</span></span> <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">i</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;bi bi-house&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span></code></pre> <p> If you’d rather stick with FontAwesome (or use Lucide, Tabler Icons, Material Symbols, etc.), nothing in AdminLTE 4 forces Bootstrap Icons — load whichever icon font you prefer and replace the <code>&lt;i&gt;</code> classes. See <a href="integrations.html#icon-libraries">Recommended Integrations</a> for the comparison table. </p> <h5 id="pages-we-havent-ported-yet">Pages we haven’t ported yet</h5> <p> The v3 demo includes pages that haven’t all been recreated for v4. The v4 release notes cover the current page catalog. If you depend on a specific v3 page that hasn’t been ported, please <a href="https://github.com/ColorlibHQ/AdminLTE/issues">open an issue</a> — community contributions for missing pages are very welcome. </p> <h5 id="suggested-migration-order">Suggested migration order</h5> <p>For an existing AdminLTE 3 project:</p> <ol> <li> <strong>Branch first.</strong> This is not a small change — keep <code>master</code> on v3 until v4 is stable. </li> <li> <strong>Update CSS class names</strong> with a find-replace pass using the table above. Most layouts compile but look broken until step 3. </li> <li> <strong >Update <code>data-toggle</code> → <code>data-bs-toggle</code></strong > etc. across all your templates. </li> <li> <strong>Replace <code>.dark-mode</code> toggle code</strong> with <code>data-bs-theme</code> attribute writes. </li> <li> <strong>Audit jQuery calls.</strong> Either remove them (use the data API) or import plugin classes directly. </li> <li> <strong>Test responsive breakpoints</strong> — Bootstrap 5 added <code>xxl</code>. If you use breakpoint-specific utilities, double-check the new scale. </li> <li> <strong>Re-test print views</strong> — AdminLTE 4 fixed a print-layout issue (#5996); if you had custom print CSS, verify it still works. </li> </ol> <h5 id="help-and-discussion">Help and discussion</h5> <ul> <li> Migration questions: <a href="https://github.com/ColorlibHQ/AdminLTE/discussions" >GitHub Discussions</a > </li> <li> Found something we missed? <a href="https://github.com/ColorlibHQ/AdminLTE/issues">Open an issue</a> tagged <code>migration</code>. </li> </ul> </div> </div> </div> </div> </div> </div> </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 &copy; 2014-2026&nbsp; <a href="https://adminlte.io" class="text-decoration-none">AdminLTE.io</a>. </strong> All rights reserved. <!--end::Copyright--> </footer> <!--end::Footer--> </div> <!--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 m