Skip to content

feat: [MDS-1564] Avatar component #461

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

Merged
GittHub-d merged 1 commit into from
Jan 30, 2025
Merged

feat: [MDS-1564] Avatar component #461

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
22 changes: 10 additions & 12 deletions example/lib/src/storybook/stories/primitives/avatar.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import 'package:example/src/storybook/common/color_options.dart';
import 'package:example/src/storybook/common/widgets/text_divider.dart';
import 'package:flutter/material.dart';
import 'package:moon_core/moon_core.dart';
import 'package:moon_design/moon_design.dart';
import 'package:storybook_flutter/storybook_flutter.dart';

Expand Down Expand Up @@ -108,6 +109,10 @@ class AvatarStory extends StatelessWidget {
initial: true,
);

final BorderRadius? borderRadius = borderRadiusKnob != null
? BorderRadius.circular(borderRadiusKnob.toDouble())
: null;

return Center(
child: SingleChildScrollView(
padding: const EdgeInsets.symmetric(vertical: 64.0, horizontal: 16.0),
Expand All @@ -121,30 +126,23 @@ class AvatarStory extends StatelessWidget {
MoonAvatar(
avatarSize: avatarSizeKnob,
badgeSize: badgeSizeKnob?.toDouble(),
borderRadius: borderRadiusKnob != null
? BorderRadius.circular(borderRadiusKnob.toDouble())
: null,
borderRadius: borderRadius,
badgeMarginValue: badgeMarginKnob?.toDouble(),
backgroundColor: backgroundColor,
showBadge: showBadgeKnob,
badgeColor: badgeColor,
badgeAlignment:
avatarBadgeAlignmentKnob ?? MoonBadgeAlignment.bottomRight,
content: Padding(
padding: const EdgeInsets.only(top: 1.0),
child: Text(
customLabelTextKnob,
style: TextStyle(color: textColor),
),
content: Text(
customLabelTextKnob,
style: TextStyle(color: textColor),
),
),
const TextDivider(text: "Custom MoonAvatar with image background"),
MoonAvatar(
avatarSize: avatarSizeKnob,
badgeSize: badgeSizeKnob?.toDouble(),
borderRadius: borderRadiusKnob != null
? BorderRadius.circular(borderRadiusKnob.toDouble())
: null,
borderRadius: borderRadius,
badgeMarginValue: badgeMarginKnob?.toDouble(),
backgroundColor: backgroundColor,
showBadge: showBadgeKnob,
Expand Down
212 changes: 64 additions & 148 deletions lib/src/widgets/avatar/avatar.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';

import 'package:mix/mix.dart';
import 'package:moon_core/moon_core.dart';

import 'package:moon_design/src/theme/avatar/avatar_size_properties.dart';
import 'package:moon_design/src/theme/avatar/avatar_sizes.dart';
import 'package:moon_design/src/theme/theme.dart';
import 'package:moon_design/src/theme/tokens/tokens.dart';
import 'package:moon_design/src/utils/extensions.dart';
import 'package:moon_design/src/utils/squircle/squircle_border.dart';
import 'package:moon_design/src/widgets/avatar/avatar_clipper.dart';

import 'package:moon_tokens/moon_tokens.dart';

Expand All @@ -22,13 +18,6 @@ enum MoonAvatarSize {
x2l,
}

enum MoonBadgeAlignment {
topLeft,
topRight,
bottomLeft,
bottomRight,
}

class MoonAvatar extends StatelessWidget {
/// Whether to show the avatar badge.
final bool showBadge;
Expand Down Expand Up @@ -66,6 +55,9 @@ class MoonAvatar extends StatelessWidget {
/// The semantic label for the avatar.
final String? semanticLabel;

/// The widget to display within the badge.
final Widget? badgeContent;

/// The widget to display within the avatar.
final Widget? content;

Expand All @@ -84,68 +76,23 @@ class MoonAvatar extends StatelessWidget {
this.avatarSize,
this.badgeAlignment = MoonBadgeAlignment.bottomRight,
this.semanticLabel,
this.badgeContent,
this.content,
});

Alignment _avatarAlignmentMapper(BuildContext context) {
final bool isRTL = Directionality.of(context) == TextDirection.rtl;

if (isRTL) {
switch (badgeAlignment) {
case MoonBadgeAlignment.topLeft:
return Alignment.topRight;
case MoonBadgeAlignment.topRight:
return Alignment.topLeft;
case MoonBadgeAlignment.bottomLeft:
return Alignment.bottomRight;
case MoonBadgeAlignment.bottomRight:
return Alignment.bottomLeft;
default:
return Alignment.bottomRight;
}
} else {
switch (badgeAlignment) {
case MoonBadgeAlignment.topLeft:
return Alignment.topLeft;
case MoonBadgeAlignment.topRight:
return Alignment.topRight;
case MoonBadgeAlignment.bottomLeft:
return Alignment.bottomLeft;
case MoonBadgeAlignment.bottomRight:
return Alignment.bottomRight;
default:
return Alignment.bottomRight;
}
}
}

MoonAvatarSizeProperties _getMoonAvatarSize(
BuildContext context,
MoonAvatarSize? moonAvatarSize,
) {
switch (moonAvatarSize) {
case MoonAvatarSize.xs:
return context.moonTheme?.avatarTheme.sizes.xs ??
MoonAvatarSizes(tokens: MoonTokens.light).xs;
case MoonAvatarSize.sm:
return context.moonTheme?.avatarTheme.sizes.sm ??
MoonAvatarSizes(tokens: MoonTokens.light).sm;
case MoonAvatarSize.md:
return context.moonTheme?.avatarTheme.sizes.md ??
MoonAvatarSizes(tokens: MoonTokens.light).md;
case MoonAvatarSize.lg:
return context.moonTheme?.avatarTheme.sizes.lg ??
MoonAvatarSizes(tokens: MoonTokens.light).lg;
case MoonAvatarSize.xl:
return context.moonTheme?.avatarTheme.sizes.xl ??
MoonAvatarSizes(tokens: MoonTokens.light).xl;
case MoonAvatarSize.x2l:
return context.moonTheme?.avatarTheme.sizes.x2l ??
MoonAvatarSizes(tokens: MoonTokens.light).x2l;
default:
return context.moonTheme?.avatarTheme.sizes.md ??
MoonAvatarSizes(tokens: MoonTokens.light).md;
}
return switch (moonAvatarSize) {
MoonAvatarSize.xs => MoonAvatarSizes(tokens: MoonTokens.light).xs,
MoonAvatarSize.sm => MoonAvatarSizes(tokens: MoonTokens.light).sm,
MoonAvatarSize.md => MoonAvatarSizes(tokens: MoonTokens.light).md,
MoonAvatarSize.lg => MoonAvatarSizes(tokens: MoonTokens.light).lg,
MoonAvatarSize.xl => MoonAvatarSizes(tokens: MoonTokens.light).xl,
MoonAvatarSize.x2l => MoonAvatarSizes(tokens: MoonTokens.light).x2l,
_ => MoonAvatarSizes(tokens: MoonTokens.light).md,
};
}

@override
Expand All @@ -159,21 +106,14 @@ class MoonAvatar extends StatelessWidget {
final resolvedBorderRadius =
effectiveBorderRadius.resolve(Directionality.of(context));

final Color effectiveBackgroundColor = backgroundColor ??
context.moonTheme?.avatarTheme.colors.backgroundColor ??
MoonColors.light.goku;
final Color effectiveBackgroundColor =
backgroundColor ?? MoonColors.light.goku;

final Color effectiveBadgeColor = badgeColor ??
context.moonTheme?.avatarTheme.colors.badgeColor ??
MoonColors.light.roshi;
final Color effectiveBadgeColor = badgeColor ?? MoonColors.light.roshi;

final Color effectiveTextColor =
context.moonTheme?.avatarTheme.colors.textColor ??
MoonColors.light.textPrimary;
final Color effectiveTextColor = MoonColors.light.textPrimary;

final Color effectiveIconColor =
context.moonTheme?.avatarTheme.colors.iconColor ??
MoonColors.light.iconPrimary;
final Color effectiveIconColor = MoonColors.light.iconPrimary;

final double effectiveAvatarHeight =
height ?? effectiveMoonAvatarSize.avatarSizeValue;
Expand All @@ -187,77 +127,53 @@ class MoonAvatar extends StatelessWidget {
final double effectiveBadgeSize =
badgeSize ?? effectiveMoonAvatarSize.badgeSizeValue;

return Semantics(
label: semanticLabel,
button: false,
focusable: false,
image: backgroundImage != null,
child: SizedBox(
width: effectiveAvatarWidth,
height: effectiveAvatarHeight,
child: Stack(
children: [
Positioned.fill(
child: ClipPath(
// TODO: Since clipper does not work properly on mobile web/PWA,
// we are disabling it. Remove this check when it has been
// fixed from Flutter side.
clipper: kIsWeb &&
MediaQueryData.fromView(View.of(context)).size.width <
500
? null
: AvatarClipper(
showBadge: showBadge,
width: effectiveAvatarWidth,
height: effectiveAvatarHeight,
borderRadius: resolvedBorderRadius,
badgeSize: effectiveBadgeSize,
badgeMarginValue: effectiveBadgeMarginValue,
badgeAlignment: badgeAlignment,
textDirection: Directionality.of(context),
),
child: DefaultTextStyle(
style: effectiveMoonAvatarSize.textStyle
.copyWith(color: effectiveTextColor),
child: IconTheme(
data: IconThemeData(
color: effectiveIconColor,
),
child: DecoratedBox(
decoration: ShapeDecorationWithPremultipliedAlpha(
color: effectiveBackgroundColor,
image: backgroundImage != null
? DecorationImage(
image: backgroundImage!,
fit: BoxFit.cover,
)
: null,
shape: MoonSquircleBorder(
borderRadius: resolvedBorderRadius
.squircleBorderRadius(context),
),
),
child: Center(child: content),
),
),
),
),
),
if (showBadge)
Align(
alignment: _avatarAlignmentMapper(context),
child: Container(
height: effectiveBadgeSize,
width: effectiveBadgeSize,
decoration: BoxDecoration(
color: effectiveBadgeColor,
borderRadius: BorderRadius.circular(effectiveBadgeSize / 2),
),
),
),
],
final TextStyle resolvedTextStyle =
effectiveMoonAvatarSize.textStyle.copyWith(color: effectiveTextColor);

final Style baseStyle = Style(
$box.alignment.center(),
$with.defaultTextStyle.style.as(resolvedTextStyle),
$with.iconTheme.data.color(effectiveIconColor),
);

final Style badgeStyle = baseStyle.add(
$box.shapeDecoration.as(
ShapeDecorationWithPremultipliedAlpha(
color: effectiveBadgeColor,
shape: MoonBorder(
borderRadius: BorderRadius.circular(effectiveBadgeSize / 2),
),
),
),
);

final Style contentStyle = baseStyle.add(
$box.shapeDecoration.as(
ShapeDecorationWithPremultipliedAlpha(
color: effectiveBackgroundColor,
shape: MoonBorder(borderRadius: resolvedBorderRadius),
image: backgroundImage != null
? DecorationImage(image: backgroundImage!, fit: BoxFit.cover)
: null,
),
),
);

return MoonRawAvatar(
showBadge: showBadge,
semanticLabel: semanticLabel,
badgeSizeValue: effectiveBadgeSize,
badgeMarginValue: effectiveBadgeMarginValue,
badgeAlignment: badgeAlignment,
avatarSize: Size(effectiveAvatarWidth, effectiveAvatarHeight),
badge: Box(
style: badgeStyle,
child: badgeContent,
),
content: Box(
style: contentStyle,
child: content,
),
);
}
}
Loading