added docs

This commit is contained in:
Deven Joshi
2021-09-08 16:12:29 +05:30
parent b3fa3aea45
commit 2f65a0d480
3 changed files with 40 additions and 20 deletions
@@ -2,11 +2,9 @@ import 'package:flutter/material.dart';
import 'package:stream_chat_flutter/stream_chat_flutter.dart';
import 'package:stream_chat_flutter/src/extension.dart';
/// Overlay for displaying commands that can be used
class CommandsOverlay extends StatelessWidget {
final BuildContext context;
final String text;
final ValueChanged<Command> onCommandResult;
/// Constructor for creating a [CommandsOverlay]
const CommandsOverlay(
this.context, {
required this.text,
@@ -14,9 +12,18 @@ class CommandsOverlay extends StatelessWidget {
Key? key,
}) : super(key: key);
/// Context of the upper tree
final BuildContext context;
/// Query for searching commands
final String text;
/// Callback called when a command is selected
final ValueChanged<Command> onCommandResult;
@override
Widget build(BuildContext otherContext) {
var _streamChatTheme = StreamChatTheme.of(context);
final _streamChatTheme = StreamChatTheme.of(context);
final commands = StreamChannel.of(context)
.channel
.config
@@ -4,11 +4,9 @@ import 'package:stream_chat_flutter/src/emoji/emoji.dart';
import 'package:stream_chat_flutter/src/extension.dart';
import 'package:substring_highlight/substring_highlight.dart';
/// Overlay for displaying emoji that can be used
class EmojiOverlay extends StatelessWidget {
final BuildContext context;
final String query;
final ValueChanged<Emoji> onEmojiResult;
/// Constructor for creating a [EmojiOverlay]
const EmojiOverlay(
this.context, {
required this.query,
@@ -16,10 +14,19 @@ class EmojiOverlay extends StatelessWidget {
Key? key,
}) : super(key: key);
/// Context of the upper tree
final BuildContext context;
/// Query for searching emoji
final String query;
/// Callback called when an emoji is selected
final ValueChanged<Emoji> onEmojiResult;
@override
Widget build(BuildContext otherContext) {
var _streamChatTheme = StreamChatTheme.of(context);
var _emojiNames =
final _streamChatTheme = StreamChatTheme.of(context);
final _emojiNames =
Emoji.all().where((it) => it.name != null).map((e) => e.name!);
final emojis = _emojiNames
@@ -1,15 +1,9 @@
import 'package:flutter/material.dart';
import 'package:stream_chat_flutter/src/extension.dart';
import 'package:stream_chat_flutter/stream_chat_flutter.dart';
/// Overlay for displaying users that can be mentioned
class MentionsOverlay extends StatelessWidget {
final BuildContext context;
final String query;
final ValueChanged<User?> onMentionResult;
/// Customize the tile for the mentions overlay
final MentionTileBuilder? mentionsTileBuilder;
/// Constructor for creating a [MentionsOverlay]
const MentionsOverlay(
this.context, {
required this.query,
@@ -18,9 +12,21 @@ class MentionsOverlay extends StatelessWidget {
Key? key,
}) : super(key: key);
/// Context of the upper tree
final BuildContext context;
/// Query for searching users
final String query;
/// Callback called when a user is selected
final ValueChanged<User?> onMentionResult;
/// Customize the tile for the mentions overlay
final MentionTileBuilder? mentionsTileBuilder;
@override
Widget build(BuildContext otherContext) {
var _streamChatTheme = StreamChatTheme.of(context);
final _streamChatTheme = StreamChatTheme.of(context);
Future<List<Member>>? queryMembers;