Migration Guide: Chat Flutter SDK (v0.17.0 to v1.0.0)
This guide outlines the key changes in the LikeMinds Chat Flutter SDK moving from version v0.17.0 to v1.0.0, and provides instructions for updating your integration accordingly.
What’s New in v1.0.0?
1. LMChatHomeScreen
has been Removed
The monolithic LMChatHomeScreen
used to handle both group and DM feeds has now been replaced with three modular screens for clearer responsibilities and better customization.
Replaced With
Removed | Replacement(s) |
---|---|
LMChatHomeScreen | LMCommunityChatScreen , LMCommunityHybridChatScreen , LMNetworkingChatScreen |
New Screens Overview
1. LMCommunityChatScreen
Used to display group (community) chatrooms only.
MaterialPageRoute(
builder: (context) => const LMCommunityChatScreen(),
);
2. LMNetworkingChatScreen
Used to show direct message chatrooms only.
MaterialPageRoute(
builder: (context) => const LMNetworkingChatScreen(),
);
3. LMCommunityHybridChatScreen
A tab-based hybrid view combining both community and DM chatrooms.
MaterialPageRoute(
builder: (context) => const LMCommunityHybridChatScreen(),
);
Migration Steps
Step 1: Update the SDK version
In your pubspec.yaml
:
likeminds_chat_flutter_core: ^1.0.0
Then run:
flutter pub get
Step 2: Remove LMChatHomeScreen
usage
Before (v0.17.0):
Navigator.push(
context,
MaterialPageRoute(
builder: (context) => const LMChatHomeScreen(),
),
);
After (v1.0.0):
Choose one of the following based on your use case:
For Tab-based Hybrid View:
Navigator.push(
context,
MaterialPageRoute(
builder: (context) => const LMCommunityHybridChatScreen(),
),
);For Group Chatrooms Only:
Navigator.push(
context,
MaterialPageRoute(
builder: (context) => const LMCommunityChatScreen(),
),
);For Direct Messages Only:
Navigator.push(
context,
MaterialPageRoute(
builder: (context) => const LMNetworkingChatScreen(),
),
);
Step 3: Update Custom Builders (if applicable)
If you previously used LMChatHomeConfig
for customization, you’ll now need to configure them separately using:
🧾 Summary of Changes
Feature/Screen | v0.17.0 | v1.0.0 |
---|---|---|
Group Feed | LMChatHomeFeedList | LMCommunityChatScreen |
DM Feed | LMChatDMFeedList | LMNetworkingChatScreen |
Hybrid View | LMChatHomeScreen | LMCommunityHybridChatScreen |
Configuration | LMChatHomeConfig | Separate: communityChatConfig , networkingChatConfig , hybridChatConfig |
Benefits of v1.0.0
- Modular Design: Separate screens for better navigation control.
- Granular Customization: Individual builders and settings for each screen.
- Improved Performance & Maintainability.
By following this guide, your migration to v1.0.0 will be smooth and provide a more flexible architecture for future customizations and features.