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

1import * as React from "react";
2
3/**
4 * Matching information
5 */
6export interface MatchInfo {
7    /**
8     * Link schema, can be empty for fuzzy links, or for protocol-neutral links
9     */
10    schema: string;
11    /**
12     * Offset of matched text
13     */
14    index: number;
15    /**
16     * Index of next char after the end of the matched text
17     */
18    lastIndex: number;
19    /**
20     * Normalized text
21     */
22    text: string;
23    /**
24     * Link, generated from matched text
25     */
26    url: string;
27}
28
29export interface Props {
30    children: React.ReactNode;
31    /**
32     * Custom anchor tag creator
33     * Default to using exisint <a> tag with the provided href={decoratedHref}, key={key}
34     * and children={decoratedText}, without additional styling
35     */
36    componentDecorator?: ((decoratedHref: string, decoratedText: string, key: number) => React.ReactNode) | undefined;
37    /**
38     * Custom href decorator or mapper on the matched (url) href
39     * Default to no transformation
40     */
41    hrefDecorator?: ((urlHref: string) => string) | undefined;
42    /**
43     * Custom matcher for (url), that returns each match with the matching information
44     * Default to https://github.com/markdown-it/linkify-it's LinkifyIt().tlds(tlds).match
45     */
46    matchDecorator?: ((text: string) => MatchInfo[] | null) | undefined;
47    /**
48     * Custom text decorator or mapper on the matched (url) text
49     * Default to no transformation
50     */
51    textDecorator?: ((urlText: string) => string) | undefined;
52}
53
54export default class ReactLinkify extends React.Component<Props> {}
55

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/react

Credits

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