πŸš€ 8.9 Released! β†’ ⚑️ New Node-API Engine Preview, πŸ“² ns widget ios, πŸ’… Tailwind v4 and more...
Read Announcement
ScrollView
Represents a scrollable area that can have content that is larger than its bounds.

Summary ​

Constructors

constructor

Properties

horizontalOffset
isScrollEnabled
orientation
scrollableHeight
scrollableWidth
scrollBarIndicatorVisible
scrollEvent
verticalOffset
155 properties inherited from ContentView
Click to expand
_androidContentDescriptionUpdated
_automaticallyAdjustsScrollViewInsets
_closeModalCallback
_context
_cssState
_defaultPaddingBottom
_defaultPaddingLeft
_defaultPaddingRight
_defaultPaddingTop
_domId
_ignoreFlexMinWidthHeightReset
_isAddedToNativeVisualTree
_isLayoutValid
_isPaddingRelative
_isStyleScopeHost
_oldBottom
_oldLeft
_oldRight
_oldTop
_styleScope
_suspendNativeUpdatesCount
accessibilityBlurEvent
accessibilityFocusChangedEvent
accessibilityFocusEvent
accessibilityHidden
accessibilityHint
accessibilityIdentifier
accessibilityLabel
accessibilityLanguage
accessibilityLiveRegion
accessibilityMediaSession
accessibilityPerformEscapeEvent
accessibilityRole
accessibilityState
accessibilityValue
accessible
alignSelf
android
androidDynamicElevationOffset
androidElevation
automationText
background
backgroundColor
backgroundImage
bindingContext
borderBottomColor
borderBottomLeftRadius
borderBottomRightRadius
borderBottomWidth
borderColor
borderLeftColor
borderLeftWidth
borderRadius
borderRightColor
borderRightWidth
borderTopColor
borderTopLeftRadius
borderTopRightRadius
borderTopWidth
borderWidth
boxShadow
className
col
color
colSpan
column
columnSpan
content
createdEvent
cssClasses
cssPseudoClasses
cssType
disposeNativeViewEvent
dock
domNode
effectiveBorderBottomWidth
effectiveBorderLeftWidth
effectiveBorderRightWidth
effectiveBorderTopWidth
effectiveHeight
effectiveLeft
effectiveMarginBottom
effectiveMarginLeft
effectiveMarginRight
effectiveMarginTop
effectiveMinHeight
effectiveMinWidth
effectivePaddingBottom
effectivePaddingLeft
effectivePaddingRight
effectivePaddingTop
effectiveTop
effectiveWidth
flexGrow
flexShrink
flexWrapBefore
height
horizontalAlignment
id
ignoreTouchAnimation
ios
iosAccessibilityAdjustsFontSize
iosAccessibilityMaxFontScale
iosAccessibilityMinFontScale
iosIgnoreSafeArea
iosOverflowSafeArea
iosOverflowSafeAreaEnabled
isCollapsed
isEnabled
isLayoutValid
isUserInteractionEnabled
layoutChangedEvent
left
loadedEvent
margin
marginBottom
marginLeft
marginRight
marginTop
minHeight
minWidth
modal
nativeViewProtected
opacity
order
originX
originY
parent
perspective
propertyChangeEvent
recycleNativeView
reusable
rotate
rotateX
rotateY
row
rowSpan
scaleX
scaleY
sharedTransitionIgnore
sharedTransitionTag
showingModallyEvent
shownModallyEvent
testID
top
touchAnimation
touchDelay
transitionId
translateX
translateY
unloadedEvent
verticalAlignment
viewController
visibility
width

Methods

_onOrientationChanged
on
scrollToHorizontalOffset
scrollToVerticalOffset
113 methods inherited from ContentView
Click to expand
_addChildFromBuilder
_addView
_addViewCore
_addViewToNativeVisualTree
_applyXmlAttribute
_batchUpdate
_childIndexToNativeChildIndex
_closeAllModalViewsInternal
_createPropertyChangeData
_dialogClosed
_eachLayoutView
_emit
_getNativeViewsCount
_getRootModalViews
_getValue
_handleLivesync
_hasAncestorView
_hideNativeModalView
_inheritStyleScope
_layoutParent
_observe
_onAttachedToWindow
_onDetachedFromWindow
_onRootViewReset
_onSizeChanged
_parentChanged
_raiseLayoutChangedEvent
_raiseShowingModallyEvent
_raiseShownModallyEvent
_removeView
_removeViewCore
_removeViewFromNativeVisualTree
_resumeNativeUpdates
_setupAsRootView
_setupUI
_setValue
_shouldDelayLayout
_showNativeModalView
_suspendNativeUpdates
_tearDownUI
_updateStyleScope
accessibilityAnnouncement
accessibilityScreenChanged
addEventListener
addEventListener
addPseudoClass
animate
bind
callLoaded
callUnloaded
closeModal
combineMeasuredStates
createAnimation
createNativeView
deletePseudoClass
destroyNode
disposeNativeView
eachChild
eachChildView
ensureDomNode
focus
get
getActualSize
getGestureObservers
getLocationInWindow
getLocationOnScreen
getLocationRelativeTo
getMeasuredHeight
getMeasuredState
getMeasuredWidth
getSafeAreaInsets
getViewByDomId
getViewById
hasGestureObservers
hasListeners
initNativeView
layout
layoutChild
layoutNativeView
layoutView
loadView
measure
measureChild
notify
notifyPropertyChange
off
off
on
onBackPressed
once
once
onLayout
onLoaded
onMeasure
onResumeNativeUpdates
onUnloaded
removeEventListener
removeEventListener
requestLayout
resetNativeView
resolveSizeAndState
sendAccessibilityEvent
set
setInlineStyle
setMeasuredDimension
setNativeView
setOnTouchListener
setProperty
setTestID
showModal
toString
unbind
unloadView

Constructors ​

constructor ​

new ScrollView(): ScrollView 

Properties ​

horizontalOffset ​

horizontalOffset: number
Gets a value that contains the horizontal offset of the scrolled content.

isScrollEnabled ​

isScrollEnabled: boolean
Gets or sets a value indicating whether scroll is enabled.

orientation ​

orientation: OrientationType 
Gets or sets direction in which the content can be scrolled.

scrollBarIndicatorVisible ​

scrollBarIndicatorVisible: boolean
Toggles scrollbar indicator visibility

scrollableHeight ​

scrollableHeight: number
Gets the maximum value for the verticalOffset.

scrollableWidth ​

scrollableWidth: number
Gets the maximum value for the horizontalOffset.

verticalOffset ​

verticalOffset: number
Gets a value that contains the vertical offset of the scrolled content.

scrollEvent ​

Static
scrollEvent: string
String value used when hooking to scroll event.

Methods ​

_onOrientationChanged ​

_onOrientationChanged(): void

on ​

on(eventNames: string, callback: (data: EventData) => void, thisArg?: any): void
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
Parameter Default Description
eventNames
string

String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").

callback
(data: EventData) => void

Callback function which will be executed when event is raised.

thisArg
any

An optional parameter which will be used as `this` context for callback execution.

Returns void
on(event: "scroll", callback: (args: ScrollEventData) => void, thisArg?: any): void
Raised when a scroll event occurs.
Parameter Default Description
event
"scroll"
callback
(args: ScrollEventData) => void
thisArg
any
Returns void

scrollToHorizontalOffset ​

scrollToHorizontalOffset(value: number, animated: boolean): any
Scrolls the content the specified horizontal offset position.
Parameter Default Description
value
number

The offset value

animated
boolean

true for animated scroll, false for immediate scroll.

Returns any

scrollToVerticalOffset ​

scrollToVerticalOffset(value: number, animated: boolean): any
Scrolls the content the specified vertical offset position.
Parameter Default Description
value
number

The offset value

animated
boolean

true for animated scroll, false for immediate scroll.

Returns any
Previous
Screen

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /