Gathering detailed insights and metrics for egg-view-vue-ssr-zk
Gathering detailed insights and metrics for egg-view-vue-ssr-zk
Installations
npm install egg-view-vue-ssr-zkDeveloper Guide
BETA
Typescript
No
Module System
N/A
Min. Node Version
>=6.0.0
Node Version
16.14.0
NPM Version
8.3.1
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
100 Commits
4 Branches
1 Contributors
Updated on Jul 07, 2022
Maintainers
1
Package Meta Information
Latest Version
0.0.3
Package Id
egg-view-vue-ssr-zk@0.0.3
Unpacked Size
19.46 kB
Size
6.16 kB
File Count
10
NPM Version
8.3.1
Node Version
16.14.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
egg-view-vue-ssr-zk
fork自egg-view-vue-ssr，仅设置vue版本~2.6.14
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
1$ npm i egg-view-vue-ssr --save
Document
https://www.yuque.com/easy-team/egg-vue
Usage
1// {app_root}/config/plugin.js 2exports.vuessr = { 3 enable: true, 4 package: 'egg-view-vue-ssr', 5};
Configuration
1// {app_root}/config/config.default.js 2exports.vuessr = { 3 // layout: path.join(app.baseDir, 'app/view/layout.html'), 4 // manifest: path.join(app.baseDir, 'config/manifest.json'), 5 // injectCss: true, 6 // injectJs: true, 7 // fallbackToClient: true, // fallback to client rendering after server rendering failed 8 // afterRender: (html, ctx) => { 9 // return html; 10 // }, 11};
- 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:
1{ 2 "app/app.js": "/public/js/app/app.js", 3 "vendor.js": "/public/js/vendor.js", 4 "deps": { 5 "app/app.js": { 6 "js": [ 7 "/public/js/vendor.js", 8 "/public/js/app/app.js" 9 ], 10 "css": [ 11 "/public/css/vendor.css", 12 "/public/css/app.css" 13 ] 14 } 15 } 16}
- 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
Server Render, Call render
when server render bundle error, will try client render**
1// controller/home.js 2exports.index = function* (ctx) { 3 yield ctx.render('index/index.js', { message: 'egg vue server side render'}); 4};
Server Render, Call renderToHtml
when server render bundle error, will try client render**
1// controller/home.js
2exports.index = function* (ctx) {
3 const html = yield ctx.renderToHtml('index/index.js', { message: 'egg vue server side render'});
4 // you can process html
5 ctx.body = html;
6};Client Render, Call renderClient, Use Vue render layout
when client render, render layout
exports.vuessr.layoutby Vue
1// controller/home.js
2exports.client = function* (ctx) {
3 yield ctx.renderClient('index/index.js',{ message: 'egg vue client render'});
4};Asset Render, Call renderAsset, Use render layout by viewEngine, default nunjucks
- when asset render, you can render layout
exports.vuessr.layoutby viewEngine, default useegg-view-nunjucks - you must install the specified engine dependence, such as
egg-view-nunjucksoregg-view-ejs - The context provides an
assetobject that can getjs,css,stateinformation. layout template
use default viewEngine nunjucks
1// controller/home.js
2exports.asset = function* (ctx) {
3 yield ctx.renderAsset('index/index.js', { message: 'egg vue asset render'});
4};scope render viewEngine config
1// controller/home.js
2exports.asset = function* (ctx) {
3 yield ctx.renderAsset('index/index.js', { message: 'egg vue asset render'}, { viewEngine: 'ejs' });
4};- see config/config.default.js for more detail.
- see egg-vue-asset-boilerplate examples
Questions & Suggestions
Please open an issue here.
License
No vulnerabilities found.
No security vulnerabilities found.