vue server side render solution for egg
npm install egg-view-vue-ssr[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-view-vue-ssr.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-view-vue-ssr
[travis-image]: https://img.shields.io/travis/hubcarl/egg-view-vue-ssr.svg?style=flat-square
[travis-url]: https://travis-ci.org/hubcarl/egg-view-vue-ssr
[codecov-image]: https://img.shields.io/codecov/c/github/hubcarl/egg-view-vue-ssr.svg?style=flat-square
[codecov-url]: https://codecov.io/github/hubcarl/egg-view-vue-ssr?branch=master
[david-image]: https://img.shields.io/david/hubcarl/egg-view-vue-ssr.svg?style=flat-square
[david-url]: https://david-dm.org/hubcarl/egg-view-vue-ssr
[snyk-image]: https://snyk.io/test/npm/egg-view-vue-ssr/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-view-vue-ssr
[download-image]: https://img.shields.io/npm/dm/egg-view-vue-ssr.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-view-vue-ssr
Vue Server Side Render Plugin for Egg.
- 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
``bash`
$ npm i egg-view-vue-ssr --save
https://www.yuque.com/easy-team/egg-vue
`js`
// {app_root}/config/plugin.js
exports.vuessr = {
enable: true,
package: 'egg-view-vue-ssr',
};
`js`
// {app_root}/config/config.default.js
exports.vuessr = {
// 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 , you can set doctype: ''
- layout: {String} client render template, support renderString compile
- manifest: {Object} static resource dependence, the content such as:
`json`
{
"app/app.js": "/public/js/app/app.js",
"vendor.js": "/public/js/vendor.js",
"deps": {
"app/app.js": {
"js": [
"/public/js/vendor.js",
"/public/js/app/app.js"
],
"css": [
"/public/css/vendor.css",
"/public/css/app.css"
]
}
}
}
- 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
> when server render bundle error, will try client render**
> https://www.yuque.com/easy-team/egg-vue/node
`js`
// controller/home.js
exports.index = function* (ctx) {
yield ctx.render('index/index.js', { message: 'egg vue server side render'});
};
> when server render bundle error, will try client render**
> https://www.yuque.com/easy-team/egg-vue/node
`js`
// controller/home.js
exports.index = function* (ctx) {
const html = yield ctx.renderToHtml('index/index.js', { message: 'egg vue server side render'});
// you can process html
ctx.body = html;
};
> https://www.yuque.com/easy-team/egg-vue/web
> when client render, render layout exports.vuessr.layout by Vue
`js`
// controller/home.js
exports.client = function* (ctx) {
yield ctx.renderClient('index/index.js',{ message: 'egg vue client render'});
};
> https://www.yuque.com/easy-team/egg-vue/asset
- when asset render, you can render layout exports.vuessr.layout by viewEngine, default use egg-view-nunjucks
- you must install the specified engine dependence, such as or egg-view-ejs
- The context provides an object that can get js, css, state information. layout template
#### use default viewEngine nunjucks
`js`
// controller/home.js
exports.asset = function* (ctx) {
yield ctx.renderAsset('index/index.js', { message: 'egg vue asset render'});
};
#### scope render viewEngine config
`js``
// controller/home.js
exports.asset = function* (ctx) {
yield ctx.renderAsset('index/index.js', { message: 'egg vue asset render'}, { viewEngine: 'ejs' });
};
- see config/config.default.js for more detail.
- see egg-vue-asset-boilerplate examples
Please open an issue here.