jQuery Plugins › jQuery Text Plugins › jQuery linkify

jQuery Plugin To Transform URLs In Text Into Links - linkify

File Size:	98.4 KB
Views Total:
Last Update:	01/30/2019 08:53:00 UTC
Publish Date:	12/26/2013 13:17:09 UTC
Official Website:	Go to website
License:	MIT

Demo Download

How to start using jQuery?

Install & Download:

# Yarn
$ yarn add linkifyjs

# NPM
$ npm install linkifyjs --save

Basic Usage:

1. Include jQuery library and the jQuery linkify plugin in the page.

<script src="jquery.min.js"></script>
<script src="linkify.min.js"></script>
<script src="linkify-jquery.min.js"></script>

2. To use plugins, include the plugin's JavaScript in the document. All possible plugins:

hashtag: supports #hashtag
mention: supports @mention
ticket: supports Github-style tickets/issues

<script src="linkify-plugin-hashtag.amd.min.js"></script>
<script src="linkify-plugin-mention.amd.js"></script>
<script src="linkify-plugin-ticket.amd.js"></script>

3. Include a polyfill for legacy browsers.

<script src="linkify-polyfill.min.js"></script>

4. A Linkified object contains a DOM node (or just plain text) whose inner text is replaced by HTML containing <a> links to URLs discovered in that text.

<p>My website is https://www.jqueryscript.net</p>
<p>My email address is [email protected]</p>

5. Call the plugin and done.

$(function(){
  $('p').linkify();
});

6. All default plugin settings.

$('p').linkify({

  // additional attributes for the links
  attributes: null,

  // default CSS class
  className: 'linkified',

  // default protocol
  defaultProtocol: 'http',

  /* event listeners
    click: function (e) {
      alert('Link clicked!');
    }
  */
  events: null,

  // format the text
  format: function (value, type) {
    return value;
  },

  // format the href
  formatHref: function (href, type) {
    return href;
  },

  // ignore specified HTML tags
  ignoreTags: [],

  // if true, \n line breaks will automatically be converted to <br> tags.
  nl2br: false,

  // the tag that should be used to wrap each URL. This is useful for cases where a tags might be innapropriate, or might syntax problems
  tagName: 'a',

  // target attribute for each linkified tag.
  target: {
    url: '_blank'
  },

  // custom validation rules here
  validate: true

});

7. Find all links in the given string.

linkify.find('any string here');

Changelog:

v2.1.8 (2019-01-30)

Allow mentions with inner @ sign for federated mentions
Drop official support for Internet Explorer 8 and Node.js 6 (still supported unofficially but may break in future releases)
Update dev dependencies

v2.1.7 (2018-03-06)