Skip to content

feat(ssr): add ability to set SSR content placeholder #9946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat(ssr): add ability to set SSR content placeholder #9946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/server/create-renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export type RenderOptions = {
clientManifest?: ClientManifest;
serializer?: Function;
runInNewContext?: boolean | 'once';
contentPlaceholder?: string;
};

export function createRenderer ({
Expand All @@ -43,7 +44,8 @@ export function createRenderer ({
shouldPreload,
shouldPrefetch,
clientManifest,
serializer
serializer,
contentPlaceholder
}: RenderOptions = {}): Renderer {
const render = createRenderFunction(modules, directives, isUnaryTag, cache)
const templateRenderer = new TemplateRenderer({
Expand All @@ -52,7 +54,8 @@ export function createRenderer ({
shouldPreload,
shouldPrefetch,
clientManifest,
serializer
serializer,
contentPlaceholder
})

return {
Expand Down
7 changes: 4 additions & 3 deletions src/server/template-renderer/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ type TemplateRendererOptions = {
shouldPreload?: (file: string, type: string) => boolean;
shouldPrefetch?: (file: string, type: string) => boolean;
serializer?: Function;
contentPlaceholder?: string;
};

export type ClientManifest = {
Expand Down Expand Up @@ -55,11 +56,11 @@ export default class TemplateRenderer {
this.inject = options.inject !== false
// if no template option is provided, the renderer is created
// as a utility object for rendering assets like preload links and scripts.
const { template } = options

const { template, contentPlaceholder } = options
this.parsedTemplate = template
? typeof template === 'string'
? parseTemplate(template)
? parseTemplate(template, contentPlaceholder)
: template
: null

Expand Down
20 changes: 20 additions & 0 deletions test/ssr/ssr-template.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import VueSSRClientPlugin from '../../packages/vue-server-renderer/client-plugin
import { createRenderer as createBundleRenderer } from './ssr-bundle-render.spec.js'

const defaultTemplate = `<html><head></head><body><!--vue-ssr-outlet--></body></html>`
const customContentPlaceholderTemplate = `<html><head></head><body><!--vue-app--></body></html>`
const interpolateTemplate = `<html><head><title>{{ title }}</title></head><body><!--vue-ssr-outlet-->{{{ snippet }}}</body></html>`

function generateClientManifest (file, cb) {
Expand Down Expand Up @@ -67,6 +68,25 @@ describe('SSR: template option', () => {
})
})

it('renderToString with custom content placeholder', done => {
const renderer = createRenderer({
template: customContentPlaceholderTemplate,
contentPlaceholder: '<!--vue-app-->'
})

renderer.renderToString(new Vue({
template: '<div>hi</div>'
}), (err, res) => {
expect(err).toBeNull()
expect(res).toContain(
`<html><head></head><body>` +
`<div data-server-rendered="true">hi</div>` +
`</body></html>`
)
done()
})
})

it('renderToString with interpolation', done => {
const renderer = createRenderer({
template: interpolateTemplate
Expand Down