README

Description

SlimScroll is a small (4.6KB) jQuery plugin that transforms any div into a scrollable area with a nice scrollbar - similar to the one Facebook and Google started using in their products recently. slimScroll doesn't occupy any visual space as it only appears on a user initiated mouse-over. User can drag the scrollbar or use mouse-wheel to change the scroll value. For more information please visit SlimScroll.

Requirements

• PHP 7.4 or 8.x
• Yii 2.0
• asset-packagist repository configured in your application's composer.json (standard for Yii2 app templates)

Installation

Install the extension via Composer:

composer require conquer/slimscroll:^2.1

Usage

<?php
use conquer\slimscroll\SlimscrollWidget;
?>

<?php SlimscrollWidget::begin([
    // slimScroll options: https://github.com/rochal/jQuery-slimScroll#options
    'options' => [
        'height' => '250px',
        'color' => '#00f',
        'alwaysVisible' => true,
    ],
    // attributes of the container
    'htmlOptions' => ['class' => 'news'],
    'tag' => 'div',
]); ?>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit...</p>
<?php SlimscrollWidget::end(); ?>

The jQuery slimScroll plugin is no longer developed (last release 1.3.8, 2016). It works with jQuery 3, which Yii 2 uses, but relies on .bind() / .unbind(), removed in jQuery 4.

License

conquer/slimscroll is released under the MIT License. See the bundled LICENSE for details.