richardfan1126/yii2-js-register

Yii2 widget to register JS into view

yii2-js-register

, _(*1)

Yii2 widget to register JS into view, _(*2)

Why do I need this?

How to register JS script into view in Yii2?

In Yii2, the way to register JS script into view is using \yii\web\View::registerJS(),, _(*3)

For example, if you want to initialize a jQuery plugin, you do:, _(*4)

// in view file




  

    

      

        
Hello World!, (*5)

      
    
  




registerJS('$(".modal").modal({backdrop:"static",keyboard:"false"})');
?>

Obviously, this is a very bad way because:, _(*6)

1. Hard to read for human
2. Hard to read for you editor (Means no syntax coloring for the JS code)
3. You have to handle the single / double quote

This widget help you register JS script in Yii just as you write script block directly into HTML!, _(*7)

Getting Started

Installing

Install with Composer:, _(*8)

composer require richardfan1126/yii2-js-register "*"

or, _(*9)

php composer.phar require richardfan1126/yii2-js-register "*"

or add, _(*10)

"richardfan1126/yii2-js-register":"*"

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

How to use

In your view file, wrap your JS script with <script> tag, and wrap all the things with this widget., _(*12)

example:, _(*13)

// in view file

use richardfan\widget\JSRegister;




  

    

      

        
Hello World!, (*14)
      
    
  

IMPORTANT Remember not to add anything out of the <script> block., _(*15)

Configurations

There are 2 configurations for this widget, which are the parameters passed into \yii\web\View::registerJS() method. example:, _(*16)

<?php JSRegister::begin([
    'key' => 'bootstrap-modal',
    'position' => \yii\web\View::POS_READY
]); ?>
<script>
    // JS script
</script>
<?php JSRegister::end(); ?>

• key (optional)The key that identifies the JS code block. If null, it will use $js as the key. If two JS code blocks are registered with the same key, the latter will overwrite the former. Default to null
• position (optional) The position at which the JS script tag should be inserted in a page. Default to \yii\web\View::POS_READY