Linkify URLs in text
$ npm install linkify-urls
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);Type: string
Text with URLs to linkify.
Type: Object
Type: Object
HTML attributes to add to the link.
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.
Type: string
Default: The URL
Set a custom HTML value for the link.
- url-regex - Regular expression for matching URLs
- linkify-issues - Linkify GitHub issue references
- get-urls - Get all URLs in text
MIT © Sindre Sorhus