jhoff/blade-vue-directive

Vue directive for Laravel Blade

2.2.0 2020-10-07 13:32 UTC

Requires

• php: >=7.0
• laravel/framework: ^5.4|^6.0|^7.0|^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.13|^2.16
• mockery/mockery: ^1.0|^1.3.1
• orchestra/testbench: ^4.0|^6.0
• phpmd/phpmd: ^2.6
• phpunit/phpunit: ^8.0|^9.3
• squizlabs/php_codesniffer: ^2.9|^3.5
• two-thirds/artisan-anywhere: ^1.2
• two-thirds/laravel-test-suite: ^4.1

MIT

• Jordan Hoff

• laravel
• blade
• Vue.js

README

Laravel Blade Vue Directive provides blade directives for vue.js single file and inline template components.

• Upgrade from 1.1.x to 2.0.0
• Installation
• Usage
  • Basic Example
  • Scalars Example
  • Booleans and Numbers Example
  • Objects and Arrays Example
  • camelCase to kebab-case
  • Using compact to pass variables directly through

Upgrade from 1.1.x to 2.0.0

In 2.0, the @vue and @endvue directives have been renamed to @inlinevue and @endinlinevue. The new @vue and @endvue directives should now be used for non-inline components.

WARNING: You'll need to make sure that you run php artisan view:clear after upgrading

Installation

To install the Laravel Blade Vue Directive, simply run composer require jhoff/blade-vue-directive in a terminal, or if you prefer to manually install you can the following in your composer.json file and then run composer install from the terminal:

{
    "require": {
        "jhoff/blade-vue-directive": "2.*"
    }
}

For Laravel 5.5 and later, the package will automatically register. If you're using Laravel before 5.5, then you need to add the provider to the providers array of config/app.php.

  'providers' => [
    // ...
    Jhoff\BladeVue\DirectiveServiceProvider::class,
    // ...
  ],

Usage

The Laravel Blade Vue Directive was written to be simple and intuitive to use. It's not opinionated about how you use your vue.js components. Simply provide a component name and (optionally) an associative array of properties.

Basic Example

Using the vue directive with no arguments in your blade file

    @vue('my-component')
        <div>Some optional slot content</div>
    @endvue

Renders in html as

    <component v-cloak is="my-component">
        <div>Some optional slot content</div>
    </component>

Note that the contents between the start and end tag are optional and will be provided as slot contents. To use an inline-template, use the @inlinevue directive instead:

    @inlinevue('my-component')
        <div>Some inline template content</div>
    @endinlinevue

Renders in html as

    <component inline-template v-cloak is="my-component">
        <div>Some inline template content</div>
    </component>

Scalars Example

Using the vue directive with an associative array as the second argument will automatically translate into native properties that you can use within your vue.js components.

    @vue('page-title', ['title' => 'Welcome to my page'])
        <h1>@{{ title }}</h1>
    @endvue

Renders in html as

    <component v-cloak is="page-title" title="Welcome to my page">
        <h1>{{ title }}</h1>
    </component>

Then, to use the properties in your vue.js component, add them to props in your component definition. See Component::props for more information.

    Vue.component('page-title', {
        props: ['title']
    });

Booleans and Numbers Example

Properties that are booleans or numeric will be bound automatically as well

    @vue('report-viewer', ['show' => true, 'report' => 8675309])
        <h1 v-if="show">Report #@{{ report }}</h1>
    @endvue

Renders in html as

    <component v-cloak is="report-viewer" :show="true" :report="8675309">
        <h1 v-if="show">Report #{{ report }}</h1>
    </component>

Objects and Arrays Example

The vue directive will automatically handle any objects or arrays to make sure that vue.js can interact with them without any additional effort.

    @vue('welcome-header', ['user' => (object)['name' => 'Jordan Hoff']])
        <h2>Welcome @{{ user.name }}!</h2>
    @endvue

Renders in html as

    <component v-cloak is="welcome-header" :user="{&quot;name&quot;:&quot;Jordan Hoff&quot;}">
        <h2>Welcome {{ user.name }}!</h2>
    </component>

Notice that the object is json encoded, html escaped and the property is prepended with : to ensure that vue will bind the value as data.

To use an object property in your component, make sure to make it an Object type:

    Vue.component('welcome-header', {
        props: {
            user: {
                type: Object
            }
        }
    });

camelCase to kebab-case

If you provide camel cased property names, they will automatically be converted to kebab case for you. This is especially useful since vue.js will still work with camelCase variable names.

    @vue('camel-to-kebab', ['camelCasedVariable' => 'value']])
        <div>You can still use it in camelCase see :) @{{ camelCasedVariable }}!</div>
    @endvue

Renders in html as

    <component inline-template v-cloak is="camel-to-kebab" camel-cased-variable="value">
        <div>You can still use it in camelCase see :) {{ camelCasedVariable }}!</div>
    </component>

Just make sure that it's still camelCased in the component props definition:

    Vue.component('camel-to-kebab', {
        props: ['camelCasedVariable']
    });

Using compact to pass variables directly through

Just like when you render a view from a controller, you can use compact to pass a complex set of variables directly through to vue:

    <?php list($one, $two, $three) = ['one', 'two', 'three']; ?>
    @vue('compact-variables', compact('one', 'two', 'three'))
        <div>Variables are passed through by name: @{{ one }}, @{{ two }}, @{{ three }}.</div>
    @endvue

Renders in html as

    <component inline-template v-cloak is="compact-variables" one="one" two="two" three="three">
        <div>Variables are passed through by name: {{ one }}, {{ two }}, {{ three }}.</div>
    </component>

Then in vue, make sure to define all of your properties:

    Vue.component('compact-variables', {
        props: ['one', 'two', 'three']
    });