Merge pull request #993 from AppFlowy-IO/feat/board_documentation

Author: appflowy

frontend/app_flowy/lib/plugins/board/application/board_bloc.dart

@@ -22,7 +22,7 @@ part 'board_bloc.freezed.dart';
 
 class BoardBloc extends Bloc<BoardEvent, BoardState> {
   final BoardDataController _gridDataController;
-  late final AFBoardDataController boardController;
+  late final AppFlowyBoardController boardController;
   final MoveRowFFIService _rowService;
   LinkedHashMap<String, GroupController> groupControllers = LinkedHashMap();
 
@@ -34,16 +34,16 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
       : _rowService = MoveRowFFIService(gridId: view.id),
         _gridDataController = BoardDataController(view: view),
         super(BoardState.initial(view.id)) {
-    boardController = AFBoardDataController(
-      onMoveColumn: (
+    boardController = AppFlowyBoardController(
+      onMoveGroup: (
         fromColumnId,
         fromIndex,
         toColumnId,
         toIndex,
       ) {
         _moveGroup(fromColumnId, toColumnId);
       },
-      onMoveColumnItem: (
+      onMoveGroupItem: (
         columnId,
         fromIndex,
         toIndex,
@@ -52,15 +52,15 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
         final toRow = groupControllers[columnId]?.rowAtIndex(toIndex);
         _moveRow(fromRow, columnId, toRow);
       },
-      onMoveColumnItemToColumn: (
-        fromColumnId,
+      onMoveGroupItemToGroup: (
+        fromGroupId,
         fromIndex,
-        toColumnId,
+        toGroupId,
         toIndex,
       ) {
-        final fromRow = groupControllers[fromColumnId]?.rowAtIndex(fromIndex);
-        final toRow = groupControllers[toColumnId]?.rowAtIndex(toIndex);
-        _moveRow(fromRow, toColumnId, toRow);
+        final fromRow = groupControllers[fromGroupId]?.rowAtIndex(fromIndex);
+        final toRow = groupControllers[toGroupId]?.rowAtIndex(toIndex);
+        _moveRow(fromRow, toGroupId, toRow);
       },
     );
 
@@ -165,10 +165,10 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
     boardController.clear();
 
     //
-    List<AFBoardColumnData> columns = groups
+    List<AppFlowyGroupData> columns = groups
         .where((group) => fieldController.getField(group.fieldId) != null)
         .map((group) {
-      return AFBoardColumnData(
+      return AppFlowyGroupData(
         id: group.groupId,
         name: group.desc,
         items: _buildRows(group),
@@ -178,7 +178,7 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
         ),
       );
     }).toList();
-    boardController.addColumns(columns);
+    boardController.addGroups(columns);
 
     for (final group in groups) {
       final delegate = GroupControllerDelegateImpl(
@@ -227,8 +227,8 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
         if (isClosed) return;
         for (final group in updatedGroups) {
           final columnController =
-              boardController.getColumnController(group.groupId);
-          columnController?.updateColumnName(group.desc);
+              boardController.getGroupController(group.groupId);
+          columnController?.updateGroupName(group.desc);
         }
       },
       onError: (err) {
@@ -243,13 +243,13 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
     );
   }
 
-  List<AFColumnItem> _buildRows(GroupPB group) {
+  List<AppFlowyGroupItem> _buildRows(GroupPB group) {
     final items = group.rows.map((row) {
       final fieldContext = fieldController.getField(group.fieldId);
       return BoardColumnItem(row: row, fieldContext: fieldContext!);
     }).toList();
 
-    return <AFColumnItem>[...items];
+    return <AppFlowyGroupItem>[...items];
   }
 
   Future<void> _loadGrid(Emitter<BoardState> emit) async {
@@ -335,7 +335,7 @@ class GridFieldEquatable extends Equatable {
   UnmodifiableListView<FieldPB> get value => UnmodifiableListView(_fields);
 }
 
-class BoardColumnItem extends AFColumnItem {
+class BoardColumnItem extends AppFlowyGroupItem {
   final RowPB row;
   final GridFieldContext fieldContext;
 
@@ -350,7 +350,7 @@ class BoardColumnItem extends AFColumnItem {
 
 class GroupControllerDelegateImpl extends GroupControllerDelegate {
   final GridFieldController fieldController;
-  final AFBoardDataController controller;
+  final AppFlowyBoardController controller;
   final void Function(String, RowPB, int?) onNewColumnItem;
 
   GroupControllerDelegateImpl({
@@ -369,16 +369,16 @@ class GroupControllerDelegateImpl extends GroupControllerDelegate {
 
     if (index != null) {
       final item = BoardColumnItem(row: row, fieldContext: fieldContext);
-      controller.insertColumnItem(group.groupId, index, item);
+      controller.insertGroupItem(group.groupId, index, item);
     } else {
       final item = BoardColumnItem(row: row, fieldContext: fieldContext);
-      controller.addColumnItem(group.groupId, item);
+      controller.addGroupItem(group.groupId, item);
     }
   }
 
   @override
   void removeRow(GroupPB group, String rowId) {
-    controller.removeColumnItem(group.groupId, rowId);
+    controller.removeGroupItem(group.groupId, rowId);
   }
 
   @override
@@ -388,7 +388,7 @@ class GroupControllerDelegateImpl extends GroupControllerDelegate {
       Log.warn("FieldContext should not be null");
       return;
     }
-    controller.updateColumnItem(
+    controller.updateGroupItem(
       group.groupId,
       BoardColumnItem(row: row, fieldContext: fieldContext),
     );
@@ -404,9 +404,9 @@ class GroupControllerDelegateImpl extends GroupControllerDelegate {
     final item = BoardColumnItem(row: row, fieldContext: fieldContext);
 
     if (index != null) {
-      controller.insertColumnItem(group.groupId, index, item);
+      controller.insertGroupItem(group.groupId, index, item);
     } else {
-      controller.addColumnItem(group.groupId, item);
+      controller.addGroupItem(group.groupId, item);
     }
     onNewColumnItem(group.groupId, row, index);
   }

frontend/app_flowy/lib/plugins/board/presentation/board_page.dart

@@ -62,17 +62,15 @@ class BoardContent extends StatefulWidget {
 }
 
 class _BoardContentState extends State<BoardContent> {
-  late ScrollController scrollController;
-  late AFBoardScrollManager scrollManager;
+  late AppFlowyBoardScrollController scrollManager;
 
-  final config = AFBoardConfig(
-    columnBackgroundColor: HexColor.fromHex('#F7F8FC'),
+  final config = AppFlowyBoardConfig(
+    groupBackgroundColor: HexColor.fromHex('#F7F8FC'),
   );
 
   @override
   void initState() {
-    scrollController = ScrollController();
-    scrollManager = AFBoardScrollManager();
+    scrollManager = AppFlowyBoardScrollController();
     super.initState();
   }
 
@@ -101,20 +99,20 @@ class _BoardContentState extends State<BoardContent> {
 
   Expanded _buildBoard(BuildContext context) {
     return Expanded(
-      child: AFBoard(
-        scrollManager: scrollManager,
-        scrollController: scrollController,
-        dataController: context.read<BoardBloc>().boardController,
+      child: AppFlowyBoard(
+        boardScrollController: scrollManager,
+        scrollController: ScrollController(),
+        controller: context.read<BoardBloc>().boardController,
         headerBuilder: _buildHeader,
         footerBuilder: _buildFooter,
         cardBuilder: (_, column, columnItem) => _buildCard(
           context,
           column,
           columnItem,
         ),
-        columnConstraints: const BoxConstraints.tightFor(width: 300),
-        config: AFBoardConfig(
-          columnBackgroundColor: HexColor.fromHex('#F7F8FC'),
+        groupConstraints: const BoxConstraints.tightFor(width: 300),
+        config: AppFlowyBoardConfig(
+          groupBackgroundColor: HexColor.fromHex('#F7F8FC'),
         ),
       ),
     );
@@ -143,20 +141,19 @@ class _BoardContentState extends State<BoardContent> {
 
   @override
   void dispose() {
-    scrollController.dispose();
     super.dispose();
   }
 
   Widget _buildHeader(
     BuildContext context,
-    AFBoardColumnData columnData,
+    AppFlowyGroupData columnData,
   ) {
     final boardCustomData = columnData.customData as BoardCustomData;
-    return AppFlowyColumnHeader(
+    return AppFlowyGroupHeader(
       title: Flexible(
         fit: FlexFit.tight,
         child: FlowyText.medium(
-          columnData.headerData.columnName,
+          columnData.headerData.groupName,
           fontSize: 14,
           overflow: TextOverflow.clip,
           color: context.read<AppTheme>().textColor,
@@ -181,14 +178,14 @@ class _BoardContentState extends State<BoardContent> {
     );
   }
 
-  Widget _buildFooter(BuildContext context, AFBoardColumnData columnData) {
+  Widget _buildFooter(BuildContext context, AppFlowyGroupData columnData) {
     final boardCustomData = columnData.customData as BoardCustomData;
     final group = boardCustomData.group;
 
     if (group.isDefault) {
       return const SizedBox();
     } else {
-      return AppFlowyColumnFooter(
+      return AppFlowyGroupFooter(
         icon: SizedBox(
           height: 20,
           width: 20,
@@ -215,8 +212,8 @@ class _BoardContentState extends State<BoardContent> {
 
   Widget _buildCard(
     BuildContext context,
-    AFBoardColumnData column,
-    AFColumnItem columnItem,
+    AppFlowyGroupData column,
+    AppFlowyGroupItem columnItem,
   ) {
     final boardColumnItem = columnItem as BoardColumnItem;
     final rowPB = boardColumnItem.row;
@@ -242,7 +239,7 @@ class _BoardContentState extends State<BoardContent> {
       },
     );
 
-    return AppFlowyColumnItemCard(
+    return AppFlowyGroupCard(
       key: ValueKey(columnItem.id),
       margin: config.cardPadding,
       decoration: _makeBoxDecoration(context),

frontend/app_flowy/packages/appflowy_board/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.0.7
+* Rename some classes
+* Add documentation
 # 0.0.6
 * Support scroll to bottom
 * Fix some bugs