spatie/laravel-blade-javascript

A Blade directive to export variables to JavaScript

A Blade directive to export variables to JavaScript

, _(*1)

This package contains a Blade directive to export values to JavaScript., _(*2)

Here's an example of how it can be used:, _(*3)

@javascript('key', 'value')

The rendered view will output:, _(*4)

<script>window['key'] = 'value';</script>

So in your browser you now have access to a key variable:, _(*5)

console.log(key); //outputs "value"

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., _(*6)

Support us

, _(*7)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*8)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*9)

Installation

You can install the package via composer:, _(*10)

``` bash composer require spatie/laravel-blade-javascript, <sub>(*11)</sub>

The package will automatically register itself.

Optionally the config file can be published with

```bash
php artisan vendor:publish --provider="Spatie\BladeJavaScript\BladeJavaScriptServiceProvider" --tag="config"

This is the contents of the published config file:, <sub>(*12)</sub>

return [

    /**
     * All passed values will be present in this JavaScript namespace. Set this to an empty string
     * to use the window object.
     */
    'namespace' => '',
];

If you want to customize the generated <script> tag you can publish and override the used view., <sub>(*13)</sub>

php artisan vendor:publish --provider="Spatie\BladeJavaScript\BladeJavaScriptServiceProvider" --tag="views"

After this you can edit the published view resources/views/vendor/bladeJavaScript/index.blade.php. This is usefull to add the type or a CSP nonce., <sub>(*14)</sub>

Usage

With the package installed you can make use of a @javascript Blade directive., <sub>(*15)</sub>

@javascript('key', 'value')

The rendered view will output:, <sub>(*16)</sub>

<script>key = 'value';</script>

You can also use a single argument:, <sub>(*17)</sub>

@javascript(['key' => 'value'])

This will also output:, <sub>(*18)</sub>

<script>key = 'value';</script>

When setting the namespace to eg js in the config file this will be the output:, <sub>(*19)</sub>

<script>window['js'] = window['js'] || {};js['key'] = 'value';</script>

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*20)</sub>

Testing

bash composer test, <sub>(*21)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*22)</sub>

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., <sub>(*23)</sub>

Credits

• Freek Van der Herten
• Sebastian De Deyne
• All Contributors

This repository contains some code from the laracasts/PHP-Vars-To-Js-Transformer package written by Jeffrey Way., <sub>(*24)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*25)</sub>