@samhammer/tiptob

@samhammer/TipToB

TipTap ToolBox (TipToB)

TipToB is a customizable, web component-based toolbox for TipTap. It provides a set of ready-to-use Svelte web components and extensions for building modern, flexible, and framework-agnostic rich text editing experiences.

✨ Features

• Web Components: Use editor buttons and menus as custom elements in any framework or plain HTML.
• TipTap Extensions: Includes a set of TipTap extensions for advanced editing features.
• Svelte-based: All UI components are written in Svelte for performance and reactivity.
• Customizable: Easily style and extend the toolbox to fit your needs.

🚀 Installation

npm install @samhammer/tiptob

🛠️ Usage

Using Web Components

Import the web components bundle in your application:

import '@samhammer/tiptob/web-components.js';

You can now use the provided custom elements in your HTML:

<tiptob-bold-button></tiptob-bold-button>
<tiptob-italic-button></tiptob-italic-button>
<tiptob-underline-button></tiptob-underline-button>
<!-- ...and more -->

Using Extensions

Import the extensions bundle to use with your TipTap editor instance:

import { ImageExtension, InternalLinkExtension, KnowledgeExtension, SelectionDecoration, TableBubbleMenuExtension } from '@samhammer/tiptob/extensions';

🧩 Components

TipToB provides the following web components:

Web Component	Required TipTap Extension(s) and Import
<tiptob-bold-button>	@tiptap/extension-bold (Bold)
<tiptob-italic-button>	@tiptap/extension-italic (Italic)
<tiptob-underline-button>	@tiptap/extension-underline (Underline)
<tiptob-strike-button>	@tiptap/extension-strike (Strike)
<tiptob-bullet-list-button>	@tiptap/extension-list (ListKit)
<tiptob-ordered-list-button>	@tiptap/extension-list (ListKit)
<tiptob-font-color-button>	@tiptap/extension-color (Color), @tiptap/extension-text-style (TextStyleKit)
<tiptob-font-highlight-button>	HighlightExtension (from TipToB), @tiptap/extension-text-style (TextStyleKit)
<tiptob-image-button>	ImageExtension (from TipToB)
<tiptob-redo-button>	@tiptap/extensions (UndoRedo)
<tiptob-undo-button>	@tiptap/extensions (UndoRedo)
<tiptob-remove-format-button>
<tiptob-hyperlink-button>	@tiptap/extension-link (Link)
<tiptob-internal-link-button>	InternalLinkExtension (from TipToB), plus fetchSuggestions, fetchTitle, and getPreviewUrl callback properties
<tiptob-table-button>	@tiptap/extension-table (Table, TableCell, TableHeader, TableRow)
<tiptob-table-bubble-menu>	TableBubbleMenuExtension (from TipToB), @tiptap/extension-table (Table, TableCell, TableHeader, TableRow)
<tiptob-text-align-button>	@tiptap/extension-text-align (TextAlign)

🧩 Extensions

• ImageExtension: Add image support to your editor. You need to bind a function that uploads the File to your choosen FileProvider, the function receives a File and returns a Promise<string>. Example:

  uploadInlineImage(file: File): Promise<string>;
  

• InternalLinkExtension: Add support for <internallink internallinkid="..."> marks. The <tiptob-internal-link-button> component requires these callback properties:

  fetchSuggestions(term: string, signal?: AbortSignal): Promise<{ label: string; value: string }[]>;
  fetchTitle(id: string, signal?: AbortSignal): Promise<string>;
  getPreviewUrl(id: string): string;
  

• TableBubbleMenuExtension: Bubble Menu for table editing support.

⚡ Simple TipTap Editor Example

Below is a minimal example of initializing a TipTap editor. For more advanced usage and configuration, see the TipTap documentation:

import { Editor } from '@tiptap/core';
import StarterKit from '@tiptap/starter-kit';

const editor = new Editor({
  element: document.querySelector('.editor'),
  extensions: [
    StarterKit,
  ],
  content: '<p>Hello World!</p>',
});

<div class="editor"></div>

For more details and advanced configuration, visit the TipTap documentation.

🔗 Binding the Editor Instance to Web Components (Plain JavaScript)

TipToB web components require a TipTap editor instance to function. Some components, like the image upload button, also require a callback function for uploading images that returns a string (the image URL). Here is how you can do this in plain JavaScript (example for bold, italic, and image upload buttons):

import { Editor } from '@tiptap/core';
import StarterKit from '@tiptap/starter-kit';
import Bold from '@tiptap/extension-bold';
import Italic from '@tiptap/extension-italic';
import { ImageExtension } from '@samhammer/tiptob/extensions.js';

// Example image upload function (should return a Promise<string> with the image URL)
function uploadInlineImage(file) {
  // Replace this with your actual upload logic
  return new Promise((resolve) => {
    setTimeout(() => {
      // Simulate upload and return a dummy URL
      resolve('https://your.cdn.com/' + file.name);
    }, 1000);
  });
}

const editor = new Editor({
  element: document.querySelector('#editor'),
  extensions: [
    StarterKit,
    Bold,
    Italic,
    ImageExtension(uploadInlineImage)
  ],
  content: '<p>Hello World!</p>',
});

// Assign the editor instance to each TipToB custom element
const boldButton = document.querySelector('tiptob-bold-button');
boldButton.editor = editor;

const italicButton = document.querySelector('tiptob-italic-button');
italicButton.editor = editor;

const imageButton = document.querySelector('tiptob-image-button');
imageButton.editor = editor;
imageButton.imageUpload = uploadInlineImage;

<script type="module" src="@samhammer/tiptob/web-components.js"></script>

<div id="editor"></div>
<tiptob-bold-button></tiptob-bold-button>
<tiptob-italic-button></tiptob-italic-button>
<tiptob-image-button></tiptob-image-button>

Note: For components like <tiptob-image-button> and <tiptob-internal-link-button>, you must provide their callback properties before users interact with them.

🎨 Styling

TipToB components use CSS custom properties for easy theming. The following variables can be overwritten:

:root {
  --tiptob-bg-button: white;
  --tiptob-bg-button-hover: #e2e2e2;
  --tiptob-bg-button-highlighted: #a6ccf7;
  --tiptob-bg-icon: rgba(37, 39, 45, 0.37);
}

📄 License

MIT © Samhammer AG