View engines
The default view engine in Sails is EJS.
Swapping out the view engine
To use a different view engine, you should use npm to install it in your project, then in config/views.js set sails.config.views.extension to your desired file extension and sails.config.views.getRenderFn to a function that returns your view engine's rendering function.
If your view engine is supported by Consolidate, you can use that in getRenderFn to easily access the rendering function. First, you'll need to use npm to install consolidate into your project, if it is not already present:
npm install consolidate --save
After the install has completed and you have installed your view engine package, you can then set the view configuration. For example, to use Swig templates you would npm install swig --save and then add the following into config/views.js:
extension: 'swig',
getRenderFn: ()=>{
// Import `consolidate`.
var cons = require('consolidate');
// Return the rendering function for Swig.
return cons.swig;
}
The getRenderFn allows you to configure your view engine before plugging it into Sails:
extension: 'swig',
getRenderFn: ()=>{
// Import `consolidate`.
var cons = require('consolidate');
// Import `swig`.
var swig = require('swig');
// Configure `swig`.
swig.setDefaults({tagControls: ['{?', '?}']});
// Set the module that Consolidate uses for Swig.
cons.requires.swig = swig;
// Return the rendering function for Swig.
return cons.swig;
}
For a better experience on sailsjs.com, update your browser.
Concepts
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.