Livewire PowerGrid

https://github.com/power-components/livewire-powergrid
Admin
Livewire PowerGrid is a modern and powerful library that allows developers to easily create dynamic,...
Tokens:249,224
Snippets:1,365
Trust Score:6.2
License:MIT
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Install power-components/partials

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

Install the required PowerGrid 7.x package.

```bash
composer require power-components/partials
```

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

### Usage Example

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/01-powergrid-component.md

Example of a PowerGridComponent subclass.

```APIDOC
## Usage Example

### Description
Example of a custom PowerGridComponent class.

### Code
```php
use PowerComponents\LivewirePowerGrid\Column;
use PowerComponents\LivewirePowerGrid\PowerGridComponent;
use PowerComponents\LivewirePowerGrid\PowerGridFields;

final class UsersTable extends PowerGridComponent
{
    public string $tableName = 'users-table';
    public string $primaryKey = 'id';

    public function datasource(): \Illuminate\Database\Eloquent\Builder
    {
        return \App\Models\User::query();
    }

    public function fields(): PowerGridFields
    {
        return PowerGridFields::make()
            ->add('id')
            ->add('name')
            ->add('email');
    }

    public function columns(): array
    {
        return [
            Column::make('Name', 'name')->searchable()->sortable(),
            Column::make('E-mail', 'email')->searchable(),
            Column::action('Action'),
        ];
    }
}
```

```

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

### Clone repository and install dependencies

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/CONTRIBUTING.md

Clone the PowerGrid repository and install all dependencies with Composer and NPM.

```shell
git clone https://github.com/Power-Components/livewire-powergrid.git && cd livewire-powergrid
```

```shell
composer install
```

```shell
npm install
```

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

### Responsive Setup

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/09-setup.md

Configuration methods for responsive behavior in the PowerGrid component.

```APIDOC
## Responsive Setup

### Description
Provides methods to configure responsive behavior, including fixed columns and column sort order.

### Constants
- `ACTIONS_COLUMN_NAME` = `'actions'`
- `CHECKBOX_COLUMN_NAME` = `'checkbox'`

### Methods

#### `fixedColumns(string ...$columnNames)`
- **Signature:** `public function fixedColumns(string ...$columnNames): static`
- **Parameters:**
  - `$columnNames` (string...) - Required - Column names that should stay visible.
- **Returns:** `static` instance for chaining.

#### `sortOrder(string|array ...$columnNames)`
- **Signature:** `public function sortOrder(string|array ...$columnNames): static`
- **Parameters:**
  - `$columnNames` (string|array...) - Required - Column names or associative array mapping column to order (e.g., `['a','b']` or `['a' => 1, 'b' => 2]`).
- **Returns:** `static` instance for chaining.

#### `isColumnFixed(mixed $column, array $fixedColumns)`
- **Signature:** `public static function isColumnFixed(mixed $column, array $fixedColumns): bool`
- **Parameters:**
  - `$column` (mixed) - Required - Column object.
  - `$fixedColumns` (array) - Required - List of fixed column names.
- **Returns:** `bool` - Whether the column is fixed (matches `field`, `dataField`, actions sentinel, or `fixedOnResponsive()`).

#### `columnSortOrder(mixed $column, array $sortOrder)`
- **Signature:** `public static function columnSortOrder(mixed $column, array $sortOrder): ?int`
- **Parameters:**
  - `$column` (mixed) - Required - Column object.
  - `$sortOrder` (array) - Required - Associative array of column names to order.
- **Returns:** `?int` - The computed order, or `null` if not found.

### Properties
- `fixedColumns` (list<string>) - Default `['id', 'checkbox', 'actions']`
- `sortOrder` (array<string, int>) - Default `[]`

```

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

### Configure PowerGrid setup with header, footer, responsive, cache, exportable, and filterBuilder

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/09-setup.md

Configure PowerGrid setup options in the setUp method: header search, toggle columns, soft deletes, footer per-page and record count, responsive fixed columns, cache with custom tag and TTL, exportable with XLS/CSV types and queue, and filter builder with match and max conditions.

```php
use PowerComponents\LivewirePowerGrid\Facades\PowerGrid;
use PowerComponents\LivewirePowerGrid\Components\SetUp\Exportable;

public function setUp(): array
{
    return [
        PowerGrid::header()
            ->showSearchInput()
            ->showToggleColumns()
            ->showSoftDeletes(),

        PowerGrid::footer()
            ->showPerPage(25, [10, 25, 50, 100])
            ->showRecordCount('full'),

        PowerGrid::responsive()->fixedColumns('sku', 'checkbox', 'actions'),

        PowerGrid::cache()->customTag('products')->ttl(600),

        PowerGrid::exportable('products')
            ->type(Exportable::TYPE_XLS, Exportable::TYPE_CSV)
            ->queues(4)
            ->onQueue('exports'),

        PowerGrid::filterBuilder()->match('and')->maxConditions(20),
    ];
}
```

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

### Install Laravel Boost for AI-assisted development

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/README.md

Install Laravel Boost and its Agent Skills for AI-assisted development. Run these commands to set up PowerGrid's skills and guidelines for your AI agents.

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

```

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

### Example: GridDefinition and Controller

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/14-response-api.md

Example of defining a GridDefinition class and using it in a controller to return a JSON response, as well as a Livewire component variant.

```APIDOC
## Example: GridDefinition and Controller

### Description
Example of defining a GridDefinition class and using it in a controller to return a JSON response, as well as a Livewire component variant.

### Code Example
```php
use PowerComponents\Turbine\GridDefinition;
use Illuminate\Http\Request;

final class UsersDefinition extends GridDefinition
{
    public string $tableName = 'users';
    public function datasource(): mixed { return \App\Models\User::query(); }
    public function columns(): array { /* Column[] */ }
    public function filters(): array { /* FilterBase[] */ }
}

// inside a controller:
public function grid(Request $request): \Illuminate\Http\JsonResponse
{
    return (new UsersDefinition())->toResponse($request); // JsonResponse envelope
}

// Livewire component variant:
public function data(): \Illuminate\Http\JsonResponse
{
    return $this->toDataResponse(); // PowerGridComponent::toDataResponse()
}
```

### Response Envelope Example
```json
{
  "data": [{ "id": 1, "name": "Ada" }],
  "meta": {
    "pagination": { "current_page": 1, "per_page": 15, "from": 1, "to": 1, "total": 1, "last_page": 1 },
    "sort": { "field": "id", "direction": "asc", "multiSort": false, "sortArray": null },
    "search": null,
    "filters": null,
    "filterBuilder": null,
    "setup": null
  },
  "columns": [{ "field": "name", "title": "Name", "sortable": true, "searchable": true, "hidden": false }],
  "filters": [{ "key": "input_text", "field": "name", "column": "name", "title": "Name" }],
  "actions": { "1": [{ "id": "edit", "label": "Edit", "icon": null, "tag": "button", "visible": true, "disabled": false, "attributes": [] }] }
}
```

```

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

### Detail Setup

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/09-setup.md

Configuration methods for detail rows in the PowerGrid component.

```APIDOC
## Detail Setup

### Description
Provides methods to configure the detail row view, including view template, parameters, expand/collapse behavior, and single-expand mode.

### Methods

#### `view(string $view)`
- **Signature:** `public function view(string $view): Detail`
- **Parameters:**
  - `$view` (string) - Required - The detail-row view name.
- **Returns:** `Detail` instance for chaining.

#### `options(array $options = [])`
- **Signature:** `public function options(array $options = []): Detail`
- **Parameters:**
  - `$options` (array) - Optional - View options (deprecated in v4; use `params()`).
- **Returns:** `Detail` instance for chaining.

#### `params(array $params = [])`
- **Signature:** `public function params(array $params = []): Detail`
- **Parameters:**
  - `$params` (array) - Optional - View parameters.
- **Returns:** `Detail` instance for chaining.

#### `showCollapseIcon(string $viewIcon = '')`
- **Signature:** `public function showCollapseIcon(string $viewIcon = ''): Detail`
- **Parameters:**
  - `$viewIcon` (string) - Optional - Icon for collapse/expand.
- **Returns:** `Detail` instance for chaining.

#### `singleExpand()`
- **Signature:** `public function singleExpand(): Detail`
- **Description:** Allows only one row to be expanded at a time.
- **Returns:** `Detail` instance for chaining.

#### `collapseOthers()`
- **Signature:** `public function collapseOthers(): Detail`
- **Description:** Deprecated alias of `singleExpand()`.
- **Returns:** `Detail` instance for chaining.

### Properties
- `view` (string) - Default `''`
- `options` (array) - Default `[]`
- `state` (array) - Default `[]`
- `showCollapseIcon` (bool) - Default `false`
- `viewIcon` (string) - Default `''`
- `singleExpand` (bool) - Default `false`

```

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

### Install PowerGrid with Composer

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/README.md

Install PowerGrid via Composer. Requires PHP 8.3+, Laravel 12+, Livewire 4.0+, and Tailwind CSS 4.x.

```bash
composer require power-components/livewire-powergrid

```

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

### Update Boost with --discover flag

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/README.md

Discover and install newly available package resources, including PowerGrid's, when Laravel Boost is already installed.

```bash
php artisan boost:update --discover

```

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

### Turbine::make() Usage

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Usage example for building a Turbine grid headlessly, showing the fluent API methods.

```APIDOC
## Turbine::make()

### Description
Creates a new Turbine instance for building a grid definition.

### Method
`make`

### Parameters
- None explicitly documented.

### Returns
A Turbine instance with fluent methods.

### Fluent Methods
- `datasource(callable $datasource)` - Sets the datasource as a lazy callback.
- `fields(Fields $fields)` - Sets the fields to display.
- `columns(array $columns)` - Sets the columns with searchable/sortable options.
- `filters(array $filters)` - Sets the filters.
- `tableName(string $tableName)` - Sets the table name.
- `perPage(int $perPage)` - Sets the number of items per page.
- `fromRequest($request)` - Sets the request for query parameters.
- `toResponse()` - Returns a JsonResponse with `{data, meta, columns}`.
```

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

### Opt in with PowerGrid::filterBuilder() in setUp()

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/src/Plugins/FilterBuilder/README.md

Add the Filter Builder plugin to your component by returning PowerGrid::filterBuilder() from the setUp() method. Requires the Flux theme; on other themes the plugin renders nothing.

```php
use PowerComponents\LivewirePowerGrid\Facades\PowerGrid;

public function setUp(): array
{
    return [
        PowerGrid::filterBuilder(),
    ];
}
```

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

### Configure Livewire PowerGrid with daisyui theme and OpenSpout v5 exports

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/configuration.md

Example configuration for Livewire PowerGrid. Sets the theme to 'daisyui', overrides table header layout, limits max_per_page to 200, enables flyout filter with left position and close behaviors, sets input text debounce to 800ms, uses session persistence, and configures OpenSpout v5 export classes for XLS and CSV.

```php
// config/livewire-powergrid.php
return [
    'theme' => 'daisyui',
    'theme_overrides' => [
        'table' => ['layout' => ['th' => 'font-bold px-4 py-3']],
    ],
    'max_per_page' => 200,
    'filter' => 'flyout',
    'filter_flyout' => ['position' => 'left', 'close_on_escape' => true, 'close_on_click_outside' => true],
    'filter_wire' => ['input_text' => ['value' => 'live.debounce.800ms']],
    'persist_driver' => 'session',
    'exportable' => [
        'default' => 'openspout_v5',
        'openspout_v5' => [
            'xlsx' => \PowerComponents\LivewirePowerGrid\Plugins\Export\OpenSpout\v5\ExportToXLS::class,
            'csv'  => \PowerComponents\LivewirePowerGrid\Plugins\Export\OpenSpout\v5\ExportToCsv::class,
        ],
    ],
];
```

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

### PowerGrid Lite example: Livewire component with sorting, search, and checkbox traits

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

A Livewire component using the WithSorting, WithSearch, and WithCheckbox traits from the Lite namespace. The render method queries users, applies search and sorting, and paginates results. This is part of the PowerGrid Lite example.

```php
use Livewire\Component;
use PowerComponents\LivewirePowerGrid\Lite\Traits\{WithSorting, WithSearch, WithCheckbox};

class UsersTable extends Component
{
    use WithSorting, WithSearch, WithCheckbox;

    public function render()
    {
        return view('livewire.users-table', [
            'users' => \App\Models\User::query()
                ->when($this->search, fn ($q) => $q->where('name', 'like', "%{$this->search}%"))
                ->orderBy($this->sortField ?: 'name', $this->sortDirection)
                ->paginate(15),
        ]);
    }
}
```

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

### Example: UsersDefinition and controller methods

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/14-response-api.md

Shows a `GridDefinition` subclass and two controller methods that return JSON responses. The `grid` method uses `toResponse` on the definition, while the Livewire variant uses `toDataResponse` on the component.

```php
use PowerComponents\Turbine\GridDefinition;
use Illuminate\Http\Request;

final class UsersDefinition extends GridDefinition
{
    public string $tableName = 'users';
    public function datasource(): mixed { return \App\Models\User::query(); }
    public function columns(): array { /* Column[] */ }
    public function filters(): array { /* FilterBase[] */ }
}

// inside a controller:
public function grid(Request $request): \Illuminate\Http\JsonResponse
{
    return (new UsersDefinition())->toResponse($request); // JsonResponse envelope
}

// Livewire component variant:
public function data(): \Illuminate\Http\JsonResponse
{
    return $this->toDataResponse(); // PowerGridComponent::toDataResponse()
}
```

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

### Turbine::header / footer / detail / cache / filterBuilder / responsive

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Fresh SetUp builders for grid components.

```APIDOC
## Turbine::header / footer / detail / cache / filterBuilder / responsive

### Description
Returns fresh SetUp builders for the respective grid component.

### Method
Static factories

### Signatures
- `public static function header(): Header`
- `public static function footer(): Footer`
- `public static function detail(): Detail`
- `public static function cache(): Cache`
- `public static function filterBuilder(): FilterBuilder`
- `public static function responsive(): Responsive`

### Returns
- `Header` / `Footer` / `Detail` / `Cache` / `FilterBuilder` / `Responsive` - Fresh builder instance.

### Example
```php
$header = Turbine::header();
```
```

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

### Cache Setup

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/09-setup.md

Configuration methods for cache settings in the PowerGrid component.

```APIDOC
## Cache Configuration

### Description
Provides methods to configure caching behavior for the PowerGrid component, including enabling/disabling, setting cache tags, prefixes, and TTL.

### Methods

#### `disabled()`
- **Signature:** `public function disabled(): Cache`
- **Description:** Disables records caching.
- **Returns:** `Cache` instance for chaining.

#### `customTag(string $tag)`
- **Signature:** `public function customTag(string $tag): Cache`
- **Parameters:**
  - `$tag` (string) - Required - The cache tag to use.
- **Returns:** `Cache` instance for chaining.

#### `prefix(string $prefix)`
- **Signature:** `public function prefix(string $prefix): Cache`
- **Parameters:**
  - `$prefix` (string) - Required - The cache key prefix.
- **Returns:** `Cache` instance for chaining.

#### `ttl(int $time)`
- **Signature:** `public function ttl(int $time): Cache`
- **Parameters:**
  - `$time` (int) - Required - TTL in seconds.
- **Returns:** `Cache` instance for chaining.

### Properties
- `enabled` (bool) - Default `true`
- `tag` (string) - Default `''`
- `ttl` (int) - Default `300`
- `prefix` (string) - Default `''`

```

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

### Server-Side Action Button Example

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

Example of customizing a server-side action button using setAttribute, slot, hide, or bladeComponent parameters. This replaces client-side JavaScript callbacks.

```php
Button::add('edit')
    ->slot('Edit')
    ->class('btn btn-primary')
    ->dispatch('edit', ['id' => 'id']);
```

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

### Example usage of PowerGridFields

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/04-fields.md

Shows how to define a fields() method returning a PowerGridFields instance with added fields, including a custom closure for a derived field.

```php
use PowerComponents\LivewirePowerGrid\PowerGridFields;

public function fields(): PowerGridFields
{
    return PowerGridFields::make()
        ->add('id')
        ->add('name')
        ->add('email')
        ->add('full_name', fn ($user) => $user->first_name.' '.$user->last_name);
}
```

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

### MetaResponse constructor

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/14-response-api.md

Defines the MetaResponse class with pagination, sort, search, filters, filterBuilder, and setup. jsonSerialize keys are pagination, sort, search, filters, filterBuilder, setup.

```php
public function __construct(
    public PaginationResponse $pagination,
    public SortResponse $sort,
    public ?string $search = null,
    public ?array $filters = null,          // raw filter bag snapshot
    public ?array $filterBuilder = null,
    public ?array $setup = null,            // setup components snapshot
) {}
```

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

### PowerGrid action rules example using Rule facade

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/07-rules.md

Shows how to define action rules in the actionRules method. Uses Rule::button, Rule::rows, Rule::checkbox, Rule::editOnClick, and Rule::toggleable with conditions and actions like hide, disable, and setAttribute.

```php
use PowerComponents\LivewirePowerGrid\Facades\Rule;

public function actionRules(object $row): array
{
    return [
        // Hide the 'edit' button for blocked users
        Rule::button('edit')
            ->when(fn ($row) => $row->status === 'blocked')
            ->hide(),

        // Row-level warning styling
        Rule::rows()
            ->when(fn ($row) => $row->balance < 0)
            ->setAttribute('class', 'bg-red-50'),

        // Checkbox rules
        Rule::checkbox()
            ->unless(fn ($row) => $row->active)
            ->disable()
            ->hide(),

        // Inline-edit rule (plugin macro)
        Rule::editOnClick('quantity')
            ->disable()
            ->when(fn ($row) => $row->locked === true),

        // Toggle rule (plugin macro)
        Rule::toggleable('enabled')->hide()->when(fn ($row) => $row->is_system),
    ];
}
```

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

### TurbineTable Usage

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Usage example for creating a Livewire table component extending TurbineTable.

```APIDOC
## TurbineTable

### Description
Base class for Livewire PowerGrid tables using Turbine.

### Properties
- `public string $tableName` - The table name.

### Methods
- `definition(): GridDefinition` - Returns the grid definition. Must be implemented by subclasses.
- `datasource()` - Throws `LogicException` when `definition()` returns null.
```

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

### PowerGrid Lite example: Blade view with table components

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

A Blade view that builds a search input and per-page selector bound to $search and $perPage, then renders a table using the x-pg-table, x-pg-columns, x-pg-column, x-pg-rows, x-pg-row, and x-pg-cell components. This is the companion view for the UsersTable component.

```blade
{{-- Search and per-page are built by you, bound to $search and $perPage --}}
<div class="flex items-center justify-between gap-3 mb-3">
    <input wire:model.live.debounce.700ms="search" type="text" placeholder="Search..." />
    <select wire:model.live="perPage">
        <option value="10">10</option>
        <option value="25">25</option>
        <option value="50">50</option>
    </select>
</div>

{{-- Table renders structure + pagination via the active theme --}}
<x-pg-table :paginate="$users" record-count="full">
    <x-pg-columns>
        <x-pg-column checkbox />
        <x-pg-column sortable field="name"
            :sorted="$this->isSorted('name')"
            :direction="$this->sortDirectionFor('name')"
            wire:click="sortBy('name')">
            Name
        </x-pg-column>
        <x-pg-column align="end">Email</x-pg-column>
    </x-pg-columns>

    <x-pg-rows>
        @foreach ($users as $user)
            <x-pg-row :checkbox-value="$user->id">
                <x-pg-cell>{{ $user->name }}</x-pg-cell>
                <x-pg-cell align="end">{{ $user->email }}</x-pg-cell>
            </x-pg-row>
        @endforeach
    </x-pg-rows>
</x-pg-table>
```

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

### Define filters with Filter facade

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/06-filters.md

Example of defining filters in the filters() method using Filter::inputText, select, multiSelect, number, boolean, and datepicker. Demonstrates data sources, placeholders, and params.

```php
use PowerComponents\LivewirePowerGrid\Facades\Filter;

public function filters(): array
{
    return [
        Filter::inputText('name'),
        Filter::select('status')
            ->dataSource(['active' => 'Active', 'blocked' => 'Blocked']),
        Filter::multiSelect('categories', 'category_id')
            ->dataSource(\App\Models\Category::pluck('name', 'id'))
            ->optionValue('id')
            ->optionLabel('name'),
        Filter::number('price')
            ->placeholder('Min', 'Max')
            ->thousands('.'),
        Filter::boolean('verified')->label('Verified', 'Pending'),
        Filter::datepicker('created_at', 'created_at')
            ->params(['dateFormat' => 'Y-m-d']),
    ];
}
```

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

### Grid JSON response envelope

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/endpoints.md

Example JSON response body returned by the grid's data endpoint. The `data` array contains whitelisted row fields, `meta` holds pagination, sort, search, filters, filterBuilder, and setup state, `columns` describes sortable/searchable columns, `filters` lists active filter descriptors, and `actions` maps row IDs to action descriptors. `filters` and `actions` are omitted when empty.

```json
{
  "data": [ { "…": "row fields (whitelisted)" } ],
  "meta": {
    "pagination": { "current_page": 1, "per_page": 15, "from": 1, "to": 10, "total": 42, "last_page": 5 },
    "sort": { "field": "name", "direction": "asc", "multiSort": false, "sortArray": null },
    "search": null,
    "filters": null,
    "filterBuilder": null,
    "setup": null
  },
  "columns": [ { "field": "name", "title": "Name", "sortable": true, "searchable": true, "hidden": false } ],
  "filters": [ { "key": "input_text", "field": "name", "column": "name", "title": "Name" } ],
  "actions": { "42": [ { "id": "edit", "label": "Edit", "icon": null, "tag": "button", "visible": true, "disabled": false, "attributes": [] } ] }
}
```

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

### Turbine::setUp

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Sets up grid components.

```APIDOC
## Turbine::setUp

### Description
Sets up grid components such as header, footer, etc.

### Method
Fluent configuration

### Signature
`public function setUp(array $setUp): self`

### Parameters
- `setUp` (array) - Required - An array of `Header[]/Footer[]/…[]` components.

### Returns
- `self` - The Turbine instance for chaining.

### Example
```php
$turbine->setUp([Turbine::header()->showSearchInput()]);
```
```

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

### PowerComponents\LivewirePowerGrid\Components\SetUp\Tab

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/types.md

Documentation for the Tab component, including constructor, properties, and methods.

```APIDOC
## PowerComponents\LivewirePowerGrid\Components\SetUp\Tab

### Description
Represents a tab in the SetUp component.

### Constructor
- **key** (string) - Required - The tab key.

### Properties
- **label** - Tab label.
- **icon** - Tab icon.
- **scope** (?array) - Optional scope.
- **badge** (bool|int) - Default `true` - Badge value or boolean.
- **classes** - CSS classes.

### Methods
- **label()** - Sets the label.
- **icon()** - Sets the icon.
- **scope()** - Sets the scope.
- **badge()** - Sets the badge.
- **classes()** - Sets the classes.

See the SetUp API reference for full details.
```

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

### Publish Livewire PowerGrid config, views, and lang files

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/configuration.md

Publish the package's configuration, views, and language files. Each command targets a specific tag and outputs to the corresponding path.

```bash
php artisan vendor:publish --tag=livewire-powergrid-config   # config/livewire-powergrid.php
php artisan vendor:publish --tag=livewire-powergrid-views    # resources/views/vendor/livewire-powergrid
php artisan vendor:publish --tag=livewire-powergrid-lang     # lang/vendor/livewire-powergrid
```

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

### PowerGrid::responsive()

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/05-powergrid-manager.md

Returns a fresh, container-resolved Responsive builder instance.

```APIDOC
## PowerGrid::responsive()

### Description
Returns a fresh, container-resolved Responsive builder instance.

### Method
responsive

### Signature
public function responsive(): Responsive

### Returns
Turbine\Components\SetUp\Responsive

### Example
```php
PowerGrid::responsive()->fixedColumns('sku', 'actions');
```
```

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

### Select theme by name or FQCN in config

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/resources/boost/skills/powergrid-theme/REFERENCE.md

The 'theme' config accepts a registered name or a fully qualified class name. Default names are tailwind, daisyui, and flux.

```php
'theme' => 'daisyui',                                   // registered name
// 'theme' => \PowerComponents\LivewirePowerGrid\Themes\Flux::class, // FQCN
```

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

### Run the test suite with composer test and pest filter

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/resources/boost/skills/upgrade-theme-v6-to-v7/SKILL.md

Use composer test to run the full suite (which invokes ./vendor/bin/pest --compact) or ./vendor/bin/pest --filter=Theme to run only theme-related tests.

```bash
composer test               # runs ./vendor/bin/pest --compact (see composer.json scripts)
./vendor/bin/pest --filter=Theme
```

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

### Per-component override

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/resources/boost/skills/powergrid-theme/SKILL.md

Use the 'powergrid-theme' skill to apply a partial theme override to MyTableComponent so that table.layout.tr gets an extra 'stripe' class.

```text
Use the 'powergrid-theme' skill to apply a partial theme override to
MyTableComponent so that table.layout.tr gets an extra 'stripe' class.
```

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

### Headless usage with Turbine::make()

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Shows how to use Turbine headlessly to build a response with datasource, fields, columns, filters, table name, per page, and request handling.

```php
use PowerComponents\Turbine\Turbine;
use PowerComponents\Turbine\Column;
use PowerComponents\Turbine\Fields;
use PowerComponents\Turbine\Components\Filters\FilterInputText;

return Turbine::make()
    ->datasource(fn () => \App\Models\User::query())
    ->fields((new Fields())->add('id')->add('name')->add('email'))
    ->columns([
        Column::make('Name', 'name')->searchable()->sortable(),
        Column::make('Email', 'email')->searchable(),
    ])
    ->filters([new FilterInputText('name')])
    ->tableName('users')
    ->perPage(15)
    ->fromRequest($request)
    ->toResponse();  // JsonResponse with {data, meta, columns}
```

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

### PowerGrid artisan commands

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/12-commands.md

Shows usage of the powergrid:create, powergrid:publish, and powergrid:generate-theme-meta artisan commands with options and expected outputs.

```bash
php artisan powergrid:create                              # interactive scaffold
php artisan powergrid:create --template=stubs/table.custom.stub
php artisan powergrid:publish                             # app/Jobs/ExportJob.php
php artisan powergrid:publish --type=stubs --force
php artisan powergrid:generate-theme-meta                 # .phpstorm.meta.php
```

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

### Example: JSON response envelope

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/14-response-api.md

Shows the JSON structure returned by the PowerGrid response, including data, meta, columns, filters, and actions.

```json
{
  "data": [{ "id": 1, "name": "Ada" }],
  "meta": {
    "pagination": { "current_page": 1, "per_page": 15, "from": 1, "to": 1, "total": 1, "last_page": 1 },
    "sort": { "field": "id", "direction": "asc", "multiSort": false, "sortArray": null },
    "search": null,
    "filters": null,
    "filterBuilder": null,
    "setup": null
  },
  "columns": [{ "field": "name", "title": "Name", "sortable": true, "searchable": true, "hidden": false }],
  "filters": [{ "key": "input_text", "field": "name", "column": "name", "title": "Name" }],
  "actions": { "1": [{ "id": "edit", "label": "Edit", "icon": null, "tag": "button", "visible": true, "disabled": false, "attributes": [] }] }
}
```

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

### ArrayGridContext

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

The headless Context returned by Turbine::context(). It implements the full Context contract and provides methods to get filtered keys and summary values.

```APIDOC
## ArrayGridContext

### Description
The headless `Context` returned by `Turbine::context()`. It implements the full `Context` contract plus `getFilteredKeys()` and `getSummaryValues()`.

### Constructor
`(State $state, Closure $datasourceResolver, Fields $fields, array|Closure $columns = [], array $filters = [], ?Closure $transformQueryResolver = null, array $relationSearch = [], array $searchMorphs = [], ?Closure $actionsResolver = null, ?Closure $actionRulesResolver = null)`

### Methods
- `getFilteredKeys(): array` - Returns the filtered keys.
- `getSummaryValues(): array` - Returns the summary values.

```

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

### theme_view() helper resolves theme view path

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

Returns a view path resolved from the theme configuration. Example: theme_view('header') returns 'livewire-powergrid::components.themes.tailwind.header'.

```php
// Resolves view path from theme configuration
theme_view('header') // Returns: 'livewire-powergrid::components.themes.tailwind.header'
```

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

### Configure header buttons with HeaderElement in setUp()

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

Configure header buttons from the component's setUp() method using HeaderElement callbacks. Each element resolves its icon and title from user configuration, falling back to theme tokens and package defaults. Icons resolve like Button::icon(): 'funnel' renders <x-funnel />, 'icons.funnel' renders <x-icons.funnel />, and 'livewire-powergrid::icons.filter' renders a packaged icon. The title is always emitted as title/aria-label and becomes visible text only when showLabel() is set.

```php
use PowerComponents\Turbine\Components\SetUp\HeaderElement;

public function setUp(): array
{
    return [
        PowerGrid::header()
            ->showToggleColumns(fn (HeaderElement $element) => $element->icon('columns')->title('Columns'))
            ->showSoftDeletes(config: fn (HeaderElement $element) => $element->icon('icons.trash', ['class' => 'size-5']))
            ->showSearchInput(fn (HeaderElement $element) => $element->title('Search documents...'))
            ->filtersToggle(fn (HeaderElement $element) => $element->icon('funnel')->showLabel())
            ->clearFiltersPill(fn (HeaderElement $element) => $element->hideLabel())
            ->searchClearIcon(fn (HeaderElement $element) => $element->icon('x-mark')),

        PowerGrid::filterBuilder()->title('Filter')->icon('funnel'),

        PowerGrid::exportable('report')->title('Export')->icon('icons.download'),
    ];
}
```

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

### Define filters() for the builder

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/src/Plugins/FilterBuilder/README.md

The columns, types, and operators shown in the modal come entirely from your filters() definitions. This example shows inputText, number, datepicker, and boolean filters.

```php
public function filters(): array
{
    return [
        Filter::inputText('name'),
        Filter::number('price'),
        Filter::datepicker('created_at'),
        Filter::boolean('active'),
    ];
}
```

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

### Enable persistence with regular filters

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/src/Plugins/FilterBuilder/README.md

Use this in your component's setUp method to persist filters along with the Filter Builder. The builder is included automatically when filters are persisted.

```php
public function setUp(): array
{
    $this->persist(['filters']);

    return [PowerGrid::filterBuilder()];
}
```

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

### Run theme tests with composer

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/resources/boost/skills/powergrid-theme/SKILL.md

Commands to run the theme-related test suite and then the full test suite. Use after making theme changes to verify correctness.

```bash
composer test -- --filter="ThemeTest|ThemeBuilderTest|PowerGridComponentThemeTest"
composer test
```

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

### JSON data endpoint

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/endpoints.md

The JSON data endpoint returns the grid envelope for the PowerGrid component. It accepts GET or POST requests and reads state from input parameters.

```APIDOC
## [GET/POST] JSON data endpoint

### Description
Returns the grid envelope (data, meta, columns, filters, actions) for the PowerGrid component. Any host-app controller route can delegate to `GridDefinition::envelope(Request)` / `GridDefinition::toResponse(Request)` / `PowerGridComponent::toDataResponse()`.

### Method
GET or POST

### Endpoint
Any host-app route (no package-registered routes)

### Parameters
#### Query Parameters
- **search** (string) - Optional - Global search term.
- **sortField** (string) - Optional - Current sort field.
- **sortDirection** (string) - Optional - `asc`/`desc` (sanitized).
- **filters** (object) - Optional - Filter bag: `{ <bagKey>: {type, value, op?} }`.
- **sortArray** (object) - Optional - Multi-sort `{field: direction}`.
- **filterBuilder** (object) - Optional - `{match: 'and'|'or', rows: [{column, operator, value, value2, boolean}]}`.
- **turbine** (object) - Optional - Nested payload; merges over the flat keys.
- **powergrid** (object) - Optional - Nested payload; merges over the flat keys.

### Response
#### Success Response (200)
- **data** (array) - Row fields (whitelisted).
- **meta** (object) - Pagination, sort, search, filters, filterBuilder, setup.
- **columns** (array) - Column definitions.
- **filters** (array) - Filter descriptors (omitted when empty).
- **actions** (object) - Action descriptors keyed by row ID (omitted when empty).

#### Response Example
```json
{
  "data": [ { "...": "row fields (whitelisted)" } ],
  "meta": {
    "pagination": { "current_page": 1, "per_page": 15, "from": 1, "to": 10, "total": 42, "last_page": 5 },
    "sort": { "field": "name", "direction": "asc", "multiSort": false, "sortArray": null },
    "search": null,
    "filters": null,
    "filterBuilder": null,
    "setup": null
  },
  "columns": [ { "field": "name", "title": "Name", "sortable": true, "searchable": true, "hidden": false } ],
  "filters": [ { "key": "input_text", "field": "name", "column": "name", "title": "Name" } ],
  "actions": { "42": [ { "id": "edit", "label": "Edit", "icon": null, "tag": "button", "visible": true, "disabled": false, "attributes": [] } ] }
}
```
```

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

### Response::make

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/14-response-api.md

Static factory method to create a new Response instance from a Context.

```APIDOC
## [POST] /response/make

### Description
Creates a new Response instance using the provided Context.

### Method
POST

### Endpoint
/response/make

### Parameters
#### Request Body
- **context** (Context) - Required - The context object used to build the response.

### Request Example
{
  "context": {}
}

### Response
#### Success Response (200)
- **response** (Response) - A new Response instance.

#### Response Example
{
  "response": {}
}
```

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

### Configure filterBuilder with chainable methods

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/src/Plugins/FilterBuilder/README.md

All methods are chainable on PowerGrid::filterBuilder(). This example sets match to 'or', maxConditions to 10, restricts to only name, price, and created_at, and hides default filters.

```php
public function setUp(): array
{
    return [
        PowerGrid::filterBuilder()
            ->match('or')
            ->maxConditions(10)
            ->only(['name', 'price', 'created_at'])
            ->hideDefaultFilters(),
    ];
}
```

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

### Run code style fix and verification

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/CONTRIBUTING.md

Run the CS Fix and then run tests and static analysis to check your work.

```shell
composer pint:fix
```

```shell
composer verify
```

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

### Expose TomSelect or SlimSelect globally

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

Expose TomSelect or SlimSelect globally in your JavaScript bundle to enable multi-select filters. If the library is not exposed, the filter degrades gracefully and a console message explains what to install.

```javascript
// resources/js/app.js
import TomSelect from 'tom-select' // npm i tom-select
window.TomSelect = TomSelect

// or, for SlimSelect (npm i slim-select)
import SlimSelect from 'slim-select'
window.SlimSelect = SlimSelect
```

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

### Using the PowerGrid Facade to Access Builders

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/05-powergrid-manager.md

Shows how to use the PowerGrid facade to call various factory methods, such as fields(), header(), footer(), exportable(), tabs(), responsive(), cache(), and filterBuilder().

```php
use PowerComponents\LivewirePowerGrid\Facades\PowerGrid;

PowerGrid::fields();                          // PowerGridFields
PowerGrid::header();                          // Header builder
PowerGrid::footer()->showPerPage(25);
PowerGrid::exportable('orders');              // Exportable
PowerGrid::tabs()->add('all', label: 'All');
PowerGrid::responsive()->fixedColumns('sku', 'actions');
PowerGrid::cache()->ttl(60);
PowerGrid::filterBuilder()->persist();
```

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

### PowerGrid::detail()

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/05-powergrid-manager.md

Returns a fresh, container-resolved Detail builder instance.

```APIDOC
## PowerGrid::detail()

### Description
Returns a fresh, container-resolved Detail builder instance.

### Method
detail

### Signature
public function detail(): Detail

### Returns
Turbine\Components\SetUp\Detail

### Example
```php
PowerGrid::detail();
```
```

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

### GridSchema interface definition

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Defines the contract for a grid schema, requiring methods for datasource, fields, columns, filters, actions, action rules, relation search, search morphs, query transformation, and setup.

```php
interface GridSchema
{
    public function datasource(): mixed;
    public function fields(): Fields;
    /** @return array<int, mixed> */ public function columns(): array;
    /** @return array<int, FilterBase> */ public function filters(): array;
    /** @return array<int, mixed> */ public function actions(object $row): array;
    /** @return array<int, mixed> */ public function actionRules(object $row): array;
    /** @return array<string, list<string>|string> */ public function relationSearch(): array;
    /** @return array<string, string> */ public function searchMorphs(): array;
    public function transformQuery(mixed $query): mixed;
    /** @return array<int, object> */ public function setUp(): array;
}
```

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

### Migrate $theme array to app('powergrid.theme') in Blade

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

In v6, Blade views received a `$theme` array; in v7 this is removed. Use the PowerGrid theme manager singleton instead. The v7 example checks the active theme name via app('powergrid.theme')->name().

```blade
{{-- v6 --}}
@if($theme['name'] === 'tailwind')
    <div class="...">
@endif

{{-- v7 --}}
@if(app('powergrid.theme')->name() === 'tailwind')
    <div class="...">
@endif
```

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

### Register a new theme in livewire-powergrid.php

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/resources/boost/skills/powergrid-theme/SKILL.md

Shows two ways to set the default theme in the config file: by name (after registering via PowerGridManager::registerTheme) or by FQCN. Use this when creating a new default theme.

```php
'theme' => 'my-theme', // registered via PowerGridManager::registerTheme('my-theme', MyTheme::class)
// 'theme' => \PowerComponents\LivewirePowerGrid\Themes\MyTheme::class, // FQCN also works
```

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

### Column Summaries and Raw Search

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/02-column.md

Shows how to add summaries to a column using summarize() with sum and avg, and how to use searchableRaw() for custom SQL search conditions.

```php
Column::make('Price', 'price')
    ->summarize('sum', 'Total')
    ->summarize('avg', 'Average', header: true, footer: false),

Column::make('Notes', 'notes')
    ->searchableRaw('notes LIKE ? OR comments LIKE ?'),
```

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

### Register plugin in AppServiceProvider boot()

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/resources/boost/skills/create-powergrid-plugin/REFERENCE.md

Registers a custom PowerGrid plugin by passing its class to PowerGrid::plugins(). Built-in plugins are always registered and de-duplicated automatically, so only custom plugins need to be added here.

```php
use App\PowerGrid\Plugins\{PluginName}\{PluginName}Plugin;
use PowerComponents\LivewirePowerGrid\Facades\PowerGrid;

public function boot(): void
{
    // Built-in plugins (Editable, Export, FilterBuilder, Flatpickr, Toggleable)
    // are always registered automatically and de-duplicated by PowerGrid::plugins().
    // Only add your custom plugin here.
    PowerGrid::plugins([
        {PluginName}Plugin::class,
    ]);
}
```

```php
public function onUpdated{PluginName}(string|int $id, string $field, string $value): void
{
    // IMPORTANT: field must be in Model's $fillable
    MyModel::find($id)->update([$field => $value]);
}
```

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

### Configure livewire-powergrid assets

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/UPGRADE.md

Configuration for asset injection in v7. Set auto_inject to false when using Vite; minify only applies when auto_inject is true.

```php
// config/livewire-powergrid.php
'assets' => [
    'auto_inject' => false, // true = PHP inlines files the table uses (no Vite)
    'minify' => true,       // only applies to auto_inject
],
```

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

### Turbine::make

Source: https://github.com/power-components/livewire-powergrid/blob/7.x/_autodocs/api-reference/08-turbine-engine.md

Creates a new Turbine engine instance.

```APIDOC
## Turbine::make

### Description
Creates a new Turbine engine instance.

### Method
Static factory

### Signature
`public static function make(): self`

### Returns
- `self` - New engine instance.

### Example
```php
$turbine = Turbine::make();
```
```
Tokens:
Raw