linkifyjs

What is linkifyjs?

The linkifyjs package is a robust tool for finding links in plain text and converting them into clickable HTML hyperlinks. It is useful for enhancing user-generated content where links are not automatically hyperlinked.

What are linkifyjs's main functionalities?

Link Detection

Detects URLs and email addresses in plain text and provides details about them. This feature is useful for applications that need to extract hyperlink information from text.

const linkify = require('linkifyjs');
const text = 'Visit http://example.com for more info.';
const html = linkify.find(text);
console.log(html);

Convert Text to HTML

Converts plain text containing URLs or email addresses into HTML with clickable links. This is particularly useful for rendering user-generated content safely in web applications.

const linkifyHtml = require('linkifyjs/html');
const text = 'See more at http://example.com.';
const linkedText = linkifyHtml(text);
console.log(linkedText);

Other packages similar to linkifyjs

autolinker

Like linkifyjs, autolinker is also designed to automatically convert URLs, email addresses, and Twitter usernames into clickable links in text. It offers additional features like customizing how links are displayed, which might be advantageous depending on the use case.

README

linkifyjs

Core linkify library.

Installation

Install from the command line with NPM

npm install linkifyjs

Import into your JavaScript with require

const linkify = require('linkifyjs');

or with ES modules

import * as linkify from 'linkifyjs';

Usage

Read the full documentation.

Changelog

v3.0.0

BREAKING CHANGES

• React, jQuery and Element interfaces moved to dedicated packages at linkify-react,linkify-jquery and linkify-element respectively:
• Remove default class="linkified" from all discovered links. Opt back in by setting the className option:

  linkifyStr(str, { className: "linkified" });
  

• Remove default target="_blank" attribute for discovered URLs. Opt back in by setting the target option:

  linkifyHtml(str, {
    target: (href, type) => type === "url" && "_blank",
  });
  

• React component: Remove outer <span> tag wrapper in favour of tag-less React.Fragment for React >=16. To opt back-in, set tagName='span':

  <Linkify tagName="span">{content}</Linkify>
  

• AMD module interface is no longer provided. Use an ESM bundler instead.
• Plugins imported after linkify is called on a string for the first time will not longer work. Import all plugins before calling a linkify core or interface function.
• Custom plugin API is not compatible with previous API in Linkify v2
• Dropped support for Internet Explorer versions 9 and 10. IE11 is still supported
• Dropped support for React versions <15

Deprecations

• Use dedicated packages linkify-string and linkify-html instead of linkifyjs/string and linkifyjs/html. The embedded packages will be removed in v4.0
• Use dedicated plugin packages linkify-plugin-[PLUGIN] instead of linkifyjs/plugin/[PLUGIN]. The embedded packages will be removed in v4.0

All Changes

• Full Internationalized Domain (IDN) and Emoji domain support 🇺🇳🌍✈️🎉💃! Detect URLs, #hashtags and @mentions in any language

• ~10x faster startup; ~4x faster combined startup + first run

• Custom protocols with linkify.registerCustomProtocol('protocol')

• Modernized codebase and build system

• Add new rel option at top level as an alternate way of including it in attributes

• New and improved plugin API

• TypeScript definitions included in published packages

• linkify.find() output includes start and end indexes for where in the string a link was found

• Plugins no longer need to be called on linkify after import

  // Before
  import * as linkify from "linkifyjs";
  import hashtag from "linkifyjs/plugins/hashtag";
  hashtag(linkify);
  
  // After
  import * as linkify from "linkifyjs";
  import "linkifyjs/plugins/hashtag";