Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mickgeek/yii2-actionbar
A control bar with bulk actions for the GridView widget.
https://github.com/mickgeek/yii2-actionbar
bulk-actions grid yii2
Last synced: about 2 months ago
JSON representation
A control bar with bulk actions for the GridView widget.
- Host: GitHub
- URL: https://github.com/mickgeek/yii2-actionbar
- Owner: mickgeek
- License: bsd-3-clause
- Created: 2014-07-15T15:58:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-12T19:53:28.000Z (over 2 years ago)
- Last Synced: 2024-11-18T09:49:51.754Z (about 2 months ago)
- Topics: bulk-actions, grid, yii2
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 34
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
ActionBar
=========
ActionBar is a Yii 2 widget that render the drop-down list for manipulation selected the GridView items and control buttons. The widget permits you to fully customize elements.
Installation
------------
You can install the widget using [Composer]. Just run the following command under your application folder:
```
php composer.phar require --prefer-dist mickgeek/yii2-actionbar
```
Usage
-----
```php
use mickgeek\actionbar\Widget as ActionBar;
= ActionBar::widget([
'grid' => 'user-grid',
]) ?>
```
But first, add the action to your controller:
```php
public function actions()
{
return [
'delete-multiple' => [
'class' => 'mickgeek\actionbar\DeleteMultipleAction',
'modelClass' => 'app\models\User',
],
];
}
```
> Note: You can write your action without using `DeleteMultipleAction` class.
> Tip: For information about properties and methods of the widget, see the bundled `DOCUMENTATION.md`.
Examples
--------
Below are two examples showing some features of the widget.
### Advanced Bulk Actions
The code in the view:
```php
use yii\helpers\Url;
use mickgeek\actionbar\Widget as ActionBar;
= ActionBar::widget([
'grid' => 'user-grid',
'templates' => [
'{bulk-actions}' => ['class' => 'col-xs-4'],
'{create}' => ['class' => 'col-xs-8 text-right'],
],
'bulkActionsItems' => [
'Update Status' => [
'status-active' => 'Active',
'status-blocked' => 'Blocked',
],
'General' => ['general-delete' => 'Delete'],
],
'bulkActionsOptions' => [
'options' => [
'status-active' => [
'url' => Url::toRoute(['update-status', 'status' => 'active']),
'disabled' => !Yii::$app->user->can('updateUserStatus'),
],
'status-blocked' => [
'url' => Url::toRoute(['update-status', 'status' => 'blocked']),
'disabled' => !Yii::$app->user->can('updateUserStatus'),
],
'general-delete' => [
'url' => Url::toRoute('delete-multiple'),
'data-confirm' => 'Are you sure?',
'disabled' => !Yii::$app->user->can('deleteUser'),
],
],
'class' => 'form-control',
],
]) ?>
```
The code in the User controller:
```php
public function actions()
{
return [
'delete-multiple' => [
'class' => 'mickgeek\actionbar\DeleteMultipleAction',
'modelClass' => 'app\models\User',
'beforeDeleteCallback' => function ($action) {
if (!Yii::$app->user->can('deleteOwnAccount', Yii::$app->getRequest()->post('ids'))) {
Yii::$app->getSession()->setFlash('error', 'You cannot delete your own account.');
$action->redirect();
Yii::$app->end();
}
},
'afterDeleteCallback' => function ($action) {
Yii::$app->getSession()->setFlash('success', 'The selected users have been deleted successfully.');
},
],
];
}
public function actionUpdateStatus($status)
{
...
}
```
### Custom Buttons
The code:
```php
use mickgeek\actionbar\Widget as ActionBar;
/* @var $model app\models\User */
= ActionBar::widget([
'templates' => [
'{back}' => ['class' => 'col-xs-4'],
'{update} {delete}' => ['class' => 'col-xs-8 text-right'],
],
'elements' => [
'back' => Html::a(
' ' . 'Back',
['/users/index'],
['class' => 'btn btn-default']
),
'update' => Html::a(
' ' . 'Update',
['/users/update', 'id' => $model->id],
['class' => 'btn btn-default']
),
'delete' => Html::a(
' ' . 'Delete',
['/users/delete', 'id' => $model->id],
['class' => 'btn btn-default']
),
],
]) ?>
```
License
-------
This extension is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.
[Composer]:https://getcomposer.org