feat: support htmlParserOptions prop

BREAKING CHANGE: `decodeEntities` prop has been dropped. Pass this option to `htmlParserOptions` prop instead.
meliorence · Jun 4, 2021 · 624c57e · 624c57e
1 parent 6c9d70f
commit 624c57e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 7 deletions.
diff --git a/packages/render-html/src/RenderHTML.tsx b/packages/render-html/src/RenderHTML.tsx
@@ -27,7 +27,7 @@ const propTypes: RenderHTMLPropTypes = {
   ignoredTags: PropTypes.array.isRequired,
   ignoredStyles: PropTypes.array.isRequired,
   allowedStyles: PropTypes.array,
-  decodeEntities: PropTypes.bool.isRequired,
+  htmlParserOptions: PropTypes.object,
   debug: PropTypes.bool.isRequired,
   listsPrefixesRenderers: PropTypes.object,
   alterData: PropTypes.func,
@@ -70,7 +70,9 @@ const defaultProps: {
   [k in keyof RenderHTMLProps]?: RenderHTMLProps[k];
 } = {
   ...defaultSharedPropsContext,
-  decodeEntities: true,
+  htmlParserOptions: {
+    decodeEntities: true
+  },
   emSize: 14,
   ptSize: 1.3,
   ignoredTags: [],

diff --git a/packages/render-html/src/hooks/useTRenderEngine.ts b/packages/render-html/src/hooks/useTRenderEngine.ts
@@ -13,7 +13,7 @@ export default function useTRenderEngine(props: RenderHTMLProps) {
   const {
     allowedStyles,
     ignoredStyles,
-    decodeEntities,
+    htmlParserOptions,
     baseStyle,
     classesStyles,
     tagsStyles,
@@ -102,7 +102,8 @@ export default function useTRenderEngine(props: RenderHTMLProps) {
           inlinePropertiesWhitelist: allowedStyles
         },
         htmlParserOptions: {
-          decodeEntities
+          decodeEntities: true,
+          ...htmlParserOptions
         },
         stylesConfig: {
           baseStyle,

diff --git a/packages/render-html/src/shared-types.ts b/packages/render-html/src/shared-types.ts
@@ -24,6 +24,7 @@ import {
 } from '@native-html/css-processor';
 import type { TStyles } from '@native-html/transient-render-engine';
 import { CustomTagRendererRecord } from './render/render-types';
+import { ParserOptions as HtmlParserOptions } from 'htmlparser2';
 
 export interface RendererDictionary<P> {}
 
@@ -104,10 +105,11 @@ export interface RenderHTMLPassedProps<P = any> {
 
 export interface TransientRenderEngineConfig {
   /**
-   * Decode HTML entities of your content.
-   * Optional, defaults to true
+   * ParserOptions for [htmlparser2](https://github.com/fb55/htmlparser2/wiki/Parser-options)
+   *
+   * @defaultvalue  `{ decodeEntities: true }`
    */
-  decodeEntities?: boolean;
+  htmlParserOptions?: HtmlParserOptions;
   /**
    * Enable or disable fallback styles for each tag. For example, `pre` tags
    * will have `whiteSpace` set to 'pre' by default.