Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodus-it/livewire-datatables
A awesome package for easy dynamic datatables with Laravel Livewire and Bootstrap v4
https://github.com/nodus-it/livewire-datatables
bootstrap4 laravel livewire livewire-datatables php
Last synced: 2 months ago
JSON representation
A awesome package for easy dynamic datatables with Laravel Livewire and Bootstrap v4
- Host: GitHub
- URL: https://github.com/nodus-it/livewire-datatables
- Owner: nodus-it
- License: mit
- Created: 2020-11-10T11:37:33.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T15:46:03.000Z (9 months ago)
- Last Synced: 2024-09-29T02:06:12.831Z (3 months ago)
- Topics: bootstrap4, laravel, livewire, livewire-datatables, php
- Language: PHP
- Homepage:
- Size: 133 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Livewire Datatables
[](//packagist.org/packages/nodus-it/livewire-datatables)
[](https://packagist.org/packages/nodus-it/livewire-datatables)
[](//packagist.org/packages/nodus-it/livewire-datatables)
[](https://github.com/nodus-it/livewire-datatables/actions/workflows/unittests.yml)
[](https://github.styleci.io/repos/311639565?branch=master)
[](https://codecov.io/gh/nodus-it/livewire-datatables)
_An awesome package for easy dynamic datatables with **Laravel Livewire** and **Bootstrap v4**._
## Installation
You can install the package via composer:
````
composer require nodus-it/livewire-datatables
````
You can publish the config file with:
````
php artisan vendor:publish --provider="Nodus\Packages\LivewireDatatables\LivewireDatatablesServiceProvider" --tag="livewire-datatables:config"
````
You can publish the blade views with:
````
php artisan vendor:publish --provider="Nodus\Packages\LivewireDatatables\LivewireDatatablesServiceProvider" --tag="livewire-datatables:views"
````
Now with the package installed we need to set up some things in order for things to properly work.
First of all, all prerequisites of the livewire library are of course required. For these steps consult: https://laravel-livewire.com/docs/2.x/installation
Second you should check the configs of the core package and this package and make sure all settings work for your project. Especially the blade stack names for styles and scripts could potentially differ from our defaults!
Additionally, we need to include the styles of the livewire datatable package.
````php
@livewireDatatableStyles
````
## Usage
### General tooling
For information of the general tooling around this package (e.g. full component rendering, CSP support, ...) please consult the core package documentation under: https://github.com/nodus-it/livewire-core
### The ``DataTable`` component
Todo
### The ``ConfirmModal`` component
Add the confirm-modal component to your layout at entrance level of your documents body.
````html
````
Now you're already good to go for the confirmation buttons of your datatables.
Furthermore, it's possible to use the confirm-modal component from outside the datatable aswell. You simply need to emit the ``confirm:show`` event:
**In livewire components:**
````html
wire:click="$emit('confirm:show', 'url')"
````
**Out of livewire components:**
````html
onClick="Livewire.emit('confirm:show', 'url')"
````
With the third parameter it is possible to customize the modal texts and colors. For further details take a look inside the ``ConfirmModal`` class.
## Roadmap
- Support for search keys through multiple relations
- Support for sort keys through relations
- Advanced scopes
- More themes (Tailwind3, Bootstrap5)
- Fix the query rebuilding problem (currently using the IDs array) by using EloquentBuilder serialization
## Testing
````
composer test
````
## License
The MIT License (MIT). Please see [License File](LICENCE) for more information.