html-react-parser 1.4.12 → 2.0.0

package/index.d.ts

@@ -43,9 +43,9 @@ export interface HTMLReactParserOptions {
 /**
  * Converts HTML string to JSX element(s).
  *
- * @param  html    - HTML string.
- * @param  options - Parser options.
- * @return         - JSX element(s), empty array, or string.
+ * @param html - HTML string.
+ * @param options - Parser options.
+ * @returns - JSX element(s), empty array, or string.
  */
 export default function HTMLReactParser(
   html: string,

package/index.js

@@ -12,12 +12,12 @@ var domParserOptions = { lowerCaseAttributeNames: false };
 /**
  * Converts HTML string to React elements.
  *
- * @param  {String}   html                    - HTML string.
- * @param  {Object}   [options]               - Parser options.
- * @param  {Object}   [options.htmlparser2]   - htmlparser2 options.
- * @param  {Object}   [options.library]       - Library for React, Preact, etc.
- * @param  {Function} [options.replace]       - Replace method.
- * @return {JSX.Element|JSX.Element[]|String} - React element(s), empty array, or string.
+ * @param {string} html - HTML string.
+ * @param {object} [options] - Parser options.
+ * @param {object} [options.htmlparser2] - htmlparser2 options.
+ * @param {object} [options.library] - Library for React, Preact, etc.
+ * @param {Function} [options.replace] - Replace method.
+ * @returns {JSX.Element|JSX.Element[]|string} - React element(s), empty array, or string.
  */
 function HTMLReactParser(html, options) {
   if (typeof html !== 'string') {
@@ -36,7 +36,7 @@ function HTMLReactParser(html, options) {
 HTMLReactParser.domToReact = domToReact;
 HTMLReactParser.htmlToDOM = htmlToDOM;
 HTMLReactParser.attributesToProps = attributesToProps;
-HTMLReactParser.Element = require('domhandler/lib/node').Element;
+HTMLReactParser.Element = require('domhandler').Element;
 
 // support CommonJS and ES Modules
 module.exports = HTMLReactParser;

package/lib/attributes-to-props.d.ts

@@ -9,7 +9,7 @@ export type Props = Record<string, string> & {
 /**
  * Converts HTML/SVG DOM attributes to React props.
  *
- * @param  attributes - HTML/SVG DOM attributes.
- * @return            - React props.
+ * @param attributes - HTML/SVG DOM attributes.
+ * @returns - React props.
  */
 export default function attributesToProps(attributes: Attributes): Props;

package/lib/attributes-to-props.js

@@ -4,8 +4,8 @@ var utilities = require('./utilities');
 /**
  * Converts HTML/SVG DOM attributes to React props.
  *
- * @param  {object} [attributes={}] - HTML/SVG DOM attributes.
- * @return {object}                 - React props.
+ * @param {object} [attributes={}] - HTML/SVG DOM attributes.
+ * @returns - React props.
  */
 module.exports = function attributesToProps(attributes) {
   attributes = attributes || {};
@@ -79,7 +79,7 @@ module.exports = function attributesToProps(attributes) {
  * Gets prop name from lowercased attribute name.
  *
  * @param {string} attributeName - Lowercased attribute name.
- * @return {string}
+ * @returns - Prop name.
  */
 function getPropName(attributeName) {
   return reactProperty.possibleStandardNames[attributeName];

package/lib/dom-to-react.d.ts

@@ -7,9 +7,9 @@ export { DOMNode, HTMLReactParserOptions };
 /**
  * Converts DOM nodes to JSX element(s).
  *
- * @param  nodes   - DOM nodes.
- * @param  options - Parser options.
- * @return         - JSX element(s).
+ * @param nodes - DOM nodes.
+ * @param options - Parser options.
+ * @returns - JSX element(s).
  */
 export default function domToReact(
   nodes: DOMNode[],

package/lib/dom-to-react.js

@@ -8,11 +8,11 @@ var canTextBeChildOfNode = utilities.canTextBeChildOfNode;
 /**
  * Converts DOM nodes to JSX element(s).
  *
- * @param  {DomElement[]} nodes             - DOM nodes.
- * @param  {object}       [options={}]      - Options.
- * @param  {Function}     [options.replace] - Replacer.
- * @param  {object}       [options.library] - Library (React/Preact/etc.).
- * @return {string|JSX.Element|JSX.Element[]}
+ * @param {DomElement[]} nodes - DOM nodes.
+ * @param {object} [options={}] - Options.
+ * @param {Function} [options.replace] - Replacer.
+ * @param {object} [options.library] - Library (React, Preact, etc.).
+ * @returns - String or JSX element(s).
  */
 function domToReact(nodes, options) {
   options = options || {};
@@ -125,8 +125,8 @@ function domToReact(nodes, options) {
  * Determines whether DOM element attributes should be transformed to props.
  * Web Components should not have their attributes transformed except for `style`.
  *
- * @param  {DomElement} node
- * @return {boolean}
+ * @param {DomElement} node
+ * @returns - Whether node attributes should be converted to props.
  */
 function skipAttributesToProps(node) {
   return (

package/lib/utilities.js

@@ -4,9 +4,9 @@ var styleToJS = require('style-to-js').default;
 /**
  * Swap key with value in an object.
  *
- * @param  {Object}   obj        - The object.
- * @param  {Function} [override] - The override method.
- * @return {Object}              - The inverted object.
+ * @param {object} obj - The object.
+ * @param {Function} [override] - The override method.
+ * @returns - The inverted object.
  */
 function invertObject(obj, override) {
   if (!obj || typeof obj !== 'object') {
@@ -44,8 +44,8 @@ function invertObject(obj, override) {
  * @see {@link https://github.com/facebook/react/blob/v16.6.3/packages/react-dom/src/shared/isCustomComponent.js}
  *
  * @param {string} tagName - The name of the html tag.
- * @param {Object} props   - The props being passed to the element.
- * @return {boolean}
+ * @param {object} props - The props being passed to the element.
+ * @returns - Whether tag is custom component.
  */
 function isCustomComponent(tagName, props) {
   if (tagName.indexOf('-') === -1) {
@@ -113,8 +113,8 @@ var elementsWithNoTextChildren = new Set([
 /**
  * Checks if the given node can contain text nodes
  *
- * @param {DomElement} node
- * @returns {boolean}
+ * @param {DomElement} node - Node.
+ * @returns - Whether node can contain text nodes.
  */
 function canTextBeChildOfNode(node) {
   return !elementsWithNoTextChildren.has(node.name);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-react-parser",
-  "version": "1.4.12",
+  "version": "2.0.0",
   "description": "HTML to React parser.",
   "author": "Mark <mark@remarkablemark.org>",
   "main": "index.js",
@@ -45,35 +45,36 @@
   ],
   "dependencies": {
     "domhandler": "4.3.1",
-    "html-dom-parser": "1.2.0",
+    "html-dom-parser": "2.0.0",
     "react-property": "2.0.0",
-    "style-to-js": "1.1.0"
+    "style-to-js": "1.1.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.2.3",
-    "@commitlint/config-conventional": "16.2.1",
-    "@rollup/plugin-commonjs": "21.1.0",
-    "@rollup/plugin-node-resolve": "13.2.1",
+    "@commitlint/cli": "17.0.2",
+    "@commitlint/config-conventional": "17.0.2",
+    "@rollup/plugin-commonjs": "22.0.0",
+    "@rollup/plugin-node-resolve": "13.3.0",
     "@size-limit/preset-big-lib": "7.0.8",
-    "@types/react": "18.0.6",
-    "@typescript-eslint/parser": "5.20.0",
+    "@types/react": "18.0.14",
+    "@typescript-eslint/parser": "5.28.0",
     "benchmark": "2.1.4",
     "dtslint": "4.2.1",
-    "eslint": "8.13.0",
+    "eslint": "8.18.0",
     "eslint-plugin-prettier": "4.0.0",
-    "husky": "7.0.4",
-    "jest": "27.5.1",
-    "lint-staged": "12.4.0",
+    "husky": "8.0.1",
+    "jest": "28.1.1",
+    "jest-environment-jsdom": "28.1.1",
+    "lint-staged": "13.0.2",
     "pinst": "3.0.0",
-    "preact": "10.7.1",
-    "prettier": "2.6.2",
-    "react": "18.0.0",
-    "react-dom": "18.0.0",
+    "preact": "10.8.1",
+    "prettier": "2.7.1",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
     "rimraf": "3.0.2",
-    "rollup": "2.70.2",
+    "rollup": "2.75.6",
     "rollup-plugin-terser": "7.0.2",
     "size-limit": "7.0.8",
-    "typescript": "4.6.3"
+    "typescript": "4.7.4"
   },
   "peerDependencies": {
     "react": "0.14 || 15 || 16 || 17 || 18"