Skip to content

inbox: Implement Inbox appearance when empty #1337

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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
Binary file modified assets/icons/ZulipIcons.ttf
Binary file not shown.
7 changes: 7 additions & 0 deletions assets/icons/inbox_done.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions assets/l10n/app_en.arb
Original file line number Diff line number Diff line change
Expand Up @@ -824,5 +824,9 @@
"zulipAppTitle": "Zulip",
"@zulipAppTitle": {
"description": "The name of Zulip. This should be either 'Zulip' or a transliteration."
},
"emptyInboxMessage": "There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.",
"@emptyInboxMessage": {
"description": "Message shown when inbox is empty. [combined feed] will be replaced with a clickable link to Combined Feed."
}
}
6 changes: 6 additions & 0 deletions lib/generated/l10n/zulip_localizations.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1208,6 +1208,12 @@ abstract class ZulipLocalizations {
/// In en, this message translates to:
/// **'Zulip'**
String get zulipAppTitle;

/// Message shown when inbox is empty. [combined feed] will be replaced with a clickable link to Combined Feed.
///
/// In en, this message translates to:
/// **'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.'**
String get emptyInboxMessage;
}

class _ZulipLocalizationsDelegate extends LocalizationsDelegate<ZulipLocalizations> {
Expand Down
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_ar.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsAr extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_en.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsEn extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_ja.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsJa extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_nb.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsNb extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_pl.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsPl extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_ru.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsRu extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
3 changes: 3 additions & 0 deletions lib/generated/l10n/zulip_localizations_sk.dart
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,7 @@ class ZulipLocalizationsSk extends ZulipLocalizations {

@override
String get zulipAppTitle => 'Zulip';

@override
String get emptyInboxMessage => 'There are no unread messages in your Inbox.\nCheck out the [combined feed] for recent messages.';
}
39 changes: 21 additions & 18 deletions lib/widgets/icons.dart
Original file line number Diff line number Diff line change
Expand Up @@ -84,59 +84,62 @@ abstract final class ZulipIcons {
/// The Zulip custom icon "inbox".
static const IconData inbox = IconData(0xf114, fontFamily: "Zulip Icons");

/// The Zulip custom icon "inbox_done".
static const IconData inbox_done = IconData(0xf115, fontFamily: "Zulip Icons");

/// The Zulip custom icon "info".
static const IconData info = IconData(0xf115, fontFamily: "Zulip Icons");
static const IconData info = IconData(0xf116, fontFamily: "Zulip Icons");

/// The Zulip custom icon "inherit".
static const IconData inherit = IconData(0xf116, fontFamily: "Zulip Icons");
static const IconData inherit = IconData(0xf117, fontFamily: "Zulip Icons");

/// The Zulip custom icon "language".
static const IconData language = IconData(0xf117, fontFamily: "Zulip Icons");
static const IconData language = IconData(0xf118, fontFamily: "Zulip Icons");

/// The Zulip custom icon "lock".
static const IconData lock = IconData(0xf118, fontFamily: "Zulip Icons");
static const IconData lock = IconData(0xf119, fontFamily: "Zulip Icons");

/// The Zulip custom icon "menu".
static const IconData menu = IconData(0xf119, fontFamily: "Zulip Icons");
static const IconData menu = IconData(0xf11a, fontFamily: "Zulip Icons");

/// The Zulip custom icon "message_feed".
static const IconData message_feed = IconData(0xf11a, fontFamily: "Zulip Icons");
static const IconData message_feed = IconData(0xf11b, fontFamily: "Zulip Icons");

/// The Zulip custom icon "mute".
static const IconData mute = IconData(0xf11b, fontFamily: "Zulip Icons");
static const IconData mute = IconData(0xf11c, fontFamily: "Zulip Icons");

/// The Zulip custom icon "read_receipts".
static const IconData read_receipts = IconData(0xf11c, fontFamily: "Zulip Icons");
static const IconData read_receipts = IconData(0xf11d, fontFamily: "Zulip Icons");

/// The Zulip custom icon "send".
static const IconData send = IconData(0xf11d, fontFamily: "Zulip Icons");
static const IconData send = IconData(0xf11e, fontFamily: "Zulip Icons");

/// The Zulip custom icon "share".
static const IconData share = IconData(0xf11e, fontFamily: "Zulip Icons");
static const IconData share = IconData(0xf11f, fontFamily: "Zulip Icons");

/// The Zulip custom icon "share_ios".
static const IconData share_ios = IconData(0xf11f, fontFamily: "Zulip Icons");
static const IconData share_ios = IconData(0xf120, fontFamily: "Zulip Icons");

/// The Zulip custom icon "smile".
static const IconData smile = IconData(0xf120, fontFamily: "Zulip Icons");
static const IconData smile = IconData(0xf121, fontFamily: "Zulip Icons");

/// The Zulip custom icon "star".
static const IconData star = IconData(0xf121, fontFamily: "Zulip Icons");
static const IconData star = IconData(0xf122, fontFamily: "Zulip Icons");

/// The Zulip custom icon "star_filled".
static const IconData star_filled = IconData(0xf122, fontFamily: "Zulip Icons");
static const IconData star_filled = IconData(0xf123, fontFamily: "Zulip Icons");

/// The Zulip custom icon "three_person".
static const IconData three_person = IconData(0xf123, fontFamily: "Zulip Icons");
static const IconData three_person = IconData(0xf124, fontFamily: "Zulip Icons");

/// The Zulip custom icon "topic".
static const IconData topic = IconData(0xf124, fontFamily: "Zulip Icons");
static const IconData topic = IconData(0xf125, fontFamily: "Zulip Icons");

/// The Zulip custom icon "unmute".
static const IconData unmute = IconData(0xf125, fontFamily: "Zulip Icons");
static const IconData unmute = IconData(0xf126, fontFamily: "Zulip Icons");

/// The Zulip custom icon "user".
static const IconData user = IconData(0xf126, fontFamily: "Zulip Icons");
static const IconData user = IconData(0xf127, fontFamily: "Zulip Icons");

// END GENERATED ICON DATA
}
Expand Down
91 changes: 91 additions & 0 deletions lib/widgets/inbox.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import '../model/narrow.dart';
import '../model/recent_dm_conversations.dart';
import '../model/unreads.dart';
import 'action_sheet.dart';
import 'color.dart';
import 'icons.dart';
import 'message_list.dart';
import 'sticky_header.dart';
Expand Down Expand Up @@ -160,6 +161,10 @@ class _InboxPageState extends State<InboxPageBody> with PerAccountStoreAwareStat
sections.add(_StreamSectionData(streamId, countInStream, streamHasMention, topicItems));
}

if (sections.isEmpty) {
return const InboxEmptyWidget();
}

return SafeArea(
// Don't pad the bottom here; we want the list content to do that.
bottom: false,
Expand All @@ -182,6 +187,92 @@ class _InboxPageState extends State<InboxPageBody> with PerAccountStoreAwareStat
}
}

class InboxEmptyWidget extends StatelessWidget {
const InboxEmptyWidget({super.key});

// Splits a message containing text in square brackets into three parts.
List<String> _splitMessage(String message) {
final pattern = RegExp(r'(.*?)\[(.*?)\](.*)', dotAll: true);
final match = pattern.firstMatch(message);

return match == null
? [message, '', '']
: [
match.group(1) ?? '',
match.group(2) ?? '',
match.group(3) ?? '',
];
}

@override
Widget build(BuildContext context) {
final zulipLocalizations = ZulipLocalizations.of(context);
final designVariables = DesignVariables.of(context);

final messageParts = _splitMessage(zulipLocalizations.emptyInboxMessage);

return Center(
child: Padding(
padding: const EdgeInsets.all(16),
child: Column(
mainAxisAlignment: MainAxisAlignment.start,
children: [
const SizedBox(height: 48),
Icon(
ZulipIcons.inbox_done,
size: 80,
color: designVariables.foreground.withFadedAlpha(0.3),
),
const SizedBox(height: 16),
Text.rich(
TextSpan(
style: TextStyle(
color: designVariables.labelSearchPrompt,
fontSize: 17,
fontWeight: FontWeight.w500,
),
children: [
TextSpan(text: messageParts[0]),
WidgetSpan(
alignment: PlaceholderAlignment.baseline,
baseline: TextBaseline.alphabetic,
child: TextButton(
style: TextButton.styleFrom(
padding: EdgeInsets.zero,
minimumSize: Size.zero,
tapTargetSize: MaterialTapTargetSize.shrinkWrap,
splashFactory: NoSplash.splashFactory
),
onPressed: () => Navigator.push(context,
MessageListPage.buildRoute(context: context,
narrow: const CombinedFeedNarrow())),
child: Text(
messageParts[1],
style: TextStyle(
fontSize: 17,
fontWeight: FontWeight.w500,
color: designVariables.link,
decoration: TextDecoration.underline,
decorationStyle: TextDecorationStyle.solid,
decorationThickness: 2.5,
decorationColor: designVariables.link,
height: 1.5,
)
),
),
),
TextSpan(text: messageParts[2]),
],
),
textAlign: TextAlign.center,
),
],
),
),
);
}
}

sealed class _InboxSectionData {
const _InboxSectionData();
}
Expand Down
14 changes: 14 additions & 0 deletions lib/widgets/theme.dart
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
groupDmConversationIcon: Colors.black.withValues(alpha: 0.5),
groupDmConversationIconBg: const Color(0x33808080),
inboxItemIconMarker: const HSLColor.fromAHSL(0.5, 0, 0, 0.2).toColor(),
labelSearchPrompt: const Color(0xff000000).withValues(alpha: 0.5),
loginOrDivider: const Color(0xffdedede),
loginOrDividerText: const Color(0xff575757),
link: const Color(0xff066bd0),
modalBarrierColor: const Color(0xff000000).withValues(alpha: 0.3),
mutedUnreadBadge: const HSLColor.fromAHSL(0.5, 0, 0, 0.8).toColor(),
navigationButtonBg: Colors.black.withValues(alpha: 0.05),
Expand Down Expand Up @@ -209,8 +211,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
// TODO(design-dark) need proper dark-theme color (this is ad hoc)
groupDmConversationIconBg: const Color(0x33cccccc),
inboxItemIconMarker: const HSLColor.fromAHSL(0.4, 0, 0, 1).toColor(),
labelSearchPrompt: const Color(0xffffffff).withValues(alpha: 0.5),
loginOrDivider: const Color(0xff424242),
loginOrDividerText: const Color(0xffa8a8a8),
link: const Color(0xff00aaff),
modalBarrierColor: const Color(0xff000000).withValues(alpha: 0.5),
// TODO(design-dark) need proper dark-theme color (this is ad hoc)
mutedUnreadBadge: const HSLColor.fromAHSL(0.5, 0, 0, 0.6).toColor(),
Expand Down Expand Up @@ -263,8 +267,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
required this.groupDmConversationIcon,
required this.groupDmConversationIconBg,
required this.inboxItemIconMarker,
required this.labelSearchPrompt,
required this.loginOrDivider,
required this.loginOrDividerText,
required this.link,
required this.modalBarrierColor,
required this.mutedUnreadBadge,
required this.navigationButtonBg,
Expand Down Expand Up @@ -325,8 +331,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
final Color groupDmConversationIcon;
final Color groupDmConversationIconBg;
final Color inboxItemIconMarker;
final Color labelSearchPrompt;
final Color loginOrDivider; // TODO(design-dark) need proper dark-theme color (this is ad hoc)
final Color loginOrDividerText; // TODO(design-dark) need proper dark-theme color (this is ad hoc)
final Color link;
final Color modalBarrierColor;
final Color mutedUnreadBadge;
final Color navigationButtonBg;
Expand Down Expand Up @@ -374,8 +382,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
Color? groupDmConversationIcon,
Color? groupDmConversationIconBg,
Color? inboxItemIconMarker,
Color? labelSearchPrompt,
Color? loginOrDivider,
Color? loginOrDividerText,
Color? link,
Color? modalBarrierColor,
Color? mutedUnreadBadge,
Color? navigationButtonBg,
Expand Down Expand Up @@ -422,8 +432,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
groupDmConversationIcon: groupDmConversationIcon ?? this.groupDmConversationIcon,
groupDmConversationIconBg: groupDmConversationIconBg ?? this.groupDmConversationIconBg,
inboxItemIconMarker: inboxItemIconMarker ?? this.inboxItemIconMarker,
labelSearchPrompt: labelSearchPrompt ?? this.labelSearchPrompt,
loginOrDivider: loginOrDivider ?? this.loginOrDivider,
loginOrDividerText: loginOrDividerText ?? this.loginOrDividerText,
link: link ?? this.link,
modalBarrierColor: modalBarrierColor ?? this.modalBarrierColor,
mutedUnreadBadge: mutedUnreadBadge ?? this.mutedUnreadBadge,
navigationButtonBg: navigationButtonBg ?? this.navigationButtonBg,
Expand Down Expand Up @@ -477,8 +489,10 @@ class DesignVariables extends ThemeExtension<DesignVariables> {
groupDmConversationIcon: Color.lerp(groupDmConversationIcon, other.groupDmConversationIcon, t)!,
groupDmConversationIconBg: Color.lerp(groupDmConversationIconBg, other.groupDmConversationIconBg, t)!,
inboxItemIconMarker: Color.lerp(inboxItemIconMarker, other.inboxItemIconMarker, t)!,
labelSearchPrompt: Color.lerp(labelSearchPrompt, other.labelSearchPrompt, t)!,
loginOrDivider: Color.lerp(loginOrDivider, other.loginOrDivider, t)!,
loginOrDividerText: Color.lerp(loginOrDividerText, other.loginOrDividerText, t)!,
link: Color.lerp(link, other.link, t)!,
modalBarrierColor: Color.lerp(modalBarrierColor, other.modalBarrierColor, t)!,
mutedUnreadBadge: Color.lerp(mutedUnreadBadge, other.mutedUnreadBadge, t)!,
navigationButtonBg: Color.lerp(navigationButtonBg, other.navigationButtonBg, t)!,
Expand Down
Loading