Tutorial

Hide SSR-Incapable Vue Components with vue-no-ssr

Published on June 11, 2017
author

Joshua Bemenderfer

Hide SSR-Incapable Vue Components with vue-no-ssr

While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

The prolific egoist is at it again with his latest super-useful, extra-tiny Vue.js utility. vue-no-ssr keeps Vue from attempting to render components on the server that don’t work there, while allowing them to keep rendering on the client.

I’ve actually run into this sort of issue more than once, and came up with a few hacks and awkward solutions around it. vue-no-ssr is a significant improvement and is incredibly easy to use, as shown below.

Installation

Install vue-no-ssr via Yarn or NPM.

# Yarn
$ yarn add vue-no-ssr

# NPM
$ npm install vue-no-ssr --save

Usage

Now, just wrap any component that doesn’t work on the server with a no-ssr component.

<template>
  <div>
    <server-component>I work fine on the server!</server-component>
    <no-ssr placeholder="You can even add a placeholder to be rendered instead!">
      <client-component>I only work on the client. :( </client-component>
    </no-ssr>
  </div>
</template>

<script>
import NoSSR from 'vue-no-ssr';

export default {
  components: {
    'no-ssr': NoSSR
  }
}
</script>

Now, the server won’t even attempt to render client-component, but it will render on the client. Easy-peasy!

The code for vue-no-ssr itself is itty-bitty (< 500B). Basically all it does it avoid rendering the child component until the mounted() hook is called. Since the mounted() hook doesn’t get called during SSR, the rendering of the child component won’t happen until it’s rendered on the client. How’s that for an elegant solution?

Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.

Learn more about our products


About the authors
Default avatar
Joshua Bemenderfer

author

Still looking for an answer?

Ask a questionSearch for more help

Was this helpful?
 
Leave a comment


This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Try DigitalOcean for free

Click below to sign up and get $200 of credit to try our products over 60 days!

Sign up

Join the Tech Talk
Success! Thank you! Please check your email for further details.

Please complete your information!

Featured on Community

Get our biweekly newsletter

Sign up for Infrastructure as a Newsletter.

Hollie's Hub for Good

Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.

Become a contributor

Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.

Welcome to the developer cloud

DigitalOcean makes it simple to launch in the cloud and scale up as you grow — whether you're running one virtual machine or ten thousand.

Learn more
DigitalOcean Cloud Control Panel