uran1980/yii2-pace-widget

An Yii2 widget for automatic web page progress bar.

Yii2 Pace Widget

An Yii2 widget for automatic web page progress bar based on Pace javascript library., _(*1)

What Pace do?

Pace will automatically monitor your ajax requests, event loop lag, document ready state, and elements on your page to decide the progress., _(*2)

On ajax navigation it will begin again!, _(*3)

For more info see: github.hubspot.com/pace., _(*4)

Installation

Composer

The preferred way to install this extension is through Composer., _(*5)

Either run, _(*6)

php composer.phar require uran1980/yii2-pace-widget "dev-master"

or add, _(*7)

"uran1980/yii2-pace-widget": "dev-master"

to the require section of your composer.json, _(*8)

Usage

To activate this widget add this line to you view or layout:, _(*9)

<?php echo uran1980\yii\widgets\pace\Pace::widget(); ?>

Available options: color, theme and paceOptions, for example:, _(*10)

<?php echo uran1980\yii\widgets\pace\Pace::widget([
    'color' => 'green',
    'theme' => 'flash',
]); ?>

or with paceOptions (@see pace documentation for mor info):, _(*11)

<?php echo uran1980\yii\widgets\pace\Pace::widget([
    'color' => 'blue',
    'theme' => 'flash',
    'paceOptions' => [
        'ajax'      => false,
        'document'  => false,
    ],
]); ?>

Author

Ivan Yakovlev, e-mail: uran1980@gmail.com, _(*12)