Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiknil/wire-table
Laravel package extending Livewire to easily create useful tables
https://github.com/tiknil/wire-table
laravel livewire livewire-tables
Last synced: about 2 months ago
JSON representation
Laravel package extending Livewire to easily create useful tables
- Host: GitHub
- URL: https://github.com/tiknil/wire-table
- Owner: tiknil
- License: mit
- Created: 2023-04-03T14:27:34.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-07T08:26:24.000Z (5 months ago)
- Last Synced: 2024-09-18T17:15:29.303Z (about 2 months ago)
- Topics: laravel, livewire, livewire-tables
- Language: PHP
- Homepage:
- Size: 87.9 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Livewire extension for building tables
[](https://packagist.org/packages/tiknil/wire-table)
[](https://packagist.org/packages/tiknil/wire-table)
The aim of this project is to provide a useful boilerplate with sane defaults for building backoffice tables,
while allowing easy customization.
## Installation
`wire-table` requires PHP >= 8.1 and Laravel >= 10.0
```bash
composer require livewire/livewire:^3.0 tiknil/wire-table
```
> [!NOTE]
> Since v1.0.0, wire-table requires livewire 3.0. Use v0.3.2 if you are supporting livewire 2
**Optional** you can publish wire-table files for further customization:
```bash
php artisan vendor:publish --tag=wiretable:config # Config file
php artisan vendor:publish --tag=wiretable:views # Blade views
php artisan vendor:publish --tag=wiretable:lang # Lang translation files
```
## Usage
Create a new component using the `make:wiretable` command:
```bash
php artisan make:wiretable UsersTable
```
The UsersTable class will be created inside your `app/Livewire` folder.
A basic table:
```php
class UsersTable extends WireTable
{
public function query(): Builder
{
return User::query();
}
public function columns(): array
{
return [
Column::create(
label: __('backend.created_at'),
key: 'created_at',
sort: true
),
Column::create(
label: __('backend.name'),
key: 'name',
sort: true
),
Column::create(
label: __('backend.email'),
key: 'email',
sort: true
),
];
}
}
```
Include it in your blade file:
```
```
> Remember to include
> the [livewire javascript and css](https://laravel-livewire.com/docs/2.x/quickstart#install-livewire) in every page
> where
> you will be using it.
> The tables are just livewire components, so
> the [official livewire documentation](https://laravel-livewire.com/docs/2.x)
> applies here.
### Features
#### See the [docs folder](./docs/README.md) for the full documentation.
Quick links:
- [Columns](./docs/Columns.md)
- [Row rendering](./docs/Row.md)
- [Filters](./docs/Filters.md)
- [Sorting](./docs/Sorting.md)
- [Pagination](./docs/Pagination.md)
- [Theme and style](./docs/Theme.md)
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please
email [[email protected]](mailto:[email protected]) instead of using the issue
tracker.
## Credits
- [Giorgio Balduzzi](https://github.com/tiknil)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
----
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com), following the
[laravelpackage.com](https://laravelpackage.com) documentation.