README

Laravel Grid.js

The modern, dependency-free Datagrid for Laravel. A powerful Grid.js wrapper with Eloquent support, server-side pagination, and an elegant fluent API.

Table of Contents

• Why Grid.js?
• Installation
• Quick Start
• Visual Examples
• Server-side JSON Schema
• Fluent API Reference
• Configuration
• Development
• Changelog
• Contributing

Why Grid.js?

• No jQuery
• Tiny footprint (Grid.js UMD)
• Native Laravel integration (Eloquent + routes)
• Fluent, chainable API
• Server-side ready (search, sort, paginate)

Installation

composer require amjadiqbal/laravel-gridjs

Installation Wizard (Interactive)

• Run the installer to set defaults and optionally publish assets:

php artisan gridjs:install

• Prompts:

  • Route prefix (default: gridjs)
  • Use CDN or local assets
  • Publish local assets and path
  • Open contact page in browser

• Non-interactive usage:

php artisan gridjs:install \
  --prefix=datagrid \
  --cdn=false \
  --publish-assets=true \
  --assets-path=public/vendor/gridjs \
  --open-link=false \
  --contact-url=https://github.com/amjadiqbal/laravel-gridjs/issues

Publish Assets Locally

php artisan gridjs:publish-assets --path=public/vendor/gridjs

Quick Start

use AmjadIqbal\GridJS\Facades\Grid;
use App\Models\User;

echo Grid::fromQuery(User::query())
    ->columns(['id', 'name', 'email'])
    ->searchable()
    ->sortable()
    ->pagination(10)
    ->theme('mermaid')
    ->render();

Visual Examples

Minimal Users Table

use AmjadIqbal\GridJS\Facades\Grid;
use App\Models\User;

echo Grid::fromQuery(User::query())
    ->columns(['id', 'name', 'email'])
    ->pagination(15)
    ->render();

Skeleton Theme + Fixed Header + Resizable

echo Grid::fromQuery(User::query())
    ->columns(['id', 'name', 'email'])
    ->searchable()
    ->sortable()
    ->pagination(20)
    ->resizable()
    ->fixedHeader()
    ->theme('skeleton')
    ->render();

Custom ClassName Theme

echo Grid::fromQuery(User::query())
    ->columns(['id', 'name', 'email'])
    ->theme([
        'table' => 'w-full border border-slate-200 rounded-md',
        'thead' => 'bg-slate-50',
        'th'    => 'px-3 py-2 text-xs text-slate-600',
        'td'    => 'px-3 py-2 text-sm text-slate-800',
    ])
    ->render();

Column Formatters

echo Grid::fromQuery(User::query())
    ->columns([
        ['field' => 'id', 'name' => 'ID'],
        ['field' => 'email', 'name' => 'Email', 'formatter' => 'cell => cell.toUpperCase()'],
    ])
    ->render();

Built-in Format Options

// Date
echo Grid::fromQuery(User::query())
    ->columns([
        ['field' => 'created_at', 'name' => 'Joined', 'format' => ['type' => 'date', 'locale' => 'en-US']],
    ])
    ->render();

// Currency
echo Grid::fromQuery(User::query())
    ->columns([
        ['field' => 'balance', 'name' => 'Balance', 'format' => ['type' => 'currency', 'currency' => 'USD']],
    ])
    ->render();

// Link
echo Grid::fromQuery(User::query())
    ->columns([
        ['field' => 'email', 'name' => 'Email', 'format' => ['type' => 'link']],
    ])
    ->render();

Actions Column

echo Grid::fromQuery(User::query())
    ->columns([['field' => 'id', 'name' => 'ID'], 'name', 'email'])
    ->actions([
        ['label' => 'View', 'baseUrl' => '/users', 'class' => 'btn btn-sm'],
        ['label' => 'Edit', 'baseUrl' => '/users/edit', 'class' => 'btn btn-sm btn-warning'],
    ], idIndex: 0)
    ->render();

Asset Options

• Configurable CDN injection via config/gridjs.php:

return [
  'assets' => [
    'cdn' => true,
    'script' => 'https://unpkg.com/gridjs/dist/gridjs.umd.js',
    'themes' => [
      'mermaid' => 'https://unpkg.com/gridjs/dist/theme/mermaid.min.css',
      'skeleton' => 'https://unpkg.com/gridjs/dist/theme/skeleton.min.css',
    ],
  ],
];

Custom Route Prefix

// config/gridjs.php
return ['prefix' => 'datagrid'];

Server-side JSON Schema

• Endpoint: GET /{prefix}/data (default: /gridjs/data)
• Query params:
  • model: FQCN of the Eloquent model
  • columns: comma-separated list of fields
  • limit: page size (int)
  • page: page number (int)
  • search: search string (optional)
  • sort: column name (optional)
  • direction: asc or desc (optional)
• Response:

{
  "data": [
    ["1", "Alice", "alice@example.com"],
    ["2", "Bob", "bob@example.com"]
  ],
  "total": 42
}

Fluent API Reference

Configuration

• File: config/gridjs.php
• Options:
  • prefix: Route segment for the data endpoint (default: gridjs)

Development

• Testing:

vendor/bin/pest

• Installer:

  • The installer prints a general contact message:
    • “If you are facing any issue or need development help, contact me: https://github.com/amjadiqbal/laravel-gridjs/issues”
  • You can pass a custom contact URL with --contact-url
  • Opening the contact page is optional via --open-link or prompt

• Local Assets:

  • Banner stored in assets/banner.svg and included in README

Changelog

• See GitHub releases for a full changelog.

Contributing

• Fork and create a feature branch
• Add tests for your changes
• Open a PR with a clear description and rationale