Hierarchy

  • ScenarioRegistration

Properties

displayName: string

A label that will be displayed to identify the scenario in the Scenario Explorer list.

displayOrder: number

The order the scenario will be displayed in the Scenario Explorer list. The displayOrder will be used to sort scenarios with each groupName.

groupName: string

The group the scenario belongs to. This value will be displayed in the Scenario Explorer list and each scenario will be grouped under the same group name.

rootComponent: FC

The root React component to be rendered for the scenario.

shortId: string

A human readable unique identifier for the scenario. This value will also be visible in the Browser address bar.

The naming convention shall be lower-kebab-case

The route for the scenario will be generated as /${shortId}.

Generated using TypeDoc