Download the PHP package pozitronik/yii2-grid-config without Composer
On this page you can find all versions of the php package pozitronik/yii2-grid-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pozitronik/yii2-grid-config
More information about pozitronik/yii2-grid-config
Files in pozitronik/yii2-grid-config
Package yii2-grid-config
Short Description Configurable grids for YII2
License GPL-3.0-or-later
Informations about the package yii2-grid-config
GridConfig
Конфигурирование GridView с сохранением настроек каждого пользователя.
Installation
The preferred way to install this extension is through composer.
Run
or add
to the require section of your composer.json
file.
Requirements
Yii2, PHP >= 7.4.0
Описание и использование
Идея модуля в том, чтобы позволить в рантайме конфигурировать любой экземпляр GridView, сохранить конфигурацию и применить её при следующем рендере GridView. Это достигается тем, что вместо
вызывается
а модуль инжектирует в GridView панель конфигурации и всю обвязку.
Для того, чтобы связать сохраняемые настройки с определённым GridView, потребуется вручную задать
идентификатор виджету. Это можно сделать, определив параметр id
либо для GridView, либо для GridConfig:
Этого достаточно, чтобы всё заработало.
Настраивать можно набор скрытых/отображаемых колонок, их порядок, пажинацию (количество отображаемых на одной странице записей), наличие плавающего заголовка и плавающего блока с основной информации (если это поддерживает класс GridView).
Поддерживаются как yii\grid\GridView
, так и все наследуемые расширения, в т.ч. kartik\grid\GridView
.
Версии Bootstrap
Модуль поддерживает Bootstrap третьей (по умолчанию) и четвёртой версий. Переключение между версиями задаётся
через параметр Yii::$app->params->bsVersion
.
Конфигурация
Для хранения персональных настроек модуль опирается на расширение pozitronik/yii2-users-options. После установки может потребоваться конфигурация этого расширения согласно документации и применение миграции:
yii migrate --migrationPath=@vendor/pozitronik/yii2-users-options/migrations
Конфигурация модуля GridConfig в базовом случае сводится к его подключению в web.php:
Другие настройки модуля:
Порядок применения настроек грида, по увеличению приоритета:
- Глобальные настройки из
defaultGridParams
, - Параметры, переданные при вызове виджета,
- Установленные пользователем настройки.
включит фильтрацию по изменению фокуса для всех вызовов GridConfig. Переданный
параметр 'filterOnFocusOut' => false
имеет больший приоритет, и перекроет глобальную настройку. Настройка, которую установит себе пользователь имеет самый высший приоритет.
Плавающий заголовок:
При включении плавающего заголовка или плавающего блока с основной информацией (если это поддерживает класс GridView) автоматически задается высота блока в свойстве грида containerOptions. Значение можно переопределить.
Изменение layout GridView
Для базового yii\grid\GridView
модуль модифицирует свойство $layout, добавляя к нему отрендеренную кнопку
вызова модального окна с настройками. Её расположение изменить нельзя.
Для kartik\grid\GridView
модуль добавляет тег {options}, при рендеринге виджета заменяемый на кнопку вызова
модального окна с настройками. Этот тег можно использовать в свойстве $layout стандартным способом. По
умолчанию он добавляется к $layout автоматически.
All versions of yii2-grid-config with dependencies
pozitronik/yii2-users-options Version ^2.0.0
pozitronik/yii2-traits Version ^1.0.0
kartik-v/yii2-sortable Version dev-master
kartik-v/yii2-widget-switchinput Version dev-master