smladeoye/yii2-dependentinput

Yii 2 Dependent Form Input

dev-master 2017-06-18 10:26 UTC

MIT

• smladeoye

• jquery
• javascript
• form
• widget
• yii2
• dependent
• smladeoye
• dynamic input

README

YII 2 Dependent Form-Input Control Widget

• [Installation] (https://github.com/smladeoye/yii2-dependentinput#installation)
• [Usage] (https://github.com/smladeoye/yii2-dependentinput#usage)

Installation

The preferred way to install this extension is through composer.

Either run

composer require smladeoye/yii2-dependentinput

or

add '"smladeoye/yii2-dependentinput": "1.0.0"' to the require section of your composer.json file, then run:

composer install

Usage

To use the widget, simply call it from your view and pass it the required parameters; Example:

    use smladeoye\dependentinput\DependentInputWidget;

    echo DependentInputWidget::widget(
    [
        // set to true to display the default loader when ajax request is being made
        'displayLoader' => true,

        // settings for the widget dependent element
        // this can be an array containg an array of settings or just one array with the setting
        'options' => [
            [
                // the dependent element type - ("select" or "text")
                'type' => 'select',

                // the dependent element parent/parents id without the #
                // the value can be a string or an array;
                // if it is an array, the array key is used to save the value
                //the value for the below input can be gotten from $_GET['params']['input1']
                'parent' => ['input1' => 'input1'],

                OR

                //the value for the below input can be gotten from $_GET['params'][0]
                // 'parent' => 'input1'

                // the dependent element id without the #
                'child' => 'input2',

                // the url used for the ajax request
                'url' => Url::to(),
            ],
            // another dependent element settings
            [
                'type' => 'text',
                'parent' => ['input2'=>'input2'],
                'child' => 'input3',
                'url' => Url::to(),
                // you can set this value in cases where the dependent is an input and you
                // want to modify some attributes with the gotten result
                'resultAttr' => ['max'],
                // you can also set the element attributes
                'elementAttr' => ['max' => 0, 'value' => 'sweet', 'min' => 0]
            ],
        ],
    ]
    );
?>

The request method used is GET; The controller action is passed a params array as the GET parameter containing all the parent values which can be identified by their respective keys.