yii-ui / yii2-overlay-scrollbars-asset-bundle
Overlay Scrollbars asset bundle for Yii 2.
Requires
- php: ^7.2.5
- npm-asset/overlayscrollbars: ^1.10
- yiisoft/yii2: ^2.0
Requires (Dev)
- roave/security-advisories: dev-master
This package is auto-updated.
Last update: 2022-03-26 19:20:21 UTC
README
This is an Yii framework 2.0 asset bundle of the KingSora OverlayScrollbars plugin.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require yii-ui/yii2-overlay-scrollbars-asset-bundle
or add
"yii-ui/yii2-overlay-scrollbars-asset-bundle": "^1.0"
to the require section of your composer.json
file.
Usage
in your layout file (ex. views/layouts/main.php):
\yiiui\yii2overlayscrollbars\assets\OverlayScrollbarsAsset::register($this);
or as dependency in your app asset bundle:
namespace app\assets;
use yii\web\AssetBundle;
class AppAsset extends AssetBundle
{
public $sourcePath = '@app/assets';
public $js = [
'js/main.js',
];
public $css = [
'css/main.scss',
];
public $depends = [
'yiiui\yii2overlayscrollbars\assets\OverlayScrollbarsAsset'
];
}
See https://www.yii-ui.com/packages/yii2-overlay-scrollbars-asset-bundle for more infos. For plugin configuration see KingSora OverlayScrollbars Documentation.
Documentation
Documentation can be found at https://www.yii-ui.com/packages/yii2-overlay-scrollbars-asset-bundle/docs.
License
yii2-overlay-scrollbars-asset-bundle is released under the MIT License. See the LICENSE for details.