Skip to content
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.

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

feat(UX-1314): Created comment component #41

Merged
merged 4 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
67 changes: 67 additions & 0 deletions example/lib/pages/components/comment.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import 'package:flutter/material.dart';
import 'package:zds_flutter/zds_flutter.dart';

class CommentDemo extends StatefulWidget {
const CommentDemo({super.key});

@override
State<CommentDemo> createState() => _CommentDemoState();
}

class _CommentDemoState extends State<CommentDemo> {
@override
Widget build(BuildContext context) {
return Container(
color: Zeta.of(context).colors.surfaceDefault,
child: Column(
children: [
ZdsComment(
avatar: ZetaAvatar.initials(
initials: 'JP',
size: ZetaAvatarSize.xxxs,
),
author: 'John Doe',
comment: 'This is a comment',
onReply: () {},
replySemanticLabel: 'Reply to comment',
onDelete: () {},
deleteSemanticLabel: 'Delete',
timeStamp: '09:30 AM',
attachment: ZdsChatAttachment(
type: ZdsChatAttachmentType.docNetwork,
name: 'Blueprints.xls',
size: '1234kb',
extension: 'xls',
),
),
ZdsComment(
avatar: ZetaAvatar.initials(
initials: 'JP',
size: ZetaAvatarSize.xxxs,
backgroundColor: Zeta.of(context).colors.surfaceAvatarPurple,
),
onDelete: () {},
deleteSemanticLabel: 'Delete',
isReply: true,
author: 'John Doe',
comment: 'This is a comment',
timeStamp: '09:30 AM',
),
ZdsComment(
avatar: ZetaAvatar.initials(
initials: 'JP',
size: ZetaAvatarSize.xxxs,
),
author: 'John Doe',
comment: 'This is a comment',
onReply: () {},
replySemanticLabel: 'Reply to comment',
onDelete: () {},
deleteSemanticLabel: 'Delete',
timeStamp: '09:30 AM',
),
],
),
);
}
}
10 changes: 10 additions & 0 deletions example/lib/routes.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import 'package:flutter/material.dart';
import 'package:zds_flutter_example/pages/components/chat.dart';
import 'package:zds_flutter_example/pages/components/comment.dart';

import 'home.dart';
import 'pages/assets/animations.dart';
Expand Down Expand Up @@ -92,6 +94,14 @@ final kRoutes = {
title: 'Card Actions',
child: CardActionsDemo(),
),
const DemoRoute(
title: 'Chat',
child: ChatDemo(),
),
const DemoRoute(
title: 'Comments',
child: CommentDemo(),
),
const DemoRoute(
title: 'Interactive Viewer',
wrapper: false,
Expand Down
1 change: 1 addition & 0 deletions lib/src/components/molecules.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export 'molecules/bottom_sheet.dart';
export 'molecules/card_actions.dart';
export 'molecules/card_header.dart';
export 'molecules/check_button.dart';
export 'molecules/comment.dart';
export 'molecules/date_range_picker.dart';
export 'molecules/date_time_picker.dart';
export 'molecules/dropdown.dart';
Expand Down
265 changes: 265 additions & 0 deletions lib/src/components/molecules/comment.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';

import '../../../zds_flutter.dart';

/// Displays a comment with an optional attachment and delete and reply swipeable actions.
class ZdsComment extends StatelessWidget {
/// Constructs a [ZdsComment] widget.
const ZdsComment({
required this.comment,
required this.author,
this.isReply = false,
this.avatar,
this.timeStamp,
this.onDelete,
this.onReply,
super.key,
this.attachment,
this.downloadCallback,
this.deleteSemanticLabel,
this.replySemanticLabel,
this.attachmentThumbnail,
}) : assert(
onReply != null && replySemanticLabel != null || onReply == null && replySemanticLabel == null,
'replySemanticLabel must be not null if onReply is defined',
),
assert(
onDelete != null && deleteSemanticLabel != null || onDelete == null && deleteSemanticLabel == null,
'deleteSemanticLabel must be not null if onDelete is defined',
);

/// The comment text.
final String comment;

/// The avatar widget to display.
/// Should be a [ZetaAvatar]
final Widget? avatar;

/// The timestamp of the comment.
final String? timeStamp;

/// The author of the comment.
final String author;

/// Whether the comment is a reply.
/// If this is true, the reply action will automatically be hidden.
final bool isReply;

/// The callback to be called when the delete action is tapped.
/// If this is null, the delete action will be hidden.
/// If this is not null, [deleteSemanticLabel] must also be not null.
final VoidCallback? onDelete;

/// The semantic label for the delete action.
final String? deleteSemanticLabel;

/// The callback to be called when the reply action is tapped.
/// If this is null, the reply action will be hidden.
/// If this is not null, [replySemanticLabel] must also be not null.
final VoidCallback? onReply;

/// The semantic label for the reply action.
final String? replySemanticLabel;

/// The attachment to display.
final ZdsChatAttachment? attachment;

/// The callback to be called when the attachment is tapped.
final VoidCallback? downloadCallback;

/// The custom thumbnail to display for the attachment.
final Widget? attachmentThumbnail;

@override
Widget build(BuildContext context) {
final colors = Zeta.of(context).colors;
final spacing = Zeta.of(context).spacing;

return Row(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
if (isReply)
Padding(
padding: EdgeInsets.only(
left: spacing.large,
right: spacing.minimum,
top: spacing.minimum,
),
child: const ZetaIcon(
ZetaIcons.reply,
size: 24,
applyTextScaling: true,
),
),
Expanded(
child: LayoutBuilder(
builder: (context, constraints) {
return ZdsSlidableListTile(
width: constraints.maxWidth,
elevation: 0,
actions: [
if (!isReply && onReply != null && replySemanticLabel != null)
ZdsSlidableAction(
icon: ZetaIcons.reply,
semanticLabel: replySemanticLabel,
foregroundColor: colors.primary,
backgroundColor: colors.surfacePrimarySubtle,
onPressed: (_) => onReply!(),
),
if (onDelete != null && deleteSemanticLabel != null)
ZdsSlidableAction(
icon: ZetaIcons.delete,
semanticLabel: deleteSemanticLabel,
onPressed: (_) {},
backgroundColor: colors.surfaceNegativeSubtle,
foregroundColor: colors.error,
),
],
child: Container(
decoration: BoxDecoration(
color: colors.surfaceDefault,
border: Border(
bottom: BorderSide(
color: colors.borderSubtle,
),
),
),
padding: EdgeInsets.all(spacing.large),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Row(
children: [
if (avatar != null)
Padding(
padding: EdgeInsets.only(right: spacing.small),
child: avatar,
),
Text(
author,
style: ZetaTextStyles.labelLarge.copyWith(
fontWeight: FontWeight.w500,
),
),
const Spacer(),
if (timeStamp != null)
Padding(
padding: EdgeInsets.only(left: spacing.small),
child: Text(
timeStamp!,
style: ZetaTextStyles.bodyXSmall.copyWith(color: colors.textSubtle),
),
),
],
),
Padding(
padding: EdgeInsets.only(top: spacing.small),
child: Text(
comment,
style: Theme.of(context).textTheme.bodyMedium,
),
),
if (attachment != null)
Padding(
padding: EdgeInsets.only(top: spacing.large),
child: _AttachmentRow(
attachment: attachment!,
downloadCallback: downloadCallback,
customThumbnail: attachmentThumbnail,
),
),
],
),
),
);
},
),
),
],
);
}

@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
super.debugFillProperties(properties);
properties
..add(StringProperty('comment', comment))
..add(StringProperty('timeStamp', timeStamp))
..add(StringProperty('author', author))
..add(DiagnosticsProperty<bool>('isReply', isReply))
..add(ObjectFlagProperty<VoidCallback?>.has('onDelete', onDelete))
..add(ObjectFlagProperty<VoidCallback?>.has('onReply', onReply))
..add(DiagnosticsProperty<ZdsChatAttachment?>('attachment', attachment))
..add(ObjectFlagProperty<VoidCallback?>.has('downloadCallback', downloadCallback))
..add(StringProperty('deleteSemanticLabel', deleteSemanticLabel))
..add(StringProperty('replySemanticLabel', replySemanticLabel));
}
}

class _AttachmentRow extends StatelessWidget {
const _AttachmentRow({
required this.attachment,
this.customThumbnail,
this.downloadCallback,
});

final ZdsChatAttachment attachment;
final VoidCallback? downloadCallback;
final Widget? customThumbnail;

@override
Widget build(BuildContext context) {
final spacing = Zeta.of(context).spacing;
final colors = Zeta.of(context).colors;
final radius = Zeta.of(context).radius;

return Material(
child: InkWell(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the design is not clear but i think some padding around the ink well splash would be better
image

borderRadius: radius.minimal,
onTap: downloadCallback,
child: Row(
children: [
if (customThumbnail != null)
SizedBox(
width: 44,
height: 44,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are custom thumbnails bigger than icons below?

child: customThumbnail,
)
else
ZetaIcon(
extensionIcon('.${attachment.fileType}'),
color: iconColor('.${attachment.fileType}'),
size: 40,
),
SizedBox(width: spacing.small),
Column(
crossAxisAlignment: CrossAxisAlignment.start,
mainAxisAlignment: MainAxisAlignment.spaceBetween,
children: [
Text(
attachment.name,
style: ZetaTextStyles.bodySmall,
),
if (attachment.size != null)
Text(
attachment.size!,
style: ZetaTextStyles.bodySmall.copyWith(color: colors.textSubtle),
),
],
),
],
),
),
);
}

@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
super.debugFillProperties(properties);
properties
..add(DiagnosticsProperty<ZdsChatAttachment>('attachment', attachment))
..add(ObjectFlagProperty<VoidCallback?>.has('downloadCallback', downloadCallback));
}
}
Loading