Introduction

Tyro Dashboard is a ready-to-use admin panel designed specifically for Laravel applications. It provides everything needed to manage users, control access, monitor activity, and build admin interfaces without assembling multiple packages or writing repetitive boilerplate code.

It integrates seamlessly with Tyro for role-based access control and Tyro Login for complete authentication workflows, including registration, login, OTP, TOTP, magic login, social login, email verification, and user suspension. Together, they form a complete and cohesive user management system.

Tyro Dashboard also includes dynamic CRUD generation, audit trails, and a fully responsive interface with native dark mode support. This allows you to focus on building your application's core features while Tyro handles the dashboard infrastructure.

Features

Tyro Dashboard comes packed with features to help you manage your application effectively:

Requirements

• PHP: 8.2 or higher
• Laravel: 12.x
• Tyro Package: hasinhayder/tyro ^1.0 (required)
• Tyro Login: hasinhayder/tyro-login ^1.0 (optional but recommended)
• Database: Any database supported by Laravel

Installation

Install Tyro Dashboard in just two simple steps:

Step 1: Install via Composer

composer require hasinhayder/tyro-dashboard

Step 2: Run the Interactive Installer

php artisan tyro-dashboard:install

The installer will:

• Check dependencies (Tyro package)
• Publish the configuration file
• Optionally publish views for customization
• Help you configure admin roles and branding

Manual Installation

If you prefer manual setup:

# Publish configuration
php artisan vendor:publish --tag=tyro-dashboard-config

# Optionally publish views
php artisan vendor:publish --tag=tyro-dashboard-views

Screenshots

Here are some screenshots of Tyro Dashboard in action:

Dashboard Landing Light Mode

Dashboard Landing Dark Mode

Profile Management Light Mode

Profile Management Dark Mode

User Management Light Mode

User Management Dark Mode

Role Management Light Mode

Role Management Dark Mode

Create Role Light Mode

Create Role Dark Mode

Role Detail Light Mode

Role Detail Dark Mode

Edit User Light Mode

Edit User Dark Mode

Privilege Management Light Mode

Privilege Management Dark Mode

Create Privilege Light Mode

Create Privilege Dark Mode

Privilege Detail Light Mode

Privilege Detail Dark Mode

Edit Privilege Light Mode

Edit Privilege Dark Mode

Route Settings

Configure how Tyro Dashboard routes are registered:

'routes' => [
    // URL prefix for all dashboard routes
    'prefix' => env('TYRO_DASHBOARD_PREFIX', 'dashboard'),

    // Middleware applied to all dashboard routes
    'middleware' => ['web', 'auth'],

    // Route name prefix
    'name_prefix' => 'tyro-dashboard.',
],

Environment Variables

# Change dashboard URL from /dashboard to /admin
TYRO_DASHBOARD_PREFIX=admin

Admin Roles

Configure which roles have full admin access to the dashboard:

// Users with these roles have full admin access
'admin_roles' => ['admin', 'super-admin'],

Users with these roles can:

• Manage all users (create, edit, suspend, delete)
• Manage all roles and privileges
• Access and modify package settings
• View the full admin dashboard

Users without admin roles can only:

• Access the dashboard home page
• Manage their own profile

Pagination Settings

Configure how many items appear per page in lists:

'pagination' => [
    'users' => 15,      // Users per page
    'roles' => 15,      // Roles per page
    'privileges' => 15, // Privileges per page
],

Branding

Customize the dashboard with your brand identity:

'branding' => [
    // Application name shown in dashboard
    'app_name' => env('TYRO_DASHBOARD_APP_NAME', env('APP_NAME', 'Laravel')),

    // URL to your logo (null for text-based logo)
    'logo' => env('TYRO_DASHBOARD_LOGO', null),
],

Environment Variables

TYRO_DASHBOARD_APP_NAME="My Application"
TYRO_DASHBOARD_LOGO="/images/logo.svg"

User Management

The User Management section allows administrators to:

• View Users: Browse all users with search and pagination
• Create Users: Add new users with name, email, and role assignment
• Edit Users: Update user information and change roles
• Suspend Users: Temporarily disable user accounts
• Delete Users: Remove users from the system

Routes

Role Management

Manage roles for your application's access control:

• View Roles: Browse all roles with their assigned privileges
• Create Roles: Add new roles with name, slug, and description
• Edit Roles: Update role information and assign/remove privileges
• View Role Details: See all privileges assigned to a role
• Delete Roles: Remove roles (protected roles cannot be deleted)

Routes

Privilege Management

Manage privileges for fine-grained access control:

• View Privileges: Browse all privileges in the system
• Create Privileges: Add new privileges with name, slug, and description
• Edit Privileges: Update privilege information
• Delete Privileges: Remove privileges from the system

Routes

Profile Management

All authenticated users can manage their own profile:

• Update Name: Change display name
• Update Email: Change email address
• Change Password: Update account password
• Profile Picture: Upload or change avatar

Route

Profile Photos & Gravatar

Tyro Dashboard supports user profile photos out of the box. Users can upload a custom photo or fall back to their Gravatar avatar. Avatars are shown throughout the dashboard, including the user management list.

Setup

Add the HasProfilePhoto trait to your User model:

use Hasinhayder\TyroDashboard\Traits\HasProfilePhoto;

class User extends Authenticatable
{
    use HasProfilePhoto;
    // ...
}

Configuration

User Impersonation

Administrators can impersonate any regular user account to debug problems or provide hands-on support. The original admin session is preserved and easily restored.

How It Works

1. Navigate to the Users admin page.
2. Click the Impersonate action button for the target user. A modal dialog will ask for confirmation.
3. After confirming, you are now browsing as that user.
4. To return to your admin session, navigate to the /dashboard/leave-impersonation route.

Security

• Only users with a role listed in admin_roles config can initiate impersonation.
• A dedicated middleware (TyroImpersonation) protects the leave-impersonation route.
• Impersonation state is stored securely in the server-side session.

Invitation & Referral System

Tyro Dashboard includes a complete invitation and referral system. Admins manage invitation links; users see who they have referred. Everything is tracked automatically.

Enable the Feature

TYRO_DASHBOARD_ENABLE_INVITATION=true

Database Migrations

Two migrations are included and run automatically during php artisan tyro-dashboard:install:

• invitation_links - Stores invitation links created by admins
• invitation_referrals - Records which users signed up via an invitation

Admin Capabilities

• Create and revoke invitation links with optional expiry dates
• View all invitation links and their usage statistics
• See the complete referral history

User Capabilities

• View their own referral history on their dashboard
• See how many users they have referred

Routes

Audit Trail

Tyro Dashboard provides detailed admin pages for browsing the audit trail recorded by the Tyro RBAC package's HasAuditTrail trait. Every model change is logged and can be reviewed with powerful filters.

Features

• Filterable: Filter by event type (created, updated, deleted), model type, user, or date range
• Searchable: Full-text search across audit log entries
• Paginated: Large audit logs are paginated for fast loading
• Detail View: Click any entry to see the exact old and new values for every changed field

Prerequisite

Your models must use the HasAuditTrail trait from the Tyro RBAC package to generate audit records:

use Hasinhayder\Tyro\Traits\HasAuditTrail;

class Post extends Model
{
    use HasAuditTrail;
    // ...
}

Routes

Modal Dialogs

Tyro Dashboard ships with a built-in modal dialog system that replaces browser confirm() popups with beautiful, accessible modals. Three helper functions are available globally in all dashboard views.

Available Functions

Usage Example

// Basic confirmation before form submit
showConfirm('Delete Record', 'Are you sure you want to delete this item?', function() {
    document.getElementById('delete-form').submit();
});

// Danger dialog for destructive actions
showDanger('Suspend User', 'This will revoke all access for this user.', function() {
    window.location.href = '/dashboard/users/42/suspend';
});

// Simple alert
showAlert('Success', 'The record has been saved successfully.');

Admin Bar

The Admin Bar in Tyro Dashboard allows you to display a globally visible announcement, alert, or notice at the very top of all dashboard layouts. It spans the full width of the screen (100vw) and dynamically adjusts the dashboard elements below it, ensuring your layout remains flawless.

You can configure and enable the Admin Bar in two ways:

• Via Environment Variables / Configuration file (Persistent and global)
• Programmatically via the AdminNotice Service Class (Dynamic, session-based, or logic-driven)

1. Using Configuration / Environment Variables

The most straightforward way to use the admin bar is through your .env file. This approach is highly useful for system maintenance messages or long-term announcements.

TYRO_DASHBOARD_ADMIN_BAR_ENABLED=true
TYRO_DASHBOARD_ADMIN_BAR_MESSAGE="⚠️ System will undergo scheduled maintenance this Sunday."
TYRO_DASHBOARD_ADMIN_BAR_BG_COLOR="#ffcc00"
TYRO_DASHBOARD_ADMIN_BAR_TEXT_COLOR="#000000"
TYRO_DASHBOARD_ADMIN_BAR_ALIGN="center"
TYRO_DASHBOARD_ADMIN_BAR_HEIGHT="40px"

Alternatively, modify config/tyro-dashboard.php directly:

'admin_bar' => [
    'enabled' => true,
    'message' => 'System will undergo scheduled maintenance this Sunday.',
    'bg_color' => '#ffcc00',     // Default is #000000
    'text_color' => '#000000',   // Default is #ffffff
    'align' => 'center',         // Default is left (options: left, center, right)
    'height' => '40px',          // Configurable height
],

2. Using the AdminNotice Service Class

For dynamic messages, notifications tied to a specific user state, or alerts generated from middleware and controllers, inject notices at runtime using the AdminNotice class.

use HasinHayder\TyroDashboard\Services\AdminNotice;

// Basic usage with just a message
AdminNotice::show('Sale ends in 24 hours! <b>Don\'t miss out!</b>');

// Advanced usage with custom styling
AdminNotice::show(
    'Server SSD capacity is critically low (< 5%). <a href="/admin/servers">Check Status</a>', 
    '#dc2626',   // Background Color (Red)
    '#ffffff',   // Text Color (White)
    'center'     // Text Alignment
);

Page Creation

Tyro Dashboard includes powerful artisan commands to scaffold complete dashboard pages in seconds. These commands automatically handle everything from view creation to route registration and sidebar navigation.

Available Commands

Three specialized commands let you create pages with different access levels:

Create User Page

The create-user-page command generates pages for regular authenticated users. These pages extend the user layout and appear in the user sidebar.

# Interactive mode - prompts for page name
php artisan tyro-dashboard:create-user-page

# Direct mode - provide page name as argument
php artisan tyro-dashboard:create-user-page "analytics"

# With multiple words (automatically slugified)
php artisan tyro-dashboard:create-user-page "Sales Reports"
# Creates: /dashboard/sales-reports

# Overwrite existing files
php artisan tyro-dashboard:create-user-page "analytics" --force

What Gets Created

Generated Route

Route::view('dashboard/{page-name}', 'dashboard.{page-name}')
    ->middleware(['auth'])
    ->name('dashboard.{page-name}');

Create Admin Page

The create-admin-page command generates pages exclusively for administrators. These pages are protected with the tyro-dashboard.admin middleware and appear in the admin sidebar.

# Interactive mode
php artisan tyro-dashboard:create-admin-page

# Direct mode
php artisan tyro-dashboard:create-admin-page "system-logs"

# With multiple words
php artisan tyro-dashboard:create-admin-page "Advanced Settings"
# Creates: /dashboard/advanced-settings

# Overwrite existing files
php artisan tyro-dashboard:create-admin-page "system-logs" --force

What Gets Created

Generated Route

Route::view('dashboard/{page-name}', 'dashboard.{page-name}')
    ->middleware(['auth', 'tyro-dashboard.admin'])
    ->name('dashboard.{page-name}');

Create Common Page

The create-common-page command creates pages accessible to both regular users and administrators. These pages appear in both the user and admin sidebars.

# Interactive mode
php artisan tyro-dashboard:create-common-page

# Direct mode
php artisan tyro-dashboard:create-common-page "help-center"

# With multiple words
php artisan tyro-dashboard:create-common-page "Support Documentation"
# Creates: /dashboard/support-documentation

# Overwrite existing files
php artisan tyro-dashboard:create-common-page "help-center" --force

What Gets Created

Generated Route

Route::view('dashboard/{page-name}', 'dashboard.{page-name}')
    ->middleware(['auth'])
    ->name('dashboard.{page-name}');

Generated Page Structure

All generated pages follow a consistent, clean structure that's ready to customize:

Generated Page File Locations

Understanding where files are created and modified helps you customize your pages:

your-laravel-app/
├── resources/
│   └── views/
│       ├── dashboard/
│       │   └── page-name.blade.php          ← New page view created here
│       └── vendor/
│           └── tyro-dashboard/
│               └── partials/
│                   ├── user-sidebar.blade.php  ← Link added here (user/common)
│                   └── admin-sidebar.blade.php ← Link added here (admin/common)
└── routes/
    └── web.php                                 ← Route registered here

Automatic Features

Every generated page includes these features out of the box:

Use Cases

Here are some practical examples of when to use each command:

Page Removal Commands

Safely remove dashboard pages that were created with the page creation commands. These commands will delete the view file, remove the route from web.php, and remove the sidebar link.

Remove User Page

Remove a user-facing dashboard page that was created with create-user-page.

# Interactive mode - asks for page name
php artisan tyro-dashboard:remove-user-page

# Direct mode - provide page name as argument
php artisan tyro-dashboard:remove-user-page "my-reports"

What Gets Removed

Remove Admin Page

Remove an admin-only dashboard page that was created with create-admin-page.

# Interactive mode
php artisan tyro-dashboard:remove-admin-page

# Direct mode
php artisan tyro-dashboard:remove-admin-page "system-settings"

What Gets Removed

Remove Common Page

Remove a common dashboard page that was created with create-common-page. This removes the page from both user and admin sidebars.

# Interactive mode
php artisan tyro-dashboard:remove-common-page

# Direct mode
php artisan tyro-dashboard:remove-common-page "help-center"

What Gets Removed

Page Removal

Remove dashboard pages that were created with the page creation commands. These commands safely delete view files, routes, and sidebar links.

tyro-dashboard:remove-user-page

Remove a user-facing dashboard page.

php artisan tyro-dashboard:remove-user-page

# Direct mode
php artisan tyro-dashboard:remove-user-page "my-reports"

tyro-dashboard:remove-admin-page

Remove an admin-only dashboard page.

php artisan tyro-dashboard:remove-admin-page

# Direct mode
php artisan tyro-dashboard:remove-admin-page "system-settings"

tyro-dashboard:remove-common-page

Remove a common dashboard page (removes from both sidebars).

php artisan tyro-dashboard:remove-common-page

# Direct mode
php artisan tyro-dashboard:remove-common-page "help-center"

What removal commands do:

• Delete the Blade view file from resources/views/dashboard/
• Remove the route from routes/web.php
• Remove the sidebar link(s) from the appropriate sidebar file(s)
• Show a warning and ask for confirmation before deletion
• Display "Page not found" message if the page doesn't exist

CRUD Workflow

Creating a new resource in Tyro Dashboard is an incredibly streamlined process using the HasCrud trait. Follow these steps to set up a complete CRUD interface in minutes.

1. Create Migration & Model

Start by creating your standard Laravel model and migration.

php artisan make:model Product -m

2. Add HasCrud Trait

Add the HasCrud trait to your model. Ensure the model has a $fillable array, which Tyro Dashboard uses to determine the fields to render.

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use HasinHayder\TyroDashboard\Concerns\HasCrud;

class Product extends Model
{
    use HasCrud;

    protected $fillable = [
        'name', 
        'price', 
        'status', 
        'description'
    ];
}

3. Visit the Resource Page

That's literally it! Visit your admin dashboard in the browser, and navigate to the plural form of your model (e.g., /dashboard/resources/products). You will instantly have access to the full create, read, update, and delete interface for your resource.

Resource CRUD Configuration

Tyro Dashboard comes with a powerful and dynamic CRUD generator that allows you to quickly build administrative interfaces for your Eloquent models. It supports generating full create, read, update, and delete interfaces simply by using the HasCrud trait on your models.

The Power of HasCrud

The HasCrud trait uses auto-discovery and introspection to automatically learn about your database schema, model properties ($fillable), and defined Eloquent relationships. With just one line of code, you get a full-fledged working CRUD dashboard.

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use HasinHayder\TyroDashboard\Concerns\HasCrud;

class Post extends Model
{
    use HasCrud;

    protected $fillable = [
        'title',
        'content',
        'is_published',
        'category_id',
    ];

    // Defining this relationship tells HasCrud to automatically create a select field for category_id!
    public function category()
    {
        return $this->belongsTo(Category::class);
    }
}

The HasCrud trait introspects the table schema, analyzes your $fillable array, and intelligently guesses field types. For example:

• It matches a _id suffix to a select type.
• It detects is_, has_, can_ prefixed fields as boolean inputs.
• It sees fields like description, bio, or content and turns them into textarea.
• It intelligently discovers all publicly exported Eloquent relationships like BelongsToMany to create syncable multi-select fields out of the box.

Model Overrides & Deep Customization

While auto-detection takes care of most of the heavy lifting, HasCrud exposes several highly customizable protected properties allowing you to bend the CRUD to your exact needs without needing external configuration files.

General Resource Overrides (Optional)

• $resourceKey: Override the URL slug/identifier used in routes (default is plural snake_case of class name).
• $resourceTitle: The plural display name of the resource (default is plural Title Case of class name).
• $resourceTitleSingular: The singular display name.
• $resourceRoles: An array of role slugs that can access this resource globally ['admin', 'manager'].
• $resourceReadonly: An array of role slugs that can only view (read-only) ['editor', 'guest'].
• $resourceUploadDisk: The Laravel storage disk for file uploads (public by default).
• $resourceUploadDirectory: The disk directory for uploads (uploads by default).

Tailoring Fields with $resourceFieldOverrides (Optional)

The real magic arrives with $resourceFieldOverrides. Instead of redefining all your fields or moving to a configuration file, use this property to inject UI specifics on a per-field basis.

class User extends Model
{
    use HasCrud;

    protected $fillable = ['name', 'email', 'bio', 'password', 'role_id'];

    // Provide overriding UI states just for the fields that need tweaking
    protected $resourceFieldOverrides = [
        'email' => [
            'type' => 'email', // Ensures client validation for email
            'searchable' => true,
        ],
        'bio' => [
            'type' => 'markdown', // Change from textarea to rich markdown editor
            'hide_in_index' => true,
        ],
        'password' => [
            'type' => 'password',
            'hide_in_index' => true,      
            'hide_in_edit' => true, // Don't let users edit password here
        ],
    ];
}

Note: You can completely disable auto-generation and define the entire UI natively from scratch by providing a strict $resourceFields array inside your model instead. However, using $resourceFieldOverrides is the generally recommended path.

Field Types and Modifiers

Tyro Dashboard natively supports a huge list of input configurations.

Field Options

Every field defined under $resourceFieldOverrides accepts various parameters that dictate behavior on forms:

'description' => [
    'type' => 'text',
    'label' => 'Display Label',
    'rules' => 'required|min:5|max:200', // Laravel validation rules
    'default' => 'Initial Text',         // Default value shown on create screens
    'placeholder' => 'Enter text here',  // Standard placeholder
    'help_text' => 'Optional string beneath the input describing usage',
    'hide_in_index' => true,             // Hides field specifically on the table view
    'hide_in_create' => true,            // Hides on the "create" mode
    'hide_in_edit' => true,              // Hides on the "update/edit" mode
    'hide_in_form' => true,              // Hides completely across ALL forms (create + edit)
    'hide_in_single_view' => true,       // Hide from detail/show view
    'readonly' => true,                  // Forces HTML `readonly` state
],
// Sort/Search mechanics
'title' => [
    'searchable' => true, // Can users search this globally on index boards?
    'sortable' => true,   // Clickable column header asc/desc tracking?
]

Passing HTML Attributes

You can pass raw underlying HTML attributes directly to the generated inputs via the attributes dictionary. This is incredibly useful for setting HTML5 specific steps, disabled states, or data tags.

'purchase_price' => [
    'type' => 'number',
    'attributes' => [
        'min' => '0',
        'step' => '0.01',
        'data-trigger' => 'price-update',
        'disabled' => 'disabled' // Or using native string 'disabled'
    ]
]

Mastering Relationships

HasCrud goes out of its way to link Eloquent relationships securely. When HasCrud analyzes your model, it identifies relationships and immediately builds the correct foreign selections out of the box. You only really need to customize them using $resourceFieldOverrides for fine-grained labeling.

You do this via three main relationship keys:

• relationship: The name of the method housing your Eloquent relationship.
• option_label: The target DB column representing the display name for the relation choices.
• multiple: Needed for Multi-select BelongsToMany syncs where type is a standard select.

1D Relationships (BelongsTo)

// Creating standard one-to-many selectors
'category_id' => [
    'type' => 'select', // Or radio natively
    'label' => 'Parent Category',
    'relationship' => 'category', // Name of `public function category()`
    'option_label' => 'name', // What property to grab from the Category model
],

Many-To-Many Synced Relationships (BelongsToMany)

Multi-relational syncing handles logic perfectly underneath the hood. Choose the optimal display logic (a large multi-select, or an expanding array of checkboxes).

// In `$resourceFieldOverrides` for Tags Syncing
'tags' => [
    'type' => 'multiselect', // Will render an auto-syncing multiselect dropdown
    // OR 'type' => 'checkbox' // Will render an auto-syncing UI checklist!
    'label' => 'Post Tags',
    'relationship' => 'tags',
    'option_label' => 'name', 
],

When store() or update() is tripped, these relationship selections are cleverly parsed out of standard Eloquent payload flows and strictly diverted safely through Eloquent's User->tags()->sync([id_list]) function.

File and Image Modifiers

File fields (type => file) automatically push uploads directly to standard Laravel Disks utilizing configured settings.

You can explicitly ask Tyro Dashboard to render image previews natively inline on Edit Views by overriding the config properties:

'avatar' => [
    'type' => 'file',
    'display_image' => true, // Auto-renders an <img> preview if the stored asset is jpg/webp/gif
    'display_image_position' => 'top', // Show the preview 'top' (before input) or 'bottom' (after input) 
]

During deletion/replacement, Tyro Dashboard is equipped to safely manage auto-delete garbage collection. When you update a user's avatar, it drops the old picture first directly via Storage facades natively to preserve disk capacities.

Access Management

Tyro Dashboard integrates deeply with Tyro RBAC. You can control exactly which roles have access to your CRUD resource by overriding the $resourceRoles array.

class Product extends Model
{
    use HasCrud;

    // Only these roles can access the resource dashboard
    protected $resourceRoles = ['admin', 'manager']; 
}

Readonly Resources

If you want to disable creating, editing, or deleting records for a specific resource, you can set the $readonly property.

protected $readonly = true;

Alternatively, you can restrict write access to specific roles by providing an array to the $resourceReadonly property in your Model overrides.

class Product extends Model
{
    use HasCrud;

    // The 'editor' role can only read/view this resource, but cannot create/update/destroy it
    protected $resourceReadonly = ['editor']; 
}

This will remove the "Create" button and the "Edit/Delete" actions from the index view.

Error Visibility

You can control whether validation errors are shown globally or inline. Override the $showErrors property.

protected $showErrors = true; // Default is true

Publishing Assets

Customize Tyro Dashboard by publishing assets:

Publish Configuration

php artisan vendor:publish --tag=tyro-dashboard-config

Publish Views

php artisan vendor:publish --tag=tyro-dashboard-views

Views will be published to resources/views/vendor/tyro-dashboard/.

Theme Customization (shadcn Variables)

Tyro Dashboard uses shadcn/ui CSS variables for theming, making it easy to customize colors and integrate with shadcn-based projects. The theme system is fully compatible with the tweakcn.com visual theme editor.

Publishing Theme Files

Publish the theme variables to customize the look and feel of your dashboard:

# Publish only theme variables (recommended for color customization)
php artisan tyro-dashboard:publish-style --theme-only

# Or publish complete styles (theme + component styles)
php artisan tyro-dashboard:publish-style

Theme files will be published to resources/views/vendor/tyro-dashboard/partials/.

Visual Theme Editing with tweakcn

The easiest way to customize your theme is using tweakcn.com:

1. Visit tweakcn.com
2. Use the visual editor to create your perfect color palette
3. Copy the generated CSS variables
4. Publish your theme: php artisan tyro-dashboard:publish-style --theme-only
5. Paste the variables into resources/views/vendor/tyro-dashboard/partials/shadcn-theme.blade.php

Theme File Structure

After publishing, your theme structure will be:

resources/views/vendor/tyro-dashboard/partials/
├── shadcn-theme.blade.php  # Theme variables (edit this!)
└── styles.blade.php        # Component styles (includes theme)

The shadcn-theme.blade.php file contains only CSS variables, making it safe to edit without breaking component styles.

Available CSS Variables

Tyro Dashboard uses standard shadcn CSS variables in oklch color format for both light and dark modes:

Manual Theme Editing

If you prefer to edit the theme manually, open resources/views/vendor/tyro-dashboard/partials/shadcn-theme.blade.php and modify the CSS variables:

<style>
    :root {
        /* Base radius for components */
        --radius: 0.625rem;

        /* Light mode colors */
        --background: oklch(1 0 0);
        --foreground: oklch(0.145 0 0);
        --card: oklch(1 0 0);
        --card-foreground: oklch(0.145 0 0);
        --popover: oklch(1 0 0);
        --popover-foreground: oklch(0.145 0 0);
        --primary: oklch(0.205 0 0);
        --primary-foreground: oklch(0.985 0 0);
        --secondary: oklch(0.97 0 0);
        --secondary-foreground: oklch(0.205 0 0);
        --muted: oklch(0.97 0 0);
        --muted-foreground: oklch(0.556 0 0);
        --accent: oklch(0.97 0 0);
        --accent-foreground: oklch(0.205 0 0);
        --destructive: oklch(0.577 0.245 27.325);
        --border: oklch(0.922 0 0);
        --input: oklch(0.922 0 0);
        --ring: oklch(0.708 0 0);

        /* Chart colors */
        --chart-1: oklch(0.646 0.222 41.116);
        --chart-2: oklch(0.6 0.118 184.704);
        --chart-3: oklch(0.398 0.07 227.392);
        --chart-4: oklch(0.828 0.189 84.429);
        --chart-5: oklch(0.769 0.188 70.08);

        /* Sidebar colors */
        --sidebar: oklch(0.985 0 0);
        --sidebar-foreground: oklch(0.145 0 0);
        --sidebar-primary: oklch(0.205 0 0);
        --sidebar-primary-foreground: oklch(0.985 0 0);
        --sidebar-accent: oklch(0.97 0 0);
        --sidebar-accent-foreground: oklch(0.205 0 0);
        --sidebar-border: oklch(0.922 0 0);
        --sidebar-ring: oklch(0.708 0 0);

        /* Extended semantic colors */
        --success: oklch(0.627 0.194 149.214);
        --success-foreground: oklch(1 0 0);
        --warning: oklch(0.769 0.188 70.08);
        --warning-foreground: oklch(0.205 0 0);
        --info: oklch(0.623 0.214 259.815);
        --info-foreground: oklch(1 0 0);

        /* Card shadows */
        --card-shadow: 0 1px 2px 0 rgb(0 0 0 / 0.05);
        --card-shadow-hover: 0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1);
    }

    /* Dark mode colors - using .dark class */
    .dark {
        --background: oklch(0.145 0 0);
        --foreground: oklch(0.985 0 0);
        --card: oklch(0.205 0 0);
        --card-foreground: oklch(0.985 0 0);
        --popover: oklch(0.205 0 0);
        --popover-foreground: oklch(0.985 0 0);
        --primary: oklch(0.922 0 0);
        --primary-foreground: oklch(0.205 0 0);
        --secondary: oklch(0.269 0 0);
        --secondary-foreground: oklch(0.985 0 0);
        --muted: oklch(0.269 0 0);
        --muted-foreground: oklch(0.708 0 0);
        --accent: oklch(0.269 0 0);
        --accent-foreground: oklch(0.985 0 0);
        --destructive: oklch(0.704 0.191 22.216);
        --border: oklch(1 0 0 / 10%);
        --input: oklch(1 0 0 / 15%);
        --ring: oklch(0.556 0 0);

        /* Chart colors (dark mode) */
        --chart-1: oklch(0.488 0.243 264.376);
        --chart-2: oklch(0.696 0.17 162.48);
        --chart-3: oklch(0.769 0.188 70.08);
        --chart-4: oklch(0.627 0.265 303.9);
        --chart-5: oklch(0.645 0.246 16.439);

        /* Sidebar colors (dark mode) */
        --sidebar: oklch(0.205 0 0);
        --sidebar-foreground: oklch(0.985 0 0);
        --sidebar-primary: oklch(0.488 0.243 264.376);
        --sidebar-primary-foreground: oklch(0.985 0 0);
        --sidebar-accent: oklch(0.269 0 0);
        --sidebar-accent-foreground: oklch(0.985 0 0);
        --sidebar-border: oklch(1 0 0 / 10%);
        --sidebar-ring: oklch(0.556 0 0);

        /* Extended semantic colors (dark mode) */
        --success: oklch(0.696 0.17 162.48);
        --success-foreground: oklch(0.145 0 0);
        --warning: oklch(0.769 0.188 70.08);
        --warning-foreground: oklch(0.145 0 0);
        --info: oklch(0.488 0.243 264.376);
        --info-foreground: oklch(0.985 0 0);

        /* Card shadows (dark mode) */
        --card-shadow: 0 1px 2px 0 rgb(0 0 0 / 0.2);
        --card-shadow-hover: 0 4px 6px -1px rgb(0 0 0 / 0.3), 0 2px 4px -2px rgb(0 0 0 / 0.2);
    }
</style>

Sidebar Customization

Tyro Dashboard allows you to quickly change the sidebar's visual appearance using environment variables - no CSS overrides needed.

Sidebar Colors

TYRO_DASHBOARD_SIDEBAR_BG=#1e293b
TYRO_DASHBOARD_SIDEBAR_TEXT=#f8fafc
TYRO_DASHBOARD_DISABLE_EXAMPLES=true

Custom Menu Items

Define custom sidebar menu items for admin, common, and user sidebars by publishing and editing config/menu.php. Each item supports a title, URL, and optional inline SVG icon.

Publish Menu Config

php artisan vendor:publish --tag=tyro-dashboard-config

Menu Configuration

Edit config/menu.php to add items to the three available menus:

<?php

return [
    // Shown only to admin users
    'adminMenuItems' => [
        [
            'title' => 'Reports',
            'url'   => '/dashboard/reports',
            'icon'  => '<svg ...>...</svg>',
        ],
    ],

    // Shown to both admins and regular users
    'commonMenuItems' => [
        [
            'title' => 'Help Center',
            'url'   => '/dashboard/help',
            'icon'  => '<svg ...>...</svg>',
        ],
    ],

    // Shown only to regular (non-admin) users
    'userMenuItems' => [
        [
            'title' => 'My Reports',
            'url'   => '/dashboard/my-reports',
            'icon'  => '<svg ...>...</svg>',
        ],
    ],
];

Environment Variables

Complete list of environment variables for Tyro Dashboard:

Artisan Commands

Tyro Dashboard provides the following artisan commands:

Page Creation Commands

Tyro Dashboard includes powerful commands to generate complete dashboard pages in seconds. These commands automatically create views, register routes, and add sidebar navigation links.

Create User Page

Creates a new page for regular users, extending the user layout and adding it to the user sidebar.

# Interactive mode - prompts for page name
php artisan tyro-dashboard:create-user-page

# Direct mode - provide page name as argument
php artisan tyro-dashboard:create-user-page "my-reports"

# Overwrite existing files
php artisan tyro-dashboard:create-user-page "my-reports" --force

What this command does:

• Creates a Blade view file at resources/views/dashboard/{page-name}.blade.php
• Extends tyro-dashboard::layouts.user layout
• Adds a route to routes/web.php with auth middleware
• Automatically links the page in the user sidebar under "Menu" section
• Includes proper breadcrumb navigation
• Publishes user views if not already published

Generated route:

Route::view('dashboard/{page-name}', 'dashboard.{page-name}')
    ->middleware(['auth'])
    ->name('dashboard.{page-name}');

Create Admin Page

Creates a new page for administrators, extending the admin layout and adding it to the admin sidebar.

# Interactive mode
php artisan tyro-dashboard:create-admin-page

# Direct mode
php artisan tyro-dashboard:create-admin-page "system-settings"

# Overwrite existing files
php artisan tyro-dashboard:create-admin-page "system-settings" --force

What this command does:

• Creates a Blade view file at resources/views/dashboard/{page-name}.blade.php
• Extends tyro-dashboard::layouts.admin layout
• Adds a route to routes/web.php with auth and tyro-dashboard.admin middleware
• Automatically links the page in the admin sidebar under "Administration" section
• Includes proper breadcrumb navigation
• Publishes admin views if not already published

Generated route:

Route::view('dashboard/{page-name}', 'dashboard.{page-name}')
    ->middleware(['auth', 'tyro-dashboard.admin'])
    ->name('dashboard.{page-name}');

Create Common Page

Creates a page accessible to both regular users and administrators, extending the common app layout.

# Interactive mode
php artisan tyro-dashboard:create-common-page

# Direct mode
php artisan tyro-dashboard:create-common-page "help-center"

# Overwrite existing files
php artisan tyro-dashboard:create-common-page "help-center" --force

What this command does:

• Creates a Blade view file at resources/views/dashboard/{page-name}.blade.php
• Extends tyro-dashboard::layouts.app layout
• Adds a route to routes/web.php with auth middleware
• Automatically links the page in both user and admin sidebars under "Menu" section
• Includes proper breadcrumb navigation
• Publishes all dashboard views if not already published

Generated route:

Route::view('dashboard/{page-name}', 'dashboard.{page-name}')
    ->middleware(['auth'])
    ->name('dashboard.{page-name}');

Page Structure

All generated pages follow a consistent structure with proper sections and styling:

@extends('tyro-dashboard::layouts.user') {{-- or admin/app --}}

@section('title', 'Page Title')

@section('breadcrumb')
Dashboard
/
Page Title
@endsection

@section('content')

    

        

            
Page Title
            
Welcome to your new page.
        
    



    

        
Page Title Content
    
    

        
This is a new dashboard page. Start building your content here.
    

@endsection

File Locations

When you create a page, the following files are created or modified:

your-laravel-app/
├── resources/
│   └── views/
│       ├── dashboard/
│       │   └── {page-name}.blade.php          ← New page view created here
│       └── vendor/
│           └── tyro-dashboard/
│               └── partials/
│                   ├── user-sidebar.blade.php  ← Link added here (user/common pages)
│                   └── admin-sidebar.blade.php ← Link added here (admin/common pages)
└── routes/
    └── web.php                                 ← Route added here

Page Removal Commands

Remove dashboard pages that were created with the page creation commands. These commands safely delete view files, routes, and sidebar links.

tyro-dashboard:remove-user-page

Remove a user-facing dashboard page.

php artisan tyro-dashboard:remove-user-page

# Direct mode
php artisan tyro-dashboard:remove-user-page "my-reports"

tyro-dashboard:remove-admin-page

Remove an admin-only dashboard page.

php artisan tyro-dashboard:remove-admin-page

# Direct mode
php artisan tyro-dashboard:remove-admin-page "system-settings"

tyro-dashboard:remove-common-page

Remove a common dashboard page (removes from both sidebars).

php artisan tyro-dashboard:remove-common-page

# Direct mode
php artisan tyro-dashboard:remove-common-page "help-center"

What removal commands do:

• Delete the Blade view file from resources/views/dashboard/
• Remove the route from routes/web.php
• Remove the sidebar link(s) from the appropriate sidebar file(s)
• Show a warning and ask for confirmation before deletion
• Display "Page not found" message if the page doesn't exist

Routes Reference

Complete list of routes provided by Tyro Dashboard:

Access Control

Tyro Dashboard implements role-based access control:

Admin & Super-Admin

Users with admin roles have full access to:

• User management (create, edit, suspend, delete)
• Role management (create, edit, delete)
• Privilege management (create, edit, delete)
• Package settings configuration
• Dashboard home and statistics

Regular Users

Users without admin roles can only access:

• Dashboard home page
• Profile management (their own profile)