The samples in this directory demonstrate using @arcgis/core ES modules with various frameworks, module bundlers and build tools. @arcgis/core is installed using npm, and is intended for use in local builds that you host.
You can use these links to download individual samples:
- Angular CLI
- ArcGIS ESM CDN
- Custom workers
- Custom UI
- Deno
- esbuild (no framework)
- Node.js
- OAuth
- React/Vite
- Rollup.js (no framework)
- Vue.js/Vite
- Vite
- Webpack (no framework)
Run npm install in a project directory and then start adding ArcGIS Maps SDK for JavaScript functionality.
For additional information, see the Get started with npm Guide topic in the SDK.
For TypeScript users, the type definitions are included when you install @arcgis/core. There is no need for a separate install.
Building applications locally involves understanding many interrelated pieces including frameworks, module bundlers, transpilers, dependency libraries and the ArcGIS Maps SDK for JavaScript. Refer to our Troubleshooting issues with local builds guide topic for guidance on narrowing down the potential sources for issues.
For each release, we track certain metrics including bundle size and web application performance. These files can be found in the /core-samples/.metrics directory. You can read more about how we capture this information this README.
The performance metrics can be separated into two categories: initial application load and on-disk build output files.
The initial application load metrics are related to the browser fetching and processing all initial HTTP requests before any user interaction. In the metrics, we make a distinction between JavaScript file requests and service request data which includes map tiles and query data.
The on-disk build output metrics represent files created by the local build and written to disk. At runtime, your application only loads a portion of the bundles depending on which @arcgis/core modules are used in your project. The number and size of bundles is dependant on multiple factors and will vary based on framework, module bundler, transpiling and related configurations. The compile process can output several hundred or more bundles on-disk due to the ArcGIS JavaScript Maps SDK using dynamic imports.
The performance indicators will vary depending on the device or virtual machine, and they are best used for analyzing trends over time. They depend on many hardware and software factors including CPU load, memory usage and internet speed during the time window when they are captured. For example, the numbers posted in the metrics directory come from running a cloud-based GitHub action. It's very likely that the metrics will be different from when you capture metrics locally on your development machine in a headless environment, or directly in a browser developer console.