ReactAndroid/com.facebook.react.uimanager/ViewManager

ViewManager

abstract class ViewManager<T : View?, C : ReactShadowNode?> : BaseJavaModule

Class responsible for knowing how to create and update catalyst Views of a given type. It is also responsible for creating and updating CSSNodeDEPRECATED subclasses used for calculating position and size for the corresponding native view.

Inheritors

ReactRawTextManager

BaseViewManager

Constructors

ViewManager

constructor()

constructor(@Nullable reactContext: ReactApplicationContext)

Properties

METHOD_TYPE_ASYNC

val METHOD_TYPE_ASYNC: String = "async"

METHOD_TYPE_PROMISE

val METHOD_TYPE_PROMISE: String = "promise"

METHOD_TYPE_SYNC

val METHOD_TYPE_SYNC: String = "sync"

Functions

canOverrideExistingModule

open fun canOverrideExistingModule(): Boolean

Return true if you intend to override some other native module that was registered e.g.

createShadowNodeInstance

open fun createShadowNodeInstance(): C

This method should return a subclass of ReactShadowNode which will be then used for measuring position and size of the view.

@NonNull

open fun createShadowNodeInstance(@NonNull context: ReactApplicationContext): C

createView

@NonNull

open fun createView(reactTag: Int, @NonNull reactContext: ThemedReactContext, @Nullable props: ReactStylesDiffMap, @Nullable stateWrapper: StateWrapper, jsResponderHandler: JSResponderHandler): T

Creates a view with knowledge of props and state.

experimental_prefetchResource

open fun experimental_prefetchResource(reactContext: ReactContext, surfaceId: Int, reactTag: Int, params: MapBuffer)

THIS PREFETCH METHOD IS EXPERIMENTAL, DO NOT USE IT FOR PRODUCTION CODE, MOST LIKELY IT WILL CHANGE OR BE REMOVED IN THE FUTURE.

getCommandsMap

@Nullable

open fun getCommandsMap(): Map<String, Integer>

Subclasses of ViewManager that expect to receive commands through dispatchViewManagerCommand should override this method returning the map between names of the commands and IDs that are then used in receiveCommand method whenever the command is dispatched for this particular ViewManager.

getConstants

@Nullable

open fun getConstants(): Map<String, Any>

getExportedCustomBubblingEventTypeConstants

@Nullable

open fun getExportedCustomBubblingEventTypeConstants(): Map<String, Any>

Returns a map of config data passed to JS that defines eligible events that can be placed on native views.

getExportedCustomDirectEventTypeConstants

@Nullable

open fun getExportedCustomDirectEventTypeConstants(): Map<String, Any>

Returns a map of config data passed to JS that defines eligible events that can be placed on native views.

getExportedViewConstants

@Nullable

open fun getExportedViewConstants(): Map<String, Any>

Returns a map of view-specific constants that are injected to JavaScript.

getName

@NonNull

abstract fun getName(): String

getNativeProps

open fun getNativeProps(): Map<String, String>

Returns a , representing the native props of the view manager.

getShadowNodeClass

abstract fun getShadowNodeClass(): Class<out C>

This method should return Class instance that represent type of shadow node that this manager will return from createShadowNodeInstance.

initialize

open fun initialize()

This method is called after ReactApplicationContext has been created.

invalidate

open fun invalidate()

The CatalystInstance is going away with Venice.

measure

open fun measure(context: Context, localData: ReadableMap, props: ReadableMap, state: ReadableMap, width: Float, widthMode: YogaMeasureMode, height: Float, heightMode: YogaMeasureMode, @Nullable attachmentsPositions: Array<Float>): Long

Subclasses can override this method to implement custom measure functions for the ViewManager

open fun measure(context: Context, localData: MapBuffer, props: MapBuffer, @Nullable state: MapBuffer, width: Float, widthMode: YogaMeasureMode, height: Float, heightMode: YogaMeasureMode, @Nullable attachmentsPositions: Array<Float>): Long

THIS MEASURE METHOD IS EXPERIMENTAL, MOST LIKELY YOU ARE LOOKING TO USE THE OTHER OVERLOAD INSTEAD: measureSubclasses can override this method to implement custom measure functions for the ViewManager

onCatalystInstanceDestroy

open fun ~~onCatalystInstanceDestroy~~()

Allow NativeModule to clean up.

onDropViewInstance

open fun onDropViewInstance(@NonNull view: T)

Called when view is detached from view hierarchy and allows for some additional cleanup by the ViewManager subclass.

onSurfaceStopped

open fun onSurfaceStopped(surfaceId: Int)

Lifecycle method: called when a surface is stopped.

receiveCommand

open fun ~~receiveCommand~~(@NonNull root: T, commandId: Int, @Nullable args: ReadableArray)

open fun receiveCommand(@NonNull root: T, commandId: String, @Nullable args: ReadableArray)

Subclasses may use this method to receive events/commands directly from JS through the .

setPadding

open fun setPadding(view: T, left: Int, top: Int, right: Int, bottom: Int)

Subclasses can override this method to set padding for the given View in Fabric.

updateExtraData

abstract fun updateExtraData(@NonNull root: T, extraData: Any)

Subclasses can implement this method to receive an optional extra data enqueued from the corresponding instance of ReactShadowNode in onCollectExtraUpdates.

updateProperties

open fun updateProperties(@NonNull viewToUpdate: T, props: ReactStylesDiffMap)

For the vast majority of ViewManagers, you will not need to override this.

updateState

@Nullable

open fun updateState(@NonNull view: T, props: ReactStylesDiffMap, stateWrapper: StateWrapper): Any

Subclasses can implement this method to receive state updates shared between all instances of this component type.