mirror of
https://github.com/AppFlowy-IO/AppFlowy.git
synced 2024-08-30 18:12:39 +00:00
27dd719aa8
* chore: create orphan view handler * feat: save icon url and cover url in view * feat: implement emoji picker UI * chore: config ui * chore: config ui again * chore: replace RowPB with RowMetaPB to exposing more row information * fix: compile error * feat: show emoji in row * chore: update * test: insert emoji test * test: add update emoji test * test: add remove emoji test * test: add create field tests * test: add create row and delete row integration tests * test: add create row from row menu * test: document in row detail page * test: delete, duplicate row in row detail page * test: check the row count displayed in grid page * test: rename existing field in grid page * test: update field type of exisiting field in grid page * test: delete field test * test: add duplicate field test * test: add hide field test * test: add edit text cell test * test: add insert text to text cell test * test: add edit number cell test * test: add edit multiple number cells * test: add edit checkbox cell test * feat: integrate editor into database row * test: add edit create time and last edit time cell test * test: add edit date cell by selecting a date test * chore: remove unused code * chore: update checklist bg color * test: add update database layout test --------- Co-authored-by: Lucas.Xu <lucas.xu@appflowy.io>
105 lines
2.6 KiB
Dart
105 lines
2.6 KiB
Dart
library flowy_plugin;
|
|
|
|
import 'package:appflowy/startup/plugin/plugin.dart';
|
|
import 'package:appflowy/startup/startup.dart';
|
|
import 'package:appflowy/workspace/presentation/home/home_stack.dart';
|
|
import 'package:appflowy_backend/protobuf/flowy-folder2/view.pb.dart';
|
|
import 'package:flutter/widgets.dart';
|
|
|
|
export "./src/sandbox.dart";
|
|
|
|
enum PluginType {
|
|
editor,
|
|
blank,
|
|
trash,
|
|
grid,
|
|
board,
|
|
calendar,
|
|
}
|
|
|
|
typedef PluginId = String;
|
|
|
|
abstract class Plugin<T> {
|
|
PluginId get id;
|
|
|
|
PluginWidgetBuilder get widgetBuilder;
|
|
|
|
PluginNotifier? get notifier => null;
|
|
|
|
PluginType get pluginType;
|
|
|
|
void dispose() {
|
|
notifier?.dispose();
|
|
}
|
|
}
|
|
|
|
abstract class PluginNotifier<T> {
|
|
/// Notify if the plugin get deleted
|
|
ValueNotifier<T> get isDeleted;
|
|
|
|
void dispose() {}
|
|
}
|
|
|
|
abstract class PluginBuilder {
|
|
Plugin build(dynamic data);
|
|
|
|
String get menuName;
|
|
|
|
String get menuIcon;
|
|
|
|
/// The type of this [Plugin]. Each [Plugin] should have a unique [PluginType]
|
|
PluginType get pluginType;
|
|
|
|
/// The layoutType is used in the backend to determine the layout of the view.
|
|
/// Currrently, AppFlowy supports 4 layout types: Document, Grid, Board, Calendar.
|
|
ViewLayoutPB? get layoutType => ViewLayoutPB.Document;
|
|
}
|
|
|
|
abstract class PluginConfig {
|
|
// Return false will disable the user to create it. For example, a trash plugin shouldn't be created by the user,
|
|
bool get creatable => true;
|
|
}
|
|
|
|
abstract class PluginWidgetBuilder with NavigationItem {
|
|
List<NavigationItem> get navigationItems;
|
|
|
|
EdgeInsets get contentPadding =>
|
|
const EdgeInsets.symmetric(horizontal: 40, vertical: 28);
|
|
|
|
Widget buildWidget({PluginContext? context});
|
|
}
|
|
|
|
class PluginContext {
|
|
// calls when widget of the plugin get deleted
|
|
final Function(ViewPB, int?) onDeleted;
|
|
|
|
PluginContext({required this.onDeleted});
|
|
}
|
|
|
|
void registerPlugin({required PluginBuilder builder, PluginConfig? config}) {
|
|
getIt<PluginSandbox>()
|
|
.registerPlugin(builder.pluginType, builder, config: config);
|
|
}
|
|
|
|
/// Make the correct plugin from the [pluginType] and [data]. If the plugin
|
|
/// is not registered, it will return a blank plugin.
|
|
Plugin makePlugin({required PluginType pluginType, dynamic data}) {
|
|
final plugin = getIt<PluginSandbox>().buildPlugin(pluginType, data);
|
|
return plugin;
|
|
}
|
|
|
|
List<PluginBuilder> pluginBuilders() {
|
|
final pluginBuilders = getIt<PluginSandbox>().builders;
|
|
final pluginConfigs = getIt<PluginSandbox>().pluginConfigs;
|
|
return pluginBuilders.where(
|
|
(builder) {
|
|
final config = pluginConfigs[builder.pluginType]?.creatable;
|
|
return config ?? true;
|
|
},
|
|
).toList();
|
|
}
|
|
|
|
enum FlowyPluginException {
|
|
invalidData,
|
|
}
|