Skip to content

fix: use JSX.Element for type definitions #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2020
Merged

fix: use JSX.Element for type definitions #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8e2ada
fix: use JSX.Element for type definitions
yunyu Mar 26, 2020
bae05c0
fix: update .d.ts docstrings
yunyu Mar 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// TypeScript Version: 3.3

import * as React from 'react';
import { DomElement } from 'domhandler';
import domToReact from './lib/dom-to-react';
import htmlToDOM from 'html-dom-parser';
Expand All @@ -9,24 +8,21 @@ export interface HTMLReactParserOptions {
// TODO: Replace `object` by type for objects like `{ type: 'h1', props: { children: 'Heading' } }`
replace?: (
domNode: DomElement
) => React.ReactElement | object | void | undefined | null | false;
) => JSX.Element | object | void | undefined | null | false;
library?: object;
}

/**
* Converts HTML string to React elements.
* Converts HTML string to JSX element(s).
*
* @param html - The HTML string to parse to React.
* @param html - The HTML string to parse to JSX element(s).
* @param options - The parser options.
* @return - When parsed with HTML string, returns React elements; otherwise, returns string or empty array.
* @return - Single or array of JSX elements.
*/
declare function HTMLReactParser(
html: string,
options?: HTMLReactParserOptions
):
| string
| React.DetailedReactHTMLElement<{}, HTMLElement>
| Array<React.DetailedReactHTMLElement<{}, HTMLElement>>;
): ReturnType<typeof domToReact>;

export { DomElement, domToReact, htmlToDOM };

Expand Down
11 changes: 5 additions & 6 deletions lib/dom-to-react.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
// TypeScript Version: 3.3

import * as React from 'react';
import { HTMLReactParserOptions } from '..';
import { DomElement } from 'domhandler';

/**
* Converts DOM nodes to React elements.
* Converts DOM nodes to JSX element(s).
*
* @param nodes - A list of formatted DomNodes to convert to React.
* @param options - Options to use when converting to react.
* @returns ReactElement or and array of ReactElements.
* @param nodes - An array of DomNodes to convert to JSX element(s).
* @param options - Options to use when converting to JSX.
* @returns Single or array of JSX elements.
*/
export default function domToReact(
nodes: DomElement[],
options?: HTMLReactParserOptions
): React.ReactElement | React.ReactElement[];
): JSX.Element | JSX.Element[];
7 changes: 2 additions & 5 deletions test/types/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import parse, { HTMLReactParserOptions, domToReact, htmlToDOM } from 'html-react-parser';
import * as React from 'react';

// $ExpectType string | DetailedReactHTMLElement<{}, HTMLElement> | DetailedReactHTMLElement<{}, HTMLElement>[]
/* $ExpectType ReactElement | ReactElement[] */
parse('<div>text</div>');

// `options.replace`
Expand Down Expand Up @@ -39,8 +39,5 @@ parse('<a id="header" href="#">Heading</a>', {
// $ExpectType DomElement[]
const dom = htmlToDOM('<div>text</div>');

/* $ExpectType ReactElement<any, string | ((props: any) => ReactElement<any, string | any | (new (props: any) => Component<any, any, any>)> | null) |
(new (props: any) => Component<any, any, any>)> |
ReactElement<any, string | ((props: any) => ReactElement<any, string | any | (new (props: any) => Component<any, any, any>)> | null) |
(new (props: any) => Component<any, any, any>)>[] */
/* $ExpectType ReactElement | ReactElement[] */
domToReact(dom);
5 changes: 1 addition & 4 deletions test/types/lib/dom-to-react.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ import domToReact from 'html-react-parser/lib/dom-to-react';
import * as React from 'react';
import htmlToDOM from 'html-dom-parser';

/* $ExpectType ReactElement<any, string | ((props: any) => ReactElement<any, string | any | (new (props: any) => Component<any, any, any>)> | null) |
(new (props: any) => Component<any, any, any>)> |
ReactElement<any, string | ((props: any) => ReactElement<any, string | any | (new (props: any) => Component<any, any, any>)> | null) |
(new (props: any) => Component<any, any, any>)>[] */
/* $ExpectType ReactElement | ReactElement[] */
domToReact(htmlToDOM('<div>text</div>'));

// `options.replace`
Expand Down