FlowColumnOverflow

Class

Common

Deprecated FlowLayout overflow is no longer maintained

@ExperimentalLayoutApi
class FlowColumnOverflow
private constructor(
    type: OverflowType,
    minLinesToShowCollapse: Int = 0,
    minCrossAxisSizeToShowCollapse: Int = 0,
    seeMoreGetter: ((state: FlowLayoutOverflowState) -> @Composable () -> Unit)? = null,
    collapseGetter: ((state: FlowLayoutOverflowState) -> @Composable () -> Unit)? = null,
) :
    FlowLayoutOverflow(
        type,
        minLinesToShowCollapse,
        minCrossAxisSizeToShowCollapse,
        seeMoreGetter,
        collapseGetter,
    )

Overflow Handling Options

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

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.

Companion Object

Properties

Common

@ExperimentalLayoutApi
    val Visible = FlowColumnOverflow(FlowLayoutOverflow.OverflowType.Visible)

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

Common

@ExperimentalLayoutApi val Clip = FlowColumnOverflow(FlowLayoutOverflow.OverflowType.Clip)

Clip the overflowing content to fix its container.

Methods

Common

@ExperimentalLayoutApi
        fun expandIndicator(
            content: @Composable FlowColumnOverflowScope.() -> Unit
        ): FlowColumnOverflow

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

This function allows the creation of a custom composable that can be displayed when there are more items in the FlowColumn 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 that visually indicates more items can be loaded.

Common

@ExperimentalLayoutApi
        @Composable
        fun expandOrCollapseIndicator(
            expandIndicator: @Composable FlowColumnOverflowScope.() -> Unit,
            collapseIndicator: @Composable FlowColumnOverflowScope.() -> Unit,
            minColumnsToShowCollapse: Int = 1,
            minWidthToShowCollapse: Dp = 0.dp,
        ): FlowColumnOverflow

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

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.

Parameters


minColumnsToShowCollapse	Specifies the minimum number of columns that should be visible before showing the collapse option. This parameter is useful when the number of columns is too small to be reduced further.
minWidthToShowCollapse	Specifies the minimum width at which the collapse option should be displayed. This parameter is useful for preventing the collapse option from appearing when the width is too narrow.
expandIndicator	composable that visually indicates more items can be loaded.
collapseIndicator	composable that visually indicates less items can be loaded.