Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckykenlin/livewire-tables
A dynamic livewire table component for laravel
https://github.com/luckykenlin/livewire-tables
datatables laravel livewire livewire-tables
Last synced: 3 months ago
JSON representation
A dynamic livewire table component for laravel
- Host: GitHub
- URL: https://github.com/luckykenlin/livewire-tables
- Owner: luckykenlin
- License: apache-2.0
- Created: 2021-03-25T21:35:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-12T14:28:15.000Z (about 1 year ago)
- Last Synced: 2024-09-18T17:15:44.296Z (3 months ago)
- Topics: datatables, laravel, livewire, livewire-tables
- Language: PHP
- Homepage: https://luckykenlin.github.io/livewire-tables
- Size: 1.12 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# livewire-tables
[](https://packagist.org/packages/luckykenlin/livewire-tables)
[](https://github.com/luckykenlin/livewire-tables/actions?query=workflow%3ATests+branch%3Amain)
[](https://packagist.org/packages/luckykenlin/livewire-tables)
A dynamic livewire table component for laravel.
## Requirements
- [Laravel](https://laravel.com/docs)
- [Livewire](https://laravel-livewire.com/docs)
- [TailwindCSS](https://tailwindcss.com/docs)
## Installation
You can install the package via composer:
```bash
composer require luckykenlin/livewire-tables
```
## Documentation
[https://luckykenlin.github.io/livewire-tables/](https://luckykenlin.github.io/livewire-tables/)
## Usage
### Creating Tables
To create a table component you draw inspiration from the below stub:
```bash
php artisan make:table UsersTable
```
To specific model use --model:
```bash
php artisan make:table UsersTable --model=User
```
```php
sortable(),
Column::make('Name', 'name')->searchable()->sortable(),
Column::make('Email', 'email')->searchable()->sortable(),
Action::make()
];
}
}
```
Your component must implement two methods:
```php
/**
* This defines the start of the query, usually Model::query() but can also eager load relationships and counts if needed.
*/
public function query() : Builder;
/**
* This defines the columns of the table, they don't necessarily have to map to columns on the database table.
*/
public function columns() : array;
```
## Rendering the Table
Place the following where you want the table to appear.
``
## To-do/Roadmap
- [ ] User Column Selection
- [ ] Bulk Actions
- [ ] Date Filter
- [ ] Selector Filter
- [ ] Multiple Selector Filter
- [ ] Bulk Actions
- [ ] CDN Css
- [ ] Test Suite
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ken Lin](https://github.com/KenLin)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.