Add Markdown rendering to AI Chat

CHANGELOG.md

@@ -35,6 +35,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We added an "Open example library" button to Welcome Tab. [#13014](https://github.com/JabRef/jabref/issues/13014)
 - We added automatic detection and selection of the identifier type (e.g., DOI, ISBN, arXiv) based on clipboard content when opening the "New Entry" dialog [#13111](https://github.com/JabRef/jabref/pull/13111)
 - We added support for import of a Refer/BibIX file format. [#13069](https://github.com/JabRef/jabref/issues/13069)
+- We added markdown rendering and copy capabilities to AI chat responses. [#12234](https://github.com/JabRef/jabref/issues/12234)
 - We added a new `jabkit` command `pseudonymize` to pseudonymize the library. [#13109](https://github.com/JabRef/jabref/issues/13109)
 - We added functionality to focus running instance when trying to start a second instance. [#13129](https://github.com/JabRef/jabref/issues/13129)
 - We added a highlighted diff regarding changes to the Group Tree Structure of a bib file, made outside JabRef. [#11221](https://github.com/JabRef/jabref/issues/11221)

jabgui/src/main/java/module-info.java

@@ -127,10 +127,10 @@
     // requires org.apache.xmpbox;
     // requires com.ibm.icu;
 
-    // requires flexmark;
+    requires flexmark;
     requires flexmark.html2md.converter;
-    // requires flexmark.util.ast;
-    // requires flexmark.util.data;
+    requires flexmark.util.ast;
+    requires flexmark.util.data;
 
     // requires com.h2database.mvstore;
 

jabgui/src/main/java/org/jabref/gui/JabRefGUI.java

@@ -18,6 +18,7 @@
 import org.jabref.gui.help.VersionWorker;
 import org.jabref.gui.icon.IconTheme;
 import org.jabref.gui.keyboard.KeyBindingRepository;
+import org.jabref.gui.keyboard.SelectableTextFlowKeyBindings;
 import org.jabref.gui.keyboard.TextInputKeyBindings;
 import org.jabref.gui.openoffice.OOBibBaseConnect;
 import org.jabref.gui.preferences.GuiPreferences;
@@ -267,10 +268,10 @@ private void openWindow() {
         themeManager.installCss(scene);
 
         LOGGER.debug("Handle TextEditor key bindings");
-        scene.addEventFilter(KeyEvent.KEY_PRESSED, event -> TextInputKeyBindings.call(
-                scene,
-                event,
-                preferences.getKeyBindingRepository()));
+        scene.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
+            TextInputKeyBindings.call(scene, event, preferences.getKeyBindingRepository());
+            SelectableTextFlowKeyBindings.call(scene, event, preferences.getKeyBindingRepository());
+        });
 
         mainStage.setTitle(JabRefFrame.FRAME_TITLE);
         mainStage.getIcons().addAll(IconTheme.getLogoSetFX());

jabgui/src/main/java/org/jabref/gui/ai/components/aichat/chatmessage/ChatMessageComponent.java

@@ -6,15 +6,18 @@
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.fxml.FXML;
 import javafx.geometry.NodeOrientation;
+import javafx.geometry.Pos;
 import javafx.scene.control.Label;
 import javafx.scene.layout.HBox;
+import javafx.scene.layout.Pane;
+import javafx.scene.layout.Priority;
 import javafx.scene.layout.VBox;
 
+import org.jabref.gui.util.MarkdownTextFlow;
 import org.jabref.logic.ai.util.ErrorMessage;
 import org.jabref.logic.l10n.Localization;
 
 import com.airhacks.afterburner.views.ViewLoader;
-import com.dlsc.gemsfx.ExpandingTextArea;
 import dev.langchain4j.data.message.AiMessage;
 import dev.langchain4j.data.message.ChatMessage;
 import dev.langchain4j.data.message.UserMessage;
@@ -30,19 +33,26 @@ public class ChatMessageComponent extends HBox {
     @FXML private HBox wrapperHBox;
     @FXML private VBox vBox;
     @FXML private Label sourceLabel;
-    @FXML private ExpandingTextArea contentTextArea;
+    @FXML private Pane markdownContentPane;
     @FXML private VBox buttonsVBox;
 
+    private final MarkdownTextFlow markdownTextFlow;
+
     public ChatMessageComponent() {
         ViewLoader.view(this)
                   .root(this)
                   .load();
 
-        chatMessage.addListener((observable, oldValue, newValue) -> {
+        chatMessage.addListener((_, _, newValue) -> {
             if (newValue != null) {
                 loadChatMessage();
             }
         });
+
+        markdownTextFlow = new MarkdownTextFlow(markdownContentPane);
+        markdownContentPane.getChildren().add(markdownTextFlow);
+        markdownContentPane.minHeightProperty().bind(markdownTextFlow.heightProperty());
+        markdownContentPane.prefHeightProperty().bind(markdownTextFlow.heightProperty());
     }
 
     public ChatMessageComponent(ChatMessage chatMessage, Consumer<ChatMessageComponent> onDeleteCallback) {
@@ -68,32 +78,35 @@ private void loadChatMessage() {
             case UserMessage userMessage -> {
                 setColor("-jr-ai-message-user", "-jr-ai-message-user-border");
                 setNodeOrientation(NodeOrientation.RIGHT_TO_LEFT);
+                wrapperHBox.setAlignment(Pos.TOP_RIGHT);
                 sourceLabel.setText(Localization.lang("User"));
-                contentTextArea.setText(userMessage.singleText());
+                markdownTextFlow.setMarkdown(userMessage.singleText());
             }
 
             case AiMessage aiMessage -> {
                 setColor("-jr-ai-message-ai", "-jr-ai-message-ai-border");
                 setNodeOrientation(NodeOrientation.LEFT_TO_RIGHT);
+                wrapperHBox.setAlignment(Pos.TOP_LEFT);
                 sourceLabel.setText(Localization.lang("AI"));
-                contentTextArea.setText(aiMessage.text());
+                markdownTextFlow.setMarkdown(aiMessage.text());
             }
 
             case ErrorMessage errorMessage -> {
                 setColor("-jr-ai-message-error", "-jr-ai-message-error-border");
                 setNodeOrientation(NodeOrientation.LEFT_TO_RIGHT);
                 sourceLabel.setText(Localization.lang("Error"));
-                contentTextArea.setText(errorMessage.getText());
+                markdownTextFlow.setMarkdown(errorMessage.getText());
             }
 
             default ->
-                LOGGER.error("ChatMessageComponent supports only user, AI, or error messages, but other type was passed: {}", chatMessage.get().type().name());
+                    LOGGER.error("ChatMessageComponent supports only user, AI, or error messages, but other type was passed: {}", chatMessage.get().type().name());
         }
     }
 
     @FXML
     private void initialize() {
         buttonsVBox.visibleProperty().bind(wrapperHBox.hoverProperty());
+        HBox.setHgrow(this, Priority.ALWAYS);
     }
 
     @FXML

jabgui/src/main/java/org/jabref/gui/keyboard/SelectableTextFlowKeyBindings.java

@@ -0,0 +1,25 @@
+package org.jabref.gui.keyboard;
+
+import javafx.scene.Scene;
+import javafx.scene.input.KeyEvent;
+
+import org.jabref.gui.util.SelectableTextFlow;
+
+public class SelectableTextFlowKeyBindings {
+    public static void call(Scene scene, KeyEvent event, KeyBindingRepository keyBindingRepository) {
+        if (scene.focusOwnerProperty().get() instanceof SelectableTextFlow selectableTextFlow) {
+            keyBindingRepository.mapToKeyBinding(event).ifPresent(binding -> {
+                switch (binding) {
+                    case COPY -> {
+                        selectableTextFlow.copySelectedText();
+                        event.consume();
+                    }
+                    case SELECT_ALL -> {
+                        selectableTextFlow.selectAll();
+                        event.consume();
+                    }
+                }
+            });
+        }
+    }
+}