Preventing Text Highlighting

Oct 13, 2025 by magicalceylontours.com 19 views

Introduction

Adding a floating menu to your application can enhance user experience and provide easy access to frequently used features. However, when implementing a floating menu, it's common to encounter issues with text highlighting. In this article, we'll explore how to add a floating menu without highlighting the text using the Tiptap editor.

What is Tiptap Editor?

Tiptap is a JavaScript component for building rich text editors. It provides a simple and intuitive API for creating custom editors. One of the key features of Tiptap is its extensibility, allowing developers to create custom extensions to add new functionality to the editor.

Floating Menu Extension

The floating menu extension is a built-in extension in Tiptap that allows you to add a floating menu to your editor. The menu can contain custom buttons, dropdowns, or other interactive elements. To add a floating menu, you'll need to install the Tiptap editor and import the floating menu extension.

Step 1: Install Tiptap Editor

To get started, you'll need to install the Tiptap editor using npm or yarn:

npm install tiptap

Step 2: Import Floating Menu Extension

Once you've installed the Tiptap editor, you'll need to import the floating menu extension:

import { Editor } from '@tiptap/core';
import FloatingMenu from '@tiptap/extension-floating-menu';

Step 3: Create a Floating Menu

To create a floating menu, you'll need to create a new instance of the FloatingMenu extension and pass it to the Editor instance:

const editor = new Editor({
  extensions: [
    FloatingMenu,
  ],
  floatingMenu: {
    position: 'bottom',
    width: 200,
  },
});

In this example, we're creating a floating menu that appears at the bottom of the editor with a width of 200 pixels.

Step 4: Add Menu Items

To add menu items to the floating menu, you'll need to create a new instance of the FloatingMenu extension and pass it to the Editor instance:

const floatingMenu = editor.commandsFloatingMenu({
  items: [
    {
      label: 'Bold',
      icon: 'bold',
      onClick: () => {
        editor.commands.toggleBold();
      },
    },
    {
      label: 'Italic',
      icon: 'italic',
      onClick: () => {
        editor.commands.toggleItalic();
      },
    },
  ],
});

In this example, we're adding two menu items: a bold button and an italic button. When the user clicks on either button, the corresponding command is executed.

Step 5: Render the Floating Menu

To render the floating menu, you'll need to use the FloatingMenu extension's render method:

floatingMenu.render();

This will render the floating menu at the specified position and width.

Preventing Text Highlighting

To prevent text highlighting when the floating menu is open, you'll need to use the FloatingMenu extension's onOpen and onClose events:

floatingMenu.on('open', () => {
  editor.commands.selectNone();
});

floatingMenu.on('close', () => {
  editor.commands.selectNone();
});

In this example, we're using the onOpen and onClose events to select no text when the floating menu is open or closed, respectively. This prevents text highlighting when the menu is open.

Conclusion

Adding a floating menu to your application can enhance user experience and provide easy access to frequently used features. By following the steps outlined in this article, you can add a floating menu to your Tiptap editor without highlighting the text. Remember to use the FloatingMenu extension's onOpen and onClose events to prevent text highlighting when the menu is open or closed.

Example Use Case

Here's an example use case for the floating menu extension:

import { Editor } from '@tiptap/core';
import FloatingMenu from '@tiptap/extension-floating-menu';

const editor = new Editor({
  extensions: [
    FloatingMenu,
  ],
  floatingMenu: {
    position: 'bottom',
    width: 200,
  },
});

const floatingMenu = editor.commandsFloatingMenu({
  items: [
    {
      label: 'Bold',
      icon: 'bold',
      onClick: () => {
        editor.commands.toggleBold();
      },
    },
    {
      label: 'Italic',
      icon: 'italic',
      onClick: () => {
        editor.commands.toggleItalic();
      },
    },
  ],
});

floatingMenu.render();

floatingMenu.on('open', () => {
  editor.commands.selectNone();
});

floatingMenu.on('close', () => {
  editor.commands.selectNone();
});

Q: What is the purpose of the floating menu extension in Tiptap?

A: The floating menu extension in Tiptap allows you to add a floating menu to your editor. The menu can contain custom buttons, dropdowns, or other interactive elements.

Q: How do I install the Tiptap editor and import the floating menu extension?

A: To install the Tiptap editor, run the following command in your terminal:

npm install tiptap

To import the floating menu extension, add the following line to your code:

import { Editor } from '@tiptap/core';
import FloatingMenu from '@tiptap/extension-floating-menu';

Q: How do I create a floating menu in Tiptap?

A: To create a floating menu in Tiptap, you'll need to create a new instance of the FloatingMenu extension and pass it to the Editor instance:

const editor = new Editor({
  extensions: [
    FloatingMenu,
  ],
  floatingMenu: {
    position: 'bottom',
    width: 200,
  },
});

Q: How do I add menu items to the floating menu?

A: To add menu items to the floating menu, you'll need to create a new instance of the FloatingMenu extension and pass it to the Editor instance:

const floatingMenu = editor.commandsFloatingMenu({
  items: [
    {
      label: 'Bold',
      icon: 'bold',
      onClick: () => {
        editor.commands.toggleBold();
      },
    },
    {
      label: 'Italic',
      icon: 'italic',
      onClick: () => {
        editor.commands.toggleItalic();
      },
    },
  ],
});

Q: How do I prevent text highlighting when the floating menu is open?

A: To prevent text highlighting when the floating menu is open, you'll need to use the FloatingMenu extension's onOpen and onClose events:

floatingMenu.on('open', () => {
  editor.commands.selectNone();
});

floatingMenu.on('close', () => {
  editor.commands.selectNone();
});

Q: Can I customize the appearance of the floating menu?

A: Yes, you can customize the appearance of the floating menu by using the FloatingMenu extension's options. For example, you can change the position, width, and background color of the menu:

const editor = new Editor({
  extensions: [
    FloatingMenu,
  ],
  floatingMenu: {
    position: 'bottom',
    width: 200,
    backgroundColor: '#f0f0f0',
  },
});

Q: Can I add custom buttons to the floating menu?

A: Yes, you can add custom buttons to the floating menu by creating a new instance of the FloatingMenu extension and passing it to the Editor instance:

const floatingMenu = editor.commandsFloatingMenu({
  items: [
    {
      label: 'Custom Button',
      icon: 'custom-icon',
      onClick: () => {
        // Custom button logic here
      },
    },
  ],
});

Q: Can I use the floating menu extension with other Tiptap extensions?

A: Yes, you can use the floating menu extension with other Tiptap extensions. For example, you can use the FloatingMenu extension with the Bold and Italic extensions to create a menu with bold and italic buttons:

const editor = new Editor({
  extensions: [
    FloatingMenu,
    Bold,
    Italic,
  ],
  floatingMenu: {
    position: 'bottom',
    width: 200,
  },
});

Q: Can I customize the behavior of the floating menu?

A: Yes, you can customize the behavior of the floating menu by using the FloatingMenu extension's options. For example, you can change the behavior of the menu when it's opened or closed:

const editor = new Editor({
  extensions: [
    FloatingMenu,
  ],
  floatingMenu: {
    position: 'bottom',
    width: 200,
    onOpen: () => {
      // Custom logic here
    },
    onClose: () => {
      // Custom logic here
    },
  },
});

Conclusion

Adding a floating menu to your Tiptap editor can enhance user experience and provide easy access to frequently used features. By following the steps outlined in this article, you can add a floating menu to your Tiptap editor without highlighting the text. Remember to use the FloatingMenu extension's onOpen and onClose events to prevent text highlighting when the menu is open or closed.