Tiptap Utility Package

A collection of utility functions to enhance your workflow with the Tiptap editor.

Installation

npm install tiptap-utility

Utilities

Quick Access

• isTextSelected
• getWordCount
• getFocusedNodeContainer

isTextSelected

Checks if text is selected in the Tiptap editor.

Parameters:

• editor: Tiptap Editor instance.

Returns:

• boolean: true if text is selected and editor is editable, otherwise false.

Example:

import { isTextSelected } from 'tiptap-utility';

const isSelected = isTextSelected({ editor });
console.log(isSelected ? "Text is selected" : "No text selected");

getWordCount

Counts the number of words in the Tiptap editor content.

Parameters:

• editor: Tiptap Editor instance.

Returns:

• number: Total word count.

Example:

import { getWordCount } from 'tiptap-utility';

const wordCount = getWordCount(editor);
console.log(`Word count: ${wordCount}`);

getFocusedNodeContainer

Finds the focused node container in the Tiptap editor DOM based on the specified nodeType.

Parameters:

• editor: Tiptap Editor instance.
• nodeType: The target node type to locate.
• attribute (optional): Attribute used to identify the node. Default is 'data-type'.
• focusClass (optional): CSS class used to identify focused nodes. Default is 'has-focus'.

Returns:

• HTMLElement | null: The focused node container or null if not found.

Example:

import { getFocusedNodeContainer } from 'tiptap-utility';

const container = getFocusedNodeContainer(editor, 'paragraph');
if (container) {
  console.log('Focused node container:', container);
} else {
  console.log('No focused container found.');
}

License

This package is open-source and available under the MIT License.