computeUniformPoolSize

Compute pool dimensions for a uniform grid (all cells share one cellSize)

Available since @roku-sdk/flex-grid 3.3.0

import { computeUniformPoolSize } from "@roku-sdk/flex-grid";
computeUniformPoolSize(viewportWidth: number, viewportHeight: number, cellWidth: number, cellHeight: number, hGap: number, vGap: number, isWrap: boolean, extraBuffer: number): PoolSizeResult

Deprecated.

Grid geometry is managed by the grid implementation. Will be removed from the public exports in the next major version.

Description

Compute pool dimensions for a uniform grid (all cells share one cellSize).

Parameters

NameTypeDescription
viewportWidthnumberVisible viewport width in pixels
viewportHeightnumberVisible viewport height in pixels
cellWidthnumberWidth of each cell
cellHeightnumberHeight of each cell
hGapnumberHorizontal gap between cells
vGapnumberVertical gap between rows
isWrapbooleanWhether fixedFocusWrap strategy is active (adds 2 extra cols)
extraBuffernumberOptional additional node buffer (poolBuffer prop)

Return values

Returns PoolSizeResult.


Did this page help you?