esri-loader

A tiny library to help you use the ArcGIS API for JavaScript in applications built with popular JavaScript frameworks and bundlers.

Ready to jump in? Follow the Install and Usage instructions below to get started. Then see more in depth instructions on how to configure esri-loader and use it with React, Vue.js, Angular, Ember, or the ArcGIS Types.

Want to learn more? Read below about why this library is needed and how it can help improve application load performance and allow you to use the ArcGIS API in server side rendered applications.

Want to be inspired? See the Examples section below for links to applications that use this library in over a dozen different frameworks.

Install

npm install --save esri-loader

or

yarn add esri-loader

Usage

The code snippets below show how to load the ArcGIS API and its modules and then use them to create a map. Where you would place similar code in your application will depend on which application framework you are using. See below for examples that are specific to React, Vue.js, Angular, Ember, and example applications written in over a dozen frameworks.

Loading Modules from the ArcGIS API for JavaScript

From the Latest Version

Here's an example of how you could load and use the WebMap and MapView classes from the latest 4.x release to create a map (based on this sample):

import { loadModules } from 'esri-loader';

// this will lazy load the ArcGIS API
// and then use Dojo's loader to require the classes
loadModules(['esri/views/MapView', 'esri/WebMap'])
  .then(([MapView, WebMap]) => {
    // then we load a web map from an id
    var webmap = new WebMap({
      portalItem: { // autocasts as new PortalItem()
        id: 'f2e9b762544945f390ca4ac3671cfa72'
      }
    });
    // and we show that map in a container w/ id #viewDiv
    var view = new MapView({
      map: webmap,
      container: 'viewDiv'
    });
  })
  .catch(err => {
    // handle any errors
    console.error(err);
  });

From a Specific Version

By default esri-loader will load modules from the latest 4.x release of the API from the CDN, but you can configure the default behavior by calling setDefaultOptions() once before making any calls to loadModules().

For example, the snippet below configures esri-loader to use the latest 3.x release of the API from the CDN by setting the default version option during application start up.

// app.js
import { setDefaultOptions } from 'esri-loader';

// configure esri-loader to use version 3.31 from the ArcGIS CDN
// NOTE: make sure this is called once before any calls to loadModules()
setDefaultOptions({ version: '3.31' })

Then later, for example after a map component has mounted, you would use loadModules() as normal, except in this case you'd be using the 3.x Map class instead of the 4.x classes.

// component.js
import { loadModules } from 'esri-loader';

// this will lazy load the ArcGIS API
// and then use Dojo's loader to require the map class
loadModules(['esri/map'])
  .then(([Map]) => {
    // create map with the given options at a DOM node w/ id 'mapNode'
    let map = new Map('mapNode', {
      center: [-118, 34.5],
      zoom: 8,
      basemap: 'dark-gray'
    });
  })
  .catch(err => {
    // handle any script or module loading errors
    console.error(err);
  });

You can load the "next" version of the ArcGIS API by passing version: 'next'.

From a Specific URL

If you want to load modules from a build that you host on your own server (i.e. that you've downloaded or built with Dojo), you would set the default url option instead:

// app.js
import { setDefaultOptions } from 'esri-loader';

// configure esri-loader to use version from a locally hosted build of the API
// NOTE: make sure this is called once before any calls to loadModules()
setDefaultOptions({ url: `http://server/path/to/esri` });

See Configuring esri-loader for all available configuration options.

Lazy Loading the ArcGIS API for JavaScript

Lazy loading the ArcGIS API can dramatically improve the initial load performance of your mapping application, especially if your users may never end up visiting any routes that need to show a map or 3D scene. That is why it is the default behavior of esri-loader. In the above snippets, the first time loadModules() is called, it will lazy load the ArcGIS API by injecting a <script> tag in the page. That call and any subsequent calls to loadModules() will wait for the script to load before resolving with the modules.

If you have some reason why you do not want to lazy load the ArcGIS API, you can use a static script tag instead.

Loading Styles

Before you can use the ArcGIS API in your app, you must load the styles that correspond to the version you are using. Just like the ArcGIS API modules, you'll probably want to lazy load the styles only once they are needed by the application.

When you load the script

The easiest way to do that is to pass the css option to setDefaultOptions():

import { setDefaultOptions, loadModules } from 'esri-loader';

// before loading the modules for the first time,
// also lazy load the CSS for the version of
// the script that you're loading from the CDN
setDefaultOptions({ css: true });

loadModules(['esri/views/MapView', 'esri/WebMap'])
  .then(([MapView, WebMap]) => {
    // the styles, script, and modules have all been loaded (in that order)
  });

Passing css: true does not work when loading the script using the url option. In that case you'll need to pass the URL to the styles like: css: 'http://server/path/to/esri/css/main.css'. See Configuring esri-loader for all available configuration options.

Using loadCss()

Alternatively, you can use the provided loadCss() function to load the ArcGIS styles at any point in your application's life cycle. For example:

import { loadCss } from 'esri-loader';

// by default loadCss() loads styles for the latest 4.x version
loadCss();

// or for a specific CDN version
loadCss('3.31');

// or a from specific URL, like a locally hosted version
loadCss('http://server/path/to/esri/css/main.css');

See below for information on how to override ArcGIS styles that you've lazy loaded with loadModules() or loadCss().

Using traditional means

Of course, you don't need to use esri-loader to load the styles. See the ArcGIS API for JavaScript documentation for more information on how to load the ArcGIS styles by more traditional means such as adding <link> tags to your HTML, or @import statements to your CSS.

Why is this needed?

Unfortunately, you can't simply npm install the ArcGIS API and then import 'esri' modules in a non-Dojo application. The only reliable way to load ArcGIS API for JavaScript modules is using Dojo's AMD loader. However, when using the ArcGIS API in an application built with another framework, you typically want to use the tools and conventions of that framework rather than the Dojo build system.

There are a few ways to integrate the ArcGIS API for JavaScript with other frameworks and their tools, but esri-loader is the most versatile since it works in applications that:

are built with any loader/bundler, such as webpack, rollup.js, or Parcel
use framework tools that discourage or prevent you from manually editing the webpack configuration
use either version 4.x or 3.x of the ArcGIS API for JavaScript

If you are using webpack, you may be able to use the @arcgis/webpack-plugin instead of esri-loader. Learn more about which is the right solution for your application.

Examples

Here are some applications and framework-specific wrapper libraries that use this library. We don't guarantee that these examples are current, so check the version of esri-loader and their commit history before using them as a reference. They are presented by framework in alphabetical order - not picking any favorites here 😜:

Angular

See the ArcGIS API guides for up to date examples of how to use the ArcGIS API for JavaScript with Angular.

Reusable libraries for Angular

angular-esri-components - A set of Angular components to work with ArcGIS API for JavaScript v4.3

Example Angular applications

angular-cli-esri-map - Example of how to build a simple mapping component using Angular CLI.

NOTE: If you want to use the ArcGIS API in an AngularJS (1.x) application, see angular-esri-map, which is actually where the code in this library was originally extracted from.

CanJS

can-arcgis - CanJS configurable mapping app (inspired by cmv-app) and components built for the ArcGIS JS API 4.x, bundled with StealJS

Choo

esri-choo-example - An example Choo application that shows how to use esri-loader to create a custom map view.

Dojo 2+

dojo-esri-loader - Dojo 5 app with esri-loader (blog post)
esri-dojo - An example of how to use Esri Loader with Dojo 2+. This example is a simple map that allows you to place markers on it.

Electron

ng-cli-electron-esri - This project is meant to demonstrate how to run a mapping application using the ArcGIS API for JavaScript inside of Electron

Ember

See the ArcGIS API guides for up to date examples of how to use the ArcGIS API for JavaScript with Ember.

Reusable libraries for Ember

ember-esri-loader - An Ember addon that wraps this library

Example Ember applications

See the examples over at ember-esri-loader

Glimmer.js

esri-glimmer-example - An example of how to use the ArcGIS API for JavaScript in a https://glimmerjs.com/ application

Hyperapp

esri-hyperapp-example - An example Hyperapp application that shows how to use esri-loader to create a custom map view and component.

Ionic

ionic2-esri-map - Prototype app demonstrating how to use Ionic 3+ with the ArcGIS API for JavaScript

Preact

esri-preact-pwa - An example progressive web app (PWA) using the ArcGIS API for JavaScript built with Preact

React

See the ArcGIS API guides for up to date examples of how to use the ArcGIS API for JavaScript with React.

Reusable libraries for React

react-arcgis - A few components to help you get started using esri-loader with React
esri-loader-react - A React component wrapper around esri-loader (blog post)
arcgis-react-redux-legend - Legend control for ArcGIS JS v4 using React and Redux

Example React applications

create-arcgis-app - An example of how to use the ArcGIS platform in an application created with Create React App and React Router.
next-arcgis-app - An example of how to use the ArcGIS platform in an application built with Next.js
esri-loader-react-starter-kit - A fork of the react-starter-kit showing how to use esri-loader in an isomorphic/universal React application
create-react-app-esri-loader - An example create-react-app application that uses esri-loader-react to load the ArcGIS API
React-Typescript-App-with-ArcGIS-JSAPI - An example create-react-app application that uses esri-loader, esri-loader-react, Typescript, Webpack3 to create MapView

Riot

esri-riot-example - An example Riot application that shows how to use esri-loader to create a custom <esri-map-view> component.

Stencil

esri-stencil-example - An example Stencil application that shows how to use esri-loader to create a custom map view component and implement some basic routing controlling the map state

Svelte

esri-svelte-example - An example Svelte application that shows how to use esri-loader to load a map.

Vue.js

See the ArcGIS API guides for up to date examples of how to use the ArcGIS API for JavaScript with Vue.

CreateMap - Create Map: City of Baltimore - https://gis.baltimorecity.gov/createmap/#/
City of Baltimore: Map Gallery - Map Gallery built with Vue.js that uses this library to load the ArcGIS API
vue-jsapi4 - An example of how to use the ArcGIS API for Javascript in a NUXT application (blog post, video)
esri-vue-cli-example - An example of how to use the ArcGIS API for JavaScript 3.x in a vue-cli application

Advanced Usage

ArcGIS Types

This library doesn't make any assumptions about which version of the ArcGIS API you are using, so you will have to install the appropriate types. Furthermore, because you don't import esri modules directly with esri-loader, you'll have to follow the instructions below to use the types in your application.

4.x Types

Follow these instructions to install the 4.x types.

After installing the 4.x types, you can use the __esri namespace for the types as seen in this example.

3.x Types

You can use these instructions to install the 3.x types.

The __esri namespace is not defined for 3.x types, but you can import * as esri from 'esri'; to use the types as shown here.

TypeScript import()

TypeScript 2.9 added a way to import() types which allows types to be imported without importing the module. For more information on import types see this post. You can use this as an alternative to the 4.x _esri namespace or import * as esri from 'esri' for 3.x.

After you've installed the 4.x or 3.x types as described above, you can then use TypeScript's import() like:

// define a type that is an array of the 4.x types you are using
// and indicate that loadModules() will resolve with that type
type MapModules = [typeof import("esri/WebMap"), typeof import("esri/views/MapView")];
const [WebMap, MapView] = await (loadModules(["esri/WebMap", "esri/views/MapView"]) as Promise<MapModules>);
// the returned objects now have type
const webmap = new WebMap({portalItem: {id: this.webmapid}});

A more complete 4.x sample can be seen here.

This also works with the 3.x types:

// define a type that is an array of the 3.x types you are using
// and indicate that loadModules() will resolve with that type
type MapModules = [typeof import("esri/map"), typeof import("esri/geometry/Extent")];
const [Map, Extent] = await (loadModules(["esri/map", "esri/geometry/Extent"]) as Promise<MapModules>);
// the returned objects now have type
let map = new Map("viewDiv"...

A more complete 3.x sample can be seen here.

Types in Angular CLI Applications

For Angular CLI applications, you will also need to add "arcgis-js-api" to compilerOptions.types in src/tsconfig.app.json and src/tsconfig.spec.json as shown here.

Configuring esri-loader

As mentioned above, you can call setDefaultOptions() to configure how esri-loader loads ArcGIS API modules and CSS. Here are all the options you can set:

Name	Type	Default Value	Description
`version`	`string`	`'4.14'`	The version of the ArcGIS API hosted on Esri's CDN to use.
`url`	`string`	`undefined`	The URL to a hosted build of the ArcGIS API to use. If both `version` and `url` are passed, `url` will be used.
`css`	`string` or `boolean`	`undefined`	If a `string` is passed it is assumed to be the URL of a CSS file to load. Use `css: true` to load the `version`'s CSS from the CDN.
`insertCssBefore`	`string`	`undefined`	When using `css`, the `<link>` to the stylesheet will be inserted before the first element that matches this CSS Selector. See Overriding ArcGIS Styles.
`dojoConfig`	`Object`	`undefined`	See Configuring Dojo.

All of the above are optional.

Without `setDefaultOptions()`

If your application only has a single call to loadModules(), you do not need setDefaultOptions(). Instead you can just pass the options as a second argument to loadModules():

import { loadModules } from 'esri-loader';

// configure esri-loader to use version 3.31
// and the CSS for that version from the ArcGIS CDN
const options = { version: '3.31', css: true };

loadModules(['esri/map'], options)
  .then(([Map]) => {
    // create map with the given options at a DOM node w/ id 'mapNode'
    let map = new Map('mapNode', {
      center: [-118, 34.5],
      zoom: 8,
      basemap: 'dark-gray'
    });
  })
  .catch(err => {
    // handle any script or module loading errors
    console.error(err);
  });

Configuring Dojo

You can pass a dojoConfig option to loadModules() to configure Dojo before the script tag is loaded. This is useful if you want to use esri-loader to load Dojo packages that are not included in the ArcGIS API for JavaScript such as FlareClusterLayer.

import { loadModules } from 'esri-loader';

// in this case options are only needed so we can configure Dojo before loading the API
const options = {
  // tell Dojo where to load other packages
  dojoConfig: {
    async: true,
    packages: [
      {
        location: '/path/to/fcl',
        name: 'fcl'
      }
    ]
  }
};

loadModules(['esri/map', 'fcl/FlareClusterLayer_v3'], options)
  .then(([Map, FlareClusterLayer]) => {
    // you can now create a new FlareClusterLayer and add it to a new Map
  })
  .catch(err => {
    // handle any errors
    console.error(err);
  });

Overriding ArcGIS Styles

If you want to override ArcGIS styles that you have lazy loaded using loadModules() or loadCss(), you may need to insert the ArcGIS styles into the document above your custom styles in order to ensure the rules of CSS precedence are applied correctly. For this reason, loadCss() accepts a selector (string) as optional second argument that it uses to query the DOM node (i.e. <link> or <script>) that contains your custom styles and then insert the ArcGIS styles above that node. You can also pass that selector as the insertCssBefore option to loadModules():

import { loadModules } from 'esri-loader';

// lazy load the CSS before loading the modules
const options = {
  css: true,
  // insert the stylesheet link above the first <style> tag on the page
  insertCssBefore: 'style'
};

// before loading the modules, this will call:
// loadCss('https://js.arcgis.com/4.12/themes/light/main.css', 'style')
loadModules(['esri/views/MapView', 'esri/WebMap'], options);

Alternatively you could insert it before the first <link> tag w/ insertCssBefore: 'link[rel="stylesheet"]', etc.

Pre-loading the ArcGIS API for JavaScript

Under the hood, loadModules() calls esri-loader's loadScript() function to lazy load the ArcGIS API by injecting a <script> tag into the page.

If loadModules() hasn't yet been called, but you have good reason to believe that the user is going take an action that will call it (i.e. transition to a route that shows a map), you can call loadScript() ahead of time to start loading ArcGIS API. For example:

import { loadScript, loadModules } from 'esri-loader';

// preload the ArcGIS API
// NOTE: in this case, we're not passing any options to loadScript()
// so it will default to loading the latest 4.x version of the API from the CDN
loadScript();

// later, for example after transitioning to a route with a map
// you can now load the map modules and create the map
const [MapView, WebMap] = await loadModules(['esri/views/MapView', 'esri/WebMap']);

See Configuring esri-loader for all available configuration options you can pass to loadScript().

NOTE: loadScript() does not use rel="preload", so it will fetch, parse, and execute the script. In practice, it can be tricky to find a point in your application where you can call loadScript() without blocking rendering. In most cases, it's best to just use loadModules() to lazy load the script.

Using your own script tag

It is possible to use this library only to load modules (i.e. not to lazy load or pre-load the ArcGIS API). In this case you will need to add a data-esri-loader attribute to the script tag you use to load the ArcGIS API for JavaScript. Example:

<!-- index.html -->
<script src="https://js.arcgis.com/4.14/" data-esri-loader="loaded"></script>

Using the esriLoader Global

Typically you would install the esri-loader package and then import the functions you need as shown in all the above examples. However, esri-loader is also distributed as an ES5 UMD bundle on UNPKG so that you can load it via a script tag and use the above functions from the esriLoader global.

<script src="https://unpkg.com/esri-loader"></script>
<script>
  esriLoader.loadModules(['esri/views/MapView', 'esri/WebMap'])
  .then(([MapView, WebMap]) => {
    // use MapView and WebMap classes as shown above
  });
</script>

Pro Tips

Using Classes Synchronously

Let's say you need to create a map in one component, and then later in another component add a graphic to that map. Unlike creating a map, creating a graphic and adding it to a map is ordinarily a synchronous operation, so it can be inconvenient to have to wait for loadModules() just to load the Graphic class. One way to handle this is have the function that creates the map also load the Graphic class before its needed. You can then hold onto that class for later use to be exposed by a function like addGraphicToMap(view, graphicJson):

// utils/map.js
import { loadModules } from 'esri-loader';

// NOTE: module, not global scope
let _Graphic;

// this will be called by the map component
export function loadMap(element, mapOptions) {
  return loadModules(['esri/Map', 'esri/views/MapView', 'esri/Graphic'])
  .then(([Map, MapView, Graphic]) => {
    // hold onto the graphic class for later use
    _Graphic = Graphic;
    // create the Map
    const map = new Map(mapOptions);
    // return a view showing the map at the element
    return new MapView({
      map,
      container: element
    });
  });
}

// this will be called by the component that needs to add the graphic to the map
export function addGraphicToMap(view, graphicJson) {
  // make sure that the graphic class has already been loaded
  if (!_Graphic) {
    throw new Error('You must load a map before creating new graphics');
  }
  view.graphics.add(new _Graphic(graphicJson));
}

You can see this pattern in use in a real-world application.

See #124 (comment) and #71 (comment) for more background on this pattern.

Server Side Rendering

This library also allows you to use the ArcGIS API in applications that are rendered on the server. There's really no difference in how you invoke the functions exposed by this library, however you should avoid trying to call them from any code that runs on the server. The easiest way to do this is to call loadModules() in component lifecyle hooks that are only invoked in a browser, for example, React's useEffect or componentDidMount, or Vue's mounted.

Alternatively, you could use checks like the following to prevent calling esri-loader functions on the server:

import { loadCss } from 'esri-loader';

if (typeof window !== 'undefined') {
  // this is running in a browser, so go ahead and load the CSS
  loadCss();
}

See next-arcgis-app or esri-loader-react-starter-kit for examples of how to use esri-loader in server side rendered (SSR) applications.

FAQs

In addition to the pro tips above, you might want to check out some frequently asked questions.

Updating from previous versions

From < v1.5

If you have an application using a version that is less than v1.5, this commit shows the kinds of changes you'll need to make. In most cases, you should be able to replace a series of calls to isLoaded(), bootstrap(), and dojoRequire() with a single call to loadModules().

From angular-esri-loader

The angular-esri-loader wrapper library is no longer needed and has been deprecated in favor of using esri-loader directly. See this issue for suggestions on how to replace angular-esri-loader with the latest version of esri-loader.

Dependencies

Browsers

This library doesn't have any external dependencies, but the functions it exposes to load the ArcGIS API and its modules expect to be run in a browser. This library officially supports the same browsers that are supported by the latest version of the ArcGIS API for JavaScript. Since this library also works with v3.x of the ArcGIS API, the community has made some effort to get it to work with some of the older browsers supported by 3.x like IE < 11.

You cannot run the ArcGIS API for JavaScript in Node.js, but you can use this library in server side rendered applications as well as Electron. If you need to execute requests to ArcGIS REST services from something like a Node.js CLI application, see arcgis-rest-js.

Promises

Since v1.5 asynchronous functions like loadModules() and loadScript() return Promises, so if your application has to support browsers that don't support Promise (i.e. IE) you have a few options.

If there's already a Promise implementation loaded on the page you can configure esri-loader to use that implementation. For example, in ember-esri-loader, we configure esri-loader to use the RSVP Promise implementation included with Ember.js.

import { utils } from  'esri-loader';

init () {
  this._super(...arguments);
  // have esriLoader use Ember's RSVP promise
  utils.Promise = Ember.RSVP.Promise;
},

Otherwise, you should consider using a Promise polyfill, ideally only when needed.

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.

Name		Name	Last commit message	Last commit date
Latest commit History 319 Commits
.github		.github
profiles		profiles
scripts		scripts
src		src
test		test
.gitignore		.gitignore
.npmignore		.npmignore
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
karma.conf.js		karma.conf.js
package.json		package.json
rollup.config.js		rollup.config.js
tsconfig.json		tsconfig.json
tslint.json		tslint.json
yarn.lock		yarn.lock

License

adam-beauchamp/esri-loader

Folders and files

Latest commit

History

Repository files navigation