Edit Page

sails.config.views

Configuration for your app's server-side views. The options are conventionally specified in the config/views.js configuration file.

Properties

#
Property Type Default Details
layout String -or- Boolean "layout" Set the default layout for your app by specifying the relative path to the desired layout file from your views folder (i.e. views/), or disable layout support altogether with false. Built-in support for layouts is only relevant when using ejs (see below).
extension String "ejs" The file extension for view files.
getRenderFn Function none A function that Sails will call to get the rendering function for your desired view engine. See the view engine documentation for more info about specifying a getRenderFn value. If this setting is undefined, Sails will use the built-in EJS renderer.
locals Dictionary {} Default data to be included as view locals every time a server-side view is compiled anywhere in this app. If an optional locals argument was passed in directly via res.view(), its properties take precedence when both dictionaries are merged and provided to the view (more on that below).

Notes

#
  • If your app is NOT using ejs (the default view engine) Sails will function as if the layout option was set to false. To take advantage of layouts when using a custom view engine like Jade or Handlebars, check out that view engine's documentation to find the appropriate syntax.
  • As of Sails 0.12.0, app-wide locals from sails.config.views.locals are combined with any one-off locals you use with res.view() using a shallow merge strategy. That is, if your app-wide locals configuration is {foo: 3, bar: { baz: 'beep' } }, and then you use res.view({bar: 'boop'}), your view will have access to foo (3) and bar ('boop').

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Reference

Reference