Skip to main content

betaThis is a new capability. Help us improve it and give your feedback on Slack.

Templates and views

[!NOTE] forms-engine-plugin currently handles the page layout internally within the plugin and cannot be customised. We plan to offer this customisation as a feature, please contact us on Slack if this is urgent for you.

To override the default page template, vision and nunjucks both need to be configured to search in the forms-engine-plugin views directory when looking for template files.

For vision this is done through the path plugin option For nunjucks it is configured through the environment configure options.

The forms-engine-plugin path to add can be imported from:

import { VIEW_PATH } from '@defra/forms-engine-plugin'

Which can then be appended to the node_modules path node_modules/@defra/forms-engine.

The main template layout is govuk-frontend's template.njk file, this also needs to be added to the paths that nunjucks can look in.

Using page views with data from your own API

Page templates have access to {{ context.data }}, which is an attribute made available when a page event is triggered. It represents the entire response body from your API. To learn more about this, see our guidance on page events.