Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CatavoltPaneProps

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 enableResourceCaching

enableResourceCaching: boolean

This enables the use of the CvEventRegistry cache to 'retain' objects retrieved during navigation requests. This makes it possible to use a browser 'history', by allowing the retrieval of these objects by 'resource id' from the cache.

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 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

Generated using TypeDoc