@arcgis/core 4.29.0-next.20231113 → 4.29.0-next.20231114

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,127 +1,33 @@
1
1
  # @arcgis/core
2
2
 
3
- A minified, unbuilt version of the [ArcGIS Maps SDK for JavaScript](https://developers.arcgis.com/javascript/) ES modules.
3
+ A minified, unbuilt version of the [ArcGIS Maps SDK for JavaScript](https://developers.arcgis.com/javascript/) ES modules. Use ArcGIS Maps SDK for JavaScript to build compelling web apps that unlock your data's potential with interactive user experiences and stunning 2D and 3D visualizations.
4
4
 
5
- ## Features
5
+ Want to get started immediately? See our [sample applications](https://github.com/Esri/jsapi-resources/tree/main/esm-samples) for using the package with popular frameworks, module bundlers and TypeScript.
6
6
 
7
- For an overview of the SDK, visit the [developer documentation](https://developers.arcgis.com/javascript/latest/key-features/) site.
7
+ ## Documentation
8
8
 
9
- You can install this package with [npm](https://npmjs.org/) and then use it directly in a framework such as [React](https://reactjs.org/), [Vue.js](https://vuejs.org) or [Angular](https://cli.angular.io/). Or, you can also create your own custom builds with a module bundler such as [Webpack](https://webpackjs.org) or [Rollup](https://rollupjs.org).
10
-
11
- The SDK includes [TypeScript](https://www.typescriptlang.org/) type definitions. The `.d.ts` declaration files are bundled with the install.
12
-
13
- For more information on using the `next` versions, visit the [feedback-js-api-next](https://github.com/Esri/feedback-js-api-next/blob/main/README.md) repository.
14
-
15
- Sample applications can be found at [github.com/Esri/jsapi-resources/](https://github.com/Esri/jsapi-resources/tree/main/esm-samples).
9
+ - [Key Features](https://developers.arcgis.com/javascript/latest/key-features/)
10
+ - [Build with ES modules](https://developers.arcgis.com/javascript/latest/es-modules/)
11
+ - [API Reference](https://developers.arcgis.com/javascript/latest/api-reference/)
12
+ - [Functionality samples](https://developers.arcgis.com/javascript/latest/sample-code/)
13
+ - [TypeScript setup](https://developers.arcgis.com/javascript/latest/typescript-setup/)
16
14
 
17
15
  ## Get started
18
16
 
19
17
  Install the package into your project:
20
18
 
21
- ```
19
+ ```sh
22
20
  npm install @arcgis/core
23
21
  ```
24
22
 
25
- ## Configure CSS
26
-
27
- Set the CSS to the same version as the installed package. You can verify the installed SDK version by running `npm list @arcgis/core`. If you are working with locally hosted assets skip to the _Manage assets locally_ section.
28
-
29
- The first example shows importing CSS for the `latest` SDK version: `4.28.7`:
30
-
31
- _index.css_
32
-
33
- ```css
34
- @import "https://js.arcgis.com/4.28/@arcgis/core/assets/esri/themes/light/main.css";
35
- ```
36
-
37
- ## Working with assets
38
-
39
- The default configuration for local builds is for the SDK to automatically pull assets from a CDN at runtime. There is no need for additional configuration. The assets include styles, images, web workers, wasm and localization files. `latest` and `rc` versions of the SDK's assets are hosted on the ArcGIS CDN, while `next` versions use assets hosted on the jsDelivr CDN.
40
-
41
- ### Manage assets locally
42
-
43
- If you need to manage the assets locally, copy them into your project from `/node_modules/@arcgis/core/assets`, and then set `config.assetsPath` to ensure requests for assets are resolved correctly. A simple way to accomplish this is to configure an npm script that runs during your build process. For example, use `cp` on MacOS and Windows PowerShell, or [`xcopy`](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/xcopy) on Windows, and configure a script in the package.json to copy the folder.
44
-
45
- **Important:** Every time you upgrade the SDK, be sure to recopy the new version of the assets into your project. This ensures the assets and API library stay synchronized.
46
-
47
- Here’s a React example:
48
-
49
- _package.json_
50
-
51
- ```json
52
- {
53
- "scripts": {
54
- "start": "cp -R ./node_modules/@arcgis/core/assets ./public/assets && react-scripts start",
55
- "build": "cp -R ./node_modules/@arcgis/core/assets ./public/assets && react-scripts build"
56
- }
57
- }
58
- ```
59
-
60
- _App.js_
61
-
62
- ```js
63
- import esriConfig from "@arcgis/core/config.js";
64
- esriConfig.assetsPath = "./assets";
65
- ```
66
-
67
- _index.css_
68
-
69
- ```css
70
- @import "@arcgis/core/assets/esri/themes/light/main.css";
71
- ```
72
-
73
- For Angular, one example is to copy the asset files by configuring the `architect/build/options/assets` section of `angular.json`, for example:
74
-
75
- _angular.json_
76
-
77
- ```json
78
- {
79
- "assets": [
80
- {
81
- "glob": "**/*",
82
- "input": "node_modules/@arcgis/core/assets",
83
- "output": "/assets/"
84
- }
85
- ]
86
- }
87
- ```
88
-
89
- _app.component.ts_
90
-
91
- ```ts
92
- import esriConfig from "@arcgis/core/config.js";
93
- esriConfig.assetsPath = "./assets";
94
- ```
95
-
96
- _app.component.css_
97
-
98
- Add the following line at the top of the css file:
99
-
100
- ```css
101
- @import "@arcgis/core/assets/esri/themes/light/main.css";
102
- ```
103
-
104
- For other installations, consider using this npm script as a starting point:
105
-
106
- _package.json_
107
-
108
- ```json
109
- {
110
- "script": {
111
- "copy": "cp -R ./node_modules/@arcgis/core/assets ./dist/assets"
112
- }
113
- }
114
- ```
115
-
116
- ## Requirements
117
-
118
- Use of the ArcGIS Maps SDK for JavaScript is subject to [System Requirements](https://developers.arcgis.com/javascript/latest/system-requirements/), and the terms described in the product-specific [Terms of Use.](https://www.esri.com/en-us/legal/terms/product-specific-scope-of-use) Learn more about licensing [here](https://developers.arcgis.com/javascript/latest/licensing/).
119
-
120
23
  ## Resources
121
24
 
122
- - [ArcGIS Maps SDK for JavaScript - Build with ES modules](https://developers.arcgis.com/javascript/latest/es-modules/)
123
- - [http://blogs.esri.com/esri/arcgis/tag/javascript/](https://blogs.esri.com/esri/arcgis/tag/javascript/)
25
+ - [ArcGIS blog](https://blogs.esri.com/esri/arcgis/tag/javascript/)
124
26
  - [twitter@EsriDevs](https://twitter.com/EsriDevs)
27
+ - [System Requirements](https://developers.arcgis.com/javascript/latest/system-requirements/)
28
+ - [Terms of Use](https://www.esri.com/en-us/legal/terms/product-specific-scope-of-use)
29
+ - [Licensing](https://developers.arcgis.com/javascript/latest/licensing/)
30
+ - [Working with `next` versions](https://github.com/Esri/feedback-js-api-next/blob/main/README.md))
125
31
 
126
32
  ## Issues
127
33