Micronaut Views Configuration Reference

Every documented configuration property of Micronaut Views, with types, descriptions, and defaults.

207 properties across 15 sections

Micronaut Views Core Config Properties

Configuration properties for CsrfViewModelProcessorConfigurationProperties

Property	Type	Description
`micronaut.security.csrf.views-model-decorator.csrf-token-key`	java.lang.String	Model key for CSRF Token. Default value ("csrfToken").
`micronaut.security.csrf.views-model-decorator.enabled`	boolean	Enable {@link CsrfViewModelProcessor}. Default value (true).

Configuration properties for SecurityViewModelProcessorConfigurationProperties

Property	Type	Description
`micronaut.security.views-model-decorator.enabled`	boolean	Enable {@link SecurityViewModelProcessor}. Default value (true).
`micronaut.security.views-model-decorator.security-key`	java.lang.String	Model key name. Default value ("security").
`micronaut.security.views-model-decorator.principal-name-key`	java.lang.String	Nested security map key for the user’s name property. Default value ("name").
`micronaut.security.views-model-decorator.attributes-key`	java.lang.String	Nested security map key for the user’s attributes property. Default value ("attributes").

Configuration properties for ViewsConfigurationProperties

Property	Type	Description
`micronaut.views.enabled`	boolean	Whether view rendering is enabled. Default value (true).
`micronaut.views.folder`	java.lang.String	The resources' folder where views should be searched for. Default value ("views").
`micronaut.views.dir`	java.lang.String	The folder to look for views. Default value ("views").

Configuration properties for CspConfiguration

Property	Type	Description
`micronaut.views.csp.enabled`	boolean	Sets whether CSP is enabled. Default value (false).
`micronaut.views.csp.policy-directives`	java.lang.String	Sets the policy directives.
`micronaut.views.csp.report-only`	boolean	If true, the Content-Security-Policy-Report-Only header will be sent instead of Content-Security-Policy. Default value (false).
`micronaut.views.csp.random-engine`	java.util.Random	Sets the Random data engine used to generate nonce values. Ignored if forceSecureRandom is set to true .
`micronaut.views.csp.generate-nonce`	boolean	If true, the CSP header will contain a generated nonce that is made available to view renderers. The nonce should change for each request/response cycle and can be used by views to authorize inlined script blocks.
`micronaut.views.csp.force-secure-random`	boolean	Sets whether SecureRandom is forced for use in generated nonce values. Defaults to (false). Enabling this requires careful consideration, because SecureRandom will block infinitely without enough entropy.
`micronaut.views.csp.filter-path`	java.lang.String	Sets the path the CSP filter should apply to. Default value ("/**").

Configuration properties for ViewsFilterConfiguration

Property	Type	Description
`micronaut.views.filter.enabled`	boolean	Sets whether the filter is enabled.

Micronaut Views Fieldset Config Properties

Configuration properties for FormElementRendererConfigurationProperties

Property	Type	Description
`micronaut.views.form-element.render.enabled`	boolean	Whether form element rendering is enabled. Default value (true).

Configuration properties for FormElementRendererViewsConfiguration

Property	Type	Description
`micronaut.views.form-element.render.views.input-checkbox`	java.lang.String	The view name for a field of type input checkbox.
`micronaut.views.form-element.render.views.input-date`	java.lang.String	The view name for a field of type input date.
`micronaut.views.form-element.render.views.input-date-time-local`	java.lang.String	The view name for a field of type input datetime-local.
`micronaut.views.form-element.render.views.input-email`	java.lang.String	The view name for a field of type input email.
`micronaut.views.form-element.render.views.input-hidden`	java.lang.String	The view name for a field of type input hidden.
`micronaut.views.form-element.render.views.input-number`	java.lang.String	The view name for a field of type input number.
`micronaut.views.form-element.render.views.input-password`	java.lang.String	The view name for a field of type input password.
`micronaut.views.form-element.render.views.input-radio`	java.lang.String	The view name for a field of type input radio.
`micronaut.views.form-element.render.views.input-submit`	java.lang.String	The view name for a field of type input submit.
`micronaut.views.form-element.render.views.input-tel`	java.lang.String	The view name for a field of type input tel.
`micronaut.views.form-element.render.views.input-text`	java.lang.String	The view name for a field of type input text.
`micronaut.views.form-element.render.views.input-time`	java.lang.String	The view name for a field of type input time.
`micronaut.views.form-element.render.views.input-url`	java.lang.String	The view name for a field of type input url.
`micronaut.views.form-element.render.views.option`	java.lang.String	The view name to render an option html element.
`micronaut.views.form-element.render.views.select`	java.lang.String	The view name for a field of type select.
`micronaut.views.form-element.render.views.textarea`	java.lang.String	The view name to render a textarea html element.
`micronaut.views.form-element.render.views.trix-editor`	java.lang.String	The view name for a field of type trix-editor.

Micronaut Views Freemarker Config Properties

Configuration properties for FreemarkerViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.freemarker.parent`	freemarker.core.Configurable
`micronaut.views.freemarker.classic-compatible`	boolean
`micronaut.views.freemarker.classic-compatible-as-int`	int
`micronaut.views.freemarker.locale`	java.util.Locale
`micronaut.views.freemarker.c-format`	freemarker.core.CFormat
`micronaut.views.freemarker.time-zone`	java.util.TimeZone
`micronaut.views.freemarker.sqldate-and-time-time-zone`	java.util.TimeZone
`micronaut.views.freemarker.number-format`	java.lang.String
`micronaut.views.freemarker.custom-number-formats`	java.util.Map
`micronaut.views.freemarker.boolean-format`	java.lang.String
`micronaut.views.freemarker.time-format`	java.lang.String
`micronaut.views.freemarker.date-format`	java.lang.String
`micronaut.views.freemarker.date-time-format`	java.lang.String
`micronaut.views.freemarker.custom-date-formats`	java.util.Map
`micronaut.views.freemarker.template-exception-handler`	freemarker.template.TemplateExceptionHandler
`micronaut.views.freemarker.attempt-exception-reporter`	freemarker.template.AttemptExceptionReporter
`micronaut.views.freemarker.arithmetic-engine`	freemarker.core.ArithmeticEngine
`micronaut.views.freemarker.object-wrapper`	freemarker.template.ObjectWrapper
`micronaut.views.freemarker.output-encoding`	java.lang.String
`micronaut.views.freemarker.output-encoding-set`	boolean
`micronaut.views.freemarker.urlescaping-charset`	java.lang.String
`micronaut.views.freemarker.new-builtin-class-resolver`	freemarker.core.TemplateClassResolver
`micronaut.views.freemarker.auto-flush`	boolean
`micronaut.views.freemarker.show-error-tips`	boolean
`micronaut.views.freemarker.apibuiltin-enabled`	boolean
`micronaut.views.freemarker.truncate-builtin-algorithm`	freemarker.core.TruncateBuiltinAlgorithm
`micronaut.views.freemarker.log-template-exceptions`	boolean
`micronaut.views.freemarker.wrap-unchecked-exceptions`	boolean
`micronaut.views.freemarker.lazy-imports`	boolean
`micronaut.views.freemarker.lazy-auto-imports`	java.lang.Boolean
`micronaut.views.freemarker.lazy-auto-imports-set`	boolean
`micronaut.views.freemarker.auto-imports`	java.util.Map
`micronaut.views.freemarker.auto-includes`	java.util.List
`micronaut.views.freemarker.strict-bean-models`	boolean
`micronaut.views.freemarker.settings`	java.util.Properties
`micronaut.views.freemarker.template-loader`	freemarker.cache.TemplateLoader
`micronaut.views.freemarker.template-loader-explicitly-set`	boolean
`micronaut.views.freemarker.template-lookup-strategy`	freemarker.cache.TemplateLookupStrategy
`micronaut.views.freemarker.template-lookup-strategy-explicitly-set`	boolean
`micronaut.views.freemarker.template-name-format`	freemarker.cache.TemplateNameFormat
`micronaut.views.freemarker.template-name-format-explicitly-set`	boolean
`micronaut.views.freemarker.template-configurations`	freemarker.cache.TemplateConfigurationFactory
`micronaut.views.freemarker.cache-storage`	freemarker.cache.CacheStorage
`micronaut.views.freemarker.cache-storage-explicitly-set`	boolean
`micronaut.views.freemarker.directory-for-template-loading`	java.io.File
`micronaut.views.freemarker.template-update-delay`	int
`micronaut.views.freemarker.template-update-delay-milliseconds`	long
`micronaut.views.freemarker.strict-syntax-mode`	boolean
`micronaut.views.freemarker.object-wrapper-explicitly-set`	boolean
`micronaut.views.freemarker.locale-explicitly-set`	boolean
`micronaut.views.freemarker.time-zone-explicitly-set`	boolean
`micronaut.views.freemarker.template-exception-handler-explicitly-set`	boolean
`micronaut.views.freemarker.attempt-exception-reporter-explicitly-set`	boolean
`micronaut.views.freemarker.log-template-exceptions-explicitly-set`	boolean
`micronaut.views.freemarker.wrap-unchecked-exceptions-explicitly-set`	boolean
`micronaut.views.freemarker.incompatible-enhancements`	java.lang.String
`micronaut.views.freemarker.whitespace-stripping`	boolean
`micronaut.views.freemarker.auto-escaping-policy`	int
`micronaut.views.freemarker.output-format`	freemarker.core.OutputFormat
`micronaut.views.freemarker.output-format-explicitly-set`	boolean
`micronaut.views.freemarker.registered-custom-output-formats`	java.util.Collection
`micronaut.views.freemarker.recognize-standard-file-extensions`	boolean
`micronaut.views.freemarker.c-format-explicitly-set`	boolean
`micronaut.views.freemarker.tag-syntax`	int
`micronaut.views.freemarker.interpolation-syntax`	int
`micronaut.views.freemarker.naming-convention`	int
`micronaut.views.freemarker.tab-size`	int
`micronaut.views.freemarker.fallback-on-null-loop-variable`	boolean
`micronaut.views.freemarker.prevent-strippings`	boolean
`micronaut.views.freemarker.default-encoding`	java.lang.String
`micronaut.views.freemarker.default-encoding-explicitly-set`	boolean
`micronaut.views.freemarker.shared-variables`	java.util.Map
`micronaut.views.freemarker.shared-varibles`	java.util.Map
`micronaut.views.freemarker.all-shared-variables`	freemarker.template.TemplateHashModelEx
`micronaut.views.freemarker.localized-lookup`	boolean
`micronaut.views.freemarker.enabled`	boolean	Whether freemarker views are enabled.
`micronaut.views.freemarker.default-extension`	java.lang.String	Sets the default extension to use.
`micronaut.views.freemarker.incompatible-improvements`	freemarker.template.Version	the FreeMarker version number where the not 100% backward compatible bug fixes and improvements that you want to enable were already implemented. Defaults to {@link Configuration#DEFAULT_INCOMPATIBLE_IMPROVEMENTS}.
`micronaut.views.freemarker.properties`	java.util.Properties
`micronaut.views.freemarker.custom-attributes`	java.util.HashMap
`micronaut.views.freemarker.sql-data-and-time-time-zone`	java.util.TimeZone
`micronaut.views.freemarker.sql-data-and-time-time-zone-set`	boolean
`micronaut.views.freemarker.url-escaping-charset`	java.lang.String
`micronaut.views.freemarker.url-escaping-charset-set`	boolean
`micronaut.views.freemarker.api-builtin-enabled`	java.lang.Boolean
`micronaut.views.freemarker.strict-syntax`	boolean
`micronaut.views.freemarker.cache`	freemarker.cache.TemplateCache
`micronaut.views.freemarker.rewrappable-shared-variables`	java.util.HashMap
`micronaut.views.freemarker.locale-to-charset-map`	java.util.concurrent.ConcurrentMap

Micronaut Views Handlebars Config Properties

Configuration properties for HandlebarsViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.handlebars.enabled`	boolean	Whether handlebars view rendering is enabled. Default value (true).
`micronaut.views.handlebars.default-extension`	java.lang.String	The default extension. Default value ("hbs").

Micronaut Views Htmx Config Properties

Configuration properties for HtmxConfigurationProperties

Property	Type	Description
`micronaut.views.htmx.enabled`	boolean	Whether the htmx integration is enabled. Default value (true).

Micronaut Views Jinjava Config Properties

Configuration properties for JinjavaViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.jinja.enabled`	boolean	Whether Jinjava Views rendering is enabled
`micronaut.views.jinja.default-extension`	java.lang.String	The default template extension

Configuration properties for JinjavaConfig$Builder

Property	Type	Description
`micronaut.views.jinja.config.charset`	java.nio.charset.Charset
`micronaut.views.jinja.config.locale`	java.util.Locale
`micronaut.views.jinja.config.time-zone`	java.time.ZoneId
`micronaut.views.jinja.config.disabled`	java.util.Map
`micronaut.views.jinja.config.restricted-methods`	java.util.Set
`micronaut.views.jinja.config.restricted-properties`	java.util.Set
`micronaut.views.jinja.config.max-render-depth`	int
`micronaut.views.jinja.config.random-number-generator-strategy`	com.hubspot.jinjava.random.RandomNumberGeneratorStrategy
`micronaut.views.jinja.config.date-time-provider`	com.hubspot.jinjava.objects.date.DateTimeProvider
`micronaut.views.jinja.config.trim-blocks`	boolean
`micronaut.views.jinja.config.lstrip-blocks`	boolean
`micronaut.views.jinja.config.enable-recursive-macro-calls`	boolean
`micronaut.views.jinja.config.max-macro-recursion-depth`	int
`micronaut.views.jinja.config.read-only-resolver`	boolean
`micronaut.views.jinja.config.el-resolver`	jinjava.javax.el.ELResolver
`micronaut.views.jinja.config.fail-on-unknown-tokens`	boolean
`micronaut.views.jinja.config.max-output-size`	long
`micronaut.views.jinja.config.nested-interpretation-enabled`	boolean
`micronaut.views.jinja.config.validation-mode`	boolean
`micronaut.views.jinja.config.max-string-length`	long
`micronaut.views.jinja.config.max-list-size`	int
`micronaut.views.jinja.config.max-map-size`	int
`micronaut.views.jinja.config.range-limit`	int
`micronaut.views.jinja.config.max-num-deferred-tokens`	int
`micronaut.views.jinja.config.interperter-factory`	com.hubspot.jinjava.interpret.InterpreterFactory
`micronaut.views.jinja.config.token-scanner-symbols`	com.hubspot.jinjava.tree.parse.TokenScannerSymbols
`micronaut.views.jinja.config.execution-mode`	com.hubspot.jinjava.mode.ExecutionMode
`micronaut.views.jinja.config.legacy-overrides`	com.hubspot.jinjava.LegacyOverrides
`micronaut.views.jinja.config.enable-precise-divide-filter`	boolean
`micronaut.views.jinja.config.enable-filter-chain-optimization`	boolean
`micronaut.views.jinja.config.keep-trailing-newline`	boolean
`micronaut.views.jinja.config.object-mapper`	com.fasterxml.jackson.databind.ObjectMapper
`micronaut.views.jinja.config.object-unwrapper`	com.hubspot.jinjava.el.ObjectUnwrapper
`micronaut.views.jinja.config.processors`	com.hubspot.jinjava.el.JinjavaProcessors
`micronaut.views.jinja.config.feature-config`	com.hubspot.jinjava.features.FeatureConfig

Micronaut Views Jte Config Properties

Configuration properties for JteViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.jte.dynamic`	boolean	Whether to enable dynamic reloading of templates. Default value (false).
`micronaut.views.jte.dynamic-path`	java.lang.String	Root directory under which to write generated source and class files. . Default value ("build/jte-classes").
`micronaut.views.jte.dynamic-source-path`	java.lang.String	When using dynamic templates, the root source directory to search. If not specified, jte will search src/<sourceset>/jte and src/<sourceset>/resources/<folder> where 'folder' is ViewsConfiguration.getFolder(). In cases where the source directory cannot be found, jte will use classpath loading instead, and will not dynamically reload templates.
`micronaut.views.jte.binary-static-content`	boolean	Enable building binary content for templates. Default value (false). (Only has an effect when 'dynamic' is true. To use with precompiled templates, enable it in the build plugin)

Micronaut Views Pebble Config Properties

Configuration properties for PebbleConfigurationProperties

Property	Type	Description
`micronaut.views.pebble.enabled`	boolean	Sets whether the component is enabled. Default value (true).
`micronaut.views.pebble.default-extension`	java.lang.String	The default extension. Default value ("html").
`micronaut.views.pebble.cache-active`	boolean	Enable/disable all caches, i.e. cache used by the engine to store compiled PebbleTemplate instances and tags cache. Default value (true).
`micronaut.views.pebble.new-line-trimming`	boolean	Changes the newLineTrimming setting of the PebbleEngine. By default, Pebble will trim a new line that immediately follows a Pebble tag. If set to false, then the first newline following a Pebble tag won’t be trimmed. All newlines will be preserved. Default value (true).
`micronaut.views.pebble.auto-escaping`	boolean	Sets whether or not escaping should be performed automatically. Default value (true).
`micronaut.views.pebble.default-escaping-strategy`	java.lang.String	Sets the default escaping strategy of the built-in escaper extension. Default value (EscapeFilter.HTML_ESCAPE_STRATEGY).
`micronaut.views.pebble.strict-variables`	boolean	Changes the strictVariables setting of the PebbleEngine. Default value (false).
`micronaut.views.pebble.greedy-match-method`	boolean	Enable/disable greedy matching mode for finding java method. Default is disabled. If enabled, when can not find perfect method (method name, parameter length and parameter type are all satisfied), reduce the limit of the parameter type, try to find other method which has compatible parameter types. Default value (false).
`micronaut.views.pebble.allow-override-core-operators`	boolean	Sets whether or not core operators overrides should be allowed. Default value (false).
`micronaut.views.pebble.literal-decimals-as-integers`	boolean	Enable/disable treat literal decimal as Integer. Default value (false), treated as Long.
`micronaut.views.pebble.literal-numbers-as-big-decimals`	boolean	Enable/disable treat literal numbers as BigDecimals. Default value (false), treated as Long/Double.

Micronaut Views React Config Properties

Configuration properties for ReactViewsRendererConfiguration

Property	Type	Description	Default
`micronaut.views.react.client-bundle-url`	java.lang.String	the URL (relative or absolute) where the client Javascript bundle can be found. It will be appended to the generated HTML in a <script> tag. Defaults to "/static/client.js"	`/static/client.js`
`micronaut.views.react.hydrate-without-request`	boolean	Whether a render with no HttpRequest still emits the hydration bootstrap: the {@code Micronaut} object carrying the serialised view model, and the script tag for the client bundle. <p>Such a render is not being sent to a browser. An email body built by {@code micronaut-email-template} is the common case: it cannot hydrate, the bundle URL has no origin to resolve against, and the bootstrap puts the entire model into the delivered message — a password reset token along with everything else. Set this to {@code false} to render markup only in that case; a render with a request is unaffected either way.	`true`
`micronaut.views.react.server-bundle-path`	java.lang.String	the path relative to micronaut.views.folder where the bundle used for server-side rendering can be found. Defaults to "classpath:views/ssr-components.mjs"	`classpath:views/ssr-components.mjs`
`micronaut.views.react.render-script`	java.lang.String	Either a file path (starting with "file:" or a resource in the classpath (starting with "classpath:") to a render script. Please see the user guide for more information on what this Javascript file should contain.	`classpath:io/micronaut/views/react/react.js`
`micronaut.views.react.sandbox`	boolean	If true, GraalJS sandboxing is enabled. This helps protect you against supply chain attacks that might inject code into your server via hijacked React components. It requires a sufficiently new version of GraalJS. Defaults to OFF.	`false`

Micronaut Views React Dev Config Properties

Configuration properties for ReactDevConfiguration

Property	Type	Description	Default
`micronaut.views.react.dev.enabled`	boolean	Whether to tell the browser when the server bundle has been rebuilt. <p>Off by default. It serves an unauthenticated endpoint and adds a script to every rendered page, so it has to be asked for rather than inferred.	`false`
`micronaut.views.react.dev.path`	java.lang.String	the path that both transports are served from, and that the injected script connects to. Defaults to "/micronaut/views/react/dev-reload".	`/micronaut/views/react/dev-reload`
`micronaut.views.react.dev.quiet-period`	java.time.Duration	How long to wait for bundle writes to settle before telling the browser. <p>This is not politeness, it is correctness. The file watcher fires when the bundler starts writing, and {@code micronaut-views-react} only drops its cached bundle then — it re-reads lazily, on the next render. Announce immediately and the browser reloads within milliseconds, that render re-reads a half-written file, and the stale content is cached as the new bundle. The page then sits there with old markup and a current token. Measured in a real browser. <p>Waiting for a quiet period means the first render after a rebuild happens once the bundler has finished, so it reads the finished file.	`1s`

Micronaut Views Rocker Config Properties

Configuration properties for RockerViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.rocker.enabled`	boolean	Whether Rocker views are enabled. Default value (true).
`micronaut.views.rocker.default-extension`	java.lang.String	Sets the default extension to use for Rocker templates. Default value ("rocker.html").
`micronaut.views.rocker.hot-reloading`	boolean	Whether hot reloading is enabled. Default value (false). Hot reloading requires an additional dependency on {@code com.fizzed:rocker-compiler:1.2.3:provided}.
`micronaut.views.rocker.relaxed`	boolean	Whether relaxed binding is enabled for dynamic templates. Default value (false).

Micronaut Views Soy Config Properties

Configuration properties for SoyViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.soy.enabled`	boolean	Whether Soy-backed views are enabled. Default value (true).
`micronaut.views.soy.renaming-enabled`	boolean	Turns renaming on or off. Default value (true).
`micronaut.views.soy.renaming`	boolean

Micronaut Views Thymeleaf Config Properties

Configuration properties for ThymeleafViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.thymeleaf.character-encoding`	java.lang.String	Sets the character encoding to use. Default value ("UTF-8").
`micronaut.views.thymeleaf.template-mode`	org.thymeleaf.templatemode.TemplateMode	Sets the template mode.
`micronaut.views.thymeleaf.suffix`	java.lang.String	Sets the suffix to use.
`micronaut.views.thymeleaf.force-suffix`	boolean	Sets whether to force the suffix. Default value (false).
`micronaut.views.thymeleaf.force-template-mode`	boolean	Sets whether to force template mode. Default value (false).
`micronaut.views.thymeleaf.cache-ttlms`	long	Sets the cache TTL in millis.
`micronaut.views.thymeleaf.check-existence`	boolean	Sets whether templates should be checked for existence.
`micronaut.views.thymeleaf.cacheable`	boolean	Sets whether templates are cacheable.
`micronaut.views.thymeleaf.enabled`	boolean	Sets whether thymeleaf rendering is enabled. Default value (true).
`micronaut.views.thymeleaf.cache-ttl`	java.time.Duration	Sets the cache TTL as a duration.

Micronaut Views Turbo Config Properties

Configuration properties for TurboConfigurationProperties

Property	Type	Description
`micronaut.views.turbo.enabled`	boolean	Whether the turbo integration is enabled. Default value (true).

Micronaut Views Velocity Config Properties

Configuration properties for VelocityViewsRendererConfigurationProperties

Property	Type	Description
`micronaut.views.velocity.enabled`	boolean	Whether velocity views are enabled.
`micronaut.views.velocity.default-extension`	java.lang.String	Sets the default extension to use for velocity templates.