AdminLTE 4 for Laravel

https://laravel.adminlte.io/docs
Admin
AdminLTE 4 for Laravel is an official integration package providing AdminLTE 4 and Bootstrap 5 UI...
Tokens:30,522
Snippets:416
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### AdminLTE installation command examples

Source: https://laravel.adminlte.io/docs/commands

Various ways to run the adminlte:install command for full or partial installations.

```bash
# Full install: config + assets + Vite check + npm deps (interactive)
php artisan adminlte:install

# Full install in CI / non-interactive (skip the npm prompt)
php artisan adminlte:install --no-interaction-deps

# Publish only the config file
php artisan adminlte:install --only=config

# Publish the views so you can customize them, overwriting existing files
php artisan adminlte:install --only=views --force

# Publish language files for translation overrides
php artisan adminlte:install --only=lang
```

--------------------------------

### Verify installation

Source: https://laravel.adminlte.io/docs/installation

Check the status of installed resources.

```bash
php artisan adminlte:status
```

--------------------------------

### Install Broadcasting

Source: https://laravel.adminlte.io/docs/realtime

Initialize the broadcasting system and configure the necessary environment variables.

```bash
php artisan install:broadcasting
```

--------------------------------

### Clone and Install Package

Source: https://laravel.adminlte.io/docs/contributing

Initial commands to clone the repository and install dependencies for local development.

```bash
git clone https://github.com/colorlibhq/adminlte-laravel.git
cd adminlte-laravel
composer install
```

--------------------------------

### Run adminlte:install command

Source: https://laravel.adminlte.io/docs/commands

Executes the installation command with options for specific resources, forcing overwrites, or skipping dependency prompts.

```bash
adminlte:install
    {--only= : Install only a specific resource (config|views|assets|lang)}
    {--force : Overwrite existing files}
    {--no-interaction-deps : Skip the npm install prompt}
```

--------------------------------

### Install an optional plugin

Source: https://laravel.adminlte.io/docs/plugins

Use these commands to add a new plugin to the project after the initial installation. The first command fetches the library, and the second copies it to the public directory.

```bash
npm install -D quill@^2.0          # 1. fetch the library
php artisan adminlte:install --only=assets   # 2. copy it into public/vendor
```

--------------------------------

### Post-installation steps

Source: https://laravel.adminlte.io/docs/commands

Configuration steps required after running the installation command.

```text
1. Ensure resources/js/adminlte.js & resources/css/adminlte.css are in your vite.config.js input.
2. Run npm run dev (or npm run build).
3. Extend the layout in a view: @extends('adminlte::page')
4. Configure your sidebar menu in config/adminlte.php.
```

--------------------------------

### Install optional plugins

Source: https://laravel.adminlte.io/docs/installation

Install additional plugins and update the public vendor assets.

```bash
npm install -D flatpickr@^4.6 tom-select@^2.6 tabulator-tables@^6.5 quill@^2.0
php artisan adminlte:install --only=assets
```

--------------------------------

### Run the installer

Source: https://laravel.adminlte.io/docs/installation

Execute the artisan command to publish configuration and scaffold assets.

```bash
php artisan adminlte:install
```

--------------------------------

### Install core frontend dependencies

Source: https://laravel.adminlte.io/docs/commands

Installs the required AdminLTE and Bootstrap dependencies via npm.

```bash
npm install -D admin-lte@^4.8 bootstrap@^5.3 @popperjs/core@^2.11 overlayscrollbars@^2.16 \
  bootstrap-icons@^1.13 apexcharts@^6.8 jsvectormap@^1.7 fullcalendar@^6.1 \
  sortablejs@^1.15 sass@^1.102
```

--------------------------------

### Create the preview application

Source: https://laravel.adminlte.io/docs/deployment

Initializes a new Laravel project and installs the AdminLTE package via Composer.

```bash
composer create-project laravel/laravel adminlte-preview
cd adminlte-preview
composer require colorlibhq/adminlte-laravel
```

--------------------------------

### Install Laravel Breeze

Source: https://laravel.adminlte.io/docs/authentication

Commands to install the Laravel Breeze package and set up the blade scaffolding.

```bash
composer require laravel/breeze --dev
php artisan breeze:install blade
```

--------------------------------

### Install AdminLTE and build assets

Source: https://laravel.adminlte.io/docs/deployment

Publishes package files and compiles frontend assets using Vite.

```bash
php artisan adminlte:install          # publishes config/stubs, npm deps, vendor files
# add the two entries to vite.config.js (see installation.md), then:
npm ci
npm run build
```

--------------------------------

### Scaffold Authentication Commands

Source: https://laravel.adminlte.io/docs/authentication

Examples of running the authentication scaffolding command with default and force options.

```bash
# Scaffold plain auth (controllers + routes)
php artisan adminlte:make-auth

# Re-scaffold, overwriting the controllers
php artisan adminlte:make-auth --type=plain --force
```

--------------------------------

### Start Servers

Source: https://laravel.adminlte.io/docs/realtime

Launch the Reverb WebSocket server and the queue worker for processing broadcast events.

```bash
php artisan reverb:start
php artisan queue:work     # if the event implements ShouldBroadcast (queued)
```

--------------------------------

### Require the package

Source: https://laravel.adminlte.io/docs/installation

Install the package via Composer.

```bash
composer require colorlibhq/adminlte-laravel
```

--------------------------------

### Docker Container Configuration

Source: https://laravel.adminlte.io/docs/deployment

A multi-stage Dockerfile setup for PHP-FPM that installs dependencies, builds assets, and prepares the application for production.

```dockerfile
FROM php:8.3-fpm AS app
WORKDIR /var/www/html
RUN apt-get update && apt-get install -y nodejs npm \
    && docker-php-ext-install pdo pdo_mysql bcmath
COPY composer.json composer.lock ./
RUN composer install --no-dev --optimize-autoloader
COPY package*.json ./
RUN npm ci
COPY . .
RUN npm run build \
    && php artisan config:cache && php artisan route:cache && php artisan view:cache
```

--------------------------------

### adminlte:install

Source: https://laravel.adminlte.io/docs/commands

Installs the core AdminLTE 4 scaffolding, including the configuration file, Vite asset stubs, and frontend npm dependencies.

```APIDOC
## adminlte:install

### Description
Installs the core AdminLTE 4 scaffolding: the config file, the Vite CSS/JS entry stubs, and the frontend npm dependencies.

### Signature
adminlte:install {--only= : Install only a specific resource (config|views|assets|lang)} {--force : Overwrite existing files} {--no-interaction-deps : Skip the npm install prompt}

### Options
- **--only** (string) - Optional - Publish only a specific resource (config, views, assets, or lang).
- **--force** (boolean) - Optional - Pass --force to vendor:publish, overwriting existing files.
- **--no-interaction-deps** (boolean) - Optional - Skip the interactive npm install prompt.
```

--------------------------------

### Build Client Assets

Source: https://laravel.adminlte.io/docs/realtime

Install dependencies and compile the assets including Laravel Echo and the Reverb client.

```bash
npm install && npm run build
```

--------------------------------

### Authentication Command Examples

Source: https://laravel.adminlte.io/docs/commands

Various ways to invoke the authentication scaffolding command based on the desired integration type.

```bash
# Plain auth (controllers + routes)
php artisan adminlte:make-auth

# Plain auth, overwrite existing controllers
php artisan adminlte:make-auth --type=plain --force

# Breeze integration guidance
php artisan adminlte:make-auth --type=breeze

# Fortify integration guidance
php artisan adminlte:make-auth --type=fortify
```

--------------------------------

### Install Laravel Fortify

Source: https://laravel.adminlte.io/docs/authentication

Command to add the Laravel Fortify package to your project.

```bash
composer require laravel/fortify
```

--------------------------------

### Scaffold Plain Authentication Flow

Source: https://laravel.adminlte.io/docs/authentication

Commands to install, scaffold, migrate, and build the frontend for a standard authentication flow.

```bash
# 1. Install the package scaffolding (config, assets, npm deps)
php artisan adminlte:install

# 2. Scaffold plain authentication (controllers + routes)
php artisan adminlte:make-auth

# 3. Make sure Laravel's default auth tables exist (users, password_reset_tokens)
php artisan migrate

# 4. Build the frontend
npm run dev   # or: npm run build
```

--------------------------------

### Generate demo route names

Source: https://laravel.adminlte.io/docs/demo-pages

Examples of how to generate route names for the demo pages using the route helper.

```php
route('adminlte.demo.dashboard-v2');     // demo/dashboard-v2
route('adminlte.demo.forms.wizard');     // demo/forms/wizard
route('adminlte.demo.errors.404');       // demo/errors/404
```

--------------------------------

### Run AdminLTE Status Command

Source: https://laravel.adminlte.io/docs/commands

Executes the status check to verify the installation state of AdminLTE resources.

```bash
adminlte:status
```

```bash
php artisan adminlte:status
```

--------------------------------

### Deploy via Managed Hosting

Source: https://laravel.adminlte.io/docs/deployment

Use this script in services like Laravel Forge, Ploi, or RunCloud to automate dependency installation, asset building, and cache optimization.

```bash
composer install --optimize-autoloader --no-dev
npm ci && npm run build
php artisan migrate --force
php artisan config:cache && php artisan route:cache && php artisan view:cache
```

--------------------------------

### SmallBox Component Example

Source: https://laravel.adminlte.io/docs/components

Displays a large KPI box with a value, label, icon, and a footer link.

```html
<x-adminlte-small-box title="150" text="New Orders" icon="bi bi-bag"
    theme="success" url="/orders" urlText="View all" />
```

--------------------------------

### InfoBox Component Example

Source: https://laravel.adminlte.io/docs/components

Displays a compact statistics box with an icon, value, and progress bar.

```html
<x-adminlte-info-box title="Bookmarks" text="41,410" icon="bi bi-bookmark"
    theme="info" progress="70" progressText="70% increase in 30 days" />
```

--------------------------------

### Minimal Page Layout Example

Source: https://laravel.adminlte.io/docs/layout

Basic structure for extending the AdminLTE page layout, including content sections and asset pushing.

```blade
@extends('adminlte::page')

@section('title', 'Reports')

@section('content_header')
    <h3 class="mb-0">Reports</h3>
@stop

@section('content')
    <x-adminlte-card title="Monthly summary">
        <p>Your content here.</p>
    </x-adminlte-card>
@stop

@push('css')
    <style>.report-table th { white-space: nowrap; }</style>
@endpush

@push('js')
    <script>console.log('Reports page ready');</script>
@endpush
```

--------------------------------

### AdminLTE Scaffold Usage Examples

Source: https://laravel.adminlte.io/docs/commands

Common usage patterns for the adminlte:scaffold command, ranging from interactive selection to forced overwrites.

```bash
# Interactive multi-select picker
php artisan adminlte:scaffold

# Scaffold one section
php artisan adminlte:scaffold kanban

# Scaffold one section, then migrate and seed demo data
php artisan adminlte:scaffold mailbox --seed

# Scaffold everything
php artisan adminlte:scaffold --all

# Re-scaffold and overwrite customizations
php artisan adminlte:scaffold projects --force

# Roles & permissions layer (HasRoles on User, users/roles UI), seeded
php artisan adminlte:scaffold rbac --seed
```

--------------------------------

### Scaffold API Token Management

Source: https://laravel.adminlte.io/docs/api

Commands to install Sanctum, scaffold the AdminLTE API token management features, and run migrations.

```bash
php artisan install:api          # pulls in Sanctum + personal_access_tokens migration + routes/api.php
php artisan adminlte:scaffold api
php artisan migrate
```

--------------------------------

### Define Menu Item with Scope

Source: https://laravel.adminlte.io/docs/menu

Example configuration for placing a menu item in the right side of the top navbar.

```php
// Place an item in the right side of the top navbar instead of the sidebar:
['text' => 'Help', 'url' => 'help', 'icon' => 'bi bi-question-circle', 'topnav_right' => true],
```

--------------------------------

### Proxying php artisan serve with Nginx

Source: https://laravel.adminlte.io/docs/deployment

Alternative setup for temporary previews using the built-in PHP server managed by a process manager and proxied via Nginx.

```bash
# supervisor / systemd unit
php artisan serve --host=127.0.0.1 --port=8000
```

```nginx
location / { proxy_pass http://127.0.0.1:8000; proxy_set_header Host $host; }
```

--------------------------------

### User Model Role and Permission Methods

Source: https://laravel.adminlte.io/docs/authorization

Examples of using the HasRoles trait methods on a user instance.

```php
$user->assignRole('editor');
$user->hasRole('admin');                 // false
$user->hasRole(['admin', 'editor']);     // true
$user->hasPermission('manage-projects'); // true
```

--------------------------------

### Card Component Example

Source: https://laravel.adminlte.io/docs/components

Shows a card with a title, icon, theme, collapsible functionality, and custom slots for tools and footer.

```html
<x-adminlte-card title="Sales" icon="bi bi-graph-up" theme="primary" collapsible>
    <x-slot name="tools">
        <button class="btn btn-sm">Export</button>
    </x-slot>

    Monthly revenue chart goes here.

    <x-slot name="footer">Updated 2 minutes ago</x-slot>
</x-adminlte-card>
```

--------------------------------

### Scaffold the demo application

Source: https://laravel.adminlte.io/docs/deployment

Generates authentication views and database-backed demo content, then runs migrations.

```bash
php artisan adminlte:make-auth                 # login/register/etc.
php artisan adminlte:scaffold --all --seed     # all DB-backed sections + demo data
php artisan migrate --force
```

--------------------------------

### GET /admin/profile

Source: https://laravel.adminlte.io/docs/account-management

Retrieves the account management page.

```APIDOC
## GET /admin/profile

### Description
Displays the tabbed account management page for the authenticated user.

### Method
GET

### Endpoint
/admin/profile
```

--------------------------------

### Configure AdminLTE for Breeze

Source: https://laravel.adminlte.io/docs/authentication

Command to initialize AdminLTE authentication scaffolding specifically for Breeze mode.

```bash
php artisan adminlte:make-auth --type=breeze
```

--------------------------------

### Scaffold Real-time Components

Source: https://laravel.adminlte.io/docs/realtime

Run this command to publish the broadcast event, Echo listener bundle, and channel authorization routes.

```bash
php artisan adminlte:scaffold realtime
```

--------------------------------

### Build assets

Source: https://laravel.adminlte.io/docs/installation

Run development or production build commands.

```bash
npm run dev      # development (HMR)
# or
npm run build    # production
```

--------------------------------

### Scaffold the profile management interface

Source: https://laravel.adminlte.io/docs/account-management

Run these commands to generate the profile scaffold, apply the necessary database migrations, and link the storage directory for avatar uploads.

```bash
php artisan adminlte:scaffold profile
php artisan migrate          # adds the nullable `avatar` column to users
php artisan storage:link     # so uploaded avatars are publicly served
```

--------------------------------

### Authenticate with API Token

Source: https://laravel.adminlte.io/docs/api

Example cURL request to access a protected endpoint using a Bearer token.

```bash
curl -H "Authorization: Bearer {token}" -H "Accept: application/json" \
     https://your-app.test/api/user
```

--------------------------------

### Scaffold RBAC system

Source: https://laravel.adminlte.io/docs/authorization

Run this command to publish the RBAC migration, models, middleware, and other necessary files into the application.

```bash
php artisan adminlte:scaffold rbac --seed
```

--------------------------------

### Build Multi-step Wizard with x-adminlte-wizard

Source: https://laravel.adminlte.io/docs/components

Constructs a multi-step form container using nested x-adminlte-wizard-step components. Each step requires a unique step number and title.

```html
<x-adminlte-wizard :steps="2">
    <x-adminlte-wizard-step :step="1" title="Account">
        <x-adminlte-input name="email" label="Email" />
    </x-adminlte-wizard-step>
    <x-adminlte-wizard-step :step="2" title="Confirm">
        Review and submit.
    </x-adminlte-wizard-step>
</x-adminlte-wizard>
```

--------------------------------

### Initialize RBAC and Management UI

Source: https://laravel.adminlte.io/docs/authorization

Commands to scaffold the RBAC layer, seed initial data, and access the management interface.

```bash
# 1. Publish the RBAC layer, run the migration, and seed roles/permissions.
php artisan adminlte:scaffold rbac --seed

# 2. Register a user — the first account becomes the admin.
#    (Scaffold auth first if you haven't: php artisan adminlte:make-auth)

# 3. Visit the management UI.
#    /admin/users  and  /admin/roles
```

--------------------------------

### Configure Menu Badges and Icon Colors

Source: https://laravel.adminlte.io/docs/menu

Use the label and label_color keys to display badges, and icon_color to apply colors to menu icons.

```php
['text' => 'Inbox', 'url' => 'admin/mailbox', 'icon' => 'bi bi-envelope', 'label' => 12, 'label_color' => 'danger'],
['text' => 'Important', 'url' => '#', 'icon' => 'bi bi-circle', 'icon_color' => 'danger'],
```

--------------------------------

### Define Sanctum Protected Route

Source: https://laravel.adminlte.io/docs/api

Example route definition using the auth:sanctum middleware to return the authenticated user.

```php
Route::middleware('auth:sanctum')->get('/user', fn (Request $r) => $r->user());
```

--------------------------------

### Optimize and set permissions

Source: https://laravel.adminlte.io/docs/deployment

Generates application keys, caches configuration and views, and sets directory permissions for storage and cache.

```bash
php artisan key:generate
php artisan config:cache
php artisan route:cache
php artisan view:cache
chmod -R ug+rw storage bootstrap/cache
```

--------------------------------

### Project Directory Layout

Source: https://laravel.adminlte.io/docs/contributing

Overview of the package file structure including source code, resources, configuration, and tests.

```text
src/
  AdminLte.php                  Menu builder (singleton)
  AdminLteServiceProvider.php   Components, directives, demo routes, publishing
  Console/                      install, status, scaffold, make-auth commands
  Menu/                         MenuItemHelper + the filter pipeline
  Plugins/PluginManager.php     Lazy JS-library management
  View/Components/{Widget,Form,Tool}/

resources/
  views/                        layouts, partials, components, auth, errors, demo
  lang/                         9 locales
  stubs/                        Vite entries + scaffold stubs (migrations,
                                models, controllers, seeders, routes, views)
config/adminlte.php             Published config

tests/                          Testbench-based tests
docs/                           This documentation
```

--------------------------------

### Implement auto-login route for preview

Source: https://laravel.adminlte.io/docs/deployment

Adds a conditional route to automatically log in the demo user when the APP_DEMO environment flag is enabled.

```php
// routes/web.php  — PREVIEW ONLY
if (env('APP_DEMO', false)) {
    Route::get('/preview-login', function () {
        auth()->login(\App\Models\User::firstWhere('email', 'demo@adminlte.io'));
        return redirect('/');
    });
}
```

--------------------------------

### Publish AdminLTE Views

Source: https://laravel.adminlte.io/docs/authentication

Command to publish AdminLTE authentication views to the local resources directory.

```bash
php artisan adminlte:install --only=views
```

--------------------------------

### Run the scaffolding command

Source: https://laravel.adminlte.io/docs/scaffolding

Execute the artisan command to scaffold specific sections or all sections at once.

```bash
adminlte:scaffold [section] [--all] [--force] [--seed]
```

--------------------------------

### Implement Kanban Board with x-adminlte-kanban

Source: https://laravel.adminlte.io/docs/components

Creates a drag-and-drop Kanban board using the SortableJS plugin. Requires an array of lanes with nested card definitions.

```html
<x-adminlte-kanban :lanes="[
    ['name' => 'To Do', 'cards' => [['title' => 'Write docs', 'color' => 'primary']]],
    ['name' => 'Done', 'cards' => [['title' => 'Setup repo', 'color' => 'success']]],
]" />
```

--------------------------------

### Basic Component Usage

Source: https://laravel.adminlte.io/docs/components

Demonstrates the standard syntax for using an AdminLTE component in a Blade template.

```html
<x-adminlte-card title="Hello">Body content</x-adminlte-card>
```

--------------------------------

### Publishing Language Files

Source: https://laravel.adminlte.io/docs/translations

Command to copy the package language files into the application for customization.

```bash
php artisan adminlte:install --only=lang
```

--------------------------------

### Import Real-time Listeners

Source: https://laravel.adminlte.io/docs/realtime

Register the real-time listeners in your Vite entry file after Echo has been bootstrapped.

```javascript
// resources/js/app.js
import './adminlte-realtime'
```

--------------------------------

### Next Steps Output

Source: https://laravel.adminlte.io/docs/authentication

Informational output displayed after running the authentication scaffolding command.

```text
1. Auth views ship with the package (adminlte::auth.*) — already wired.
2. Ensure your User model and the password_reset_tokens table exist.
3. Visit /login to sign in.
```

--------------------------------

### <x-adminlte-wizard>

Source: https://laravel.adminlte.io/docs/components

A multi-step form wizard container component.

```APIDOC
## <x-adminlte-wizard>

### Description
A multi-step form wizard container; wrap <x-adminlte-wizard-step> children.

### Props
- **steps** (int) - Default: 3 - Total number of steps
- **id** (?string) - Default: auto - Wizard element id
- **class** (?string) - Default: null - Extra wrapper classes

### Slots
- **$slot** - The <x-adminlte-wizard-step> children.

## <x-adminlte-wizard-step>

### Description
A single step pane inside a wizard.

### Props
- **step** (int) - Required - Step number (1-based)
- **title** (string) - Required - Step title
- **class** (?string) - Default: null - Extra pane classes

### Slots
- **$slot** - Step content.

### Example
<x-adminlte-wizard :steps="2">
    <x-adminlte-wizard-step :step="1" title="Account">
        <x-adminlte-input name="email" label="Email" />
    </x-adminlte-wizard-step>
    <x-adminlte-wizard-step :step="2" title="Confirm">
        Review and submit.
    </x-adminlte-wizard-step>
</x-adminlte-wizard>
```

--------------------------------

### <x-adminlte-progress>

Source: https://laravel.adminlte.io/docs/components

A single Bootstrap progress bar component.

```APIDOC
## <x-adminlte-progress>

### Description
A single Bootstrap progress bar.

### Props
- **value** (int|string) - Default: 0 - Progress percentage
- **theme** (string) - Default: 'primary' - Bar color theme
- **striped** (bool) - Default: false - Striped style
- **animated** (bool) - Default: false - Animate the stripes
- **height** (?string) - Default: null - CSS height (e.g. 8px)
- **showLabel** (bool) - Default: false - Show the percentage label inside the bar

### Example
<x-adminlte-progress :value="65" theme="success" striped animated showLabel height="12px" />
```

--------------------------------

### Scaffold Fortify Authentication

Source: https://laravel.adminlte.io/docs/authentication

Run the artisan command to generate authentication scaffolding using the Fortify type.

```bash
php artisan adminlte:make-auth --type=fortify
```

--------------------------------

### Scaffold Notifications

Source: https://laravel.adminlte.io/docs/notifications

Run this command to generate the necessary migrations, controllers, views, seeders, and tests for the notifications system.

```bash
php artisan adminlte:scaffold notifications --seed
```

--------------------------------

### Seed a demo user via Tinker

Source: https://laravel.adminlte.io/docs/deployment

Creates a demo user account directly from the command line using Laravel Tinker.

```bash
php artisan tinker --execute="\App\Models\User::firstOrCreate(
    ['email' => 'demo@adminlte.io'],
    ['name' => 'Demo User', 'password' => bcrypt('password')]
);"
```

--------------------------------

### Update Preview Environment

Source: https://laravel.adminlte.io/docs/deployment

Commands to pull the latest code, update dependencies, rebuild assets, and refresh application caches.

```bash
git pull            # or composer update colorlibhq/adminlte-laravel
composer install --no-dev -o
npm ci && npm run build
php artisan migrate --force
php artisan config:cache && php artisan route:cache && php artisan view:cache
```

--------------------------------

### Scaffold Activity Log

Source: https://laravel.adminlte.io/docs/activity-log

Commands to publish the activity log migration, model, trait, controller, and views.

```bash
php artisan adminlte:scaffold activity-log
php artisan migrate
```

--------------------------------

### Add menu items at runtime

Source: https://laravel.adminlte.io/docs/menu

Use the adminlte service to insert items after a specific key or append them to the end of the menu. These additions persist for the duration of the request.

```php
// Insert directly after the item whose `key`, `text` or `header` matches:
app('adminlte')->addAfter('Dashboard',
    ['header' => 'REPORTS'],
    ['text' => 'Sales', 'route' => 'reports.sales', 'icon' => 'bi bi-graph-up'],
);

// Or simply append to the end of the menu:
app('adminlte')->add(
    ['text' => 'Status', 'url' => 'status', 'icon' => 'bi bi-activity'],
);
```

--------------------------------

### Configure Fortify Service Provider

Source: https://laravel.adminlte.io/docs/authentication

Update the FortifyServiceProvider to use AdminLTE views for login and registration.

```php
Fortify::loginView(fn () => view('adminlte::auth.login'));
Fortify::registerView(fn () => view('adminlte::auth.register'));
```

--------------------------------

### <x-adminlte-kanban>

Source: https://laravel.adminlte.io/docs/components

A drag-and-drop Kanban board component powered by SortableJS.

```APIDOC
## <x-adminlte-kanban>

### Description
A drag-and-drop Kanban board backed by SortableJS. Enables the sortablejs plugin automatically.

### Props
- **lanes** (array) - Default: [] - Lanes: name, cards (each title, description, color)
- **options** (array) - Default: [] - Extra SortableJS config options
- **class** (?string) - Default: null - Extra wrapper classes

### Example
<x-adminlte-kanban :lanes="[
    ['name' => 'To Do', 'cards' => [['title' => 'Write docs', 'color' => 'primary']]],
    ['name' => 'Done', 'cards' => [['title' => 'Setup repo', 'color' => 'success']]],
]" />
```

--------------------------------

### Configure Vite

Source: https://laravel.adminlte.io/docs/installation

Add the AdminLTE entry files to the Vite configuration.

```javascript
import { defineConfig } from 'vite'
import laravel from 'laravel-vite-plugin'

export default defineConfig({
    plugins: [
        laravel({
            input: [
                'resources/css/adminlte.css',
                'resources/js/adminlte.js',
            ],
            refresh: true,
        }),
    ],
})
```

--------------------------------

### Run Quality Gates and Tests

Source: https://laravel.adminlte.io/docs/contributing

Composer scripts to execute linting, static analysis, and testing, along with instructions for running individual PHPUnit tests.

```bash
composer lint       # code style check (Laravel Pint, PSR-12)
composer fix        # code style, applying fixes
composer analyse    # static analysis (Larastan / PHPStan level 8,
                    # with the required --memory-limit baked in)
composer test       # PHPUnit via Testbench
composer check      # all three, in CI order

# Run a single test:
vendor/bin/phpunit tests/SmokeTest.php --filter testComponentsRenderWithoutErrors
```

--------------------------------

### Add API Tokens to Menu

Source: https://laravel.adminlte.io/docs/api

Configuration array for adding the API tokens link to the AdminLTE menu.

```php
['text' => 'api_tokens', 'route' => 'adminlte.api-tokens.index', 'icon' => 'bi bi-key'],
```

--------------------------------

### Register demo routes in ServiceProvider

Source: https://laravel.adminlte.io/docs/demo-pages

Logic used by AdminLteServiceProvider to register demo routes based on configuration settings.

```php
if (! config('adminlte.demo', true)) {
    return;
}

$middleware = config('adminlte.demo_middleware', ['web', 'auth']);
$middleware[] = DemoUserMenu::class;

Route::middleware($middleware)->group(function () use ($pages) {
    foreach ($pages as $uri => $view) {
        Route::view($uri, 'adminlte::'.$view)->name('adminlte.'.str_replace('/', '.', $uri));
    }
});
```

--------------------------------

### Scaffold Impersonation

Source: https://laravel.adminlte.io/docs/activity-log

Command to publish the impersonation controller and register the necessary routes.

```bash
php artisan adminlte:scaffold impersonation
```

--------------------------------

### <x-adminlte-input-color>

Source: https://laravel.adminlte.io/docs/components

A native color picker input component.

```APIDOC
## <x-adminlte-input-color>

### Description
A native color picker input.

### Props
- **name** (string) - Required - Field name
- **label** (?string) - Optional - Field label
- **id** (?string) - Optional - Element id
- **default** (string) - Optional - Default color value (default: '#0d6efd')
- **fgroupClass** (?string) - Optional - Wrapper classes
- **disableFeedback** (bool) - Optional - Suppress validation feedback (default: false)

### Example
<x-adminlte-input-color name="brand_color" label="Brand color" default="#198754" />
```

--------------------------------

### Define menu structure

Source: https://laravel.adminlte.io/docs/menu

Configure the menu array with headers, links, treeviews, and authorization gates. Use the 'can' attribute to restrict visibility based on user permissions.

```php
'menu' => [
    // Section header
    ['header' => 'MAIN'],

    // Simple link
    [
        'text' => 'Dashboard',
        'route' => 'dashboard',
        'icon' => 'bi bi-speedometer',
    ],

    // Treeview with a badge on the parent and an authorization gate
    [
        'text' => 'Shop',
        'icon' => 'bi bi-bag',
        'label' => 3,
        'label_color' => 'danger',
        'can' => 'manage-shop',
        'submenu' => [
            ['text' => 'Orders',   'route' => 'orders.index',   'icon' => 'bi bi-circle'],
            ['text' => 'Products', 'route' => 'products.index', 'icon' => 'bi bi-circle'],
        ],
    ],

    ['header' => 'OTHER'],

    // External link opening in a new tab
    [
        'text' => 'Documentation',
        'url' => 'https://adminlte.io/docs',
        'icon' => 'bi bi-book',
        'target' => '_blank',
    ],

    // Colored-icon link
    [
        'text' => 'Important',
        'url' => '#',
        'icon' => 'bi bi-exclamation-triangle',
        'icon_color' => 'warning',
    ],
],
```

--------------------------------

### <x-adminlte-select>

Source: https://laravel.adminlte.io/docs/components

A labeled native select component.

```APIDOC
## <x-adminlte-select>

### Description
A labeled native select; pass <option> elements as the slot.

### Props
- **name** (string) - Required - Field name
- **label** (?string) - Optional - Field label
- **id** (?string) - Optional - Element id
- **fgroupClass** (?string) - Optional - Wrapper classes
- **disableFeedback** (bool) - Optional - Suppress validation feedback (default: false)

### Example
<x-adminlte-select name="country" label="Country">
    <option value="us">United States</option>
    <option value="de">Germany</option>
</x-adminlte-select>
```

--------------------------------

### Set Dashboard as Home Page

Source: https://laravel.adminlte.io/docs/dashboard

Configures the root route to point to the DashboardController.

```php
// routes/web.php
use App\Http\Controllers\AdminLte\DashboardController;

Route::get('/', [DashboardController::class, 'index'])->middleware('auth');
```

--------------------------------

### Scaffold Mailbox Module

Source: https://laravel.adminlte.io/docs/scaffolding

Commands to generate the mailbox module files and populate the database.

```bash
# 1. Scaffold the mailbox section (publishes migration, model, controller,
#    seeder, views, and routes) and run migrate + seed in one shot.
php artisan adminlte:scaffold mailbox --seed

# If you prefer to do it in steps:
php artisan adminlte:scaffold mailbox
php artisan migrate
php artisan db:seed --class=AdminLteMailboxSeeder
```

--------------------------------

### Configure production environment variables

Source: https://laravel.adminlte.io/docs/deployment

Sets essential environment variables for a production deployment.

```ini
APP_ENV=production
APP_DEBUG=false
APP_URL=https://laravel.adminlte.io
```

--------------------------------

### <x-adminlte-card>

Source: https://laravel.adminlte.io/docs/components

A Bootstrap card component with optional header, tools, theming, and controls.

```APIDOC
## <x-adminlte-card>

### Description
A Bootstrap card with optional header, tools, theming, and collapse/remove/maximize controls.

### Props
- **title** (string) - Optional - Header title text
- **icon** (string) - Optional - Bootstrap Icons class shown before the title
- **theme** (string) - Optional - Color theme (primary, success, warning, danger, info, ...)
- **outline** (bool) - Optional - Render the theme as a top outline border
- **collapsible** (bool) - Optional - Add the collapse toggle button
- **collapsed** (bool) - Optional - Start collapsed
- **removable** (bool) - Optional - Add the remove (close) button
- **maximizable** (bool) - Optional - Add the maximize button
- **bodyClass** (string) - Optional - Extra classes for .card-body
- **headerClass** (string) - Optional - Extra classes for .card-header
- **footerClass** (string) - Optional - Extra classes for .card-footer

### Slots
- **$slot** - Card body content
- **tools** - Header toolbar buttons
- **footer** - Card footer content

### Example
<x-adminlte-card title="Sales" icon="bi bi-graph-up" theme="primary" collapsible>
    <x-slot name="tools">
        <button class="btn btn-sm">Export</button>
    </x-slot>
    Monthly revenue chart goes here.
    <x-slot name="footer">Updated 2 minutes ago</x-slot>
</x-adminlte-card>
```

--------------------------------

### Command Signature

Source: https://laravel.adminlte.io/docs/authentication

The signature and options for the adminlte:make-auth command.

```text
adminlte:make-auth
    {--type=plain : Auth type (plain, breeze, fortify)}
    {--force : Overwrite existing files}
```

--------------------------------

### Registering Translation Paths

Source: https://laravel.adminlte.io/docs/translations

Registers the package language directory as both a namespaced source and an additional default-namespace path.

```php
$this->loadTranslationsFrom($langPath, 'adminlte');

$loader = $this->app->make('translator')->getLoader();
if ($loader instanceof FileLoader) {
    $loader->addPath($langPath);
}
```

--------------------------------

### <x-adminlte-input>

Source: https://laravel.adminlte.io/docs/components

A labeled text input component with support for input-group addons.

```APIDOC
## <x-adminlte-input>

### Description
A labeled text input with optional input-group addons.

### Props
- **name** (string) - Required - Field name
- **label** (?string) - Optional - Field label
- **type** (string) - Optional - HTML input type (default: 'text')
- **id** (?string) - Optional - Element id
- **igroupSize** (?string) - Optional - Input group size (sm, lg)
- **fgroupClass** (?string) - Optional - Form-group wrapper classes
- **disableFeedback** (bool) - Optional - Suppress validation feedback markup (default: false)

### Example
<x-adminlte-input name="email" label="Email address" type="email" placeholder="you@example.com" />
```

--------------------------------

### Accessing Translation Keys

Source: https://laravel.adminlte.io/docs/translations

Demonstrates the two ways to access translation keys within the application.

```php
__('adminlte.search');            // default namespace (used throughout the views)
__('adminlte::adminlte.key');     // explicit package namespace
```

--------------------------------

### Display a description block

Source: https://laravel.adminlte.io/docs/components

Use the description-block component to display a heading with associated key-value pairs.

```html
<x-adminlte-description-block title="$1,200" text="Total revenue"
    :items="['Orders' => 35, 'Refunds' => 2]" />
```

--------------------------------

### x-adminlte-toast

Source: https://laravel.adminlte.io/docs/components

A Bootstrap toast notification component.

```APIDOC
## <x-adminlte-toast>

### Description
A Bootstrap toast notification.

### Parameters
- **title** (?string) - Optional - Toast header title
- **position** (string) - Optional - Screen corner (default: 'top-end')
- **autohide** (bool) - Optional - Auto-dismiss after delay (default: true)
- **delay** (int) - Optional - Auto-hide delay in ms (default: 5000)
- **theme** (string) - Optional - Header theme (default: 'primary')
- **icon** (?string) - Optional - Bootstrap Icons class
- **id** (?string) - Optional - Element id
- **class** (?string) - Optional - Extra wrapper classes

### Example
<x-adminlte-toast title="Notice" theme="success" icon="bi bi-check" :delay="4000">Your profile was updated.</x-adminlte-toast>
```

--------------------------------

### Define a Standard Navigation Link

Source: https://laravel.adminlte.io/docs/menu

Create a clickable link using text and either a url or route destination.

```php
[
    'text'  => 'Dashboard',
    'url'   => '/',
    'icon'  => 'bi bi-speedometer',
],
```

--------------------------------

### <x-adminlte-modal>

Source: https://laravel.adminlte.io/docs/components

A Bootstrap modal dialog component.

```APIDOC
## <x-adminlte-modal>

### Description
A Bootstrap modal dialog component.

### Props
- **id** (string) - Required - Modal element id (used by triggers)
- **title** (?string) - Optional - Header title
- **size** (?string) - Optional - sm, lg, or xl
- **theme** (?string) - Optional - Header background (text-bg-{theme})
- **staticBackdrop** (bool) - Optional - Disable click-outside dismissal
- **scrollable** (bool) - Optional - Scrollable modal body
- **centered** (bool) - Optional - Vertically center the dialog

### Example
<x-adminlte-modal id="confirmModal" title="Confirm" size="lg" centered>
    Are you sure you want to continue?
    <x-slot name="footer">
        <button class="btn btn-primary" data-bs-dismiss="modal">Yes</button>
    </x-slot>
</x-adminlte-modal>
```

--------------------------------

### <x-adminlte-callout>

Source: https://laravel.adminlte.io/docs/components

A bordered callout box for highlighted notes.

```APIDOC
## <x-adminlte-callout>

### Description
A bordered callout box for highlighted notes.

### Props
- **theme** (string) - Default: 'info' - Callout theme
- **title** (?string) - Default: null - Heading text
- **icon** (?string) - Default: null - Bootstrap Icons class

### Slots
- **$slot** - Callout body content

### Example
<x-adminlte-callout theme="warning" title="Heads up">
    This action cannot be undone.
</x-adminlte-callout>
```

--------------------------------

### Configure Active-State Marking

Source: https://laravel.adminlte.io/docs/menu

Define menu items with auto-derived active states or explicit URL patterns for highlighting.

```php
// Auto-derived, whether the item is defined by route or by url:
['text' => 'Users', 'route' => 'adminlte.users.index'],
['text' => 'Users', 'url' => 'admin/users'],

// Explicit patterns, when the derived one is not what you want:
['text' => 'Users', 'url' => 'admin/users', 'active' => ['admin/users*', 'admin/people*']],
```

--------------------------------

### <x-adminlte-input-file>

Source: https://laravel.adminlte.io/docs/components

A file upload input component supporting single or multiple files.

```APIDOC
## <x-adminlte-input-file>

### Description
A file upload input supporting single or multiple files.

### Props
- **name** (string) - Required - Field name
- **label** (?string) - Optional - Field label
- **id** (?string) - Optional - Element id
- **multiple** (bool) - Optional - Allow multiple files (default: false)
- **fgroupClass** (?string) - Optional - Wrapper classes
- **disableFeedback** (bool) - Optional - Suppress validation feedback (default: false)

### Example
<x-adminlte-input-file name="attachments" label="Attachments" multiple />
```

--------------------------------

### <x-adminlte-timeline>

Source: https://laravel.adminlte.io/docs/components

A vertical timeline rendered from an array of events.

```APIDOC
## <x-adminlte-timeline>

### Description
A vertical timeline rendered from an array of events.

### Props
- **items** (array) - Default: [] - Timeline entries (keys: title, body, icon, icon_bg, url, footer)
- **class** (?string) - Default: null - Extra wrapper classes

### Example
<x-adminlte-timeline :items="[
    ['icon' => 'bi bi-envelope', 'icon_bg' => 'primary', 'title' => 'New email', 'body' => 'You have 3 unread messages.'],
    ['icon' => 'bi bi-gear', 'icon_bg' => 'success', 'title' => 'Settings updated'],
]" />
```

--------------------------------

### Scaffold the Dashboard

Source: https://laravel.adminlte.io/docs/dashboard

Generates the DashboardController, view, route, and test files.

```bash
php artisan adminlte:scaffold dashboard
```

--------------------------------

### <x-adminlte-small-box>

Source: https://laravel.adminlte.io/docs/components

A large colored KPI box component with a value, label, icon, and 'more info' link.

```APIDOC
## <x-adminlte-small-box>

### Description
A large colored KPI box with a value, label, icon, and "more info" link.

### Props
- **title** (string) - Optional - The big number/value
- **text** (string) - Optional - The label under the value
- **icon** (string) - Optional - Bootstrap Icons class
- **theme** (string) - Optional - Background theme (text-bg-{theme}), default: 'primary'
- **url** (string) - Optional - Link target for the footer
- **urlText** (string) - Optional - Footer link text, default: 'More info'

### Example
<x-adminlte-small-box title="150" text="New Orders" icon="bi bi-bag" theme="success" url="/orders" urlText="View all" />
```

--------------------------------

### Create a Flatpickr date input

Source: https://laravel.adminlte.io/docs/components

Initializes a date/time picker input using the Flatpickr plugin with custom configuration options.

```html
<x-adminlte-input-flatpickr name="published_at" label="Publish date" type="datetime"
    :options="['minDate' => 'today']" />
```

--------------------------------

### Retrieve Scoped Menus

Source: https://laravel.adminlte.io/docs/menu

Resolves the AdminLte singleton to fetch menu items filtered by specific layout scopes.

```php
app('adminlte')->menu('sidebar');       // items not flagged topnav-only
app('adminlte')->menu('navbar-left');   // items with 'topnav' => true
app('adminlte')->menu('navbar-right');  // items with 'topnav_right' => true
app('adminlte')->menu();                // the full filtered list
```

--------------------------------

### Execute database migrations and seeders

Source: https://laravel.adminlte.io/docs/scaffolding

When the --seed flag is used, the scaffolder runs migrations and executes the specific seeder class for the scaffolded section.

```bash
php artisan migrate --force
php artisan db:seed --class={Seeder} --force
```

--------------------------------

### Define plugin configuration

Source: https://laravel.adminlte.io/docs/plugins

Configures individual plugins within the plugins array, supporting both string and array formats for asset paths.

```php
'plugins' => [
    'apexcharts' => [
        'enabled' => false,
        'js' => 'vendor/apexcharts/apexcharts.min.js',
    ],
    'jsvectormap' => [
        'enabled' => false,
        'css' => 'vendor/jsvectormap/jsvectormap.min.css',
        'js' => [
            'vendor/jsvectormap/jsvectormap.min.js',
            'vendor/jsvectormap/maps/world.js',
        ],
    ],
],
```

--------------------------------

### x-adminlte-direct-chat

Source: https://laravel.adminlte.io/docs/components

A chat-style message panel component.

```APIDOC
## <x-adminlte-direct-chat>

### Description
A chat-style message panel rendered from an array of messages.

### Parameters
- **items** (array) - Optional - Messages: message, avatar, is_own (bool) (default: [])
- **title** (?string) - Optional - Panel header title
- **class** (?string) - Optional - Extra wrapper classes

### Example
<x-adminlte-direct-chat title="Support" :items="[['message' => 'Hi there!', 'avatar' => '/img/u.jpg', 'is_own' => false], ['message' => 'How can I help?', 'avatar' => '/img/me.jpg', 'is_own' => true]]" />
```

--------------------------------

### Render a textarea

Source: https://laravel.adminlte.io/docs/components

Creates a labeled textarea element. Use the slot to define the initial content or value.

```html
<x-adminlte-textarea name="bio" label="About you" rows="4" />
```

--------------------------------

### <x-adminlte-alert>

Source: https://laravel.adminlte.io/docs/components

A themed, optionally dismissable Bootstrap alert component.

```APIDOC
## <x-adminlte-alert>

### Description
A themed, optionally dismissable Bootstrap alert.

### Props
- **theme** (string) - Default: 'info' - Alert theme (success, warning, danger, etc.)
- **title** (?string) - Default: null - Bold title text
- **icon** (?string) - Default: null - Bootstrap Icons class
- **dismissable** (bool) - Default: false - Render a close button

### Slots
- **$slot** - Alert body content

### Example
<x-adminlte-alert theme="success" icon="bi bi-check-circle" title="Saved!" dismissable>
    Your changes were stored successfully.
</x-adminlte-alert>
```

--------------------------------

### Disable demo pages configuration

Source: https://laravel.adminlte.io/docs/demo-pages

Setting to disable demo routes in the published config/adminlte.php file.

```php
'demo' => false,
```

--------------------------------

### Display a progress bar

Source: https://laravel.adminlte.io/docs/components

Use the progress component to visualize percentage-based completion. Supports striping, animation, and custom heights.

```html
<x-adminlte-progress :value="65" theme="success" striped animated showLabel height="12px" />
```
Tokens:
Raw