ContextualFlowRowScope

Interface

Common

Deprecated ContextualFlowLayouts are no longer maintained

@LayoutScopeMarker
@ExperimentalLayoutApi
interface ContextualFlowRowScope : RowScope

Defines the scope for items within a ContextualFlowRow.

Properties

Common
val lineIndex: Int

Identifies the row or column index where the UI component(s) are to be placed, provided they do not exceed the specified maxWidthInLine and maxHeight for that row or column.

Should the component(s) surpass these dimensions, their placement may shift to the subsequent row/column or they may be omitted from display, contingent upon the defined constraints.

Common
val indexInLine: Int

Marks the index within the current row/column where the next component is to be inserted, assuming it conforms to the row's or column's maxWidthInLine and maxHeight limitations.

In scenarios where multiple UI components are returned in one index call, this parameter is relevant solely to the first returned UI component, presuming it complies with the row's or column's defined constraints.

Common
val maxWidthInLine: Dp

Specifies the maximum permissible width (main-axis) for the upcoming UI component at the given lineIndex and indexInLine. Exceeding this width may result in the component being reallocated to the following row within the ContextualFlowRow structure, subject to existing constraints.

Common
val maxHeight: Dp

Determines the maximum allowable height (cross-axis) for the forthcoming UI component, aligned with its lineIndex and indexInLine. Should this height threshold be exceeded, the component's visibility will depend on the overflow settings, potentially leading to its exclusion.

Functions

@ExperimentalLayoutApi
    fun Modifier.fillMaxRowHeight(@FloatRange(from = 0.0, to = 1.0) fraction: Float = 1f): Modifier

Have the item fill (possibly only partially) the max height of the tallest item in the row it was placed in, within the FlowRow.

Parameters

fractionThe fraction of the max height of the tallest item between 0 and 1, inclusive.