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 |
"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 |
"ejs" | The file extension for view files. | |
getRenderFn |
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 |
{} |
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 thelayoutoption was set tofalse. 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.localsare combined with any one-off locals you use withres.view()using a shallow merge strategy. That is, if your app-wide locals configuration is{foo: 3, bar: { baz: 'beep' } }, and then you useres.view({bar: 'boop'}), your view will have access tofoo(3) andbar('boop').
v1.x
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.