alkurn/yii2-stepform

Multi step wizard widget using tabs to guide a user through steps to complete a task. Based on the Form wizard (using tabs) from lukepzak (see http://bootsnipp.com/snippets/featured/form-wizard-using-tabs).

Yii2 Step Form

Multi step Step Form using tabs to guide a user through steps to complete a task. Based on the Form wizard (using tabs) from lukepzak (see http://bootsnipp.com/snippets/featured/form-wizard-using-tabs)., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist alkurn/yii2-stepform "*"

or add, _(*4)

"alkurn/yii2-stepform": "*"

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

Stepform configuration

• id: string html id of the Step Form
• steps: array definition of the wizard steps. Array key will be used as the hyperlinks to the steps.

Each step can have the following parameters: - title: string required title of the step (shown when hoovering over step icon) - icon: string required step icon code (see Glyphicon or Font awesome codes) - content: string required HTML content of the step page - skippable: boolean optional allow to skip over a step - buttons: array optional configuration of the buttons per step - complete_content: string optional the HTML content of a complete step - start_step: string optional the starting step when wizard is initialized, _(*6)

In each step four different buttons can be configured (display of a button is dependent on position of the step in the sequence): - prev: (not shown on first step) - next: (not shown on last step) - skip: (shown when skippable is set) - save: (shown on the last step), _(*7)

Each button can be configured with: - title: string optional title as shown in the button - options: array optional of HTML options (see Yii2 HTML helper documentation), _(*8)

or, _(*9)

• html: string optional add your own button definition with HTML code (for example to save data after a step)

Usage

Once the extension is installed, use it in your code like :, _(*10)

 'stepwizard',
    'steps' => [
        1 => [
            'title' => 'Step 1',
            'icon' => 'glyphicon glyphicon-cloud-download',
            'content' => '
Step 1
This is step 1',
            'buttons' => [
                'next' => [
                    'title' => 'Forward', 
                    'options' => [
                        'class' => 'disabled'
                    ],
                 ],
             ],
        ],
        2 => [
            'title' => 'Step 2',
            'icon' => 'glyphicon glyphicon-cloud-upload',
            'content' => '
Step 2
This is step 2',
            'skippable' => true,
        ],
        3 => [
            'title' => 'Step 3',
            'icon' => 'glyphicon glyphicon-transfer',
            'content' => '
Step 3
This is step 3',
        ],
    ],
    'complete_content' => "You are done!", // Optional final screen
    'start_step' => 2, // Optional, start with a specific step
];
?>

= \alkurn\stepform\stepform::widget($wizard_config); ?>