introduction.html 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960
  1. <!doctype html>
  2. <html lang="en">
  3. <!--begin::Head-->
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Introduction | AdminLTE 4</title>
  7. <!--begin::Accessibility Meta Tags-->
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  9. <meta name="color-scheme" content="light dark" />
  10. <meta name="theme-color" content="#007bff" media="(prefers-color-scheme: light)" />
  11. <meta name="theme-color" content="#1a1a1a" media="(prefers-color-scheme: dark)" />
  12. <!--end::Accessibility Meta Tags-->
  13. <!--begin::Primary Meta Tags-->
  14. <meta name="title" content="Introduction | AdminLTE 4" />
  15. <meta name="author" content="ColorlibHQ" />
  16. <meta
  17. name="description"
  18. content="AdminLTE is a Free Bootstrap 5 Admin Dashboard, 30 example pages using Vanilla JS. Fully accessible with WCAG 2.1 AA compliance."
  19. />
  20. <meta
  21. name="keywords"
  22. 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"
  23. />
  24. <!--end::Primary Meta Tags-->
  25. <!--begin::Accessibility Features-->
  26. <!-- Skip links will be dynamically added by accessibility.js -->
  27. <meta name="supported-color-schemes" content="light dark" />
  28. <link rel="preload" href="../css/adminlte.css" as="style" />
  29. <!--end::Accessibility Features-->
  30. <!--begin::Fonts-->
  31. <link
  32. rel="stylesheet"
  33. href="https://cdn.jsdelivr.net/npm/@fontsource/source-sans-3@5.0.12/index.css"
  34. integrity="sha256-tXJfXfp6Ewt1ilPzLDtQnJV4hclT9XuaZUKyUvmyr+Q="
  35. crossorigin="anonymous"
  36. media="print"
  37. onload="this.media = 'all'"
  38. />
  39. <!--end::Fonts-->
  40. <!--begin::Third Party Plugin(OverlayScrollbars)-->
  41. <link
  42. rel="stylesheet"
  43. href="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/styles/overlayscrollbars.min.css"
  44. crossorigin="anonymous"
  45. />
  46. <!--end::Third Party Plugin(OverlayScrollbars)-->
  47. <!--begin::Third Party Plugin(Bootstrap Icons)-->
  48. <link
  49. rel="stylesheet"
  50. href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.13.1/font/bootstrap-icons.min.css"
  51. crossorigin="anonymous"
  52. />
  53. <!--end::Third Party Plugin(Bootstrap Icons)-->
  54. <!--begin::Required Plugin(AdminLTE)-->
  55. <link rel="stylesheet" href="../css/adminlte.css" />
  56. <!--end::Required Plugin(AdminLTE)-->
  57. </head>
  58. <!--end::Head-->
  59. <!--begin::Body-->
  60. <body class="layout-fixed sidebar-expand-lg bg-body-tertiary docs-page">
  61. <!--begin::App Wrapper-->
  62. <div class="app-wrapper">
  63. <!--begin::Header-->
  64. <nav class="app-header navbar navbar-expand bg-body">
  65. <!--begin::Container-->
  66. <div class="container-fluid">
  67. <!--begin::Start Navbar Links-->
  68. <ul class="navbar-nav">
  69. <li class="nav-item">
  70. <a class="nav-link" data-lte-toggle="sidebar" href="#" role="button">
  71. <i class="bi bi-list"></i>
  72. </a>
  73. </li>
  74. <li class="nav-item d-none d-md-block">
  75. <a href="../docs/introduction.html" class="nav-link">
  76. <i class="bi bi-book me-1" aria-hidden="true"></i>
  77. Documentation
  78. </a>
  79. </li>
  80. <li class="nav-item d-none d-md-block">
  81. <a href="../index.html" class="nav-link">
  82. <i class="bi bi-arrow-left me-1" aria-hidden="true"></i>
  83. Back to live preview
  84. </a>
  85. </li>
  86. </ul>
  87. <!--end::Start Navbar Links-->
  88. <!--begin::End Navbar Links-->
  89. <ul class="navbar-nav ms-auto">
  90. <!--begin::Navbar Search-->
  91. <li class="nav-item">
  92. <a class="nav-link" data-widget="navbar-search" href="#" role="button">
  93. <i class="bi bi-search"></i>
  94. </a>
  95. </li>
  96. <!--end::Navbar Search-->
  97. <!--begin::Messages Dropdown Menu-->
  98. <li class="nav-item dropdown">
  99. <a class="nav-link" data-bs-toggle="dropdown" href="#">
  100. <i class="bi bi-chat-text"></i>
  101. <span class="navbar-badge badge text-bg-danger">3</span>
  102. </a>
  103. <div class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
  104. <a href="#" class="dropdown-item">
  105. <!--begin::Message-->
  106. <div class="d-flex">
  107. <div class="flex-shrink-0">
  108. <img
  109. src="../assets/img/user1-128x128.jpg"
  110. alt="User Avatar"
  111. class="img-size-50 rounded-circle me-3"
  112. />
  113. </div>
  114. <div class="flex-grow-1">
  115. <h3 class="dropdown-item-title">
  116. Brad Diesel
  117. <span class="float-end fs-7 text-danger"
  118. ><i class="bi bi-star-fill"></i
  119. ></span>
  120. </h3>
  121. <p class="fs-7">Call me whenever you can...</p>
  122. <p class="fs-7 text-secondary">
  123. <i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
  124. </p>
  125. </div>
  126. </div>
  127. <!--end::Message-->
  128. </a>
  129. <div class="dropdown-divider"></div>
  130. <a href="#" class="dropdown-item">
  131. <!--begin::Message-->
  132. <div class="d-flex">
  133. <div class="flex-shrink-0">
  134. <img
  135. src="../assets/img/user8-128x128.jpg"
  136. alt="User Avatar"
  137. class="img-size-50 rounded-circle me-3"
  138. />
  139. </div>
  140. <div class="flex-grow-1">
  141. <h3 class="dropdown-item-title">
  142. John Pierce
  143. <span class="float-end fs-7 text-secondary">
  144. <i class="bi bi-star-fill"></i>
  145. </span>
  146. </h3>
  147. <p class="fs-7">I got your message bro</p>
  148. <p class="fs-7 text-secondary">
  149. <i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
  150. </p>
  151. </div>
  152. </div>
  153. <!--end::Message-->
  154. </a>
  155. <div class="dropdown-divider"></div>
  156. <a href="#" class="dropdown-item">
  157. <!--begin::Message-->
  158. <div class="d-flex">
  159. <div class="flex-shrink-0">
  160. <img
  161. src="../assets/img/user3-128x128.jpg"
  162. alt="User Avatar"
  163. class="img-size-50 rounded-circle me-3"
  164. />
  165. </div>
  166. <div class="flex-grow-1">
  167. <h3 class="dropdown-item-title">
  168. Nora Silvester
  169. <span class="float-end fs-7 text-warning">
  170. <i class="bi bi-star-fill"></i>
  171. </span>
  172. </h3>
  173. <p class="fs-7">The subject goes here</p>
  174. <p class="fs-7 text-secondary">
  175. <i class="bi bi-clock-fill me-1"></i> 4 Hours Ago
  176. </p>
  177. </div>
  178. </div>
  179. <!--end::Message-->
  180. </a>
  181. <div class="dropdown-divider"></div>
  182. <a href="#" class="dropdown-item dropdown-footer">See All Messages</a>
  183. </div>
  184. </li>
  185. <!--end::Messages Dropdown Menu-->
  186. <!--begin::Notifications Dropdown Menu-->
  187. <li class="nav-item dropdown">
  188. <a class="nav-link" data-bs-toggle="dropdown" href="#">
  189. <i class="bi bi-bell-fill"></i>
  190. <span class="navbar-badge badge text-bg-warning">15</span>
  191. </a>
  192. <div class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
  193. <span class="dropdown-item dropdown-header">15 Notifications</span>
  194. <div class="dropdown-divider"></div>
  195. <a href="#" class="dropdown-item">
  196. <i class="bi bi-envelope me-2"></i> 4 new messages
  197. <span class="float-end text-secondary fs-7">3 mins</span>
  198. </a>
  199. <div class="dropdown-divider"></div>
  200. <a href="#" class="dropdown-item">
  201. <i class="bi bi-people-fill me-2"></i> 8 friend requests
  202. <span class="float-end text-secondary fs-7">12 hours</span>
  203. </a>
  204. <div class="dropdown-divider"></div>
  205. <a href="#" class="dropdown-item">
  206. <i class="bi bi-file-earmark-fill me-2"></i> 3 new reports
  207. <span class="float-end text-secondary fs-7">2 days</span>
  208. </a>
  209. <div class="dropdown-divider"></div>
  210. <a href="#" class="dropdown-item dropdown-footer"> See All Notifications </a>
  211. </div>
  212. </li>
  213. <!--end::Notifications Dropdown Menu-->
  214. <!--begin::Fullscreen Toggle-->
  215. <li class="nav-item">
  216. <a class="nav-link" href="#" data-lte-toggle="fullscreen">
  217. <i data-lte-icon="maximize" class="bi bi-arrows-fullscreen"></i>
  218. <i data-lte-icon="minimize" class="bi bi-fullscreen-exit d-none"></i>
  219. </a>
  220. </li>
  221. <!--end::Fullscreen Toggle-->
  222. <!--begin::Color Mode Toggle (#6010)-->
  223. <li class="nav-item dropdown">
  224. <a
  225. class="nav-link"
  226. href="#"
  227. id="bd-theme"
  228. aria-label="Toggle color scheme"
  229. data-bs-toggle="dropdown"
  230. aria-expanded="false"
  231. >
  232. <i class="bi bi-sun-fill" data-lte-theme-icon="light"></i>
  233. <i class="bi bi-moon-fill d-none" data-lte-theme-icon="dark"></i>
  234. <i class="bi bi-circle-half d-none" data-lte-theme-icon="auto"></i>
  235. </a>
  236. <ul
  237. class="dropdown-menu dropdown-menu-end"
  238. aria-labelledby="bd-theme"
  239. style="--bs-dropdown-min-width: 8rem"
  240. >
  241. <li>
  242. <button
  243. type="button"
  244. class="dropdown-item d-flex align-items-center"
  245. data-bs-theme-value="light"
  246. aria-pressed="false"
  247. >
  248. <i class="bi bi-sun-fill me-2"></i>
  249. Light
  250. <i class="bi bi-check-lg ms-auto d-none"></i>
  251. </button>
  252. </li>
  253. <li>
  254. <button
  255. type="button"
  256. class="dropdown-item d-flex align-items-center"
  257. data-bs-theme-value="dark"
  258. aria-pressed="false"
  259. >
  260. <i class="bi bi-moon-fill me-2"></i>
  261. Dark
  262. <i class="bi bi-check-lg ms-auto d-none"></i>
  263. </button>
  264. </li>
  265. <li>
  266. <button
  267. type="button"
  268. class="dropdown-item d-flex align-items-center active"
  269. data-bs-theme-value="auto"
  270. aria-pressed="true"
  271. >
  272. <i class="bi bi-circle-half me-2"></i>
  273. Auto
  274. <i class="bi bi-check-lg ms-auto d-none"></i>
  275. </button>
  276. </li>
  277. </ul>
  278. </li>
  279. <!--end::Color Mode Toggle-->
  280. <!--begin::User Menu Dropdown-->
  281. <li class="nav-item dropdown user-menu">
  282. <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown">
  283. <img
  284. src="../assets/img/user2-160x160.jpg"
  285. class="user-image rounded-circle shadow"
  286. alt="User Image"
  287. />
  288. <span class="d-none d-md-inline">Alexander Pierce</span>
  289. </a>
  290. <ul class="dropdown-menu dropdown-menu-lg dropdown-menu-end">
  291. <!--begin::User Image-->
  292. <li class="user-header text-bg-primary">
  293. <img
  294. src="../assets/img/user2-160x160.jpg"
  295. class="rounded-circle shadow"
  296. alt="User Image"
  297. />
  298. <p>
  299. Alexander Pierce - Web Developer
  300. <small>Member since Nov. 2023</small>
  301. </p>
  302. </li>
  303. <!--end::User Image-->
  304. <!--begin::Menu Body-->
  305. <li class="user-body">
  306. <!--begin::Row-->
  307. <div class="row">
  308. <div class="col-4 text-center">
  309. <a href="#">Followers</a>
  310. </div>
  311. <div class="col-4 text-center">
  312. <a href="#">Sales</a>
  313. </div>
  314. <div class="col-4 text-center">
  315. <a href="#">Friends</a>
  316. </div>
  317. </div>
  318. <!--end::Row-->
  319. </li>
  320. <!--end::Menu Body-->
  321. <!--begin::Menu Footer-->
  322. <li class="user-footer">
  323. <a href="#" class="btn btn-outline-secondary">Profile</a>
  324. <a href="#" class="btn btn-outline-danger float-end">Sign out</a>
  325. </li>
  326. <!--end::Menu Footer-->
  327. </ul>
  328. </li>
  329. <!--end::User Menu Dropdown-->
  330. </ul>
  331. <!--end::End Navbar Links-->
  332. </div>
  333. <!--end::Container-->
  334. </nav>
  335. <!--end::Header-->
  336. <!--begin::Sidebar (docs mode)-->
  337. <aside class="app-sidebar bg-body-secondary shadow" data-bs-theme="dark">
  338. <!--begin::Sidebar Brand-->
  339. <div class="sidebar-brand">
  340. <a href="../docs/introduction.html" class="brand-link">
  341. <img
  342. src="../assets/img/AdminLTELogo.png"
  343. alt="AdminLTE Logo"
  344. class="brand-image opacity-75 shadow"
  345. />
  346. <span class="brand-text fw-light">
  347. AdminLTE 4 <span class="opacity-75">&middot; Docs</span>
  348. </span>
  349. </a>
  350. </div>
  351. <!--end::Sidebar Brand-->
  352. <!--begin::Sidebar Wrapper-->
  353. <div class="sidebar-wrapper">
  354. <nav class="mt-2">
  355. <!--begin::Sidebar Menu-->
  356. <ul
  357. class="nav sidebar-menu flex-column"
  358. data-lte-toggle="treeview"
  359. role="navigation"
  360. aria-label="Documentation navigation"
  361. data-accordion="false"
  362. id="docs-navigation"
  363. >
  364. <li class="nav-header">START HERE</li>
  365. <li class="nav-item">
  366. <a href="../docs/introduction.html" class="nav-link active">
  367. <i class="nav-icon bi bi-download"></i>
  368. <p>Installation</p>
  369. </a>
  370. </li>
  371. <li class="nav-item">
  372. <a href="../docs/getting-started.html" class="nav-link">
  373. <i class="nav-icon bi bi-rocket-takeoff"></i>
  374. <p>Getting Started</p>
  375. </a>
  376. </li>
  377. <li class="nav-header">FOUNDATIONS</li>
  378. <li class="nav-item">
  379. <a href="../docs/layout.html" class="nav-link">
  380. <i class="nav-icon bi bi-grip-horizontal"></i>
  381. <p>Layout Classes</p>
  382. </a>
  383. </li>
  384. <li class="nav-item">
  385. <a href="../docs/layout-blueprint.html" class="nav-link">
  386. <i class="nav-icon bi bi-diagram-3"></i>
  387. <p>Layout Blueprint</p>
  388. </a>
  389. </li>
  390. <li class="nav-item">
  391. <a href="../docs/customization.html" class="nav-link">
  392. <i class="nav-icon bi bi-palette"></i>
  393. <p>Customization</p>
  394. </a>
  395. </li>
  396. <li class="nav-item">
  397. <a href="../docs/color-mode.html" class="nav-link">
  398. <i class="nav-icon bi bi-star-half"></i>
  399. <p>Color Mode</p>
  400. </a>
  401. </li>
  402. <li class="nav-item">
  403. <a href="../docs/rtl.html" class="nav-link">
  404. <i class="nav-icon bi bi-text-paragraph"></i>
  405. <p>RTL Support</p>
  406. </a>
  407. </li>
  408. <li class="nav-header">BUILDING</li>
  409. <li class="nav-item">
  410. <a href="../docs/recipes.html" class="nav-link">
  411. <i class="nav-icon bi bi-clipboard-check"></i>
  412. <p>Recipes</p>
  413. </a>
  414. </li>
  415. <li class="nav-item">
  416. <a href="#" class="nav-link">
  417. <i class="nav-icon bi bi-ui-checks-grid"></i>
  418. <p>
  419. Components
  420. <i class="nav-arrow bi bi-chevron-right"></i>
  421. </p>
  422. </a>
  423. <ul class="nav nav-treeview">
  424. <li class="nav-item">
  425. <a href="../docs/components/main-header.html" class="nav-link">
  426. <i class="nav-icon bi bi-circle"></i>
  427. <p>Main Header</p>
  428. </a>
  429. </li>
  430. <li class="nav-item">
  431. <a href="../docs/components/main-sidebar.html" class="nav-link">
  432. <i class="nav-icon bi bi-circle"></i>
  433. <p>Main Sidebar</p>
  434. </a>
  435. </li>
  436. </ul>
  437. </li>
  438. <li class="nav-item">
  439. <a href="#" class="nav-link">
  440. <i class="nav-icon bi bi-filetype-js"></i>
  441. <p>
  442. JavaScript Plugins
  443. <i class="nav-arrow bi bi-chevron-right"></i>
  444. </p>
  445. </a>
  446. <ul class="nav nav-treeview">
  447. <li class="nav-item">
  448. <a href="../docs/javascript/plugins-overview.html" class="nav-link">
  449. <i class="nav-icon bi bi-circle"></i>
  450. <p>Overview</p>
  451. </a>
  452. </li>
  453. <li class="nav-item">
  454. <a href="../docs/javascript/layout.html" class="nav-link">
  455. <i class="nav-icon bi bi-circle"></i>
  456. <p>Layout</p>
  457. </a>
  458. </li>
  459. <li class="nav-item">
  460. <a href="../docs/javascript/pushmenu.html" class="nav-link">
  461. <i class="nav-icon bi bi-circle"></i>
  462. <p>PushMenu</p>
  463. </a>
  464. </li>
  465. <li class="nav-item">
  466. <a href="../docs/javascript/treeview.html" class="nav-link">
  467. <i class="nav-icon bi bi-circle"></i>
  468. <p>Treeview</p>
  469. </a>
  470. </li>
  471. <li class="nav-item">
  472. <a href="../docs/javascript/card-widget.html" class="nav-link">
  473. <i class="nav-icon bi bi-circle"></i>
  474. <p>Card Widget</p>
  475. </a>
  476. </li>
  477. <li class="nav-item">
  478. <a href="../docs/javascript/direct-chat.html" class="nav-link">
  479. <i class="nav-icon bi bi-circle"></i>
  480. <p>Direct Chat</p>
  481. </a>
  482. </li>
  483. <li class="nav-item">
  484. <a href="../docs/javascript/fullscreen.html" class="nav-link">
  485. <i class="nav-icon bi bi-circle"></i>
  486. <p>Fullscreen</p>
  487. </a>
  488. </li>
  489. <li class="nav-item">
  490. <a href="../docs/javascript/accessibility.html" class="nav-link">
  491. <i class="nav-icon bi bi-circle"></i>
  492. <p>Accessibility</p>
  493. </a>
  494. </li>
  495. </ul>
  496. </li>
  497. <li class="nav-item">
  498. <a href="../docs/integrations.html" class="nav-link">
  499. <i class="nav-icon bi bi-puzzle"></i>
  500. <p>Integrations</p>
  501. </a>
  502. </li>
  503. <li class="nav-header">SHIPPING</li>
  504. <li class="nav-item">
  505. <a href="../docs/migration.html" class="nav-link">
  506. <i class="nav-icon bi bi-arrow-up-right-square"></i>
  507. <p>Migration from v3</p>
  508. </a>
  509. </li>
  510. <li class="nav-item">
  511. <a href="../docs/deployment.html" class="nav-link">
  512. <i class="nav-icon bi bi-cloud-upload"></i>
  513. <p>Deployment</p>
  514. </a>
  515. </li>
  516. <li class="nav-item">
  517. <a href="../docs/browser-support.html" class="nav-link">
  518. <i class="nav-icon bi bi-browser-chrome"></i>
  519. <p>Browser Support</p>
  520. </a>
  521. </li>
  522. <li class="nav-header">RESOURCES</li>
  523. <li class="nav-item">
  524. <a href="../docs/faq.html" class="nav-link">
  525. <i class="nav-icon bi bi-question-circle"></i>
  526. <p>FAQ</p>
  527. </a>
  528. </li>
  529. <li class="nav-item">
  530. <a href="../docs/how-to-contribute.html" class="nav-link">
  531. <i class="nav-icon bi bi-people"></i>
  532. <p>Contributing</p>
  533. </a>
  534. </li>
  535. <li class="nav-item">
  536. <a href="../docs/license.html" class="nav-link">
  537. <i class="nav-icon bi bi-patch-check"></i>
  538. <p>License</p>
  539. </a>
  540. </li>
  541. <li class="nav-item">
  542. <a
  543. href="https://github.com/ColorlibHQ/AdminLTE"
  544. target="_blank"
  545. rel="noopener"
  546. class="nav-link"
  547. >
  548. <i class="nav-icon bi bi-github"></i>
  549. <p>
  550. GitHub
  551. <i class="bi bi-box-arrow-up-right ms-1" aria-hidden="true"></i>
  552. </p>
  553. </a>
  554. </li>
  555. </ul>
  556. <!--end::Sidebar Menu-->
  557. <!-- Back to preview CTA (bottom of sidebar) -->
  558. <div class="p-3 mt-3 border-top border-secondary border-opacity-25">
  559. <a
  560. href="../index.html"
  561. class="btn btn-sm btn-outline-light w-100 d-flex align-items-center justify-content-center gap-2"
  562. >
  563. <i class="bi bi-arrow-left" aria-hidden="true"></i>
  564. Back to live preview
  565. </a>
  566. </div>
  567. </nav>
  568. </div>
  569. <!--end::Sidebar Wrapper-->
  570. </aside>
  571. <!--end::Sidebar (docs mode)-->
  572. <!--begin::App Main-->
  573. <main class="app-main">
  574. <!--begin::App Content Header-->
  575. <div class="app-content-header">
  576. <!--begin::Container-->
  577. <div class="container-fluid">
  578. <!--begin::Row-->
  579. <div class="row">
  580. <div class="col-sm-6">
  581. <h3 class="mb-0">Introduction</h3>
  582. </div>
  583. <div class="col-sm-6">
  584. <ol class="breadcrumb float-sm-end">
  585. <li class="breadcrumb-item"><a href="#">Docs</a></li>
  586. <li class="breadcrumb-item active" aria-current="page">Introduction</li>
  587. </ol>
  588. </div>
  589. </div>
  590. <!--end::Row-->
  591. </div>
  592. <!--end::Container-->
  593. </div>
  594. <!--end::App Content Header-->
  595. <!--begin::App Content-->
  596. <div class="app-content">
  597. <!--begin::Container-->
  598. <div class="container-fluid">
  599. <h2 id="what-is-adminlte">What is AdminLTE?</h2>
  600. <p>
  601. AdminLTE is a free, MIT-licensed admin dashboard template built on
  602. <strong>Bootstrap 5.3.8</strong> with vanilla TypeScript (no jQuery). It ships
  603. responsive layouts, a sidebar navigation system, light/dark/auto color mode, RTL
  604. support, and a growing catalog of demo pages — calendar, kanban, chat, file manager,
  605. invoice, profile, settings, and more.
  606. </p>
  607. <p>
  608. It’s a <em>template</em>, not a component library. You drop the markup into your own
  609. project (or framework templates) and customize the parts you need. Bootstrap 5 handles
  610. the components; AdminLTE provides the application shell.
  611. </p>
  612. <p>
  613. If you’ve never used AdminLTE before, start with
  614. <a href="getting-started.html">Getting Started</a> — it walks through a working
  615. dashboard in ten minutes.
  616. </p>
  617. <h2 id="installation-paths">Installation paths</h2>
  618. <p>Pick the path that matches how you’ll actually use AdminLTE:</p>
  619. <table>
  620. <thead>
  621. <tr>
  622. <th>Path</th>
  623. <th>Best for</th>
  624. <th>Setup time</th>
  625. </tr>
  626. </thead>
  627. <tbody>
  628. <tr>
  629. <td><strong>CDN</strong></td>
  630. <td>Prototyping, demos, simple sites</td>
  631. <td>1 minute</td>
  632. </tr>
  633. <tr>
  634. <td><strong>npm + bundler</strong></td>
  635. <td>Production apps, framework projects (Laravel, Symfony, Rails)</td>
  636. <td>5 minutes</td>
  637. </tr>
  638. <tr>
  639. <td><strong>Build from source</strong></td>
  640. <td>You need to customize SCSS variables, sidebar width, breakpoints</td>
  641. <td>10 minutes</td>
  642. </tr>
  643. <tr>
  644. <td><strong>Composer</strong></td>
  645. <td>PHP projects that prefer Packagist over npm</td>
  646. <td>2 minutes</td>
  647. </tr>
  648. </tbody>
  649. </table>
  650. <h3 id="cdn--fastest-path">CDN — fastest path</h3>
  651. <p>
  652. Drop these four CSS tags into <code>&lt;head&gt;</code> and four script tags before
  653. <code>&lt;/body&gt;</code>. No install, no build step:
  654. </p>
  655. <pre
  656. class="astro-code dark-plus"
  657. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  658. tabindex="0"
  659. data-language="html"
  660. ><code><span class="line"><span style="color:#6A9955">&lt;!-- In &lt;head&gt; --&gt;</span></span>
  661. <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>
  662. <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>
  663. <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>
  664. <span class="line"></span>
  665. <span class="line"><span style="color:#6A9955">&lt;!-- Before &lt;/body&gt; --&gt;</span></span>
  666. <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>
  667. <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>
  668. <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>
  669. <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>
  670. <p>
  671. Then copy any
  672. <a href="https://github.com/ColorlibHQ/AdminLTE/tree/master/dist">demo page</a> HTML
  673. into your own file. See <a href="getting-started.html">Getting Started</a> for the
  674. minimum-viable layout.
  675. </p>
  676. <h3 id="npm--bundler">npm + bundler</h3>
  677. <p>Requires Node.js 18+ and a bundler (Vite, Webpack, Rollup, esbuild, etc.).</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="bash"
  683. ><code><span class="line"><span style="color:#DCDCAA">npm</span><span style="color:#CE9178"> install</span><span style="color:#CE9178"> admin-lte@4.0.0-rc7</span></span></code></pre>
  684. <p>Then import the CSS and JS in your app entry point:</p>
  685. <pre
  686. class="astro-code dark-plus"
  687. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  688. tabindex="0"
  689. data-language="js"
  690. ><code><span class="line"><span style="color:#6A9955">// CSS</span></span>
  691. <span class="line"><span style="color:#C586C0">import</span><span style="color:#CE9178"> &quot;admin-lte/dist/css/adminlte.min.css&quot;</span></span>
  692. <span class="line"><span style="color:#6A9955">// Plus Bootstrap and dependency CSS</span></span>
  693. <span class="line"><span style="color:#C586C0">import</span><span style="color:#CE9178"> &quot;bootstrap-icons/font/bootstrap-icons.css&quot;</span></span>
  694. <span class="line"><span style="color:#C586C0">import</span><span style="color:#CE9178"> &quot;overlayscrollbars/styles/overlayscrollbars.css&quot;</span></span>
  695. <span class="line"></span>
  696. <span class="line"><span style="color:#6A9955">// JS</span></span>
  697. <span class="line"><span style="color:#C586C0">import</span><span style="color:#CE9178"> &quot;bootstrap&quot;</span></span>
  698. <span class="line"><span style="color:#C586C0">import</span><span style="color:#CE9178"> &quot;admin-lte&quot;</span></span></code></pre>
  699. <p>
  700. Yarn and pnpm work the same way — substitute <code>yarn add</code> or
  701. <code>pnpm add</code> for the install.
  702. </p>
  703. <h3 id="build-from-source">Build from source</h3>
  704. <p>
  705. If you want to customize SCSS variables (sidebar width, breakpoints, brand colours),
  706. clone the repo and build locally:
  707. </p>
  708. <pre
  709. class="astro-code dark-plus"
  710. style="background-color: #1e1e1e; color: #d4d4d4; overflow-x: auto"
  711. tabindex="0"
  712. data-language="bash"
  713. ><code><span class="line"><span style="color:#DCDCAA">git</span><span style="color:#CE9178"> clone</span><span style="color:#CE9178"> https://github.com/ColorlibHQ/AdminLTE.git</span></span>
  714. <span class="line"><span style="color:#DCDCAA">cd</span><span style="color:#CE9178"> AdminLTE</span></span>
  715. <span class="line"><span style="color:#DCDCAA">npm</span><span style="color:#CE9178"> install</span></span>
  716. <span class="line"><span style="color:#DCDCAA">npm</span><span style="color:#CE9178"> run</span><span style="color:#CE9178"> dev</span><span style="color:#6A9955"> # dev server with hot-reload at localhost:3000</span></span>
  717. <span class="line"><span style="color:#DCDCAA">npm</span><span style="color:#CE9178"> run</span><span style="color:#CE9178"> production</span><span style="color:#6A9955"> # one-off production build (clean + lint + compile)</span></span></code></pre>
  718. <p>
  719. The compiled output lands in <code>dist/</code>. Edit
  720. <code>src/scss/_variables.scss</code> or
  721. <code>src/scss/_bootstrap-variables.scss</code>, then rerun the build. See
  722. <a href="customization.html">Customization &amp; Theming</a> for which variables
  723. matter.
  724. </p>
  725. <h3 id="composer">Composer</h3>
  726. <p>For PHP projects:</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="bash"
  732. ><code><span class="line"><span style="color:#DCDCAA">composer</span><span style="color:#CE9178"> require</span><span style="color:#CE9178"> &quot;almasaeed2010/adminlte=4.0.0-rc7&quot;</span></span></code></pre>
  733. <p>
  734. The package is published from the same source tree — you get the
  735. <code>dist/</code> folder ready to serve.
  736. </p>
  737. <h2 id="prerequisites">Prerequisites</h2>
  738. <table>
  739. <thead>
  740. <tr>
  741. <th></th>
  742. <th>Minimum</th>
  743. <th>Recommended</th>
  744. </tr>
  745. </thead>
  746. <tbody>
  747. <tr>
  748. <td>Bootstrap</td>
  749. <td>5.3.0</td>
  750. <td>5.3.8 (pinned in <code>package.json</code>)</td>
  751. </tr>
  752. <tr>
  753. <td>Node.js</td>
  754. <td>18 LTS</td>
  755. <td>22 LTS (used by CI)</td>
  756. </tr>
  757. <tr>
  758. <td>Browser</td>
  759. <td>Modern evergreen</td>
  760. <td>Latest stable Chrome/Firefox/Safari/Edge</td>
  761. </tr>
  762. </tbody>
  763. </table>
  764. <p>
  765. AdminLTE 4 does <strong>not</strong> support Internet Explorer. If you need IE11, stay
  766. on
  767. <a href="https://github.com/ColorlibHQ/AdminLTE/releases/tag/v3.2.0">AdminLTE 3</a> or
  768. earlier.
  769. </p>
  770. <h2 id="where-to-next">Where to next</h2>
  771. <ul>
  772. <li>
  773. <strong><a href="getting-started.html">Getting Started</a></strong> — a working
  774. dashboard in 10 minutes
  775. </li>
  776. <li>
  777. <strong><a href="layout.html">Layout</a></strong> — the app-wrapper structure and
  778. responsive options
  779. </li>
  780. <li>
  781. <strong><a href="customization.html">Customization</a></strong> — change colours,
  782. sidebar width, spacing
  783. </li>
  784. <li>
  785. <strong><a href="migration.html">Migration from v3</a></strong> — upgrading an
  786. existing AdminLTE 3 project
  787. </li>
  788. </ul>
  789. <h2 id="releases-and-changelog">Releases and changelog</h2>
  790. <p>
  791. Always grab the latest from the
  792. <a href="https://github.com/ColorlibHQ/AdminLTE/releases">GitHub releases page</a> —
  793. that’s where the changelog lives.
  794. </p>
  795. <p>
  796. Legacy releases:
  797. <a href="https://github.com/ColorlibHQ/AdminLTE/releases/tag/v3.2.0">AdminLTE 3.2</a>
  798. ·
  799. <a href="https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18">AdminLTE 2</a> ·
  800. <a href="https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1">AdminLTE 1</a>
  801. </p>
  802. </div>
  803. <!--end::Container-->
  804. </div>
  805. <!--end::App Content-->
  806. </main>
  807. <!--end::App Main-->
  808. <!--begin::Footer-->
  809. <footer class="app-footer">
  810. <!--begin::To the end-->
  811. <div class="float-end d-none d-sm-inline">Anything you want</div>
  812. <!--end::To the end-->
  813. <!--begin::Copyright-->
  814. <strong>
  815. Copyright &copy; 2014-2026&nbsp;
  816. <a href="https://adminlte.io" class="text-decoration-none">AdminLTE.io</a>.
  817. </strong>
  818. All rights reserved.
  819. <!--end::Copyright-->
  820. </footer>
  821. <!--end::Footer-->
  822. </div>
  823. <!--end::App Wrapper-->
  824. <!--begin::Script-->
  825. <!--begin::Third Party Plugin(OverlayScrollbars)-->
  826. <script
  827. src="https://cdn.jsdelivr.net/npm/overlayscrollbars@2.11.0/browser/overlayscrollbars.browser.es6.min.js"
  828. crossorigin="anonymous"
  829. ></script>
  830. <!--end::Third Party Plugin(OverlayScrollbars)--><!--begin::Required Plugin(popperjs for Bootstrap 5)-->
  831. <script
  832. src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js"
  833. crossorigin="anonymous"
  834. ></script>
  835. <!--end::Required Plugin(popperjs for Bootstrap 5)--><!--begin::Required Plugin(Bootstrap 5)-->
  836. <script
  837. src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/js/bootstrap.min.js"
  838. crossorigin="anonymous"
  839. ></script>
  840. <!--end::Required Plugin(Bootstrap 5)--><!--begin::Required Plugin(AdminLTE)-->
  841. <script src="../js/adminlte.js"></script>
  842. <!--end::Required Plugin(AdminLTE)--><!--begin::OverlayScrollbars Configure-->
  843. <script>
  844. const SELECTOR_SIDEBAR_WRAPPER = '.sidebar-wrapper';
  845. const Default = {
  846. scrollbarTheme: 'os-theme-light',
  847. scrollbarAutoHide: 'leave',
  848. scrollbarClickScroll: true,
  849. };
  850. document.addEventListener('DOMContentLoaded', function () {
  851. const sidebarWrapper = document.querySelector(SELECTOR_SIDEBAR_WRAPPER);
  852. // Disable OverlayScrollbars on mobile devices to prevent touch interference
  853. const isMobile = window.innerWidth <= 992;
  854. if (
  855. sidebarWrapper &&
  856. OverlayScrollbarsGlobal?.OverlayScrollbars !== undefined &&
  857. !isMobile
  858. ) {
  859. OverlayScrollbarsGlobal.OverlayScrollbars(sidebarWrapper, {
  860. scrollbars: {
  861. theme: Default.scrollbarTheme,
  862. autoHide: Default.scrollbarAutoHide,
  863. clickScroll: Default.scrollbarClickScroll,
  864. },
  865. });
  866. }
  867. });
  868. </script>
  869. <!--end::OverlayScrollbars Configure--><!--begin::Color Mode Toggle (#6010)-->
  870. <script>
  871. (() => {
  872. 'use strict';
  873. const STORAGE_KEY = 'lte-theme';
  874. const getStoredTheme = () => localStorage.getItem(STORAGE_KEY);
  875. const setStoredTheme = (theme) => localStorage.setItem(STORAGE_KEY, theme);
  876. const prefersDark = () => globalThis.matchMedia('(prefers-color-scheme: dark)').matches;
  877. const getPreferredTheme = () => {
  878. const stored = getStoredTheme();
  879. if (stored) return stored;
  880. return prefersDark() ? 'dark' : 'light';
  881. };
  882. const setTheme = (theme) => {
  883. const resolved = theme === 'auto' ? (prefersDark() ? 'dark' : 'light') : theme;
  884. document.documentElement.setAttribute('data-bs-theme', resolved);
  885. };
  886. setTheme(getPreferredTheme());
  887. const showActiveTheme = (theme) => {
  888. // Highlight the active dropdown option
  889. document.querySelectorAll('[data-bs-theme-value]').forEach((el) => {
  890. el.classList.remove('active');
  891. el.setAttribute('aria-pressed', 'false');
  892. const check = el.querySelector('.bi-check-lg');
  893. if (check) check.classList.add('d-none');
  894. });
  895. const active = document.querySelector(`[data-bs-theme-value="${theme}"]`);
  896. if (active) {
  897. active.classList.add('active');
  898. active.setAttribute('aria-pressed', 'true');
  899. const check = active.querySelector('.bi-check-lg');
  900. if (check) check.classList.remove('d-none');
  901. }
  902. // Sync the topbar trigger icon
  903. document.querySelectorAll('[data-lte-theme-icon]').forEach((icon) => {
  904. icon.classList.toggle('d-none', icon.dataset.lteThemeIcon !== theme);
  905. });
  906. };
  907. globalThis.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
  908. const stored = getStoredTheme();
  909. if (!stored || stored === 'auto') setTheme(getPreferredTheme());
  910. });
  911. document.addEventListener('DOMContentLoaded', () => {
  912. showActiveTheme(getPreferredTheme());
  913. document.querySelectorAll('[data-bs-theme-value]').forEach((toggle) => {
  914. toggle.addEventListener('click', () => {
  915. const theme = toggle.getAttribute('data-bs-theme-value');
  916. setStoredTheme(theme);
  917. setTheme(theme);
  918. showActiveTheme(theme);
  919. });
  920. });
  921. });
  922. })();
  923. </script>
  924. <!--end::Color Mode Toggle-->
  925. <!--end::Script-->
  926. </body>
  927. <!--end::Body-->
  928. </html>