1. Demo
2. Installation
3. Usage
4. Report
5. License
6. Resources

A library to export server/db data in various formats (e.g. excel, html, pdf, csv etc.) using the PHPExcel library. The widget allows you to configure the dataProvider, columns just like a yii\grid\GridView. However, it just displays the export actions in form of a ButtonDropdown menu, for embedding into any of your GridView or other components.

In addition, with release v1.2.0, the extension also displays a handy grid columns selector for controlling the columns for export. The features available with the column selector are:

• shows a column picker dropdown list to allow selection of columns for export.
• new container property allows you to group the export menu and column selector dropdowns.
• allows configuration of column picker dropdown button through columnSelectorOptions
• auto-generates column labels in the column selector. But you can override displayed column labels for each column key through columnSelector property settings.
• allows preselected columns through selectedColumns (you must set the selected column keys)
• allows columns to be disabled in column selector through disabledColumns (you must set the disabled column keys)
• allows columns to be hidden in column selector through hiddenColumns (you must set the hidden column keys)
• allows columns to be hidden from both export and column selector through noExportColumns (you must set the no export column keys)
• toggle display of the column selector through showColumnSelector property
• column selector is displayed only if asDropdown is set to true.

The extension offers configurable user interfaces for advanced cases using view templates.

• exportFormView allows you to setup your own custom view file for rendering the export form.
• exportColumnsView allows you to setup your own custom view file for rendering the column selector dropdown.

Demo ¶

You can see detailed documentation and demonstration on usage of the extension.

Installation ¶

The preferred way to install this extension is through composer.

Either run:

$ php composer.phar require kartik-v/yii2-export "*"

or add:

"kartik-v/yii2-export": "*"

to the require section of your composer.json file.

Usage ¶

use kartik\export\ExportMenu;
$gridColumns = [
    ['class' => 'yii\grid\SerialColumn'],
    'id',
    'name',
    'color',
    'publish_date',
    'status',
    ['class' => 'yii\grid\ActionColumn'],
];

// Renders a export dropdown menu
echo ExportMenu::widget([
    'dataProvider' => $dataProvider,
    'columns' => $gridColumns
]);

// You can choose to render your own GridView separately
echo \kartik\grid\GridView::widget([
    'dataProvider' => $dataProvider,
    'filterModel' => $searchModel,
    'columns' => $gridColumns
]);

Report ¶

• Report any issues on the project page
• Use the forum page for any discussions on this extension

License ¶

yii2-export is released under the BSD 3-Clause License. See the bundled LICENSE.md for details.

Resources ¶

• Github Project
• Packagist Package
• Documentation & Demo