Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvViewDescProps

Hierarchy

Index

Properties

Optional actionListeners

actionListeners: Array<function>

Array of CvListeners that will be notified if a view is 'opened'

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 navTarget

navTarget: string

Provide a target for any navigations that originate from this action. The navTarget should correspond to the 'targetId' value of the coresident CvNavigation or {@link CvNavigator}. This is useful for single page apps where components may be coresident.

Optional navigationListeners

navigationListeners: Array<function>

Register to receive CvEvents of type CvNavigationResult

Optional paneContext

paneContext: PaneContext

The sdk {PaneContext} associated with this action. If not specified, the context chain will be upwardly searched to find a component with a containing sdk {PaneContext} scopeObj

Optional renderer

renderer: function

Render override function. It should accept the following params:

param

The current cvContext. The cvContext.cvScope.scopeObj will be the sdk {ViewDesc} object

Type declaration

Optional stateChangeListeners

stateChangeListeners: Array<function>

Array of {@link CvListener> that will be notified of a state change for which they may need to refresh

Optional viewDesc

viewDesc: ViewDesc

The sdk {ViewDesc}

Optional wrapperElemName

wrapperElemName: string

Name of the wrapping element (should be component name) Defaults to 'span' from backward compatibility's sake

Optional wrapperElemProps

wrapperElemProps: any

Props for the wrapping element

Optional wrapperEventHandlerName

wrapperEventHandlerName: string

Name of the wrapperElem property that fires the 'open viewDesc' action (i.e. onClick or onPress) Defaults to 'onClick'

Generated using TypeDoc