ContextualFlowRowOverflow

Artifact: androidx.compose.foundation:foundation-layout

View Source

Added in 1.7.0

Common/AllAndroid/JVM

• Cmn

  @ExperimentalLayoutApi
  class ContextualFlowRowOverflow : FlowLayoutOverflow

kotlin.Any
↳	androidx.compose.foundation.layout.FlowLayoutOverflow
	↳	androidx.compose.foundation.layout.ContextualFlowRowOverflow

---

Overflow Handling Options

This enumeration defines the available options for handling content that exceeds the boundaries of its container for ContextualFlowRow.

Options:

• Visible: The overflowing content remains visible outside its container. This can lead to overlapping with other elements. Use this option when it's crucial to display all content, regardless of the container's size.

• Clip: The overflowing content is clipped and not visible beyond the boundary of its container. Ideal for maintaining a clean and uncluttered UI, where overlapping elements are undesirable.

• expandIndicator: Behaves similar to Clip, however shows an indicator or button indicating that more items can be loaded.

• expandOrCollapseIndicator: Extends the expandIndicator functionality by adding a 'Collapse' option. After expanding the content, users can choose to collapse it back to the summary view.

Summary

Public companion functions
ContextualFlowRowOverflow	@ExperimentalLayoutApi expandIndicator(content: @Composable ContextualFlowRowOverflowScope.() -> Unit) Registers an "expand indicator" composable for handling overflow in a ContextualFlowRow.	Cmn
ContextualFlowRowOverflow	@ExperimentalLayoutApi @Composable expandOrCollapseIndicator(     expandIndicator: @Composable ContextualFlowRowOverflowScope.() -> Unit,     collapseIndicator: @Composable ContextualFlowRowOverflowScope.() -> Unit,     minRowsToShowCollapse: Int,     minHeightToShowCollapse: Dp ) Registers an "expand or collapse indicator" composable for handling overflow in a ContextualFlowRow.	Cmn

Public companion properties
ContextualFlowRowOverflow	@ExperimentalLayoutApi Clip Clip the overflowing content to fix its container.	Cmn
ContextualFlowRowOverflow	@ExperimentalLayoutApi Visible Display all content, even if there is not enough space in the specified bounds.	Cmn

Public companion functions

expandIndicator

Cmn

Added in 1.7.0

@ExperimentalLayoutApi
fun expandIndicator(content: @Composable ContextualFlowRowOverflowScope.() -> Unit): ContextualFlowRowOverflow

Registers an "expand indicator" composable for handling overflow in a ContextualFlowRow.

This function allows the creation of a custom composable that can be displayed when there are more items in the ContextualFlowRow than can be displayed in the available space. The "expandable indicator" composable can be tailored to show a summary, a button, or any other composable element that indicates the presence of additional items.

Parameters
content: @Composable ContextualFlowRowOverflowScope.() -> Unit	composable that visually indicates more items can be loaded.

expandOrCollapseIndicator

Cmn

@ExperimentalLayoutApi
@Composable
fun expandOrCollapseIndicator(
    expandIndicator: @Composable ContextualFlowRowOverflowScope.() -> Unit,
    collapseIndicator: @Composable ContextualFlowRowOverflowScope.() -> Unit,
    minRowsToShowCollapse: Int = 1,
    minHeightToShowCollapse: Dp = 0.dp
): ContextualFlowRowOverflow

Registers an "expand or collapse indicator" composable for handling overflow in a ContextualFlowRow.

This function is designed to switch between two states: a "Expandable" state when there are more items to show, and a "Collapsable" state when all items are being displayed and can be collapsed.

Prior to layout, the function evaluates both composables indicators to determine their maximum intrinsic size. Depending on the space available and the number of items, either the expandIndicator or the collapseIndicator is rendered.

import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.ContextualFlowRow
import androidx.compose.foundation.layout.ContextualFlowRowOverflow
import androidx.compose.foundation.layout.ContextualFlowRowOverflowScope
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.layout.wrapContentHeight
import androidx.compose.material.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp

val totalCount = 300
var maxLines by remember { mutableStateOf(2) }

Text(
    modifier =
        Modifier.fillMaxWidth(1f).padding(20.dp).wrapContentHeight(align = Alignment.Top),
    text =
        "ContextualFlowRow (based on Subcompose)" +
            " is great for Large Items & +N dynamic labels",
    fontWeight = FontWeight.Bold
)
val moreOrCollapseIndicator =
    @Composable { scope: ContextualFlowRowOverflowScope ->
        val remainingItems = totalCount - scope.shownItemCount
        DynamicSeeMore(isHorizontal = true, remainingItems = remainingItems) {
            if (remainingItems == 0) {
                maxLines = 2
            } else {
                maxLines += 5
            }
        }
    }
ContextualFlowRow(
    modifier =
        Modifier.fillMaxWidth(1f).padding(20.dp).wrapContentHeight(align = Alignment.Top),
    horizontalArrangement = Arrangement.spacedBy(10.dp),
    verticalArrangement = Arrangement.spacedBy(20.dp),
    maxLines = maxLines,
    overflow =
        ContextualFlowRowOverflow.expandOrCollapseIndicator(
            minRowsToShowCollapse = 4,
            expandIndicator = moreOrCollapseIndicator,
            collapseIndicator = moreOrCollapseIndicator
        ),
    itemCount = totalCount
) {
    Box(
        Modifier.align(Alignment.CenterVertically)
            .width(50.dp)
            .height(50.dp)
            .background(Color.Green)
    ) {
        Text(
            text = it.toString(),
            fontSize = 18.sp,
            modifier = Modifier.padding(3.dp).align(Alignment.Center)
        )
    }
}

Parameters
expandIndicator: @Composable ContextualFlowRowOverflowScope.() -> Unit	composable that visually indicates more items can be loaded.
collapseIndicator: @Composable ContextualFlowRowOverflowScope.() -> Unit	composable that visually indicates less items can be loaded.
minRowsToShowCollapse: Int = 1	Specifies the minimum number of rows that should be visible before showing the collapse option. This parameter is useful when the number of rows is too small to be reduced further.
minHeightToShowCollapse: Dp = 0.dp	Specifies the minimum height at which the collapse option should be displayed. This parameter is useful for preventing the collapse option from appearing when the height is too narrow.

Public companion properties

Clip

Cmn

Added in 1.7.0

@ExperimentalLayoutApi
val Clip: ContextualFlowRowOverflow

Clip the overflowing content to fix its container.

Visible

Cmn

Added in 1.7.0

@ExperimentalLayoutApi
val Visible: ContextualFlowRowOverflow

Display all content, even if there is not enough space in the specified bounds.