feat: override block component validator

AppFlowy-IO · Oct 14, 2024 · 946fb9b · 946fb9b
1 parent 0a0d441
commit 946fb9b
Show file tree

Hide file tree

Showing 12 changed files with 64 additions and 71 deletions.
diff --git a/...c/editor/block_component/bulleted_list_block_component/bulleted_list_block_component.dart b/...c/editor/block_component/bulleted_list_block_component/bulleted_list_block_component.dart
@@ -60,7 +60,7 @@ class BulletedListBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) => node.delta != null;
+  BlockComponentValidate get validate => (node) => node.delta != null;
 }
 
 class BulletedListBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/divider_block_component/divider_block_component.dart b/lib/src/editor/block_component/divider_block_component/divider_block_component.dart
@@ -52,7 +52,7 @@ class DividerBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) => node.children.isEmpty;
+  BlockComponentValidate get validate => (node) => node.children.isEmpty;
 }
 
 class DividerBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/heading_block_component/heading_block_component.dart b/lib/src/editor/block_component/heading_block_component/heading_block_component.dart
@@ -63,9 +63,6 @@ class HeadingBlockComponentBuilder extends BlockComponentBuilder {
       ),
     );
   }
-
-  @override
-  bool validate(Node node) => true;
 }
 
 class HeadingBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/image_block_component/image_block_component.dart b/lib/src/editor/block_component/image_block_component/image_block_component.dart
@@ -83,7 +83,8 @@ class ImageBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) => node.delta == null && node.children.isEmpty;
+  BlockComponentValidate get validate =>
+      (node) => node.delta == null && node.children.isEmpty;
 }
 
 class ImageBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/...c/editor/block_component/numbered_list_block_component/numbered_list_block_component.dart b/...c/editor/block_component/numbered_list_block_component/numbered_list_block_component.dart
@@ -70,7 +70,7 @@ class NumberedListBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) => node.delta != null;
+  BlockComponentValidate get validate => (node) => node.delta != null;
 }
 
 class NumberedListBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/paragraph_block_component/paragraph_block_component.dart b/lib/src/editor/block_component/paragraph_block_component/paragraph_block_component.dart
@@ -60,9 +60,7 @@ class ParagraphBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) {
-    return node.delta != null;
-  }
+  BlockComponentValidate get validate => (node) => node.delta != null;
 }
 
 class ParagraphBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/quote_block_component/quote_block_component.dart b/lib/src/editor/block_component/quote_block_component/quote_block_component.dart
@@ -57,7 +57,7 @@ class QuoteBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) => node.delta != null;
+  BlockComponentValidate get validate => (node) => node.delta != null;
 }
 
 class QuoteBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/table_block_component/table_block_component.dart b/lib/src/editor/block_component/table_block_component/table_block_component.dart
@@ -110,68 +110,68 @@ class TableBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) {
-    // check the node is valid
-    if (node.attributes.isEmpty) {
-      AppFlowyEditorLog.editor
-          .debug('TableBlockComponentBuilder: node is empty');
-      return false;
-    }
-
-    // check the node has rowPosition and colPosition
-    if (!node.attributes.containsKey(TableBlockKeys.colsLen) ||
-        !node.attributes.containsKey(TableBlockKeys.rowsLen)) {
-      AppFlowyEditorLog.editor.debug(
-        'TableBlockComponentBuilder: node has no colsLen or rowsLen',
-      );
-      return false;
-    }
-
-    final colsLen = node.attributes[TableBlockKeys.colsLen];
-    final rowsLen = node.attributes[TableBlockKeys.rowsLen];
-
-    // check its children
-    final children = node.children;
-    if (children.isEmpty) {
-      AppFlowyEditorLog.editor
-          .debug('TableBlockComponentBuilder: children is empty');
-      return false;
-    }
-
-    if (children.length != colsLen * rowsLen) {
-      AppFlowyEditorLog.editor.debug(
-        'TableBlockComponentBuilder: children length(${children.length}) is not equal to colsLen * rowsLen($colsLen * $rowsLen)',
-      );
-      return false;
-    }
+  BlockComponentValidate get validate => (node) {
+        // check the node is valid
+        if (node.attributes.isEmpty) {
+          AppFlowyEditorLog.editor
+              .debug('TableBlockComponentBuilder: node is empty');
+          return false;
+        }
 
-    // all children should contain rowPosition and colPosition
-    for (var i = 0; i < colsLen; i++) {
-      for (var j = 0; j < rowsLen; j++) {
-        final child = children.where(
-          (n) =>
-              n.attributes[TableCellBlockKeys.colPosition] == i &&
-              n.attributes[TableCellBlockKeys.rowPosition] == j,
-        );
-        if (child.isEmpty) {
+        // check the node has rowPosition and colPosition
+        if (!node.attributes.containsKey(TableBlockKeys.colsLen) ||
+            !node.attributes.containsKey(TableBlockKeys.rowsLen)) {
           AppFlowyEditorLog.editor.debug(
-            'TableBlockComponentBuilder: child($i, $j) is empty',
+            'TableBlockComponentBuilder: node has no colsLen or rowsLen',
           );
           return false;
         }
 
-        // should only contains one child
-        if (child.length != 1) {
+        final colsLen = node.attributes[TableBlockKeys.colsLen];
+        final rowsLen = node.attributes[TableBlockKeys.rowsLen];
+
+        // check its children
+        final children = node.children;
+        if (children.isEmpty) {
+          AppFlowyEditorLog.editor
+              .debug('TableBlockComponentBuilder: children is empty');
+          return false;
+        }
+
+        if (children.length != colsLen * rowsLen) {
           AppFlowyEditorLog.editor.debug(
-            'TableBlockComponentBuilder: child($i, $j) is not unique',
+            'TableBlockComponentBuilder: children length(${children.length}) is not equal to colsLen * rowsLen($colsLen * $rowsLen)',
           );
           return false;
         }
-      }
-    }
 
-    return true;
-  }
+        // all children should contain rowPosition and colPosition
+        for (var i = 0; i < colsLen; i++) {
+          for (var j = 0; j < rowsLen; j++) {
+            final child = children.where(
+              (n) =>
+                  n.attributes[TableCellBlockKeys.colPosition] == i &&
+                  n.attributes[TableCellBlockKeys.rowPosition] == j,
+            );
+            if (child.isEmpty) {
+              AppFlowyEditorLog.editor.debug(
+                'TableBlockComponentBuilder: child($i, $j) is empty',
+              );
+              return false;
+            }
+
+            // should only contains one child
+            if (child.length != 1) {
+              AppFlowyEditorLog.editor.debug(
+                'TableBlockComponentBuilder: child($i, $j) is not unique',
+              );
+              return false;
+            }
+          }
+        }
+
+        return true;
+      };
 }
 
 class TableBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/block_component/table_block_component/table_cell_block_component.dart b/lib/src/editor/block_component/table_block_component/table_cell_block_component.dart
@@ -68,7 +68,7 @@ class TableCellBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) =>
+  BlockComponentValidate get validate => (node) =>
       node.attributes.isNotEmpty &&
       node.attributes.containsKey(TableCellBlockKeys.rowPosition) &&
       node.attributes.containsKey(TableCellBlockKeys.colPosition);

diff --git a/lib/src/editor/block_component/todo_list_block_component/todo_list_block_component.dart b/lib/src/editor/block_component/todo_list_block_component/todo_list_block_component.dart
@@ -81,9 +81,7 @@ class TodoListBlockComponentBuilder extends BlockComponentBuilder {
   }
 
   @override
-  bool validate(Node node) {
-    return node.delta != null;
-  }
+  BlockComponentValidate get validate => (node) => node.delta != null;
 }
 
 class TodoListBlockComponentWidget extends BlockComponentStatefulWidget {

diff --git a/lib/src/editor/editor_component/service/renderer/block_component_service.dart b/lib/src/editor/editor_component/service/renderer/block_component_service.dart
@@ -12,6 +12,8 @@ typedef BlockActionBuilder = Widget Function(
   BlockComponentActionState state,
 );
 
+typedef BlockComponentValidate = bool Function(Node node);
+
 abstract class BlockComponentActionState {
   set alwaysShowActions(bool alwaysShowActions);
 }
@@ -27,11 +29,11 @@ abstract class BlockComponentBuilder with BlockComponentSelectable {
   /// return true if the node is valid.
   /// return false if the node is invalid,
   ///   and the node will be displayed as a PlaceHolder widget.
-  bool validate(Node node) => true;
+  BlockComponentValidate validate = (_) => true;
 
   BlockComponentWidget build(BlockComponentContext blockComponentContext);
 
-  bool Function(Node) showActions = (_) => false;
+  bool Function(Node node) showActions = (_) => false;
 
   BlockActionBuilder actionBuilder = (_, __) => const SizedBox.shrink();
 

diff --git a/test/customer/custom_error_block_test.dart b/test/customer/custom_error_block_test.dart
@@ -89,9 +89,6 @@ class ErrorBlockComponentBuilder extends BlockComponentBuilder {
       ),
     );
   }
-
-  @override
-  bool validate(Node node) => true;
 }
 
 class ErrorBlockComponentWidget extends BlockComponentStatefulWidget {
-Original file line number
+Diff line change
@@ Expand Up @@
           ),
         );
       }
-      @override
-      bool validate(Node node) => true;
     }
     class HeadingBlockComponentWidget extends BlockComponentStatefulWidget {
@@ Expand Down @@