Download the PHP package ysaroka/laravel-grid without Composer

Laravel grid

Live demo: here

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
• Date picker (optional - for the single date & date range filters)

Note that from version 2.0.2 onwards, you'll need the package barryvdh/laravel-dompdf to export data from the grid as PDF

Getting started

Install

The package is available on packagist. Just run;

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;

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.

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;

Creating grids

A laravel command is available to make it easy to create grids. It's usage is as shown below;

Just make sure you replace {modelClass} with your actual eloquent model class. E.g

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;

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;

Otherwise, you can also instantiate the grid class like any other class then inject any constructor dependencies you might need.

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;

For eloquent relationships, its basically the same approach. Like this;

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.

For a quick demonstration, be sure to check out the demo here. The demo's source code is also available on github.

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;

You can also place this command in composer so that it is executed automatically on each update run. Like this;

Next up

Rendering the grid