Resources
Everything around AdminLTE React — source, the npm package, the live demo, the upstream template, the hooks reference and how to get help.
Project links
| Resource | Link |
|---|---|
| Repository (GitHub) | github.com/ColorlibHQ/adminlte-react |
| Package (npm) | @adminlte/react |
| Live demo | adminlte.io/themes/next-react |
| AdminLTE (template home) | adminlte.io |
| AdminLTE core (HTML/Bootstrap) | github.com/ColorlibHQ/AdminLTE |
| Issues | github.com/ColorlibHQ/adminlte-react/issues |
| Discussions | github.com/ColorlibHQ/adminlte-react/discussions |
Install
npm install @adminlte/react
Hooks reference
Beyond the context hooks, the library exports standalone hooks for building custom UI:
| Hook | Returns / purpose |
|---|---|
useColorModeContext() | { colorMode, setColorMode, resolvedMode } |
useSidebarContext() | { isCollapsed, isMobileOpen, isMiniMode, toggle, collapse, expand, sidebarBreakpoint } |
useCommandPalette() | { isOpen, open, close, toggle } (or undefined outside the provider) |
usePushMenu(options?) | Sidebar state machine (used by SidebarProvider). |
useCardWidget(initialCollapsed?) | Card collapse / maximize / remove state. |
useFullscreen() | Fullscreen API wrapper. |
useTreeviewAnimation(isOpen, speed?) | Animate a collapsible <ul> height. |
useSortable(enabled?) | Drag-and-drop on .connectedSortable lists (SortableJS). |
useDirectChat() | Toggle the chat contacts pane. |
Exported types
Full TypeScript support — import the prop and model types you need:
import type {
DashboardLayoutProps,
MenuNode,
BootstrapTheme,
LinkComponent,
CommandItem,
} from '@adminlte/react'
License
Released under the MIT License © Colorlib & AdminLTE contributors. Free for personal and commercial projects.
Reporting issues
Found a bug or have a feature request? Open an issue on the GitHub issue tracker. Please include your React and Next.js versions, the @adminlte/react version, and a minimal reproduction (the relevant component usage and menu config).
Related ports
AdminLTE 4 is offered as official ports across many stacks — the same template, native to each ecosystem:
Contributions are welcome — build the library with pnpm build and run pnpm type-check before opening a pull request.