Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leantony/laravel-grid
A grid view for laravel, inspired by the yii2 grid widget
https://github.com/leantony/laravel-grid
bootstrap filter grid grid-generator javascript jquery laravel laravel-grid pjax
Last synced: 8 days ago
JSON representation
A grid view for laravel, inspired by the yii2 grid widget
- Host: GitHub
- URL: https://github.com/leantony/laravel-grid
- Owner: leantony
- License: mit
- Created: 2018-02-14T07:24:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T17:05:59.000Z (almost 2 years ago)
- Last Synced: 2024-10-15T08:41:45.196Z (24 days ago)
- Topics: bootstrap, filter, grid, grid-generator, javascript, jquery, laravel, laravel-grid, pjax
- Language: PHP
- Homepage: https://leantony.github.io/laravel-grid/
- Size: 754 KB
- Stars: 91
- Watchers: 9
- Forks: 39
- Open Issues: 46
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Laravel grid
Live demo: [here](http://laravel-grid.herokuapp.com/)
[](https://travis-ci.org/leantony/laravel-grid)
[](https://packagist.org/packages/leantony/laravel-grid)
[](https://packagist.org/packages/leantony/laravel-grid)
[](https://packagist.org/packages/leantony/laravel-grid)
This package allows rendering of data via a tabular format (grid). The grid uses bootstrap classes to style the `table` elements. Icons used are from `font-awesome`, and most of the functionality is insipred by the yii2's framework's gridview widget.
## Requirements
+ Laravel 5.5+
+ Bootstrap 4 (for the styling)
+ Font awesome (for icons)
+ Jquery (required by bootstrap and the package's javascript)
+ Jquery pjax (quickly view data without having to reload the page). Note that you'll need to [create the middleware on your own](https://gist.github.com/JeffreyWay/8526696b6f29201c4e33)
+ [Date picker](https://github.com/dangrossman/bootstrap-daterangepicker.git) (optional - for the single date & date range filters)
> **Note that from version 2.0.2 onwards, you'll need the package [barryvdh/laravel-dompdf](https://github.com/barryvdh/laravel-dompdf) to export data from the grid as PDF**
# Getting started
## Install
The package is available on packagist. Just run;
```php
composer install leantony/laravel-grid "~2.0"
```
> For bootstrap 3 support, consider installing version `1.0`. Version 1.0 though is pretty not much updated at this point, so may lack some features.
If you can't wait for a release inorder to try any fixes, or the latest features, just run;
```php
composer install leantony/laravel-grid "2.0.x-dev"
```
## Publish assets
The grid comes with a config file, CSS assets, JS assets and view files. The command below should allow you to publish them.
```php
php artisan vendor:publish --provider="Leantony\Grid\Providers\GridServiceProvider"
```
> You can also choose to publish the assets and views separately by passing the `--tag` argument to the command.
For the argument values, try `assets`, `views`, `config` for js|css assets, views and config respectively.
## Add/Customize your layout
Be sure to also include the necessary javascript and css assets on your layout. An example layout is as shown below;
```html
My application
@yield('content')
@include('leantony::modal.container')
// send csrf token (see https://laravel.com/docs/5.6/csrf#csrf-x-csrf-token) - this is required
$.ajaxSetup({
headers: {
'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
}
});
// for the progress bar (required for progress bar functionality)
$(document).on('pjax:start', function () {
NProgress.start();
});
$(document).on('pjax:end', function () {
NProgress.done();
});
@stack('grid_js')
```
## Creating grids
A laravel command is available to make it easy to create grids. It's usage is as shown below;
```php
php artisan make:grid --model="{modelClass}"
```
Just make sure you replace `{modelClass}` with your actual `eloquent` model class. E.g
```php
php artisan make:grid --model="App\User"
```
Once this is run, a grid will be generated. Default namespace for grid generation is `App\Grids`. Once the generation of the grid is done, you can add add it in your controller like this;
```php
class UsersController extends Controller
{
/**
* Display a listing of the resource.
*
* @param UsersGridInterface $usersGrid
* @param Request $request
* @return \Illuminate\Http\Response
*/
public function index(UsersGridInterface $usersGrid, Request $request)
{
// the 'query' argument needs to be an instance of the eloquent query builder
// you can load relationships at this point
return $usersGrid
->create(['query' => User::query(), 'request' => $request])
->renderOn('welcome'); // render the grid on the welcome view
}
}
```
Just make sure that you do not call `->get()` on the query.
If you inject the interface on the controller, just make sure that you add a binding to the service provider. Like this;
```php
/**
* Register any application services.
*
* @return void
*/
public function register()
{
$this->app->bind(UsersGridInterface::class, UsersGrid::class);
}
```
Otherwise, you can also instantiate the grid class like any other class then inject any constructor dependencies you might need.
```php
/**
* Display a listing of the resource.
*
* @param Request $request
* @return \Illuminate\Http\Response
*/
public function index(Request $request)
{
$user = $request->user();
return (new UsersGrid(['user' => $user])) // you can then use it as $this->user within the class. It's set implicitly using the __set() call
->create(['query' => User::query(), 'request' => $request])
->renderOn('welcome');
}
```
If you need to pass extra data to the view specified, you just need to pass the data as arguments, just as you do normally on any other laravel controller;
```php
/**
* Display a listing of the resource.
*
* @param Request $request
* @return \Illuminate\Http\Response
*/
public function index(Request $request)
{
$data = 'hello world';
return (new UsersGrid())
->create(['query' => User::query(), 'request' => $request])
->renderOn('welcome', compact('data'));
}
```
For eloquent relationships, its basically the same approach. Like this;
```php
class UsersController extends Controller
{
/**
* Display a listing of the resource.
*
* @param UsersGridInterface $usersGrid
* @param Request $request
* @return \Illuminate\Http\Response
*/
public function index(UsersGridInterface $usersGrid, Request $request)
{
// load relationships
$query = User::with(['posts', 'activities'])
return $usersGrid
->create(['query' => $query, 'request' => $request])
->renderOn('welcome');
}
}
```
And once again, just make sure that you do not call `->get()` on the query.
## Rendering the grid
To display your grid, simply add this to your view. Or any appropriate variable you passed into the `renderOn` method.
```php
{!! $grid !!}
```
For a quick demonstration, be sure to check out the demo [here](http://laravel-grid.herokuapp.com/). The demo's source code is also [available on github](https://github.com/leantony/laravel-grid-app).
## Updating local JS and CSS assets after package updates
When the package is updated, it is highly likely that you will also need to update the javascript assets. To do that, run this command below after an update;
```php
php artisan vendor:publish --provider="Leantony\Grid\Providers\GridServiceProvider" --tag=assets --force
```
You can also place this command in composer so that it is executed automatically on each update run. Like this;
```php
// ... composer config
"post-autoload-dump": [
"Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
"@php artisan package:discover",
"@php artisan vendor:publish --provider=\"Leantony\\Grid\\Providers\\GridServiceProvider\" --tag=assets --force"
]
```
# Next up
[Rendering the grid](docs/rendering.md)