ereminmdev/yii2-infinite-scroll

Infinite ajax scroll widget for Yii framework.

v1.0.7 2024-04-28 14:25 UTC

Requires

• php: >=7.4
• webcreate/jquery-ias: ^2.2
• yiisoft/yii2: ~2.0.1

MIT

• Michael Eremin

• javascript
• pager
• pagination
• widget
• yii2

README

Infinite Ajax Scroll widget.

Based on jQuery plugin: https://infiniteajaxscroll.com

Install

composer require --prefer-dist ereminmdev/yii2-infinite-scroll

Documentation

See for clientOptions: https://infiniteajaxscroll.com/docs/options.html

Use

Add as pager component:

echo ListView::widget([
     'dataProvider' => $dataProvider,
     'itemOptions' => ['class' => 'item'],
     'pager' => ['class' => \ereminmdev\yii2\infinite_scroll\InfiniteScroll::class]
]);

or insert as widget into view:

<div class="pagination">
    <?= InfiniteScroll::widget([
        'pagination' => $dataProvider->getPagination(),
        'clientOptions' => [
            'container' => '.items',
            'item' => '.item',
            'pagination' => '.pagination',
        ],
        'clientExtensions' => [
            InfiniteScroll::EXT_TRIGGER => [
                'offset' => 0,
                'text' => Yii::t('app', 'Load more...'),
                'html' => '<div class="ias-trigger ias-trigger-next"><a class="btn btn-default">{text}</a></div>',
                'textPrev' => Yii::t('app', 'Load previous...'),
                'htmlPrev' => '<div class="ias-trigger ias-trigger-prev"><a class="btn btn-default">{text}</a></div>',
            ],
            InfiniteScroll::EXT_SPINNER => [
                'html' => '<div class="ias-spinner"><i class="fa fa-refresh fa-spin fa-lg"></i></div>',
            ],
            InfiniteScroll::EXT_NONE_LEFT => [
                'html' => 'You reached the end.',
            ],
        ],
        'clientEvents' => [
            'rendered' => new \yii\web\JsExpression('function() { console.log("on rendered"); }'),
        ],
    ]) ?>
</div>

When updating content throw ajax, don't forget to reinitialize plugin:

$(document).on('click', '#sample_filter', function (event) {
    $('.list-view').load('sample_url', function () {
        //reinitialize plugin after load success
        jQuery.ias().reinitialize();
    });
    event.preventDefault();
});