Rich Text Editor | Fix for Editor's blinking caret disappearing issue in Firefox browser

change/@ni-nimble-components-46b1fdfb-63b3-4a04-ac71-1124855a4e45.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Fix for Firefox caret disappearing issue",
+  "packageName": "@ni/nimble-components",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

packages/nimble-components/src/rich-text-editor/index.ts

@@ -101,6 +101,7 @@ export class RichTextEditor extends FoundationElement {
      */
     public boldButtonClick(): void {
         this.tiptapEditor.chain().focus().toggleBold().run();
+        this.focusEditorInFirefoxEnv();
     }
 
     /**
@@ -110,6 +111,7 @@ export class RichTextEditor extends FoundationElement {
     public boldButtonKeyDown(event: KeyboardEvent): boolean {
         if (this.keyActivatesButton(event)) {
             this.tiptapEditor.chain().focus().toggleBold().run();
+            this.focusEditorInFirefoxEnv();
             return false;
         }
         return true;
@@ -121,6 +123,7 @@ export class RichTextEditor extends FoundationElement {
      */
     public italicsButtonClick(): void {
         this.tiptapEditor.chain().focus().toggleItalic().run();
+        this.focusEditorInFirefoxEnv();
     }
 
     /**
@@ -130,6 +133,7 @@ export class RichTextEditor extends FoundationElement {
     public italicsButtonKeyDown(event: KeyboardEvent): boolean {
         if (this.keyActivatesButton(event)) {
             this.tiptapEditor.chain().focus().toggleItalic().run();
+            this.focusEditorInFirefoxEnv();
             return false;
         }
         return true;
@@ -141,6 +145,7 @@ export class RichTextEditor extends FoundationElement {
      */
     public bulletListButtonClick(): void {
         this.tiptapEditor.chain().focus().toggleBulletList().run();
+        this.focusEditorInFirefoxEnv();
     }
 
     /**
@@ -150,6 +155,7 @@ export class RichTextEditor extends FoundationElement {
     public bulletListButtonKeyDown(event: KeyboardEvent): boolean {
         if (this.keyActivatesButton(event)) {
             this.tiptapEditor.chain().focus().toggleBulletList().run();
+            this.focusEditorInFirefoxEnv();
             return false;
         }
         return true;
@@ -161,6 +167,7 @@ export class RichTextEditor extends FoundationElement {
      */
     public numberedListButtonClick(): void {
         this.tiptapEditor.chain().focus().toggleOrderedList().run();
+        this.focusEditorInFirefoxEnv();
     }
 
     /**
@@ -170,6 +177,7 @@ export class RichTextEditor extends FoundationElement {
     public numberedListButtonKeyDown(event: KeyboardEvent): boolean {
         if (this.keyActivatesButton(event)) {
             this.tiptapEditor.chain().focus().toggleOrderedList().run();
+            this.focusEditorInFirefoxEnv();
             return false;
         }
         return true;
@@ -347,6 +355,18 @@ export class RichTextEditor extends FoundationElement {
                 return false;
         }
     }
+
+    // In Firefox browser, Once the editor gets focused, the blinking caret will be visible until we click format buttons (Bold, Italic ...) in the Firefox browser (Changing focus).
+    // But once the any of the buttons clicked, the editor internally has its focus but the blinking caret disappears.
+    // As a workaround, manually triggering blur and setting focus on editor will hepls making the caret re-appears.
+    // It seems like this issue in not fixed in firefox browser yet, Created Issue https://github.com/ni/nimble/issues/1454 tracks removal of this workaround.
+    private focusEditorInFirefoxEnv(): void {
+        const browserInfo = navigator.userAgent;
+        if (browserInfo.includes('Firefox')) {
+            this.tiptapEditor.commands.blur();
+            this.tiptapEditor.commands.focus();
+        }
+    }
 }
 
 const nimbleRichTextEditor = RichTextEditor.compose({