Skip to content

Latest commit

 

History

History
112 lines (82 loc) · 4.28 KB

README.md

File metadata and controls

112 lines (82 loc) · 4.28 KB
Raw

react-native-js-injector

React Native WebView with "super powers". This package is basically a WebView with some extra perks included.

  1. Possibility to inject JS scripts easily.
  2. Browser cookies enabled by default.
  3. DOM Storage Enabled
  4. Auto Height WebView options, in order to use WebViews inside components like ScrollView
  5. scrollEnabled set to default false

Caution! This package can only be used with row HTML content. If a uri is passed as the source prop this component will return an empty <View/>.

!Here is also a Test CASE

Install

npm install react-native-js-injector --save

yarn add react-native-js-injector

This library is depended of the latest updates of the WebView component. At the current time of this release, the react team suggests using the RN community backed WebView as they are removing WebView from the react core.

Install the following WebView

yarn add react-native-webview

react-native link react-native-webview

If there are any issues check out their Getting-Started guide.

Usage

import {WebViewInjector, INJECTOR_TYPE} from 'react-native-js-injector'
const htmlTemplate = `<p>Hello!</p`
//example script
const script = `<script>document.body.appendChild(document.createElement("hr"));</script>`
export default class App extends Component {
  render() {
    return (<View style={styles.container}>
          <WebViewInjector
            injectScript={script}
            scrollEnabled={false}
            // style={{backgroundColor: 'red'}}
            showsVerticalScrollIndicator={false}
            showsHorizontalScrollIndicator={false}
            type={INJECTOR_TYPE.AUTO_HEIGHT}
            source={{html: htmlTemplate}}
          />
      </View>
    )
  }
}

Props

The props are build to follow the same guidelines as the standard props that WebView accepts.

  • source (Object) - JS object containing the raw HTML code. Example: {html: <div></div>}
  • type (String) - A flag specifying if the component should use the auto-height perks or not. INJECTOR_TYPE.DEFAULT || INJECTOR_TYPE.AUTO_HEIGHT. Not required!
  • injectScript (String) - String containing the script that will be executed on the WebView. Read the guideline scripts bellow.
  • defaultHeight (Number) - In case of using INJECTOR_TYPE.AUTO_HEIGHT, use this property to set a default height to the WebView content.
  • maxHeight (Number) - In case of using INJECTOR_TYPE.AUTO_HEIGHT, use this property to set the MAX height the WebView can reach.
  • minHeight (Number) - In case of using INJECTOR_TYPE.AUTO_HEIGHT, use this property to set the MIN height the WebView can have.
  • ***** (PROPS) - The component is build to accept any of the default props that are supported by the standard WebView.

scripts guidelines

In order to execute scripts make sure they are **IIFE** (Immediately Invoked Function Expression). Make sure the injectScript props is passed as String. You can use one of the following examples to pass as the value of injectScript prop.

const script1 = (function () {
                    //statements...
                })();
// usage
injectScript={script1.toString()}



const script2 = `<script>(console.log('worthless script');)()</script>`
// usage
injectScript={script2}

Debugging

In order to remotely debug WebView issues read the following steps. Debugging Info

License


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.