Merge pull request #68 from gemini1389/master

New settings and Advanced example for ListView

Author: kop

README.md

@@ -55,6 +55,44 @@ echo ListView::widget([
 ]);
 ```
 
+### ListView (Advanced example)
+
+Here you can see how you can use variable `{{ias}}` for events. In this example are added the new settings `linkPager`, `linkPagerOptions` and `linkPagerWrapperTemplate`.
+```php
+echo ListView::widget([
+     'options' => ['class' => 'list-view'],
+     'dataProvider' => $listDataProvider,
+     'itemOptions' => ['tag' => false],
+     'itemView' => '_list_item',
+     'summary' => '',
+     'layout' => '{items}{pager}',
+     'pager' => [
+          'class' => \kop\y2sp\ScrollPager::className(),
+          'item' => 'article',
+          'next' => '.next a',
+          'paginationSelector' => '.list-view .pagination',
+          'triggerText' => Yii::t('app', 'Show more'),
+          'triggerTemplate' => '<span class="reveal-btn">{text}</span>',
+          'noneLeftText' => '',
+          'noneLeftTemplate' => '',
+          'spinnerSrc' => '',
+          'spinnerTemplate' => '',
+          'linkPager'     => [
+               'prevPageCssClass' => 'btn-link prev',
+               'nextPageCssClass' => 'btn-link next',
+               'prevPageLabel' => '<span class="prev-page">prev</span>',
+               'nextPageLabel' => '<span class="next-page">next</span>',
+          ],
+          'linkPagerOptions'     => [
+               'class' => 'pagination',
+          ],
+          'linkPagerWrapperTemplate' => '<div class="button-news-more"><div class="wrapper"><div class="paging">{pager}</div></div></div>',
+          'eventOnPageChange' => 'function() {{{ias}}.hidePagination();}',
+          'eventOnReady' => 'function() {{{ias}}.restorePagination();}',
+     ],
+]);
+```
+
 ### GridView
 
 ```php

ScrollPager.php

@@ -232,6 +232,17 @@ class ScrollPager extends Widget
      */
     public $pagination;
 
+	/**
+	 * @var array The options for yii\widgets\LinkPager.
+	 */
+	public $linkPager = [];
+	public $linkPagerOptions;
+
+	/**
+	 * @var $linkPagerWrapper string Wrapper template for pagination.
+	 */
+	public $linkPagerWrapperTemplate = '{pager}';
+
     /**
      * Initializes the pager.
      */
@@ -262,6 +273,14 @@ public function init()
         if ($this->noneLeftText === null) {
             $this->noneLeftText = Yii::t('kop\y2sp', 'You reached the end');
         }
+
+		// Set default class for pagination
+		if ($this->linkPagerOptions === null) {
+			$this->linkPagerOptions = ['class' => 'pagination hidden'];
+		}
+		elseif (!isset($this->linkPagerOptions['class'])) {
+			$this->linkPagerOptions['class'] = 'pagination hidden';
+		}
     }
 
     /**
@@ -286,7 +305,7 @@ public function run()
         $initString = empty($this->overflowContainer)
             ? "var {$this->id}_ias = jQuery.ias({$pluginSettings});"
             : "var {$this->id}_ias = jQuery('{$this->overflowContainer}').ias({$pluginSettings});";
-        $this->view->registerJs($initString, View::POS_READY, "{$this->id}_ias_main");
+		$this->view->registerJs($initString, View::POS_READY, "{$this->id}_ias_main");
 
         // Register IAS extensions
         $this->registerExtensions([
@@ -338,17 +357,19 @@ public function run()
             'next' => [],
             'ready' => [],
             'pageChange' => [
-                self::EXTENSION_PAGING
+                self::EXTENSION_PAGING,
             ]
         ]);
 
-        // Render pagination links
-        echo LinkPager::widget([
-            'pagination' => $this->pagination,
-            'options' => [
-                'class' => 'pagination hidden'
-            ]
-        ]);
+		// Render pagination links with wrapper
+		echo str_replace(
+			'{pager}',
+			LinkPager::widget([
+				'pagination' => $this->pagination,
+				'options' => $this->linkPagerOptions,
+			] + $this->linkPager),
+			$this->linkPagerWrapperTemplate
+		);
     }
 
     /**
@@ -423,9 +444,12 @@ protected function registerEventHandlers(array $config)
                     );
                 }
 
+				// Replace the variable template
+				$callback = str_replace('{{ias}}', "{$this->id}_ias", $this->$eventName);
+
                 // Register event
                 $this->view->registerJs(
-                    "{$this->id}_ias.on('{$name}', {$this->$eventName});",
+                    "{$this->id}_ias.on('{$name}', {$callback});",
                     View::POS_READY,
                     "{$this->id}_ias_event_{$eventName}"
                 );