- Creating Columns
- Relationships
- Available Methods
- Other Column Types
- Column Selection
- Secondary Header
- Footer
Getting Started
Usage
DataTable
Columns
Rows
Sorting
Pagination
Search
Bulk Actions
Filters
Reordering
Secondary Header
Footer
Examples
Misc.
🎉 Enjoying this package? Consider sponsoring me on GitHub or buying me a beer.
This is the documentation for v2. You can switch versions in the menu on the left/at the top. Check your current version with the following command:
composer show rappasoft/laravel-livewire-tables
Other Column Types
Boolean Columns
Boolean columns are good if you have a column type that is a true/false, or 0/1 value.
For example:
BooleanColumn::make('Active')
Would yield:
Using your own view
If you don't want to use the default view and icons you can set your own:
BooleanColumn::make('Active')
->setView('my.active.view')
You will have access to $component
, $status
, and $successValue
.
To help you better understand, this is the Tailwind implementation of BooleanColumn:
@if ($status)
<svg xmlns="http://www.w3.org/2000/svg" class="inline-block h-5 w-5 @if ($successValue === true) text-green-500 @else text-red-500 @endif" fill="none" viewBox="0 0 24 24" stroke="currentColor">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z" />
</svg>
@else
<svg xmlns="http://www.w3.org/2000/svg" class="inline-block h-5 w-5 @if ($successValue === false) text-green-500 @else text-red-500 @endif" fill="none" viewBox="0 0 24 24" stroke="currentColor">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M10 14l2-2m0 0l2-2m-2 2l-2-2m2 2l2 2m7-2a9 9 0 11-18 0 9 9 0 0118 0z" />
</svg>
@endif
Setting the truthy value
If you want the false value to be the green option, you can set:
BooleanColumn::make('Active')
->setSuccessValue(false); // Makes false the 'successful' option
That would swap the colors of the icons in the image above.
Setting the status value
By default, the $status
is set to:
(bool)$value === true
You can override this functionality:
BooleanColumn::make('Active')
// Note: Parameter `$row` available as of v2.4
->setCallback(function(string $value, $row) {
// Figure out what makes $value true
}),
Different types of boolean display
By default, the BooleanColumn displays icons.
If you would like the BooleanColumn to display a plain Yes/No, you can set:
BooleanColumn::make('Active')
->yesNo()
Image Columns
Image columns provide a way to display images in your table without having to use format()
or partial views:
ImageColumn::make('Avatar')
->location(
fn($row) => storage_path('app/public/avatars/' . $row->id . '.jpg')
),
You may also pass an array of attributes to apply to the image tag:
ImageColumn::make('Avatar')
->location(
fn($row) => storage_path('app/public/avatars/' . $row->id . '.jpg')
)
->attributes(fn($row) => [
'class' => 'rounded-full',
'alt' => $row->name . ' Avatar',
]),
Link Columns
Link columns provide a way to display HTML links in your table without having to use format()
or partial views:
LinkColumn::make('Action')
->title(fn($row) => 'Edit')
->location(fn($row) => route('admin.users.edit', $row)),
You may also pass an array of attributes to apply to the a
tag:
LinkColumn::make('Action')
->title(fn($row) => 'Edit')
->location(fn($row) => route('admin.users.edit', $row))
->attributes(fn($row) => [
'class' => 'rounded-full',
'alt' => $row->name . ' Avatar',
]),
Button Group Columns
Button group columns let you provide an array of LinkColumns to display in a single cell.
ButtonGroupColumn::make('Actions')
->attributes(function($row) {
return [
'class' => 'space-x-2',
];
})
->buttons([
LinkColumn::make('View') // make() has no effect in this case but needs to be set anyway
->title(fn($row) => 'View ' . $row->name)
->location(fn($row) => route('user.show', $row))
->attributes(function($row) {
return [
'class' => 'underline text-blue-500 hover:no-underline',
];
}),
LinkColumn::make('Edit')
->title(fn($row) => 'Edit ' . $row->name)
->location(fn($row) => route('user.edit', $row))
->attributes(function($row) {
return [
'target' => '_blank',
'class' => 'underline text-blue-500 hover:no-underline',
];
}),
]),
Component Columns
Component columns let you specify a component name and attributes and provides the column value to the slot.
// Before
Column::make("Email", "email")
->format(function ($value) {
return view('components.alert')
->with('attributes', new ComponentAttributeBag([
'type' => Str::endsWith($value, 'example.org') ? 'success' : 'danger',
'dismissible' => true,
]))
->with('slot', $value);
}),
// After
ComponentColumn::make('E-mail', 'email')
->component('email')
->attributes(fn ($value, $row, Column $column) => [
'type' => Str::endsWith($value, 'example.org') ? 'success' : 'danger',
'dismissible' => true,
]),