Download the PHP package lucianolima00/laravel-grid-view without Composer

Laravel Grid View

Introduction

This package is to displaying the model data in a Grid table.

Requirements

• laravel 5.5+ | 6+ | 7+ | 8+ | 9+ | 10+
• Bootstrap 4 for styling
• JQuery
• php >= 7.1
• composer

Installation

General from remote packagist repository

Run the composer command:

composer require lucianolima00/laravel-grid-view "~1.0.19"

If you are testing this package from a local server directory

In application composer.json file set the repository, as in example:

Here,

../laravel-grid-view - directory path, which has the same directory level as application and contains Grid View package.

Then run command:

composer require lucianolima00/laravel-grid-view:dev-master --prefer-source

Registration

Register service provider in config/app.php

Publish files (Not necessary)

• To publish views run command:

  php artisan grid_view:publish --only=views

  It stores view files to resources/views/vendor/grid_view folder.

• To publish translations run command:

  php artisan grid_view:publish --only=lang

  It stores translation files to resources/lang/vendor/grid_view folder.

• To publish all parts run command without only argument:

  php artisan grid_view:publish

  Else you can use --force argument to rewrite already published files.

Usage

Make sure you use a Bootstrap 4 for styling and JQuery in your application.

Controller part

Must use EloquentDataProvider to insert data in to the view template.

For EloquentDataProvider class constructor use a model query object.

Example:

View template part

Use @gridView() directive with config array in a blade view template.

Simple quick usage

You can simply set columns to display as string format in columnFields array.

Note:

There search filter fields are displayed automatically. By default text form field filters are used.

If you don't want to use search filters, set useFilters = false.

Alternative variant without a blade directive:

Setting custom options

Main columns

Simple example:

Special columns

Besides main columns, there can be the next special columns:

• ActionColumn - is for displaying Buttons to view, edit and delete rows.

  Set 'class' => Lucianolima00\GridView\Columns\ActionColumn::class in column option

  There are the next required actionTypes:

  • view - makes a link for viewing. Default url scheme: url()->current() . '/' . $row->id . '/delete'.
  • edit - makes a link for edition. Default url scheme: url()->current() . '/' . $row->id . '/edit'.
  • delete - makes a link for deletion. Default url scheme: url()->current() . '/' . $row->id . '/delete'.

  They can be simple strings, arrays or callbacks.

  For array format it is necessary set class. And optional: url, htmlAttributes.

  By callback you can change urls to your routes.

  Simple example for a column config:

• CheckboxColumn - is for displaying Checkboxes to multiple choose the rows.

  Set 'class' => Lucianolima00\GridView\Columns\CheckboxColumn::class in column option

  There are the next required options:

  • field - is for a name checkbox input attribute. It is rendered as an array name="{{ $field }}[]".
  • attribute - is for a value checkbox input attribute. It is rendered as: value="$row->{$this->attribute}".

  Simple example for a column config:

Filters

There are the next filter's variants:

• Column option to switch off the filter:

• TextFilter - is a default filter, which renders a text form field to search, using column attribute.

• DropdownFilter - is a filter, which renders <select> html tag.

  Set the next as column option:

  If attribute is not defined for column or you want to set a special filter field name:

Formatters

There are the next formatter keys:

• html - is for passing a row content with html tags.
• image - is for inserting a row data in to src attribute of <img> tag.
• text - applies strip_tags() for a row data.
• url - is for inserting a row data in to href attribute of <a> tag.

For that keys there are the next formatters:

• HtmlFormatter
• ImageFormatter
• TextFormatter
• UrlFormatter

Also you can set formatter with some addition options. See the next simple example:

Existing form areas and main buttons

There are two main form areas:

• grid_view_filters_form

  Two buttons affect search request submission:

  • Search. You can change a button label by option: searchButtonLabel.
  • Reset. You can change a button label by option: resetButtonLabel.

  If useFilters = false, these buttons will not be displayed.

• grid_view_rows_form

  You can set a specific action attribute value by option rowsFormAction.

  One button affect a main submit request:

  • Send. You can change a button label by option: sendButtonLabel.

    Note! This button will be displayed under one of two conditions:

    • There is a checkbox column.
    • Option useSendButtonAnyway = true.

Complex extended example

License

Copyright © 2020-2023 Andrey Girnik [email protected].

Licensed under the MIT license. See LICENSE.txt for details.