README.md

Tiptap automatic links demo

Example of using Tiptap decorations to highlight any text in an editor that mathes one of n search terms.

Implementation is based heavily on serenadeinserenade's find & replace plugin.

The example here uses a dataset of ~5,000 food ingredients, and creates a link in the editor whenever an ingredient is mentioned.

Setup demo

The demo is based on create-react-app, so clone the repository them use the following to get it running

npm install
npm start

Use it yourself

To use in your own project, copyPaste the AutomaticLinks.tsx file into your project. Then in your Tiptap editor, import the plugin:

import { AutomaticLinks } from "./AutomaticLinks";

then add AutomaticLinks to your extensions list for the tiptap editor, along with configuration info.

AutomaticLinks.configure({
    searchResultClass: "autolink",
    searchTerms: arrayOfSearchTerms,
    onClick: id => {
        functionToRunOnLinkClick(id);
    },
}),