Extends vinyl with render and compile methods, and properties used for rendering templates.
Install with npm:
$ npm install --save vinyl-viewUse the same way you would use a vinyl file:
var View = require('vinyl-view');
var view = new View({path: 'foo'});Create an instance of View. Optionally pass a default object to use.
Params
view{Object}
Example
var view = new View({
path: 'foo.html',
contents: new Buffer('...')
});Synchronously compile a view.
Params
locals{Object}: Optionally pass locals to the engine.returns{Object}View: instance, for chaining.
Example
var view = page.compile();
view.fn({title: 'A'});
view.fn({title: 'B'});
view.fn({title: 'C'});Synchronously render templates in view.content.
Params
locals{Object}: Optionally pass locals to the engine.returns{Object}View: instance, for chaining.
Example
var view = new View({content: 'This is <%= title %>'});
view.renderSync({title: 'Home'});
console.log(view.content);Asynchronously render templates in view.content.
Params
locals{Object}: Context to use for rendering templates.
Example
view.render({title: 'Home'}, function(err, res) {
//=> view object with rendered `content`
});Create a context object from locals and the view.data and view.locals objects. The view.data property is typically created from front-matter, and view.locals is used when a new View() is created.
This method be overridden either by defining a custom view.options.context function
to customize context for a view instance, or static View.context function to customize
context for all view instances.
Params
locals{Object}: Optionally pass a locals object to merge onto the context.returns{Object}: Returns the context object.
Example
var page = new View({path: 'a/b/c.txt', locals: {a: 'b', c: 'd'}});
var ctx = page.context({a: 'z'});
console.log(ctx);
//=> {a: 'z', c: 'd'}Returns true if the view is the given viewType. Returns false if no type is assigned. When used with vinyl-collections, types are assigned by their respective collections.
Params
type{String}: (renderable,partial,layout)
Example
var view = new View({path: 'a/b/c.txt', viewType: 'partial'})
view.isType('partial');Define a custom static View.context function to override default .context behavior. See the context docs for more info.
Params
locals{Object}returns{Object}
Example
// custom context function
View.context = function(locals) {
// `this` is the view being rendered
return locals;
};Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testJon Schlinkert
Copyright © 2017, Jon Schlinkert. MIT
This file was generated by verb-generate-readme, v0.4.2, on February 08, 2017.