chat: add Jetpack Compose support to documentation #2991

ttypic · 2025-12-01T09:38:32Z

Description

Added examples showcasing the use of Jetpack Compose APIs in the chat SDK.
Updated documentation to include Jetpack Compose methods such as collectAsPagingMessagesState(), collectAsCurrentlyTyping(), collectAsStatus(), and others.
Extended sections with Jetpack Compose-specific code snippets for message reactions, typing events, room management, and more.

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2025-12-01T09:38:39Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

- Added examples showcasing the use of Jetpack Compose APIs in the chat SDK. - Updated documentation to include Jetpack Compose methods such as `collectAsPagingMessagesState()`, `collectAsCurrentlyTyping()`, `collectAsStatus()`, and others. - Extended sections with Jetpack Compose-specific code snippets for message reactions, typing events, room management, and more.

AndyTWF · 2025-12-08T13:35:50Z

src/data/languages/languageInfo.ts

    label: 'Kotlin',
    syntaxHighlighterKey: 'kotlin',
  },
+  jetpack: {


I added these as a fixup so that it shows up in docs - could you source an icon for Jetpack so it shows in the language selector?

I have added alias to kotlin, so it will use kotlin icon for now

Created PR to add icon -> ably/ably-ui#1023

AndyTWF · 2025-12-08T14:36:21Z

src/pages/docs/chat/setup.mdx

+```
+
+```jetpack
+import com.ably.chat.ChatClient


The indentation on the code examples are different between Kotlin and Jetpack in many places (despite being the same code) - can we fix this?

Fixed -> b8cf371

AndyTWF · 2025-12-08T14:40:14Z

src/pages/docs/chat/connect.mdx

 </Code>
 </If>

 ## Handle connection discontinuity <a id="discontinuity"/>


We have discontinuityAsFlow - should that be mentioned here?

Fixed -> b8cf371

AndyTWF · 2025-12-08T14:50:52Z

src/pages/docs/chat/rooms/messages.mdx

 </If>

+<If lang="jetpack">
+For Jetpack Compose, use the [`collectAsPagingMessagesState()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/jetpack/chat-extensions-compose/com.ably.chat.extensions.compose/collect-as-paging-messages-state.html) composable function to observe messages with automatic pagination support. Alternatively, you can use [`messages.subscribe()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/dokka/chat/com.ably.chat/-messages/subscribe.html) for a simple subscription:


We should avoid saying "For Jetpack Compose", as the language selector filters all this out. It should just be "Use the..."

Fixed -> b8cf371

AndyTWF · 2025-12-08T14:51:55Z

src/pages/docs/chat/rooms/messages.mdx

-<If lang="javascript,kotlin">
-Use the `unsubscribe()` function returned in the `subscribe()` response to remove a chat message listener:
+<If lang="javascript,kotlin,jetpack">
+Use the `unsubscribe()` function returned in the `subscribe()` response to remove a chat message listener<If lang="jetpack">. When using Jetpack Compose's `collectAsPagingMessagesState()`, lifecycle and cleanup are handled automatically</If>:


I think we can remove this extra sentence, because someone using jetpack won't be expecting to use it? So we just say:

"collectAsPagingMessagesState() handles lifecycle and cleanup automatically"

Fixed -> b8cf371

AndyTWF · 2025-12-08T15:03:50Z

src/pages/docs/chat/rooms/occupancy.mdx


 ### Occupancy event structure

 The following is the structure of an occupancy event:


We need to fix this for Kotlin and Swift

added for kotlin,swift and jetpack

AndyTWF · 2025-12-08T15:04:09Z

src/pages/docs/chat/rooms/occupancy.mdx


-<If lang="javascript,kotlin">
-Use the `unsubscribe()` function returned in the `subscribe()` response to remove a room occupancy listener:
+<If lang="javascript,kotlin,jetpack">


Ditto re Jetpack having its own if block rather than tacking on the end of kotlin

jetpack block has been removed, since it automatically handles unsubscribe as a part of the component lifecycle.

Removed the block

AndyTWF · 2025-12-08T15:04:30Z

src/pages/docs/chat/rooms/occupancy.mdx

+```jetpack
+// Jetpack Compose handles cleanup automatically
+// When using subscribe directly:
+val (unsubscribe) = room.occupancy.subscribe { event ->


Ditto re whether we should be encouraging manual subscription with jetpack

Removed the code, it's not needed similar to swift

AndyTWF · 2025-12-08T15:05:25Z

src/pages/docs/chat/rooms/message-reactions.mdx


 Note that if sending two identical reactions of type `Distinct`, the second one will be accepted and broadcast as a raw reaction, but it will be ignored in the summary (aggregate). Similarly, when removing a reaction that doesn't exist (of any type), the operation will be accepted and broadcast as a raw reaction, but it will have no effect on the summary.

 ### Configure the default reaction type <a id="default-type"/>


Needs a jetpack

Added -> 37360d5

AndyTWF · 2025-12-08T15:06:07Z

src/pages/docs/chat/rooms/message-reactions.mdx


 ## Messages and reactions <a id="messages-and-reactions"/>

 The `Message` object contains a `reactions` property which is an object that looks like this:


Needs Kotlin+Swift section

Added -> 37360d5

Copilot

Pull request overview

This pull request adds comprehensive Jetpack Compose support to the Ably Chat SDK documentation. It introduces a new "jetpack" language option alongside existing Kotlin examples, providing developers with Compose-specific APIs and patterns for building chat applications with reactive state management.

Changes:

Added "jetpack" as a new language option in the documentation system with appropriate configuration and syntax highlighting
Extended all major chat feature documentation pages with Jetpack Compose code examples showcasing composable functions and state management
Fixed several existing typos and syntax errors in Kotlin code examples (spelling corrections and bracket issues)

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 33 comments.

Show a summary per file

File	Description
`src/data/languages/types.ts`	Added 'jetpack' to the list of supported language keys
`src/data/languages/languageInfo.ts`	Configured Jetpack Compose with label and Kotlin syntax highlighting
`src/data/languages/languageData.ts`	Added version 1.0 for jetpack in chat SDK
`src/pages/docs/chat/setup.mdx`	Added Jetpack Compose dependency installation and client instantiation examples
`src/pages/docs/chat/rooms/typing.mdx`	Added composable examples for typing indicators using collectAsCurrentlyTyping()
`src/pages/docs/chat/rooms/reactions.mdx`	Added composable examples for room reactions and fixed "reaciton" typo
`src/pages/docs/chat/rooms/presence.mdx`	Added composable examples for presence management with collectAsPresenceMembers()
`src/pages/docs/chat/rooms/occupancy.mdx`	Added composable examples for occupancy tracking with collectAsOccupancy()
`src/pages/docs/chat/rooms/messages.mdx`	Added composable examples for messages with collectAsPagingMessagesState() and fixed broken markdown link
`src/pages/docs/chat/rooms/message-reactions.mdx`	Added composable examples for message reactions and fixed syntax errors with extra parentheses
`src/pages/docs/chat/rooms/index.mdx`	Added composable examples for room status monitoring with collectAsStatus()
`src/pages/docs/chat/rooms/history.mdx`	Added composable examples for message history with pagination support
`src/pages/docs/chat/connect.mdx`	Added composable examples for connection status monitoring

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/pages/docs/chat/rooms/message-reactions.mdx

src/pages/docs/chat/rooms/typing.mdx

src/pages/docs/chat/rooms/presence.mdx

src/pages/docs/chat/rooms/messages.mdx

src/pages/docs/chat/rooms/typing.mdx

src/pages/docs/chat/rooms/reactions.mdx

src/pages/docs/chat/rooms/messages.mdx

src/pages/docs/chat/rooms/message-reactions.mdx

src/pages/docs/chat/rooms/history.mdx

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 14 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/pages/docs/chat/rooms/message-reactions.mdx

src/pages/docs/chat/connect.mdx

src/pages/docs/chat/rooms/presence.mdx

src/pages/docs/chat/rooms/occupancy.mdx

src/pages/docs/chat/rooms/message-reactions.mdx

src/pages/docs/chat/rooms/history.mdx

src/pages/docs/chat/rooms/messages.mdx

…be method - Added missing Room imports for occupancy and presence - Fixed android.mdx to use `historyBeforeSubscribe` method instead of `getPreviousMessages`

# Conflicts: # src/pages/docs/chat/rooms/messages.mdx

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 14 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/pages/docs/chat/rooms/history.mdx

src/pages/docs/chat/rooms/presence.mdx

src/pages/docs/chat/rooms/messages.mdx

src/pages/docs/chat/rooms/presence.mdx

src/pages/docs/chat/rooms/messages.mdx

src/pages/docs/chat/rooms/message-reactions.mdx

src/pages/docs/chat/rooms/messages.mdx

src/pages/docs/chat/rooms/index.mdx

rather than imports

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/pages/docs/chat/rooms/history.mdx

src/pages/docs/chat/rooms/presence.mdx

… merged into ably-ui - Bumped up kotlin and jetpack version to 1.1

sacOO7 · 2026-01-14T07:45:27Z

Closing in favor of #3097

ttypic requested a review from AndyTWF December 1, 2025 09:38

ttypic force-pushed the chat-jetpack-compose branch from d33713d to 3d7feab Compare December 1, 2025 09:39

AndyTWF added the review-app Create a Heroku review app label Dec 8, 2025

ably-ci temporarily deployed to ably-docs-chat-jetpack--sgdwpj December 8, 2025 12:08 Inactive

fixup! chat: add Jetpack Compose support to documentation

e6875ba

ably-ci temporarily deployed to ably-docs-chat-jetpack--sgdwpj December 8, 2025 12:58 Inactive

AndyTWF reviewed Dec 8, 2025

View reviewed changes

sacOO7 requested review from Copilot and sacOO7 January 8, 2026 12:05

Copilot started reviewing on behalf of sacOO7 January 12, 2026 13:55 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

sacOO7 mentioned this pull request Jan 12, 2026

Updated README with jetpack compose extensions ably/ably-chat-kotlin#187

Draft

Refactored jetpack code snippets as per review comments

0293510

sacOO7 force-pushed the chat-jetpack-compose branch from b8cf371 to 0293510 Compare January 12, 2026 17:18

sacOO7 requested a review from Copilot January 12, 2026 17:21

Copilot started reviewing on behalf of sacOO7 January 12, 2026 17:21 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

Added missing doc for swift, kotlin and jetpack for message-reactions

37360d5

sacOO7 force-pushed the chat-jetpack-compose branch 2 times, most recently from 27b058c to 8e8d3bd Compare January 13, 2026 13:48

- Fixed history.mdx for kotlin and jetpack using historyBeforeSubscri…

1abfd27

…be method - Added missing Room imports for occupancy and presence - Fixed android.mdx to use `historyBeforeSubscribe` method instead of `getPreviousMessages`

sacOO7 force-pushed the chat-jetpack-compose branch from 8e8d3bd to 1abfd27 Compare January 13, 2026 13:53

sacOO7 added 2 commits January 13, 2026 19:28

Fixed gradle dep. installation syntax groovy for chat-kotlin

f363830

Merge branch 'main' into chat-jetpack-compose

838a06c

# Conflicts: # src/pages/docs/chat/rooms/messages.mdx

sacOO7 requested a review from Copilot January 13, 2026 14:07

Copilot started reviewing on behalf of sacOO7 January 13, 2026 14:08 View session

Copilot AI reviewed Jan 13, 2026

View reviewed changes

Package imports shortened to make sure devs can focus on actual snippets

4a5066e

rather than imports

sacOO7 requested a review from Copilot January 13, 2026 14:42

Copilot started reviewing on behalf of sacOO7 January 13, 2026 14:42 View session

Copilot AI reviewed Jan 13, 2026

View reviewed changes

src/pages/docs/chat/rooms/history.mdx Outdated Show resolved Hide resolved

src/pages/docs/chat/rooms/presence.mdx Outdated Show resolved Hide resolved

- Added kotlin icon for jetpack temporarily till we have jetpack icon…

4e71d12

… merged into ably-ui - Bumped up kotlin and jetpack version to 1.1

sacOO7 force-pushed the chat-jetpack-compose branch from 56f98c6 to 4e71d12 Compare January 13, 2026 14:58

sacOO7 mentioned this pull request Jan 13, 2026

Add jetpack icon ably/ably-ui#1027

Merged

Updated/refactored code snippets for jetpack compose in web docs

d086414

sacOO7 mentioned this pull request Jan 14, 2026

chat docs: Add jetpack compose support ( latest ) #3097

Open

sacOO7 closed this Jan 14, 2026


		### Occupancy event structure

		The following is the structure of an occupancy event:


		Note that if sending two identical reactions of type `Distinct`, the second one will be accepted and broadcast as a raw reaction, but it will be ignored in the summary (aggregate). Similarly, when removing a reaction that doesn't exist (of any type), the operation will be accepted and broadcast as a raw reaction, but it will have no effect on the summary.

		### Configure the default reaction type <a id="default-type"/>


		## Messages and reactions <a id="messages-and-reactions"/>

		The `Message` object contains a `reactions` property which is an object that looks like this:

chat: add Jetpack Compose support to documentation #2991

chat: add Jetpack Compose support to documentation #2991

Uh oh!

Conversation

ttypic commented Dec 1, 2025

Description

Checklist

Uh oh!

coderabbitai bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Other AI code review bot(s) detected

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacOO7 Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Dec 1, 2025 •

edited

Loading

sacOO7 Jan 12, 2026 •

edited

Loading

sacOO7 Jan 12, 2026 •

edited

Loading

sacOO7 Jan 12, 2026 •

edited

Loading