stream-chat-android-compose/io.getstream.chat.android.compose.ui.theme/ChatTheme

ChatTheme

fun ChatTheme(isInDarkMode: Boolean = isSystemInDarkTheme(), autoTranslationEnabled: Boolean = false, showOriginalTranslationEnabled: Boolean = false, isComposerLinkPreviewEnabled: Boolean = false, useDefaultSystemMediaPicker: Boolean = false, systemAttachmentsPickerConfig: SystemAttachmentsPickerConfig = SystemAttachmentsPickerConfig(), colors: StreamColors = if (isInDarkMode) StreamColors.defaultDarkColors() else StreamColors.defaultColors(), dimens: StreamDimens = StreamDimens.defaultDimens(), typography: StreamTypography = StreamTypography.defaultTypography(), shapes: StreamShapes = StreamShapes.defaultShapes(), rippleConfiguration: StreamRippleConfiguration = StreamRippleConfiguration.defaultRippleConfiguration( contentColor = LocalContentColor.current, lightTheme = !isInDarkMode, ), userPresence: UserPresence = UserPresence(), componentFactory: ChatComponentFactory = DefaultChatComponentFactory(), attachmentFactories: List<AttachmentFactory> = StreamAttachmentFactories.defaults(), messageContentFactory: MessageContentFactory = MessageContentFactory.Deprecated, attachmentPreviewHandlers: List<AttachmentPreviewHandler> = AttachmentPreviewHandler.defaultAttachmentHandlers(LocalContext.current), quotedAttachmentFactories: List<AttachmentFactory> = StreamAttachmentFactories.defaultQuotedFactories(), reactionIconFactory: ReactionIconFactory = ReactionIconFactory.defaultFactory(), reactionPushEmojiFactory: ReactionPushEmojiFactory = ReactionPushEmojiFactory.defaultFactory(), reactionOptionsTheme: ReactionOptionsTheme = ReactionOptionsTheme.defaultTheme(), messagePreviewIconFactory: MessagePreviewIconFactory = MessagePreviewIconFactory.defaultFactory(), pollSwitchItemFactory: PollSwitchItemFactory = DefaultPollSwitchItemFactory(context = LocalContext.current), allowUIAutomationTest: Boolean = false, dateFormatter: DateFormatter = DateFormatter.from(LocalContext.current), timeProvider: TimeProvider = TimeProvider.DEFAULT, durationFormatter: DurationFormatter = DurationFormatter.defaultFormatter(), channelNameFormatter: ChannelNameFormatter = ChannelNameFormatter.defaultFormatter(LocalContext.current), messagePreviewFormatter: MessagePreviewFormatter = MessagePreviewFormatter.defaultFormatter( context = LocalContext.current, typography = typography, attachmentFactories = attachmentFactories, autoTranslationEnabled = autoTranslationEnabled, colors = colors, ), searchResultNameFormatter: SearchResultNameFormatter = SearchResultNameFormatter.defaultFormatter(), imageLoaderFactory: StreamCoilImageLoaderFactory = StreamCoilImageLoaderFactory.defaultFactory(), imageHeadersProvider: ImageHeadersProvider = DefaultImageHeadersProvider, asyncImageHeadersProvider: AsyncImageHeadersProvider? = null, downloadAttachmentUriGenerator: DownloadAttachmentUriGenerator = DefaultDownloadAttachmentUriGenerator, downloadRequestInterceptor: DownloadRequestInterceptor = DownloadRequestInterceptor { }, imageAssetTransformer: ImageAssetTransformer = DefaultImageAssetTransformer, messageAlignmentProvider: MessageAlignmentProvider = MessageAlignmentProvider.defaultMessageAlignmentProvider(), messageOptionsTheme: MessageOptionsTheme = MessageOptionsTheme.defaultTheme(), channelOptionsTheme: ChannelOptionsTheme = ChannelOptionsTheme.defaultTheme(), messageOptionsUserReactionAlignment: MessageOptionsUserReactionAlignment = MessageOptionsUserReactionAlignment.END, attachmentsPickerTabFactories: List<AttachmentsPickerTabFactory> = if (useDefaultSystemMediaPicker) { AttachmentsPickerTabFactories.systemAttachmentsPickerTabFactories(systemAttachmentsPickerConfig) } else { AttachmentsPickerTabFactories.defaultFactories() }, videoThumbnailsEnabled: Boolean = true, streamCdnImageResizing: StreamCdnImageResizing = StreamCdnImageResizing.defaultStreamCdnImageResizing(), readCountEnabled: Boolean = true, ownMessageTheme: MessageTheme = MessageTheme.defaultOwnTheme( isInDarkMode = isInDarkMode, typography = typography, shapes = shapes, colors = colors, ), otherMessageTheme: MessageTheme = MessageTheme.defaultOtherTheme( isInDarkMode = isInDarkMode, typography = typography, shapes = shapes, colors = colors, ), messageDateSeparatorTheme: MessageDateSeparatorTheme = MessageDateSeparatorTheme.defaultTheme( typography = typography, colors = colors, ), messageUnreadSeparatorTheme: MessageUnreadSeparatorTheme = MessageUnreadSeparatorTheme.defaultTheme( typography = typography, colors = colors, ), messageComposerTheme: MessageComposerTheme = MessageComposerTheme.defaultTheme( isInDarkMode = isInDarkMode, typography = typography, shapes = shapes, colors = colors, ), attachmentPickerTheme: AttachmentPickerTheme = AttachmentPickerTheme.defaultTheme(colors), messageTextFormatter: MessageTextFormatter = MessageTextFormatter.defaultFormatter( autoTranslationEnabled = autoTranslationEnabled, typography = typography, shapes = shapes, colors = colors, ownMessageTheme = ownMessageTheme, otherMessageTheme = otherMessageTheme, ), quotedMessageTextFormatter: QuotedMessageTextFormatter = QuotedMessageTextFormatter.defaultFormatter( autoTranslationEnabled = autoTranslationEnabled, context = LocalContext.current, typography = typography, shapes = shapes, colors = colors, ownMessageTheme = ownMessageTheme, otherMessageTheme = otherMessageTheme, ), streamMediaRecorder: StreamMediaRecorder = DefaultStreamMediaRecorder(LocalContext.current), keyboardBehaviour: StreamKeyboardBehaviour = StreamKeyboardBehaviour.defaultBehaviour(), mediaGalleryConfig: MediaGalleryConfig = MediaGalleryConfig(), content: @Composable () -> Unit)

Our theme that provides all the important properties for styling to the user.

Parameters

isInDarkMode

If we're currently in the dark mode or not. Affects only the default color palette that's provided. If you customize colors, make sure to add your own logic for dark/light colors.

autoTranslationEnabled

Whether messages auto translation is enabled or not.

showOriginalTranslationEnabled

Whether the option to show the original translation is enabled or not.

isComposerLinkPreviewEnabled

Whether the composer link preview is enabled or not.

useDefaultSystemMediaPicker

Flag that determines which attachment picker should be used. If true, the system attachments picker which doesn't use storage permissions will be used. If false, the default attachments picker which requires storage permissions will be used.

systemAttachmentsPickerConfig

Configuration for the system attachments picker.

colors

The set of colors we provide, wrapped in StreamColors.

dimens

The set of dimens we provide, wrapped in StreamDimens.

typography

The set of typography styles we provide, wrapped in StreamTypography.

shapes

The set of shapes we provide, wrapped in StreamShapes.

rippleConfiguration

Defines the appearance for ripples.

userPresence

The user presence display configuration.

componentFactory

Provide to customize the stateless components that are used throughout the UI

attachmentFactories

Attachment factories that we provide.

attachmentPreviewHandlers

Attachment preview handlers we provide.

quotedAttachmentFactories

Quoted attachment factories that we provide.

reactionIconFactory

Used to create an icon Painter for the given reaction type.

reactionPushEmojiFactory

Used to create an emoji code for a given reaction type (used for push notifications).

reactionOptionsTheme

ReactionOptionsTheme Theme for the reaction option list in the selected message menu. For theming the message option list in the same menu, use messageOptionsTheme.

messagePreviewIconFactory

Used to create a preview icon for the given message type.

allowUIAutomationTest

Allow to simulate ui automation with given test tags.

dateFormatter

DateFormatter Used throughout the app for date and time information.

timeProvider

TimeProvider Used throughout the app for time information.

durationFormatter

DurationFormatter Used to format durations in the app.

channelNameFormatter

ChannelNameFormatter Used throughout the app for channel names.

messagePreviewFormatter

MessagePreviewFormatter Used to generate a string preview for the given message.

imageLoaderFactory

A factory that creates new Coil ImageLoader instances. If used in combination with asyncImageHeadersProvider you must override the StreamCoilImageLoaderFactory.imageLoader method accepting the interceptors parameter.

imageAssetTransformer

ImageAssetTransformer Used to transform image assets.

imageHeadersProvider

ImageHeadersProvider Deprecated. Use asyncImageHeadersProvider instead. Headers provided here are injected synchronously on the main thread, which blocks the UI for any non-trivial work.

asyncImageHeadersProvider

AsyncImageHeadersProvider Used to provide headers for image requests. Invoked on IO Dispatcher inside Coil's interceptor pipeline, making it safe for blocking or suspending operations such as reading an auth token. Prefer this over imageHeadersProvider. If you are using this in combination with a custom StreamCoilImageLoaderFactory you must override the StreamCoilImageLoaderFactory.imageLoader method accepting the interceptors parameter.

downloadAttachmentUriGenerator

DownloadAttachmentUriGenerator Used to generate download URIs for attachments.

downloadRequestInterceptor

DownloadRequestInterceptor Used to intercept download requests.

messageAlignmentProvider

MessageAlignmentProvider Used to provide message alignment for the given message.

messageOptionsTheme

MessageOptionsTheme Theme for the message option list in the selected message menu. For theming the reaction option list in the same menu, use reactionOptionsTheme.

messageOptionsUserReactionAlignment

Alignment of the user reaction inside the message options.

attachmentsPickerTabFactories

Attachments picker tab factories that we provide.

videoThumbnailsEnabled

Dictates whether video thumbnails will be displayed inside video previews.

streamCdnImageResizing

Sets the strategy for resizing images hosted on Stream's CDN. Disabled by default, set StreamCdnImageResizing.imageResizingEnabled to true if you wish to enable resizing images. Note that resizing applies only to images hosted on Stream's CDN which contain the original height (oh) and width (ow) query parameters.

ownMessageTheme

Theme of the current user messages.

otherMessageTheme

Theme of the other users messages.

messageDateSeparatorTheme

Theme of the message date separator.

messageUnreadSeparatorTheme

Theme of the message unread separator.

messageComposerTheme

Theme of the message composer.

attachmentPickerTheme

Theme of the attachment picker.

streamMediaRecorder

Used for recording audio messages.

keyboardBehaviour

Configuration for different keyboard behaviours.

mediaGalleryConfig

Configuration for the media gallery screen.

content

The content shown within the theme wrapper.