JSPM

react-render-props-script-loader

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 398
  • Score
    100M100P100Q95304F
  • License MIT

an easier to use dynamic script loader

Package Exports

  • react-render-props-script-loader

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-render-props-script-loader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-render-props-script-loader

Build Status Coverage Status semantic-release Commitizen friendly

an easier to use dynamic script loader with a render prop

Version notes

  • supports React 15 or 16
  • if building for legacy browsers with a bundler like Webpack that supports the module field of package.json, you will probably need to add a rule to transpile this package.

Installation

npm install --save react-render-props-script-loader

Example

import * as React from 'react'
import ScriptLoader from 'react-render-props-script-loader'

import MapView from './MapView'

export const MapViewContainer = props => (
  <ScriptLoader
    type="text/javascript"
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&libraries=places"
    onLoad={() => console.log('loaded google maps!')}
    onError={error => console.error('failed to load google maps:', error.stack)}
  >
    {({loading, error}) => {
      if (loading) return <h3>Loading Google Maps API...</h3>
      if (error) return <h3>Failed to load Google Maps API: {error.message}</h3>
      return <MapView {...props} />
    }}
  </ScriptLoader>
)

API

The package exports a single component with the following props:

src (required string)

The script source.

onLoad (?() => any)

A callback that ScriptLoader will call once the script has been loaded

onError (?(error: Error) => any)

A callback that ScriptLoader will call if there was an error loading the script

children (?(state: State) => ?React.Node)

The render function. It will be passed the following props, and may return the content to display:

  • loading (boolean) - true iff the script is loading
  • loaded (boolean) - true iff the script successfully loaded
  • error (?Error) - the Error that occurred if the script failed to load