README

Laravel Livewire Datatables

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require defstudio/wired-tables

You can publish the config file with:

php artisan vendor:publish --tag="wired-tables-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="wired-tables-views"

Tailwind configuration

In order to keep wired tables tailwind classes, add this to your tailwind.config.js:

module.exports = {
    content: [
        //...
        './vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php',
        './vendor/wire-elements/modal/resources/views/*.blade.php',
        //...
    ],
    theme: {
        extend: {},
    },
    plugins: [],
    prefix: 'tw-',
    corePlugins: {
        preflight: false,
    }
}

Using tailwind along with other frameworks (i.e. bootstrap)

set style = tailwind_3_prefixed config in configs/wired-tables.php (see above for info on how to publish config file)

and add these to your tailwind.config.js:

module.exports = {
    content: [
        //...
        './vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php',
        './vendor/wire-elements/modal/resources/views/*.blade.php',
    ],
    
    //...
    
    prefix: 'tw-',
    corePlugins: {
        //...
        preflight: false,
    }
}

Usage

$wiredTables = new DefStudio\WiredTables();
echo $wiredTables->echoPhrase('Hello, DefStudio!');

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

TODO DOCS

Views can be overridden by publishing them

php artisan vendor:publish --tag="wired-tables-views"

Views can be overridden on a single table also:

MyTable extends WiredTable{
    public function mainView(): string
    {
        return 'custom-main-view';
    }

the following view methods can be overridden:

mainView(): the main container view for the table
tableView(): the main table view

defstudio / wired-tables

Maintainers

Details