egg-view-vue-ssr
Vue Server Side Render Plugin for Egg.
Feature
- Support Vue Server Side Render Mode And Vue Client Render Mode
- Support Asset Render Layout by Nunjucks Or ejs Enigne
- Support Vue Server Side Render Error, Auto Try Client Render
- Support Static Resouce Auto Inject to Html
Install
$ npm i egg-view-vue-ssr --save
Document
https://www.yuque.com/easy-team/egg-vue
Usage
// {app_root}/config/plugin.jsexportsvuessr = enable: true package: 'egg-view-vue-ssr';
Configuration
// {app_root}/config/config.default.jsexportsvuessr = // layout: path.join(app.baseDir, 'app/view/layout.html'), // manifest: path.join(app.baseDir, 'config/manifest.json'), // injectCss: true, // injectJs: true, // fallbackToClient: true, // fallback to client rendering after server rendering failed // afterRender: (html, ctx) => { // return html; // },;
- doctype: {String} html content will auto add
<!doctype html>
, you can setdoctype: ''
- layout: {String} client render template, support renderString compile
- manifest: {Object} static resource dependence, the content such as:
- injectCss: {Boolean} whether inject href css, default true
- injectJs: {Boolean} whether inject src script, default true
- injectRes: {Boolean} inline/inject css or js to file head or body. include location and src config inline {Boolean} true or false, default false location {String} headBefore, headAfter, bodyBefore, bodyAfter insert location, default headBefore url {String} inline file absolution path
- viewEngine egg-view render engine, only valid when renderAsset rendering,default nunjucks
- mergeLocals {Boolean} whether merge ctx locals to data, default true
- crossorigin: {Boolean} js cross domain support for cdn js error catch, default false
- fallbackToClient: {Boolean} fallback to client rendering if server render failed, default true
- cache: lru-cache options @see https://www.npmjs.com/package/lru-cache
- renderOptions: @see https://ssr.vuejs.org/en/api.html#renderer-options
- afterRender: afterRender hook html after render
Render
render
Server Render, Call when server render bundle error, will try client render**
// controller/home.jsexports { ctx;};
renderToHtml
Server Render, Call when server render bundle error, will try client render**
// controller/home.jsexports { const html = ctx; // you can process html ctxbody = html;};
renderClient
, Use Vue render layout
Client Render, Call when client render, render layout
exports.vuessr.layout
by Vue
// controller/home.jsexports { ctx;};
renderAsset
, Use render layout by viewEngine, default nunjucks
Asset Render, Call - when asset render, you can render layout
exports.vuessr.layout
by viewEngine, default useegg-view-nunjucks
- you must install the specified engine dependence, such as
egg-view-nunjucks
oregg-view-ejs
- The context provides an
asset
object that can getjs
,css
,state
information. layout template
use default viewEngine nunjucks
// controller/home.jsexports { ctx;};
scope render viewEngine config
// controller/home.jsexports { ctx;};
- see config/config.default.js for more detail.
- see egg-vue-asset-boilerplate examples
Questions & Suggestions
Please open an issue here.