Newfoundland Pitbull Mix

    @tdukart/linkify-urls
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.0 • Public • Published

    linkify-urls Build Status

    Linkify URLs in a string

    Install

    $ npm install @tdukart/linkify-urls
    

    Usage

    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(string, [options])

    string

    Type: string

    String 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

    License

    MIT © Sindre Sorhus

    Install

    npm i @tdukart/linkify-urls

    DownloadsWeekly Downloads

    1

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    7.65 kB

    Total Files

    5

    Last publish

    Collaborators

    • tdukart