Skip to content

Bring projects, wikis, and teams together with AI. AppFlowy is the AI collaborative workspace where you achieve more without losing control of your data. The leading open source Notion alternative.

feat: support auto text direction on mobile (#7092) (#7163)

Morn89c4629ec28d
diff --git a/frontend/appflowy_flutter/integration_test/mobile/settings/default_text_direction_test.dart b/frontend/appflowy_flutter/integration_test/mobile/settings/default_text_direction_test.dart
new file mode 100644
index 0000000000..158264cad1
--- /dev/null
+++ b/frontend/appflowy_flutter/integration_test/mobile/settings/default_text_direction_test.dart
@@ -0,0 +1,81 @@
+import 'package:appflowy/generated/locale_keys.g.dart';
+import 'package:appflowy/mobile/presentation/base/app_bar/app_bar_actions.dart';
+import 'package:appflowy/mobile/presentation/home/setting/settings_popup_menu.dart';
+import 'package:appflowy/mobile/presentation/mobile_bottom_navigation_bar.dart';
+import 'package:appflowy/mobile/presentation/widgets/flowy_option_tile.dart';
+import 'package:appflowy_editor/appflowy_editor.dart';
+import 'package:easy_localization/easy_localization.dart';
+import 'package:flutter/cupertino.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+
+import '../../shared/util.dart';
+
+void main() {
+ IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+
+ testWidgets('Change default text direction', (tester) async {
+ await tester.launchInAnonymousMode();
+
+ /// tap [Setting] button
+ await tester.tapButton(find.byType(HomePageSettingsPopupMenu));
+ await tester
+ .tapButton(find.text(LocaleKeys.settings_popupMenuItem_settings.tr()));
+
+ /// tap [Default Text Direction]
+ await tester.tapButton(
+ find.text(LocaleKeys.settings_appearance_textDirection_label.tr()),
+ );
+
+ /// there are 3 items: LTR-RTL-AUTO
+ final bottomSheet = find.ancestor(
+ of: find.byType(FlowyOptionTile),
+ matching: find.byType(SafeArea),
+ );
+ final items = find.descendant(
+ of: bottomSheet,
+ matching: find.byType(FlowyOptionTile),
+ );
+ expect(items, findsNWidgets(3));
+
+ /// select [Auto]
+ await tester.tapButton(items.last);
+ expect(
+ find.text(LocaleKeys.settings_appearance_textDirection_auto.tr()),
+ findsOneWidget,
+ );
+
+ /// go back home
+ await tester.tapButton(find.byType(AppBarImmersiveBackButton));
+
+ /// create new page
+ final createPageButton =
+ find.byKey(BottomNavigationBarItemType.add.valueKey);
+ await tester.tapButton(createPageButton);
+
+ final editorState = tester.editor.getCurrentEditorState();
+ // focus on the editor
+ await tester.editor.tapLineOfEditorAt(0);
+
+ const testEnglish = 'English', testArabic = 'إنجليزي';
+
+ /// insert [testEnglish]
+ await editorState.insertTextAtCurrentSelection(testEnglish);
+ await tester.pumpAndSettle();
+ await editorState.insertNewLine(position: editorState.selection!.end);
+ await tester.pumpAndSettle();
+
+ /// insert [testArabic]
+ await editorState.insertTextAtCurrentSelection(testArabic);
+ await tester.pumpAndSettle();
+ final testEnglishFinder = find.text(testEnglish, findRichText: true),
+ testArabicFinder = find.text(testArabic, findRichText: true);
+ final testEnglishRenderBox =
+ testEnglishFinder.evaluate().first.renderObject as RenderBox,
+ testArabicRenderBox =
+ testArabicFinder.evaluate().first.renderObject as RenderBox;
+ final englishPosition = testEnglishRenderBox.localToGlobal(Offset.zero),
+ arabicPosition = testArabicRenderBox.localToGlobal(Offset.zero);
+ expect(englishPosition.dx > arabicPosition.dx, true);
+ });
+}
diff --git a/frontend/appflowy_flutter/integration_test/mobile_runner_1.dart b/frontend/appflowy_flutter/integration_test/mobile_runner_1.dart
index a17fe909e7..4d92db7d25 100644
--- a/frontend/appflowy_flutter/integration_test/mobile_runner_1.dart
+++ b/frontend/appflowy_flutter/integration_test/mobile_runner_1.dart
@@ -3,6 +3,8 @@ import 'package:integration_test/integration_test.dart';
import 'mobile/document/document_test_runner.dart' as document_test_runner;
import 'mobile/home_page/create_new_page_test.dart' as create_new_page_test;
+import 'mobile/settings/default_text_direction_test.dart'
+ as default_text_direction_test;
import 'mobile/sign_in/anonymous_sign_in_test.dart' as anonymous_sign_in_test;
Future<void> main() async {
@@ -17,4 +19,5 @@ Future<void> runIntegration1OnMobile() async {
anonymous_sign_in_test.main();
create_new_page_test.main();
document_test_runner.main();
+ default_text_direction_test.main();
}
diff --git a/frontend/appflowy_flutter/lib/mobile/presentation/setting/appearance/rtl_setting.dart b/frontend/appflowy_flutter/lib/mobile/presentation/setting/appearance/rtl_setting.dart
index e61281c5c4..8e1aceefae 100644
--- a/frontend/appflowy_flutter/lib/mobile/presentation/setting/appearance/rtl_setting.dart
+++ b/frontend/appflowy_flutter/lib/mobile/presentation/setting/appearance/rtl_setting.dart
@@ -1,6 +1,7 @@
import 'package:appflowy/generated/locale_keys.g.dart';
import 'package:appflowy/mobile/presentation/bottom_sheet/bottom_sheet.dart';
import 'package:appflowy/mobile/presentation/widgets/widgets.dart';
+import 'package:appflowy/plugins/document/application/document_appearance_cubit.dart';
import 'package:appflowy/workspace/application/settings/appearance/appearance_cubit.dart';
import 'package:easy_localization/easy_localization.dart';
import 'package:flowy_infra_ui/flowy_infra_ui.dart';
@@ -17,15 +18,15 @@ class RTLSetting extends StatelessWidget {
@override
Widget build(BuildContext context) {
final theme = Theme.of(context);
- final layoutDirection =
- context.watch<AppearanceSettingsCubit>().state.layoutDirection;
+ final textDirection =
+ context.watch<AppearanceSettingsCubit>().state.textDirection;
return MobileSettingItem(
name: LocaleKeys.settings_appearance_textDirection_label.tr(),
trailing: Row(
mainAxisSize: MainAxisSize.min,
children: [
FlowyText(
- _textDirectionLabelText(layoutDirection),
+ _textDirectionLabelText(textDirection),
color: theme.colorScheme.onSurface,
),
const Icon(Icons.chevron_right),
@@ -39,30 +40,33 @@ class RTLSetting extends StatelessWidget {
showDivider: false,
title: LocaleKeys.settings_appearance_textDirection_label.tr(),
builder: (context) {
- final layoutDirection =
- context.watch<AppearanceSettingsCubit>().state.layoutDirection;
return Column(
children: [
FlowyOptionTile.checkbox(
text: LocaleKeys.settings_appearance_textDirection_ltr.tr(),
- isSelected: layoutDirection == LayoutDirection.ltrLayout,
- onTap: () {
- context
- .read<AppearanceSettingsCubit>()
- .setLayoutDirection(LayoutDirection.ltrLayout);
- Navigator.pop(context);
- },
+ isSelected: textDirection == AppFlowyTextDirection.ltr,
+ onTap: () => applyTextDirectionAndPop(
+ context,
+ AppFlowyTextDirection.ltr,
+ ),
),
FlowyOptionTile.checkbox(
showTopBorder: false,
text: LocaleKeys.settings_appearance_textDirection_rtl.tr(),
- isSelected: layoutDirection == LayoutDirection.rtlLayout,
- onTap: () {
- context
- .read<AppearanceSettingsCubit>()
- .setLayoutDirection(LayoutDirection.rtlLayout);
- Navigator.pop(context);
- },
+ isSelected: textDirection == AppFlowyTextDirection.rtl,
+ onTap: () => applyTextDirectionAndPop(
+ context,
+ AppFlowyTextDirection.rtl,
+ ),
+ ),
+ FlowyOptionTile.checkbox(
+ showTopBorder: false,
+ text: LocaleKeys.settings_appearance_textDirection_auto.tr(),
+ isSelected: textDirection == AppFlowyTextDirection.auto,
+ onTap: () => applyTextDirectionAndPop(
+ context,
+ AppFlowyTextDirection.auto,
+ ),
),
],
);
@@ -72,13 +76,26 @@ class RTLSetting extends StatelessWidget {
);
}
- String _textDirectionLabelText(LayoutDirection? textDirection) {
+ String _textDirectionLabelText(AppFlowyTextDirection textDirection) {
switch (textDirection) {
- case LayoutDirection.rtlLayout:
+ case AppFlowyTextDirection.auto:
+ return LocaleKeys.settings_appearance_textDirection_auto.tr();
+ case AppFlowyTextDirection.rtl:
return LocaleKeys.settings_appearance_textDirection_rtl.tr();
- case LayoutDirection.ltrLayout:
+ case AppFlowyTextDirection.ltr:
default:
return LocaleKeys.settings_appearance_textDirection_ltr.tr();
}
}
+
+ void applyTextDirectionAndPop(
+ BuildContext context,
+ AppFlowyTextDirection textDirection,
+ ) {
+ context.read<AppearanceSettingsCubit>().setTextDirection(textDirection);
+ context
+ .read<DocumentAppearanceCubit>()
+ .syncDefaultTextDirection(textDirection.name);
+ Navigator.pop(context);
+ }
}
diff --git a/frontend/appflowy_flutter/lib/workspace/application/settings/appearance/appearance_cubit.dart b/frontend/appflowy_flutter/lib/workspace/application/settings/appearance/appearance_cubit.dart
index a034558110..37027bcf38 100644
--- a/frontend/appflowy_flutter/lib/workspace/application/settings/appearance/appearance_cubit.dart
+++ b/frontend/appflowy_flutter/lib/workspace/application/settings/appearance/appearance_cubit.dart
@@ -129,9 +129,8 @@ class AppearanceSettingsCubit extends Cubit<AppearanceSettingsState> {
emit(state.copyWith(layoutDirection: layoutDirection));
}
- void setTextDirection(AppFlowyTextDirection? textDirection) {
- _appearanceSettings.textDirection =
- textDirection?.toTextDirectionPB() ?? TextDirectionPB.FALLBACK;
+ void setTextDirection(AppFlowyTextDirection textDirection) {
+ _appearanceSettings.textDirection = textDirection.toTextDirectionPB();
_saveAppearanceSettings();
emit(state.copyWith(textDirection: textDirection));
}
@@ -336,7 +335,7 @@ enum AppFlowyTextDirection {
rtl,
auto;
- static AppFlowyTextDirection? fromTextDirectionPB(
+ static AppFlowyTextDirection fromTextDirectionPB(
TextDirectionPB? textDirectionPB,
) {
switch (textDirectionPB) {
@@ -347,7 +346,7 @@ enum AppFlowyTextDirection {
case TextDirectionPB.AUTO:
return AppFlowyTextDirection.auto;
default:
- return null;
+ return AppFlowyTextDirection.ltr;
}
}
@@ -374,7 +373,7 @@ class AppearanceSettingsState with _$AppearanceSettingsState {
required ThemeMode themeMode,
required String font,
required LayoutDirection layoutDirection,
- required AppFlowyTextDirection? textDirection,
+ required AppFlowyTextDirection textDirection,
required bool enableRtlToolbarItems,
required Locale locale,
required bool isMenuCollapsed,
@@ -424,6 +423,7 @@ class AppearanceSettingsState with _$AppearanceSettingsState {
}
ThemeData get lightTheme => _getThemeData(Brightness.light);
+
ThemeData get darkTheme => _getThemeData(Brightness.dark);
ThemeData _getThemeData(Brightness brightness) {
diff --git a/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_workspace_view.dart b/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_workspace_view.dart
index 94b8923db5..ab8d5ee078 100644
--- a/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_workspace_view.dart
+++ b/frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/settings_workspace_view.dart
@@ -381,7 +381,7 @@ class TextDirectionSelect extends StatelessWidget {
Widget build(BuildContext context) {
return BlocBuilder<AppearanceSettingsCubit, AppearanceSettingsState>(
builder: (context, state) {
- final selectedItem = state.textDirection ?? AppFlowyTextDirection.ltr;
+ final selectedItem = state.textDirection;
return SettingsRadioSelect<AppFlowyTextDirection>(
onChanged: (item) {
diff --git a/frontend/appflowy_flutter/test/widget_test/direction_setting_test.dart b/frontend/appflowy_flutter/test/widget_test/direction_setting_test.dart
index d83706f068..4d954d1724 100644
--- a/frontend/appflowy_flutter/test/widget_test/direction_setting_test.dart
+++ b/frontend/appflowy_flutter/test/widget_test/direction_setting_test.dart
@@ -33,6 +33,7 @@ void main() {
appearanceSettings =
await UserSettingsBackendService().getAppearanceSetting();
dateTimeSettings = await UserSettingsBackendService().getDateTimeSettings();
+ registerFallbackValue(AppFlowyTextDirection.ltr);
});
testWidgets('TextDirectionSelect update default text direction setting',
@@ -129,7 +130,7 @@ void main() {
when(
() => mockAppearanceSettingsBloc.setTextDirection(
- any<AppFlowyTextDirection?>(),
+ any<AppFlowyTextDirection>(),
),
).thenAnswer((_) async => {});
when(
@@ -146,7 +147,7 @@ void main() {
verify(
() => mockAppearanceSettingsBloc.setTextDirection(
- any<AppFlowyTextDirection?>(),
+ any<AppFlowyTextDirection>(),
),
).called(1);
verify(