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.
Dart blogconfluence-alternativecontent-managementcontent-servicesdocumentationflutternote-takingnotion-alternativeproject-managementtask-managementteam-collaborationwiki
feat: support scrollable columns block (#7429)
Lucas8ebd49026078
diff --git a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_configuration.dart b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_configuration.dartindex 5e5376d42b..2d6a52a58d 100644--- a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_configuration.dart+++ b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_configuration.dart@@ -15,6 +15,14 @@ import 'package:flutter/services.dart';import 'package:flutter_bloc/flutter_bloc.dart';import 'package:universal_platform/universal_platform.dart';+/// A global configuration for the editor.+class EditorGlobalConfiguration {+ /// Whether to enable the drag menu in the editor.+ ///+ /// Case 1, resizing the columns block in the desktop, then the drag menu will be disabled.+ static ValueNotifier<bool> enableDragMenu = ValueNotifier(true);+}+/// The node types that support slash menu.final Set<String> supportSlashMenuNodeTypes = {ParagraphBlockKeys.type,@@ -208,34 +216,39 @@ void _customBlockOptionActions(top += 2.0;}return ValueListenableBuilder(- valueListenable: editorState.editableNotifier,- builder: (_, editable, child) {- return IgnorePointer(- ignoring: !editable,- child: Opacity(- opacity: editable ? 1.0 : 0.0,- child: Padding(- padding: EdgeInsets.only(top: top),- child: BlockActionList(- blockComponentContext: context,- blockComponentState: state,- editorState: editorState,- blockComponentBuilder: builders,- actions: actions,- showSlashMenu: slashMenuItemsBuilder != null- ? () => customAppFlowySlashCommand(- itemsBuilder: slashMenuItemsBuilder,- shouldInsertSlash: false,- deleteKeywordsByDefault: true,- style:- styleCustomizer.selectionMenuStyleBuilder(),- supportSlashMenuNodeTypes:- supportSlashMenuNodeTypes,- ).handler.call(editorState)- : () {},+ valueListenable: EditorGlobalConfiguration.enableDragMenu,+ builder: (_, enableDragMenu, child) {+ return ValueListenableBuilder(+ valueListenable: editorState.editableNotifier,+ builder: (_, editable, child) {+ return IgnorePointer(+ ignoring: !editable,+ child: Opacity(+ opacity: editable && enableDragMenu ? 1.0 : 0.0,+ child: Padding(+ padding: EdgeInsets.only(top: top),+ child: BlockActionList(+ blockComponentContext: context,+ blockComponentState: state,+ editorState: editorState,+ blockComponentBuilder: builders,+ actions: actions,+ showSlashMenu: slashMenuItemsBuilder != null+ ? () => customAppFlowySlashCommand(+ itemsBuilder: slashMenuItemsBuilder,+ shouldInsertSlash: false,+ deleteKeywordsByDefault: true,+ style: styleCustomizer+ .selectionMenuStyleBuilder(),+ supportSlashMenuNodeTypes:+ supportSlashMenuNodeTypes,+ ).handler.call(editorState)+ : () {},+ ),+ ),),- ),- ),+ );+ },);},);@@ -973,7 +986,13 @@ SimpleColumnsBlockComponentBuilder _buildSimpleColumnsBlockComponentBuilder() {return SimpleColumnsBlockComponentBuilder(configuration: configuration.copyWith(- padding: (_) => EdgeInsets.zero,+ padding: (node) {+ if (UniversalPlatform.isMobile) {+ return configuration.padding(node);+ }++ return EdgeInsets.zero;+ },),);}diff --git a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_column_block_width_resizer.dart b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_column_block_width_resizer.dartindex 34d751520d..dad0dea132 100644--- a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_column_block_width_resizer.dart+++ b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_column_block_width_resizer.dart@@ -1,11 +1,12 @@+import 'package:appflowy/plugins/document/presentation/editor_configuration.dart';import 'package:appflowy/plugins/document/presentation/editor_plugins/actions/drag_to_reorder/draggable_option_button.dart';import 'package:appflowy/plugins/document/presentation/editor_plugins/columns/simple_columns_block_constant.dart';import 'package:appflowy/plugins/document/presentation/editor_plugins/plugins.dart';import 'package:appflowy_editor/appflowy_editor.dart';import 'package:flutter/material.dart';-class ColumnBlockWidthResizer extends StatefulWidget {- const ColumnBlockWidthResizer({+class SimpleColumnBlockWidthResizer extends StatefulWidget {+ const SimpleColumnBlockWidthResizer({super.key,required this.columnNode,required this.editorState,@@ -15,11 +16,12 @@ class ColumnBlockWidthResizer extends StatefulWidget {final EditorState editorState;@override- State<ColumnBlockWidthResizer> createState() =>- _ColumnBlockWidthResizerState();+ State<SimpleColumnBlockWidthResizer> createState() =>+ _SimpleColumnBlockWidthResizerState();}-class _ColumnBlockWidthResizerState extends State<ColumnBlockWidthResizer> {+class _SimpleColumnBlockWidthResizerState+ extends State<SimpleColumnBlockWidthResizer> {bool isDragging = false;ValueNotifier<bool> isHovering = ValueNotifier(false);@@ -66,6 +68,7 @@ class _ColumnBlockWidthResizerState extends State<ColumnBlockWidthResizer> {void _onHorizontalDragStart(DragStartDetails details) {isDragging = true;+ EditorGlobalConfiguration.enableDragMenu.value = false;}void _onHorizontalDragUpdate(DragUpdateDetails details) {@@ -102,6 +105,7 @@ class _ColumnBlockWidthResizerState extends State<ColumnBlockWidthResizer> {void _onHorizontalDragEnd(DragEndDetails details) {isHovering.value = false;+ EditorGlobalConfiguration.enableDragMenu.value = true;if (!isDragging) {return;@@ -120,5 +124,6 @@ class _ColumnBlockWidthResizerState extends State<ColumnBlockWidthResizer> {void _onHorizontalDragCancel() {isDragging = false;isHovering.value = false;+ EditorGlobalConfiguration.enableDragMenu.value = true;}}diff --git a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_columns_block_component.dart b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_columns_block_component.dartindex cd7b2190cd..849d5afd4c 100644--- a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_columns_block_component.dart+++ b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/columns/simple_columns_block_component.dart@@ -5,17 +5,22 @@ import 'package:appflowy_editor/appflowy_editor.dart';import 'package:collection/collection.dart';import 'package:flutter/material.dart';import 'package:provider/provider.dart';+import 'package:universal_platform/universal_platform.dart';// if the children is not provided, it will create two columns by default.// if the columnCount is provided, it will create the specified number of columns.Node simpleColumnsNode({List<Node>? children,int? columnCount,+ double? width,}) {columnCount ??= 2;children ??= List.generate(columnCount,- (index) => simpleColumnNode(children: [paragraphNode()]),+ (index) => simpleColumnNode(+ width: width,+ children: [paragraphNode()],+ ),);// check the type of children@@ -95,14 +100,28 @@ class ColumnsBlockComponentState extends State<ColumnsBlockComponent>@overrideWidget build(BuildContext context) {- Widget child = IntrinsicHeight(+ Widget child = SingleChildScrollView(+ scrollDirection: Axis.horizontal,child: Row(- mainAxisSize: MainAxisSize.min,crossAxisAlignment: CrossAxisAlignment.stretch,children: _buildChildren(),),);+ if (UniversalPlatform.isDesktop) {+ // only show the scrollbar on desktop+ child = Scrollbar(+ child: child,+ );+ }++ child = Align(+ alignment: Alignment.topLeft,+ child: IntrinsicHeight(+ child: child,+ ),+ );+child = Padding(key: columnsKey,padding: padding,@@ -130,33 +149,26 @@ class ColumnsBlockComponentState extends State<ColumnsBlockComponent>final children = <Widget>[];for (var i = 0; i < node.children.length; i++) {final childNode = node.children[i];- final double? width = childNode.attributes[SimpleColumnBlockKeys.width];+ final width = childNode.attributes[SimpleColumnBlockKeys.width] ??+ SimpleColumnsBlockConstants.minimumColumnWidth;Widget child = editorState.renderer.build(context, childNode);- if (width != null) {- child = SizedBox(- width: width.clamp(- SimpleColumnsBlockConstants.minimumColumnWidth,- double.infinity,- ),- child: child,- );- } else {- child = Expanded(- child: child,- );- }+ child = SizedBox(+ width: width.clamp(+ SimpleColumnsBlockConstants.minimumColumnWidth,+ double.infinity,+ ),+ child: child,+ );children.add(child);- if (i != node.children.length - 1) {- children.add(- ColumnBlockWidthResizer(- columnNode: childNode,- editorState: editorState,- ),- );- }+ children.add(+ SimpleColumnBlockWidthResizer(+ columnNode: childNode,+ editorState: editorState,+ ),+ );}return children;}diff --git a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/slash_menu/slash_menu_items/simple_columns_item.dart b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/slash_menu/slash_menu_items/simple_columns_item.dartindex 4ffac6965e..103cfface4 100644--- a/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/slash_menu/slash_menu_items/simple_columns_item.dart+++ b/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/slash_menu/slash_menu_items/simple_columns_item.dart@@ -29,17 +29,11 @@ final _fourColumnsKeywords = ['4 columns',];-final _fiveColumnsKeywords = [- ..._baseKeywords,- 'five columns',- '5 columns',-];-// 2 columns menu itemSelectionMenuItem twoColumnsSlashMenuItem = SelectionMenuItem.node(getName: () => LocaleKeys.document_slashMenu_name_twoColumns.tr(),keywords: _twoColumnsKeywords,- nodeBuilder: (_, __) => simpleColumnsNode(columnCount: 2),+ nodeBuilder: (editorState, __) => _buildColumnsNode(editorState, 2),replace: (_, node) => node.delta?.isEmpty ?? false,nameBuilder: slashMenuItemNameBuilder,iconBuilder: (_, isSelected, style) => SelectableSvgWidget(@@ -59,7 +53,7 @@ SelectionMenuItem twoColumnsSlashMenuItem = SelectionMenuItem.node(SelectionMenuItem threeColumnsSlashMenuItem = SelectionMenuItem.node(getName: () => LocaleKeys.document_slashMenu_name_threeColumns.tr(),keywords: _threeColumnsKeywords,- nodeBuilder: (_, __) => simpleColumnsNode(columnCount: 3),+ nodeBuilder: (editorState, __) => _buildColumnsNode(editorState, 3),replace: (_, node) => node.delta?.isEmpty ?? false,nameBuilder: slashMenuItemNameBuilder,iconBuilder: (_, isSelected, style) => SelectableSvgWidget(@@ -79,7 +73,7 @@ SelectionMenuItem threeColumnsSlashMenuItem = SelectionMenuItem.node(SelectionMenuItem fourColumnsSlashMenuItem = SelectionMenuItem.node(getName: () => LocaleKeys.document_slashMenu_name_fourColumns.tr(),keywords: _fourColumnsKeywords,- nodeBuilder: (_, __) => simpleColumnsNode(columnCount: 4),+ nodeBuilder: (editorState, __) => _buildColumnsNode(editorState, 4),replace: (_, node) => node.delta?.isEmpty ?? false,nameBuilder: slashMenuItemNameBuilder,iconBuilder: (_, isSelected, style) => SelectableSvgWidget(@@ -95,22 +89,14 @@ SelectionMenuItem fourColumnsSlashMenuItem = SelectionMenuItem.node(},);-// 5 columns menu item-SelectionMenuItem fiveColumnsSlashMenuItem = SelectionMenuItem.node(- getName: () => '5 Columns',- keywords: _fiveColumnsKeywords,- nodeBuilder: (_, __) => simpleColumnsNode(columnCount: 5),- replace: (_, node) => node.delta?.isEmpty ?? false,- nameBuilder: slashMenuItemNameBuilder,- iconBuilder: (_, isSelected, style) => SelectableSvgWidget(- data: FlowySvgs.slash_menu_icon_code_block_s,- isSelected: isSelected,- style: style,- ),- updateSelection: (_, path, __, ___) {- return Selection.single(- path: path.child(0).child(0),- startOffset: 0,- );- },-);+Node _buildColumnsNode(EditorState editorState, int columnCount) {+ final selection = editorState.selection;+ double? width;+ if (selection != null) {+ final parentNode = editorState.getNodeAtPath(selection.start.path);+ if (parentNode != null) {+ width = parentNode.rect.width / columnCount;+ }+ }+ return simpleColumnsNode(columnCount: columnCount, width: width);+}