vue-server-renderer

What is vue-server-renderer?

The vue-server-renderer package is used for server-side rendering (SSR) of Vue.js applications. It allows you to render Vue components on the server and send the HTML to the client, which can improve performance and SEO.

What are vue-server-renderer's main functionalities?

Basic Server-Side Rendering

This feature allows you to render a Vue component to a string on the server. The rendered HTML can then be sent to the client.

const Vue = require('vue');
const renderer = require('vue-server-renderer').createRenderer();

const app = new Vue({
  template: '<div>Hello World</div>'
});

renderer.renderToString(app, (err, html) => {
  if (err) throw err;
  console.log(html); // <div data-server-rendered="true">Hello World</div>
});

Using a Render Context

This feature allows you to pass a context object to the renderer, which can be used to inject additional data into the rendered HTML.

const Vue = require('vue');
const renderer = require('vue-server-renderer').createRenderer();

const app = new Vue({
  template: '<div>{{ message }}</div>',
  data: {
    message: 'Hello World'
  }
});

const context = {
  title: 'My Vue App',
  meta: '<meta charset="utf-8">'
};

renderer.renderToString(app, context, (err, html) => {
  if (err) throw err;
  console.log(html); // <div data-server-rendered="true">Hello World</div>
  console.log(context); // { title: 'My Vue App', meta: '<meta charset="utf-8">' }
});

Streaming Server-Side Rendering

This feature allows you to render a Vue component to a stream, which can be useful for large applications where you want to start sending HTML to the client as soon as possible.

const Vue = require('vue');
const renderer = require('vue-server-renderer').createRenderer();

const app = new Vue({
  template: '<div>Hello World</div>'
});

const stream = renderer.renderToStream(app);

stream.on('data', chunk => {
  process.stdout.write(chunk);
});

stream.on('end', () => {
  console.log('Stream ended');
});

Other packages similar to vue-server-renderer

next

Next.js is a React framework that provides built-in support for server-side rendering. It offers a higher-level abstraction compared to vue-server-renderer, making it easier to set up SSR with features like automatic code splitting, routing, and more.

nuxt

Nuxt.js is a framework for Vue.js that provides server-side rendering out of the box. It simplifies the process of setting up SSR with Vue by offering a higher-level abstraction and additional features like routing, state management, and more.

README

vue-server-renderer

This package is auto-generated. For pull requests please see src/platforms/web/entry-server-renderer.js.

This package offers Node.js server-side rendering for Vue 2.0.

• API Reference
• Vue.js Server-Side Rendering Guide

Changelog

2.7.0-alpha.9 (2022-06-16)

Features

• defineExpose() support (3c2707b)
• directive resolution for <script setup> (aa2b1f4)
• resolve components from <script setup> (4b19339)
• types for <script setup> macros (7173ad4)