@types/react-linkify v1.0.4

Installation

npm install --save @types/react-linkify

Summary

This package contains type definitions for react-linkify (http://tasti.github.io/react-linkify/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-linkify.

index.d.ts

// Type definitions for react-linkify 1.0
// Project: http://tasti.github.io/react-linkify/
// Definitions by: Michael James <https://github.com/majames>
//                 Jacky Wang <https://github.com/jackywang529>
//                 Akhil Stanislavose <https://github.com/akhilstanis>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.4

import * as React from "react";

/**
 * Matching information
 */
export interface MatchInfo {
  /**
   * Link schema, can be empty for fuzzy links, or for protocol-neutral links
   */
  schema: string;
  /**
   * Offset of matched text
   */
  index: number;
  /**
   * Index of next char after the end of the matched text
   */
  lastIndex: number;
  /**
   * Normalized text
   */
  text: string;
  /**
   * Link, generated from matched text
   */
  url: string;
}

export interface Props {
  children: React.ReactNode;
  /**
   * Custom anchor tag creator
   * Default to using exisint <a> tag with the provided href={decoratedHref}, key={key}
   * and children={decoratedText}, without additional styling
   */
  componentDecorator?: ((decoratedHref: string, decoratedText: string, key: number) => React.ReactNode) | undefined;
  /**
   * Custom href decorator or mapper on the matched (url) href
   * Default to no transformation
   */
  hrefDecorator?: ((urlHref: string) => string) | undefined;
  /**
   * Custom matcher for (url), that returns each match with the matching information
   * Default to https://github.com/markdown-it/linkify-it's LinkifyIt().tlds(tlds).match
   */
  matchDecorator?: ((text: string) => MatchInfo[] | null) | undefined;
  /**
   * Custom text decorator or mapper on the matched (url) text
   * Default to no transformation
   */
  textDecorator?: ((urlText: string) => string) | undefined;
}

export default class ReactLinkify extends React.Component<Props> { }

Additional Details

• Last updated: Wed, 07 Jul 2021 17:33:47 GMT
• Dependencies: @types/react
• Global values: none

Credits

These definitions were written by Michael James, Jacky Wang, and Akhil Stanislavose.