2.8 KiB
appflowy_board
AppFlowy Board
A customizable and draggable Kanban Board widget for Flutter
Intro
appflowy_board is a customizable and draggable Kanban Board widget for Flutter. You can use it to create a Kanban Board tool like those in Trello.
Check out AppFlowy to see how appflowy_board is used to build a BoardView database.
Getting Started
Add the AppFlowy Board Flutter package to your environment.
With Flutter:
flutter pub add appflowy_board
flutter pub get
This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):
dependencies:
appflowy_board: ^0.0.6
Create board
Import the package in your Dart file:
import 'package:appflowy_board/appflowy_board.dart';
Usage Example
To quickly grasp how it can be used, look at the /example/lib folder. First, run main.dart to play with the demo.
Second, let's delve into multi_board_list_example.dart to understand a few key components:
- A Board widget is created via instantiating an AFBoard() object.
- In the AFBoard() object, you can find:
- AFBoardDataController, which is defined in board_data.dart, is feeded with prepopulated mock data. It also contains callback functions to materialize future user data.
- Three builders: AppFlowyColumnHeader, AppFlowyColumnFooter, AppFlowyColumnItemCard. See below image for what they are used for.
Glossary
Please refer to the API documentation.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Please look at CONTRIBUTING.md for details.
License
Distributed under the AGPLv3 License. See LICENSE for more information.
d