README

This package is in development stage, please do not use it in production

install

composer require joe.szeto/tablelite

update your app.php file to include the service provider

\Tablelite\TablesliteServiceProvider::class

Usage

use Tablelite\Table as TableAlias;

class SomeComponent extends Component  {
    use \Tablelite\InteractsWithTablelite;
    
    public function table( TableAlias $table ){
        $table->schema([
            TextColumn::make('id'),
            TextColumn::make('name'),
        ])->records([
            [ 'id' => 1, 'name' => 'John'],
            [ 'id' => 2, 'name' => 'Doe'],
        ]);
    }
}

in view


<div>
    {{ $this->getTable() }}
</div>

KeyBy

if id not found in the records, you can use the keyBy method to specify the key

$table->keyBy('some_key');

Selecteable

if you want to make the table selectable, you can use the selectable method

$table->selectable();

disable the select all checkbox

$table->selectable(false);

if you only want to make some of the records not selectable, you can use the selectableRecord method in the records closure

$table->selectableRecord(fn($record) => $record->slug === 'foo');

Searchable

if you want to make the Column searchable, you can use the searchable method

$table->schema(fn(ColumnBuilder $builder) => [
    $builder->text('code')->searchable(),
]);

and then you can use the keyword in records closure

->records(
    fn($keyword) => // do something with this keyword
)

Sortable

if you want to make the Column sortable, you can use the sortable method

$table->schema(fn(ColumnBuilder $builder) => [
    $builder->text('code')->sortable(),
]);

and then you can use the sort in records closure

->records(
    fn($sort) => // do something with this keyword
)

it will return an array with the key column and direction eg. ['code' => 'asc' ]

Actions

 $table->schema([
    TextColumn::make('id'),
    TextColumn::make('name'),
])
    ->records([
        ['id' => 1, 'name' => 'John'],
        ['id' => 2, 'name' => 'Doe'],
    ])->actions(fn(ActionFactory $actionFactory) => [
        $actionFactory->make('some_action')
            ->label('Action Label')
            ->action(function ($record) {
                // do something here
             })
    ]);

Text style action button

$actionFactory->make('some_action')->text()

if you want to make the whole row clickable you can use the detail method in action factory

$actionFactory->detail('some_action')->url()

Disable action

$action->disabled()
// or
$action->disabled(function($record) : bool {} )

header actions

 ->headerActions(fn(ActionFactory $actionFactory) => [
    $actionFactory->make('assign')
        ->label('Assign Coupon')
        ->slideover('some-livewire-component', [
            // params for the livewire component...
        ])
])

Slide Over

use IsSlideOver in your livewire component when we want to do something when slide over open, we can use the onSlideOver method

$this->onSlideOver(
    'someMethod',
    loading: true,
    loadingPattern: 'cccb|accc'
)

pagination

$table->schema([
    TextColumn::make('id'),
    TextColumn::make('name'),
])
    ->records(
        function ($page) {
            // fetch api here
        }
    )
    ->paginateUsing(
        function ($records, PaginatorBuilder $builder) {
            // records is the response of the fetching
            return $builder
                ->items($records['data']) // the items
                ->total($records['total']) // total items
                ->perPage($records['per_page'])
                ->currentPage($records['current_page']);
        }
    );

Development in local

clone the repository to your local machine

add this to your composer.json file

"repositories": [
    {
        "type": "path",
        "url": "path/to/tablelite"
    }
]

make sure update the path to the correct path

run

composer require joe.szeto/tablelite

joe.szeto / tablelite

Maintainers

Details