mylistryx/yii2-overlay-scrollbars-asset

Yii2 OverlayScrollbars asset bundle

2.10.1 2024-12-02 20:16 UTC

Requires

• php: >=8.2
• yiisoft/yii2: ~2.0.50

MIT

• Sergey Zhukovskiy

• asset
• bundle
• free
• yii2
• overlay
• scrollbar
• bootstrap5
• overlayscrollbars

README

Based on https://github.com/KingSora/OverlayScrollbars Version of this package is same as plugin version!

Installation

The preferred way to install this extension is through composer

Either run: composer require mylistryx/yii2-overlay-scrollbars-asset or add "mylistryx/yii2-overlay-scrollbars-asset": "~2.0.0" into your composer.json file.

Then register assets in your view file: OverlayScrollbarsAsset::register($this) or OverlayScrollbarsCdnAsset::register($this) to use CDN version.

Add same code in your template:

$JS = <<<JS
const SELECTOR_SIDEBAR_WRAPPER = ".sidebar-wrapper";
const Default = {
    scrollbarTheme: "os-theme-light",
    scrollbarAutoHide: "leave",
    scrollbarClickScroll: true
};
document.addEventListener("DOMContentLoaded", function() {
    const sidebarWrapper = document.querySelector(SELECTOR_SIDEBAR_WRAPPER);
    if (sidebarWrapper && typeof OverlayScrollbarsGlobal?.OverlayScrollbars !== "undefined") {
        OverlayScrollbarsGlobal.OverlayScrollbars(sidebarWrapper, {
            scrollbars: {
                theme: Default.scrollbarTheme,
                autoHide: Default.scrollbarAutoHide,
                clickScroll: Default.scrollbarClickScroll
            },
        });
    }
});
JS;

$this->registerJs($JS, View::POS_END);

See package documentation https://github.com/KingSora/OverlayScrollbars for more options.

Dependencies

This package depends on:

• "php": ">=8.2"
• "yiisoft/yii2": "~2.0.0" base framework files