stream-chat-android-compose/io.getstream.chat.android.compose.ui.util

Package-level declarations

Types

typealias AnnotatedMessageTextBuilder = AnnotatedString.Builder.(message: Message, currentUser: User?) -> Unit

A builder for the annotated message text.

typealias AnnotatedQuotedMessageTextBuilder = AnnotatedString.Builder.(message: Message, replyMessage: Message?, currentUser: User?) -> Unit

A builder for the annotated message text.

DefaultPollSwitchItemFactory

class DefaultPollSwitchItemFactory(context: Context) : PollSwitchItemFactory

The default implementation of PollSwitchItemFactory that holds the default poll switch items.ø

MessageAlignmentProvider

fun interface MessageAlignmentProvider

An interface that allows to return the desired horizontal alignment for a particular MessageItemState.

MessagePreviewFormatter

interface MessagePreviewFormatter

An interface that allows to generate a preview text for the given message.

MessagePreviewIconFactory

interface MessagePreviewIconFactory

An interface that allows the creation of message preview icons for message types.

MessageTextFormatter

fun interface MessageTextFormatter

An interface that allows to format the message text.

PollSwitchItemFactory

@Stable

interface PollSwitchItemFactory

An interface that allows the creation of poll switch items for the creation screen.

QuotedMessageTextFormatter

fun interface QuotedMessageTextFormatter

An interface that allows to format the quoted message text.

ReactionDrawable

data class ReactionDrawable(@DrawableRes val iconResId: Int, @DrawableRes val selectedIconResId: Int)

Contains drawable resources for normal and selected reaction states.

ReactionIcon

data class ReactionIcon(val painter: Painter, val selectedPainter: Painter)

Contains Painters for normal and selected states of the reaction icon.

ReactionIconFactory

interface ReactionIconFactory

An interface that allows the creation of reaction icons for reaction types.

SearchResultNameFormatter

fun interface SearchResultNameFormatter

An interface that allows to generate a title text for the given message.

StorageHelperWrapper

class StorageHelperWrapper(context: Context, storageHelper: StorageHelper, attachmentFilter: AttachmentFilter)

Wrapper around the StorageHelper class, with some extra functionality that makes it easier to decouple the business logic and make it consistent.

StreamCoilImageLoaderFactory

fun interface StreamCoilImageLoaderFactory

A factory that creates new Coil ImageLoader instances.

StreamImageLoaderProvidableCompositionLocal

@JvmInline

value class StreamImageLoaderProvidableCompositionLocal

A provider of CompositionLocal that returns the current ImageLoader for the composition.

Properties

LocalStreamImageLoader

val LocalStreamImageLoader: StreamImageLoaderProvidableCompositionLocal

A CompositionLocal that returns the current ImageLoader for the composition. If a local ImageLoader has not been provided, it returns the singleton instance of ImageLoader in Coil.

Functions

rememberMessageListState

@Composable

fun rememberMessageListState(initialFirstVisibleItemIndex: Int = 0, initialFirstVisibleItemScrollOffset: Int = 0, parentMessageId: String? = null, messageOffsetHandler: MessagesLazyListState.MessageOffsetHandler = MessagesLazyListState.defaultOffsetHandler): MessagesLazyListState

Provides a MessagesLazyListState that's tied to a given message list. This is the default behavior, where we keep the base scroll position of the list persisted at all times, while the thread scroll state is always new, whenever we enter a thread.

rememberMessagesLazyListState

@Composable

fun rememberMessagesLazyListState(initialFirstVisibleItemIndex: Int = 0, initialFirstVisibleItemScrollOffset: Int = 0, messageOffsetHandler: MessagesLazyListState.MessageOffsetHandler = MessagesLazyListState.defaultOffsetHandler): MessagesLazyListState

Creates a MessagesLazyListState that is remembered across compositions. Changes to the provided initial values will not result in the state being recreated or changed in any way if it has already been created.

rememberStreamImagePainter

@Composable

fun ~~rememberStreamImagePainter~~(model: ImageRequest, placeholderPainter: Painter? = null, errorPainter: Painter? = null, fallbackPainter: Painter? = errorPainter, onLoading: (AsyncImagePainter.State.Loading) -> Unit? = null, onSuccess: (AsyncImagePainter.State.Success) -> Unit? = null, onError: (AsyncImagePainter.State.Error) -> Unit? = null, contentScale: ContentScale = ContentScale.Fit, filterQuality: FilterQuality = DrawScope.DefaultFilterQuality): AsyncImagePainter

@Composable

fun ~~rememberStreamImagePainter~~(data: Any?, placeholderPainter: Painter? = null, errorPainter: Painter? = null, fallbackPainter: Painter? = errorPainter, onLoading: (AsyncImagePainter.State.Loading) -> Unit? = null, onSuccess: (AsyncImagePainter.State.Success) -> Unit? = null, onError: (AsyncImagePainter.State.Error) -> Unit? = null, contentScale: ContentScale = ContentScale.Fit, filterQuality: FilterQuality = DrawScope.DefaultFilterQuality): AsyncImagePainter

Wrapper around the coil.compose.rememberAsyncImagePainter that plugs in our LocalStreamImageLoader singleton that can be used to customize all image loading requests, like adding headers, interceptors and similar.

StreamImage

@Composable

fun StreamImage(imageRequest: () -> ImageRequest, modifier: Modifier = Modifier, component: ImageComponent = rememberImageComponent {}, imageOptions: ImageOptions = ImageOptions(), onImageStateChanged: (CoilImageState) -> Unit = {}, previewPlaceholder: Painter? = null, loading: @Composable BoxScope.(imageState: CoilImageState.Loading) -> Unit? = null, success: @Composable BoxScope.(imageState: CoilImageState.Success, painter: Painter) -> Unit? = null, failure: @Composable BoxScope.(imageState: CoilImageState.Failure) -> Unit? = null)

@Composable

fun StreamImage(data: () -> Any?, modifier: Modifier = Modifier, component: ImageComponent = rememberImageComponent {}, requestListener: () -> ImageRequest.Listener? = null, imageOptions: ImageOptions = ImageOptions(), onImageStateChanged: (CoilImageState) -> Unit = {}, previewPlaceholder: Painter? = null, loading: @Composable BoxScope.(imageState: CoilImageState.Loading) -> Unit? = null, success: @Composable BoxScope.(imageState: CoilImageState.Success, painter: Painter) -> Unit? = null, failure: @Composable BoxScope.(imageState: CoilImageState.Failure) -> Unit? = null)

Wrapper around the CoilImage that plugs in our LocalStreamImageLoader singleton that can be used to customize all image loading requests, like adding headers, interceptors and similar.

Inherited functions

getLastMessage

fun Channel.getLastMessage(currentUser: User?): Message?

Returns channel's last regular or system message if exists. Deleted and silent messages, as well as messages from shadow-banned users, are not taken into account.

getLastSeenText

fun User.getLastSeenText(context: Context): String

Returns a string describing the elapsed time since the user was online (was watching the channel).

getMembersStatusText

fun Channel.getMembersStatusText(context: Context, currentUser: User?): String

Returns a string describing the member status of the channel: either a member count for a group channel or the last seen text for a direct one-to-one conversation with the current user.

getOtherUsers

fun Channel.getOtherUsers(currentUser: User?): List<User>

Returns a list of users that are members of the channel excluding the currently logged in user.

getReadStatuses

fun Channel.getReadStatuses(userToIgnore: User?): List<Date>

Filters the read status of each person other than the target user.

isDistinct

fun Channel.isDistinct(): Boolean

Checks if the channel is distinct.

isOneToOne

fun Channel.isOneToOne(currentUser: User?): Boolean

Checks if the channel is a direct conversation between the current user and some other user.

mirrorRtl

fun Modifier.mirrorRtl(layoutDirection: LayoutDirection): Modifier

Applies the given mirroring scaleX based on the layoutDirection that's currently configured in the UI.