ChatChannelListView navigation did not trigger when using a custom container

[laevandus]

🔗 Issue Link

Resolves: PBE-6081

🎯 Goal

• Fix an issue where embedding the ChatChannelListView breaks its navigation after the embedded view reloads its body
• Added documentation to the ChatChannelListView.init

🛠 Implementation

The default onTapHandler captures the view model instance created within the view, not the one stored in the @StateObject property. When view reloads, onTapHandler captures the incorrect instance.

🧪 Testing

1. Open DemoAppSwiftUIApp.swift
2. Replace case .loggedIn: implementation with:

NavigationView {
    VStack {
        Button(!isBroken ? "Break" : "Broken") {
            isBroken.toggle()
        }
        ChatChannelListView(
            viewFactory: DemoAppFactory.shared,
            channelListController: channelListController,
            embedInNavigationView: false
        )
    }
}

and add
@State private var isBroken = false
to the DemoAppSwiftUIApp type
3. Launch the demo app
4. Tap on any of the items and verify that the tapped channel is opened
5. Navigate back to the channel list, tap on the "Break" button and verify that navigation is still possible.

☑️ Checklist

• I have signed the Stream CLA (required)
• Changelog is updated with client-facing changes
• New code is covered by unit tests
• Affected documentation updated (docusaurus, tutorial, CMS (task created)

[laevandus]

Note how it does not capture the self.viewModel instance.

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChatSwiftUI	7.1 MB	7.11 MB	+1 KB	🟢

[sonarqubecloud]

Quality Gate passed

Issues
88 New issues
0 Accepted issues

Measures
0 Security Hotspots
71.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud