linkifyjs

The core linkifyjs library can be extended or used in specific environments via specialized packages. Depending on your use case, you may want to install one of the following instead of or in addition to the core library:

• Environment specific:

  • linkify-html: For processing HTML strings.
  • linkify-react: As a React component.
  • linkify-jquery: As a jQuery plugin.
  • linkify-element: For working directly with DOM Elements.
  • linkify-string: For plain-text processing.

• Plugins for detection:

  • linkify-plugin-hashtag: For detecting #hashtags.
  • linkify-plugin-mention: For detecting @mentions.
  • linkify-plugin-ticket: For detecting ticket identifiers.
  • linkify-plugin-ip: For detecting IP addresses.
  • linkify-plugin-keyword: For detecting specific keywords.

To use the ticket plugin, you must install both the core linkifyjs package and the linkify-plugin-ticket package via NPM.

npm install linkifyjs linkify-plugin-ticket

Install the keyword plugin and the core linkifyjs library using npm:

npm install linkifyjs linkify-plugin-keyword

The mention plugin works by extending the core linkifyjs functionality. You must import the plugin after importing linkifyjs to ensure the plugin registers itself correctly.

// Using CommonJS (require)
const linkify = require('linkifyjs');
require('linkify-plugin-mention');

// Using ES modules (import)
import * as linkify from 'linkifyjs';
import 'linkify-plugin-mention';

To use the linkify-element DOM interface, install both the core linkifyjs and the linkify-element package using npm. Note that if you are already using linkify-jquery, linkify-element is included automatically and does not need to be installed separately.

npm install linkifyjs linkify-element

If your environment does not have a window.document global available, you must manually provide the jQuery instance and the document object to the plugin during initialization.

// Using CommonJS (require)
const $ = require('jquery');
require('linkify-jquery')($, document);

// Using ES modules (import)
import $ from 'jquery';
import linkifyJq from 'linkify-jquery';
linkifyJq($, document);