https://github.com/hupe1980/react-script-hook

React hook to dynamically load an external script and know when its loaded
https://github.com/hupe1980/react-script-hook

hook loader react script

Last synced: 3 months ago
JSON representation

React hook to dynamically load an external script and know when its loaded

• Host: GitHub
• URL: https://github.com/hupe1980/react-script-hook
• Owner: hupe1980
• License: mit
• Created: 2019-05-31T13:36:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-07T20:39:08.000Z (about 1 year ago)
• Last Synced: 2024-03-23T20:42:43.619Z (3 months ago)
• Topics: hook, loader, react, script
• Language: TypeScript
• Size: 871 KB
• Stars: 125
• Watchers: 4
• Forks: 20
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-react-hooks - `react-script-hook`
• awesome-react-hooks-cn - `react-script-hook`
• awesome-github-repos - hupe1980/react-script-hook - React hook to dynamically load an external script and know when its loaded (TypeScript)
• awesome-react-hooks - `react-script-hook`
• fucking-awesome-react-hooks - `react-script-hook`
• awesome-react-hooks - `react-script-hook`

README

        
# react-script-hook

> React hook to dynamically load an external script and know when its loaded

## Install

```sh

// with npm

npm install react-script-hook

// with yarn

yarn add react-script-hook

```

## How to use

```javascript

import React from 'react';

import { StripeProvider } from 'react-stripe-elements';

import useScript from 'react-script-hook';

import MyCheckout from './my-checkout';

function App() {

    const [loading, error] = useScript({ src: 'https://js.stripe.com/v3/' });

    if (loading) return 
Loading Stripe API...
;

    if (error) return 
Failed to load Stripe API: {error.message}
;


    return (

        

            

        

    );

}

export default App;

```

## Use with callbacks

```js

useScript({

    src: 'https://js.stripe.com/v3/',

    onload: () => console.log('Script loaded!'),

});

```

## Check for Existing

The hook automatically handles when the script was already loaded (or started

loading) from another instance of the hook. So you can safely add identical

`useScript` hooks to multiple components that depend on the same external

script, and they will properly block on the loading of only one copy.

If you're in an environment where the script may have already been loaded in

some other way (not from this hook), pass an `checkForExisting` flag of `true`.

In this case, the hook will ensure the script is placed on the page only once

by querying for script tags with the same `src`. Useful for SSR or SPAs with

client-side routing.

```js

const [loading, error] = useScript({

    src: 'https://js.stripe.com/v3/',

    checkForExisting: true,

});

```

## Conditionally calling a script

If you want to conditionally call a script you can do so by setting the src value to either the script or null. Note that the script is not removed if the src is set to null after it was previously set to a value causing the script to be appended.

```js

const [loading, error] = useScript({

    /** Only append stripeJS script when shouldLoadStripe is true */

    src: shouldLoadStripe ? 'https://js.stripe.com/v3/' : null,

});

```

## License

[MIT](LICENSE)