mirror of
https://github.com/Iconica-Development/flutter_chat.git
synced 2025-05-18 18:33:49 +02:00
feat: updated readme, ui colors and null values
This commit is contained in:
parent
ac163a28f8
commit
cb423c582c
6 changed files with 154 additions and 75 deletions
88
README.md
88
README.md
|
@ -1,4 +1,5 @@
|
|||
# Flutter Community Chat
|
||||
|
||||
Flutter Community Chat is a package which gives the possibility to add a (personal or group) chat to your Flutter-application. Default this package adds support for a Firebase back-end. You can add your custom back-end (like a Websocket-API) by extending the `CommunityChatInterface` interface from the `flutter_community_chat_interface` package.
|
||||
|
||||

|
||||
|
@ -7,6 +8,7 @@ Figma Design that defines this component (only accessible for Iconica developers
|
|||
Figma clickable prototype that demonstrates this component (only accessible for Iconica developers): https://www.figma.com/proto/PRJoVXQ5aOjAICfkQdAq2A/Iconica-User-Stories?page-id=1%3A2&type=design&node-id=56-6837&viewport=279%2C2452%2C0.2&t=E7Al3Xng2WXnbCEQ-1&scaling=scale-down&starting-point-node-id=56%3A6837&mode=design
|
||||
|
||||
## Setup
|
||||
|
||||
To use this package, add flutter_community_chat as a dependency in your pubspec.yaml file:
|
||||
|
||||
```
|
||||
|
@ -25,25 +27,84 @@ If you are going to use Firebase as the back-end of the Community Chat, you shou
|
|||
path: packages/flutter_community_chat_firebase
|
||||
```
|
||||
|
||||
Create a Firebase project for your application and add firebase firestore and storage.
|
||||
|
||||
## How to use
|
||||
To use the module within your Flutter-application you should add the following code to the build-method of a chosen widget.
|
||||
|
||||
To use the module within your Flutter-application with predefined `Go_router` routes you should add the following:
|
||||
|
||||
Add go_router as dependency to your project.
|
||||
Add the following configuration to your flutter_application:
|
||||
|
||||
```
|
||||
CommunityChat(
|
||||
dataProvider: FirebaseCommunityChatDataProvider(),
|
||||
)
|
||||
List<GoRoute> getCommunityChatRoutes() => getCommunityChatStoryRoutes(
|
||||
CommunityChatUserStoryConfiguration(
|
||||
service: FirebaseChatService(userService: FirebaseUserService()),
|
||||
userService: FirebaseUserService(),
|
||||
messageService:
|
||||
FirebaseMessageService(userService: FirebaseUserService()),
|
||||
chatOptionsBuilder: (ctx) => const ChatOptions(),
|
||||
),
|
||||
);
|
||||
```
|
||||
|
||||
In this example we provide a `FirebaseCommunityChatDataProvider` as a data provider. You can also specify your own implementation here of the `CommunityChatInterface` interface.
|
||||
|
||||
You can also include your custom configuration for both the Community Chat itself as the Image Picker which is included in this package. You can specify those configurations as a parameter:
|
||||
Add the `getCommunityChatRoutes()` to your go_router routes like so:
|
||||
|
||||
```
|
||||
CommunityChat(
|
||||
dataProvider: FirebaseCommunityChatDataProvider(),
|
||||
imagePickerTheme: ImagePickerTheme(),
|
||||
chatOptions: ChatOptions(),
|
||||
)
|
||||
final GoRouter _router = GoRouter(
|
||||
routes: <RouteBase>[
|
||||
GoRoute(
|
||||
path: '/',
|
||||
builder: (BuildContext context, GoRouterState state) {
|
||||
return const MyHomePage(
|
||||
title: "home",
|
||||
);
|
||||
},
|
||||
),
|
||||
...getCommunityChatRoutes()
|
||||
],
|
||||
);
|
||||
```
|
||||
|
||||
To use the module within your Flutter-application without predefined `Go_router` routes add the following code to the build-method of a chosen widget:
|
||||
|
||||
To add the `ChatScreen` add the following code:
|
||||
|
||||
````
|
||||
ChatScreen(
|
||||
options: options,
|
||||
onPressStartChat: onPressStartChat,
|
||||
onPressChat: onPressChat,
|
||||
onDeleteChat: onDeleteChat,
|
||||
service: service,
|
||||
pageSize: pageSize,
|
||||
);
|
||||
```
|
||||
|
||||
To add the `ChatDetailScreen` add the following code:
|
||||
|
||||
```
|
||||
ChatDetailScreen(
|
||||
options: options,
|
||||
onMessageSubmit: onMessageSubmit,
|
||||
onUploadImage: onUploadImage,
|
||||
onReadChat: onReadChat,
|
||||
service: service,
|
||||
chatUserService: chatUserService,
|
||||
messageService: messageService,
|
||||
pageSize: pageSize,
|
||||
);
|
||||
```
|
||||
|
||||
To add the `NewChatScreen` add the following code:
|
||||
|
||||
```
|
||||
NewChatScreen(
|
||||
options: options,
|
||||
onPressCreateChat: onPressCreateChat,
|
||||
service: service,
|
||||
userService: userService,
|
||||
);
|
||||
```
|
||||
|
||||
The `ChatOptions` has its own parameters, as specified below:
|
||||
|
@ -51,7 +112,7 @@ The `ChatOptions` has its own parameters, as specified below:
|
|||
|-----------|-------------|
|
||||
| newChatButtonBuilder | Builds the 'New Chat' button, to initiate a new chat session. This button is displayed on the chat overview. |
|
||||
| messageInputBuilder | Builds the text input which is displayed within the chat view, responsible for sending text messages. |
|
||||
| chatRowContainerBuilder | Builds a chat row. A row with the users' avatar, name and eventually the last massage sended in the chat. This builder is used both in the *chat overview screen* as in the *new chat screen*. |
|
||||
| chatRowContainerBuilder | Builds a chat row. A row with the users' avatar, name and eventually the last massage sended in the chat. This builder is used both in the _chat overview screen_ as in the _new chat screen_. |
|
||||
| imagePickerContainerBuilder | Builds the container around the ImagePicker. |
|
||||
| closeImagePickerButtonBuilder | Builds the close button for the Image Picker pop-up window. |
|
||||
| scaffoldBuilder | Builds the default Scaffold-widget around the Community Chat. The chat title is displayed within the Scaffolds' title for example. |
|
||||
|
@ -69,3 +130,4 @@ If you would like to contribute to the plugin (e.g. by improving the documentati
|
|||
## Author
|
||||
|
||||
This `flutter_community_chat` for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>
|
||||
````
|
||||
|
|
|
@ -267,6 +267,7 @@ class FirebaseChatService implements ChatService {
|
|||
var startIndex = (pageNumber - 1) * pageSize;
|
||||
var endIndex = startIndex + pageSize;
|
||||
|
||||
if (groupChatIds != null) {
|
||||
if (startIndex >= groupChatIds.length) {
|
||||
return [];
|
||||
}
|
||||
|
@ -274,6 +275,8 @@ class FirebaseChatService implements ChatService {
|
|||
startIndex, endIndex.clamp(0, groupChatIds.length));
|
||||
lastGroupId = groupIds.last;
|
||||
return groupIds;
|
||||
}
|
||||
return [];
|
||||
});
|
||||
|
||||
if (userSnapshot.docs.isNotEmpty) {
|
||||
|
|
|
@ -37,7 +37,6 @@ class _ChatDetailRowState extends State<ChatDetailRow> {
|
|||
widget.message.timestamp.day != widget.previousMessage?.timestamp.day;
|
||||
var isSameSender = widget.previousMessage == null ||
|
||||
widget.previousMessage?.sender.id != widget.message.sender.id;
|
||||
print(isNewDate);
|
||||
|
||||
return Padding(
|
||||
padding: EdgeInsets.only(
|
||||
|
@ -79,9 +78,13 @@ class _ChatDetailRowState extends State<ChatDetailRow> {
|
|||
Text(
|
||||
widget.message.sender.fullName?.toUpperCase() ??
|
||||
widget.translations.anonymousUser,
|
||||
style: const TextStyle(
|
||||
style: TextStyle(
|
||||
fontSize: 14,
|
||||
fontWeight: FontWeight.w500,
|
||||
color: Theme.of(context)
|
||||
.textTheme
|
||||
.labelMedium
|
||||
?.color,
|
||||
),
|
||||
),
|
||||
Padding(
|
||||
|
@ -106,7 +109,13 @@ class _ChatDetailRowState extends State<ChatDetailRow> {
|
|||
text: TextSpan(
|
||||
text: (widget.message as ChatTextMessageModel)
|
||||
.text,
|
||||
style: const TextStyle(fontSize: 16),
|
||||
style: TextStyle(
|
||||
fontSize: 16,
|
||||
color: Theme.of(context)
|
||||
.textTheme
|
||||
.labelMedium
|
||||
?.color,
|
||||
),
|
||||
children: <TextSpan>[
|
||||
if (widget.showTime)
|
||||
TextSpan(
|
||||
|
|
|
@ -24,9 +24,11 @@ class ChatImage extends StatelessWidget {
|
|||
),
|
||||
width: size,
|
||||
height: size,
|
||||
child: CachedNetworkImage(
|
||||
child: image != ''
|
||||
? CachedNetworkImage(
|
||||
imageUrl: image,
|
||||
fit: BoxFit.cover,
|
||||
),
|
||||
)
|
||||
: null,
|
||||
);
|
||||
}
|
||||
|
|
|
@ -75,7 +75,7 @@ Widget _createImagePickerContainer(
|
|||
) =>
|
||||
Container(
|
||||
padding: const EdgeInsets.all(8.0),
|
||||
color: Colors.black,
|
||||
color: Colors.white,
|
||||
child: ImagePicker(
|
||||
customButton: ElevatedButton(
|
||||
onPressed: onClose,
|
||||
|
|
|
@ -316,6 +316,8 @@ class ChatListItem extends StatelessWidget {
|
|||
Widget build(BuildContext context) {
|
||||
return GestureDetector(
|
||||
onTap: () => widget.onPressChat(chat),
|
||||
child: Container(
|
||||
color: Colors.transparent,
|
||||
child: widget.options.chatRowContainerBuilder(
|
||||
(chat is PersonalChatModel)
|
||||
? ChatRow(
|
||||
|
@ -359,6 +361,7 @@ class ChatListItem extends StatelessWidget {
|
|||
: null,
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue