useScript

Hook that manages a script with onLoad, onError, and removeOnUnmount functionalities

browser

test coverage

Last changed: last month

Installation

Library

CLI

Manual

import { useScript } from '@siberiacancode/reactuse';

Usage

const status = useScript('https://example.com/script.js');

Demo

source

Api

Parameters

Name	Type	Default	Note
src	string	-	The source of the script
options?	UseScriptOptions	-	The options of the script extends from attributes script tag
options.removeOnUnmount?	boolean	true	Whether to remove the script on unmount
options.async?	boolean	true	Whether to load the script asynchronously

Returns

UseScriptStatus

Type declaration

import type { ComponentProps } from 'react';

export type UseScriptStatus = 'error' | 'loading' | 'ready' | 'unknown';

export interface UseScriptOptions extends ComponentProps<'script'> {
  /** Whether to remove the script on unmount */
  removeOnUnmount?: boolean;
}

Source

Source • Demo

Contributors

D

debabin

H

hywax