Package Exports
- linkify-urls
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (linkify-urls) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
linkify-urls 
Linkify URLs in text
Install
$ npm install linkify-urlsUsage
const linkifyUrls = require('linkify-urls');
linkifyUrls('See https://sindresorhus.com', {
attributes: {
class: 'unicorn',
one: 1,
foo: true,
multiple: ['a', 'b']
}
});
//=> 'See <a href="https://sindresorhus.com" class="unicorn" one="1" foo multiple="a b">https://sindresorhus.com</a>'
// In the browser
const fragment = linkifyUrls('See https://sindresorhus.com', {
type: 'dom',
attributes: {
class: 'unicorn',
}
});
document.body.appendChild(fragment);API
linkifyUrls(input, [options])
input
Type: string
Text with URLs to linkify.
options
Type: Object
attributes
Type: Object
HTML attributes to add to the link.
type
Type: string
Values: string dom
Default: string
Format of the generated content.
string will return it as a flat string like 'Visit <a href="https://example.com">https://example.com</a>'.
dom will return it as a DocumentFragment ready to be appended in a DOM safely, like DocumentFragment(TextNode('Visit '), HTMLAnchorElement('https://example.com')). This type only works in the browser.
value
Type: string Function
Default: The URL
Set a custom HTML value for the link.
If it's a function, it will receive the URL as a string:
linkifyUrls('See https://sindresorhus.com/foo', {
value: url => new URL(url).pathname
});
//=> 'See <a href="https://sindresorhus.com/foo">/foo</a>'Browser compatibility
Version 3 of this package uses negative lookbehind regex syntax. Stay on version 2 if you need to support browsers that doesn't support this feature.
Related
- url-regex - Regular expression for matching URLs
- linkify-issues - Linkify GitHub issue references
- get-urls - Get all URLs in text
License
MIT © Sindre Sorhus