Skip to main content

View

The View component holds UI structures defined for User Integration on the front-end. With Backend-Driven View semantics, it minimizes platform release cycles (Mobile, Web, etc.).

Schema: vnext-schema/view-definition.schema.json

Usage Model

View definitions are made at the state or transition level. The vNext Client Workflow Manager SDK delivers the correct view to the user during state and transition cycles. The view is rendered by requesting required data from the Data Function.

For the detailed flow: User Integration (conceptual).

Required Fields

FieldTypeDescription
keystringUnique view identifier
versionstringView version (SemVer)
domainstringOwning domain
flowstringAssociated flow
flowVersionstringFlow version
tagsstring[]Tags
attributesobjectView definition (template, platform overrides, etc.)

Platform Overrides

A single view can include platform-specific overrides:

  • default — fallback render
  • web — web-specific
  • mobile-ios — iOS-specific
  • mobile-android — Android-specific

The Client SDK reads the platform header and renders the correct variant.

Typical Use Cases

  • State view: main screen rendered when arriving at a state
  • Transition view: pre-transition popup/modal confirmation
  • Form rendering: form generation together with Schema
  • Backend-driven UI: screen changes shipped via backend deploy only