An auto height webview for React Native
Switch branches/tags
Nothing to show
Clone or download
Latest commit 84c4ef9 Oct 8, 2018

README.md

react-native-autoheight-webview

An auto height webview for React Native, or even auto width for inline html.

Cause of changes to lifecycle methods in React 16.3.0 (https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html), please install react-native-autoheight-webview 0.6.1 for the project with 0.47 <= rn < 0.55

Cause of removing unused createJSModules calls in React Naitve 0.47 (https://github.com/facebook/react-native/releases/tag/v0.47.2), please install react-native-autoheight-webview 0.3.1 for the project with 0.44 <= rn < 0.47.

Cause of moving View.propTypes to ViewPropTypes in React Naitve 0.44 (https://github.com/facebook/react-native/releases/tag/v0.44.3) and PropTypes has been moved to a separate package in React 16 (https://facebook.github.io/react/blog/2017/04/07/react-v15.5.0.html#migrating-from-react.proptypes), please install react-native-autoheight-webview 0.2.3 for the project with rn < 0.44.

npm install react-native-autoheight-webview --save (rn >= 0.56)

npm install react-native-autoheight-webview@0.6.1 --save (0.47 <= rn < 0.56)

npm install react-native-autoheight-webview@0.3.1 --save (0.44 <= rn < 0.47)

npm install react-native-autoheight-webview@0.2.3 --save (rn < 0.44)

Android

react-native link react-native-autoheight-webview

import AutoHeightWebView from 'react-native-autoheight-webview';

iOS

import AutoHeightWebView from 'react-native-autoheight-webview';

showcase

react-native-autoheight-webview iOS  react-native-autoheight-webview Android

usage

<AutoHeightWebView
    onMessage={e => console.log(e)},
    // either height or width updated will trigger this
    onSizeUpdated={({size => console.log(size.height)})},
    // set scrollEnabled to true may cause some layout issues
    scrollEnabled={true},
    // if page contains iframe on iOS, use a specific script for it
    hasIframe={true}
    /*
    if set to false may cause some layout issues (width of container not fit for screen) on Android
    if set to true may cause some layout issues (smaller font size) on iOS
    */
    scalesPageToFit={Platform.OS === 'Android' ? true : false}
    // offset of rn webview margin 
    heightOffset={5}
    // default width is the width of screen
    // if there are some text selection issues on iOS, the width should be reduced more than 15 and the marginTop should be added more than 35
    style={{ width: Dimensions.get('window').width - 15, marginTop: 35 }}
    // enable animation by default
    enableAnimation={true},
    // only works on enable animation
    animationDuration={255},
    // only on Android for animating size
    animationEasing={Easing.ease()},
    // or uri
    source={{ html: `<p style="font-weight: 400;font-style: normal;font-size: 21px;line-height: 1.58;letter-spacing: -.003em;">Tags are great for describing the essence of your story in a single word or phrase, but stories are rarely about a single thing. <span style="background-color: transparent !important;background-image: linear-gradient(to bottom, rgba(146, 249, 190, 1), rgba(146, 249, 190, 1));">If I pen a story about moving across the country to start a new job in a car with my husband, two cats, a dog, and a tarantula, I wouldn’t only tag the piece with “moving”. I’d also use the tags “pets”, “marriage”, “career change”, and “travel tips”.</span></p>` }}
    // 'web/' by default on iOS, and 'file:///android_asset/web/' on Android, and baseUrl not work in android 4.3 or below version
    baseUrl: 'webAssets/',
    // add baseUrl/files... to project root
    /* 
    use local or remote files
    local files only works on enable baseUrl on Android,
    to add local file on Android: rnproject/android/app/src/main/assets/web/,
    to add local file on iOS: open iOS project with Xcode, 
    add new group named web (with folder) under your project folder, then drag your files into this folder
    */
    files={[{
        href: 'cssfileaddress',
        type: 'text/css',
        rel: 'stylesheet'
    }]}
    customScript={`document.body.style.background = 'lightyellow';`}
    // rn WebView callbacks
    onError={() => console.log('on error')}
    onLoad={() => console.log('on load')}
    onLoadStart={() => console.log('on load start')}
    onLoadEnd={() => console.log('on load end')}
    onNavigationStateChange={() => console.log('navigation state changed')}
    // only on iOS
    onShouldStartLoadWithRequest={result => {
      console.log(result)
      return true;
    }}
    // add custom CSS to the page's <head>
    customStyle={`
      * {
        font-family: 'Times New Roman';
      }
      p {
        font-size: 16px;
      }
    `}
  />

demo

You may have to copy autoHeightWebView, android, node_modules folders to 'demo/node_modules/react-native-autoheight-webview/', cause of installing a local package with npm will create symlink, but there is no supporting of React Native to symlink (https://github.com/facebook/watchman/issues/105).