diff --git a/README.md b/README.md index 84823cad4..3fcdb5576 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - [![platforms](https://img.shields.io/badge/platforms-Android%20%7C%20iOS-brightgreen.svg?colorB=191A17)](#) [![npm](https://img.shields.io/npm/v/react-native-render-html/latest)](https://www.npmjs.com/package/react-native-render-html) [![](https://img.shields.io/npm/v/react-native-render-html/next)](#) @@ -68,8 +67,8 @@ An iOS/Android pure javascript react-native component that renders your HTML int ### Stable releases -| Minor | Branch | Documentation | Test Status | Latest | -| ----- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| Minor | Branch | Documentation | Test Status | Latest | +| ----- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | 4.2   |  [release/4.2](https://github.com/archriss/react-native-render-html/tree/release/4.2)   | [release/4.2/README.md](https://github.com/archriss/react-native-render-html/blob/release/4.2/README.md) | ![CI](https://github.com/archriss/react-native-render-html/workflows/CI/badge.svg?branch=release%2F4.2) | [![npm](https://img.shields.io/npm/v/react-native-render-html/release/4.2)](#) | | 4.1   |  [release/4.1](https://github.com/archriss/react-native-render-html/tree/release/4.1)   | [release/4.1/README.md](https://github.com/archriss/react-native-render-html/blob/release/4.1/README.md) | ![CI](https://github.com/archriss/react-native-render-html/workflows/CI/badge.svg?branch=release%2F4.1) | [![npm](https://img.shields.io/npm/v/react-native-render-html/release/4.1)](#) | | 4.0   |  [release/4.0](https://github.com/archriss/react-native-render-html/tree/release/4.0)   | [release/4.0/README.md](https://github.com/archriss/react-native-render-html/blob/release/4.0/README.md) | ![CI](https://github.com/archriss/react-native-render-html/workflows/CI/badge.svg?branch=release%2F4.0) | [![npm](https://img.shields.io/npm/v/react-native-render-html/release/4.0)](#) | @@ -106,7 +105,7 @@ npm install react-native-render-html ```javascript import React, { Component } from "react"; -import { ScrollView, Dimensions } from "react-native"; +import { ScrollView, useWindowDimensions } from "react-native"; import HTML from "react-native-render-html"; const htmlContent = ` @@ -116,54 +115,52 @@ const htmlContent = ` Look at how happy this native cat is `; -export default class Demo extends Component { - render() { - return ( - - - - ); - } +export default function Demo() { + const contentWidth = useWindowDimensions().width; + return ( + + + + ); } ``` ## Props -| Prop | Description | Type | Required/Default | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | ------------------------------------------------------------ | -| `renderers` | Your [custom renderers](#creating-custom-renderers) | `object` | Optional, some default ones are supplied (``, ``...) | -| `renderersProps` | Set of props accessible into your [custom renderers](#creating-custom-renderers) in `passProps` (4th argument) | `object` | Optional | -| `html` | HTML string to parse and render | `string` | Required | -| `uri` | _(experimental)_ remote website to parse and render | `string` | Optional | -| `decodeEntities` | Decode HTML entities of your content | `bool` | Optional, defaults to `true` | -| `imagesMaxWidth` | Resize your images to this maximum width, see [images](#images) | `number` | Optional | -| `staticContentMaxWidth` | Set a maximum width to non-responsive content (`