Building a Purple Experience
views.json

View

1min

Basic Fields

* = required field

Field

Description

name*

Defines the class name which will be added to the DOM element "storefront-view". Therefore, we recommend using a lower-case name without spaces, so it works well as a CSS selector.

path*

Describes under which URL the view will be accessible (exception: Using the URL resolver for dynamic paths). Note: The root view must have the path /, all other paths must not start with a slash.

pullToRefresh

The view will automatically be updated on any changes caused by app resumes or invalidations (e.g. caused by a login or a purchase). If 'pullToRefresh' is activated, manual updates via a pull gesture will also trigger an update.

appBar

If 'appBar' is set, it shows the top app bar with the matching ID from the appBar.json

navigation

If 'navigation' is set, it shows the bottom sticky navigation bar with the matching ID from the navigation.json

content*

'content*' defines the content of the page, composed of different possibly nested Inspecting Components.

data

'data' stands for a list of Data sources that are required throughout the page. You may set up data sources to be loaded per view or from the components defined above.





title

The <title> Tag text is shown in the browser's bar and search engine entries. You can use $context, $functions or $global expressions, but it is not reactive (e.g. only set once). The <title> Tag is relevant to be set for SEO.

postView

'postView ' is set for the simple opening of content based on 'postType'. We recommend using the URL resolver as it gives more flexibility.

cache

Allows configuring the cache-control header by specifying maxAge, staleWhileRevalidate and staleIfError. Values are set in seconds. If none are set, defaults are used, see tooltips for the current defaults.

See CloudFront docs for more information on the cache-control header.

seo

Adds metadata tags to the rendered HTML, e.g. for Open Graph properties.

pageConfigs

Currently used for setting up traffective tracking.

viewTrackingParams

Additional tracking parameters for view tracking events.

jsonLD

A string representing the JsonLD config to pass additional information to Search Engine Crawlers.

errorPage

If true, the page is treated as an Error Page.



Updated 23 Sep 2024
Did this page help you?