Note: You are on the beta version of our docs. This is a work in progress and may contain broken links and pages. 
Classes
ViewCommon
Summary 
Constructors
Properties
- _androidContentDescriptionUpdated
 - _closeModalCallback
 - _currentHeightMeasureSpec
 - _currentWidthMeasureSpec
 - _gestureObservers
 - _isLayoutValid
 - _manager
 - _modalParent
 - _setMinHeightNative
 - _setMinWidthNative
 - accessibilityBlurEvent
 - accessibilityFocusChangedEvent
 - accessibilityFocusEvent
 - accessibilityHint
 - accessibilityIdentifier
 - accessibilityLabel
 - accessibilityPerformEscapeEvent
 - accessibilityValue
 - ignoreTouchAnimation
 - iosIgnoreSafeArea
 - iosOverflowSafeArea
 - iosOverflowSafeAreaEnabled
 - isEnabled
 - isUserInteractionEnabled
 - layoutChangedEvent
 - originX
 - originY
 - showingModallyEvent
 - shownModallyEvent
 - testID
 - touchAnimation
 - touchDelay
 - transitionId
 
69 properties inherited from ViewBase
Click to expand
Accessors
- accessibilityHidden
 - accessibilityLanguage
 - accessibilityLiveRegion
 - accessibilityMediaSession
 - accessibilityRole
 - accessibilityState
 - accessible
 - androidDynamicElevationOffset
 - androidElevation
 - automationText
 - background
 - backgroundColor
 - backgroundImage
 - backgroundPosition
 - backgroundRepeat
 - backgroundSize
 - borderBottomColor
 - borderBottomLeftRadius
 - borderBottomRightRadius
 - borderBottomWidth
 - borderColor
 - borderLeftColor
 - borderLeftWidth
 - borderRadius
 - borderRightColor
 - borderRightWidth
 - borderTopColor
 - borderTopLeftRadius
 - borderTopRightRadius
 - borderTopWidth
 - borderWidth
 - boxShadow
 - color
 - css
 - cssType
 - height
 - horizontalAlignment
 - iosAccessibilityAdjustsFontSize
 - iosAccessibilityMaxFontScale
 - iosAccessibilityMinFontScale
 - isLayoutRequired
 - isLayoutValid
 - margin
 - marginBottom
 - marginLeft
 - marginRight
 - marginTop
 - minHeight
 - minWidth
 - modal
 - opacity
 - perspective
 - rotate
 - rotateX
 - rotateY
 - scaleX
 - scaleY
 - textTransform
 - translateX
 - translateY
 - verticalAlignment
 - visibility
 - width
 
9 accessors inherited from ViewBase
Click to expand
Methods
- _applyBackground
 - _closeAllModalViewsInternal
 - _eachLayoutView
 - _getCurrentLayoutBounds
 - _getFragmentManager
 - _getNativeViewsCount
 - _getRootModalViews
 - _getValue
 - _handleLivesync
 - _hasAncestorView
 - _hideNativeModalView
 - _observe
 - _onAttachedToWindow
 - _onDetachedFromWindow
 - _onLivesync
 - _raiseLayoutChangedEvent
 - _raiseShowingModallyEvent
 - _raiseShownModallyEvent
 - _redrawNativeBackground
 - _removeAnimation
 - _setCurrentLayoutBounds
 - _setCurrentMeasureSpecs
 - _setNativeClipToBounds
 - _setNativeViewFrame
 - _setupAsRootView
 - _setValue
 - _showNativeModalView
 - _updateEffectiveLayoutValues
 - _updateStyleScope
 - accessibilityAnnouncement
 - accessibilityScreenChanged
 - addCss
 - addCssFile
 - addEventListener
 - animate
 - changeCssFile
 - closeModal
 - combineMeasuredStates
 - createAnimation
 - eachChild
 - eachChildView
 - focus
 - getActualSize
 - getGestureObservers
 - getLocationInWindow
 - getLocationOnScreen
 - getLocationRelativeTo
 - getMeasuredHeight
 - getMeasuredState
 - getMeasuredWidth
 - getSafeAreaInsets
 - layout
 - layoutChild
 - layoutNativeView
 - measure
 - measureChild
 - onBackPressed
 - onLayout
 - onLoaded
 - onMeasure
 - removeEventListener
 - requestLayout
 - resetNativeView
 - resolveSizeAndState
 - sendAccessibilityEvent
 - setMeasuredDimension
 - setTestID
 - showModal
 
56 methods inherited from ViewBase
Click to expand
Constructors 
constructor 
new ViewCommon(): ViewCommon
 Returns ViewCommon
Properties 
_androidContentDescriptionUpdated 
_closeModalCallback 
Protected
_currentHeightMeasureSpec 
_currentWidthMeasureSpec 
_gestureObservers 
_isLayoutValid 
Protected
_manager 
_modalParent 
_modalParent: ViewCommon
_setMinHeightNative 
_setMinHeightNative: (value: LengthType) => void
_setMinWidthNative 
_setMinWidthNative: (value: LengthType) => void
accessibilityHint 
accessibilityIdentifier 
accessibilityLabel 
accessibilityValue 
ignoreTouchAnimation 
iosIgnoreSafeArea 
iosOverflowSafeArea 
iosOverflowSafeAreaEnabled 
isEnabled 
isUserInteractionEnabled 
originX 
originY 
testID 
touchAnimation 
touchAnimation: boolean | TouchAnimationOptions
touchDelay 
transitionId 
Active transition instance id for tracking state
accessibilityBlurEvent 
Static
accessibilityFocusChangedEvent 
Static
accessibilityFocusEvent 
Static
accessibilityPerformEscapeEvent 
Static
layoutChangedEvent 
Static
showingModallyEvent 
Static
shownModallyEvent 
Static
Accessors 
accessibilityHidden 
get accessibilityHidden(): boolean Returns boolean
accessibilityLanguage 
 Returns string
accessibilityLiveRegion 
get accessibilityLiveRegion(): AccessibilityLiveRegion
 Returns AccessibilityLiveRegion
accessibilityMediaSession 
 Returns boolean
accessibilityRole 
get accessibilityRole(): AccessibilityRole
 Returns AccessibilityRole
accessibilityState 
get accessibilityState(): AccessibilityState
 Returns AccessibilityState
accessible 
 Returns boolean
androidDynamicElevationOffset 
 Returns number
androidElevation 
 Returns number
automationText 
 Returns string
background 
 Returns string
backgroundImage 
 Returns string | LinearGradient
backgroundPosition 
 Returns string
backgroundRepeat 
get backgroundRepeat(): BackgroundRepeatType
 Returns BackgroundRepeatType
backgroundSize 
 Returns string
borderBottomLeftRadius 
get borderBottomLeftRadius(): LengthType
 Returns LengthType
borderBottomRightRadius 
get borderBottomRightRadius(): LengthType
 Returns LengthType
borderBottomWidth 
get borderBottomWidth(): LengthType
 Returns LengthType
borderLeftWidth 
get borderLeftWidth(): LengthType
 Returns LengthType
borderRadius 
get borderRadius(): string | number | LengthDipUnit | LengthPxUnit
 Returns string | number | LengthDipUnit | LengthPxUnit
borderRightWidth 
get borderRightWidth(): LengthType
 Returns LengthType
borderTopLeftRadius 
get borderTopLeftRadius(): LengthType
 Returns LengthType
borderTopRightRadius 
get borderTopRightRadius(): LengthType
 Returns LengthType
borderTopWidth 
get borderTopWidth(): LengthType
 Returns LengthType
borderWidth 
get borderWidth(): string | number | LengthDipUnit | LengthPxUnit
 Returns string | number | LengthDipUnit | LengthPxUnit
boxShadow 
 Returns CSSShadow
css 
 Returns string
cssType 
 Returns string
height 
get height(): PercentLengthType
 Returns PercentLengthType
horizontalAlignment 
get horizontalAlignment(): HorizontalAlignmentType
 Returns HorizontalAlignmentType
iosAccessibilityAdjustsFontSize 
 Returns boolean
iosAccessibilityMaxFontScale 
 Returns number
iosAccessibilityMinFontScale 
 Returns number
isLayoutRequired 
 Returns boolean
isLayoutValid 
 Returns boolean
margin 
get margin(): string | number | LengthDipUnit | LengthPxUnit | LengthPercentUnit
 Returns string | number | LengthDipUnit | LengthPxUnit | LengthPercentUnit
marginBottom 
get marginBottom(): PercentLengthType
 Returns PercentLengthType
marginLeft 
get marginLeft(): PercentLengthType
 Returns PercentLengthType
marginRight 
get marginRight(): PercentLengthType
 Returns PercentLengthType
marginTop 
get marginTop(): PercentLengthType
 Returns PercentLengthType
minHeight 
get minHeight(): LengthType
 Returns LengthType
minWidth 
get minWidth(): LengthType
 Returns LengthType
modal 
get modal(): ViewCommon
 Returns ViewCommon
opacity 
 Returns number
perspective 
 Returns number
rotate 
 Returns number
rotateX 
 Returns number
rotateY 
 Returns number
scaleX 
 Returns number
scaleY 
 Returns number
textTransform 
get textTransform(): TextTransformType
 Returns TextTransformType
translateX 
 Returns number
translateY 
 Returns number
verticalAlignment 
get verticalAlignment(): VerticalAlignmentType
 Returns VerticalAlignmentType
visibility 
get visibility(): VisibilityType
 Returns VisibilityType
width 
get width(): PercentLengthType
 Returns PercentLengthType
Methods 
_applyBackground 
_closeAllModalViewsInternal 
 Returns boolean
_eachLayoutView 
| Parameter | Default | Description | 
callback |  | (View: any) => void | 
 Returns void
_getCurrentLayoutBounds 
 Returns {
  bottom: number
  left: number
  right: number
}
_getFragmentManager 
 Returns any
_getNativeViewsCount 
 Returns number
_getValue 
 Returns never
_handleLivesync 
| Parameter | Default | Description | 
context |  | ModuleContext | 
 Returns boolean
_hasAncestorView 
_hasAncestorView(ancestorView: View): boolean
| Parameter | Default | Description | 
ancestorView |  | 
 Returns boolean
_hideNativeModalView 
Protected
_hideNativeModalView(parent: ViewCommon, whenClosedCallback: () => void): void
| Parameter | Default | Description | 
parent |  | |
whenClosedCallback |  | () => void | 
 Returns void
_observe 
_observe(type: GestureTypes, callback: (args: GestureEventData) => void, thisArg?: any): void
| Parameter | Default | Description | 
type |  | |
callback |  | (args: GestureEventData) => void | 
thisArg |  | any | 
 Returns void
_onAttachedToWindow 
 Returns void
_onDetachedFromWindow 
 Returns void
_onLivesync 
| Parameter | Default | Description | 
context |  | ModuleContext | 
 Returns boolean
_raiseLayoutChangedEvent 
Protected
 Returns void
_raiseShowingModallyEvent 
Protected
 Returns void
_raiseShownModallyEvent 
Protected
 Returns void
_redrawNativeBackground 
| Parameter | Default | Description | 
value |  | any | 
 Returns void
_removeAnimation 
_removeAnimation(animation: Animation): boolean
| Parameter | Default | Description | 
animation |  | 
 Returns boolean
_setCurrentLayoutBounds 
_setCurrentMeasureSpecs 
| Parameter | Default | Description | 
widthMeasureSpec |  | number | 
heightMeasureSpec |  | number | 
 Returns boolean
_setNativeClipToBounds 
 Returns void
_setNativeViewFrame 
| Parameter | Default | Description | 
nativeView |  | any | 
frame |  | any | 
 Returns void
_setValue 
 Returns never
_setupAsRootView 
| Parameter | Default | Description | 
context |  | any | 
 Returns void
_showNativeModalView 
Protected
_showNativeModalView(parent: ViewCommon, options: ShowModalOptions): void
| Parameter | Default | Description | 
parent |  | |
options |  | 
 Returns void
_updateEffectiveLayoutValues 
_updateEffectiveLayoutValues(
  parentWidthMeasureSize: number,
  parentWidthMeasureMode: number,
  parentHeightMeasureSize: number,
  parentHeightMeasureMode: number
): void| Parameter | Default | Description | 
parentWidthMeasureSize |  | number | 
parentWidthMeasureMode |  | number | 
parentHeightMeasureSize |  | number | 
parentHeightMeasureMode |  | number | 
 Returns void
_updateStyleScope 
| Parameter | Default | Description | 
cssFileName |  | string | 
cssString |  | string | 
css |  | string | 
 Returns void
accessibilityAnnouncement 
| Parameter | Default | Description | 
msg |  | string | 
 Returns void
accessibilityScreenChanged 
 Returns void
addCss 
| Parameter | Default | Description | 
cssString |  | string | 
 Returns void
addCssFile 
| Parameter | Default | Description | 
cssFileName |  | string | 
 Returns void
addEventListener 
addEventListener(arg: string | GestureTypes, callback: (data: EventData) => void, thisArg?: any): void
| Parameter | Default | Description | 
arg |  | string | GestureTypes | 
callback |  | (data: EventData) => void | 
thisArg |  | any | 
 Returns void
animate 
| Parameter | Default | Description | 
animation |  | any | 
 Returns AnimationPromise
changeCssFile 
| Parameter | Default | Description | 
cssFileName |  | string | 
 Returns void
closeModal 
| Parameter | Default | Description | 
args |  | any[] | 
 Returns void
createAnimation 
eachChild 
eachChildView 
focus 
 Returns boolean
getGestureObservers 
getGestureObservers(type: GestureTypes): GesturesObserver[]
| Parameter | Default | Description | 
type |  | 
 Returns GesturesObserver[]
getLocationInWindow 
 Returns Point
getLocationOnScreen 
 Returns Point
getLocationRelativeTo 
getLocationRelativeTo(otherView: View): Point
| Parameter | Default | Description | 
otherView |  | 
 Returns Point
getMeasuredHeight 
 Returns number
getMeasuredState 
 Returns number
getMeasuredWidth 
 Returns number
getSafeAreaInsets 
 Returns {
  bottom: any
  left: any
  right: any
}
layout 
| Parameter | Default | Description | 
left |  | number | 
top |  | number | 
right |  | number | 
bottom |  | number | 
 Returns void
layoutNativeView 
Abstract
| Parameter | Default | Description | 
left |  | number | 
top |  | number | 
right |  | number | 
bottom |  | number | 
 Returns void
measure 
| Parameter | Default | Description | 
widthMeasureSpec |  | number | 
heightMeasureSpec |  | number | 
 Returns void
onBackPressed 
 Returns boolean
onLayout 
Abstract
| Parameter | Default | Description | 
left |  | number | 
top |  | number | 
right |  | number | 
bottom |  | number | 
 Returns void
onLoaded 
 Returns void
onMeasure 
Abstract
| Parameter | Default | Description | 
widthMeasureSpec |  | number | 
heightMeasureSpec |  | number | 
 Returns void
removeEventListener 
removeEventListener(arg: string | GestureTypes, callback?: (data: EventData) => void, thisArg?: any): void
| Parameter | Default | Description | 
arg |  | string | GestureTypes | 
callback |  | (data: EventData) => void | 
thisArg |  | any | 
 Returns void
requestLayout 
 Returns void
resetNativeView 
 Returns void
sendAccessibilityEvent 
| Parameter | Default | Description | 
options |  | Partial<AccessibilityEventOptions> | 
 Returns void
setMeasuredDimension 
| Parameter | Default | Description | 
measuredWidth |  | number | 
measuredHeight |  | number | 
 Returns void
setTestID 
| Parameter | Default | Description | 
view |  | any | 
value |  | string | 
 Returns void
combineMeasuredStates 
Static
| Parameter | Default | Description | 
curState |  | number | 
newState |  | any | 
 Returns number
layoutChild 
Static
measureChild 
Static
measureChild(parent: ViewCommon, child: ViewCommon, widthMeasureSpec: number, heightMeasureSpec: number): { measuredHeight: number }
| Parameter | Default | Description | 
parent |  | |
child |  | |
widthMeasureSpec |  | number | 
heightMeasureSpec |  | number | 
 Returns {
  measuredHeight: number
}
resolveSizeAndState 
Static
- Previous
 - ViewBase
 - Next
 - ViewHelper