Download the PHP package okipa/laravel-table without Composer

Package looking for co-maintainers

I've been quite busy professionally lately and I'm currently looking for one or more co-maintainers to help me to maintain and develop this package.

Current roadmap:

• PR reviewing
• Livewire 3 compatibility
• Tailwind 3 compatibility

Please contact me at arthur[dot]lorent[at]gmail.com to apply.

Save time and easily render tables in your views from Eloquent models.

Tables can be generated under the following UI frameworks:

• Bootstrap 5
• Bootstrap 4
• TailwindCSS 3 (upcoming feature)

Found this package helpful? Please consider supporting my work!

Compatibility

Upgrade guide

• From V4 to V5
• From V3 to V4
• From V2 to V3
• From V1 to V2

Usage

Create your table with the following command:

Configure your table in the UsersTable generated class, which can be found in the app\Tables directory:

And display it in a view:

Table of contents

• Installation
• Configuration
• Templates
• Translations
• How to
  • Create table configuration
  • Display tables in views
  • Pass external data to your tables
  • Generate tables from Eloquent models
  • Override native selects behaviour on your tables
  • Add query instructions on tables
  • Handle tables number of rows per page, pagination and navigation status
  • Set conditional row class
  • Setup table filters
  • Define table head action
  • Define table bulk actions
  • Define table row actions
  • Declare columns on tables
  • Format column values
  • Define column actions
  • Configure columns searching
  • Configure columns sorting
  • Allow columns to be reordered from drag and drop action
  • Declare results on tables
  • Set up a few lines of JavaScript
  • Trigger Livewire events on table load
  • Interact with your tables from events
• Testing
• Changelog
• Contributing
• Credits
• Licence

Installation

• Install the package with composer:

This package uses Livewire under the hood and its installation is required.

You'll have to follow the installation instructions if Livewire is not already installed on your project.

Configuration

Optionally publish the package configuration:

Templates

Optionally publish the package templates:

Translations

All words and sentences used in this package are translatable.

See how to translate them on the Laravel official documentation: https://laravel.com/docs/localization#using-translation-strings-as-keys.

Here is the list of the words and sentences available for translation:

Status

• Loading in progress...
• No results were found.
• You can rearrange the order of the items in this list using a drag and drop action.
• Reset filters
• Yes
• No
• Search by:
• Reset research
• Number of rows per page
• Sort ascending
• Sort descending
• Actions
• Bulk Actions
• Create
• Add
• Show
• Edit
• Destroy
• Activate
• Deactivate
• Verify Email
• Unverify Email
• Toggle On
• Toggle Off
• Are you sure you want to execute the action :action on the line #:primary?
• Are you sure you want to execute the action :action on the field :attribute from the line #:primary?
• Are you sure you want to execute the action :action on the :count selected lines?
• The line #:primary does not allow the action :action and will not be affected.
• :count selected lines do not allow the action :action and will not be affected.
• The action :action has been executed on the line #:primary.
• The action :action has been executed on the field :attribute from the line #:primary.
• The action :action has been executed on the :count selected lines.
• The line #:primary does not allow the action :action and was not affected.
• :count selected lines do not allow the action :action and were not affected.
• The list has been reordered.
• Showing results <b>:start</b> to <b>:stop</b> on <b>:total</b>

How to

Create table configurations

Generate a table configuration by executing this command : php artisan make:table UsersTable.

If you want to generate a configuration with a predefined model, just add this option at the end: --model=App/Models/User.

You'll find all your generated table configurations in the app/Tables directory.

Display tables in views

Just call this Livewire component in your view with your configuration class name passed in the config parameter.

Pass external data to your tables

In case you have specific attributes to transmit to your table configuration, you should pass them to the configParams parameter.

This could be useful when you have to transmit external information to your table.

You should then declare the passed attributes as public attributes your table configuration.

Generate tables from Eloquent models

To generate a table from an Eloquent model, you'll just have to call the model method on your table.

Override native selects behaviour on your tables

You may want to override native HTML select components behaviour on your tables.

You will be able to add a data attribute (which is known as the best practice to add extra features to a HTML component) to all the HTML select components displayed on your tables by defining an array of HTML attribute as value for the laravel-table.html_select_components_attributes config key.

Add query instructions on tables

To add specific query instructions on tables, use the available query method.

You'll be able to set specific Eloquent instructions by passing a closure parameter to the query method on your table.

This closure will allow you to manipulate a \Illuminate\Database\Eloquent\Builder $query argument.

Handle tables number of rows per page, pagination and navigation status

You have two ways to allow or disallow users to choose the number of rows that will be displayed per page:

• Activate or deactivate it globally from the laravel-table.enable_number_of_rows_per_page_choice config boolean value
• Override global activation status by executing the enableNumberOfRowsPerPageChoice() method on your table

Following the same logic, you'll be able to define the number of rows per page options that will be available for selection:

• Set options globally from the laravel-table.number_of_rows_per_page_default_options config array value
• Override global options by executing the numberOfRowsPerPageOptions() method on your table

The first available option will be automatically selected and applied on table initialization.

Pagination will automatically be handled, according to the number of rows to display and the total number of rows, as well as a navigation status.

Both of them will be displayed in the table footer.

Set conditional row class

Define conditional row class on tables by passing a closure argument to the rowClass method.

This closure will allow you to manipulate a Illuminate\Database\Eloquent $model argument and has to return an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression.

Setup table filters

Configuring table filters will make them appear as select HTML components on a dedicated bar above the table.

The filters bar will not appear if no filter is declared.

This package provides the following built-in filters:

• ValueFilter:
  • Requires string $label, string $attribute, array $options and bool $multiple = true arguments on instantiation
  • Filters the table based on whether the value of the selected options (or single option if multiple mode is disabled) is found in the given attribute
• RelationshipFilter:
  • Requires string $label, string $relationship, array $options and bool $multiple = true arguments on instantiation
  • Filters the table based on whether the value of the selected options (or single option if multiple mode is disabled) is found in the given relationship
• NullFilter
  • Requires a string $attribute argument on instantiation
  • Filters the table based on whether the value of the given attribute is null or not
• BooleanFilter
  • Requires string $label and string $attribute arguments on instantiation
  • Filters the table based on whether the value of the given attribute is true or false

To use them, you'll have to pass an array to the filters method, containing the filter instances to declare.

You may need to create your own filters. To do so, execute the following command: php artisan make:table:filter MyNewFilter.

You'll find your generated table filter in the app/Tables/Filters directory.

You will now be able to use your new filter in your tables.

Define table head action

Configure a table action that will be displayed as a button positioned at the right of the table head.

If no head action is declared, the dedicated slot for it in the table head will remain empty.

This package provides the following built-in head actions:

• RedirectHeadAction:
  • Requires string $url, string $label, string $icon, array $class = ['btn', 'btn-success'] and bool $openInNewWindow = false arguments on instantiation
  • Redirects to the given URL from a click on the button
• CreateHeadAction:
  • Requires string $createUrl and bool $openInNewWindow = false arguments on instantiation
  • Instantiate a pre-configured RedirectHeadAction with $createUrl as URL, __('Create') as label and config('laravel-table.icon.create') as icon

To use one of them, you'll have to pass an instance of it to the headAction method.

You'll be able to chain the following method to your head action:

• when(bool $condition): Okipa\LaravelTable\Abstracts\AbstractHeadAction
  • Determines whether the head action should be enabled

You may need to create your own head actions. To do so, execute the following command: php artisan make:table:head:action MyNewHeadAction.

You'll find your generated table head action in the app/Tables/HeadActions directory.

You will now be able to use your new head action in your tables.

Define table bulk actions

Configure table bulk actions that will be available in a dropdown positioned at the left of the table head.

If no bulk action is declared on your table, the dedicated column will not be displayed.

Important note: you'll have to set up a few lines of javascript to allow bulk actions confirmation requests and feedback to be working properly.

This package provides the built-in following bulk actions:

• VerifyEmailBulkAction:
  • Requires a string $attribute argument on instantiation
  • Update the given attribute with the current datetime for all selected lines
• CancelEmailVerificationBulkAction:
  • Requires a string $attribute argument on instantiation
  • Update the given attribute to null for all selected lines
• ActivateBulkAction:
  • Requires a string $attribute argument on instantiation
  • Update the given attribute to true for all selected lines
• DeactivateBulkAction:
  • Requires a string $attribute argument on instantiation
  • Update the given attribute to false for all selected lines
• DestroyBulkAction:
  • Destroys all the selected lines

To use them, you'll have to pass a closure parameter to the bulkActions method. This closure will allow you to manipulate a Illuminate\Database\Eloquent $model argument and has to return an array containing bulk action instances.

You'll be able to chain the following methods to your bulk actions:

• when(bool $condition): Okipa\LaravelTable\Abstracts\AbstractBulkAction
  • Determines whether the bulk action should be enabled on the table rows
• confirmationQuestion(string|false $confirmationQuestion): Okipa\LaravelTable\Abstracts\AbstractBulkAction
  • Overrides the default action confirmation message
• feedbackMessage(string|false $feedbackMessage): Okipa\LaravelTable\Abstracts\AbstractBulkAction:
  • Overrides the default action feedback message

You may need to create your own bulk actions. To do so, execute the following command: php artisan make:table:bulk:action MyNewBulkAction.

You'll find your generated table bulk actions in the app/Tables/BulkActions directory.

You will now be able to use your new bulk action in your tables.

Define table row actions

Configure row actions on your table that will be displayed at the end of each row.

If no row action is declared on your table, the dedicated Actions column at the right of the table will not be displayed.

Important note: you'll have to set up a few lines of javascript to allow row actions confirmation requests and feedback to be working properly.

This package provides the built-in following row actions:

• RedirectRowAction:
  • Requires string $url, string $title, string $icon, array $class = ['link-info'], string|null $defaultConfirmationQuestion = null, string|null $defaultFeedbackMessage = null and bool $openInNewWindow = false arguments on instantiation
  • Redirects to the given URL from a click on the link
• ShowRowAction:
  • Requires string $showUrl and bool $openInNewWindow = false arguments on instantiation
  • Instantiate a pre-configured RedirectRowAction with $showUrl as URL, __('Show') as label and config('laravel-table.icon.show') as icon
• EditRowAction:
  • Requires a string $editUrl argument on instantiation
  • Redirects to the model edit page on click
• DestroyRowAction:
  • Destroys the line after being asked to confirm

To use them, you'll have to pass a closure parameter to the rowActions method. This closure will allow you to manipulate a Illuminate\Database\Eloquent $model argument and has to return an array containing row action instances.

You'll be able to chain the same methods as for a bulk action => See bulk actions configuration.

You may need to create your own row actions. To do so, execute the following command: php artisan make:table:row:action MyNewRowAction.

You'll find your generated table row actions in the app/Tables/RowActions directory.

You will now be able to use your new row action in your tables.

You may need your row actions to be confirmed before they'll be executed and to trigger feedback messages.

You'll have to configure them in the same way you did for bulk actions.

Declare columns on tables

Declare columns on tables with the columns method available in your generated table configuration, from which you'll have to return an array of column instances.

To declare columns, just use the static make method that will await a string $attribute argument. This attribute will be used to get the default cell value.

By default, the column title will be defined to __('validation.attributes.<attribute>') in order to reuse attributes translations.

If you need to, you may use the title method that will await a string $title argument to set a specific column title that will override the default one.

Format column values

You'll sometimes need to apply specific formatting for your columns. There are a few ways to achieve this.

For specific cases, you should pass a closure parameter to the format method on your column.

This closure will allow you to manipulate a Illuminate\Database\Eloquent $model argument.

If you want to apply the same formatting treatment repeatedly, you should create a formatter with the following command: php artisan make:table:formatter NewFormatter.

You'll find the generated formatter in the app\Table\Formatters directory.

You'll be able to reuse this formatter in your tables.

This package provides the following built-in formatters :

• BooleanFormatter:
  • Displays the config('laravel-table.icon.active') active icon or the config('laravel-table.icon.inactive') inactive icon from a boolean value
• DateFormatter:
  • Requires string $format and string $timezone arguments on instantiation
  • Displays a formatted string from a date or datetime value
• StrLimitFormatter:
  • Allows optional int $limit and string $end arguments on instantiation
  • Displays a truncated string with a title allowing to see the full string on hover

Define column actions

Configure column actions on your table that will be displayed on their own cells.

Column actions have a lot in common with row actions.

Important note: you'll have to set up a few lines of javascript to allow column actions confirmation requests and feedback to be working properly.

This package provides the built-in following actions:

• ToggleBooleanColumnAction:
  • Toggles the email verification status
• ToggleBooleanColumnAction:
  • Toggles a boolean value

To use them, you'll have to pass a closure parameter to the action method. This closure will allow you to manipulate a Illuminate\Database\Eloquent $model argument and has to return an AbstractColumnAction instance.

You'll be able to chain the same methods as for a bulk action => See bulk actions configuration.

You may need to create your own column actions. To do so, execute the following command: php artisan make:table:column:action MyNewColumnAction.

You'll find your generated table column actions in the app/Tables/ColumnActions directory.

You will now be able to use your new column action in your tables.

You may need your column actions to be confirmed before they'll be executed and to trigger feedback messages.

You'll have to configure them in the same way you did for bulk actions.

Configure columns searching

Allow searching on columns by calling the searching method.

When searchable fields are set, a search input will appear in the table head.

Searchable column titles will be used to indicate which field can be searched on the search input placeholder.

By default, searching will be applied to columns defined keys.

You will be able to set up a custom searching behaviour by passing a closure to the searchable method.

This closure will be executed when searching will be triggered on the table and will allow you to manipulate a Illuminate\Database\Eloquent\Builder $query argument.

Configure columns sorting

Allow sorting on columns by calling the sortable method.

Sortable columns will display clickable sort icons before their titles that will trigger ascending or descending sorting.

By default, sorting will be applied to columns defined keys.

To sort a column by default, use the sortByDefault column method, which will allow you to pass a string $direction argument.

You can sort by default a column that is not sortable.

You will be able to set up a custom sorting behaviour by passing a closure to the sortable method.

This closure will be executed when sorting will be triggered on the column and will allow you to manipulate a Illuminate\Database\Eloquent\Builder $query and a string $sortDir arguments (asc or desc).

Allow columns to be reordered from drag and drop action

Allow columns to be reordered from drag and drop action by calling the reorderable method on your table.

This method will await a first string $attribute argument, an optional second string $title argument, and an optional third string $sortDirByDefault argument (accepting asc or desc values).

Important notes:

• You'll have to set up a few lines of javascript to allow reorder action feedback to be working properly
• You'll have to install the Livewire Sortable Plugin, that will handle the drag and drop utility for us

Activating this feature will:

• Prepend a new column that will display the drag-and-drop icon defined in the laravel-table.icon.drag_drop config value, followed by the defined model order attribute value
• Sort the rows from the defined model order attribute (asc by default)
• Disable all other columns sorting as it is not compatible with drag-and-drop reordering
• And of course, enable the drag-and-drop columns reordering by adding all the Livewire Sortable Plugin necessary markup

Tip: if you are using packages like spatie/eloquent-sortable to handle your Eloquent models sorting behaviour with a grouping query, you'll have to also set this grouping query in the table query instruction.

Declare results on tables

To display results, you'll have to return an array of result instances from the results method available in your generated table configuration.

If no result is declared, their dedicated space will remain empty.

Results should be declared this way:

1. Create a Result instance with the static make method
2. Chain the title method that will await a string $title argument
3. Chain the format method that will await a closure, letting you manipulate Illuminate\Database\Query\Builder $totalRowsQuery and Illuminate\Support\Collection $displayedRowsCollection params

Set up a few lines of JavaScript

You'll have to add few Javascript lines to your project once this package is installed, in order to allow confirmation requests and actions feedback to be working properly.

When an action is requesting the user confirmation, it will not be directly executed. A table:action:confirm Livewire event will be emitted instead with the following parameters:

1. The action type
2. The action identifier
3. The model primary key related to your action
4. The $confirmationQuestion attribute from your action

As you will see on the provided snippet below, the 4th param of this event is the only one you'll have to use in order to request the user confirmation. The 3 first params are only there to be sent back to a new event when the action is confirmed by the user. Just ignore them in your treatment.

You will have to intercept this event from your own JS script and prompt a confirmation request.

When the action is confirmed by the user, you'll have to emit a new laraveltable:action:confirmed Livewire event that will trigger the action execution. You'll have to pass it the 3 first arguments provided in the table:action:confirm event:

1. The action type
2. The action identifier
3. The model primary key related to your action

Here is an JS snippet to show you how to proceed:

Once an action is executed, a table:action:feedback Livewire event is triggered (it sometimes depends on the configuration of a feedback message).

Following the same logic, you'll have to intercept it from a JS script as shown on the snippet below to provide an immediate feedback to the user:

Finally, in order to allow head RedirectHeadAction and CreateHeadAction to open link in new tab, you'll also have to add the following JS snippet:

Trigger Livewire events on table load

You may want to trigger some events on table load, in order to load UI third party JS libraries for example.

You can do it using the table emitEventsOnLoad method, that will await an array of events.

Interact with your tables from events

You will be able to interact with your tables by sending them the following Livewire events:

• laraveltable:refresh
  • Allows optional array $configParams = [], and array $targetedConfigs = [] arguments
  • Refreshes your tables and (optionaly) set external table config data with (optional) table targeting to only refresh specific ones (empty $targetedConfigs array will refresh all tables one page)

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• Arthur LORENT
• All Contributors

License

The MIT License (MIT). Please see License File for more information.