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

Tools

The Table offers additional configuration to show/hide the Tools/Toolbar sections:

Tools

Contains:

  • Filter Pills
  • Sorting Pills
  • The Toolbar

Toolbar

Contains:

  • Actions (if set to Toolbar)
  • Column Select dropdown
  • Configurable Areas for Toolbar
  • Filters Button/Dropdown/Popover
  • Pagination dropdown
  • Reorder Button
  • Search Input

Component Available Methods

setToolsEnabled

The Default Behaviour, Tools Are Enabled. But will only be rendered if there are available/enabled elements. If the Toolbar is enabled, this takes into account any Toolbar elements that are present.

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

setToolsDisabled

Disables the Tools section, this includes the Toolbar, and Sort/Filter pills

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

setToolBarEnabled

The Default Behaviour, ToolBar is Enabled. But will only be rendered if there are available/enabled elements

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

setToolBarDisabled

Disables the Toolbar, which contains the Reorder, Filters, Search, Column Select, Pagination buttons/options. Does not impact the Filter/Sort pills (if enabled)

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

setToolsAttributes

Allows setting of attributes for the parent element in the tools blade

By default, this replaces the default classes on the tools blade, if you would like to keep them, set the default-colors/default-styling flags to true as appropriate

1public function configure(): void
2{
3 $this->setToolsAttributes(['class' => ' bg-green-500', 'default-colors' => false, 'default-styling' => true]);
4}

setToolBarAttributes

Allows setting of attributes for the parent element in the toolbar blade.

By default, this replaces the default classes on the toolbar blade, if you would like to keep them, set the default-colors/default-styling flags to true as appropriate

1public function configure(): void
2{
3 $this->setToolBarAttributes(['class' => ' bg-red-500', 'default-colors' => false, 'default-styling' => true]);
4}