Skip to content

Commit

Permalink
docs(iframe): add generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jsamr committed Apr 17, 2021
1 parent 5db6719 commit 18fd44c
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Html attributes for this iframe node.
<b>Signature:</b>

```typescript
htmlAttribs: HtmlAttributesDictionary;
htmlAttribs: Record<string, string>;
```
4 changes: 2 additions & 2 deletions packages/iframe-plugin/docs/iframe-plugin.htmliframeprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ export interface HTMLIframeProps<WebViewProps = any> extends IframeConfig
| Property | Type | Description |
| --- | --- | --- |
| [htmlAttribs](./iframe-plugin.htmliframeprops.htmlattribs.md) | HtmlAttributesDictionary | Html attributes for this iframe node. |
| [onLinkPress?](./iframe-plugin.htmliframeprops.onlinkpress.md) | RenderHTMLProps\['onLinkPress'\] | <i>(Optional)</i> Handle link press events. |
| [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. |
| [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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Handle link press events.
<b>Signature:</b>

```typescript
onLinkPress?: RenderHTMLProps['onLinkPress'];
onLinkPress?: RenderersPropsBase['a']['onPress'];
```
7 changes: 3 additions & 4 deletions packages/iframe-plugin/etc/iframe-plugin.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@
import { ComponentType } from 'react';
import { CustomBlockRenderer } from 'react-native-render-html';
import { CustomTagRendererProps } from 'react-native-render-html';
import { HtmlAttributesDictionary } 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 { RenderHTMLProps } from 'react-native-render-html';
import { RenderersPropsBase } from 'react-native-render-html';
import { StyleProp } from 'react-native';
import type { TBlock } from '@native-html/transient-render-engine';
import { ViewStyle } from 'react-native';
Expand All @@ -21,8 +20,8 @@ export function HTMLIframe({ WebView, webViewProps: userWebViewProps, source, st

// @public
export interface HTMLIframeProps<WebViewProps = any> extends IframeConfig {
htmlAttribs: HtmlAttributesDictionary;
onLinkPress?: RenderHTMLProps['onLinkPress'];
htmlAttribs: Record<string, string>;
onLinkPress?: RenderersPropsBase['a']['onPress'];
scaleFactor: number;
source: {
uri?: string;
Expand Down

0 comments on commit 18fd44c

Please sign in to comment.