This is the initial beta, offering support for Livewire 3.

N.B - This is a preview/beta, and is not suitable for production use.

For more information on the beta please see the discussion here, or join us on Discord

Potential breaking changes

• Introduction of multiple relations to a single table
• SetSearchLazy removed

Key Notes

• The package uses an injection approach to inject required JS and CSS, in the same method as Livewire itself. The behaviour is customisable.

Non-Breaking Changes

General

• Added support for multiple relations on a single table (e.g. user has a "mother user" and a "father user")
• Bootstrap striping is now working as standard
• Uses HeroIcons instead of hard-coded SVGs for icons
• Optimisation of Blade/View Components

Columns

• Label Columns (without a field) are sortable using a callback
• Preview Livewire Component Column - Caution - potential high memory/CPU usage

Filters

• Added Numeric Range filter
• Added Date Range filter
• DateFilter & DateTimeFilter have customisable Pills Date Format
• DateFilter & DateTimeFilter support setFilterDefaultValue to set a Default Value
• MultiSelectFilter & MultiSelectDropdownFilter both support setFirstOption() to set a value for "All"

Pagination

• Added support for cursor pagination ($this->setPaginationMethod('cursor'))
• Cursor & Simple pagination both include a "Total Item Count" stored in $paginationTotalItemCount, which is displayed in the table foot

Search

• Search Placeholder is customisable ($this->setSearchPlaceholder('Finder'))
• Added setSearchBlur()
• Added setSearchThrottle(int $milliseconds)

Other

• Optimisation of codebase overall
• Introduction of typehinting for parameters and return values across majority of codebase
• Increased test coverage

• Fixes

  • Re-enable capability for configuring whether to Hide/Show Bulk Actions when empty - https://github.com/rappasoft/laravel-livewire-tables/pull/1240

• Enhancements

  • Allow Label Columns to be Sortable - https://github.com/rappasoft/laravel-livewire-tables/pull/1256
  • Add Select All On Page Translations - https://github.com/rappasoft/laravel-livewire-tables/pull/1244
  • Add Contributors Document to track Localisation contributors - https://github.com/rappasoft/laravel-livewire-tables/pull/1223

Changed

• Fixes

  • Bulk Actions (AlpineJS)
  • Moving Table Head Checkbox to AlpineJS
  • Using AlpineJS for calculating if all items have been selected
  • Correcting missing x-cloak
  • Added indeterminateCheckbox for TH for bulk actions
  • Cleaned up ALpineJS functionality for Bulk Actions
  • Repair of tests that were looking for wire:model that no longer existed

• Enhancements

  • Several new public variables for accessing pagination data cleanly, to avoid calling functions repeatedly across various blades.
    • paginationTotalItemCount (Total number of items in the results across all page)
    • paginationCurrentItems (Primary keys of items in the current page)
    • paginationCurrentCount (Number of results on the current page)

• Blades

  • Several blades have had the classic Tables approach ($theme == 'tailwind', $theme == 'bootstrap) replaced with conditional classes using the @class([]) approach. This is to reduce the complexity of the blade files.

Fixes for AlpineJS

Changed

• General

  • Migrate to AlpineJS for Bulk Actions - https://github.com/rappasoft/laravel-livewire-tables/pull/1196
  • Add capability for passing a custom model path to the MakeCommand - https://github.com/rappasoft/laravel-livewire-tables/pull/1168
  • Add setFilterDefaultValue() on a per-component basis - https://github.com/rappasoft/laravel-livewire-tables/pull/1191
  • Add getFilterDefaultValue() to each Filter Component (to maintain support for PHP7.4 - variable return types) - https://github.com/rappasoft/laravel-livewire-tables/pull/1191
  • Moved Setting of Filter Defaults to Traits/Helpers/FilterHelpers - mountFilterHelpers - https://github.com/rappasoft/laravel-livewire-tables/pull/1191
  • Moved Setting of Theme to Traits/ComponentUtilities - mountComponentUtilities for efficiency - https://github.com/rappasoft/laravel-livewire-tables/pull/1191

• Filters

  • Fix - Hide the filter label in the header/footer when using as a secondary header/footer
  • Fix - Changed the booting order to prevent repeated calling of filters() - https://github.com/rappasoft/laravel-livewire-tables/pull/1166
  • Fix - fixed multiSelectDropdownFilter in menus - https://github.com/rappasoft/laravel-livewire-tables/pull/1160
  • Fix - TypeHint to allow continued support of PHP 7.4 - https://github.com/rappasoft/laravel-livewire-tables/pull/1185

• Documentation

  • Fix - Minor wording tweak to documentation - https://github.com/rappasoft/laravel-livewire-tables/pull/1139
  • Fix - Fix to example in applying-filters - https://github.com/rappasoft/laravel-livewire-tables/pull/1171
  • Improved template for New Issue/Bug - https://github.com/rappasoft/laravel-livewire-tables/pull/1194

• Tests

  • Restore PHP 7.4 tests for L8 only (includes minor tweaks)
  • Remove duplicate tests in ComponentHelpersTest
  • Tweak to ReorderingVisualsTest
  • Add TextFilter as a test in FilterHelpersTest

• Localization

  • Added Danish Localization - https://github.com/rappasoft/laravel-livewire-tables/pull/1206

Added

• AlpineJS Variable for Toolbar Dropdowns to force the dropdown to remain open - childElementOpen - https://github.com/rappasoft/laravel-livewire-tables/pull/1076

• Added Custom Column Slug method setCustomSlug('') allowing Columns to use non-roman characters in the Column Title - https://github.com/rappasoft/laravel-livewire-tables/pull/1088

• Eager loading so anyone can load any type of relationship - https://github.com/rappasoft/laravel-livewire-tables/pull/943

• Improved visibility of active page in pagination - https://github.com/rappasoft/laravel-livewire-tables/pull/1096

• Pagination methods

  • Retrieve currently displayed IDs - getPerPageDisplayedItemIds()
  • Retrieve number of records currently displayed - getPerPageDisplayedItemCount()
  • Public variables for the above https://github.com/rappasoft/laravel-livewire-tables/pull/1136

• Filter Changes - https://github.com/rappasoft/laravel-livewire-tables/pull/1129

  • Custom Filter Pill Blades per Filter component (setFilterPillBlade()) - https://github.com/rappasoft/laravel-livewire-tables/pull/1107
  • Custom Filter Label Blades per Filter component (setCustomFilterLabel()) - https://github.com/rappasoft/laravel-livewire-tables/pull/1110
  • Filter positioning options when using slide-down - https://github.com/rappasoft/laravel-livewire-tables/pull/1108
    • Set the row per Filter component (setFilterSlidedownRow())
    • Set the colspan per Filter component (setFilterSlidedownColspan())

Changed

• Filters

  • Fix - enabled re-use of Filters in Secondary Header/Footer, fixing issue where the filter remains visible after deselecting the Column- https://github.com/rappasoft/laravel-livewire-tables/pull/1108
  • Fix - restrict AppliedFilters to only return non-empty - preventing default values from setting the filter https://github.com/rappasoft/laravel-livewire-tables/pull/1080
  • Minor - added ID to Filter Wrapper allowing for easier targeting in blades/AlpineJS - https://github.com/rappasoft/laravel-livewire-tables/pull/1087

• Workflow Changes

  • PHPStan - Introducing PHP-Stan at Level 3 to ensure code-quality persists - https://github.com/rappasoft/laravel-livewire-tables/pull/1133
  • Run-Tests - Use of ParaTest, Composer Caching, Fixing the Stability Matrix clash - https://github.com/rappasoft/laravel-livewire-tables/pull/1105
  • php-cs-fixer - (For Badge) - https://github.com/rappasoft/laravel-livewire-tables/pull/1125 / https://github.com/rappasoft/laravel-livewire-tables/pull/1126

• Testing

  • Significant quantity of tests, improving test coverage from 81% to 91% - https://github.com/rappasoft/laravel-livewire-tables/pull/1137
  • General DocType/TypeHint Fixes https://github.com/rappasoft/laravel-livewire-tables/pull/1133

Added

• Support for Laravel 10 - https://github.com/rappasoft/laravel-livewire-tables/pull/1049
• Trigger events when changing selected columns - https://github.com/rappasoft/laravel-livewire-tables/pull/1046
• Added before-tools configurable area - https://github.com/rappasoft/laravel-livewire-tables/pull/1037
• Added support to hide column select on tablet or mobile - https://github.com/rappasoft/laravel-livewire-tables/pull/1031

Changed

• Corrected issue in filter docs - https://github.com/rappasoft/laravel-livewire-tables/pull/1048
• Fixed filter pill values for option groups - https://github.com/rappasoft/laravel-livewire-tables/pull/1044

Added

• Added support for MorphOne relationships - https://github.com/rappasoft/laravel-livewire-tables/pull/844
• Added MultiSelectDropdownFilter - https://github.com/rappasoft/laravel-livewire-tables/pull/1011
• FilterSlideDown - Ability to set Default to Open or Closed - https://github.com/rappasoft/laravel-livewire-tables/pull/1017

Changed

• Updated EN translations - https://github.com/rappasoft/laravel-livewire-tables/pull/999
• Updated ES translations - https://github.com/rappasoft/laravel-livewire-tables/pull/1000
• Bulk Actions Simple Pagination fix & typo in toolbar.blade.php - https://github.com/rappasoft/laravel-livewire-tables/pull/1015

Added

• Added support for optgroups in SelectFilter - https://github.com/rappasoft/laravel-livewire-tables/pull/962
• Added information about applying filters on boot - https://github.com/rappasoft/laravel-livewire-tables/pull/949
• Added ComponentColumn - https://github.com/rappasoft/laravel-livewire-tables/pull/827
• Added ability to set the pagination mode of standard or simple

Changed

• Fixed formatting for relational column - https://github.com/rappasoft/laravel-livewire-tables/pull/757
• Fixed errors when filter does not exist - https://github.com/rappasoft/laravel-livewire-tables/pull/979
• Update basic example to represent V2 requirements - https://github.com/rappasoft/laravel-livewire-tables/pull/944
• Fixed responsive on bootstrap 4 & 5 - https://github.com/rappasoft/laravel-livewire-tables/pull/903
• Fix for select and checkbox inputs styling with Bootstrap 5 theme - https://github.com/rappasoft/laravel-livewire-tables/pull/864

Added

• Added functionality to bookmark or deep link column selection
• Added functionality to identify different datatable components as unique in column selection
• Added funcitonality to configure query string alias
• Added funcitonality to configure session key for column selection (dataTableFingerprint)
• Added functionality to select/desect all columns in column selection dropdown
• Added French translation - https://github.com/rappasoft/laravel-livewire-tables/pull/816
• Added Malay translation - https://github.com/rappasoft/laravel-livewire-tables/pull/821
• Added Dutch translation - https://github.com/rappasoft/laravel-livewire-tables/pull/834
• Added Ukranian translation - https://github.com/rappasoft/laravel-livewire-tables/pull/840

Changed

• Fixed bug with sort callback on newer versions of Livewire - https://github.com/rappasoft/laravel-livewire-tables/pull/805
• Fixed: Removed :mixed return type hint as it requires PHP8.0 - https://github.com/rappasoft/laravel-livewire-tables/pull/822

Added

• Added functionality to hide individual filters from popover and slide down views
• Added functionality to hide individual filters from filter pills
• Added functionality to hide individual filters from the active filter count
• Added functionality to say which filters get reset by the clear button
• Added functionality to set filters as secondaryHeader or footer of columns

Added

• Added functionality to display BooleanColumn as Yes/No instead of icons.
• Added ButtonGroupColumn for multiple LinkColumns in one group. Pretty much built in action buttons support.
• Added bulk action export example to docs.

Added

• Ability to pass mount parameters to configurable areas

Changed

• Move configure call to boot() instead of booted().
• Mount methods now available in configure() method.
• Non-field columns with a searchable callback are now included in the search query.
• Fixed debug query output duplicating select statements.
• Fixed header issue on column hide - https://github.com/rappasoft/laravel-livewire-tables/pull/754

Removed

• Calls to set builder and columns in render as it doesn't seem to make a difference since it's also called in booted().

Added

• Added table event listeners to sort/filter/clear from other components.
• Added text filter.
• Added $row as second parameter to BooleanColumn setCallback().
• Added setThSortButtonAttributes() to set attributes for th sort button.
• Added setHideConfigurableAreasWhenReorderingStatus() to hide configurable areas when reordering status which now defaults to true.

Changed

• Rework builder to fix passed parameters in builder() and columns() methods.
• Fixed possible bug with bulk actions dropdown on Tailwind when bulk actions are hidden until a selection is made.

Added

• Added ability to define additional select statements outside the scope of a column using the setAdditionalSelects(array $selects) configuration method.
• Added 8 configurable areas, see Configurable Areas of the Datatable section of the documentation.

Changed

• Fixed filter dropdown opening on sort - https://github.com/rappasoft/laravel-livewire-tables/pull/740

Added

• Added space to include custom markup at the end of the component.
• Added events documentation
• Added ability to set columns as deselected by default - https://github.com/rappasoft/laravel-livewire-tables/pull/731
• Added NumberFilter - https://github.com/rappasoft/laravel-livewire-tables/pull/729

Changed

• Fixed issue with Postgres and quotes - https://github.com/rappasoft/laravel-livewire-tables/pull/734

Added

• Turkish Translation - https://github.com/rappasoft/laravel-livewire-tables/pull/686
• Added missing table row click functionality
• Added ability to mark column as unclickable if you need a cell to have another clickable element with clickable rows turned on.

Changed

• Update filter docs - https://github.com/rappasoft/laravel-livewire-tables/pull/691
• Update getTdAttributes to take 4th missing argument
• Add filters in the config section - https://github.com/rappasoft/laravel-livewire-tables/pull/709
• Update some docs formatting

Ground Up Rebuild

Changed

• Fixed $wireclick issue