@nanogiants/react-native-render-html 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,263 @@
+# @nanogiants/react-native-render-html
+
+A lightweight, customisable HTML renderer for React Native.
+
+Parses an HTML string and maps each recognised element to the appropriate React Native primitive — no native modules, no WebView. Images and text components are injected via render props, keeping the package free of any hard image-library dependency.
+
+---
+
+## Installation
+
+```sh
+npm install @nanogiants/react-native-render-html
+# or
+yarn add @nanogiants/react-native-render-html
+# or
+pnpm add @nanogiants/react-native-render-html
+```
+
+`react` and `react-native` are peer dependencies and must already be present in your project.
+
+---
+
+## Quick start
+
+```tsx
+import { RenderHTML } from '@nanogiants/react-native-render-html';
+import { Image } from 'react-native';
+
+const html = `
+  <h1>Hello world</h1>
+  <p>This is a <strong>bold</strong> statement.</p>
+  <img src="https://picsum.photos/400/200" />
+`;
+
+export default function Screen() {
+  return (
+    <RenderHTML
+      html={html}
+      renderImage={(props) => <Image {...props} />}
+      baseStyle={{ fontSize: 16, lineHeight: 24, color: '#111' }}
+      onLinkPress={({ url }) => Linking.openURL(url)}
+    />
+  );
+}
+```
+
+---
+
+## Props
+
+### `html` (required)
+
+```ts
+html: string
+```
+
+The HTML string to parse and render.
+
+---
+
+### `renderImage`
+
+```ts
+renderImage?: (props: ImageProps) => ReactNode
+```
+
+Render prop invoked for every image in the output: `<img>` tags, unordered-list bullet markers, and external-link icons. Receives standard React Native `ImageProps` (`source`, `style`, `alt`, …).
+
+When omitted the built-in React Native `<Image>` component is used.
+
+```tsx
+// Using expo-image for better caching
+import { Image } from 'expo-image';
+
+<RenderHTML
+  html={html}
+  renderImage={(props) => <Image {...props} contentFit="contain" />}
+/>
+```
+
+---
+
+### `renderTextComponent`
+
+```ts
+renderTextComponent?: (props: TextProps) => ReactNode
+```
+
+Render prop invoked for every text node. Receives standard React Native `TextProps`. Use this to swap in a custom typography component.
+
+```tsx
+<RenderHTML
+  html={html}
+  renderTextComponent={(props) => <MyAppText {...props} />}
+/>
+```
+
+---
+
+### `TextComponent`
+
+```ts
+TextComponent?: ComponentType<TextProps & { children?: ReactNode }>
+```
+
+A drop-in component replacement for React Native `Text`. Applied globally to all text nodes. `renderTextComponent` takes priority when both are supplied.
+
+---
+
+### `baseStyle`
+
+```ts
+baseStyle?: TextStyle
+```
+
+Base text style applied to all elements before per-tag overrides. Commonly used to set a global font family, size, line height, or colour.
+
+---
+
+### `tagStyles`
+
+```ts
+tagStyles?: Partial<TagStyles>
+```
+
+Per-tag style overrides. Each key is an HTML tag name; the value is `{ text?: TextStyle; block?: ViewStyle }`.
+
+```tsx
+<RenderHTML
+  html={html}
+  tagStyles={{
+    h1: { text: { color: 'navy' } },
+    blockquote: { block: { borderLeftColor: '#6366f1' } },
+    code: { text: { fontFamily: 'JetBrainsMono' } },
+    section: { block: { marginVertical: 16 } },
+  }}
+/>
+```
+
+---
+
+### `classesStyles`
+
+```ts
+classesStyles?: { [className: string]: { text?: TextStyle; block?: ViewStyle } }
+```
+
+Style overrides keyed by HTML `class` attribute value. Applied on top of the matching tag style.
+
+```tsx
+<RenderHTML
+  html='<p class="lead">Introduction paragraph</p>'
+  classesStyles={{
+    lead: { text: { fontSize: 20, fontWeight: '600' } },
+  }}
+/>
+```
+
+---
+
+### `listGap`
+
+```ts
+listGap?: number
+```
+
+Vertical gap between items in `<ul>` and `<ol>` lists. Maps to the flex `gap` property. Defaults to `0`.
+
+---
+
+### `onLinkPress`
+
+```ts
+onLinkPress?: (options: { url: string; title: string }) => void
+```
+
+Called when the user taps an `<a>` element.
+
+```tsx
+import { Linking } from 'react-native';
+
+<RenderHTML
+  html={html}
+  onLinkPress={({ url }) => Linking.openURL(url)}
+/>
+```
+
+---
+
+### `markerColor`
+
+```ts
+markerColor?: string
+```
+
+Colour of bullet markers in unordered lists. Falls back to the inherited text colour, then `'pink'`.
+
+---
+
+### `overrideExternalLinkTintColor`
+
+```ts
+overrideExternalLinkTintColor?: ColorValue
+```
+
+Tint colour applied to the small icon appended to external `<a href="https://…">` links.
+
+---
+
+## Supported HTML tags
+
+| Category | Tags |
+|---|---|
+| Headings | `h1` `h2` `h3` `h4` `h5` `h6` |
+| Sectioning | `main` `section` `article` `aside` `nav` `header` `footer` |
+| Text block | `p` `blockquote` `pre` `div` |
+| Inline | `a` `b` `strong` `i` `em` `u` `s` `del` `mark` `small` `sup` `sub` `span` `code` |
+| Lists | `ul` `ol` `li` `dl` `dt` `dd` |
+| Media | `img` |
+| Table | `table` `thead` `tbody` `tfoot` `tr` `th` `td` |
+| Other | `hr` `br` |
+
+Unknown tags (e.g. `script`, `style`, `iframe`) are silently ignored.
+
+---
+
+## Default styles
+
+The renderer ships with sensible defaults for all supported tags. Every default can be overridden via `tagStyles`.
+
+| Tag | Default |
+|---|---|
+| `h1` | 32px, line-height 38.4, top/bottom margin |
+| `h2` | 24px, line-height 28.8, top/bottom margin |
+| `h3` | 18.72px, matching margin |
+| `h4–h6` | Scaled down accordingly |
+| `p` | `marginTop: 8` / `marginBottom: 8` (collapsed at container edges) |
+| `a` | Underlined; external links display a tinted icon |
+| `blockquote` | Italic, 4px left border, grey background |
+| `pre` / `code` | Monospace font, grey background |
+| `ul` / `ol` | `paddingLeft: 12`, configurable gap |
+| `b` / `strong` | Bold |
+| `i` / `em` | Italic |
+| `u` | Underline |
+| `s` / `del` | Strikethrough |
+| `mark` | `backgroundColor: '#fff59d'` |
+| `small` | `max(baseSize − 2, 12)` |
+| `sup` / `sub` | `max(baseSize − 4, 10)`, aligned top/bottom |
+| `hr` | 1px bottom border, `marginVertical: 12` |
+| `img` | `flex: 1`, `height: 100`, `marginVertical: 8`; aspect ratio corrected after async `Image.getSize` |
+| `th` | Bold, `padding: 8`, 1px border |
+| `td` | `padding: 8` |
+| `section` / `article` | `marginVertical: 8` |
+| `header` | `marginBottom: 8` |
+| `footer` | `marginTop: 8` |
+| `main` / `aside` / `nav` | No default margin (semantic wrappers) |
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](./LICENSE) for details.
+

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+import { ReactNode, ComponentType, FunctionComponent } from 'react';
+import { TextStyle, ViewStyle, ImageProps, TextProps, ColorValue } from 'react-native';
+
+type HTMLTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'a' | 'ul' | 'ol' | 'li' | 'img' | 'table' | 'tr' | 'th' | 'td' | 'pre' | 'code' | 'blockquote' | 'hr' | 'br' | 'div' | 'b' | 'strong' | 'i' | 'em' | 'u' | 'mark' | 'small' | 's' | 'del' | 'sup' | 'sub' | 'span' | 'dt' | 'dd' | 'thead' | 'tbody' | 'tfoot' | 'dl' | 'main' | 'section' | 'article' | 'aside' | 'nav' | 'header' | 'footer';
+type HtmlStyle = {
+    text?: TextStyle;
+    block?: ViewStyle;
+};
+type TagStyles = {
+    [key in HTMLTag]: HtmlStyle;
+};
+interface CommonProps {
+    /**
+     * Render prop for all images rendered by the HTML renderer
+     * (<img> tags, bullet markers, and external link icons).
+     * Keeps the package free of any specific image library dependency.
+     *
+     * @example
+     * renderImage={(props) => <Image {...props} />}
+     */
+    renderImage?: (props: ImageProps) => ReactNode;
+    /**
+     * Custom component to use instead of the built-in React Native `Text`.
+     * Useful for applying a global font or integrating a design-system text component.
+     * Must accept the same props as `Text` (i.e. `TextProps`).
+     *
+     * @example
+     * TextComponent={MyAppText}
+     */
+    TextComponent?: ComponentType<TextProps & {
+        children?: ReactNode;
+    }>;
+    /**
+     * Render prop for all text nodes rendered by the HTML renderer.
+     * Receives the full `TextProps` (including `style`, `children`, accessibility props, etc.)
+     * and must return a renderable node. Takes priority over `TextComponent` when both are set.
+     *
+     * @example
+     * renderTextComponent={(props) => <MyText {...props} />}
+     */
+    renderTextComponent?: (props: TextProps) => ReactNode;
+    baseStyle?: TextStyle;
+    tagStyles?: Partial<TagStyles>;
+    classesStyles?: {
+        [className: string]: HtmlStyle;
+    };
+    listGap?: number;
+    onLinkPress?: (options: OnHTMLLinkPress) => void;
+    markerColor?: string;
+    overrideExternalLinkTintColor?: ColorValue;
+}
+
+interface OnHTMLLinkPress {
+    url: string;
+    title: string;
+}
+
+interface RenderHTMLProps extends CommonProps {
+    html: string;
+}
+declare const RenderHTML: FunctionComponent<RenderHTMLProps>;
+
+export { type HTMLTag, type HtmlStyle, type OnHTMLLinkPress, RenderHTML, type RenderHTMLProps, type TagStyles };

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { ReactNode, ComponentType, FunctionComponent } from 'react';
+import { TextStyle, ViewStyle, ImageProps, TextProps, ColorValue } from 'react-native';
+
+type HTMLTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'a' | 'ul' | 'ol' | 'li' | 'img' | 'table' | 'tr' | 'th' | 'td' | 'pre' | 'code' | 'blockquote' | 'hr' | 'br' | 'div' | 'b' | 'strong' | 'i' | 'em' | 'u' | 'mark' | 'small' | 's' | 'del' | 'sup' | 'sub' | 'span' | 'dt' | 'dd' | 'thead' | 'tbody' | 'tfoot' | 'dl' | 'main' | 'section' | 'article' | 'aside' | 'nav' | 'header' | 'footer';
+type HtmlStyle = {
+    text?: TextStyle;
+    block?: ViewStyle;
+};
+type TagStyles = {
+    [key in HTMLTag]: HtmlStyle;
+};
+interface CommonProps {
+    /**
+     * Render prop for all images rendered by the HTML renderer
+     * (<img> tags, bullet markers, and external link icons).
+     * Keeps the package free of any specific image library dependency.
+     *
+     * @example
+     * renderImage={(props) => <Image {...props} />}
+     */
+    renderImage?: (props: ImageProps) => ReactNode;
+    /**
+     * Custom component to use instead of the built-in React Native `Text`.
+     * Useful for applying a global font or integrating a design-system text component.
+     * Must accept the same props as `Text` (i.e. `TextProps`).
+     *
+     * @example
+     * TextComponent={MyAppText}
+     */
+    TextComponent?: ComponentType<TextProps & {
+        children?: ReactNode;
+    }>;
+    /**
+     * Render prop for all text nodes rendered by the HTML renderer.
+     * Receives the full `TextProps` (including `style`, `children`, accessibility props, etc.)
+     * and must return a renderable node. Takes priority over `TextComponent` when both are set.
+     *
+     * @example
+     * renderTextComponent={(props) => <MyText {...props} />}
+     */
+    renderTextComponent?: (props: TextProps) => ReactNode;
+    baseStyle?: TextStyle;
+    tagStyles?: Partial<TagStyles>;
+    classesStyles?: {
+        [className: string]: HtmlStyle;
+    };
+    listGap?: number;
+    onLinkPress?: (options: OnHTMLLinkPress) => void;
+    markerColor?: string;
+    overrideExternalLinkTintColor?: ColorValue;
+}
+
+interface OnHTMLLinkPress {
+    url: string;
+    title: string;
+}
+
+interface RenderHTMLProps extends CommonProps {
+    html: string;
+}
+declare const RenderHTML: FunctionComponent<RenderHTMLProps>;
+
+export { type HTMLTag, type HtmlStyle, type OnHTMLLinkPress, RenderHTML, type RenderHTMLProps, type TagStyles };