Skip to content
This repository has been archived by the owner on Nov 6, 2024. It is now read-only.

Commit

Permalink
Bjorn's feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
andygup committed Dec 9, 2022
1 parent 22d0826 commit 4790f91
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 31 deletions.
50 changes: 25 additions & 25 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [3.7.0] - 2022-11-16
### Added
- default to JS SDK 4.25; update docs w/ latest version numbers - @andygup
- default to 4.25; update docs w/ latest version numbers - @andygup
### Changed
- raise visibility of deprecation notice for frameworks that do not support async/await at runtime, e.g. Angular due to limitations in Zone.js
- archive framework samples and various 3.x-related sections to archived-examples.md. Most of the samples haven't been updated in years

## [3.6.0] - 2022-07-07
### Added
- default to JS SDK 4.24; update docs w/ latest version numbers - @gavinr
- default to 4.24; update docs w/ latest version numbers - @gavinr

### Changed
- fix build by not compiling @types
Expand All @@ -27,11 +27,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [3.5.0] - 2022-03-29
### Added
- default to JS SDK 4.23; update docs w/ latest version numbers - @gavinr
- default to 4.23; update docs w/ latest version numbers - @gavinr

## [3.4.0] - 2022-01-14
### Added
- default to JS SDK 4.22; update docs w/ latest version numbers - @gavinr
- default to 4.22; update docs w/ latest version numbers - @gavinr

## [3.3.0] - 2021-09-22

Expand All @@ -41,33 +41,33 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [3.1.0] - 2021-04-23
### Added
- default to JS SDK 4.19; update docs w/ latest version numbers - @vannizhang
- default to 4.19; update docs w/ latest version numbers - @vannizhang

## [3.0.0] - 2020-12-31
### Added
- default to JS SDK 4.18; update docs w/ latest version numbers - @gavinr
- default to 4.18; update docs w/ latest version numbers - @gavinr

### Breaking
- default version of JS SDK no longer supports IE
- 4.18 no longer supports IE
- remove option to set `dojoConfig`
- remove esri-loader default export

## [2.16.0] - 2020-10-13
### Added
- default to JS SDK 4.17; update docs w/ latest version numbers - @tgirgin23
- default to 4.17; update docs w/ latest version numbers - @tgirgin23

## [2.15.0] - 2020-07-10
### Added
- default to JS SDK 4.16; update docs w/ latest version numbers - @JoshCrozier
- default to 4.16; update docs w/ latest version numbers - @JoshCrozier

## [2.14.0] - 2020-04-09
### Added
- default to JS SDK 4.15; update docs w/ latest version numbers - @JoshCrozier
- default to 4.15; update docs w/ latest version numbers - @JoshCrozier

## [2.13.0] - 2019-12-22

### Added
- default to JS SDK 4.14; update docs w/ latest version numbers - @gpbmike
- default to 4.14; update docs w/ latest version numbers - @gpbmike

## [2.12.0] - 2019-10-24

Expand All @@ -78,8 +78,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [2.11.0] - 2019-10-14
### Added
- default to JS SDK 4.13; update docs w/ latest version numbers
- add support for "next" version of JS SDK
- default to 4.13; update docs w/ latest version numbers
- add support for "next" version of

## [2.10.2] - 2019-10-12

Expand All @@ -95,7 +95,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [2.10.0] - 2019-07-03
### Added
- default to JS SDK 4.12; update docs w/ latest version numbers
- default to 4.12; update docs w/ latest version numbers

## [2.9.2] - 2019-04-18

Expand All @@ -109,7 +109,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [2.9.0] - 2019-03-29
### Added
- default to JS SDK 4.11; update docs w/ latest version numbers
- default to 4.11; update docs w/ latest version numbers

## [2.8.0] - 2019-03-27
### Added
Expand All @@ -129,21 +129,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [2.6.0] - 2018-12-17

### Added
- default to JS SDK 4.10; update docs w/ latest version numbers
- default to 4.10; update docs w/ latest version numbers

## [2.5.0] - 2018-09-29

### Changed
- default to JS SDK 4.9; update docs w/ latest version numbers
- default to 4.9; update docs w/ latest version numbers

## [2.4.0]

### Changed
- default to JS SDK 4.8; update docs w/ latest version numbers
- default to 4.8; update docs w/ latest version numbers

## [2.3.0]
### Added
- default to JS SDK 4.7; update docs w/ latest version numbers
- default to 4.7; update docs w/ latest version numbers
### Changed
- added Hyperapp example link to README
- move CSS functions into own module
Expand Down Expand Up @@ -197,7 +197,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [1.6.0] - 2017-12-31
### Added
- default to version 4.6 of the JS SDK [#63](https://github.com/Esri/esri-loader/issues/63)
- default to version 4.6 [#63](https://github.com/Esri/esri-loader/issues/63)
### Changed
- remove remaining references to angular-esri-loader from README
- update README w/ info on arcgis types and browser support [#60](https://github.com/Esri/esri-loader/issues/60)
Expand Down Expand Up @@ -251,7 +251,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [1.2.0]

### Added
- default to version 4.5 of the JS SDK
- default to 4.5

### Fixed
- don't throw an error when `bootstrap()` is called multiple times w/o a callback
Expand All @@ -262,7 +262,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [1.1.0]

### Added
- default to version 4.4 of the JS SDK
- default to 4.4

## [1.0.0]

Expand All @@ -289,13 +289,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [0.2.0]

### Added
- enable pre-loading the JS SDK
- default to version 4.3 of the JS SDK
- enable pre-loading
- default to 4.3

## [0.1.3]

### Fixed
- default to version 4.2 of the JS SDK
- default to 4.2
- use HTTPS by default

## [0.1.2]
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A tiny library to help you use the [ArcGIS Maps SDK for JavaScript](https://deve

Ready to jump in? Follow the [Install](#install) and [Usage](#usage) instructions below to get started. Then see more in depth instructions on how to [configure esri-loader](#configuring-esri-loader).

Want to learn more? Learn how esri-loader can help [improve application load performance](#lazy-loading-the-arcgis-api-for-javascript) and allow you to [use the API in server side rendered applications](#server-side-rendering).
Want to learn more? Learn how esri-loader can help [improve application load performance](#lazy-loading-the-arcgis-api-for-javascript) and allow you to [use the Maps SDK in server side rendered applications](#server-side-rendering).

Looking for legacy examples from a variety of frameworks, or 3.x information? Visit the [archive](archived-examples.md) page.

Expand Down Expand Up @@ -154,13 +154,13 @@ See [Configuring esri-loader](#configuring-esri-loader) for all available config

### Lazy Loading

Lazy loading the 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 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.
Lazy loading the modules 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 modules 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 API, you can [use a static script tag](#using-your-own-script-tag) instead.
If you have some reason why you do not want to lazy load the modules, you can [use a static script tag](#using-your-own-script-tag) instead.

### Loading Styles

Before you can use the API in your app, you _must_ load the styles that correspond to the version you are using. Just like the APIs modules, you'll probably want to [lazy load](#lazy-loading-the-arcgis-api-for-javascript) the styles only once they are needed by the application.
You _must_ load the styles that correspond to the version you are using. You'll probably want to [lazy load](#lazy-loading-the-arcgis-api-for-javascript) the styles only once they are needed by the application.

#### When you load the script

Expand Down Expand Up @@ -211,10 +211,10 @@ It is recommended to try installing [@arcgis/core](https://www.npmjs.com/package

<a id="why-is-this-needed"></a>For versions of the SDK before 4.18, esri-loader is required when working with frameworks or bundlers. esri-loader provides a way to dynamically load the SDK's AMD modules at runtime from the [ArcGIS CDN](https://developers.arcgis.com/javascript/latest/install-and-set-up/#amd-modules-via-arcgis-cdn) into applications built using modern tools and framework conventions. This allows your application to take advantage of the fast cached [CDN](https://developers.arcgis.com/javascript/latest/guide/get-api/#cdn).

esri-loader provides a convenient way to lazy load the API in any application, and it has been the most versatile way to integrate the ArcGIS Maps SDK for JavaScript with other frameworks and their tools since it works in applications that:
esri-loader provides a convenient way to lazy load the modules in any application, and it has been the most versatile way to integrate the ArcGIS Maps SDK for JavaScript with other frameworks and their tools since it works in applications that:
- are built with _any_ loader/bundler, such as [webpack](https://webpack.js.org/), [rollup.js](https://rollupjs.org/), or [Parcel](https://parceljs.org)
- use framework tools that discourage or prevent you from manually editing their configuration
- make very limited use of the API and don't want to incur the cost of including it in their build
- make very limited use of the Maps SDK and don't want to incur the cost of including it in their build

Most developers will prefer the convenience and native interoperability of being able to `import` modules from `@arcgis/core` directly, especially if their application makes extensive use of the SDK. However, if `@arcgis/core` doesn't work in your application for whatever reason, esri-loader probably will.

Expand Down

0 comments on commit 4790f91

Please sign in to comment.