Skip to content package
vision v5.3.0 Templates rendering plugin support for hapi.js
node >=8.9.0 4 deps cjs open source
overview readme
license BSD-3-Clause
deps 4
unpacked Unknown
files Unknown
node >=8.9.0 $ npm install vision@5.3.0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
versions Latest published Dec 15, 2018
maintainers Registry package owners.
contents vision
Templates rendering plugin support for hapi.js.
Lead Maintainer - William Woodruff
vision decorates the server ,
request , and
h response toolkit interfaces with additional
methods for managing view engines that can be used to render templated responses.
vision also provides a built-in handler implementation for creating templated responses.
Usage
See also the API Reference
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const server = Hapi. Server ({ port: 3000 });
const provision = async () => {
await server. register (Vision);
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision (); copy
Note:
Vision 5.x.x requires hapi 17.x.x. For use with hapi 16.x.x, use vision 4.x.x.
Vision is included with and loaded by default in Hapi < 9.0.
Examples
The examples in the examples folder can be run with node.
git clone https://github.com/hapijs/vision.git && cd vision
npm install
node examples/handlebars copy
:point_up: That command will run the handlebars basic template.
There are three more examples in there: for helpers, layout, and partials.
Use this hierarchy to know which commands to run, e.g.
node examples/mustache
node examples/mustache/partials
node examples/jsx copy
- cms // A bare-bones Content Management System with a WYSIWYG editor
- ejs
- layout
- handlebars
- helpers
- layout
- partials
- jsx // React server-side rendering with `hapi-react-views`
- marko
- mixed // Using multiple render engines (handlebars and pug)
- mustache
- layout
- partials
- nunjucks
- pug
- twig copy
vision is compatible with most major templating engines out of the box. Engines that don't follow
the normal API pattern can still be used by mapping their API to the vision API . Some of the examples below use the compile and prepare methods which are part of the API.
EJS
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Ejs = require ( 'ejs' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/ejs/templates/basic | Hapi ' + request.server.version,
message: 'Hello Ejs!'
});
};
const provision = async () => {
Handlebars
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Handlebars = require ( 'handlebars' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/handlebars/templates/basic | Hapi ' + request.server.version,
message: 'Hello Handlebars!'
});
};
const provision = async () =>
Pug
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Pug = require ( 'pug' );
const Path = require ( 'path' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/pug/templates | Hapi ' + request.server.version,
message: 'Hello Pug!'
});
};
Marko
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Marko = require ( 'marko' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/marko/templates | Hapi ' + request.server.version,
message: 'Hello Marko!'
});
};
const provision = async () => {
Mustache
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Mustache = require ( 'mustache' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/mustache/templates/basic | Hapi ' + request.server.version,
message: 'Hello Mustache!'
});
};
const provision = async () => {
Nunjucks
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Nunjucks = require ( 'nunjucks' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/nunjucks/templates | Hapi ' + request.server.version,
message: 'Hello Nunjucks!'
});
};
const provision = async () => {
Twig
const Hapi = require ( 'hapi' );
const Vision = require ( 'vision' );
const Twig = require ( 'twig' );
const server = Hapi. Server ({ port: 3000 });
const rootHandler = (request, h) => {
return h. view ( 'index' , {
title: 'examples/twig/templates | Hapi ' + request.server.version,
message: 'Hello Twig!'
});
};
const provision = async () => {
install size Estimated unpacked size across 12 packages.
2.2 MB
Includes dependencies.
dependencies 4 direct · 1 outdated
devinivy
devinivy@gmail.com
await server. register (Vision);
server. views ({
engines: { ejs: Ejs },
relativeTo: __dirname,
path: 'examples/ejs/templates/basic'
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy
{
await server. register (Vision);
server. views ({
engines: { html: Handlebars },
relativeTo: __dirname,
path: 'examples/handlebars/templates/basic'
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy
const provision = async () => {
await server. register (Vision);
server. views ({
engines: { pug: Pug },
relativeTo: __dirname,
path: 'examples/pug/templates' ,
compileOptions: {
// By default Pug uses relative paths (e.g. ../root.pug), when using absolute paths (e.g. include /root.pug), basedir is prepended.
// https://pugjs.org/language/includes.html
basedir: Path. join (__dirname, 'examples/pug/templates' )
}
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy
await server. register (Vision);
server. views ({
engines: {
marko: {
compile : (src, options) => {
const opts = { preserveWhitespace: true , writeToDisk: false };
const template = Marko. load (options.filename, opts);
return (context) => {
return template. renderToString (context);
};
}
}
},
relativeTo: __dirname,
path: 'examples/marko/templates'
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy
await server. register (Vision);
server. views ({
engines: {
html: {
compile : (template) => {
Mustache. parse (template);
return (context) => {
return Mustache. render (template, context);
};
}
}
},
relativeTo: __dirname,
path: 'examples/mustache/templates/basic'
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy
await server. register (Vision);
server. views ({
engines: {
html: {
compile : (src, options) => {
const template = Nunjucks. compile (src, options.environment);
return (context) => {
return template. render (context);
};
},
prepare : (options, next) => {
options.compileOptions.environment = Nunjucks. configure (options.path, { watch : false });
return next ();
}
}
},
relativeTo: __dirname,
path: 'examples/nunjucks/templates'
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy
await server. register (Vision);
server. views ({
engines: {
twig: {
compile : (src, options) => {
const template = Twig. twig ({ id: options.filename, data: src });
return (context) => {
return template. render (context);
};
}
}
},
relativeTo: __dirname,
path: 'examples/twig/templates'
});
server. route ({ method: 'GET' , path: '/' , handler: rootHandler });
await server. start ();
console. log ( 'Server running at:' , server.info.uri);
};
provision ();
copy