Skip to content
Nuxt module for SSR without rehydration payload
JavaScript Vue
Branch: master
Clone or download
Latest commit 230355f Jul 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example initial commit Jul 6, 2019
src update readme, bump: 0.0.4 Jul 20, 2019
.eslintrc initial commit Jul 6, 2019
.gitignore initial commit Jul 6, 2019
README.md update readme Jul 20, 2019
package.json update readme, bump: 0.0.4 Jul 20, 2019
rollup.config.js bump: 0.0.3 Jul 6, 2019

README.md

nuxt-static-render

Nuxt's asyncData comes at a cost: the embedded __NUXT__ payload.

What if you could render some markup on the server and not hydrate it on the client? You'd get a dead component: unable to properly update (re-render) on the client-side following data updates. Even worse: you'd get a node mismatch error, since the client wouldn't have the actual data to rerender it.

Sometimes though, a dead component is exactly what you need: say you're just fetching data on the server to render some content, but won't ever update this fragment on the client-side.

nuxt-static-render gives you that functionality with some caveats.

Install with:

npm install nuxt-static-render --save

Add to your Nuxt project via modules:

export default {
  modules: ['nuxt-static-render']
}

Usage

Simply wrap your dead markup fragments in <nuxt-static-render> anywhere on the page, as many times as needed.

Use $staticData to access the static rendering data. It is automatically populated on the server by the serverData() handler, which you can add to any Nuxt page. From the included example:

<template>
  <div class="wrapper">
    <nuxt-static-render class="top">
      <div>{{ $staticData.foobar }}</div>
    </nuxt-static-render>
    <div class="bottom" @click="counter++">
      <div>
        <p>This component should remain operational.<p>
        <p>Here's a counter: {{ counter }}. Click to increment.</p>
      </div>
    </div>
  </div>
</template>

<script>
export default {
  serverData() {
    return {
      foobar: 'This should not be in __NUXT__'
    }
  },
  asyncData() {
    return {
      counter: 1
    }
  }
}
</script>

The top div, rendered with <nuxt-static-render> should have markup based on $staticData.foobar, which is only populated on the server and is not added to the __NUXT__ payload. That means this data will only be used on the server to render markup and immediately discarded.

Why not call it $serverData instead of $staticData? Because it's static data populated via the serverData() function. The same data object ($staticData) can also be populated via clientData(), so it made more sense to use $staticData for the data object.

Caveats

If you tried to do this:

<nuxt-static-render class="top">
  <div>{{ $staticData.obj.foobar }}</div>
</nuxt-static-render>

It would result in the following error:

error-shot

Because in the first template compiler run, obj does not exist yet. In this implementation, data for static rendering must be readily available in $staticData. If you know how to circumvent this limitation, let me know. Yes, I tried v-once but it appears to requires hydration data to be available on the client-side for at least one render. cc @yyx990803 :)

Advanced

Say you have a huge chunk of markup that needs to be server-rendered for SEO, but you don't want a massive __NUXT__ payload to go with it. Still, once that markup is rendered on the client, you have bits of it that need hydration so they can continue to be updated on the client. For this specific case, you can provide clientData():

export default {
  serverData() {
    // This is used to instantly render the fragments
    // on the server and deliver ready-for-display markup
    return {
      foobar: 'This should not be in __NUXT__'
    }
  },
  clientData() {
    // This is loaded asynchronously post-mount, i.e.,
    // server-side content is immediately displayed while
    // the page silently hydrates and gets ready for 
    // further dynamic updates on the client
    return {
      foobar: 'This should not be in __NUXT__'
    }
  }
}

In this usage, you can also define:

export default {
  clientDataLoaded(data) {
  }
}

As a way of knowing when the data has been fully hydrated on the client.

Use this feature only if you absolutely must avoid __NUXT__-based hydration due to exceptionally large content.

Kudos

To Markus Oberlehner for vue-lazy-hydration, which served as inspiration for this module. The asyncFactory render() hack is mainly what makes this possible at all.

You can’t perform that action at this time.