html-linkify

Turn plain text links into HTML anchor elements

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
html-linkify
1141.2.28 years ago11 years agoMinified + gzip package size for html-linkify in KB

Readme

html-linkify
Replace any links and emails found in your text with HTML anchor elements and return properly escaped and safe HTML.
Example
var linkify = require("html-linkify");
var text = linkify(
	"Visit http://foo.com!\n" +
	"Email me@me.com\n" +
	"<script>alert('xss!')</script>");
console.log(text);
// -> Visit <a href="http://foo.com">http://foo.com</a>!
//    Email <a href="mailto:me@me.com">me@me.com</a>
//    <script>alert('xss!')</script>
API

linkify(text, [options])

Replace any links found in the input text with anchor elements.
Options:
options.attributes: A mapping of attributes to be added to the
generated anchor elements (in addition to *href*).
options.escape: Whether surrounding HTML tags should be escaped or not (default: true).
Todo
Allow arbitrary user-definable replacing
Installation
npm install html-linkify