stream-chat-android-ui-common/io.getstream.chat.android.ui.common.utils/ExpandableList

ExpandableList

data class ExpandableList<T>(items: List<T>, minimumVisibleItems: Int = items.size, val isCollapsed: Boolean = true) : List<T>

A read-only, immutable list wrapper that supports expandable and collapsible behavior.

This class behaves like a standard List but adds metadata and logic to control visibility of its elements based on a specified minimumVisibleItems threshold and current isCollapsed state.

Behavior:

When isCollapsed is true and the total item count exceeds minimumVisibleItems, only the first minimumVisibleItems items are exposed through the list interface. The remaining items are considered collapsed.
When isCollapsed is false, all items are exposed.
If the total number of items is less than or equal to minimumVisibleItems, all items are shown, and the list is not expandable.

Parameters

T

the type of elements contained in the list.

items

the full list of items to wrap.

minimumVisibleItems

the minimum number of items to show when collapsed. Defaults to the full list size (no collapsing by default).

isCollapsed

whether the list is currently collapsed (hiding excess items).

Constructors

constructor(items: List<T>, minimumVisibleItems: Int = items.size, isCollapsed: Boolean = true)

Properties

val canExpand: Boolean

Indicates whether the list can be expanded or collapsed, i.e., when the number of items exceeds minimumVisibleItems.

val collapsedCount: Int

The number of items that are currently collapsed (not visible). Returns 0 if the list is expanded or cannot be expanded.

val isCollapsed: Boolean = true

Inherited properties

open override val size: Int

Inherited functions

open override fun addFirst(p0: T)

open override fun addLast(p0: T)

open operator override fun contains(element: T): Boolean

open override fun containsAll(elements: Collection<T>): Boolean

open fun forEach(p0: Consumer<in T>)

open operator override fun get(index: Int): T

open override fun ~~getFirst~~(): T

open override fun ~~getLast~~(): T

getUserByNameOrId

fun List<User>.getUserByNameOrId(nameOrId: String): User?

open override fun indexOf(element: T): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): Iterator<T>

open override fun lastIndexOf(element: T): Int

open override fun listIterator(): ListIterator<T>

open override fun listIterator(index: Int): ListIterator<T>

open fun parallelStream(): Stream<T>

open override fun removeFirst(): T

open override fun removeLast(): T

open override fun reversed(): MutableList<T>

open override fun spliterator(): Spliterator<T>

open fun stream(): Stream<T>

open override fun subList(fromIndex: Int, toIndex: Int): List<T>

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>