getting-started.html 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <title>Getting Started | 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="Getting Started | 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 active">
  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">
  435. <a href="#" class="nav-link">
  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">
  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">Getting Started</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 active" aria-current="page">Getting Started</li>
  579. </ol>
  580. </div>
  581. </div>
  582. </div>
  583. </div>
  584. <div class="app-content">
  585. <div class="container-fluid">
  586. <div class="row">
  587. <div class="col-12">
  588. <div class="card">
  589. <div class="card-body">
  590. <p>
  591. AdminLTE is an HTML template — there’s no build step required to use it. This
  592. page gets you to a working dashboard in about ten minutes, without npm,
  593. without a build pipeline, without learning Astro.
  594. </p>
  595. <p>
  596. If you’re integrating AdminLTE into a real project, the
  597. <a href="introduction.html">Installation</a> page covers npm, Composer, and
  598. source-build workflows.
  599. </p>
  600. <h5 id="1-grab-the-cdn-snippets">1. Grab the CDN snippets</h5>
  601. <p>
  602. Copy these tags into the <code>&lt;head&gt;</code> of a new HTML file. They
  603. pull AdminLTE, Bootstrap 5.3, Popper, OverlayScrollbars, and Bootstrap Icons
  604. from jsDelivr — no install needed.
  605. </p>
  606. <pre
  607. class="astro-code dark-plus"
  608. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  609. tabindex="0"
  610. data-language="html"
  611. ><code><span class="line"><span style="color:#6A9955">&lt;!-- AdminLTE 4 + Bootstrap 5.3 (CSS) --&gt;</span></span>
  612. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">link</span><span style="color:#9CDCFE"> rel</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;stylesheet&quot;</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/bootstrap-icons@1.13.1/font/bootstrap-icons.min.css&quot;</span><span style="color:#808080"> /&gt;</span></span>
  613. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">link</span><span style="color:#9CDCFE"> rel</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;stylesheet&quot;</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/styles/overlayscrollbars.min.css&quot;</span><span style="color:#808080"> /&gt;</span></span>
  614. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">link</span><span style="color:#9CDCFE"> rel</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;stylesheet&quot;</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/admin-lte@4.0.0-rc7/dist/css/adminlte.min.css&quot;</span><span style="color:#808080"> /&gt;</span></span></code></pre>
  615. <p>And these just before <code>&lt;/body&gt;</code>:</p>
  616. <pre
  617. class="astro-code dark-plus"
  618. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  619. tabindex="0"
  620. data-language="html"
  621. ><code><span class="line"><span style="color:#6A9955">&lt;!-- Bootstrap + Popper + AdminLTE (JS) --&gt;</span></span>
  622. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">script</span><span style="color:#9CDCFE"> src</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">script</span><span style="color:#808080">&gt;</span></span>
  623. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">script</span><span style="color:#9CDCFE"> src</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.min.js&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">script</span><span style="color:#808080">&gt;</span></span>
  624. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">script</span><span style="color:#9CDCFE"> src</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/browser/overlayscrollbars.browser.es6.min.js&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">script</span><span style="color:#808080">&gt;</span></span>
  625. <span class="line"><span style="color:#808080">&lt;</span><span style="color:#569CD6">script</span><span style="color:#9CDCFE"> src</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;https://cdn.jsdelivr.net/npm/admin-lte@4.0.0-rc7/dist/js/adminlte.min.js&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">script</span><span style="color:#808080">&gt;</span></span></code></pre>
  626. <h5 id="2-the-minimum-viable-layout">2. The minimum viable layout</h5>
  627. <p>
  628. This is the smallest AdminLTE page that still feels like AdminLTE — a header,
  629. a collapsible sidebar, and a main content area. Drop it between the CSS and JS
  630. tags above:
  631. </p>
  632. <pre
  633. class="astro-code dark-plus"
  634. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  635. tabindex="0"
  636. data-language="html"
  637. ><code><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;layout-fixed sidebar-expand-lg bg-body-tertiary&quot;</span><span style="color:#808080">&gt;</span></span>
  638. <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;app-wrapper&quot;</span><span style="color:#808080">&gt;</span></span>
  639. <span class="line"></span>
  640. <span class="line"><span style="color:#6A9955"> &lt;!-- Header --&gt;</span></span>
  641. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">nav</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;app-header navbar navbar-expand bg-body&quot;</span><span style="color:#808080">&gt;</span></span>
  642. <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;container-fluid&quot;</span><span style="color:#808080">&gt;</span></span>
  643. <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;navbar-nav&quot;</span><span style="color:#808080">&gt;</span></span>
  644. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">li</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav-item&quot;</span><span style="color:#808080">&gt;</span></span>
  645. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">a</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav-link&quot;</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:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;#&quot;</span><span style="color:#9CDCFE"> role</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;button&quot;</span><span style="color:#808080">&gt;</span></span>
  646. <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-list&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span>
  647. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">a</span><span style="color:#808080">&gt;</span></span>
  648. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">li</span><span style="color:#808080">&gt;</span></span>
  649. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">ul</span><span style="color:#808080">&gt;</span></span>
  650. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  651. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">nav</span><span style="color:#808080">&gt;</span></span>
  652. <span class="line"></span>
  653. <span class="line"><span style="color:#6A9955"> &lt;!-- Sidebar --&gt;</span></span>
  654. <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 bg-body-secondary shadow&quot;</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>
  655. <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;sidebar-brand&quot;</span><span style="color:#808080">&gt;</span></span>
  656. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">a</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;#&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;brand-link&quot;</span><span style="color:#808080">&gt;</span></span>
  657. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">span</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;brand-text fw-light&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">My Dashboard</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">span</span><span style="color:#808080">&gt;</span></span>
  658. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">a</span><span style="color:#808080">&gt;</span></span>
  659. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  660. <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;sidebar-wrapper&quot;</span><span style="color:#808080">&gt;</span></span>
  661. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">nav</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;mt-2&quot;</span><span style="color:#808080">&gt;</span></span>
  662. <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 flex-column&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"> role</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;menu&quot;</span><span style="color:#808080">&gt;</span></span>
  663. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">li</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav-item&quot;</span><span style="color:#808080">&gt;</span></span>
  664. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">a</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;#&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav-link active&quot;</span><span style="color:#808080">&gt;</span></span>
  665. <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;nav-icon bi bi-speedometer&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span>
  666. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">p</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">Dashboard</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">p</span><span style="color:#808080">&gt;</span></span>
  667. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">a</span><span style="color:#808080">&gt;</span></span>
  668. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">li</span><span style="color:#808080">&gt;</span></span>
  669. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">li</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav-item&quot;</span><span style="color:#808080">&gt;</span></span>
  670. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">a</span><span style="color:#9CDCFE"> href</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;#&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;nav-link&quot;</span><span style="color:#808080">&gt;</span></span>
  671. <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;nav-icon bi bi-bar-chart&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span>
  672. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">p</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">Reports</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">p</span><span style="color:#808080">&gt;</span></span>
  673. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">a</span><span style="color:#808080">&gt;</span></span>
  674. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">li</span><span style="color:#808080">&gt;</span></span>
  675. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">ul</span><span style="color:#808080">&gt;</span></span>
  676. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">nav</span><span style="color:#808080">&gt;</span></span>
  677. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  678. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">aside</span><span style="color:#808080">&gt;</span></span>
  679. <span class="line"></span>
  680. <span class="line"><span style="color:#6A9955"> &lt;!-- Main content --&gt;</span></span>
  681. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">main</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;app-main&quot;</span><span style="color:#808080">&gt;</span></span>
  682. <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;app-content-header&quot;</span><span style="color:#808080">&gt;</span></span>
  683. <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;container-fluid&quot;</span><span style="color:#808080">&gt;</span></span>
  684. <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;mb-0&quot;</span><span style="color:#808080">&gt;</span><span style="color:#D4D4D4">Hello, AdminLTE</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">h3</span><span style="color:#808080">&gt;</span></span>
  685. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  686. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&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;app-content&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;container-fluid&quot;</span><span style="color:#808080">&gt;</span></span>
  689. <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>
  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-header&quot;</span><span style="color:#808080">&gt;&lt;</span><span style="color:#569CD6">h5</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">Welcome</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">h5</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  691. <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>
  692. <span class="line"><span style="color:#D4D4D4"> Edit this file to start building your dashboard.</span></span>
  693. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  694. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</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">main</span><span style="color:#808080">&gt;</span></span>
  698. <span class="line"></span>
  699. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  700. <span class="line"><span style="color:#808080">&lt;/</span><span style="color:#569CD6">body</span><span style="color:#808080">&gt;</span></span></code></pre>
  701. <p>
  702. Open it in a browser. The hamburger button at the top-left collapses the
  703. sidebar — that’s AdminLTE’s
  704. <a href="javascript/pushmenu.html">PushMenu</a> plugin working out of the box,
  705. wired by <code>data-lte-toggle=&quot;sidebar&quot;</code>.
  706. </p>
  707. <h5 id="3-whats-actually-happening">3. What’s actually happening</h5>
  708. <p>The four classes that do the heavy lifting:</p>
  709. <table>
  710. <thead>
  711. <tr>
  712. <th>Class</th>
  713. <th>What it does</th>
  714. </tr>
  715. </thead>
  716. <tbody>
  717. <tr>
  718. <td><code>app-wrapper</code></td>
  719. <td>
  720. The CSS grid root — defines header / sidebar / main / footer regions
  721. </td>
  722. </tr>
  723. <tr>
  724. <td><code>app-header</code></td>
  725. <td>
  726. Stuck to the top of the viewport when <code>layout-fixed</code> is on
  727. the body
  728. </td>
  729. </tr>
  730. <tr>
  731. <td><code>app-sidebar</code></td>
  732. <td>
  733. Collapsible side rail. Add <code>sidebar-expand-lg</code> to body to
  734. control breakpoint
  735. </td>
  736. </tr>
  737. <tr>
  738. <td><code>app-main</code></td>
  739. <td>Scrollable content region — everything else lives here</td>
  740. </tr>
  741. </tbody>
  742. </table>
  743. <p>
  744. The <a href="layout.html">Layout</a> page covers the full wrapper structure
  745. and the responsive options.
  746. </p>
  747. <h5 id="4-add-a-working-javascript-widget">
  748. 4. Add a working JavaScript widget
  749. </h5>
  750. <p>
  751. AdminLTE ships seven JavaScript plugins. All of them are wired via
  752. <code>data-lte-*</code> attributes — no JavaScript code needed.
  753. </p>
  754. <p>
  755. Drop this in the content area to see the card-widget plugin in action (try the
  756. buttons in the card header):
  757. </p>
  758. <pre
  759. class="astro-code dark-plus"
  760. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  761. tabindex="0"
  762. data-language="html"
  763. ><code><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>
  764. <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>
  765. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">h5</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">Collapsible card</span><span style="color:#808080">&lt;/</span><span style="color:#569CD6">h5</span><span style="color:#808080">&gt;</span></span>
  766. <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>
  767. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">button</span><span style="color:#9CDCFE"> type</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;button&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;btn btn-sm 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>
  768. <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>
  769. <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>
  770. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">button</span><span style="color:#808080">&gt;</span></span>
  771. <span class="line"><span style="color:#808080"> &lt;</span><span style="color:#569CD6">button</span><span style="color:#9CDCFE"> type</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;button&quot;</span><span style="color:#9CDCFE"> class</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;btn btn-sm btn-tool&quot;</span><span style="color:#9CDCFE"> data-lte-toggle</span><span style="color:#D4D4D4">=</span><span style="color:#CE9178">&quot;card-remove&quot;</span><span style="color:#808080">&gt;</span></span>
  772. <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-x-lg&quot;</span><span style="color:#808080">&gt;&lt;/</span><span style="color:#569CD6">i</span><span style="color:#808080">&gt;</span></span>
  773. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">button</span><span style="color:#808080">&gt;</span></span>
  774. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  775. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  776. <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>
  777. <span class="line"><span style="color:#D4D4D4"> Click the minus icon to collapse; the X to remove.</span></span>
  778. <span class="line"><span style="color:#808080"> &lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span>
  779. <span class="line"><span style="color:#808080">&lt;/</span><span style="color:#569CD6">div</span><span style="color:#808080">&gt;</span></span></code></pre>
  780. <h5 id="5-where-to-go-next">5. Where to go next</h5>
  781. <p>You now have a working AdminLTE page. From here:</p>
  782. <ul>
  783. <li>
  784. <strong>Make it pretty</strong> →
  785. <a href="customization.html">Customization &amp; Theming</a> — change
  786. colors, fonts, and spacing via SCSS variables or CSS custom properties.
  787. </li>
  788. <li>
  789. <strong>Make it functional</strong> →
  790. <a href="javascript/layout.html">JavaScript Plugins</a> — full reference for
  791. all seven plugins.
  792. </li>
  793. <li>
  794. <strong>Make it dark</strong> → <a href="color-mode.html">Color Mode</a> —
  795. light/dark/auto toggle.
  796. </li>
  797. <li>
  798. <strong>Make it international</strong> →
  799. <a href="rtl.html">RTL Support</a> — right-to-left layouts for Arabic,
  800. Hebrew, Persian, etc.
  801. </li>
  802. <li>
  803. <strong>Add real widgets</strong> →
  804. <a href="integrations.html">Recommended Integrations</a> — date pickers,
  805. multi-selects, charts, rich text editors. AdminLTE keeps its dep tree lean;
  806. this page tells you which third-party libraries to drop in.
  807. </li>
  808. </ul>
  809. <p>
  810. If you’re upgrading an existing AdminLTE 3 project, see the
  811. <a href="migration.html">Migration from v3</a> guide for breaking changes.
  812. </p>
  813. </div>
  814. </div>
  815. </div>
  816. </div>
  817. </div>
  818. </div>
  819. </main>
  820. <!--begin::Footer-->
  821. <footer class="app-footer">
  822. <!--begin::To the end-->
  823. <div class="float-end d-none d-sm-inline">Anything you want</div>
  824. <!--end::To the end-->
  825. <!--begin::Copyright-->
  826. <strong>
  827. Copyright &copy; 2014-2026&nbsp;
  828. <a href="https://adminlte.io" class="text-decoration-none">AdminLTE.io</a>.
  829. </strong>
  830. All rights reserved.
  831. <!--end::Copyright-->
  832. </footer>
  833. <!--end::Footer-->
  834. </div>
  835. <!--begin::Third Party Plugin(OverlayScrollbars)-->
  836. <script
  837. src="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/browser/overlayscrollbars.browser.es6.min.js"
  838. crossorigin="anonymous"
  839. ></script>
  840. <!--end::Third Party Plugin(OverlayScrollbars)--><!--begin::Required Plugin(popperjs for Bootstrap 5)-->
  841. <script
  842. src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js"
  843. crossorigin="anonymous"
  844. ></script>
  845. <!--end::Required Plugin(popperjs for Bootstrap 5)--><!--begin::Required Plugin(Bootstrap 5)-->
  846. <script
  847. src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/js/bootstrap.min.js"
  848. crossorigin="anonymous"
  849. ></script>
  850. <!--end::Required Plugin(Bootstrap 5)--><!--begin::Required Plugin(AdminLTE)-->
  851. <script src="../js/adminlte.js"></script>
  852. <!--end::Required Plugin(AdminLTE)--><!--begin::OverlayScrollbars Configure-->
  853. <script>
  854. const SELECTOR_SIDEBAR_WRAPPER = '.sidebar-wrapper';
  855. const Default = {
  856. scrollbarTheme: 'os-theme-light',
  857. scrollbarAutoHide: 'leave',
  858. scrollbarClickScroll: true,
  859. };
  860. document.addEventListener('DOMContentLoaded', function () {
  861. const sidebarWrapper = document.querySelector(SELECTOR_SIDEBAR_WRAPPER);
  862. // Disable OverlayScrollbars on mobile devices to prevent touch interference
  863. const isMobile = window.innerWidth <= 992;
  864. if (
  865. sidebarWrapper &&
  866. OverlayScrollbarsGlobal?.OverlayScrollbars !== undefined &&
  867. !isMobile
  868. ) {
  869. OverlayScrollbarsGlobal.OverlayScrollbars(sidebarWrapper, {
  870. scrollbars: {
  871. theme: Default.scrollbarTheme,
  872. autoHide: Default.scrollbarAutoHide,
  873. clickScroll: Default.scrollbarClickScroll,
  874. },
  875. });
  876. }
  877. });
  878. </script>
  879. <!--end::OverlayScrollbars Configure--><!--begin::Color Mode Toggle (#6010)-->
  880. <script>
  881. (() => {
  882. 'use strict';
  883. const STORAGE_KEY = 'lte-theme';
  884. const getStoredTheme = () => localStorage.getItem(STORAGE_KEY);
  885. const setStoredTheme = (theme) => localStorage.setItem(STORAGE_KEY, theme);
  886. const prefersDark = () => globalThis.matchMedia('(prefers-color-scheme: dark)').matches;
  887. const getPreferredTheme = () => {
  888. const stored = getStoredTheme();
  889. if (stored) return stored;
  890. return prefersDark() ? 'dark' : 'light';
  891. };
  892. const setTheme = (theme) => {
  893. const resolved = theme === 'auto' ? (prefersDark() ? 'dark' : 'light') : theme;
  894. document.documentElement.setAttribute('data-bs-theme', resolved);
  895. };
  896. setTheme(getPreferredTheme());
  897. const showActiveTheme = (theme) => {
  898. // Highlight the active dropdown option
  899. document.querySelectorAll('[data-bs-theme-value]').forEach((el) => {
  900. el.classList.remove('active');
  901. el.setAttribute('aria-pressed', 'false');
  902. const check = el.querySelector('.bi-check-lg');
  903. if (check) check.classList.add('d-none');
  904. });
  905. const active = document.querySelector(`[data-bs-theme-value="${theme}"]`);
  906. if (active) {
  907. active.classList.add('active');
  908. active.setAttribute('aria-pressed', 'true');
  909. const check = active.querySelector('.bi-check-lg');
  910. if (check) check.classList.remove('d-none');
  911. }
  912. // Sync the topbar trigger icon
  913. document.querySelectorAll('[data-lte-theme-icon]').forEach((icon) => {
  914. icon.classList.toggle('d-none', icon.dataset.lteThemeIcon !== theme);
  915. });
  916. };
  917. globalThis.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
  918. const stored = getStoredTheme();
  919. if (!stored || stored === 'auto') setTheme(getPreferredTheme());
  920. });
  921. document.addEventListener('DOMContentLoaded', () => {
  922. showActiveTheme(getPreferredTheme());
  923. document.querySelectorAll('[data-bs-theme-value]').forEach((toggle) => {
  924. toggle.addEventListener('click', () => {
  925. const theme = toggle.getAttribute('data-bs-theme-value');
  926. setStoredTheme(theme);
  927. setTheme(theme);
  928. showActiveTheme(theme);
  929. });
  930. });
  931. });
  932. })();
  933. </script>
  934. <!--end::Color Mode Toggle-->
  935. </body>
  936. </html>