Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvNavigationProps

Hierarchy

Index

Properties

Optional catavolt

catavolt: AppContext

The Catavolt SDK entry point, an instance of the sdk {AppContext} which is always available to components. A singleton instance is used by the underlying components to interact with the sdk.

Optional eventRegistry

eventRegistry: CvEventRegistry

The CvEventRegistry handles decoupled communication between components. Any component may subscribe to and publish CvEvents. See also CvListener and CvEventType

Optional navigationId

navigationId: string

The cache identifier of the result of a Navigation. Should not be used if the navigationResult is provided.

Optional navigationResult

navigationResult: CvNavigationResult

The result of a navigation. Should not be used if the navigationId property is provided

Optional persistent

persistent: boolean

Setting persistent true, allows this component to remain visible, even after another, new Navigation has taken place. This is useful for single page apps where components may be coresident.

Optional renderer

renderer: function

Allows for a component's rendering logic to be overridden and completely customized. The first argument, the CvContext, exposes the CvScopeContext which provides the relevant SDK object for use by the renderer. CvScopeContext.scopeObj will always be an SDK object exposing the data related to the current component.

Type declaration

    • (cvContext: CvContext, callbackObj?: any): __type
    • Parameters

      • cvContext: CvContext
      • Optional callbackObj: any

      Returns __type

Optional targetId

targetId: string

Allows for one Navigation component to target another, when coresident on the page.

Generated using TypeDoc