This repository has been archived by the owner on Jan 25, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,3 @@ | ||
| # JS API Widget Wrapper | ||
| # JS API Widget Wrapper (Archived) | ||
|
|
||
| Example of how to include an [ArcGIS API for JavaScript widget](https://developers.arcgis.com/javascript/latest/sample-code/?search=Widget) in an Experience Builder widget. | ||
|
|
||
| The main example here includes the [2D Measurement widget](https://developers.arcgis.com/javascript/latest/sample-code/widgets-measurement-2d/index.html). Click the download button above and extract the files to `client\your-extensions\widgets\js-api-widget-wrapper` to see it in action. | ||
|
|
||
| [](https://gavinr.github.io/js-api-widget-wrapper-experience-builder/) | ||
|
|
||
|
|
||
| ([builder interface](https://github.com/gavinr/js-api-widget-wrapper-experience-builder/raw/master/builder-screencast.mp4)) | ||
|
|
||
| ## Quick Start - Download | ||
|
|
||
| 1. [Download](https://developers.arcgis.com/downloads/apis-and-sdks?product=arcgis-experience-builder) and unzip [Experience Builder Developer Edition](https://developers.arcgis.com/experience-builder/). | ||
| 2. Download the latest [release](https://github.com/gavinr/js-api-widget-wrapper-experience-builder/releases) from this repository. | ||
| 3. Unzip the downloaded files, and copy the `js-api-widget-wrapper` folder into the `client\your-extensions\widgets\js-api-widget-wrapper` folder of the extracted Experience Builder files. | ||
|
|
||
| ## Quick Start - Git | ||
|
|
||
| 1. [Download](https://developers.arcgis.com/downloads/apis-and-sdks?product=arcgis-experience-builder) and unzip [Experience Builder Developer Edition](https://developers.arcgis.com/experience-builder/). | ||
| 2. Open a new terminal window and browse to the `client` folder. | ||
| 3. `git clone https://github.com/gavinr/js-api-widget-wrapper-experience-builder` | ||
| 4. `npm ci` | ||
| 5. `npm start` | ||
| 6. Start Experience Builder server per the instructions (in a separate terminal, `cd server`, `npm ci`, `npm start`) | ||
|
|
||
| ## Development | ||
|
|
||
| 1. Open the `client` folder as a project in VS Code (or similar code editor). | ||
| 1. Make sure *both* scripts are running (in the `server` folder and `client`) folder). | ||
| 1. Every time you make a change to your widget, it will be re-built with webpack automatically. | ||
|
|
||
| ## More | ||
|
|
||
| View my other Experience Builder projects [here](https://github.com/gavinr?tab=repositories&q=experience-builder). | ||
|
|
||
| View another example of using a JS API widget within Experience Builder [here](https://developers.arcgis.com/experience-builder/sample-code/widgets/js-api-widget/) and [here](https://developers.arcgis.com/experience-builder/sample-code/widgets/editor/). | ||
| The ideas from this code have been moved into the offical Experience Builder samples repo, [here](https://developers.arcgis.com/experience-builder/sample-code/widgets/js-api-widget/) and [here](https://developers.arcgis.com/experience-builder/sample-code/widgets/editor/). Please see those for examples on how to include widgets from the ArcGIS API for JavaScript within you Experience Builder widgets. |