ContextualFlowColumnScope

Deprecated ContextualFlowLayouts are no longer maintained

@LayoutScopeMarker
@ExperimentalLayoutApi
interface ContextualFlowColumnScope : ColumnScope

Provides a scope for items within a ContextualFlowColumn.

Properties

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 maxWidth and maxHeightInLine 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.

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 maxWidth and maxHeightInLine 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.

val maxWidth: Dp

Sets the maximum width (cross-axis dimension) that the upcoming UI component can occupy, based on its lineIndex and indexInLine. Exceeding this width might result in the component not being displayed, depending on the ContextualFlowColumnOverflow.Visible overflow configuration.

val maxHeightInLine: Dp

Establishes the maximum height (main-axis dimension) permissible for the next UI component, aligned with its lineIndex and indexInLine. Should the component's height exceed this limit, it may be shifted to the subsequent column in ContextualFlowColumn, subject to the predefined constraints.

Functions

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

Have the item fill (possibly only partially) the max width of the widest item in the column it was placed in, within the FlowColumn.

Parameters