plugins-overview.html 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <title>JavaScript Plugins Overview | AdminLTE 4</title>
  6. <!--begin::Accessibility Meta Tags-->
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  8. <meta name="color-scheme" content="light dark" />
  9. <meta name="theme-color" content="#007bff" media="(prefers-color-scheme: light)" />
  10. <meta name="theme-color" content="#1a1a1a" media="(prefers-color-scheme: dark)" />
  11. <!--end::Accessibility Meta Tags-->
  12. <!--begin::Primary Meta Tags-->
  13. <meta name="title" content="JavaScript Plugins Overview | AdminLTE 4" />
  14. <meta name="author" content="ColorlibHQ" />
  15. <meta
  16. name="description"
  17. content="AdminLTE is a Free Bootstrap 5 Admin Dashboard, 30 example pages using Vanilla JS. Fully accessible with WCAG 2.1 AA compliance."
  18. />
  19. <meta
  20. name="keywords"
  21. 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"
  22. />
  23. <!--end::Primary Meta Tags-->
  24. <!--begin::Accessibility Features-->
  25. <!-- Skip links will be dynamically added by accessibility.js -->
  26. <meta name="supported-color-schemes" content="light dark" />
  27. <link rel="preload" href="../../css/adminlte.css" as="style" />
  28. <!--end::Accessibility Features-->
  29. <!--begin::Fonts-->
  30. <link
  31. rel="stylesheet"
  32. href="https://cdn.jsdelivr.net/npm/@fontsource/source-sans-3@5.0.12/index.css"
  33. integrity="sha256-tXJfXfp6Ewt1ilPzLDtQnJV4hclT9XuaZUKyUvmyr+Q="
  34. crossorigin="anonymous"
  35. media="print"
  36. onload="this.media = 'all'"
  37. />
  38. <!--end::Fonts-->
  39. <!--begin::Third Party Plugin(OverlayScrollbars)-->
  40. <link
  41. rel="stylesheet"
  42. href="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/styles/overlayscrollbars.min.css"
  43. crossorigin="anonymous"
  44. />
  45. <!--end::Third Party Plugin(OverlayScrollbars)-->
  46. <!--begin::Third Party Plugin(Bootstrap Icons)-->
  47. <link
  48. rel="stylesheet"
  49. href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.13.1/font/bootstrap-icons.min.css"
  50. crossorigin="anonymous"
  51. />
  52. <!--end::Third Party Plugin(Bootstrap Icons)-->
  53. <!--begin::Required Plugin(AdminLTE)-->
  54. <link rel="stylesheet" href="../../css/adminlte.css" />
  55. <!--end::Required Plugin(AdminLTE)-->
  56. </head>
  57. <body class="layout-fixed sidebar-expand-lg bg-body-tertiary docs-page">
  58. <div class="app-wrapper">
  59. <!--begin::Header-->
  60. <nav class="app-header navbar navbar-expand bg-body">
  61. <!--begin::Container-->
  62. <div class="container-fluid">
  63. <!--begin::Start Navbar Links-->
  64. <ul class="navbar-nav">
  65. <li class="nav-item">
  66. <a class="nav-link" data-lte-toggle="sidebar" href="#" role="button">
  67. <i class="bi bi-list"></i>
  68. </a>
  69. </li>
  70. <li class="nav-item d-none d-md-block">
  71. <a href="../../docs/introduction.html" class="nav-link">
  72. <i class="bi bi-book me-1" aria-hidden="true"></i>
  73. Documentation
  74. </a>
  75. </li>
  76. <li class="nav-item d-none d-md-block">
  77. <a href="../../index.html" class="nav-link">
  78. <i class="bi bi-arrow-left me-1" aria-hidden="true"></i>
  79. Back to live preview
  80. </a>
  81. </li>
  82. </ul>
  83. <!--end::Start Navbar Links-->
  84. <!--begin::End Navbar Links-->
  85. <ul class="navbar-nav ms-auto">
  86. <!--begin::Navbar Search-->
  87. <li class="nav-item">
  88. <a class="nav-link" data-widget="navbar-search" href="#" role="button">
  89. <i class="bi bi-search"></i>
  90. </a>
  91. </li>
  92. <!--end::Navbar Search-->
  93. <!--begin::Messages Dropdown Menu-->
  94. <li class="nav-item dropdown">
  95. <a class="nav-link" data-bs-toggle="dropdown" href="#">
  96. <i class="bi bi-chat-text"></i>
  97. <span class="navbar-badge badge text-bg-danger">3</span>
  98. </a>
  99. <div class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
  100. <a href="#" class="dropdown-item">
  101. <!--begin::Message-->
  102. <div class="d-flex">
  103. <div class="flex-shrink-0">
  104. <img
  105. src="../../assets/img/user1-128x128.jpg"
  106. alt="User Avatar"
  107. class="img-size-50 rounded-circle me-3"
  108. />
  109. </div>
  110. <div class="flex-grow-1">
  111. <h3 class="dropdown-item-title">
  112. Brad Diesel
  113. <span class="float-end fs-7 text-danger"
  114. ><i class="bi bi-star-fill"></i
  115. ></span>
  116. </h3>
  117. <p class="fs-7">Call me whenever you can...</p>
  118. <p class="fs-7 text-secondary">
  119. <i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
  120. </p>
  121. </div>
  122. </div>
  123. <!--end::Message-->
  124. </a>
  125. <div class="dropdown-divider"></div>
  126. <a href="#" class="dropdown-item">
  127. <!--begin::Message-->
  128. <div class="d-flex">
  129. <div class="flex-shrink-0">
  130. <img
  131. src="../../assets/img/user8-128x128.jpg"
  132. alt="User Avatar"
  133. class="img-size-50 rounded-circle me-3"
  134. />
  135. </div>
  136. <div class="flex-grow-1">
  137. <h3 class="dropdown-item-title">
  138. John Pierce
  139. <span class="float-end fs-7 text-secondary">
  140. <i class="bi bi-star-fill"></i>
  141. </span>
  142. </h3>
  143. <p class="fs-7">I got your message bro</p>
  144. <p class="fs-7 text-secondary">
  145. <i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
  146. </p>
  147. </div>
  148. </div>
  149. <!--end::Message-->
  150. </a>
  151. <div class="dropdown-divider"></div>
  152. <a href="#" class="dropdown-item">
  153. <!--begin::Message-->
  154. <div class="d-flex">
  155. <div class="flex-shrink-0">
  156. <img
  157. src="../../assets/img/user3-128x128.jpg"
  158. alt="User Avatar"
  159. class="img-size-50 rounded-circle me-3"
  160. />
  161. </div>
  162. <div class="flex-grow-1">
  163. <h3 class="dropdown-item-title">
  164. Nora Silvester
  165. <span class="float-end fs-7 text-warning">
  166. <i class="bi bi-star-fill"></i>
  167. </span>
  168. </h3>
  169. <p class="fs-7">The subject goes here</p>
  170. <p class="fs-7 text-secondary">
  171. <i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
  172. </p>
  173. </div>
  174. </div>
  175. <!--end::Message-->
  176. </a>
  177. <div class="dropdown-divider"></div>
  178. <a href="#" class="dropdown-item dropdown-footer">See All Messages</a>
  179. </div>
  180. </li>
  181. <!--end::Messages Dropdown Menu-->
  182. <!--begin::Notifications Dropdown Menu-->
  183. <li class="nav-item dropdown">
  184. <a class="nav-link" data-bs-toggle="dropdown" href="#">
  185. <i class="bi bi-bell-fill"></i>
  186. <span class="navbar-badge badge text-bg-warning">15</span>
  187. </a>
  188. <div class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
  189. <span class="dropdown-item dropdown-header">15 Notifications</span>
  190. <div class="dropdown-divider"></div>
  191. <a href="#" class="dropdown-item">
  192. <i class="bi bi-envelope me-2"></i> 4 new messages
  193. <span class="float-end text-secondary fs-7">3 mins</span>
  194. </a>
  195. <div class="dropdown-divider"></div>
  196. <a href="#" class="dropdown-item">
  197. <i class="bi bi-people-fill me-2"></i> 8 friend requests
  198. <span class="float-end text-secondary fs-7">12 hours</span>
  199. </a>
  200. <div class="dropdown-divider"></div>
  201. <a href="#" class="dropdown-item">
  202. <i class="bi bi-file-earmark-fill me-2"></i> 3 new reports
  203. <span class="float-end text-secondary fs-7">2 days</span>
  204. </a>
  205. <div class="dropdown-divider"></div>
  206. <a href="#" class="dropdown-item dropdown-footer"> See All Notifications </a>
  207. </div>
  208. </li>
  209. <!--end::Notifications Dropdown Menu-->
  210. <!--begin::Fullscreen Toggle-->
  211. <li class="nav-item">
  212. <a class="nav-link" href="#" data-lte-toggle="fullscreen">
  213. <i data-lte-icon="maximize" class="bi bi-arrows-fullscreen"></i>
  214. <i data-lte-icon="minimize" class="bi bi-fullscreen-exit d-none"></i>
  215. </a>
  216. </li>
  217. <!--end::Fullscreen Toggle-->
  218. <!--begin::Color Mode Toggle (#6010)-->
  219. <li class="nav-item dropdown">
  220. <a
  221. class="nav-link"
  222. href="#"
  223. id="bd-theme"
  224. aria-label="Toggle color scheme"
  225. data-bs-toggle="dropdown"
  226. aria-expanded="false"
  227. >
  228. <i class="bi bi-sun-fill" data-lte-theme-icon="light"></i>
  229. <i class="bi bi-moon-fill d-none" data-lte-theme-icon="dark"></i>
  230. <i class="bi bi-circle-half d-none" data-lte-theme-icon="auto"></i>
  231. </a>
  232. <ul
  233. class="dropdown-menu dropdown-menu-end"
  234. aria-labelledby="bd-theme"
  235. style="--bs-dropdown-min-width: 8rem"
  236. >
  237. <li>
  238. <button
  239. type="button"
  240. class="dropdown-item d-flex align-items-center"
  241. data-bs-theme-value="light"
  242. aria-pressed="false"
  243. >
  244. <i class="bi bi-sun-fill me-2"></i>
  245. Light
  246. <i class="bi bi-check-lg ms-auto d-none"></i>
  247. </button>
  248. </li>
  249. <li>
  250. <button
  251. type="button"
  252. class="dropdown-item d-flex align-items-center"
  253. data-bs-theme-value="dark"
  254. aria-pressed="false"
  255. >
  256. <i class="bi bi-moon-fill me-2"></i>
  257. Dark
  258. <i class="bi bi-check-lg ms-auto d-none"></i>
  259. </button>
  260. </li>
  261. <li>
  262. <button
  263. type="button"
  264. class="dropdown-item d-flex align-items-center active"
  265. data-bs-theme-value="auto"
  266. aria-pressed="true"
  267. >
  268. <i class="bi bi-circle-half me-2"></i>
  269. Auto
  270. <i class="bi bi-check-lg ms-auto d-none"></i>
  271. </button>
  272. </li>
  273. </ul>
  274. </li>
  275. <!--end::Color Mode Toggle-->
  276. <!--begin::User Menu Dropdown-->
  277. <li class="nav-item dropdown user-menu">
  278. <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown">
  279. <img
  280. src="../../assets/img/user2-160x160.jpg"
  281. class="user-image rounded-circle shadow"
  282. alt="User Image"
  283. />
  284. <span class="d-none d-md-inline">Alexander Pierce</span>
  285. </a>
  286. <ul class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
  287. <!--begin::User Image-->
  288. <li class="user-header text-bg-primary">
  289. <img
  290. src="../../assets/img/user2-160x160.jpg"
  291. class="rounded-circle shadow"
  292. alt="User Image"
  293. />
  294. <p>
  295. Alexander Pierce - Web Developer
  296. <small>Member since Nov. 2023</small>
  297. </p>
  298. </li>
  299. <!--end::User Image-->
  300. <!--begin::Menu Body-->
  301. <li class="user-body">
  302. <!--begin::Row-->
  303. <div class="row">
  304. <div class="col-4 text-center">
  305. <a href="#">Followers</a>
  306. </div>
  307. <div class="col-4 text-center">
  308. <a href="#">Sales</a>
  309. </div>
  310. <div class="col-4 text-center">
  311. <a href="#">Friends</a>
  312. </div>
  313. </div>
  314. <!--end::Row-->
  315. </li>
  316. <!--end::Menu Body-->
  317. <!--begin::Menu Footer-->
  318. <li class="user-footer">
  319. <a href="#" class="btn btn-outline-secondary">Profile</a>
  320. <a href="#" class="btn btn-outline-danger float-end">Sign out</a>
  321. </li>
  322. <!--end::Menu Footer-->
  323. </ul>
  324. </li>
  325. <!--end::User Menu Dropdown-->
  326. </ul>
  327. <!--end::End Navbar Links-->
  328. </div>
  329. <!--end::Container-->
  330. </nav>
  331. <!--end::Header-->
  332. <!--begin::Sidebar (docs mode)-->
  333. <aside class="app-sidebar bg-body-secondary shadow" data-bs-theme="dark">
  334. <!--begin::Sidebar Brand-->
  335. <div class="sidebar-brand">
  336. <a href="../../docs/introduction.html" class="brand-link">
  337. <img
  338. src="../../assets/img/AdminLTELogo.png"
  339. alt="AdminLTE Logo"
  340. class="brand-image opacity-75 shadow"
  341. />
  342. <span class="brand-text fw-light">
  343. AdminLTE 4 <span class="opacity-75">&middot; Docs</span>
  344. </span>
  345. </a>
  346. </div>
  347. <!--end::Sidebar Brand-->
  348. <!--begin::Sidebar Wrapper-->
  349. <div class="sidebar-wrapper">
  350. <nav class="mt-2">
  351. <!--begin::Sidebar Menu-->
  352. <ul
  353. class="nav sidebar-menu flex-column"
  354. data-lte-toggle="treeview"
  355. role="navigation"
  356. aria-label="Documentation navigation"
  357. data-accordion="false"
  358. id="docs-navigation"
  359. >
  360. <li class="nav-header">START HERE</li>
  361. <li class="nav-item">
  362. <a href="../../docs/introduction.html" class="nav-link">
  363. <i class="nav-icon bi bi-download"></i>
  364. <p>Installation</p>
  365. </a>
  366. </li>
  367. <li class="nav-item">
  368. <a href="../../docs/getting-started.html" class="nav-link">
  369. <i class="nav-icon bi bi-rocket-takeoff"></i>
  370. <p>Getting Started</p>
  371. </a>
  372. </li>
  373. <li class="nav-header">FOUNDATIONS</li>
  374. <li class="nav-item">
  375. <a href="../../docs/layout.html" class="nav-link">
  376. <i class="nav-icon bi bi-grip-horizontal"></i>
  377. <p>Layout Classes</p>
  378. </a>
  379. </li>
  380. <li class="nav-item">
  381. <a href="../../docs/layout-blueprint.html" class="nav-link">
  382. <i class="nav-icon bi bi-diagram-3"></i>
  383. <p>Layout Blueprint</p>
  384. </a>
  385. </li>
  386. <li class="nav-item">
  387. <a href="../../docs/customization.html" class="nav-link">
  388. <i class="nav-icon bi bi-palette"></i>
  389. <p>Customization</p>
  390. </a>
  391. </li>
  392. <li class="nav-item">
  393. <a href="../../docs/color-mode.html" class="nav-link">
  394. <i class="nav-icon bi bi-star-half"></i>
  395. <p>Color Mode</p>
  396. </a>
  397. </li>
  398. <li class="nav-item">
  399. <a href="../../docs/rtl.html" class="nav-link">
  400. <i class="nav-icon bi bi-text-paragraph"></i>
  401. <p>RTL Support</p>
  402. </a>
  403. </li>
  404. <li class="nav-header">BUILDING</li>
  405. <li class="nav-item">
  406. <a href="../../docs/recipes.html" class="nav-link">
  407. <i class="nav-icon bi bi-clipboard-check"></i>
  408. <p>Recipes</p>
  409. </a>
  410. </li>
  411. <li class="nav-item">
  412. <a href="#" class="nav-link">
  413. <i class="nav-icon bi bi-ui-checks-grid"></i>
  414. <p>
  415. Components
  416. <i class="nav-arrow bi bi-chevron-right"></i>
  417. </p>
  418. </a>
  419. <ul class="nav nav-treeview">
  420. <li class="nav-item">
  421. <a href="../../docs/components/main-header.html" class="nav-link">
  422. <i class="nav-icon bi bi-circle"></i>
  423. <p>Main Header</p>
  424. </a>
  425. </li>
  426. <li class="nav-item">
  427. <a href="../../docs/components/main-sidebar.html" class="nav-link">
  428. <i class="nav-icon bi bi-circle"></i>
  429. <p>Main Sidebar</p>
  430. </a>
  431. </li>
  432. </ul>
  433. </li>
  434. <li class="nav-item menu-open">
  435. <a href="#" class="nav-link active">
  436. <i class="nav-icon bi bi-filetype-js"></i>
  437. <p>
  438. JavaScript Plugins
  439. <i class="nav-arrow bi bi-chevron-right"></i>
  440. </p>
  441. </a>
  442. <ul class="nav nav-treeview">
  443. <li class="nav-item">
  444. <a href="../../docs/javascript/plugins-overview.html" class="nav-link active">
  445. <i class="nav-icon bi bi-circle"></i>
  446. <p>Overview</p>
  447. </a>
  448. </li>
  449. <li class="nav-item">
  450. <a href="../../docs/javascript/layout.html" class="nav-link">
  451. <i class="nav-icon bi bi-circle"></i>
  452. <p>Layout</p>
  453. </a>
  454. </li>
  455. <li class="nav-item">
  456. <a href="../../docs/javascript/pushmenu.html" class="nav-link">
  457. <i class="nav-icon bi bi-circle"></i>
  458. <p>PushMenu</p>
  459. </a>
  460. </li>
  461. <li class="nav-item">
  462. <a href="../../docs/javascript/treeview.html" class="nav-link">
  463. <i class="nav-icon bi bi-circle"></i>
  464. <p>Treeview</p>
  465. </a>
  466. </li>
  467. <li class="nav-item">
  468. <a href="../../docs/javascript/card-widget.html" class="nav-link">
  469. <i class="nav-icon bi bi-circle"></i>
  470. <p>Card Widget</p>
  471. </a>
  472. </li>
  473. <li class="nav-item">
  474. <a href="../../docs/javascript/direct-chat.html" class="nav-link">
  475. <i class="nav-icon bi bi-circle"></i>
  476. <p>Direct Chat</p>
  477. </a>
  478. </li>
  479. <li class="nav-item">
  480. <a href="../../docs/javascript/fullscreen.html" class="nav-link">
  481. <i class="nav-icon bi bi-circle"></i>
  482. <p>Fullscreen</p>
  483. </a>
  484. </li>
  485. <li class="nav-item">
  486. <a href="../../docs/javascript/accessibility.html" class="nav-link">
  487. <i class="nav-icon bi bi-circle"></i>
  488. <p>Accessibility</p>
  489. </a>
  490. </li>
  491. </ul>
  492. </li>
  493. <li class="nav-item">
  494. <a href="../../docs/integrations.html" class="nav-link">
  495. <i class="nav-icon bi bi-puzzle"></i>
  496. <p>Integrations</p>
  497. </a>
  498. </li>
  499. <li class="nav-header">SHIPPING</li>
  500. <li class="nav-item">
  501. <a href="../../docs/migration.html" class="nav-link">
  502. <i class="nav-icon bi bi-arrow-up-right-square"></i>
  503. <p>Migration from v3</p>
  504. </a>
  505. </li>
  506. <li class="nav-item">
  507. <a href="../../docs/deployment.html" class="nav-link">
  508. <i class="nav-icon bi bi-cloud-upload"></i>
  509. <p>Deployment</p>
  510. </a>
  511. </li>
  512. <li class="nav-item">
  513. <a href="../../docs/browser-support.html" class="nav-link">
  514. <i class="nav-icon bi bi-browser-chrome"></i>
  515. <p>Browser Support</p>
  516. </a>
  517. </li>
  518. <li class="nav-header">RESOURCES</li>
  519. <li class="nav-item">
  520. <a href="../../docs/faq.html" class="nav-link">
  521. <i class="nav-icon bi bi-question-circle"></i>
  522. <p>FAQ</p>
  523. </a>
  524. </li>
  525. <li class="nav-item">
  526. <a href="../../docs/how-to-contribute.html" class="nav-link">
  527. <i class="nav-icon bi bi-people"></i>
  528. <p>Contributing</p>
  529. </a>
  530. </li>
  531. <li class="nav-item">
  532. <a href="../../docs/license.html" class="nav-link">
  533. <i class="nav-icon bi bi-patch-check"></i>
  534. <p>License</p>
  535. </a>
  536. </li>
  537. <li class="nav-item">
  538. <a
  539. href="https://github.com/ColorlibHQ/AdminLTE"
  540. target="_blank"
  541. rel="noopener"
  542. class="nav-link"
  543. >
  544. <i class="nav-icon bi bi-github"></i>
  545. <p>
  546. GitHub
  547. <i class="bi bi-box-arrow-up-right ms-1" aria-hidden="true"></i>
  548. </p>
  549. </a>
  550. </li>
  551. </ul>
  552. <!--end::Sidebar Menu-->
  553. <!-- Back to preview CTA (bottom of sidebar) -->
  554. <div class="p-3 mt-3 border-top border-secondary border-opacity-25">
  555. <a
  556. href="../../index.html"
  557. class="btn btn-sm btn-outline-light w-100 d-flex align-items-center justify-content-center gap-2"
  558. >
  559. <i class="bi bi-arrow-left" aria-hidden="true"></i>
  560. Back to live preview
  561. </a>
  562. </div>
  563. </nav>
  564. </div>
  565. <!--end::Sidebar Wrapper-->
  566. </aside>
  567. <!--end::Sidebar (docs mode)-->
  568. <main class="app-main">
  569. <div class="app-content-header">
  570. <div class="container-fluid">
  571. <div class="row">
  572. <div class="col-sm-6">
  573. <h3 class="mb-0">JavaScript Plugins Overview</h3>
  574. </div>
  575. <div class="col-sm-6">
  576. <ol class="breadcrumb float-sm-end">
  577. <li class="breadcrumb-item"><a href="#">Docs</a></li>
  578. <li class="breadcrumb-item"><a href="#">JavaScript</a></li>
  579. <li class="breadcrumb-item active" aria-current="page">Overview</li>
  580. </ol>
  581. </div>
  582. </div>
  583. </div>
  584. </div>
  585. <div class="app-content">
  586. <div class="container-fluid">
  587. <div class="row">
  588. <div class="col-12">
  589. <div class="card">
  590. <div class="card-body">
  591. <p>
  592. AdminLTE ships seven JavaScript plugins as a single bundle
  593. (<code>adminlte.js</code>). Each one is exported from the package root, can be
  594. triggered via <code>data-lte-*</code> attributes for declarative use, and
  595. exposes a programmatic API for code-driven control.
  596. </p>
  597. <h5 id="at-a-glance">At a glance</h5>
  598. <table>
  599. <thead>
  600. <tr>
  601. <th>Plugin</th>
  602. <th>Data API</th>
  603. <th>Programmatic</th>
  604. <th>Documentation</th>
  605. </tr>
  606. </thead>
  607. <tbody>
  608. <tr>
  609. <td><strong>PushMenu</strong></td>
  610. <td><code>data-lte-toggle=&quot;sidebar&quot;</code></td>
  611. <td>
  612. <code>.toggle()</code> / <code>.expand()</code> /
  613. <code>.collapse()</code>
  614. </td>
  615. <td><a href="pushmenu.html">Reference</a></td>
  616. </tr>
  617. <tr>
  618. <td><strong>Treeview</strong></td>
  619. <td><code>data-lte-toggle=&quot;treeview&quot;</code> on parent menu</td>
  620. <td>
  621. <code>.toggle()</code> / <code>.open()</code> / <code>.close()</code>
  622. </td>
  623. <td><a href="treeview.html">Reference</a></td>
  624. </tr>
  625. <tr>
  626. <td><strong>CardWidget</strong></td>
  627. <td>
  628. <code>data-lte-toggle=&quot;card-collapse&quot;</code>,
  629. <code>card-remove</code>, <code>card-maximize</code>
  630. </td>
  631. <td>
  632. <code>.toggle()</code> / <code>.collapse()</code> /
  633. <code>.expand()</code> / <code>.remove()</code> /
  634. <code>.maximize()</code> / <code>.minimize()</code> /
  635. <code>.toggleMaximize()</code>
  636. </td>
  637. <td><a href="card-widget.html">Reference</a></td>
  638. </tr>
  639. <tr>
  640. <td><strong>DirectChat</strong></td>
  641. <td><code>data-lte-toggle=&quot;chat-pane&quot;</code></td>
  642. <td><code>.toggle()</code></td>
  643. <td><a href="direct-chat.html">Reference</a></td>
  644. </tr>
  645. <tr>
  646. <td><strong>FullScreen</strong></td>
  647. <td><code>data-lte-toggle=&quot;fullscreen&quot;</code></td>
  648. <td>
  649. <code>.toggleFullScreen()</code> / <code>.inFullScreen()</code> /
  650. <code>.outFullscreen()</code>
  651. </td>
  652. <td><a href="fullscreen.html">Reference</a></td>
  653. </tr>
  654. <tr>
  655. <td><strong>Layout</strong></td>
  656. <td>(auto-applied to <code>&lt;body&gt;</code>)</td>
  657. <td><code>.holdTransition(time)</code></td>
  658. <td><a href="layout.html">Reference</a></td>
  659. </tr>
  660. <tr>
  661. <td><strong>AccessibilityManager</strong></td>
  662. <td>(helper function: <code>initAccessibility()</code>)</td>
  663. <td>
  664. <code>.announce()</code> / <code>.focusElement()</code> /
  665. <code>.trapFocus()</code> / <code>.addLandmarks()</code>
  666. </td>
  667. <td><a href="accessibility.html">Reference</a></td>
  668. </tr>
  669. </tbody>
  670. </table>
  671. <h5 id="two-ways-to-use-them">Two ways to use them</h5>
  672. <h6 id="1-data-api-declarative">1. Data API (declarative)</h6>
  673. <p>
  674. For most pages, the data API is enough — no JavaScript code required. Drop the
  675. right <code>data-lte-*</code> attribute on the trigger element and the bundle
  676. wires it up on page load:
  677. </p>
  678. <pre
  679. class="astro-code dark-plus"
  680. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  681. tabindex="0"
  682. data-language="html"
  683. ><code><span class="line"><span style="color:#6A9955">&lt;!-- Sidebar toggle --&gt;</span></span>
  684. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">button</span><span style="color:#9CDCFE"> data-lte-toggle</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;sidebar&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">☰</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">button</span><span style="color:#808080">&gt;</span></span>
  685. <span class="line"></span>
  686. <span class="line"><span style="color:#6A9955">&lt;!-- Card collapse / remove / maximize --&gt;</span></span>
  687. <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&quot;</span><span style="color:#808080">&gt;</span></span>
  688. <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-header&quot;</span><span style="color:#808080">&gt;</span></span>
  689. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">h3</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;card-title&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">Title</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">h3</span><span style="color:#808080">&gt;</span></span>
  690. <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-tools&quot;</span><span style="color:#808080">&gt;</span></span>
  691. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">button</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;btn btn-tool&quot;</span><span style="color:#9CDCFE"> data-lte-toggle</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;card-collapse&quot;</span><span style="color:#808080">&gt;</span></span>
  692. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">i</span><span style="color:#9CDCFE"> data-lte-icon</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;expand&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;bi bi-dash-lg&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span>
  693. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">i</span><span style="color:#9CDCFE"> data-lte-icon</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;collapse&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;bi bi-plus-lg&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span>
  694. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">button</span><span style="color:#808080">&gt;</span></span>
  695. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  696. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  697. <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-body&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>
  698. <span class="line"><span style="color:#808080">&lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span></code></pre>
  699. <p>
  700. The bundle attaches all data-API listeners on <code>DOMContentLoaded</code>.
  701. Dynamically-injected elements still work for the
  702. <a href="pushmenu.html">PushMenu</a>,
  703. <a href="card-widget.html">CardWidget</a>, and
  704. <a href="treeview.html">Treeview</a> plugins, which use event delegation.
  705. </p>
  706. <h6 id="2-programmatic-imperative">2. Programmatic (imperative)</h6>
  707. <p>
  708. When you need to control a plugin from your own code — eg. open the sidebar
  709. after a successful login, or expand a card on a route change — instantiate the
  710. class directly:
  711. </p>
  712. <pre
  713. class="astro-code dark-plus"
  714. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  715. tabindex="0"
  716. data-language="js"
  717. ><code><span class="line"><span style="color:#6A9955">// ESM (bundler import)</span></span>
  718. <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:#9CDCFE">CardWidget</span><span style="color:#D4D4D4">, </span><span style="color:#9CDCFE">Treeview</span><span style="color:#D4D4D4"> } </span><span style="color:#C586C0">from</span><span style="color:#CE9178"> &quot;admin-lte&quot;</span></span>
  719. <span class="line"></span>
  720. <span class="line"><span style="color:#6A9955">// Sidebar</span></span>
  721. <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:#9CDCFE">body</span><span style="color:#D4D4D4">, {}).</span><span style="color:#DCDCAA">expand</span><span style="color:#D4D4D4">()</span></span>
  722. <span class="line"></span>
  723. <span class="line"><span style="color:#6A9955">// Card maximize</span></span>
  724. <span class="line"><span style="color:#569CD6">const</span><span style="color:#4FC1FF"> card</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;#chart-card&quot;</span><span style="color:#D4D4D4">)</span></span>
  725. <span class="line"><span style="color:#569CD6">new</span><span style="color:#DCDCAA"> CardWidget</span><span style="color:#D4D4D4">(</span><span style="color:#9CDCFE">card</span><span style="color:#D4D4D4">, {}).</span><span style="color:#DCDCAA">maximize</span><span style="color:#D4D4D4">()</span></span></code></pre>
  726. <p>Or use the globals (UMD bundle, no build step):</p>
  727. <pre
  728. class="astro-code dark-plus"
  729. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  730. tabindex="0"
  731. data-language="html"
  732. ><code><span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">script</span><span style="color:#808080">&gt;</span></span>
  733. <span class="line"><span style="color:#6A9955"> // The bundle assigns to window.adminlte</span></span>
  734. <span class="line"><span style="color:#569CD6"> new</span><span style="color:#9CDCFE"> adminlte</span><span style="color:#D4D4D4">.</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:#9CDCFE">body</span><span style="color:#D4D4D4">, {}).</span><span style="color:#DCDCAA">expand</span><span style="color:#D4D4D4">()</span></span>
  735. <span class="line"><span style="color:#808080">&lt;/</span><span style="color:#569CD6">script</span><span style="color:#808080">&gt;</span></span></code></pre>
  736. <h5 id="listening-to-plugin-events">Listening to plugin events</h5>
  737. <p>
  738. Every plugin fires a <code>CustomEvent</code> or <code>Event</code> on the
  739. element it operates on. Listen for these to coordinate with your own code:
  740. </p>
  741. <pre
  742. class="astro-code dark-plus"
  743. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  744. tabindex="0"
  745. data-language="js"
  746. ><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">&quot;expanded.lte.card-widget&quot;</span><span style="color:#D4D4D4">, (</span><span style="color:#9CDCFE">e</span><span style="color:#D4D4D4">) </span><span style="color:#569CD6">=&gt;</span><span style="color:#D4D4D4"> {</span></span>
  747. <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">&quot;Card expanded:&quot;</span><span style="color:#D4D4D4">, </span><span style="color:#9CDCFE">e</span><span style="color:#D4D4D4">.</span><span style="color:#9CDCFE">target</span><span style="color:#D4D4D4">)</span></span>
  748. <span class="line"><span style="color:#D4D4D4">})</span></span>
  749. <span class="line"></span>
  750. <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">&quot;open.lte.push-menu&quot;</span><span style="color:#D4D4D4">, () </span><span style="color:#569CD6">=&gt;</span><span style="color:#D4D4D4"> {</span></span>
  751. <span class="line"><span style="color:#6A9955"> // user opened the sidebar — eg. analytics call</span></span>
  752. <span class="line"><span style="color:#D4D4D4">})</span></span></code></pre>
  753. <h6 id="event-name-reference">Event name reference</h6>
  754. <table>
  755. <thead>
  756. <tr>
  757. <th>Plugin</th>
  758. <th>Event</th>
  759. <th>Fired when</th>
  760. </tr>
  761. </thead>
  762. <tbody>
  763. <tr>
  764. <td>PushMenu</td>
  765. <td><code>open.lte.push-menu</code></td>
  766. <td>Sidebar expanded</td>
  767. </tr>
  768. <tr>
  769. <td>PushMenu</td>
  770. <td><code>collapse.lte.push-menu</code></td>
  771. <td>Sidebar collapsed</td>
  772. </tr>
  773. <tr>
  774. <td>Treeview</td>
  775. <td><code>expanded.lte.treeview</code></td>
  776. <td>Submenu opened</td>
  777. </tr>
  778. <tr>
  779. <td>Treeview</td>
  780. <td><code>collapsed.lte.treeview</code></td>
  781. <td>Submenu closed</td>
  782. </tr>
  783. <tr>
  784. <td>Treeview</td>
  785. <td><code>load.lte.treeview</code></td>
  786. <td>Pre-opened submenu detected on page load</td>
  787. </tr>
  788. <tr>
  789. <td>CardWidget</td>
  790. <td><code>expanded.lte.card-widget</code></td>
  791. <td>Card expanded</td>
  792. </tr>
  793. <tr>
  794. <td>CardWidget</td>
  795. <td><code>collapsed.lte.card-widget</code></td>
  796. <td>Card collapsed</td>
  797. </tr>
  798. <tr>
  799. <td>CardWidget</td>
  800. <td><code>remove.lte.card-widget</code></td>
  801. <td>Card removed</td>
  802. </tr>
  803. <tr>
  804. <td>CardWidget</td>
  805. <td><code>maximized.lte.card-widget</code></td>
  806. <td>Card maximized</td>
  807. </tr>
  808. <tr>
  809. <td>CardWidget</td>
  810. <td><code>minimized.lte.card-widget</code></td>
  811. <td>Card minimized</td>
  812. </tr>
  813. <tr>
  814. <td>DirectChat</td>
  815. <td><code>expanded.lte.direct-chat</code></td>
  816. <td>Contacts pane opened</td>
  817. </tr>
  818. <tr>
  819. <td>DirectChat</td>
  820. <td><code>collapsed.lte.direct-chat</code></td>
  821. <td>Contacts pane closed</td>
  822. </tr>
  823. <tr>
  824. <td>FullScreen</td>
  825. <td><code>maximized.lte.fullscreen</code></td>
  826. <td>Entered fullscreen</td>
  827. </tr>
  828. <tr>
  829. <td>FullScreen</td>
  830. <td><code>minimized.lte.fullscreen</code></td>
  831. <td>Exited fullscreen</td>
  832. </tr>
  833. </tbody>
  834. </table>
  835. <p>
  836. All events bubble. Attach listeners to <code>document</code> or
  837. <code>document.body</code> for global hooks, or to a specific card / sidebar
  838. element for scoped listeners.
  839. </p>
  840. <h5 id="configuring-via-data-attributes">Configuring via data attributes</h5>
  841. <p>
  842. Some plugins read config from <code>data-*</code> attributes on their target
  843. element:
  844. </p>
  845. <pre
  846. class="astro-code dark-plus"
  847. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  848. tabindex="0"
  849. data-language="html"
  850. ><code><span class="line"><span style="color:#6A9955">&lt;!-- Treeview — non-accordion (multiple submenus can be open at once) --&gt;</span></span>
  851. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">ul</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav sidebar-menu&quot;</span><span style="color:#9CDCFE"> data-lte-toggle</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;treeview&quot;</span><span style="color:#9CDCFE"> data-accordion</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;false&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">…</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">ul</span><span style="color:#808080">&gt;</span></span>
  852. <span class="line"></span>
  853. <span class="line"><span style="color:#6A9955">&lt;!-- Treeview — custom animation speed --&gt;</span></span>
  854. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">ul</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav sidebar-menu&quot;</span><span style="color:#9CDCFE"> data-lte-toggle</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;treeview&quot;</span><span style="color:#9CDCFE"> data-animation-speed</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;500&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">…</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">ul</span><span style="color:#808080">&gt;</span></span>
  855. <span class="line"></span>
  856. <span class="line"><span style="color:#6A9955">&lt;!-- Sidebar — opt into localStorage persistence (default: off) --&gt;</span></span>
  857. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">aside</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;app-sidebar&quot;</span><span style="color:#9CDCFE"> data-enable-persistence</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;true&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">…</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">aside</span><span style="color:#808080">&gt;</span></span>
  858. <span class="line"></span>
  859. <span class="line"><span style="color:#6A9955">&lt;!-- Sidebar — override the mobile breakpoint --&gt;</span></span>
  860. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">aside</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;app-sidebar&quot;</span><span style="color:#9CDCFE"> data-sidebar-breakpoint</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;768&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">…</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">aside</span><span style="color:#808080">&gt;</span></span></code></pre>
  861. <p>Each plugin’s reference page documents which attributes it supports.</p>
  862. <h5 id="css-classes-the-plugins-manage">CSS classes the plugins manage</h5>
  863. <p>
  864. The plugins toggle a small set of CSS classes that you can also style or react
  865. to:
  866. </p>
  867. <table>
  868. <thead>
  869. <tr>
  870. <th>Class</th>
  871. <th>Set by</th>
  872. <th>Where</th>
  873. <th>Meaning</th>
  874. </tr>
  875. </thead>
  876. <tbody>
  877. <tr>
  878. <td><code>sidebar-collapse</code></td>
  879. <td>PushMenu</td>
  880. <td><code>&lt;body&gt;</code></td>
  881. <td>Sidebar collapsed (desktop mini state, or mobile-closed)</td>
  882. </tr>
  883. <tr>
  884. <td><code>sidebar-open</code></td>
  885. <td>PushMenu</td>
  886. <td><code>&lt;body&gt;</code></td>
  887. <td>Mobile sidebar explicitly opened by user</td>
  888. </tr>
  889. <tr>
  890. <td><code>sidebar-mini</code></td>
  891. <td>PushMenu</td>
  892. <td><code>&lt;body&gt;</code></td>
  893. <td>Mini-sidebar mode active</td>
  894. </tr>
  895. <tr>
  896. <td><code>menu-open</code></td>
  897. <td>Treeview</td>
  898. <td><code>.nav-item</code></td>
  899. <td>Submenu is currently expanded</td>
  900. </tr>
  901. <tr>
  902. <td><code>collapsed-card</code></td>
  903. <td>CardWidget</td>
  904. <td><code>.card</code></td>
  905. <td>Card body/footer are collapsed</td>
  906. </tr>
  907. <tr>
  908. <td><code>maximized-card</code></td>
  909. <td>CardWidget</td>
  910. <td><code>&lt;html&gt;</code> and <code>.card</code></td>
  911. <td>Card is in fullscreen mode</td>
  912. </tr>
  913. <tr>
  914. <td><code>direct-chat-contacts-open</code></td>
  915. <td>DirectChat</td>
  916. <td><code>.direct-chat</code></td>
  917. <td>Contacts pane visible</td>
  918. </tr>
  919. <tr>
  920. <td><code>hold-transition</code></td>
  921. <td>Layout</td>
  922. <td><code>&lt;body&gt;</code></td>
  923. <td>Transitions disabled briefly (during resize, etc.)</td>
  924. </tr>
  925. <tr>
  926. <td><code>app-loaded</code></td>
  927. <td>Layout</td>
  928. <td><code>&lt;body&gt;</code></td>
  929. <td>Initial page-load animation finished</td>
  930. </tr>
  931. <tr>
  932. <td><code>reduce-motion</code></td>
  933. <td>AccessibilityManager</td>
  934. <td><code>&lt;body&gt;</code></td>
  935. <td>OS <code>prefers-reduced-motion</code> detected</td>
  936. </tr>
  937. </tbody>
  938. </table>
  939. <h5 id="production-vs-source">Production vs source</h5>
  940. <p>
  941. The plugins live in
  942. <a href="https://github.com/ColorlibHQ/master/src/ts"><code>src/ts/</code></a>
  943. as TypeScript modules. The published <code>dist/js/adminlte.js</code> is a
  944. Rollup bundle of all seven, exporting them under a single
  945. <code>adminlte</code> namespace (UMD) or named imports (ESM).
  946. </p>
  947. <p>
  948. If you only need one or two plugins and care about bundle size, importing
  949. individual modules from <code>node_modules/admin-lte/src/ts/</code> will
  950. tree-shake — but you’ll need TypeScript in your toolchain.
  951. </p>
  952. <h5 id="where-to-next">Where to next</h5>
  953. <ul>
  954. <li>Detailed reference for each plugin (links in the table above)</li>
  955. <li>
  956. <a href="../layout-blueprint.html">Layout Blueprint</a> — the structural
  957. classes the plugins operate on
  958. </li>
  959. <li>
  960. <a href="accessibility.html">Accessibility</a> — keyboard navigation, focus
  961. trapping, ARIA helpers
  962. </li>
  963. </ul>
  964. </div>
  965. </div>
  966. </div>
  967. </div>
  968. </div>
  969. </div>
  970. </main>
  971. <!--begin::Footer-->
  972. <footer class="app-footer">
  973. <!--begin::To the end-->
  974. <div class="float-end d-none d-sm-inline">Anything you want</div>
  975. <!--end::To the end-->
  976. <!--begin::Copyright-->
  977. <strong>
  978. Copyright &copy; 2014-2026&nbsp;
  979. <a href="https://adminlte.io" class="text-decoration-none">AdminLTE.io</a>.
  980. </strong>
  981. All rights reserved.
  982. <!--end::Copyright-->
  983. </footer>
  984. <!--end::Footer-->
  985. </div>
  986. <!--begin::Third Party Plugin(OverlayScrollbars)-->
  987. <script
  988. src="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/browser/overlayscrollbars.browser.es6.min.js"
  989. crossorigin="anonymous"
  990. ></script>
  991. <!--end::Third Party Plugin(OverlayScrollbars)--><!--begin::Required Plugin(popperjs for Bootstrap 5)-->
  992. <script
  993. src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js"
  994. crossorigin="anonymous"
  995. ></script>
  996. <!--end::Required Plugin(popperjs for Bootstrap 5)--><!--begin::Required Plugin(Bootstrap 5)-->
  997. <script
  998. src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/js/bootstrap.min.js"
  999. crossorigin="anonymous"
  1000. ></script>
  1001. <!--end::Required Plugin(Bootstrap 5)--><!--begin::Required Plugin(AdminLTE)-->
  1002. <script src="../../js/adminlte.js"></script>
  1003. <!--end::Required Plugin(AdminLTE)--><!--begin::OverlayScrollbars Configure-->
  1004. <script>
  1005. const SELECTOR_SIDEBAR_WRAPPER = '.sidebar-wrapper';
  1006. const Default = {
  1007. scrollbarTheme: 'os-theme-light',
  1008. scrollbarAutoHide: 'leave',
  1009. scrollbarClickScroll: true,
  1010. };
  1011. document.addEventListener('DOMContentLoaded', function () {
  1012. const sidebarWrapper = document.querySelector(SELECTOR_SIDEBAR_WRAPPER);
  1013. // Disable OverlayScrollbars on mobile devices to prevent touch interference
  1014. const isMobile = window.innerWidth <= 992;
  1015. if (
  1016. sidebarWrapper &&
  1017. OverlayScrollbarsGlobal?.OverlayScrollbars !== undefined &&
  1018. !isMobile
  1019. ) {
  1020. OverlayScrollbarsGlobal.OverlayScrollbars(sidebarWrapper, {
  1021. scrollbars: {
  1022. theme: Default.scrollbarTheme,
  1023. autoHide: Default.scrollbarAutoHide,
  1024. clickScroll: Default.scrollbarClickScroll,
  1025. },
  1026. });
  1027. }
  1028. });
  1029. </script>
  1030. <!--end::OverlayScrollbars Configure--><!--begin::Color Mode Toggle (#6010)-->
  1031. <script>
  1032. (() => {
  1033. 'use strict';
  1034. const STORAGE_KEY = 'lte-theme';
  1035. const getStoredTheme = () => localStorage.getItem(STORAGE_KEY);
  1036. const setStoredTheme = (theme) => localStorage.setItem(STORAGE_KEY, theme);
  1037. const prefersDark = () => globalThis.matchMedia('(prefers-color-scheme: dark)').matches;
  1038. const getPreferredTheme = () => {
  1039. const stored = getStoredTheme();
  1040. if (stored) return stored;
  1041. return prefersDark() ? 'dark' : 'light';
  1042. };
  1043. const setTheme = (theme) => {
  1044. const resolved = theme === 'auto' ? (prefersDark() ? 'dark' : 'light') : theme;
  1045. document.documentElement.setAttribute('data-bs-theme', resolved);
  1046. };
  1047. setTheme(getPreferredTheme());
  1048. const showActiveTheme = (theme) => {
  1049. // Highlight the active dropdown option
  1050. document.querySelectorAll('[data-bs-theme-value]').forEach((el) => {
  1051. el.classList.remove('active');
  1052. el.setAttribute('aria-pressed', 'false');
  1053. const check = el.querySelector('.bi-check-lg');
  1054. if (check) check.classList.add('d-none');
  1055. });
  1056. const active = document.querySelector(`[data-bs-theme-value="${theme}"]`);
  1057. if (active) {
  1058. active.classList.add('active');
  1059. active.setAttribute('aria-pressed', 'true');
  1060. const check = active.querySelector('.bi-check-lg');
  1061. if (check) check.classList.remove('d-none');
  1062. }
  1063. // Sync the topbar trigger icon
  1064. document.querySelectorAll('[data-lte-theme-icon]').forEach((icon) => {
  1065. icon.classList.toggle('d-none', icon.dataset.lteThemeIcon !== theme);
  1066. });
  1067. };
  1068. globalThis.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
  1069. const stored = getStoredTheme();
  1070. if (!stored || stored === 'auto') setTheme(getPreferredTheme());
  1071. });
  1072. document.addEventListener('DOMContentLoaded', () => {
  1073. showActiveTheme(getPreferredTheme());
  1074. document.querySelectorAll('[data-bs-theme-value]').forEach((toggle) => {
  1075. toggle.addEventListener('click', () => {
  1076. const theme = toggle.getAttribute('data-bs-theme-value');
  1077. setStoredTheme(theme);
  1078. setTheme(theme);
  1079. showActiveTheme(theme);
  1080. });
  1081. });
  1082. });
  1083. })();
  1084. </script>
  1085. <!--end::Color Mode Toggle-->
  1086. </body>
  1087. </html>