Package Exports

@ima/plugin-script-loader
@ima/plugin-script-loader/dist/cjs/main.js
@ima/plugin-script-loader/dist/esm/main.js

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 (@ima/plugin-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

@ima/plugin-script-loader

This is the plugin for loading 3rd party scripts for the IMA.js application. You can visit our site https://imajs.io.

Installation

npm install @ima/plugin-script-loader --save

// /app/build.js

var vendors = {
    common: [
        '@ima/plugin-script-loader'
    ]
};

/*
Now is script loader plugin available as:

import { ScriptLoaderPlugin, Events, defaultDependencies } from '@ima/plugin-script-loader';
*/

Usage

Basic Usage

import Dispatcher from 'ima/event/Dispatcher';
import { ScriptLoader, Events as ScriptLoaderEvents, ScriptLoaderOptions } from '@ima/plugin-script-loader';

oc
    .get(ScriptLoader)
    .load('//www.example.com/script.js')
    .then((result) => {
        console.log('Script is loaded.', result.url);
    })
    .catch((error) => {
        console.log('Script failed to load.', error);
    });

oc
    .get(Dispatcher)
    .listen(ScriptLoaderEvents.LOADED, (result) => {
        if (result.error) {
            console.log('Script is not loaded.', result.url);
        } else {
            console.log('Script is loaded.', result.url);
        }
    });

Loading ES Modules

import { ScriptLoader } from '@ima/plugin-script-loader';

// Load ES module with type="module"
oc
    .get(ScriptLoader)
    .load('//www.example.com/module.js', null, false, { module: true })
    .then((result) => {
        console.log('ES module is loaded.', result.url);
    });

Advanced Configuration

import { ScriptLoader } from '@ima/plugin-script-loader';

// Load script with custom attributes
oc
    .get(ScriptLoader)
    .load('//www.example.com/script.js', null, false, {
        module: true,  // Load as ES module
        async: false,  // Disable async loading
        attributes: {
            'crossorigin': 'anonymous',
            'data-version': '1.0.0'
        }
    });

Configuration Options

The load method accepts an optional options parameter of type ScriptLoaderOptions:

module?: boolean - Set to true to load the script as an ES module with type="module"
async?: boolean - Set to false to disable async loading (default: true)
attributes?: Record<string, string> - Custom attributes to set on the script element