autolinker

constructor

constructor(cfg: AbstractMatchConfig);

• Autolinker.match.Match constructor

  Parameter cfg

  The configuration properties for the Match instance, specified in an Object (map).

property matchedText

protected readonly matchedText: string;

• {String} matchedText (required)

  The original text that was matched by the Autolinker.matcher.Matcher.

property type

abstract readonly type: MatchType;

• {'url'/'email'/'hashtag'/'mention'/'phone'} type

  A string name for the type of match that this class represents. Can be used in a TypeScript discriminating union to type-narrow from the Match type.

  Modifiers

  • @public

method buildTag

buildTag: () => HtmlTag;

• Builds and returns an Autolinker.HtmlTag instance based on the Match.

  This can be used to easily generate anchor tags from matches, and either return their HTML string, or modify them before doing so.

  Example Usage:

  var tag = match.buildTag(); tag.addClass( 'cordova-link' ); tag.setAttr( 'target', '_system' );

  tag.toAnchorString(); // Google

  Example Usage in Autolinker#replaceFn:

  var html = Autolinker.link( "Test google.com", { replaceFn : function( match ) { var tag = match.buildTag(); // returns an Autolinker.HtmlTag instance tag.setAttr( 'rel', 'nofollow' );

  return tag; } } );

  // generated html: // Test google.com

method getAnchorHref

abstract getAnchorHref: () => string;

• Returns the anchor href that should be generated for the match.

  {String}

method getAnchorText

abstract getAnchorText: () => string;

• Returns the anchor text that should be generated for the match.

  {String}

method getCssClassSuffixes

getCssClassSuffixes: () => string[];

• Returns the CSS class suffix(es) for this match.

  A CSS class suffix is appended to the Autolinker#className in the Autolinker.AnchorTagBuilder when a match is translated into an anchor tag.

  For example, if Autolinker#className was configured as 'myLink', and this method returns [ 'url' ], the final class name of the element will become: 'myLink myLink-url'.

  The match may provide multiple CSS class suffixes to be appended to the Autolinker#className in order to facilitate better styling options for different match criteria. See Autolinker.match.Mention for an example.

  By default, this method returns a single array with the match's name, but may be overridden by subclasses.

  {String[]}

method getMatchedText

getMatchedText: () => string;

• Returns the original text that was matched.

  {String}

method getOffset

getOffset: () => number;

• Returns the offset of where the match was made in the input string. This is the 0-based index of the match.

  {Number}

method getType

abstract getType: () => MatchType;

• Returns a string name for the type of match that this class represents.

  Deprecated

  Use instead which can assist in type-narrowing for TypeScript. {String}

method setOffset

setOffset: (offset: number) => void;

• Sets the of where the match was made in the input string.

  A Autolinker.matcher.Matcher will be fed only HTML text nodes, and will therefore set an original offset that is relative to the HTML text node itself. However, we want this offset to be relative to the full HTML input string, and thus if using Autolinker#parse (rather than calling a Autolinker.matcher.Matcher directly), then this offset is corrected after the Matcher itself has done its job.

  Parameter offset

constructor

constructor(cfg?: AnchorTagBuilderCfg);

• constructor

  Parameter cfg

  The configuration options for the AnchorTagBuilder instance, specified in an Object (map).

method build

build: (match: AbstractMatch) => HtmlTag;

• Generates the actual anchor (<a>) tag to use in place of the matched text, via its match object.

  Parameter match

  The Match instance to generate an anchor tag from. The HtmlTag instance for the anchor tag.

method createAttrs

protected createAttrs: (match: AbstractMatch) => { [attrName: string]: string };

• Creates the Object (map) of the HTML attributes for the anchor (<a>) tag being generated.

  Parameter match

  The Match instance to generate an anchor tag from. A key/value Object (map) of the anchor tag's attributes.

method createCssClass

protected createCssClass: (match: AbstractMatch) => string;

• Creates the CSS class that will be used for a given anchor tag, based on the matchType and the config.

  Example returns:

  - "" // no - "myLink myLink-url" // url match - "myLink myLink-email" // email match - "myLink myLink-phone" // phone match - "myLink myLink-hashtag" // hashtag match - "myLink myLink-mention myLink-twitter" // mention match with Twitter service

  Parameter match

  The Match instance to generate an anchor tag from. The CSS class string for the link. Example return: "myLink myLink-url". If no was configured, returns an empty string.

constructor

constructor(cfg?: AutolinkerConfig);

• constructor

  Parameter cfg

  The configuration options for the Autolinker instance, specified in an Object (map).

property version

static readonly version: string;

• {String} version

  The Autolinker version number in the form major.minor.patch

  Ex: 3.15.0

property version

readonly version: string;

• The Autolinker version number exposed on the instance itself.

  Ex: 0.25.1

  {String} version

method link

static link: (textOrHtml: string, options?: AutolinkerConfig) => string;

• Automatically links URLs, Email addresses, Phone Numbers, Twitter handles, Hashtags, and Mentions found in the given chunk of HTML. Does not link URLs found within HTML tags.

  For instance, if given the text: You should go to http://www.yahoo.com, then the result will be You should go to <a href="http://www.yahoo.com">http://www.yahoo.com</a>

  Example:

  var linkedText = Autolinker.link( "Go to google.com", { newWindow: false } ); // Produces: "Go to google.com"

  Parameter textOrHtml

  The HTML or text to find matches within (depending on if the , , , , , and options are enabled).

  Parameter options

  Any of the configuration options for the Autolinker class, specified in an Object (map). See the class description for an example call. {String} The HTML text, with matches automatically linked.

• Automatically links URLs, Email addresses, Phone numbers, Hashtags, and Mentions (Twitter, Instagram, Soundcloud) found in the given chunk of HTML. Does not link URLs found within HTML tags.

  For instance, if given the text: You should go to http://www.yahoo.com, then the result will be `You should go to <a href="http://www.yahoo.com">http://www.yahoo.com</a>`

  This method finds the text around any HTML elements in the input textOrHtml, which will be the text that is processed. Any original HTML elements will be left as-is, as well as the text that is already wrapped in anchor (<a>) tags.

  Parameter textOrHtml

  The HTML or text to autolink matches within (depending on if the , , , , and options are enabled). {String} The HTML, with matches automatically linked.

method parse

static parse: (textOrHtml: string, options: AutolinkerConfig) => Match[];

• Parses the input textOrHtml looking for URLs, email addresses, phone numbers, username handles, and hashtags (depending on the configuration of the Autolinker instance), and returns an array of Autolinker.match.Match objects describing those matches (without making any replacements).

  Note that if parsing multiple pieces of text, it is slightly more efficient to create an Autolinker instance, and use the instance-level method.

  Example:

  var matches = Autolinker.parse( "Hello google.com, I am asdf@asdf.com", { urls: true, email: true } );

  console.log( matches.length ); // 2 console.log( matches[ 0 ].getType() ); // 'url' console.log( matches[ 0 ].getUrl() ); // 'google.com' console.log( matches[ 1 ].getType() ); // 'email' console.log( matches[ 1 ].getEmail() ); // 'asdf@asdf.com'

  Parameter textOrHtml

  The HTML or text to find matches within (depending on if the , , , , and options are enabled).

  Parameter options

  Any of the configuration options for the Autolinker class, specified in an Object (map). See the class description for an example call. {Autolinker.match.Match[]} The array of Matches found in the given input textOrHtml.

• Parses the input textOrHtml looking for URLs, email addresses, phone numbers, username handles, and hashtags (depending on the configuration of the Autolinker instance), and returns an array of Autolinker.match.Match objects describing those matches (without making any replacements).

  This method is used by the method, but can also be used to simply do parsing of the input in order to discover what kinds of links there are and how many.

  Example usage:

  var autolinker = new Autolinker( { urls: true, email: true } );

  var matches = autolinker.parse( "Hello google.com, I am asdf@asdf.com" );

  console.log( matches.length ); // 2 console.log( matches[ 0 ].getType() ); // 'url' console.log( matches[ 0 ].getUrl() ); // 'google.com' console.log( matches[ 1 ].getType() ); // 'email' console.log( matches[ 1 ].getEmail() ); // 'asdf@asdf.com'

  Parameter textOrHtml

  The HTML or text to find matches within (depending on if the , , , , and options are enabled). {Autolinker.match.Match[]} The array of Matches found in the given input textOrHtml.

constructor

constructor(cfg: EmailMatchConfig);

• constructor

  Parameter cfg

  The configuration properties for the Match instance, specified in an Object (map).

property type

readonly type: string;

• {'email'} type

  A string name for the type of match that this class represents. Can be used in a TypeScript discriminating union to type-narrow from the Match type.

  Modifiers

  • @public

method getAnchorHref

getAnchorHref: () => string;

• Returns the anchor href that should be generated for the match.

  {String}

method getAnchorText

getAnchorText: () => string;

• Returns the anchor text that should be generated for the match.

  {String}

method getEmail

getEmail: () => string;

• Returns the email address that was matched.

  {String}

method getType

getType: () => 'email';

• Returns a string name for the type of match that this class represents. For the case of EmailMatch, returns 'email'.

  {String}

constructor

constructor(cfg: HashtagMatchConfig);

• constructor

  Parameter cfg

  The configuration properties for the Match instance, specified in an Object (map).

property type

readonly type: string;

• {'hashtag'} type

  A string name for the type of match that this class represents. Can be used in a TypeScript discriminating union to type-narrow from the Match type.

  Modifiers

  • @public

method getAnchorHref

getAnchorHref: () => string;

• Returns the anchor href that should be generated for the match.

  {String}

method getAnchorText

getAnchorText: () => string;

• Returns the anchor text that should be generated for the match.

  {String}

method getCssClassSuffixes

getCssClassSuffixes: () => string[];

• Returns the CSS class suffixes that should be used on a tag built with the match. See Autolinker.match.Match#getCssClassSuffixes for details.

  {String[]}

method getHashtag

getHashtag: () => string;

• Returns the matched hashtag, without the '#' character.

  {String}

method getServiceName

getServiceName: () => HashtagService;

• Returns the configured to point the HashtagMatch to. Ex: 'facebook', 'twitter'.

  {String}

method getType

getType: () => 'hashtag';

• Returns a string name for the type of match that this class represents. For the case of HashtagMatch, returns 'hashtag'.

  {String}

constructor

constructor(cfg?: HtmlTagCfg);

• constructor

  Parameter cfg

  The configuration properties for this class, in an Object (map)

method addClass

addClass: (cssClass: string) => this;

• Convenience method to add one or more CSS classes to the HtmlTag. Will not add duplicate CSS classes.

  Parameter cssClass

  One or more space-separated CSS classes to add. {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method buildAttrsStr

protected buildAttrsStr: () => string;

• Support method for , returns the string space-separated key="value" pairs, used to populate the stringified HtmlTag.

  {String} Example return: attr1="value1" attr2="value2"

method getAttr

getAttr: (attrName: string) => string;

• Retrieves an attribute from the HtmlTag. If the attribute does not exist, returns undefined.

  Parameter attrName

  The attribute name to retrieve. {String} The attribute's value, or undefined if it does not exist on the HtmlTag.

method getAttrs

getAttrs: () => { [key: string]: string };

• Retrieves the attributes Object (map) for the HtmlTag.

  {Object.<String, String>} A key/value object of the attributes for the HtmlTag.

method getClass

getClass: () => string;

• Convenience method to retrieve the CSS class(es) for the HtmlTag, which will each be separated by spaces when there are multiple.

  {String}

method getInnerHtml

getInnerHtml: () => string;

• Backward compatibility method name.

  {String}

method getInnerHTML

getInnerHTML: () => string;

• Retrieves the inner HTML for the tag.

  {String}

method getTagName

getTagName: () => string;

• Retrieves the tag name.

  {String}

method hasClass

hasClass: (cssClass: string) => boolean;

• Convenience method to check if the tag has a CSS class or not.

  Parameter cssClass

  The CSS class to check for. {Boolean} true if the HtmlTag has the CSS class, false otherwise.

method removeClass

removeClass: (cssClass: string) => this;

• Convenience method to remove one or more CSS classes from the HtmlTag.

  Parameter cssClass

  One or more space-separated CSS classes to remove. {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method setAttr

setAttr: (attrName: string, attrValue: string) => this;

• Sets an attribute on the HtmlTag.

  Parameter attrName

  The attribute name to set.

  Parameter attrValue

  The attribute value to set. {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method setAttrs

setAttrs: (attrs: { [attr: string]: string }) => this;

• Sets one or more attributes on the HtmlTag.

  Parameter attrs

  A key/value Object (map) of the attributes to set. {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method setClass

setClass: (cssClass: string) => this;

• Sets the provided cssClass, overwriting any current CSS classes on the HtmlTag.

  Parameter cssClass

  One or more space-separated CSS classes to set (overwrite). {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method setInnerHtml

setInnerHtml: (html: string) => this;

• Backwards compatibility method name.

  Parameter html

  The inner HTML to set. {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method setInnerHTML

setInnerHTML: (html: string) => this;

• Sets the inner HTML for the tag.

  Parameter html

  The inner HTML to set. {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method setTagName

setTagName: (tagName: string) => this;

• Sets the tag name that will be used to generate the tag with.

  Parameter tagName

  {Autolinker.HtmlTag} This HtmlTag instance, so that method calls may be chained.

method toAnchorString

toAnchorString: () => string;

• Generates the HTML string for the tag.

  {String}

constructor

constructor(cfg: MentionMatchConfig);

• constructor

  Parameter cfg

  The configuration properties for the Match instance, specified in an Object (map).

property type

readonly type: string;

• {'mention'} type

  A string name for the type of match that this class represents. Can be used in a TypeScript discriminating union to type-narrow from the Match type.

  Modifiers

  • @public

method getAnchorHref

getAnchorHref: () => string;

• Returns the anchor href that should be generated for the match.

  {String}

method getAnchorText

getAnchorText: () => string;

• Returns the anchor text that should be generated for the match.

  {String}

method getCssClassSuffixes

getCssClassSuffixes: () => string[];

• Returns the CSS class suffixes that should be used on a tag built with the match. See Autolinker.match.Match#getCssClassSuffixes for details.

  {String[]}

method getMention

getMention: () => string;

• Returns the mention, without the '@' character.

  {String}

method getServiceName

getServiceName: () => MentionService;

• Returns the configured to point the mention to. Ex: 'instagram', 'twitter', 'soundcloud'.

  {String}

method getType

getType: () => 'mention';

• Returns a string name for the type of match that this class represents. For the case of MentionMatch, returns 'mention'.

  {String}

constructor

constructor(cfg: PhoneMatchConfig);

• constructor

  Parameter cfg

  The configuration properties for the Match instance, specified in an Object (map).

property type

readonly type: string;

• {'phone'} type

  A string name for the type of match that this class represents. Can be used in a TypeScript discriminating union to type-narrow from the Match type.

  Modifiers

  • @public

method getAnchorHref

getAnchorHref: () => string;

• Returns the anchor href that should be generated for the match.

  {String}

method getAnchorText

getAnchorText: () => string;

• Returns the anchor text that should be generated for the match.

  {String}

method getNumber

getNumber: () => string;

• Alias of , returns the phone number that was matched as a string, without any delimiter characters.

  Note: This is a string to allow for prefixed 0's.

  {String}

method getPhoneNumber

getPhoneNumber: () => string;

• Returns the phone number that was matched as a string, without any delimiter characters.

  Note: This is a string to allow for prefixed 0's.

  {String}

method getType

getType: () => 'phone';

• Returns a string name for the type of match that this class represents. For the case of PhoneMatch, returns 'phone'.

  {String}

constructor

constructor(cfg: UrlMatchConfig);

• constructor

  Parameter cfg

  The configuration properties for the Match instance, specified in an Object (map).

property type

readonly type: string;

• {'url'} type

  A string name for the type of match that this class represents. Can be used in a TypeScript discriminating union to type-narrow from the Match type.

  Modifiers

  • @public

method getAnchorHref

getAnchorHref: () => string;

• Returns the anchor href that should be generated for the match.

  {String}

method getAnchorText

getAnchorText: () => string;

• Returns the anchor text that should be generated for the match.

  {String}

method getType

getType: () => 'url';

• Returns a string name for the type of match that this class represents. For the case of UrlMatch, returns 'url'.

  {String}

method getUrl

getUrl: () => string;

• Returns the url that was matched, assuming the protocol to be 'http://' if the original match was missing a protocol.

  {String}

method getUrlMatchType

getUrlMatchType: () => UrlMatchType;

• Returns a string name for the type of URL match that this class represents.

  This helps to determine if the match was made in the original text with a prefixed scheme (ex: 'http://www.google.com'), a prefixed 'www' (ex: 'www.google.com'), or was matched by a known top-level domain (ex: 'google.com').

  {"scheme"/"www"/"tld"}

property matchedText

matchedText: string;

property offset

offset: number;

property tagBuilder

tagBuilder: AnchorTagBuilder;

property className

className?: string;

property newWindow

newWindow?: boolean;

property truncate

truncate?: TruncateConfigObj;

property className

className?: string;

property context

context?: any;

property decodePercentEncoding

decodePercentEncoding?: boolean;

property email

email?: boolean;

property hashtag

hashtag?: HashtagConfig;

property mention

mention?: MentionConfig;

property newWindow

newWindow?: boolean;

property phone

phone?: boolean;

property replaceFn

replaceFn?: ReplaceFn | null;

property sanitizeHtml

sanitizeHtml?: boolean;

property stripPrefix

stripPrefix?: StripPrefixConfig;

property stripTrailingSlash

stripTrailingSlash?: boolean;

property truncate

truncate?: TruncateConfig;

property urls

urls?: UrlsConfig;

property email

email: string;

property hashtag

hashtag: string;

property serviceName

serviceName: HashtagService;

property attrs

attrs?: {
    [key: string]: string;
};

property innerHtml

innerHtml?: string;

property innerHTML

innerHTML?: string;

property tagName

tagName?: string;

property mention

mention: string;

property serviceName

serviceName: MentionService;

property decodePercentEncoding

decodePercentEncoding: boolean;

property hashtagServiceName

hashtagServiceName: HashtagService;

property mentionServiceName

mentionServiceName: MentionService;

property stripPrefix

stripPrefix: Required<StripPrefixConfigObj>;

property stripTrailingSlash

stripTrailingSlash: boolean;

property tagBuilder

tagBuilder: AnchorTagBuilder;

property number

number: string;

property plusSign

plusSign: boolean;

property scheme

scheme?: boolean;

property www

www?: boolean;

property length

length?: number;

property location

location?: 'end' | 'middle' | 'smart';

property decodePercentEncoding

decodePercentEncoding: boolean;

property protocolRelativeMatch

protocolRelativeMatch: boolean;

property stripPrefix

stripPrefix: Required<StripPrefixConfigObj>;

property stripTrailingSlash

stripTrailingSlash: boolean;

property url

url: string;

property urlMatchType

urlMatchType: UrlMatchType;

property ipV4Matches

ipV4Matches?: boolean;

property schemeMatches

schemeMatches?: boolean;

property tldMatches

tldMatches?: boolean;