Using Vue.js in Laravel 5.3

Question

In Laravel projects prior to 5.3 I've utilised Vue.js using the script tag like this:

<script type="text/javascript" src="../js/vue.js"></script>

I would then create a Vue instance specific for that page like this:

<script>
    new Vue({
      el: '#app',
      data: {
        message: 'Hello Vue.js!'
      }
    });
</script>

and then bind it to the relevant div#id in my HTML.

Now, in Laravel 5.3 Vue.js comes bundled and I am fully aware that I can use components as described in the docs by using gulp/elixir, however, my question is if I want to create a Vue.js instance like I just mentioned, i.e. where I create a Vue.js instance strictly for a given page (not a component) how do I do it?

Do I set it up like I used to by importing the vue.js library in a script tag or can I use generated app.js?

Am I not supposed to do it this way, should I be creating components for everything?

For me, it doesn't make sense to make a component for something I am only using once - I thought the purpose of components was that they are reusable - you can use it in more than one place. As mentioned in the Vue.js docs:

Components are one of the most powerful features of Vue.js. They help you extend basic HTML elements to encapsulate reusable code.

Any advice would be appreciated, thanks!

It worths mentioning that php artisan make:auth scaffolds the layout and views which make usage of the bundled "app.js" and "app.scss"... — J. Bruni, Commented Jan 14, 2017 at 0:19

prograhammer · Accepted Answer · 2017-01-27 09:37:22Z

I'd leave Laravel the way it comes, with Webpack. This gives you the ability to add some good Webpack configuration. Plus gulp watch works inside the Homestead vagrant VM now since it will be using Webpack to watch the file changes. And also check out async components.

Now on to your question regarding separate Vue instances per page...let's start with app.js...

App.js
When you first install Laravel 5.3, you'll find an app.js entry point. Let's comment out the main Vue instance:

resources/assets/js/app.js

/**
 * First we will load all of this project's JavaScript dependencies which
 * include Vue and Vue Resource. This gives a great starting point for
 * building robust, powerful web applications using Vue and Laravel.
 */

require('./bootstrap');

/**
 * Next, we will create a fresh Vue application instance and attach it to
 * the page. Then, you may begin adding components to this application
 * or customize the JavaScript scaffolding to fit your unique needs.
 */

Vue.component('example', require('./components/Example.vue'));

// Let's comment this out, each page will be its own main Vue instance.
//
// const app = new Vue({
//     el: '#app'
// });

The app.js file still remains a place to for global stuff, so components added here are available (such as the example component seen above) to any page script that includes it.

Welcome Page Script
Now let's create a script that represents a Welcome Page:

resources/assets/js/pages/welcome.js

require('../app')
import Greeting from '../components/Greeting.vue' 

var app = new Vue({
    name: 'App',
    el: '#app',
    components: { Greeting },
    data: {
        test: 'This is from the welcome page component'
    }
})

Blog Page Script
Now let's create another script that represents a Blog Page:

resources/assets/js/pages/blog.js

require('../app')
import Greeting from '../components/Greeting.vue' 

var app = new Vue({
    name: 'App',
    el: '#app',
    components: { Greeting },
    data: {
        test: 'This is from the blog page component'
    }
})

Greeting Component
resources/assets/js/components/Greeting.vue

<template>
    <div class="greeting">
       {{ message }}
    </div>
</template>

<script>
    export default {
        name: 'Greeting',
        data: () => {
            return {
                message: 'This is greeting component'
            }
        }
    }
</script>

Welcome Blade View
Let's update the welcome blade view that ships with Laravel:

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1">

        <title>Laravel</title>
    </head>
    <body>
        <div id="app">
            <example></example>
            @{{ pageMessage }}
            <greeting></greeting>
        </div>

        <script src="/js/welcome.js"></script>
    </body>
</html>

The idea would be the same for the blog view.

Elixir
Now bring it all together in your gulp file using Elixir's ability to merge Webpack config options with its own (read more about that here):

gulpfile.js

const elixir = require('laravel-elixir');

require('laravel-elixir-vue-2');

/*
 |--------------------------------------------------------------------------
 | Elixir Asset Management
 |--------------------------------------------------------------------------
 |
 | Elixir provides a clean, fluent API for defining some basic Gulp tasks
 | for your Laravel application. By default, we are compiling the Sass
 | file for our application, as well as publishing vendor resources.
 |
 */

elixir(mix => {
    var config =  elixir.webpack.mergeConfig({
          entry: {
            welcome: './resources/assets/js/pages/welcome.js',
            blog: './resources/assets/js/pages/blog.js'
          },
          output: {
            filename: '[name].js' // Template based on keys in entry above
          }
       });

    mix.sass('app.scss')
       .webpack('app.js', null, null, null, config);
});

Run gulp or gulp watch and you'll see both welcome.js and blog.js published.

Thoughts
I'm currently going the SPA route when it comes to "web apps" and just using Laravel as the backend API (or any other language/framework). I've seen some examples where Vue SPA is built in Laravel, but I really think it should be a completely seperate repo/project, independent of the backend. There's no Laravel/PHP templating views involved in an SPA, so build out the SPA separately. BTW, the SPA would have "page" components (which are usually called by VueRouter and of course would be made up of more nested components...see my example project link below).

However, for the "web site" I think Laravel is still a good choice for serving blade views and no need to go SPA for that. You can do what I've described in this answer. Also, you can connect your website to your webapp. On your website, you would have a "login" link that will take a user from the website to the webapp SPA to login. Your website remains SEO friendly (although there is good proof that Google is seeing content on SPA javascript sites as well).

For a look at an SPA approach, I've put up an example in Vue 2.0 here: https://github.com/prograhammer/example-vue-project (it works great, but still in progress).

Edit:

You may want to also checkout the Commons Chunk Plugin. This way browsers can cache some shared module dependencies separately. Webpack automatically can pull out shared imported dependencies and put them in a separate file. So that you have a both a common.js(shared stuff) and a welcome.js on a page. Then on another page you would again have common.js and blog.js and the browser can reuse the cached common.js.

@haakym please mark this as the correct answer. After searching tirelessly for a long time for the correct explanation on how to handle this in 5.3 this is really the only real explanation i have seen. — jacurtis, Commented Nov 17, 2016 at 5:31
@prograhammer Maybe you can help me. Look at this : stackoverflow.com/questions/49664451/… — moses toh, Commented Apr 5, 2018 at 6:11

craig_h · Accepted Answer · 2016-09-28 11:01:19Z

If you want to incorporate vuejs into app.js using gulp then you can do it with elixir:

Firstly, you need laravel-elixir-browserify-official from npm:

npm install laravel-elixir-browserify-official

Then place the following in package.json:

  "browserify": {
    "transform": [
      "vueify",
      "babelify"
    ]
  }

Your resources/assets/js/app.js file would then just need:

  require('./bootstrap');

The bootstrap.js file should be in the "resources/assets/js" folder. I can't remember if this got installed with passport in my application, so if you don't have it then laravel provided the following code for "bootstrap.js":

window._ = require('lodash');

/**
 * We'll load jQuery and the Bootstrap jQuery plugin which provides support
 * for JavaScript based Bootstrap features such as modals and tabs. This
 * code may be modified to fit the specific needs of your application.
 */

window.$ = window.jQuery = require('jquery');
require('bootstrap-sass');

/**
 * Vue is a modern JavaScript library for building interactive web interfaces
 * using reactive data binding and reusable components. Vue's API is clean
 * and simple, leaving you to focus on building your next great project.
 */

window.Vue = require('vue');
require('vue-resource');

/**
 * We'll register a HTTP interceptor to attach the "CSRF" header to each of
 * the outgoing requests issued by this application. The CSRF middleware
 * included with Laravel will automatically verify the header's value.
 */

Vue.http.interceptors.push((request, next) => {
    request.headers['X-CSRF-TOKEN'] = Laravel.csrfToken;

    next();
});

/**
 * Echo exposes an expressive API for subscribing to channels and listening
 * for events that are broadcast by Laravel. Echo and event broadcasting
 * allows your team to easily build robust real-time web applications.
 */

// import Echo from "laravel-echo"

// window.Echo = new Echo({
//     broadcaster: 'pusher',
//     key: 'your-pusher-key'
// });

Now in gulpfile.js you can use:

elixir(function(mix) {
    mix.browserify('app.js');
});

And in your HTML you would have:

...
<div id="app">
  @{{message}}
</div>
...

<script type="text/javascript">
   new Vue({
     el: '#app',
     data: {
       message: 'Hello Vue.js!'
     }
  });
</script>

Now just run gulp

If you are not using elixir then you should be able to do a similar thing with the browserify or webpack packages from npm.

Edit

To answer your updated question, you can of course use vue.js for a single page. I personally use knockout for this stuff (I'm using vue because laravel passport uses it), but architecturally they are the same - they are MVVM libraries.

The point in MVVM is to bind your view to an underlying data model, so when one updates the other is automatically updated (i.e. updates in the dom automatically update the model and vice verser). Vue components are a simple way to reuse blocks of code, which is really good for creating widgets or complex components, but if you are simply looking to render data from a view model on to your page, then you would not usually need to create a component for that.

As for generating app.js, this entirely depends on your project. You cannot bind more than one view model to a view, so if you plan on using multiple view models in your project you would need to find a way to include the specific view model for your page. To achieve that I would probably remove the view model from app.js and keep the bootstrap and registered components there, then create separate view models that would need to be included on each page.

Hi @craig_h thanks for your reply, I've updated my question to make what I am asking a bit clearer. — haakym, Commented Sep 28, 2016 at 8:29
@craig-h thanks for your edit, so if I have understood you correctly you're saying to use app.js for when I need components and if I need a view model for a single page I should drop <script src="../js/vue.js"></script> into the page and carry on as I used to do, is that right? — haakym, Commented Sep 29, 2016 at 8:32
If you use browserify as he outlined, you won't need the script tag. Vue will be available to use as you always have since it will be compiled into app.js. — Trip, Commented Sep 30, 2016 at 5:47
@haakym The important part will be making sure that Vue is properly required, as it is in the provided example bootstrap.js file. If it doesn't work, double-check the compiled app.js file and make sure Vue was correctly compiled in. If it wasn't, keep trying. If it it's there and still not working, it will be much tougher to figure out. — Trip, Commented Sep 30, 2016 at 18:45
@craig_h Maybe you can help me. Look at this : stackoverflow.com/questions/49664451/… — moses toh, Commented Apr 5, 2018 at 6:11

cyberfly · Accepted Answer · 2019-01-25 01:26:05Z

0

If you are on Laravel 5.5 and beyond, here is the best solution if you want to utilize the power of Blade but still enjoy reactive of VueJS

https://stackoverflow.com/a/54349029/417899

edited Jan 25, 2019 at 1:26

answered Jan 24, 2019 at 14:40

cyberfly

5,9089 gold badges53 silver badges70 bronze badges

Add a comment |

Collectives™ on Stack Overflow

Using Vue.js in Laravel 5.3

3 Answers 3

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Linked

Related