README

Table components for Laravel with sorting, filtering, and pagination. Part of the Accelade ecosystem.

Installation

composer require accelade/tables

Documentation

Overview - Introduction and basic usage
Text Column - Display text data
Badge Column - Display badges with colors
Boolean Column - Display boolean values
Image Column - Display images
Icon Column - Display icons
Color Column - Display colors
Select Column - Editable select inputs
Toggle Column - Toggle switches
Text Input Column - Editable text inputs
Checkbox Column - Checkbox selections
Filters - Filtering data
Sorting - Sorting columns
Actions - Row and bulk actions
Pagination - Paginating results

Basic Usage

use Accelade\Tables\Table;
use Accelade\Tables\Columns\TextColumn;
use Accelade\Tables\Columns\BadgeColumn;
use Accelade\Tables\Columns\BooleanColumn;

$table = Table::make('users')
    ->query(User::class)
    ->columns([
        TextColumn::make('name')
            ->sortable()
            ->searchable(),
        TextColumn::make('email')
            ->sortable(),
        BadgeColumn::make('role')
            ->colors([
                'admin' => 'danger',
                'editor' => 'warning',
                'user' => 'success',
            ]),
        BooleanColumn::make('active')
            ->sortable(),
    ])
    ->striped()
    ->hoverable();

Building Assets

The package includes TypeScript source files that need to be compiled:

cd packages/tables
npm install
npm run build

Testing

composer test

License

MIT License. See LICENSE for details.

accelade / tables

Maintainers

Details