Laravel DataTables

https://github.com/yajra/laravel-datatables-docs
Admin
Laravel DataTables is a package that handles server-side DataTables integration for Laravel,...
Tokens:160,962
Snippets:1,620
Trust Score:9.7
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Quick Install All-in-One with Vite

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/installation.md

Complete setup with all plugins: install the all-in-one package and then install DataTables assets using Vite.

```bash
# Install the all-in-one package
composer require yajra/laravel-datatables:"^13.0"

# Install DataTables assets (using Vite)
npm i laravel-datatables-vite --save-dev
```

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

### Start the development server

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Start the Artisan development server to serve the application locally.

```bash
php artisan serve
```

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

### Install Snappy Package

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-config.md

Composer command to install barryvdh/laravel-snappy for the snappy PDF generator.

```bash
composer require barryvdh/laravel-snappy
```

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

### Complete HTML Builder Configuration Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-parameters.md

Complete example showing a full configuration of the HTML Builder with common options including paging, searching, server-side processing, scrolling, state saving, and ordering.

```php
use Yajra\DataTables\Html\Builder;

$html = $builder
    ->paging(true)
    ->searching(true)
    ->info(true)
    ->lengthChange(true)
    ->pageLength(25)
    ->searchDelay(350)
    ->processing(true)
    ->serverSide(true)
    ->autoWidth(true)
    ->scrollX(true)
    ->scrollY('500px')
    ->stateSave(true)
    ->orderBy(0, 'desc');
```

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

### Complete Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-parameters.md

Shows a comprehensive configuration using multiple fluent methods.

```APIDOC
## Complete Example

### Description
Configure a DataTable with a comprehensive set of options using fluent methods.

### Method
Fluent method calls

### Parameters
- **paging** (bool) - Enable/disable pagination
- **searching** (bool) - Enable/disable search
- **info** (bool) - Show table information
- **lengthChange** (bool) - Allow changing page length
- **pageLength** (int) - Number of records per page
- **searchDelay** (int) - Search delay in milliseconds
- **processing** (bool) - Show processing indicator
- **serverSide** (bool) - Enable server-side processing
- **autoWidth** (bool) - Enable automatic column width
- **scrollX** (bool) - Enable horizontal scrolling
- **scrollY** (string) - Enable vertical scrolling with height
- **stateSave** (bool) - Save table state
- **orderBy** (int, string) - Single column order

### Request Example
```php
use Yajra\DataTables\Html\Builder;

$html = $builder
    ->paging(true)
    ->searching(true)
    ->info(true)
    ->lengthChange(true)
    ->pageLength(25)
    ->searchDelay(350)
    ->processing(true)
    ->serverSide(true)
    ->autoWidth(true)
    ->scrollX(true)
    ->scrollY('500px')
    ->stateSave(true)
    ->orderBy(0, 'desc');
```

### Response
No response body; returns the builder instance for chaining.
```

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

### displayStart

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder.md

Sets the initial display start index.

```APIDOC
## displayStart

### Description
Sets the initial display start index for the table.

### Method
displayStart

### Parameters
- **value** (integer) - Required - Start index.

### Request Example
```php
$html = $builder->displayStart(0);
```

### Response
No direct response; configures the DataTable.
```

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

### Complete Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/column-control-extension.md

A complete PHP example demonstrating how to use the Column Control extension in a DataTable class, including enabling column control and column control search with various operator types.

```APIDOC
## Complete Example

### Description
This example shows how to configure a DataTable with the Column Control extension, enabling column visibility control and search functionality for each column.

### Code
php
<?php

namespace App\DataTables;

use App\Models\User;
use Yajra\DataTables\Html\Builder;
use Yajra\DataTables\Html\Column;
use Yajra\DataTables\Services\DataTable;

class UsersDataTable extends DataTable
{
    public function html(): Builder
    {
        return $this->builder()
                    ->setTableId('users-table')
                    ->columns($this->getColumns())
                    ->minifiedAjax()
                    ->orderBy(1)
                    ->columnControl()
                    ->columnControlHeader()
                    ->columnControlSearch()
                    ->columnControlTitle();
    }

    protected function getColumns(): array
    {
        return [
            Column::make('id')
                ->columnControl(),

            Column::make('name')
                ->columnControl()
                ->columnControlSearch(),

            Column::make('email')
                ->columnControl()
                ->columnControlSearch(),

            Column::make('status')
                ->columnControl()
                ->columnControlSearch([
                    'type' => 'text',
                    'options' => ['equal', 'not'],
                ]),

            Column::make('age')
                ->columnControl()
                ->columnControlSearch([
                    'type' => 'num',
                    'options' => ['greater', 'less', 'equal'],
                ]),

            Column::make('created_at')
                ->columnControl()
                ->columnControlSearch([
                    'type' => 'date',
                    'options' => ['greater', 'less', 'equal'],
                ]),
        ];
    }
}


### Supported Operators

#### Text Operators

| Operator | Description |
|----------|-------------|
| `equal` | Exact match |
| `not` | Not equal |
| `contains` | Contains substring |
| `notContains` | Does not contain |
| `starts` | Starts with |
| `ends` | Ends with |
| `empty` | Is empty |
| `notEmpty` | Is not empty |

#### Numeric Operators

| Operator | Description |
|----------|-------------|
| `equal` | Equal to |
| `not` | Not equal to |
| `greater` | Greater than |
| `less` | Less than |
| `greaterOrEqual` | Greater than or equal |
| `lessOrEqual` | Less than or equal |

#### Date Operators

| Operator | Description |
|----------|-------------|
| `equal` | Date equal |
| `notEqual` | Date not equal (excludes NULL) |
| `greater` | After date |
| `less` | Before date |
| `greaterOrEqual` | On or after date |
| `lessOrEqual` | On or before date |
```

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

### Complete Configuration Reference

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/general-settings.md

A complete example of the config/datatables.php file showing all configuration options together.

```php
<?php

return [
    /*
     * Smart search adds wildcards automatically
     */
    'smart' => true,

    /*
     * Case insensitive searching
     */
    'case_insensitive' => true,

    /*
     * Wild card character for partial matching
     */
    'use_wildcards' => false,

    /*
     * DataTables internal index column name
     */
    'index_column' => 'DT_RowIndex',

    /*
     * Error message configuration
     */
    'error' => env('DATATABLES_ERROR', null),

    /*
     * NULLS LAST SQL pattern for PostgreSQL & Oracle
     */
    'nulls_last_sql' => '%s %s NULLS LAST',
];
```

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

### initComplete Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-callbacks.md

Complete initComplete callback that logs initialization and includes a placeholder for custom code.

```php
$html = $builder->initComplete('function(settings, json) {
    console.log("DataTables initialized");
    // Custom initialization code
}');
```

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

### Install HTML Builder with Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-installation.md

Install the yajra/laravel-datatables-html package version ^13.0 using Composer.

```bash
composer require yajra/laravel-datatables-html:"^13.0"
```

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

### Static exportFormat() examples

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-column.md

Shows how to apply static Excel formats to columns using exportFormat(). Each example sets a different format: currency, date, percentage, text, and phone number.

```php
// Format as currency
Column::make('price')
    ->exportFormat('#,##0.00')

// Format as date
Column::make('created_at')
    ->exportFormat('yyyy-mm-dd')

// Format as percentage
Column::make('discount')
    ->exportFormat('0.00%')

// Format as text (preserve leading zeros)
Column::make('zip_code')
    ->exportFormat('@')

// Format as phone number
Column::make('phone')
    ->exportFormat('[<=9999999]###-####;(###) ###-####')
```

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

### Validation rules using model instance

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-model.md

Example editRules method using the model to get table name and key for unique validation.

```php
public function editRules(Model $model): array
{
    return [
        'email' => [
            'sometimes',
            'required',
            'email',
            Rule::unique($model->getTable())->ignore($model->getKey()),
        ],
    ];
}
```

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

### Install laravel-datatables-buttons via Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-installation.md

Run this command to install the latest version of the plugin (^13.0).

```bash
composer require yajra/laravel-datatables-buttons:"^13.0"
```

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

### Starts With search using ->startsWithSearch()

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/smart-search.md

Uses the ->startsWithSearch() method to match records that start with the given keyword, useful for autocomplete and suggestions.

```php
Route::get('user-data', function () {
    return DataTables::eloquent(User::query())
        ->startsWithSearch()
        ->toJson();
});
```

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

### Upgrade from v6.x to v7.x: Service Approach (Buttons Plugin)

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Buttons plugin for v7.x (historical reference).

```bash
composer require yajra/laravel-datatables-buttons:^1.0
php artisan vendor:publish --tag=datatables-buttons --force
```

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

### Run migrations and open tinker

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Run the database migrations and start an interactive tinker session to seed test data.

```bash
php artisan migrate
php artisan tinker
```

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

### Upgrade from v6.x to v7.x: Core Package

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the core package for v7.x (historical reference).

```bash
composer require yajra/laravel-datatables-oracle:^7.0
php artisan vendor:publish --tag=datatables --force
```

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

### Upgrade to v13.x: Buttons

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Buttons plugin for v13.x.

```bash
composer require yajra/laravel-datatables-buttons:"^13.0"
php artisan vendor:publish --tag=datatables-buttons --force
```

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

### Upgrade to v13.x: Export

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Export plugin for v13.x.

```bash
composer require yajra/laravel-datatables-export:"^13.0"
php artisan vendor:publish --tag=datatables-export --force
```

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

### Complete Example - UsersDataTable

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-advanced.md

A complete example of a DataTable class using various button configurations, including editor actions, nested buttons, and utility buttons.

```APIDOC
## Complete Example - UsersDataTable

### Description
A complete example of a DataTable class using various button configurations, including editor actions, nested buttons, and utility buttons.

### Usage Example
```php
<?php

namespace App\DataTables;

use App\Models\User;
use Yajra\DataTables\Html\Builder;
use Yajra\DataTables\Html\Button;
use Yajra\DataTables\Html\Column;
use Yajra\DataTables\Html\Editor;
use Yajra\DataTables\Html\Editor\Fields;
use Yajra\DataTables\Services\DataTable;

class UsersDataTable extends DataTable
{
    public function html(): Builder
    {
        return $this->builder()
                    ->setTableId('users-table')
                    ->columns($this->getColumns())
                    ->minifiedAjax()
                    ->orderBy(1)
                    ->selectStyleSingle()
                    ->editors([
                        Editor::make()
                              ->fields($this->getFields()),
                    ])
                    ->buttons([
                        // Create button with custom form
                        Button::make('create')
                            ->editor('editor')
                            ->text('<i class="fa fa-plus"></i> Add User')
                            ->formTitle('Create New User')
                            ->formMessage('Please fill in all required fields.')
                            ->className('btn btn-success'),

                        // Edit button with refresh
                        Button::make('edit')
                            ->editor('editor')
                            ->text('<i class="fa fa-edit"></i> Edit')
                            ->formTitle('Edit User')
                            ->refresh()
                            ->key('ctrl+e'),

                        // Remove button with confirmation
                        Button::make('remove')
                            ->editor('editor')
                            ->text('<i class="fa fa-trash"></i> Delete')
                            ->formTitle('Confirm Deletion')
                            ->formMessage('This action cannot be undone. Are you sure?')
                            ->formButtons([
                                [
                                    'text' => 'Delete',
                                    'className' => 'btn btn-danger',
                                ],
                                [
                                    'text' => 'Cancel',
                                    'className' => 'btn btn-secondary',
                                ],
                            ]),

                        // Export buttons group
                        Button::make('collection')
                            ->text('<i class="fa fa-download"></i> Export')
                            ->buttons([
                                Button::make('excel')->text('Excel'),
                                Button::make('csv')->text('CSV'),
                                Button::make('pdf')->text('PDF'),
                            ]),

                        // Utility buttons
                        Button::make('print'),
                        Button::make('reset'),
                        Button::make('reload'),
                    ]);
    }

    protected function getColumns(): array
    {
        return [
            Column::make('id'),
            Column::make('name'),
            Column::make('email'),
            Column::make('status'),
            Column::make('created_at'),
        ];
    }

    protected function getFields(): array
    {
        return [
            Fields\Text::make('name')->required(),
            Fields\Text::make('email')->required(),
            Fields\Select::make('status')
                ->options([
                    'active' => 'Active',
                    'inactive' => 'Inactive',
                ]),
        ];
    }
}
```
```

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

### Install package via Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/exports-installation.md

Run this command to install the yajra/laravel-datatables-export package version ^13.0.

```bash
composer require yajra/laravel-datatables-export:"^13.0"
```

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

### Upgrade to v13.x: Editor

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Editor plugin for v13.x.

```bash
composer require yajra/laravel-datatables-editor:"^13.0"
php artisan vendor:publish --tag=datatables-editor --force
```

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

### Install Editor assets via npm

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-tutorial.md

Installs the DataTables Editor packages for Bootstrap 5.

```bash
npm i datatables.net-editor datatables.net-editor-bs5
```

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

### Complete Example - UsersDataTableEditor

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-events.md

A complete example of a custom DataTables Editor class demonstrating all event methods and validation rules.

```APIDOC
## Complete Example - UsersDataTableEditor

### Description
A complete example of a custom DataTables Editor class with all event hooks and validation rules.

### Methods
- `creating(Model $model, array $data): array` - Modify data before creating a record
- `created(Model $model, array $data): Model` - Perform actions after creating a record
- `updating(Model $model, array $data): array` - Modify data before updating a record
- `updated(Model $model, array $data): Model` - Perform actions after updating a record
- `deleting(Model $model, array $data): void` - Perform actions before deleting a record
- `forceDeleting(Model $model, array $data): void` - Perform actions before force deleting a record
- `restore(Model $model, array $data): array` - Modify data before restoring a record
- `restored(Model $model, array $data): Model` - Perform actions after restoring a record
- `createRules(): array` - Validation rules for creating a record
- `editRules(Model $model): array` - Validation rules for editing a record
- `removeRules(Model $model): array` - Validation rules for removing a record

### Example
```php
<?php
// app/DataTables/UsersDataTableEditor.php

namespace App\DataTables;

use App\Models\User;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Validation\Rule;
use Yajra\DataTables\DataTablesEditor;

/** @extends DataTablesEditor<User> **/
class UsersDataTableEditor extends DataTablesEditor
{
    protected $model = User::class;

    public function creating(Model $model, array $data): array
    {
        $data['password'] = bcrypt($data['password']);
        $data['created_by'] = auth()->id();
        return $data;
    }

    public function created(Model $model, array $data): Model
    {
        Mail::to($model)->send(new WelcomeEmail($model));
        return $model;
    }

    public function updating(Model $model, array $data): array
    {
        $data['updated_by'] = auth()->id();
        return $data;
    }

    public function updated(Model $model, array $data): Model
    {
        Cache::forget("user_{$model->id}");
        return $model;
    }

    public function deleting(Model $model, array $data): void
    {
        // Delete related files before removing user
        Storage::delete($model->avatar_path);
    }

    public function forceDeleting(Model $model, array $data): void
    {
        // Additional cleanup for force delete
        $model->posts()->forceDelete();
    }

    public function restore(Model $model, array $data): array
    {
        // Prepare data before restoring
        $data['restored_by'] = auth()->id();
        return $data;
    }

    public function restored(Model $model, array $data): Model
    {
        // Actions after restoring
        Notification::send($model, new AccountRestored($model));
        return $model;
    }

    public function createRules(): array
    {
        return [
            'name' => 'required',
            'email' => 'required|email|unique:users',
            'password' => 'required|min:8',
        ];
    }

    public function editRules(Model $model): array
    {
        return [
            'email' => [
                'sometimes',
                'required',
                'email',
                Rule::unique('users')->ignore($model->getKey()),
            ],
        ];
    }

    public function removeRules(Model $model): array
    {
        return [
            'DT_RowId' => 'required|exists:' . $model->getTable() . ',id',
        ];
    }
}
```
```

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

### Install Fractal Plugin with Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/fractal-installation.md

Run this command to install the latest version of the Fractal plugin for Laravel DataTables.

```bash
composer require yajra/laravel-datatables-fractal:"^13.0"
```

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

### Installation assets for ColumnControl

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/column-control-extension.md

Include the required CSS and JavaScript files for the ColumnControl extension.

```html
<!-- CSS -->
<link rel="stylesheet" href="https://cdn.datatables.net/columncontrol/1.0.0/css/columnControl.dataTables.min.css">

<!-- JS -->
<script src="https://cdn.datatables.net/columncontrol/1.0.0/js/dataTables.columnControl.min.js"></script>
```

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

### Example export class with headings and mapping

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-laravel-excel.md

An example export class that implements `WithMapping` to customize the exported data. It defines `headings()` for column headers and `map()` to transform each row. This is used to customize the export format.

```php
<?php
// app/Exports/UsersExport.php

namespace App\Exports;

use Maatwebsite\Excel\Concerns\WithMapping;
use Yajra\DataTables\Exports\DataTablesCollectionExport;

class UsersExport extends DataTablesCollectionExport implements WithMapping
{
    public function headings(): array
    {
        return [
            'Name',
            'Email',
        ];
    }

    public function map($row): array
    {
        return [
            $row['name'],
            $row['email'],
        ];
    }
}

```

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

### Create a new Laravel project

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Use the Laravel installer to create a new project named 'datatables'.

```bash
laravel new datatables
```

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

### Upgrade to v13.x: HTML Builder

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the HTML Builder plugin for v13.x.

```bash
composer require yajra/laravel-datatables-html:"^13.0"
php artisan vendor:publish --tag=datatables-html --force
```

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

### Upgrade from v8.x to v9.x: HTML Plugin

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the HTML plugin for v8.x (historical reference).

```bash
composer require yajra/laravel-datatables-html:3.*
php artisan vendor:publish --tag=datatables-html --force
```

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

### List of installed assets

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Shows the assets installed by the npm command: Bootstrap 5, DataTables with Buttons and Select plugins, and Laravel DataTables custom scripts.

```text
- Bootstrap 5 and Bootstrap Icons
- DataTables with Buttons and Select plugins for Bootstrap 5
- Laravel DataTables custom scripts
```

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

### Upgrade from v8.x to v9.x: Core Package

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the core package for v8.x (historical reference).

```bash
composer require yajra/laravel-datatables-oracle:8.*
php artisan vendor:publish --tag=datatables --force
```

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

### Install All-in-One Package with Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/installation.md

Use this command to install the all-in-one package when you need most DataTables plugins (Buttons, HTML Builder). The package includes HTML Builder, Buttons, and other commonly used plugins.

```bash
composer require yajra/laravel-datatables:"^13.0"
```

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

### Upgrade to v13.x: Fractal

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Fractal plugin for v13.x.

```bash
composer require yajra/laravel-datatables-fractal:"^13.0"
php artisan vendor:publish --tag=datatables-fractal --force
```

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

### Upgrade from v6.x to v7.x: HTML Builder

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the HTML Builder plugin for v7.x (historical reference).

```bash
composer require yajra/laravel-datatables-html:^1.0
php artisan vendor:publish --tag=datatables-html --force
```

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

### Upgrade from v8.x to v9.x: Buttons Plugin

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Buttons plugin for v8.x (historical reference).

```bash
composer require yajra/laravel-datatables-buttons:3.*
php artisan vendor:publish --tag=datatables-buttons --force
```

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

### Complete Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/row-options.md

A complete DataTable class combining multiple row options including setRowData and setRowAttr.

```APIDOC
## Complete Example

### Description
A DataTable class that uses setRowId, setRowClass, setRowData, and setRowAttr to customize row attributes.

### Code
```php
use App\Models\User;
use Yajra\DataTables\Html\Builder as HtmlBuilder;
use Yajra\DataTables\Services\DataTable;

class UsersDataTable extends DataTable
{
    public function html(): HtmlBuilder
    {
        return $this->builder()
            ->setTableId('users-table')
            ->columns($this->getColumns())
            ->setRowId('id')
            ->setRowClass(function (User $row) {
                return $row->is_active ? 'table-success' : 'table-secondary';
            })
            ->setRowData([
                'user-id'   => 'id',
                'user-name' => 'name',
                'role'      => fn(User $row) => $row->role?->name ?? 'guest',
            ])
            ->setRowAttr([
                'color' => fn(User $row) => $row->preference_color,
            ]);
    }
}
```
```

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

### footerCallback Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-callbacks.md

Complete footerCallback that calculates a column total and writes it into the footer.

```php
$html = $builder->footerCallback('function(tfoot, data, start, end, display) {
    var api = this.api();
    var total = api.column(3).data().reduce(function(a, b) {
        return parseFloat(a) + parseFloat(b);
    }, 0);
    $(tfoot).find("td").eq(3).html("$" + total.toFixed(2));
}');
```

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

### Upgrade from v8.x to v9.x: Fractal

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/upgrade.md

Install the Fractal plugin for v8.x (historical reference).

```bash
composer require yajra/laravel-datatables-fractal:1.*
php artisan vendor:publish --tag=datatables-fractal --force
```

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

### drawCallbackWithLivewire Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-callbacks.md

Automatically rescan Livewire components after each draw. Optionally accepts a custom script string to run.

```php
$html = $builder->drawCallbackWithLivewire();
```

```php
$html = $builder->drawCallbackWithLivewire('console.log("Custom script");');
```

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

### Quick Start: DataTables::eloquent($model)->toJson()

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/engine-eloquent.md

Basic setup to return a DataTables JSON response from an Eloquent model query. Use the DataTables facade and the eloquent() method.

```php
use Yajra\DataTables\Facades\DataTables;
use App\Models\User;

Route::get('user-data', function() {
    $model = User::query();

    return DataTables::eloquent($model)->toJson();
});
```

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

### Set up queue and batch tables

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/exports-installation.md

These commands create the jobs table (if not exists), the job batches table required for export tracking, and run migrations.

```bash
# Create the jobs table (if not already exists)
php artisan queue:table

# Create the job batches table (required for export tracking)
php artisan queue:batches-table

# Run migrations
php artisan migrate
```

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

### Add export buttons to DataTable

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-installation.md

Quick start example showing how to add export buttons (excel, csv, pdf, print, reset, reload) to a DataTable using the HTML Builder.

```php
use Yajra\DataTables\Html\Builder as HtmlBuilder;
use Yajra\DataTables\Html\Button;

public function html(): HtmlBuilder
{
    return $this->builder()
                ->setTableId('users-table')
                ->columns($this->getColumns())
                ->minifiedAjax()
                ->orderBy(1)
                ->buttons([
                    Button::make('excel'),
                    Button::make('csv'),
                    Button::make('pdf'),
                    Button::make('print'),
                    Button::make('reset'),
                    Button::make('reload'),
                ]);
}
```

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

### Basic SearchPanes Configuration

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/search-panes-options.md

Configure SearchPanes with various options like hideCount, hideTotal, clear, controls, layout, order, orderable, panes, and dtOpts. This example shows a typical setup in a Laravel DataTables HTML builder method.

```php
<?php

use Yajra\DataTables\Html\Builder;
use Yajra\DataTables\Html\SearchPane;

public function html(): Builder
{
    return $this->builder()
        ->searchPanes(
            SearchPane::make()
                ->hideCount()        // Hides the count next to the options
                ->hideTotal()        // Hides the total available without filters
                ->clear(false)       // Hides the clear button
                ->controls(false)    // Disable controls for filter search
                ->layout('columns-2') // Search panes in one row
                ->order(['user_id', 'age'])  // Order of search panes
                ->orderable(false)   // Hide order icons
                ->panes([])          // Additional search panes
                ->dtOpts([           // DataTables options for panes
                    'paging' => true,
                    'pagingType' => 'numbers'
                ])
        );
}
```

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

### Install the DataTables Editor package via Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-installation.md

Run this command to install the yajra/laravel-datatables-editor package version ^13.0. Ensure you have the core yajra/laravel-datatables package installed first.

```bash
composer require yajra/laravel-datatables-editor:"^13.0"
```

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

### Complete DataTable Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-fields.md

A full DataTable class with editor fields, including various field types and options.

```php
<?php

namespace App\DataTables;

use App\Models\User;
use App\Enums\StatusEnum;
use Yajra\DataTables\Html\Builder;
use Yajra\DataTables\Html\Column;
use Yajra\DataTables\Html\Editor;
use Yajra\DataTables\Html\Editor\Fields;
use Yajra\DataTables\Html\Editor\Fields\BelongsTo;
use Yajra\DataTables\Services\DataTable;

class UsersDataTable extends DataTable
{
    public function html(): Builder
    {
        return $this->builder()
                    ->setTableId('users-table')
                    ->columns($this->getColumns())
                    ->minifiedAjax()
                    ->orderBy(1)
                    ->selectStyleSingle()
                    ->editors([
                        Editor::make()
                              ->fields($this->getFields()),
                    ])
                    ->buttons([
                        Button::make('create')->editor('editor'),
                        Button::make('edit')->editor('editor'),
                        Button::make('remove')->editor('editor'),
                    ]);
    }

    protected function getColumns(): array
    {
        return [
            Column::make('id'),
            Column::make('name'),
            Column::make('email'),
            Column::make('status'),
            Column::make('created_at'),
        ];
    }

    protected function getFields(): array
    {
        return [
            Fields\Text::make('name')
                ->label('Full Name')
                ->required(),

            Fields\Text::make('email')
                ->label('Email Address')
                ->required()
                ->fieldInfo('We will never share your email'),

            Fields\Select::make('status')
                ->options([
                    'active' => 'Active',
                    'inactive' => 'Inactive',
                    'pending' => 'Pending',
                ])
                ->default('active'),

            Fields\Select::make('role_id')
                ->label('Role')
                ->tableOptions('roles', 'name', 'id'),

            BelongsTo::make('department')
                ->label('Department'),

            Fields\Date::make('birth_date')
                ->label('Birth Date')
                ->format('YYYY-MM-DD'),

            Fields\DateTime::make('last_login')
                ->label('Last Login')
                ->displayFormat('MMM D, YYYY h:mm A')
                ->nullDefault(),

            Fields\Boolean::make('is_active')
                ->label('Active')
                ->default(true),

            Fields\TextArea::make('bio')
                ->label('Biography')
                ->rows(4),

            Fields\File::make('avatar')
                ->label('Profile Picture')
                ->uploadRules('image|max:2048'),
        ];
    }
}
```

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

### Publish configuration and views

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/exports-installation.md

Optional step to publish the package's configuration file and views for customization.

```bash
php artisan vendor:publish --tag=datatables-export --force
```

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

### Basic Usage with searchPane()

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/search-panes-api.md

Use the searchPane() API to add search pane options on the response. This example shows an Eloquent query with status options and their counts.

```php
use Yajra\DataTables\Facades\DataTables;
use App\Models\User;

Route::get('user-data', function() {
    return DataTables::eloquent(User::query())
        ->searchPane('status', [
            'Active' => User::where('status', 'active')->count(),
            'Inactive' => User::where('status', 'inactive')->count(),
        ])
        ->toJson();
});
```

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

### Using Layout::make()

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-layout.md

Shows how to use the Layout::make() factory method to build a layout object before applying it.

```php
use Yajra\DataTables\Html\Layout;

$layout = Layout::make();
$layout->topStart('pageLength');
$layout->topEnd('search');

$html = $builder->layout($layout);
```

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

### Configure package.json with postinstall script for Editor

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-tutorial.md

Adds a postinstall script to automatically install Editor assets from the Editor.zip file. Requires the Editor.zip file to be placed in the project root.

```json
{
    "scripts": {
        "dev": "vite",
        "build": "vite build",
        "postinstall": "node node_modules/datatables.net-editor/install.js ./Editor.zip"
    }
}
```

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

### Adding Livewire Components

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-layout.md

Demonstrates how to add a Livewire component to a specific layout position.

```php
use Yajra\DataTables\Html\Enums\LayoutPosition;

$html = $builder->layout(function (Layout $layout) {
    $layout->addLivewire(
        \App\Livewire\DataTableFilters::class,
        LayoutPosition::TopStart
    );
});
```

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

### drawCallback Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-callbacks.md

Complete drawCallback example that logs a message and adds a CSS class to the DataTables wrapper buttons.

```php
$html = $builder->drawCallback('function() {
    console.log("Table redrawn");
    $(".dataTables_wrapper .btn").addClass("btn-sm");
}');
```

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

### Complete DataTable Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-advanced.md

A full DataTable class with editor buttons, export group, utility buttons, columns, and editor fields.

```php
<?php

namespace App\DataTables;

use App\Models\User;
use Yajra\DataTables\Html\Builder;
use Yajra\DataTables\Html\Button;
use Yajra\DataTables\Html\Column;
use Yajra\DataTables\Html\Editor;
use Yajra\DataTables\Html\Editor\Fields;
use Yajra\DataTables\Services\DataTable;

class UsersDataTable extends DataTable
{
    public function html(): Builder
    {
        return $this->builder()
                    ->setTableId('users-table')
                    ->columns($this->getColumns())
                    ->minifiedAjax()
                    ->orderBy(1)
                    ->selectStyleSingle()
                    ->editors([
                        Editor::make()
                              ->fields($this->getFields()),
                    ])
                    ->buttons([
                        // Create button with custom form
                        Button::make('create')
                            ->editor('editor')
                            ->text('<i class="fa fa-plus"></i> Add User')
                            ->formTitle('Create New User')
                            ->formMessage('Please fill in all required fields.')
                            ->className('btn btn-success'),

                        // Edit button with refresh
                        Button::make('edit')
                            ->editor('editor')
                            ->text('<i class="fa fa-edit"></i> Edit')
                            ->formTitle('Edit User')
                            ->refresh()
                            ->key('ctrl+e'),

                        // Remove button with confirmation
                        Button::make('remove')
                            ->editor('editor')
                            ->text('<i class="fa fa-trash"></i> Delete')
                            ->formTitle('Confirm Deletion')
                            ->formMessage('This action cannot be undone. Are you sure?')
                            ->formButtons([
                                [
                                    'text' => 'Delete',
                                    'className' => 'btn btn-danger',
                                ],
                                [
                                    'text' => 'Cancel',
                                    'className' => 'btn btn-secondary',
                                ],
                            ]),

                        // Export buttons group
                        Button::make('collection')
                            ->text('<i class="fa fa-download"></i> Export')
                            ->buttons([
                                Button::make('excel')->text('Excel'),
                                Button::make('csv')->text('CSV'),
                                Button::make('pdf')->text('PDF'),
                            ]),

                        // Utility buttons
                        Button::make('print'),
                        Button::make('reset'),
                        Button::make('reload'),
                    ]);
    }

    protected function getColumns(): array
    {
        return [
            Column::make('id'),
            Column::make('name'),
            Column::make('email'),
            Column::make('status'),
            Column::make('created_at'),
        ];
    }

    protected function getFields(): array
    {
        return [
            Fields\Text::make('name')->required(),
            Fields\Text::make('email')->required(),
            Fields\Select::make('status')
                ->options([
                    'active' => 'Active',
                    'inactive' => 'Inactive',
                ]),
        ];
    }
}
```

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

### Basic Field Configuration

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-fields.md

Shows how to create a text field with a label and chain configuration methods like placeholder and required.

```php
use Yajra\DataTables\Html\Editor\Fields;

// Simple text field
Fields\Text::make('name')

// With label
Fields\Text::make('name', 'Full Name')

// With chained configuration
Fields\Text::make('name')
    ->label('Full Name')
    ->placeholder('Enter your name')
    ->required()
```

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

### exportFormat() Method Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/custom-columns.md

Sets the Excel number format for exports. This example uses '#,##0.00' for a number with 2 decimals.

```php
$this->exportFormat('#,##0.00');
```

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

### addClass() Method Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/custom-columns.md

Adds CSS class names to the column. This example adds the 'text-right' class for right-aligned text.

```php
$this->addClass('text-right');
```

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

### Create UsersController with Artisan

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Run this Artisan command to generate the UsersController file.

```bash
php artisan make:controller UsersController
```

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

### NULL error response example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/error-handler.md

Example JSON response when `DATATABLES_ERROR` is `null`, showing the actual exception message in the `error` field.

```json
{
    "draw": 24,
    "recordsTotal": 200,
    "recordsFiltered": 0,
    "data": [],
    "error": "Exception Message:\n\nSQLSTATE[42S22]: Column not found: 1054 Unknown column 'xxx' in 'order clause'"
}
```

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

### Custom message error response example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/error-handler.md

Example JSON response when a custom string is set, showing the custom message in the `error` field.

```json
{
    "draw": 24,
    "recordsTotal": 200,
    "recordsFiltered": 0,
    "data": [],
    "error": "any custom message"
}
```

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

### Quick Example: Extending DataTable with before and response callbacks

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/buttons-extended.md

Shows a complete route definition that uses a custom RolesDataTable class, applies a `before` callback to add a column, a `response` callback to append data, a `withHtml` callback to set columns, and passes additional data with `with`. The final `render` method outputs the view.

```php
<?php
// routes/web.php

use App\DataTables\RolesDataTable;
use Yajra\DataTables\DataTableAbstract;
use Illuminate\Support\Facades\Route;

Route::get('datatable', function(RolesDataTable $dataTable) {
    return $dataTable
        ->before(function (DataTableAbstract $dataTable) {
            return $dataTable->addColumn('test', 'added inside controller');
        })
        ->response(function (\Illuminate\Support\Collection $response) {
            $response['test'] = 'Append Data';

            return $response;
        })
        ->withHtml(function(\Yajra\DataTables\Html\Builder $builder) {
            $builder->columns(['id', 'name', 'etc...']);
        })
        ->with('key', 'value')
        ->with([
            'key2' => 'value2',
            'key3' => 'value3',
        ])
        ->render('path.to.view');
});
```

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

### Example with Multiple Relations

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/enable-eager-join-aliases.md

This example demonstrates using enableEagerJoinAliases() with nested and direct relationships, including HasOne, BelongsToMany, and nested eager loads.

```php
use Yajra\DataTables\Facades\DataTables;
use App\Models\User;

Route::get('user-data', function() {
    // Eager load all relationships
    $model = User::with([
        'posts.comments',      // Nested: posts -> comments
        'roles',               // Direct: roles
        'profile',             // HasOne: profile
        'teams.members',        // BelongsToMany: teams -> members
    ]);

    return DataTables::eloquent($model)
        ->enableEagerJoinAliases()
        ->toJson();
});
```

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

### Options Format Examples

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/search-panes-api.md

Shows the array and callable formats for search pane options. The array format uses key-value pairs of label => count, while the callable format returns options dynamically.

```php
// Array format
'status' => ['active' => 100, 'inactive' => 25]
```

```php
// Callable format
'status' => fn() => Status::pluck('name', 'id')->toArray()
```

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

### AJAX with Form Selector (GET)

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-ajax.md

Automatically includes form data in the AJAX request using a form selector. Uses GET method.

```php
$html = $builder->ajaxWithForm(route('users.data'), '#search-form');
```

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

### Adding Custom Views

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-layout.md

Shows how to render any view or component into a layout position.

```php
use Yajra\DataTables\Html\Enums\LayoutPosition;

$html = $builder->layout(function (Layout $layout) {
    $layout->addView(view('components.search-box'), LayoutPosition::TopEnd);
});
```

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

### Install Laravel DataTables Vite and Bootstrap assets

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Install the required npm packages for Laravel DataTables Vite, Bootstrap, Popper.js, and Bootstrap Icons.

```bash
npm i -D laravel-datatables-vite bootstrap @popperjs/core bootstrap-icons
```

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

### Install Core Package with Composer

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/installation.md

Use this command to install the core package when you need basic DataTables functionality. Requires PHP 8.3+ and Laravel 13.x.

```bash
composer require yajra/laravel-datatables-oracle:"^13.0"
```

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

### Using Built-in Features

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-layout.md

Illustrates how to use built-in features and how to remove a feature by passing null.

```php
$html = $builder->layout(function (Layout $layout) {
    // Use built-in features
    $layout->topStart('pageLength');
    $layout->topEnd(['search' => ['placeholder' => 'Search...']]);
    $layout->bottomStart('info');
    $layout->bottomEnd('paging');
    
    // Remove a feature
    $layout->topStart(null);
});
```

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

### Create SQLite database file

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/quick-starter.md

Create an empty SQLite database file in the database directory.

```bash
touch database/database.sqlite
```

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

### renderJs() Method Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/custom-columns.md

Sets a JavaScript rendering function for the DataTables display. This example uses DataTables' number() helper to format numbers with thousand separators and decimal places.

```php
$this->renderJs('number(",", ".", 2, "", "")');
```

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

### Basic Editor example with generated PHP class

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/editor-command.md

Runs the command with 'Posts' as the name and shows the generated PHP class. The class extends DataTablesEditor, sets the model to User::class, and includes validation rules for create, edit, and remove operations.

```bash
php artisan datatables:editor Posts
```

```php
<?php
// app/DataTables/PostsDataTableEditor.php

namespace App\DataTables;

use App\Models\User;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Validation\Rule;
use Yajra\DataTables\DataTablesEditor;

/** @extends DataTablesEditor<User> **/
class PostsDataTableEditor extends DataTablesEditor
{
    protected $model = User::class;

    public function createRules(): array
    {
        return [
            'email' => 'required|email',
            'name'  => 'required',
        ];
    }

    public function editRules(Model $model): array
    {
        return [
            'email' => 'sometimes|required|email|' . Rule::unique($model->getTable())->ignore($model->getKey()),
            'name'  => 'sometimes|required',
        ];
    }

    public function removeRules(Model $model): array
    {
        return [
            'DT_RowId' => 'required|exists:' . $model->getTable() . ',id',
        ];
    }
}
```

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

### Ordering Methods

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-parameters.md

Shows how to configure column ordering using fluent methods.

```APIDOC
## Ordering Methods

### Description
Configure column ordering for the DataTable using fluent methods.

### Method
Fluent method calls

### Parameters
- **orderBy** (int, string) - Single column order: column index and direction
- **orders** (array) - Multiple column orders: array of [column, direction] pairs
- **orderByFixed** (int, string) - Fixed order always applied: column index and direction

### Request Example
```php
$html = $builder
    ->orderBy(0, 'desc')
    ->orders([[0, 'desc'], [1, 'asc']])
    ->orderByFixed(0, 'asc');
```

### Response
No response body; returns the builder instance for chaining.
```

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

### Array Configuration

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-layout.md

Demonstrates passing an array directly to the layout method for configuration.

```php
$html = $builder->layout([
    'topStart' => 'pageLength',
    'topEnd' => 'search',
    'bottomStart' => 'info',
    'bottomEnd' => 'paging',
]);
```

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

### Basic Usage

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-parameters.md

Shows how to use fluent methods to configure basic DataTables options.

```APIDOC
## Basic Usage

### Description
Configure basic DataTables options using fluent methods on the HTML Builder.

### Method
Fluent method calls

### Parameters
- **paging** (bool) - Enable/disable pagination
- **searching** (bool) - Enable/disable search
- **info** (bool) - Show table information
- **searchDelay** (int) - Search delay in milliseconds

### Request Example
```php
$html = $builder
    ->paging(true)
    ->searching(true)
    ->info(false)
    ->searchDelay(350);
```

### Response
No response body; returns the builder instance for chaining.
```

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

### headerCallback Example

Source: https://github.com/yajra/laravel-datatables-docs/blob/master/html-builder-callbacks.md

Complete headerCallback that makes header cells bold.

```php
$html = $builder->headerCallback('function(thead, data, start, end, display) {
    $(thead).find("th").css("font-weight", "bold");
}');
```
Tokens:
Raw