Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsdf/react-native-htmlview
A React Native component which renders HTML content as native views
https://github.com/jsdf/react-native-htmlview
html html-parser html-renderer react react-component react-native
Last synced: 3 days ago
JSON representation
A React Native component which renders HTML content as native views
- Host: GitHub
- URL: https://github.com/jsdf/react-native-htmlview
- Owner: jsdf
- License: isc
- Created: 2015-04-01T03:20:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T10:36:24.000Z (6 months ago)
- Last Synced: 2024-12-09T14:13:37.392Z (3 days ago)
- Topics: html, html-parser, html-renderer, react, react-component, react-native
- Language: JavaScript
- Size: 816 KB
- Stars: 2,722
- Watchers: 46
- Forks: 466
- Open Issues: 144
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native - react-native-htmlview - A React Native component which renders HTML content as native views.  (Components / Parsing)
README
# React Native HTMLView [](https://travis-ci.org/jsdf/react-native-htmlview)
A component which takes HTML content and renders it as native views, with
customisable style and handling of links, etc.
In action (from [ReactNativeHackerNews](https://github.com/jsdf/ReactNativeHackerNews)):
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [Example](#example)
- [Changelog](#changelog)
### Install
```
npm install react-native-htmlview --save
```
### Usage
props:
- `value`: a string of HTML content to render
- `onLinkPress`: a function which will be called with a url when a link is pressed.
Passing this prop will override how links are handled (defaults to calling `Linking.openURL(url)`)
- `onLinkLongPress`: a function which will be called with a url when a link is long pressed.
The default is `null`.
- `stylesheet`: a stylesheet object keyed by tag name, which will override the
styles applied to those respective tags.
- `renderNode`: a custom function to render HTML nodes however you see fit. If
the function returns `undefined` (not `null`), the default renderer will be
used for that node. The function takes the following arguments:
- `node` the html node as parsed by [htmlparser2](https://github.com/fb55/htmlparser2)
- `index` position of the node in parent node's children
- `siblings` parent node's children (including current node)
- `parent` parent node
- `defaultRenderer` the default rendering implementation, so you can use the normal rendering logic for some subtree. `defaultRenderer` takes the following arguments:
- `node` the node to render with the default rendering logic
- `parent` the parent of node of `node`
- `bullet`: text which is rendered before every `li` inside a `ul`
- `paragraphBreak`: text which appears after every `p` element
- `lineBreak`: text which appears after text elements which create a new line (`br`, headings)
- `addLineBreaks`: when explicitly `false`, effectively sets `paragraphBreak` and `lineBreak` to `null`
- `NodeComponent`, `nodeComponentProps`, `RootComponent`, `rootComponentProps`, `TextComponent`, `textComponentProps`: see [**Customizing things even further**](https://github.com/jsdf/react-native-htmlview#customizing-things-even-further) below.
### Example
```js
import React from 'react';
import {StyleSheet} from 'react-native';
import HTMLView from 'react-native-htmlview';
class App extends React.Component {
render() {
const htmlContent = `
`;
return (
);
}
}
const styles = StyleSheet.create({
a: {
fontWeight: '300',
color: '#FF3366', // make links coloured pink
},
});
```
### Custom Link Handling
When a link is clicked, by default `ReactNative.Linking.openURL` is called with the
link url. You can customise what happens when a link is clicked with `onLinkPress`:
```js
class App extends React.Component {
render() {
return (
console.log('clicked link: ', url)}
/>
);
}
}
```
If you're getting the error "undefined is not an object (evaluating 'RCTLinkingManager.openURL’)” from the LinkingIOS API, try adding ‘RCTLinking' to the project's 'Linked Frameworks and Libraries’. You might have to find RCTLinking.xcodeproj in the react-native package dir and drag that into your main Xcode project first.
### Custom Element Rendering
You can implement the `renderNode` prop to add support for unsupported element
types, or override the rendering for supported types. `renderNode` is a function which is called with the type and attributes of each HTML element found in the input HTML, and from this function you can return a React element to be rendered in its place. If you return `null` nothing will be rendered in place of this element or its children. If you return `undefined` (or don't return anything) then HTMLView will drop back to its default rendering for that type of HTML element.
For example, here is how you might implement the `` element:
```js
function renderNode(node, index, siblings, parent, defaultRenderer) {
if (node.name == 'iframe') {
const a = node.attribs;
const iframeHtml = ``;
return (
);
}
}
const htmlContent = `
`;
class App extends React.Component {
render() {
return (
);
}
}
```
Alternatively, this example shows how you could disallow the `` element:
```js
function renderNode(node, index, siblings, parent, defaultRenderer) {
if (node.name == 'iframe') {
return null;
}
}
const htmlContent = `
`;
class App extends React.Component {
render() {
return (
);
}
}
```
If you want to reuse the default renderer, you need to call it passing an array of nodes. This example shows how to replace a specific HTML tag with something different, but still process the children.
```js
function renderNode(node, index, siblings, parent, defaultRenderer) {
if (node.name == 'mytag') {
const specialSyle = node.attribs.style
return (
{defaultRenderer(node.children, parent)}
)
}
}
const htmlContent = `
some content processed normally by the engine
`;
class App extends React.Component {
render() {
return (
);
}
}
```
For further understanding of the possiblities of the `renderNode` prop, read through [htmlToElement.js](https://github.com/jsdf/react-native-htmlview/blob/master/htmlToElement.js). Particularly look at where `renderNode` is called to see how it can override what sort of React element is created in place of an element in the input HTML.
### Customizing things even further
In addition to supplying a custom `renderNode` function, you can customize what is rendered by the built in `renderNode` function. Read through [htmlToElement.js](https://github.com/jsdf/react-native-htmlview/blob/master/htmlToElement.js) and note the usage of NodeComponent (for rendering HTML element nodes) and TextComponent (for rendering text strings in the HTML). Both of these components can be injected as the `NodeComponent` and `TextComponent` props to HTMLView, or alternatively they can be given extra props by passing an object as the `nodeComponentProps` and `textComponentProps` props. Finally you can also use the props `RootComponent` and `rootComponentProps` to customize the root wrapper `View` element that is rendered by the HTMLView in [HTMLView.js](https://github.com/jsdf/react-native-htmlview/blob/master/HTMLView.js).
### Changelog
See [CHANGELOG.md](CHANGELOG.md).