Yet Another Table

This is yet another laravel livewire table and come as is. You can filter, you can sort, you can bulk, toggle columns, the basics. The data input is a collection/array, we cant handle models.

Consider using other packages like the ones that heavily inspired this one (rappasoft livewire tables/powergrid tables) for better performance and more and better features.

Requirements

Laravel 10/11
Livewire 3

Installation

composer require fantismic/yet-another-table

You may want to let the user save the table arrange of columns. If so, publish the migrations...

php artisan vendor:publish --provider="Fantismic\\YetAnotherTable\\YATProvider" --tag="migrations"

...and run them.

php artisan migrate

That's it. You are ready to go.

Optionals

You may want to publish the lang settings and change all the 6 keys. Up to you.

php artisan vendor:publish --provider="Fantismic\\YetAnotherTable\\YATProvider" --tag="lang"

Creating a table

The artisan way

To create a table you can run the following:

php artisan make:yatable MyBrandNewTable

Rendering the table

This is nothing more than a livewire component, so the rendering is just the same:

Fullpage layout

Add the layout attribute right before the class with your layout:

#[Layout('layouts.app')]
class MyBrandNewTable extends YATBaseTable

Included in blade view

<livewire:mybrandnewtable />

Livewire docs to render component

Base functions

settings(): void

Here you can set some settings to the table in general: title, column id, bulk, state handler, etc.

data(): collection

Here you return the data. As is, a collection of arrays or objects, you return it we display it. When you create a table an example of data is in the stub in order to see what is expected.

columns(): array

Here you return an array of column instances with the modifiers you want.

filters(): array

Here you return an array of filter instances.

options(): array

Here you return an array with function => label form.

This will generate an "Options" button in the view that will display a dropdown with the options you set and they will call the function established as key.

Passing data to the table

To pass data to the component, either from a route or from an attribute in the <livewire> tag, you only need to declare it as a public property in the table component.

<livewire:mytable color_type="primary">

class MyTable extends YATBaseTable
{
    public $color_type;
...

Using the mount() function

If you need to use the mount() function in the table component, be sure to call the parent mount() order to avoid errors.

public function mount() {
    parent::mount();

    mySoNeededMountFunction();
}

public function columns(): array {
    return [
        Column::make('Name','name')
            ->styling('text-lg font-bold')
            ->hideFromSelector(true),

        Column::make('Hex Code','hex'),

        Column::make('Color')
            ->customData(function($row, $value){
                return '<span style="color:'.$row['hex'].'">██████████████</span>';
            })
            ->toHtml(),

        LinkColumn::make('Google it','name')
            ->href(function($row, $value){
                return "https://www.google.com/search?q=".$value;
            })
            ->text('Google'),

        BoolColumn::make('Primary','isPrimary')
    ];
}

Column

The Column class provides several modifiers to customize your table:

Styling

styling(string $classes)

You can pass classes to add to all <td> in the column. The classes will be prefixed with ! in order to override other conflicting classes.

Column::make('Big text column','bigtext')
    ->styling('text-7xl')

Custom Data

customData(Closure $function)

To customize the data of the column you can pass any html in a closure function with $row and $value variable available.

Column::make('Upper Name','name')
    ->customData(function($row, $value){
        return strtoupper($value);
    })

Column::make('Full Name')
    ->customData(function($row, $value){
        return $row['firstname'] . " " . $row['lastname'];
    })

Tip: if you pass html, you need to add the ->toHtml() modifier

Column::make('Big Name','name')
    ->customData(function($row, $value){
        return '<div class="text-3xl">'.$value.'</div>';
    })->toHtml()

Hidding columns

hideWhen(bool $bool)

Hides the column from the view. When true the user cannot access this column at all.

Column::make('Only Admins','sensitive-row')
    ->hideWhen(Auth::user()->isAdmin)

Hidding columns from selector

hideFromSelector(bool $bool)

Hides the column from the toggle dropdown.

Column::make('Always visible','force-data')
    ->hideFromSelector(true)

Hide column by default

isVisible(bool $bool)

By default all columns are visible. IF you set this to true the table will render with this column hidden, but the user can display it any time with the column toggle switch.

Column::make('Not so important data','meh-column')
    ->isVisible(false)

Boolean columns

BoolColumn::make(string $label, string $field)

You can use this column to boolean values, they will render in table view as ✔️ and ❌.

You can set what is considered true for a strict comparison with the trueIs().

Also, you can customize the label/icons to appear in each case with trueLabel() and falseLabel()

BoolColumn::make('User status','isActive')
    ->trueIs('enabled')
    ->trueLabel('User Active')
    ->falseLabel('<i class="icon"></i>')

Link columns

LinkColumn::make(string $label, ?string $field)

Link column takes an destination and generates a link with the closure function.

LinkColumn::make('Edit user','id')
    ->text('Edit')
    ->href(function($row, $value){
        return '/edit/'.$value;
    })

Filters

[Filter]::make(string label, ?string $column)

In addition to the search input that filters globally on the table, you can add filters by column.

Note: if you pass only the label parameter, the filter will search for a column with same label and match, if you want to specify a column use the second parameter to assign the filter to the column label you want.

To enable filters, you need to create a "filters" function that returns an array of any of the Filter objects we provide.

public function filters(): array {
    return [
        FilterString::make('name'),
        FilterDateRange::make('Created At')
    ];
}

String filter

FilterString::make(string $label, ?string $column)

This filter will search in column with label $label and filter the table accordingly.

FilterString::make('name') # This will search in column with label 'name'

FilterString::make('Edad', 'age') # This will search in column with label 'age'

DateRange Filter

FilterDateRange::make(string $label, ?string $column)

This filter uses flatpickr to display a date range select and filter the table based on user input.

FilterDateRange::make('created_at') # This will search in column with label 'name'

Select Filter

FilterSelect::make(string $label, array $options)

This filter displays a select with the options given.

FilterSelect::make('type',["primary","secondary"])

Select Magic Filter

FilterSelectMagic::make(string $label, array $options)

Same as select filter, but with magic. This filter with get all values from the column given, make the unique and display them.

[
    ["id"=>1, "color"=>"red", "type"=>"Primary"],
    ["id"=>2, "color"=>"violet", "type"=>"Secondary"],
    ["id"=>2, "color"=>"green", "type"=>"Primary"],
]

FilterSelectMagic::make('type')
# Will display Primary and Secondary in the <select>

Bool filter

FilterBool::make(string $label, ?array $compared_with = null, ?string $index = null)

This filter displays a toggle to make boolean comparisons. By default it will compare true and false, but you can pass an array ["true" => "My True value", "false" => "My false value"] and it will compare to that.

FilterBool::make('isprimary')

Options

You can add an additional button next to the column toggle to display a list of custom options/actions. This options/actions will 'wire:click' the key given.

public function options(): array {
    return [
        'export' => 'Export selected rows',
        'remove' => 'Delete selected rows',
    ];
}

public function remove() {
    foreach ($this->getSelectedRows() as $id) {
        $this->removeRowFromTable($id);
    }
}

In this example, when user clicks on 'Delete selected rows' the function 'remove' will be called.

Make sure you implement this functions in your component in order to avoid errors.

Export

You have three methods in order to handle the data to export:

$this->getAllData() # Will return collection of all data

$this->getAfterFiltersData() # Will return collection of filtered data (global search and custom filters)

$this->getSelectedData() # Will return collection of data by selected rows

If you have Laravel Excel the stub comes with three functions added to the Options dropdown in order to export the data by this criterias that will work out of the box.

If you have other ways to expor the data or simply dont want to export at all feel free to delete the functions in the component.

Name		Name	Last commit message	Last commit date
Latest commit History 58 Commits
src		src
.gitignore		.gitignore
LICENSE.md		LICENSE.md
README.md		README.md
composer.json		composer.json

License

fantismic/yet-another-table

Folders and files

Latest commit

History

Repository files navigation

Yet Another Table

Requirements

Installation

Optionals

Creating a table

The artisan way

Rendering the table

Fullpage layout

Included in blade view

Base functions

settings(): void

data(): collection

columns(): array

filters(): array

options(): array

Passing data to the table

Using the mount() function

Contents

Settings

View

Set table title

Override title classes

Set a custom header

Set component classes

Add table classes

Set table classes

Set sticky header

Table spinner

Table spinner view

Modals View

Sorting

Set default sort column

Set default sort direction asc

Set default sort direction desc

Set search placeholder

Bulk

Enable bulk

Get selected rows

Remove row from table

Table state handler

Enable state handler

Pagination

Use pagination

Set default per page rows value

Set options for per page rows

Misc

Set column ID

Show column toggle button

Columns