UIScrollContainer

class UIScrollContainer

extends UIContainer

Represents a UI component that contains other components and allows scrolling horizontally and/or vertically, and emits throttled scroll events (Scroll and ScrollEnd, see UIScrollEvent).

Constructor

(...content: UIRenderable[]): UIScrollContainer

.style

UIStyle

Combined style set; when this is set to an instance of UIStyle, the individual style object properties (e.g. UIComponent.dimensions) are set to read-only objects taken from the UIStyle instance. To override individual properties, set these properties after setting style, or use Component.with to create a new constructor.

.verticalSnap

"start" | "end" | "center"

Vertical scroll snap mode: start (snap to start of first ‘mostly’ visible component), center (snap container center to center of component closest to the center), or end (snap to end of last ‘mostly’ visible component).

.horizontalSnap

"start" | "end" | "center"

Horizontal scroll snap mode: start (snap to start of first ‘mostly’ visible component), center (snap container center to center of component closest to the center), or end (snap to end of last ‘mostly’ visible component).

.topThreshold

number

Vertical threshold (in pixels) until which UIScrollEvent.atTop is set, defaults to 0.

.bottomThreshold

number

Vertical threshold (in pixels) until which UIScrollEvent.atBottom is set, defaults to 0.

.leftThreshold

number

Horizontal threshold (in pixels) until which UIScrollEvent.atLeft is set, defaults to 0.

.rightThreshold

number

Horizontal threshold (in pixels) until which UIScrollEvent.atRight is set, defaults to 0.

.verticalScrollEnabled

boolean

True if vertical scrolling should be enabled, defaults to true.

.horizontalScrollEnabled

boolean

True if horizontal scrolling should be enabled, defaults to true.

.applyStyle() protected

(style: UIStyle): void

Inherited from UIContainer.applyStyle.

.applyLayout() protected

(layout: Partial<ContainerLayout>): void

Inherited from UIContainer.applyLayout.

.isFocusable()

(): boolean

Inherited from UIContainer.isFocusable.

.isKeyboardFocusable()

(): boolean

Inherited from UIContainer.isKeyboardFocusable.

.allowFocus

boolean

Inherited from UIContainer.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UIContainer.allowKeyboardFocus.

.layout

ContainerLayout

Inherited from UIContainer.layout.

.separator

SeparatorOptions

Inherited from UIContainer.separator.

.asyncContentRendering

boolean

Inherited from UIContainer.asyncContentRendering.

.animatedContentRenderingDuration

number

Inherited from UIContainer.animatedContentRenderingDuration.

.animatedContentRenderingVelocity

number

Inherited from UIContainer.animatedContentRenderingVelocity.

.content

ManagedList<UIRenderable>

Inherited from UIContainer.content.

.propagateComponentEvent()

(name: string, inner?: ManagedEvent, event?: any): void

Inherited from UIComponent.propagateComponentEvent.

.render()

(callback: RenderCallback<Output<UIRenderable, any>>): void

Inherited from UIComponent.render.

.requestFocus()

(): void

Inherited from UIComponent.requestFocus.

.requestFocusNext()

(): void

Inherited from UIComponent.requestFocusNext.

.requestFocusPrevious()

(): void

Inherited from UIComponent.requestFocusPrevious.

.hidden

boolean

Inherited from UIComponent.hidden.

.dimensions

Dimensions

Inherited from UIComponent.dimensions.

.position

Position

Inherited from UIComponent.position.

.accessibleRole

string

Inherited from UIComponent.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.accessibleLabel.

.revealTransition

UITransitionType

Inherited from UIComponent.revealTransition.

.exitTransition

UITransitionType

Inherited from UIComponent.exitTransition.

.lastRenderOutput

Output<this, any>

Inherited from UIComponent.lastRenderOutput.

.isPresetComponent() protected

(): boolean

Inherited from Component.isPresetComponent.

.getParentComponent()

[1]. (): Component
[2]. <TParent extends Component>(ParentClass: ComponentConstructor<TParent>): TParent

Inherited from Component.getParentComponent.

.getCompositeParent()

<TParent extends Component>(ParentClass?: ComponentConstructor<TParent>): TParent

Inherited from Component.getCompositeParent.

.managedId

number

Inherited from ManagedObject.managedId.

.managedState

ManagedState

Inherited from ManagedObject.managedState.

.getReferenceCount() protected

(): number

Inherited from ManagedObject.getReferenceCount.

.getManagedReferrers() protected

(): ManagedObject[]

Inherited from ManagedObject.getManagedReferrers.

.getManagedParent() protected

[1]. (): ManagedObject
[2]. <TParent extends ManagedObject>(ParentClass: ManagedObjectConstructor<TParent>): TParent

Inherited from ManagedObject.getManagedParent.

.emit()

<TEvent extends ManagedEvent = ManagedEvent, TConstructorArgs extends any[] = any[]>(e: string | TEvent | (new (...args: TConstructorArgs) => TEvent), ...constructorArgs: TConstructorArgs): this

Inherited from ManagedObject.emit.

.propagateChildEvents() protected

[1]. (f?: (this: this, e: ManagedEvent, propertyName: string) => void | ManagedEvent | ManagedEvent[]): this
[2]. (...types: (ManagedEvent | (new (...args: any[]) => ManagedEvent))[]): this

Inherited from ManagedObject.propagateChildEvents.

.activateManagedAsync() protected

(): Promise<any>

Inherited from ManagedObject.activateManagedAsync.

.deactivateManagedAsync() protected

(): Promise<void>

Inherited from ManagedObject.deactivateManagedAsync.

.destroyManagedAsync() protected

(): Promise<void>

Inherited from ManagedObject.destroyManagedAsync.

.onManagedStateActivatingAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateActivatingAsync.

.onManagedStateActiveAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateActiveAsync.

.onManagedStateDeactivatingAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateDeactivatingAsync.

.onManagedStateInactiveAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateInactiveAsync.

.onManagedStateDestroyingAsync() protected

(): Promise<void>

Inherited from ManagedObject.onManagedStateDestroyingAsync.


UIScrollContainer.Presets

extends UIContainer.Presets

UIScrollContainer presets type, for use with Component.with.

.verticalScrollEnabled

boolean

True if vertical scrolling should be enabled, defaults to true.

.horizontalScrollEnabled

boolean

True if horizontal scrolling should be enabled, defaults to true.

.verticalSnap

"start" | "end" | "center"

Vertical scroll snap mode: start (snap to start of first ‘mostly’ visible component), center (snap container center to center of component closest to the center), or end (snap to end of last ‘mostly’ visible component).

.horizontalSnap

"start" | "end" | "center"

Horizontal scroll snap mode: start (snap to start of first ‘mostly’ visible component), center (snap container center to center of component closest to the center), or end (snap to end of last ‘mostly’ visible component).

.topThreshold

number

Vertical threshold (in pixels) until which UIScrollEvent.atTop is set, defaults to 0.

.bottomThreshold

number

Vertical threshold (in pixels) until which UIScrollEvent.atBottom is set, defaults to 0.

.leftThreshold

number

Horizontal threshold (in pixels) until which UIScrollEvent.atLeft is set, defaults to 0.

.rightThreshold

number

Horizontal threshold (in pixels) until which UIScrollEvent.atRight is set, defaults to 0.

.onScroll

UIComponentEventHandler<UIComponent, UIComponentEvent<UIComponent>>

Event handler for Scroll events.

.onScrollEnd

UIComponentEventHandler<UIComponent, UIComponentEvent<UIComponent>>

Event handler for ScrollEnd events.

.content

Iterable<UIRenderable>

Inherited from UIContainer.Presets.content.

.layout

Partial<{}> | Partial<ContainerLayout>

Inherited from UIContainer.Presets.layout.

.separator

SeparatorOptions

Inherited from UIContainer.Presets.separator.

.allowFocus

boolean

Inherited from UIContainer.Presets.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UIContainer.Presets.allowKeyboardFocus.

.asyncContentRendering

boolean

Inherited from UIContainer.Presets.asyncContentRendering.

.animatedContentRenderingDuration

number

Inherited from UIContainer.Presets.animatedContentRenderingDuration.

.animatedContentRenderingVelocity

number

Inherited from UIContainer.Presets.animatedContentRenderingVelocity.

.style

string | UIStyle

Inherited from UIComponent.Presets.style.

.hidden

boolean

Inherited from UIComponent.Presets.hidden.

.dimensions

Partial<{}> | Partial<Dimensions>

Inherited from UIComponent.Presets.dimensions.

.position

Partial<{}> | Partial<Position>

Inherited from UIComponent.Presets.position.

.accessibleRole

string

Inherited from UIComponent.Presets.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.Presets.accessibleLabel.

.requestFocus

boolean

Inherited from UIComponent.Presets.requestFocus.

.revealTransition

UITransitionType

Inherited from UIComponent.Presets.revealTransition.

.exitTransition

UITransitionType

Inherited from UIComponent.Presets.exitTransition.