rappasoft/laravel-livewire-tables

• Restore wire:confirm for Bulk Actions
• Stable Release of 3.1.0 Stable for Livewire v3 Support

• Update Date Range Icon Styling
• Migrate PHP from date-range blade into new DateRangeFilter method
• Add FilterHelper method for generating filter wire:keys
• Add Filter CustomPosition tests
• Add Placeholder config option for DateRangeFilter
• Add Placeholder config option for DateFilter, DateTimeFilter, NumberFilter
• Clean up classes on filters
• Minor tweaks to toolbar/column select styling
• Fix wire:confirm for BulkActions (removed in merge error)

• Changes to toolbar blade structure by @lrljoe in #1454
• Fix queryStringEnabled by @lrljoe in #1465
• Add missing x-cloak by @lrljoe in #1463

• Fixes for missing default behaviour by @lrljoe in #1455

• Fix for setFilter - allows setting values at mount/boot (#1451) by @lrljoe in #1452

• Add wire:navigate option for clickable rows

• Fix for collapsing column header shift

• Fix Return Type hinting for Column Rendering to allow Enum columns
• Add Bulk Action Confirmations, using wire:confirm
  • setBulkActionConfirms
  • setBulkActionConfirmMessage
  • setBulkActionConfirmMessages
  • setBulkActionDefaultConfirmationMessage
  • Localisation for confirmation message

• Introduction of Loading Placeholder
• Docs livewire namespace fix Here
• Add CollapseAlways capability for Columns
• Fix localisation bug

• Fix for Livewire ^3.0.6 where the table loading causes an additional lifecycle
• Add unminified files to .gitattributes export-ignore
• Increase cached time to 1 day from 1 hour if cache is enabled

• Removes superfluous @endphp from the DateRangeFilter blade
• Removes reference to remote/published 3rd party assets
• Add setFilterLabelAttributes Capability Per-Filter
• Fix for reorder sort not applying automatically

• Amending Documentation for Reordering

• Adding capabilities & tests for setTrAttributes

• Force calculation of even/odd only once in reorder mode

• Call internal method for reordering, and pass to configured method to process

• Amend AutoInjection/FrontendAsset to ensure it returns the original content correctly

• Remove errant disabling of Blade Directives when disabling auto-injection

• Amended in-line config documentation

• Add setSearchFieldAttributes() and getSearchFieldAttributes()

• Add missing pagination tests

• Removal of setSearchLazy

• Fix for setSearchDebounce

• Fix publishing of views

• Fix for Bulk Actions dropdown not working in Bootstrap

• Fix for Column Select "Select All" not consistently updating

• Fix for lazy loading of table

• Fix for ColumnSelect falling out of sync, displaying unselectable colums, or persisting cols in query that are not selected

• Add setSearchBlur()

• Add setSearchThrottle()

• Add publish translations

• Add prependColumns() and appendColumns() functions

• Add documentation for setSearchPlaceholder()

• Add setExcludeDeselectedColumnsFromQueryEnabled and setExcludeDeselectedColumnsFromQueryDisabled methods to configure()

• Requirements Change

  • Requires LiveWire 3.x
  • Requires PHP 8.1+
  • Requires Laravel 10+

• Core Changes

  • Move sorts, search, selectedColumns out of the traditional $this->{$this->getTableName()}['sorts'] and instead place it directly within the component. This:

    • Improves the query string behaviour
    • Reduces the need to repeatedly set up that main array Commit 1 Here Commit 2 Here

  • Tidying

    • Removed Spatie Package Tools and replaced with a generic service provider
    • Significant reduction in blade/view sizes, and repetition of code across Tailwind/Bootstrap 4/Bootstrap 5 themes
    • Uses HeroIcons instead of hard-coded SVGs for icons
    • Several variables are now inherited instead of being passed (e.g. Table Name)
    • Change to how Filters are rendered (no longer receives $component)
    • Wire keys and IDs now all conform to a format

  • Features

    • General

      • Added support for cursor pagination
      • Cursor & Simple pagination both include a "Total Item Count" stored in $paginationTotalItemCount
      • Added support for multiple relations on a single table (e.g. user has a "mother user" and a "father user")
      • Replaced dependency on unsupported Sortable JS libraries.
      • Option for a Search Placeholder to be set
      • Bootstrap striping is now fully working

    • Filters

      • Filter Construct calls config([]) by default to set configuration defaults, to avoid errors
      • Added Numeric Range filter
      • Added Date Range filter
      • DateFilter & DateTimeFilter have customisable Pills Date Format
      • DateFilter & DateTimeFilter fully support setFilterDefaultValue
      • MultiSelectFilter & MultiSelectDropdownFilter both support setFirstOption()
      • There are now two arrays relating to Filters:
        • A wireable one ($filterComponents)
        • An unwired one - only keeps track of those filters that have a value ($appliedFilters). This is what is bound to the query string, and populates the filters on mount if they are present in the query string.

    • Livewire 3 Specific

      • Migrated any $component->id reference to $component->getId()
      • Added SetSearchLive to allow for the search to be "live", with tests
      • Added capability for external CSS file
      • Custom CSS/JS and Alpine components are now stored in an external file, which has configurable injection options
      • Added setSearchLive(), setSearchThrottle(int $milliseconds) and setSearchBlur() options for Search behaviour

• Test Changes

  • Temporarily removed the sort_events_apply_correctly and filter_events_apply_correctly due to LW3 not using Emit anymore.

  • Added extra column to the PetsTable -> last_visit and associated test changes to make the counts work. This column is deselected() by default to allow for testing on those methods.

• Doc Changes

  • Slowly begun updating the docs with the relevant new features, dependencies etc.

• 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.

Changed

• 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 functionality to configure query string alias
• Added functionality to configure session key for column selection (dataTableFingerprint)
• Added functionality to select/deselect 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 Brazilian Portuguese translation - https://github.com/rappasoft/laravel-livewire-tables/pull/797

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 booteed.
• 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

Ground Up Rebuild

Added

• Added Chinese translation - https://github.com/rappasoft/laravel-livewire-tables/pull/540
• Added 'select all' checkbox for multiselect filters - https://github.com/rappasoft/laravel-livewire-tables/pull/551
• Added attributes to filters - https://github.com/rappasoft/laravel-livewire-tables/pull/558
• Added 4th option for pills fallback value - https://github.com/rappasoft/laravel-livewire-tables/pull/538

Changed

• Removed excess left padding on Bootstrap 5 form check on multiselect filters.
• Patch bulk actions random wire:key - https://github.com/rappasoft/laravel-livewire-tables/pull/557

Changed

• Fix bulk actions breaking change - https://github.com/rappasoft/laravel-livewire-tables/pull/535

Added

• Singular row translation - https://github.com/rappasoft/laravel-livewire-tables/pull/526

Changed

• Fixed bulk actions dropdown on Bootstrap - https://github.com/rappasoft/laravel-livewire-tables/pull/519
• Fixed bulk row/select with pagination off - https://github.com/rappasoft/laravel-livewire-tables/issues/510
• Conditionally show cursor-pointer class instead of inline style - https://github.com/rappasoft/laravel-livewire-tables/pull/529

Changed

• Fix bulk actions - https://github.com/rappasoft/laravel-livewire-tables/pull/517

Added

• German translation - https://github.com/rappasoft/laravel-livewire-tables/pull/502

Changed

• Extracts just the field name from primaryKey - https://github.com/rappasoft/laravel-livewire-tables/pull/506
• Update BS4 pagination - https://github.com/rappasoft/laravel-livewire-tables/pull/507
• Update minimum Livewire version to 2.6

Changed

• Fixed table target default

Added

• Thai translation - https://github.com/rappasoft/laravel-livewire-tables/pull/491
• Italian translation - https://github.com/rappasoft/laravel-livewire-tables/pull/493
• Added getTableRowUrlTarget to set row click target based on the row
• Add custom class to table - https://github.com/rappasoft/laravel-livewire-tables/pull/495

Changed

• Fix removing a multiselect filter - https://github.com/rappasoft/laravel-livewire-tables/pull/494

Added

• Secondary header (see documentation section Secondary Header Functionality on how to implement column search)

Changed

• Add missing properties to reordering session

Added

• Multiselect filter - https://github.com/rappasoft/laravel-livewire-tables/pull/469

Changed

• Fixed default version of livewire - https://github.com/rappasoft/laravel-livewire-tables/issues/486
• Fix bulk select with search and add typed property to selected - https://github.com/rappasoft/laravel-livewire-tables/pull/439

Added

• Ability to use the header as the footer
• Ability to define a custom footer cell per column
• Ability to set the footer row classes/id/attributes
• Ability to set the footer cell classes/id/attributes
• Added isHtml method on the column and replace use of property in views for internal use.
• Ability to define bulk actions with a method
• Allow to disable responsive status of the table
• Ability to link each cell

Changed

• Reduce horizontal spacing in Tailwind responsive view

Added

• Dark styles for Tailwind

Changed

• Minimum Livewire version to 2.6.2 to avoid 2.6.1 bug.
• Remove our custom pagination as Livewire 2.6 supports multiple pagination per page now.

Added

• Added ID language file
• Added ability to preselect columns
• Added ability to turn off column session
• Support virtual columns
• Added ability to dump filters above table for debugging

Added

• Spanish translation

Changed

• Use package tool to register commands
• Fix callback so it doesn't care about parameter names
• Changed default empty text

Added

• Make datatable command

Added

• Added addAttributes method to column headers

Changed

• Increased minimum Livewire version
• Added default empty message to lang file.
• Fix people messing with sort direction from URL
• Check to make sure column exists before sorting
• Removed ability to alter per page dropdown select to bypass allowed values.

Added

• Added $hideBulkActionsOnEmpty to hide the bulk actions dropdown until something is selected.

Added

• When reordering, the last known state of the table is now saved in the session so when you're done reordering you are back where you left off and no filters/sorts/search is lost.

Changed

• Fixed query string getting wiped out on reload

Changed

• Use Alpine binding syntax to avoid conflicts with Vue

Changed

• Fixed Tailwind column popup on reorder

This release requires re-publishing of assets.

Added

• Column selector for users to show/hide columns
• Drag & Drop reordering

This release requires re-publishing of assets.

Added

• Date filters

Changed

• Replaced bootstrap dropdowns with Alpine on bootstrap themes which fixes them closing prematurely when selecting filters.
• Added wrapping divs around needed if statements.
• Fixed Bootstrap pagination DOM-diffing issues.

Added

• Actual default sorting
• Added place to put modals in the scope of the component
• Added setTableRowClass, setTableRowId, setTableRowAttributes, setTableDataClass, setTableDataId, setTableDataAttributes methods to modify cells and rows depending on data for non-custom rows.

Changed

• Fix tailwind style for div containing checkbox

Added

• Arabic translation file

Changed

• Fix select tag className in Bootstrap 5