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

.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.

.handleScrollSnap()

(e: UIScrollEvent): void

Handle given scroll event to snap scroll position to content components; called automatically when the container is scrolled, but may be overridden.

.applyStyle() protected

(style?: UIStyle): void

Inherited from UIContainer.applyStyle.

.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

Readonly<ContainerLayout>

Inherited from UIContainer.layout.

.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() deprecated

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

Inherited from UIComponent.propagateComponentEvent.

.delegateEvent() protected

(e: ManagedEvent, propertyName: string): true

Inherited from UIComponent.delegateEvent.

.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.

.style

UIStyle

Inherited from UIComponent.style.

.hidden

boolean

Inherited from UIComponent.hidden.

.dimensions

Readonly<Dimensions>

Inherited from UIComponent.dimensions.

.position

Readonly<Position>

Inherited from UIComponent.position.

.accessibleRole

string

Inherited from UIComponent.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.accessibleLabel.

.lastRenderOutput

Output<this, any>

Inherited from UIComponent.lastRenderOutput.

.isPresetComponent() protected

(): boolean

Inherited from Component.isPresetComponent.

.getParentComponent()

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

Inherited from Component.getParentComponent.

.getBoundParentComponent()

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

Inherited from Component.getBoundParentComponent.

.emitAction()

(name: string, inner?: ManagedEvent, context?: ManagedObject): void

Inherited from Component.emitAction.

.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

<TParent extends ManagedObject = 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.