Documentation
On this page

Interface · Data and Templates

VirtualListProps

Props accepted by createVirtualList.

@sharpts/gui 0.0.0-local · SharpTS 7c6010104a43

Members

allowDrop

allowDrop?: boolean

Allows native drag data to be dropped on this control.

Inherited

Type: boolean

automationName

automationName?: string

Accessible automation name exposed to assistive technology and test drivers.

Inherited

Type: string

canvasLeft

canvasLeft?: number

Canvas left coordinate when parented by Canvas.

Inherited

Type: number

canvasTop

canvasTop?: number

Canvas top coordinate when parented by Canvas.

Inherited

Type: number

capturePointerOnPress

capturePointerOnPress?: boolean

Captures a pressed pointer until release, cancellation, unmount, or disposal.

Inherited

Type: boolean

classes

classes?: readonly string[]

Avalonia style classes applied to the native control.

Inherited

Type: readonly string[]

dock

dock?: Dock

Edge used when the control is placed in a DockPanel.

Inherited

Type: Dock

gridColumn

gridColumn?: number

Zero-based column index when the control is placed in a Grid.

Inherited

Type: number

gridColumnSpan

gridColumnSpan?: number

Number of Grid columns occupied by the control.

Inherited

Type: number

gridRow

gridRow?: number

Zero-based row index when the control is placed in a Grid.

Inherited

Type: number

gridRowSpan

gridRowSpan?: number

Number of Grid rows occupied by the control.

Inherited

Type: number

height

height?: number

Preferred control height in device-independent pixels.

Inherited

Type: number

horizontalAlignment

horizontalAlignment?: HorizontalAlignment

Horizontal alignment within the parent layout slot.

Inherited

Type: HorizontalAlignment

isEnabled

isEnabled?: boolean

Whether the control accepts user interaction.

Inherited

Type: boolean

isVisible

isVisible?: boolean

Whether the control participates in rendering and layout.

Inherited

Type: boolean

itemKey

itemKey(item: T, index: number): ItemKey

Returns a stable key for an item and index.

items

items: readonly T[]

Complete logical item collection.

Type: readonly T[]

key

key?: ItemKey

Optional reconciliation key for the list control.

Type: ItemKey

margin

margin?: Thickness

Space outside the control.

Inherited

Type: Thickness

maxHeight

maxHeight?: number

Maximum permitted control height.

Inherited

Type: number

maxWidth

maxWidth?: number

Maximum permitted control width.

Inherited

Type: number

minHeight

minHeight?: number

Minimum permitted control height.

Inherited

Type: number

minWidth

minWidth?: number

Minimum permitted control width.

Inherited

Type: number

onDragOver

onDragOver?(event: DropEvent): DropEffect

Chooses the accepted native drag effect.

Inherited

onDrop

onDrop?(event: DropEvent): void | Promise<unknown>

Receives normalized text and local-file drop data.

Inherited

onKeyDown

onKeyDown?(event: KeyEvent): boolean

Handles a normalized key-down event.

Inherited

onKeyUp

onKeyUp?(event: KeyEvent): boolean

Handles a normalized key-up event.

Inherited

onPointerCancel

onPointerCancel?(event: PointerEvent): boolean

Handles cancellation or loss of an active pointer capture using its last known local state.

Inherited

onPointerDown

onPointerDown?(event: PointerEvent): boolean

Handles a normalized pointer press.

Inherited

onPointerMove

onPointerMove?(event: PointerEvent): boolean

Handles normalized pointer movement.

Inherited

onPointerUp

onPointerUp?(event: PointerEvent): boolean

Handles a normalized pointer release.

Inherited

onSelectionChanged

onSelectionChanged?(indices: number[]): void

Called with logical item indices after selection changes.

opacity

opacity?: number

Opacity from zero (transparent) to one (opaque).

Inherited

Type: number

overscan

overscan?: number

Extra item count rendered before and after the viewport.

Type: number

ref

ref?: ControlRef<unknown>

Receives the retained native control handle.

Inherited

Type: ControlRef<unknown>

renderItem

renderItem: ItemTemplate<T>

Renders one visible item.

Type: ItemTemplate<T>

selectedIndices

selectedIndices?: readonly number[]

Selected logical item indices.

Type: readonly number[]

selectionMode

selectionMode?: SelectionMode

Single- or multiple-selection behavior.

Type: SelectionMode

startIndex

startIndex: number

Zero-based first visible logical item index.

Type: number

toolTip

toolTip?: string

Text shown when the pointer pauses over the control.

Inherited

Type: string

verticalAlignment

verticalAlignment?: VerticalAlignment

Vertical alignment within the parent layout slot.

Inherited

Type: VerticalAlignment

visibleCount

visibleCount: number

Number of logical items in the visible viewport.

Type: number

width

width?: number

Preferred control width in device-independent pixels.

Inherited

Type: number

Source

SharpTS.Gui.Sdk/GuiPackage/runtime.ts:806 at SharpTS revision 7c6010104a43c34d80e9d44704cf179bc4f5b8e0.