feat(iframe): support react-native-render-html@6.0.0-beta.0

native-html · Jun 8, 2021 · 96c33b5 · 96c33b5
1 parent 3fa6d07
commit 96c33b5
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 15 deletions.
diff --git a/packages/iframe-plugin/docs/iframe-plugin.htmliframeprops.md b/packages/iframe-plugin/docs/iframe-plugin.htmliframeprops.md
@@ -18,7 +18,7 @@ export interface HTMLIframeProps<WebViewProps = any> extends IframeConfig
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [htmlAttribs](./iframe-plugin.htmliframeprops.htmlattribs.md) | Record&lt;string, string&gt; | Html attributes for this iframe node. |
-|  [onLinkPress?](./iframe-plugin.htmliframeprops.onlinkpress.md) | RenderersPropsBase\['a'\]\['onPress'\] | <i>(Optional)</i> Handle link press events. |
+|  [onLinkPress?](./iframe-plugin.htmliframeprops.onlinkpress.md) | RenderersProps\['a'\]\['onPress'\] | <i>(Optional)</i> Handle link press events. |
 |  [scaleFactor](./iframe-plugin.htmliframeprops.scalefactor.md) | number | When scalesPageToFit is enabled, scales the WebView zoom level to make sure the viewport fits contentWidth. |
 |  [source](./iframe-plugin.htmliframeprops.source.md) | { uri?: string; html?: string; } | The source for the iframe. |
 |  [style](./iframe-plugin.htmliframeprops.style.md) | StyleProp&lt;ViewStyle&gt; | Container style. |

diff --git a/packages/iframe-plugin/docs/iframe-plugin.htmliframeprops.onlinkpress.md b/packages/iframe-plugin/docs/iframe-plugin.htmliframeprops.onlinkpress.md
@@ -9,5 +9,5 @@ Handle link press events.
 <b>Signature:</b>
 
 ```typescript
-onLinkPress?: RenderersPropsBase['a']['onPress'];
+onLinkPress?: RenderersProps['a']['onPress'];
 ```
diff --git a/packages/iframe-plugin/docs/iframe-plugin.usehtmliframeprops.md b/packages/iframe-plugin/docs/iframe-plugin.usehtmliframeprops.md
@@ -9,17 +9,19 @@ Extract props for the HTMLIframe component from renderer function arguments. Thi
 <b>Signature:</b>
 
 ```typescript
-export default function useHtmlIframeProps({ key, style, tnode }: CustomTagRendererProps<TBlock>, iframeConfig?: IframeConfig): HTMLIframeProps | null;
+export default function useHtmlIframeProps({ key, style, tnode }: CustomRendererProps<TBlock>, iframeConfig?: IframeConfig): (HTMLIframeProps & {
+    key?: any;
+}) | null;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { key, style, tnode } | CustomTagRendererProps&lt;TBlock&gt; |  |
+|  { key, style, tnode } | CustomRendererProps&lt;TBlock&gt; |  |
 |  iframeConfig | [IframeConfig](./iframe-plugin.iframeconfig.md) | Override config options. |
 
 <b>Returns:</b>
 
-[HTMLIframeProps](./iframe-plugin.htmliframeprops.md) \| null
+([HTMLIframeProps](./iframe-plugin.htmliframeprops.md) &amp; { key?: any; }) \| null
 
diff --git a/packages/iframe-plugin/etc/iframe-plugin.api.md b/packages/iframe-plugin/etc/iframe-plugin.api.md
@@ -6,11 +6,11 @@
 
 import { ComponentType } from 'react';
 import { CustomBlockRenderer } from 'react-native-render-html';
-import { CustomTagRendererProps } from 'react-native-render-html';
+import { CustomRendererProps } from 'react-native-render-html';
 import { HTMLContentModel } from 'react-native-render-html';
 import { HTMLElementModel } from '@native-html/transient-render-engine';
 import { default as React_2 } from 'react';
-import { RenderersPropsBase } from 'react-native-render-html';
+import { RenderersProps } from 'react-native-render-html';
 import { StyleProp } from 'react-native';
 import type { TBlock } from '@native-html/transient-render-engine';
 import { ViewStyle } from 'react-native';
@@ -21,7 +21,7 @@ export function HTMLIframe({ WebView, webViewProps: userWebViewProps, source, st
 // @public
 export interface HTMLIframeProps<WebViewProps = any> extends IframeConfig {
     htmlAttribs: Record<string, string>;
-    onLinkPress?: RenderersPropsBase['a']['onPress'];
+    onLinkPress?: RenderersProps['a']['onPress'];
     scaleFactor: number;
     source: {
         uri?: string;
@@ -49,7 +49,9 @@ const IframeRenderer: CustomBlockRenderer;
 export default IframeRenderer;
 
 // @public
-export function useHtmlIframeProps({ key, style, tnode }: CustomTagRendererProps<TBlock>, iframeConfig?: IframeConfig): HTMLIframeProps | null;
+export function useHtmlIframeProps({ key, style, tnode }: CustomRendererProps<TBlock>, iframeConfig?: IframeConfig): (HTMLIframeProps & {
+    key?: any;
+}) | null;
 
 
 // (No @packageDocumentation comment for this package)

diff --git a/packages/iframe-plugin/package.json b/packages/iframe-plugin/package.json
@@ -69,7 +69,7 @@
   "peerDependencies": {
     "react": ">= 16.8.0",
     "react-native": ">= 0.59.0",
-    "react-native-render-html": ">= 6.0.0-alpha.25 || >= 6.0.0-beta.0 || 6.x"
+    "react-native-render-html": ">= 6.0.0-beta.0 || 6.x"
   },
   "author": "Jules Sam. Randolph <jules.sam.randolph@gmail.com> (https://github.com/jsamr)",
   "homepage": "https://github.com/native-html/plugins/tree/master/packages/iframe-plugin#readme",

diff --git a/packages/iframe-plugin/src/HTMLIframe.tsx b/packages/iframe-plugin/src/HTMLIframe.tsx
@@ -7,7 +7,7 @@ import {
   useWebshell
 } from '@formidable-webview/webshell';
 import { StyleProp, ViewStyle } from 'react-native';
-import { RenderersPropsBase } from 'react-native-render-html';
+import { RenderersProps } from 'react-native-render-html';
 import { linkPressTargetToOnDOMLinkPressArgs } from '@native-html/plugins-core';
 
 /**
@@ -78,7 +78,7 @@ export interface HTMLIframeProps<WebViewProps = any> extends IframeConfig {
   /**
    * Handle link press events.
    */
-  onLinkPress?: RenderersPropsBase['a']['onPress'];
+  onLinkPress?: RenderersProps['a']['onPress'];
 
   /**
    * Html attributes for this iframe node.

diff --git a/packages/iframe-plugin/src/index.ts b/packages/iframe-plugin/src/index.ts
@@ -1,4 +1,14 @@
+import { IframeConfig } from './HTMLIframe';
 export { default, iframeModel } from './IframeRenderer';
 export { default as useHtmlIframeProps } from './useHtmlIframeProps';
 export { default as HTMLIframe } from './HTMLIframe';
 export type { HTMLIframeProps, IframeConfig } from './HTMLIframe';
+
+declare module 'react-native-render-html' {
+  interface RenderersProps {
+    /**
+     * Configuration for `@native-html/iframe-plugin` iframe renderer.
+     */
+    iframe?: IframeConfig;
+  }
+}
diff --git a/packages/iframe-plugin/src/useHtmlIframeProps.ts b/packages/iframe-plugin/src/useHtmlIframeProps.ts
@@ -1,6 +1,6 @@
 import { Dimensions } from 'react-native';
 import {
-  CustomTagRendererProps,
+  CustomRendererProps,
   useDocumentMetadata,
   useSharedProps,
   useNormalizedUrl,
@@ -29,9 +29,9 @@ const defaultIframeConfig: IframeConfig = {
  * @public
  */
 export default function useHtmlIframeProps(
-  { key, style, tnode }: CustomTagRendererProps<TBlock>,
+  { key, style, tnode }: CustomRendererProps<TBlock>,
   iframeConfig?: IframeConfig
-): HTMLIframeProps | null {
+): (HTMLIframeProps & { key?: any }) | null {
   const {
     WebView,
     defaultWebViewProps,