Skip to content

Add linkPreview example #788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nicolasbraun wants to merge 1 commit into from
Closed

Add linkPreview example #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 202 additions & 0 deletions examples/flyer_chat/lib/link_preview.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'package:flutter_chat_core/flutter_chat_core.dart';
import 'package:flutter_chat_ui/flutter_chat_ui.dart';
import 'package:flutter_link_previewer/flutter_link_previewer.dart';
import 'package:uuid/uuid.dart';

class LinkPreviewExample extends StatefulWidget {
final Dio dio;

const LinkPreviewExample({super.key, required this.dio});

@override
LinkPreviewExampleState createState() => LinkPreviewExampleState();
}

class LinkPreviewExampleState extends State<LinkPreviewExample> {
final _chatController = InMemoryChatController();

final _currentUser = const User(
id: 'me',
imageSource: 'https://picsum.photos/id/65/200/200',
);

final metadataLinkPreviewFetchedKey = 'linkPreviewDataFetched';

@override
void dispose() {
_chatController.dispose();
super.dispose();
}

@override
void initState() {
super.initState();
_chatController.setMessages([
Message.text(
id: 'not-fetched',
authorId: _currentUser.id,
text: 'https://flyer.chat/ Not fetchet yet',
createdAt: DateTime.now().toUtc().subtract(const Duration(hours: 1)),
),
Message.text(
id: 'wont-fetch',
authorId: _currentUser.id,
text: 'https://flyer.chat/ Will not fetch',
createdAt: DateTime.now().toUtc().subtract(const Duration(hours: 2)),
metadata: {metadataLinkPreviewFetchedKey: true},
),
Message.text(
id: 'complete',
authorId: _currentUser.id,
text: 'https://flyer.chat/ Already fetched',
createdAt: DateTime.now().toUtc().subtract(const Duration(hours: 3)),
linkPreviewData: LinkPreviewData(
link: 'https://flyer.chat/',
description:
'Open-source chat SDK for Flutter and React Native. Build fast, real-time apps and AI agents with a high-performance, customizable, cross-platform UI.',
image: ImagePreviewData(
url: 'https://flyer.chat/og-image.png',
width: 1200.0,
height: 630.0,
),
title: 'Flyer Chat | Ship faster with a go-to chat SDK',
),
),
Message.text(
id: 'no-text-preview',
authorId: _currentUser.id,
text: 'https://flyer.chat/ Dont display the linkify text',
createdAt: DateTime.now().toUtc().subtract(const Duration(hours: 4)),
linkPreviewData: LinkPreviewData(
link: 'https://flyer.chat/',
description:
'Open-source chat SDK for Flutter and React Native. Build fast, real-time apps and AI agents with a high-performance, customizable, cross-platform UI.',
image: ImagePreviewData(
url: 'https://flyer.chat/og-image.png',
width: 1200.0,
height: 630.0,
),
title: 'Flyer Chat | Ship faster with a go-to chat SDK',
),
),
Message.text(
id: 'only-image',
authorId: _currentUser.id,
text: 'https://flyer.chat/ Display only the image',
createdAt: DateTime.now().toUtc().subtract(const Duration(hours: 5)),
linkPreviewData: LinkPreviewData(
link: 'https://flyer.chat/',
description:
'Open-source chat SDK for Flutter and React Native. Build fast, real-time apps and AI agents with a high-performance, customizable, cross-platform UI.',
image: ImagePreviewData(
url: 'https://flyer.chat/og-image.png',
width: 1200.0,
height: 630.0,
),
title: 'Flyer Chat | Ship faster with a go-to chat SDK',
),
),
Message.text(
id: 'image-content',
authorId: _currentUser.id,
text: 'https://flyer.chat/og-image.png This is only an image',
createdAt: DateTime.now().toUtc().subtract(const Duration(hours: 6)),
),
]);
}

void _addItem(String? text) async {
if (text == null || text.isEmpty) {
return;
}

final message = Message.text(
id: Uuid().v4(),
authorId: _currentUser.id,
text: text,
createdAt: DateTime.now().toUtc().subtract(const Duration(seconds: 1)),
);

if (mounted) {
await _chatController.insertMessage(message);
}
}

@override
Widget build(BuildContext context) {
final theme = Theme.of(context);

return Scaffold(
appBar: AppBar(title: const Text('LinkPreview')),
body: Chat(
backgroundColor: Colors.transparent,
builders: Builders(
linkPreviewBuilder: (context, message) {
final isLinkPreviewDataFetched =
message.metadata?.containsKey(metadataLinkPreviewFetchedKey) ??
false;

// It's up to you to (optionally) implement the logic to avoid every
// client to eventually refetch the preview data
//
// For example, you can use a metadata to indicate if the preview
// was already fetched (and null).
//
// You could also store a data and implement some retry/refresh logic.
//

if (message.linkPreviewData != null || !isLinkPreviewDataFetched) {
return Column(
children: [
Divider(height: 0.5, color: Colors.white),
LinkPreview(
text: message.text,
linkPreviewData: message.linkPreviewData,
hideDescription: message.id == 'only-image',
hideText:
message.id == 'no-text-preview' ||
message.id == 'only-image',
hideTitle: message.id == 'only-image',
linkStyle: TextStyle().copyWith(color: Colors.white),
openOnPreviewImageTap: true,
openOnPreviewTitleTap: true,
onLinkPreviewDataFetched: (linkPreviewData) {
_chatController.updateMessage(
message,
message.copyWith(
metadata: {
...message.metadata ?? {},
metadataLinkPreviewFetchedKey: true,
},
linkPreviewData: linkPreviewData,
),
);
},
),
],
);
}
return null;
},
),
onMessageSend: (text) {
_addItem(text);
},
chatController: _chatController,
currentUserId: _currentUser.id,

resolveUser:
(id) => Future.value(switch (id) {
'me' => _currentUser,
_ => null,
}),
theme:
theme.brightness == Brightness.dark
? ChatTheme.dark()
: ChatTheme.light(),
),
);
}
}
12 changes: 12 additions & 0 deletions examples/flyer_chat/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import 'api_get_initial_messages.dart';
import 'basic.dart';
import 'gemini.dart';
import 'local.dart';
import 'link_preview.dart';
import 'pagination.dart';

void main() async {
Expand Down Expand Up @@ -286,6 +287,17 @@ class _FlyerChatHomePageState extends State<FlyerChatHomePage> {
},
child: const Text('basic'),
),
const SizedBox(height: 8),
ElevatedButton(
onPressed: () {
Navigator.of(context).push(
MaterialPageRoute(
builder: (context) => LinkPreviewExample(dio: _dio),
),
);
},
child: const Text('link preview'),
),
],
),
),
Expand Down
3 changes: 3 additions & 0 deletions examples/flyer_chat/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ dependencies:
flutter_chat_core: ^2.3.0
flutter_chat_ui: ^2.3.0
flutter_dotenv: ^5.2.1
# TODO: remove this when the package is published
flutter_link_previewer:
path: /Users/nicolasbraun/Sources/flutter_link_previewer
flutter_lorem: ^2.0.0
flyer_chat_file_message: ^2.1.5
flyer_chat_image_message: ^2.1.6
Expand Down