vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[react-linkify] Export namespace to expose props type defs (#40371)

Browse Source 
* Export namespace to expose props type defs

It would be nice to expose the props type definition which would allow users to extend the original component.

* Update version to 1.0.0-alpha

Seems like the interface haven't changed at all with the bump to 1.0.0-alpha

* Fix lint errros

* Remove the ReactLinkify namespace
This commit is contained in:
Akhil Stanislavose 2019-11-20 15:05:44 -08:00 committed by Sheetal Nandi
parent daa264d814
commit 170f1475a0
1 changed files with 52 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
types/react-linkify/index.d.ts vendored
View File

@ -1,65 +1,62 @@
// Type definitions for react-linkify 0.2
// 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";
declare namespace ReactLinkify {
/**
* Matching information
*/
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;
}
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;
/**
* Custom href decorator or mapper on the matched (url) href
* Default to no transformation
*/
hrefDecorator?: (urlHref: string) => string;
/**
* 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;
/**
* Custom text decorator or mapper on the matched (url) text
* Default to no transformation
*/
textDecorator?: (urlText: string) => string;
}
class ReactLinkify extends React.Component<Props> {}
/**
* 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 default ReactLinkify.ReactLinkify;
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;
/**
* Custom href decorator or mapper on the matched (url) href
* Default to no transformation
*/
hrefDecorator?: (urlHref: string) => string;
/**
* 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;
/**
* Custom text decorator or mapper on the matched (url) text
* Default to no transformation
*/
textDecorator?: (urlText: string) => string;
}
export default class ReactLinkify extends React.Component<Props> { }