Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fedemotta/yii2-widget-datatables
DataTables widget for Yii2
https://github.com/fedemotta/yii2-widget-datatables
Last synced: 11 days ago
JSON representation
DataTables widget for Yii2
- Host: GitHub
- URL: https://github.com/fedemotta/yii2-widget-datatables
- Owner: fedemotta
- License: mit
- Created: 2015-05-20T21:17:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T11:24:45.000Z (over 7 years ago)
- Last Synced: 2024-09-19T11:42:52.569Z (about 2 months ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 35
- Watchers: 7
- Forks: 28
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DataTables widget for Yii2
===========================
This extension provides the [DataTables](https://github.com/DataTables/DataTables) integration for the Yii2 framework.
[](https://packagist.org/packages/fedemotta/yii2-widget-datatables) [](https://packagist.org/packages/fedemotta/yii2-widget-datatables) [](https://packagist.org/packages/fedemotta/yii2-widget-datatables) [](https://packagist.org/packages/fedemotta/yii2-widget-datatables)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
With Composer installed, you can then install the extension using the following commands:
composer global require "fxp/composer-asset-plugin:~1.0.0"
composer require --prefer-dist fedemotta/yii2-widget-datatables "*"
The first command installs the [composer asset plugin](https://github.com/francoispluchino/composer-asset-plugin/)
which allows managing bower and npm package dependencies through Composer. You only need to run this command
once for all. The second command installs the datatables widget.
You can also add (instead of the second command):
```
"fedemotta/yii2-widget-datatables": "*"
```
to the require section of your `composer.json` file.
Usage
-----
Use DataTables as any other other Yii2 widget.
```php
use fedemotta\datatables\DataTables;
```
```php
search(Yii::$app->request->queryParams);
?>
= DataTables::widget([
'dataProvider' => $dataProvider,
'filterModel' => $searchModel,
'columns' => [
['class' => 'yii\grid\SerialColumn'],
//columns
['class' => 'yii\grid\ActionColumn'],
],
]);?>
```
This extension uses the Bootstrap integration plugin to provide a Yii2 style by default.
The TableTools plugin is also available. Specify the DOM and the tableTools settings in the clientOptions array as the following example.
```php
...
'clientOptions' => [
"lengthMenu"=> [[20,-1], [20,Yii::t('app',"All")]],
"info"=>false,
"responsive"=>true,
"dom"=> 'lfTrtip',
"tableTools"=>[
"aButtons"=> [
[
"sExtends"=> "copy",
"sButtonText"=> Yii::t('app',"Copy to clipboard")
],[
"sExtends"=> "csv",
"sButtonText"=> Yii::t('app',"Save to CSV")
],[
"sExtends"=> "xls",
"oSelectorOpts"=> ["page"=> 'current']
],[
"sExtends"=> "pdf",
"sButtonText"=> Yii::t('app',"Save to PDF")
],[
"sExtends"=> "print",
"sButtonText"=> Yii::t('app',"Print")
],
]
]
],
...
```
You can also use DataTables in the JavaScript layer of your application. To achieve this, you need to include DataTables as a dependency of your Asset file. In this case, you could use yii\grid\GridView or using the datatables options retrieve => true to avoid errors. In both case all options must be in the Javascript object.
```php
public $depends = [
...
'fedemotta\datatables\DataTablesAsset',
...
];
```