A component which renders HTML content as native views
react html react-native react-component react-native-component mobile ui


Project Name react-native-htmlview Project Url
InceptionYear 2015-04-01 03:21:01 更新时间 2019-08-12 08:09:45
IssueManagement Licenses ISC
仓库地址 git:// 用户数 5
Node Engine 文件大小 114.2 KB
install test lint format release jest


# React Native HTMLView [![Build status](]( A component which takes HTML content and renders it as native views, with customisable style and handling of links, etc. In action (from [ReactNativeHackerNews]( ![React Native Hacker News Comments]( ## 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]( - `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**]( 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 = `

♥ nice job!

`; 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 ``; return ( ); } } const htmlContent = `