Laravel Livewire Tables Documentation

🎉 Enjoying this package? Consider sponsoring me on GitHub or buying me a beer.

This is the documentation for v3. You can switch versions in the menu at the top. Check your current version with the following command:

composer show rappasoft/laravel-livewire-tables

Query String

The query string is enabled by default, but if you ever needed to toggle it you can use the following methods:

Global

setQueryStringStatus

Enable/disable the query string.

1public function configure(): void
2{
3 $this->setQueryStringStatus(true);
4 $this->setQueryStringStatus(false);
5}

setQueryStringEnabled

Enable the query string.

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatus(true)
4 $this->setQueryStringEnabled();
5}

setQueryStringDisabled

Disable the query string.

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatus(false)
4 $this->setQueryStringDisabled();
5}

setQueryStringAlias

Change the Alias in the URL, otherwise defaults to "$tablename"

1public function configure(): void
2{
3 $this->setQueryStringAlias('table1');
4}

Filters

The filter query string is enabled by default, but if you ever needed to toggle it you can use the following methods:

setQueryStringStatusForFilter

Enable/disable the query string for the filters

1public function configure(): void
2{
3 $this->setQueryStringStatusForFilter(true);
4 $this->setQueryStringStatusForFilter(false);
5}

setQueryStringForFilterEnabled

Enable the query string for the filters

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatusForFilter(true)
4 $this->setQueryStringForFilterEnabled();
5}

setQueryStringForFilterDisabled

Disable the query string for the filters

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatusForFilter(false)
4 $this->setQueryStringForFilterDisabled();
5}

setQueryStringAliasForFilter

Change the Alias in the URL for the filter, otherwise defaults to "$tablename-filters"

1public function configure(): void
2{
3 $this->setQueryStringAliasForFilter('filtervalues');
4}

Search

The search query string is enabled by default, but if you ever needed to toggle it you can use the following methods:

setQueryStringStatusForSearch

Enable/disable the query string for search

1public function configure(): void
2{
3 $this->setQueryStringStatusForSearch(true);
4 $this->setQueryStringStatusForSearch(false);
5}

setQueryStringForSearchEnabled

Enable the query string for search

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatusForSearch(true)
4 $this->setQueryStringForSearchEnabled();
5}

setQueryStringForSearchDisabled

Disable the query string for search

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatusForSearch(false)
4 $this->setQueryStringForSearchDisabled();
5}

setQueryStringAliasForSearch

Change the Alias in the URL for the search, otherwise defaults to "$tablename-search"

1public function configure(): void
2{
3 $this->setQueryStringAliasForSearch('search');
4}

Sorts

The sorts query string is enabled by default, but if you ever needed to toggle it you can use the following methods:

setQueryStringStatusForSort

Enable/disable the query string for sort

1public function configure(): void
2{
3 $this->setQueryStringStatusForSort(true);
4 $this->setQueryStringStatusForSort(false);
5}

setQueryStringForSortEnabled

Enable the query string for sort

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatusForSort(true)
4 $this->setQueryStringForSortEnabled();
5}

setQueryStringForSortDisabled

Disable the query string for sort

1public function configure(): void
2{
3 // Shorthand for $this->setQueryStringStatusForSort(false)
4 $this->setQueryStringForSortDisabled();
5}

setQueryStringAliasForSort

Change the Alias in the URL for the sorts, otherwise defaults to "$tablename-sorts"

1public function configure(): void
2{
3 $this->setQueryStringAliasForSort('sorts');
4}