Feat title plugin #2078

rileyhawk1417 · 2023-03-22T11:56:35Z

Description

The feature embeds a large text representing the Document Title.
Its a Editable Text Widget meaning the document name can be changed through the plugin.
This solves issue #1774

ToDo:

Display document name on page.
Save the new name to the document and update changes.

Refactor/grid decode cell data

Xazin · 2023-03-26T13:21:47Z

frontend/appflowy_flutter/lib/plugins/document/document_page.dart

@@ -189,7 +189,9 @@ class _AppFlowyEditorPageState extends State<_AppFlowyEditorPage> {
        ],
      ],
      toolbarItems: [
-        smartEditItem,
+        if (openAIKey != null && openAIKey!.isNotEmpty) ...[


Could also make the custom getter for openAIKey return an empty string if null.

String get openAIKey => documentBloc.state.userProfilePB?.openaiKey ?? ''; ... if (openAIKey.isNotEmpty) ...[

Another option.

openAIKey?.isNotEmpty ?? false

Xazin · 2023-03-26T13:22:23Z

frontend/appflowy_flutter/lib/plugins/document/document_page.dart

@@ -240,7 +242,7 @@ class _AppFlowyEditorPageState extends State<_AppFlowyEditorPage> {
    }
  }

-  dartz.Tuple2<bool, Selection?> _autoFocusParameters() {
+  dartz.Tuple2<bool, Selection?> _autoFocusParamters() {


Why rename, it was correctly spelled before?

Suggested change

dartz.Tuple2<bool, Selection?> _autoFocusParamters() {

dartz.Tuple2<bool, Selection?> _autoFocusParameters() {

Xazin · 2023-03-26T13:23:24Z

Starting to look really good, can't wait to test this out when you're done 👍

annieappflowy · 2023-03-27T07:59:40Z

You @Xazin are awesome too! Thanks for providing valuable feedback and offering help!

LucasXu0 · 2023-03-27T08:53:11Z

frontend/appflowy_flutter/lib/plugins/document/application/doc_bloc.dart

-        Node(type: kCoverType),
-      );
+      transaction
+          .insertNodes([0], [Node(type: kCoverType), Node(type: kTitleType)]);


transaction.insertNodes( [0], [ Node(type: kCoverType), Node(type: kTitleType), ], );

Add a comma here.

LucasXu0 · 2023-03-27T08:58:21Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+import 'package:appflowy_editor/appflowy_editor.dart';
+
+const String kTitleType = 'title';
+const String kTitleAttribute = 'docBloc';


Remove this unused code.

const String kTitleAttribute = 'docBloc';

LucasXu0 · 2023-03-27T08:59:03Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+        key: context.node.key,
+        node: context.node,
+        editorState: context.editorState,
+        title: docBloc);


pls add a comma between docBloc and ).

…lugin

…ppflowy into feat_title_plugin

a-wallen · 2023-04-04T17:16:23Z

frontend/appflowy_flutter/lib/plugins/document/document_page.dart

@@ -130,11 +129,11 @@ class _AppFlowyEditorPageState extends State<_AppFlowyEditorPage> {
  @override
  Widget build(BuildContext context) {
    final theme = Theme.of(context);
-    final autoFocusParameters = _autoFocusParameters();
+    final autoFocusParamters = _autoFocusParamters();


There's a typo in "parameters" here

a-wallen · 2023-04-04T17:17:29Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+const String kTitleType = 'title';
+
+class TitleNodeWidgetBuilder extends NodeWidgetBuilder {
+  TitleNodeWidgetBuilder({required this.docBloc});


If all fields are final, can't this constructor be const?

I get a warning about removing the const keyword. Would it be better to just not make the field not final?

Actually, it's because NodeWidgetBuilder does not have a const constructor.

a-wallen · 2023-04-04T17:19:32Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+  @override
+  void initState() {
+    super.initState();
+    docBloc = context.read<DocumentBloc>();


Since docBloc is marked as late, you can initialize it during its instantiating instead of in initState.

a-wallen · 2023-04-04T17:20:54Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+    docBloc = context.read<DocumentBloc>();
+    textEditingController = TextEditingController.fromValue(
+      TextEditingValue(
+        text: docBloc!.view.name.toString(),


If you use the null assertion operator here, shouldn't you make docBloc required? It's still possible for this class to be initialized with a docBloc with a value of null, and this null assertion will cause the program to fail.

a-wallen · 2023-04-04T17:21:41Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+        focusNode: focusNode,
+        selectionColor: theme.highlightColor,
+        style: TextStyle(
+            color: textColor, fontSize: 50.0, fontWeight: FontWeight.bold),


50, as a hardcoded size. Can we get that size from the theme file instead? See the AppFlowy style guide...

Okay will put it in a theme file, had tried some of the defaults such as Theme.of(context).textTheme.titleMedium and a few others. They didn't give the best result.

Xazin · 2023-04-04T19:13:11Z

frontend/appflowy_flutter/lib/plugins/document/document_page.dart

-      autoFocus: autoFocusParameters.value1,
-      focusedSelection: autoFocusParameters.value2,
+      autoFocus: autoFocusParamters.value1,
+      focusedSelection: autoFocusParamters.value2,


Xazin · 2023-04-04T19:14:39Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+
+  final Node node;
+  final EditorState editorState;
+  final DocumentBloc? title;


Do you need this? It's unused right?

You pass it through the Builder, but you in initState you read it from context anyway.

Also the name title is a bit ambiguous for a DocumentBloc

Xazin · 2023-04-04T19:14:52Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+
+class _TitleNodeWidgetState extends State<_TitleNodeWidget> {
+  _TitleNodeWidgetState();
+  late DocumentBloc? docBloc;


Suggested change

late DocumentBloc? docBloc;

late final DocumentBloc docBloc;

Xazin · 2023-04-04T19:16:05Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+        onSubmitted: (value) {
+          updateName(value);
+        },


Suggested change

onSubmitted: (value) {

updateName(value);

},

onSubmitted: updateName,

Xazin · 2023-04-04T19:16:35Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+  void updateName(String value) async {
+    await service.updateView(viewId: docBloc!.view.id, name: value);
+  }


Could be private

Xazin · 2023-04-04T19:16:58Z

...tend/appflowy_flutter/lib/plugins/document/presentation/plugins/title/title_node_widget.dart

+  @override
+  NodeValidator<Node> get nodeValidator => (node) {
+        return true;
+      };


Suggested change

@override

NodeValidator<Node> get nodeValidator => (node) {

return true;

};

@override

NodeValidator<Node> get nodeValidator => (node) => true;

appflowy · 2023-04-12T01:39:17Z

@LucasXu0 Is this PR ready to merge?

LucasXu0 · 2023-04-12T03:48:37Z

@LucasXu0 Is this PR ready to merge?

I don't think so. There are still some things that need to be done, such as adding support for multiple selection in the title plugin, and allowing the user to navigate to the next line using the enter key or arrow down key.

By the way, @rileyhawk1417, how about submitting this PR to the appflowy_editor repository instead? The main repository won't run the editor test on CI anymore.

rileyhawk1417 · 2023-04-12T18:44:54Z

Okay @LucasXu0 will move it to appflowy_editor, then close this PR. Will open a new one when connecting the plugin to AppFlowy.

rileyhawk1417 and others added 30 commits July 8, 2022 16:54

fix: fix linux build

0799bc3

Merge pull request #599 from AppFlowy-IO/refactor/grid_decode_cell_data

834f720

Refactor/grid decode cell data

Merge remote-tracking branch 'upstream/main'

2cc5f94

Merge remote-tracking branch 'upstream/main'

4a6e19e

Merge branch 'main' of github.com:rileyhawk1417/appflowy

51224ad

Merge remote-tracking branch 'upstream/main'

4ed26ea

Merge remote-tracking branch 'upstream/main'

9815382

Merge remote-tracking branch 'upstream/main'

ea69f6e

Merge remote-tracking branch 'upstream/main'

023bfe4

Merge remote-tracking branch 'upstream/main'

77cf493

Merge remote-tracking branch 'upstream/main'

2c93cdf

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

ef43e34

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

5f039c2

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

ef1b46f

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

5139518

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

afa3f70

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

a541bc3

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

590a66d

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

26e5239

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

3b8a74f

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

dc64b76

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

19684ea

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

68c8d90

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

4e86e35

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

a18ae6a

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

d554166

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

ffb48ea

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

fe86027

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

8cee776

Merge branch 'main' of github.com:AppFlowy-IO/AppFlowy

e606b20

rileyhawk1417 added 2 commits March 22, 2023 13:40

feat: Title Plugin

f3b2f2a

fix: add deleted item

a2a5bb3

Xazin reviewed Mar 26, 2023

View reviewed changes

LucasXu0 reviewed Mar 27, 2023

View reviewed changes

rileyhawk1417 added 6 commits March 28, 2023 14:56

fix: update document name & save to backend

9b41ed1

chore: Merge remote-tracking branch 'upstream/main' into feat_title_p…

99e0f00

…lugin

chore: format code & remove unused variables

1c248c3

Merge branch 'AppFlowy-IO:main' into feat_title_plugin

1524f24

feat: add hover actions & color change for text

283f71f

chore: Merge branch 'feat_title_plugin' of github.com:rileyhawk1417/a…

02bce34

…ppflowy into feat_title_plugin

rileyhawk1417 marked this pull request as ready for review April 4, 2023 13:16

rileyhawk1417 requested a review from a-wallen April 4, 2023 13:18

a-wallen suggested changes Apr 4, 2023

View reviewed changes

Xazin reviewed Apr 4, 2023

View reviewed changes

rileyhawk1417 added 2 commits April 7, 2023 10:49

Merge branch 'AppFlowy-IO:main' into feat_title_plugin

67457be

chore: optimize code & add theme value for pageTitle

ce8dc03

LucasXu0 marked this pull request as draft April 12, 2023 03:48

rileyhawk1417 closed this Apr 12, 2023

rileyhawk1417 mentioned this pull request Aug 17, 2023

Title Node Plugin For AppFlowy Editor AppFlowy-IO/appflowy-editor#392

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat title plugin #2078

Feat title plugin #2078

rileyhawk1417 commented Mar 22, 2023 •

edited

Loading

Xazin Mar 26, 2023

LucasXu0 Mar 27, 2023

Xazin Mar 26, 2023

Xazin commented Mar 26, 2023

annieappflowy commented Mar 27, 2023

LucasXu0 Mar 27, 2023

LucasXu0 Mar 27, 2023

LucasXu0 Mar 27, 2023

a-wallen Apr 4, 2023

a-wallen Apr 4, 2023

rileyhawk1417 Apr 7, 2023

Xazin Apr 7, 2023

a-wallen Apr 4, 2023

a-wallen Apr 4, 2023

a-wallen Apr 4, 2023

rileyhawk1417 Apr 7, 2023

Xazin Apr 4, 2023 •

edited

Loading

Xazin Apr 4, 2023 •

edited

Loading

Xazin Apr 4, 2023

Xazin Apr 4, 2023 •

edited

Loading

Xazin Apr 4, 2023

Xazin Apr 4, 2023

appflowy commented Apr 12, 2023

LucasXu0 commented Apr 12, 2023

rileyhawk1417 commented Apr 12, 2023

	dartz.Tuple2<bool, Selection?> _autoFocusParamters() {
	dartz.Tuple2<bool, Selection?> _autoFocusParameters() {

Feat title plugin #2078

Feat title plugin #2078

Conversation

rileyhawk1417 commented Mar 22, 2023 • edited Loading

Description

ToDo:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Xazin commented Mar 26, 2023

annieappflowy commented Mar 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Xazin Apr 4, 2023 • edited Loading

Choose a reason for hiding this comment

Xazin Apr 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Xazin Apr 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

appflowy commented Apr 12, 2023

LucasXu0 commented Apr 12, 2023

rileyhawk1417 commented Apr 12, 2023

rileyhawk1417 commented Mar 22, 2023 •

edited

Loading

Xazin Apr 4, 2023 •

edited

Loading

Xazin Apr 4, 2023 •

edited

Loading

Xazin Apr 4, 2023 •

edited

Loading