Yii2 Submit Spinner ¶

1. Installation
2. Required
3. Options
4. Usage
5. Comments / Suggestions

Updated August, 2015

New additions, see "Usage"

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-source "c006/yii2-submit-spinner" "*"

or add

"c006/yii2-submit-spinner": "*"

to the require section of your composer.json file.

Required ¶

• jQuery

• yii \ widgets \ ActiveForm

    <?php $form = ActiveForm::begin(['id'=>'form-submit'] ); ?>

Options ¶

class_id => {string}
The ID of the container. default: "SubmitSpinner"

form_id => {string}
The ID of the form

bg_color => {string}
Color of the overlay

bg_opacity => {float}
Opacity of the overlay

spin_speed => {int}
How many seconds a for a complete 360 rotation

radius => {int}
Pixel radius/width of the spinner

bg_spinner_opacity => {float}
Opacity of main spinner

bg_spinner_color => {string}
Color of main spinner

sections => {int}
How many dots or circles

section_size => {int}
Dot/circle size in px

section_color => {string}
Color of dots/circles

section_offset => {int}
How far from the center in px

section_opacity_base => {float}
Minimum opacity e.g. 0.25

proportionate_increase => {boolean}
Will increase/decrease dots proportionally to the main spinner

Usage ¶

Demo: http://demo.c006.us

Added javascript functions

• show_submit_spinner()

• hide_submit_spinner()

Once the extension is installed, simply use it in your code by :

Defaults option:

    <?= \c006\spinner\SubmitSpinner::widget(); ?>

All options: (using defaults)

    <?=
        c006\spinner\SubmitSpinner::widget(
                               [
                                   'bg_color'               => '#444444',
                                   'bg_opacity'             => 0.8,
                                   'spin_speed'             => 4,
                                   'radius'                 => 200,
                                   'bg_spinner_opacity'     => 0.5,
                                   'bg_spinner_color'       => '#000000',
                                   'sections'               => 15,
                                   'section_size'           => 20,
                                   'section_color'          => '#FFFFFF',
                                   'section_offset'         => 80,
                                   'section_opacity_base'   => .2,
                                   'proportionate_increase' => 1,
                               ]
        ) ?>

All options: (5 large dots only, no background spinner)

    <?= c006\spinner\SubmitSpinner::widget(
                                  [
                                      'bg_color'               => '#333333',
                                      'bg_opacity'             => 0.8,
                                      'spin_speed'             => 4,
                                      'radius'                 => 250,
                                      'bg_spinner_opacity'     => 0.0,
                                      'bg_spinner_color'       => '#000000',
                                      'sections'               => 5,
                                      'section_size'           => 80,
                                      'section_color'          => '#FFFFFF',
                                      'section_offset'         => 80,
                                      'section_opacity_base'   => .2,
                                      'proportionate_increase' => 0,
                                  ]
           ) ?>

Comments / Suggestions ¶

Please provide any helpful feedback or requests.

Thanks.