Why is mixing Razor Pages and VueJs a bad thing?
Mixing VueJs and Razor Pages is not necessarily a bad thing, it can be great!
I use Vue with razor for non SPA pages and the two work well together. I choose to use Vue by loading it via a script tag from a CDN and and I do not leverage the use of WebPack for transpiling, I simply write my code in (gasp) ES5. I chose this approach for the following reasons.
- Using Razor pages rather than a SPA aids in SEO and search engine ranking of public facing pages.
- Loading Vue directly from a CDN eliminates a whole stack of Webpack centric technology from the learning curve which makes it much easier for new devs to get up to speed on the system.
- The approach still provides the reactive goodness to UI development that Vue inherently brings to the table.
- By keeping with the “page model” the code that delivers site functionality is logically grouped around the backend page that delivers that functionality.
Since Vue and Razor can do many of the same things, my goal for public facing pages is to use Razor to generate as close to the final html as possible, and to use Vue to add the reactiveness to the page. This delivers great SEO benefits for crawlers that index the page by parsing the HTML returned.
I realize the my usage of Vue is quite different than going the route of a SPA and WebPack and the approach often means I can't use 3rd party Vue Components without reworking the code a bit. But the approach simplifies the software architecture and delivers a lightweight reactive UI.
By using this approach Razor can be heavily leveraged to generate the initial rendering of the HTML with some tags containing vue attributes. Then after the page loads in the browser, Vue takes over and can reconfigure that page any way desired.
Obviously, this approach will not fit the needs of all developers or projects but for some use cases it's quite a nice setup.
A few more details for those interested
Since I use vue sitewide, my global _layout.aspx file is responsible for instantiating vue. Any sitewide functionality implemented in vue is implemented at this level. Many pages have page specific vue functionality, this is implemented as a mixin on that page or a mixin in a js file loaded by that page. When the _layout.aspx page instantiates Vue it does so with all the mixins that I have registered to a global mixin array. (The page pushed it's mixin on that global mixin array)
I don’t use .vue files. Any needed components are implemented either directly on the page or if they need to be used by multiple pages then they are implemented in a partial view like the one below.:
dlogViewComponent.cshtml :
@* dlog vue component template*@ <script type="text/x-template" id="dlogTemplate"> <div class="dlog" v-show="dlog.visible" v-on:click="dlog.closeBoxVisible ? close() : ''"> <div class="dlogCell"> <div class="dlogFrame" @@click.stop="" style="max-width:400px"> <i class="icon icon-close-thin-custom dlogCloseIcon" v-if="dlog.closeBoxVisible" @@click="close()"></i> <div class="dlogCloseIconSpace" v-if="dlog.closeBoxVisible"></div> <div class="dlogInner"> <div class="dlogTitle" style="float:left" v-text="title"></div> <div class="clear"></div> <div class="dlogContent"> <slot></slot> </div> </div> </div> </div> </div> </script> @* Vue dlog component *@ <script type="text/javascript"> Vue.component('dlog', { template: '#dlogTemplate', props: { //don't mutate these! closeBoxVisible: true, title: 'One' }, data: function () { return { dlog: { //nest the data props below dlog so I can use same names as cooresponding prop closeBoxVisible: (typeof this.closeBoxVisible === 'undefined') ? true : (this.closeBoxVisible == 'true'), title: (typeof this.title === 'undefined') ? '' : this.title, visible: false } } }, methods: { //opens the dialog open: function () { app.hideBusy(); //just in case, no harm if not busy this.dlog.visible = true; var identifyingClass = this.getIdentifyingClass(); Vue.nextTick(function () { $("." + identifyingClass).addClass("animateIn"); fx.manageDlogOnly(); }); }, //closes the dialog close: function () { fx.prepDlogClose(); var identifyingClass = this.getIdentifyingClass(); this.dlog.visible = false; $("." + identifyingClass).removeClass("animateIn"); }, getIdentifyingClass: function () { if (this.$el.classList.length > 1) { //the last class is always our identifying css class. return this.$el.classList[this.$el.classList.length - 1]; } else { throw "A dialog must have an identifying class assigned to it."; } } } }); </script>In the above, it's the Vue.component('dlog', ... part of the js that installs the component and makes it available to the page.
The vue code on the _layout.cshtml page looks something like the code below. By instantiating Vue on the _layout.cshtml which is used by the whole site, Vue is only instantiated in a single place sitewide:
_layout.cshtml :
<script type="text/javascript"> var app = new Vue({ el: '#appTemplate', mixins: mixinArray, //The page adds it's mixin to mixinArray before this part of the layout executes. data: { errorMsg: '' //used sitewide for error messages //other data used sitewide }, methods: { //methods that need to be available in vue sitewide, examples below: showBusy: function (html) { //functionality to show the user that the site is busy with an ajax request. }, hideBusy: function () { //functionality to hide the busy spinner and messaging } }, created: function () { //this method is particularly useful for initializing data. } });</script>What I have provided here paints a pretty clear picture of this non-traditional approach and it's benefits. However, since several people asked, I also wrote a related blog post: Using VueJs with ASP.NET Razor Can Be Great!
You can do this. Sometimes you're obliged to do it, if, like us, you're migrating an existing code base and you can't convert everything at once. And as Ron C says, it works well.
If you're starting a new project, you have the luxury of choosing. Reasons for favouring an SPA and no Razor would be...
Reactivity. SPA apps generally feel (much) more reactive. Initial renders are often served from cache, before the data arrives. On first load, all resources arrive in a bundle, in one request-response. There's no, or much less, request chaining.
Workflow. Webpack, bundling and hot reloads are great. You get production builds, with minification, compilation of Vue render functions, elimination of 404 style errors, js syntax errors are trapped. The cycle from introducing an error to discovering it is greatly reduced for many errors.
SPA universe. Routing, Vuex, this really is the way of the future.
Purity. Razor and Vue do similar things at the end of the day. If you mix them, you may have a hard time keeping your head straight.
You can now also lint the VueJS templates within the Razor views: