{"id":19614599,"url":"https://github.com/appflowy-io/appflowy-board","last_synced_at":"2025-04-04T17:04:59.048Z","repository":{"id":103423274,"uuid":"596025781","full_name":"AppFlowy-IO/appflowy-board","owner":"AppFlowy-IO","description":"AppFlowy Board is a board-style widget that consists of multi-groups. It supports drag and drop between different groups. The AppFlowy Kanban Board project for AppFlowy and Beyond.","archived":false,"fork":false,"pushed_at":"2025-03-03T03:29:02.000Z","size":848,"stargazers_count":77,"open_issues_count":14,"forks_count":56,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-28T16:08:59.179Z","etag":null,"topics":["flutter","flutter-apps","flutter-examples","flutter-package","flutter-widget","kanban","kanban-board","kanban-board-application"],"latest_commit_sha":null,"homepage":"https://appflowy.io/blocks","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AppFlowy-IO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-01T10:03:00.000Z","updated_at":"2025-03-27T14:00:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"cbdc81e0-85c4-4c6d-9554-1e749f8f0011","html_url":"https://github.com/AppFlowy-IO/appflowy-board","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-board","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-board/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-board/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-board/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AppFlowy-IO","download_url":"https://codeload.github.com/AppFlowy-IO/appflowy-board/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247217172,"owners_count":20903008,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flutter","flutter-apps","flutter-examples","flutter-package","flutter-widget","kanban","kanban-board","kanban-board-application"],"created_at":"2024-11-11T10:53:04.421Z","updated_at":"2025-04-04T17:04:59.028Z","avatar_url":"https://github.com/AppFlowy-IO.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# appflowy_board\n\n\u003ch1 align=\"center\"\u003e\u003cb\u003eAppFlowy Board\u003c/b\u003e\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eA customizable and draggable Kanban Board widget for Flutter\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://discord.gg/ZCCYN4Anzq\"\u003e\u003cb\u003eDiscord\u003c/b\u003e\u003c/a\u003e •\n    \u003ca href=\"https://twitter.com/appflowy\"\u003e\u003cb\u003eTwitter\u003c/b\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/AppFlowy-IO/appflowy-board/blob/main/example/gifs/appflowy_board_video_1.gif?raw=true\" width=\"680\" title=\"AppFlowyBoard\"\u003e\n\u003c/p\u003e\n\n## Intro\n\nappflowy_board is a customizable and draggable Kanban Board widget for Flutter.\nYou can use it to create a Kanban Board tool like those in Trello.\n\nCheck out [appflowy_board](https://github.com/AppFlowy-IO/appflowy-board) to see to build a BoardView database.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/AppFlowy-IO/appflowy-board/blob/main/example/gifs/appflowy_board_video_2.gif?raw=true\" width=\"680\" title=\"AppFlowyBoard\"\u003e\n\u003c/p\u003e\n\n## Getting Started\n\nAdd the AppFlowy Board [Flutter package](https://docs.flutter.dev/development/packages-and-plugins/using-packages) to your environment.\n\nWith Flutter:\n\n```dart\nflutter pub add appflowy_board\nflutter pub get\n```\n\nThis will add a line like this to your package's pubspec.yaml:\n\n```dart\ndependencies:\n  appflowy_board: ^0.1.0\n```\n\n## Create your first board\n\nInitialize an `AppFlowyBoardController` for the board. It contains the data used by the board. You can\nregister callbacks to receive the changes of the board.\n\n```dart\n\nfinal AppFlowyBoardController controller = AppFlowyBoardController(\n  onMoveGroup: (fromGroupId, fromIndex, toGroupId, toIndex) {\n    debugPrint('Move item from $fromIndex to $toIndex');\n  },\n  onMoveGroupItem: (groupId, fromIndex, toIndex) {\n    debugPrint('Move $groupId:$fromIndex to $groupId:$toIndex');\n  },\n  onMoveGroupItemToGroup: (fromGroupId, fromIndex, toGroupId, toIndex) {\n    debugPrint('Move $fromGroupId:$fromIndex to $toGroupId:$toIndex');\n  },\n);\n```\n\nProvide an initial value of the board by initializing the `AppFlowyGroupData`. It represents a group data and contains list of items. Each item displayed in the group requires to implement the `AppFlowyGroupItem` class.\n\n```dart\n\nvoid initState() {\n  final group1 = AppFlowyGroupData(id: \"To Do\", items: [\n    TextItem(\"Card 1\"),\n    TextItem(\"Card 2\"),\n  ]);\n  final group2 = AppFlowyGroupData(id: \"In Progress\", items: [\n    TextItem(\"Card 3\"),\n    TextItem(\"Card 4\"),\n  ]);\n\n  final group3 = AppFlowyGroupData(id: \"Done\", items: []);\n\n  controller.addGroup(group1);\n  controller.addGroup(group2);\n  controller.addGroup(group3);\n  super.initState();\n}\n\nclass TextItem extends AppFlowyGroupItem {\n  final String s;\n  TextItem(this.s);\n\n  @override\n  String get id =\u003e s;\n}\n\n```\n\nFinally, return a `AppFlowyBoard` widget in the build method.\n\n```dart\n\n@override\nWidget build(BuildContext context) {\n  return AppFlowyBoard(\n    controller: controller,\n    cardBuilder: (context, group, groupItem) {\n      final textItem = groupItem as TextItem;\n      return AppFlowyGroupCard(\n        key: ObjectKey(textItem),\n        child: Text(textItem.s),\n      );\n    },\n    groupConstraints: const BoxConstraints.tightFor(width: 240),\n  );\n}\n\n```\n\n## Usage Example\n\nTo quickly grasp how it can be used, look at the /example/lib folder.\nFirst, run main.dart to play with the demo.\n\nSecond, let's delve into multi_board_list_example.dart to understand a few key components:\n\n- A Board widget is created via instantiating an `AppFlowyBoard` object.\n- In the `AppFlowyBoard` object, you can find the `AppFlowyBoardController`, which is defined in board_data.dart, is fed with pre-populated mock data. It also contains callback functions to materialize future user data.\n- Three builders: AppFlowyBoardHeaderBuilder, AppFlowyBoardFooterBuilder, AppFlowyBoardCardBuilder. See below image for what they are used for.\n\n\u003cp\u003e\n\u003cimg src=\"https://github.com/AppFlowy-IO/appflowy-board/blob/main/example/gifs/appflowy_board_builders.jpg?raw=true\" width=\"200\" title=\"AppFlowyBoard\"\u003e\n\u003c/p\u003e\n\n## Glossary\n\nPlease refer to the API documentation.\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.\n\nPlease look at [CONTRIBUTING.md](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-board","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappflowy-io%2Fappflowy-board","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-board/lists"}