BetaBeta pública — Consulta las notas de lanzamiento
Solidiom
Comenzar
Documentación

Virtual List

Viewport-windowed list for large datasets.

Paquete
@solidiom/virtual-list
Versión
0.0.1-next.0
Estado
stable

Generado a partir del código fuente público del paquete.

API

createVirtualizerfunción

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

                        createVirtualizer(options: CreateVirtualizerOptions): VirtualizerState

Ver código fuente

CreateVirtualizerOptionsinterfaz

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

Propiedades

containerSize?
Accessor<number> — Container height in pixels.
itemSize
number | (index: number) => number — Fixed item height (px), or function for variable heights.
onScrollOffsetChange?
(offset: number) => void — Callback when scroll offset changes (for controlled mode).
overscan?
number — Number of extra items rendered above/below viewport. Default: 3.
port?
VirtualizationPort — Custom virtualization port. Uses fixed-height fallback if omitted.
scrollOffset?
Accessor<number> — Controlled scroll offset.
totalCount
Accessor<number> — Total number of items in the list.

Ver código fuente

Itemcomponente

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

                        Item(props: VirtualListItemProps): Element

Propiedades

class?
string
item
VirtualItem — The virtual item descriptor.
style?
string | CSSProperties

hijos: Element

Ver código fuente

Rootcomponente

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

                        Root(props: VirtualListRootProps): Element

Propiedades

class?
string — Custom class on the scroll container.
height
string — Height of the scroll container (CSS value).
itemSize
number | (index: number) => number — Fixed item height (px), or function for variable heights.
onScrollOffsetChange?
(offset: number) => void — Callback when scroll offset changes.
overscan?
number — Extra items rendered beyond viewport. Default: 3.
port?
VirtualizationPort — Custom virtualization port.
ref?
(el: HTMLDivElement) => void
scrollOffset?
Accessor<number> — Controlled scroll offset.
style?
string | CSSProperties — Custom styles on the scroll container.
totalCount
number — Total number of items.

hijos: (items: Accessor<VirtualItem[]>) => Element

Ver código fuente

VirtualConfiginterfaz

Configuration passed to the virtualization port for computing visible items.

Propiedades

containerSize
number
itemSize
number | (index: number) => number
overscan?
number
scrollOffset
number
totalCount
number

Ver código fuente

VirtualIteminterfaz

A single virtual item with layout coordinates.

Propiedades

end
number
index
number
size
number
start
number

Ver código fuente

VirtualizationPortinterfaz

Adapter port for virtualization engines (e.g. TanStack Virtual). Consumers inject a custom implementation; a built-in fallback handles fixed-height lists when no port is provided.

Ver código fuente

VirtualizerStateinterfaz

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

Propiedades

containerSize
Accessor<number>
scrollOffset
Accessor<number>
scrollToIndex
(index: number) => void
setScrollOffset
(offset: number) => void
totalSize
Accessor<number>
virtualItems
Accessor<VirtualItem[]>

Ver código fuente

VirtualListContextValueinterfaz

Propiedades

containerSize
Accessor<number>
scrollOffset
Accessor<number>
scrollToIndex
(index: number) => void
setScrollOffset
(offset: number) => void
totalSize
Accessor<number>
virtualItems
Accessor<VirtualItem[]>

Ver código fuente

VirtualListItemPropsinterfaz

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

Propiedades

class?
string
item
VirtualItem — The virtual item descriptor.
style?
string | CSSProperties

hijos: Element

Ver código fuente

VirtualListRootPropsinterfaz

@solidiom/virtual-list — Headless viewport-windowed list primitive. Parts: Root (scroll container), Item (positioned child). Also exports createVirtualizer() for standalone usage.

Propiedades

class?
string — Custom class on the scroll container.
height
string — Height of the scroll container (CSS value).
itemSize
number | (index: number) => number — Fixed item height (px), or function for variable heights.
onScrollOffsetChange?
(offset: number) => void — Callback when scroll offset changes.
overscan?
number — Extra items rendered beyond viewport. Default: 3.
port?
VirtualizationPort — Custom virtualization port.
ref?
(el: HTMLDivElement) => void
scrollOffset?
Accessor<number> — Controlled scroll offset.
style?
string | CSSProperties — Custom styles on the scroll container.
totalCount
number — Total number of items.

hijos: (items: Accessor<VirtualItem[]>) => Element

Ver código fuente