Skip to content

Commit

Permalink
Merge pull request #469 from Esri/fix/peer-dependencies
Browse files Browse the repository at this point in the history
make @esri/arcis-rest-* `peerDependencies` of @esri/cedar
  • Loading branch information
tomwayson authored May 7, 2019
2 parents f7a4bd6 + 10def8a commit fc6bc89
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 5,040 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,16 @@ You are looking at the documentation for v1.x of cedar. You can also view the [d

You can install cedar and it's [dependencies](#dependencies) from npm:
```bash
npm install @esri/arcgis-rest-feature-layer@^2.0.0
npm install @esri/arcgis-rest-request@^2.0.0
npm install @esri/cedar
```

or yarn:

```bash
yarn add @esri/arcgis-rest-feature-layer@^2.0.0
yarn add @esri/arcgis-rest-request@^2.0.0
yarn add @esri/cedar
```

Expand Down Expand Up @@ -164,7 +168,7 @@ You can also see how to use cedar with the [ArcGIS API for JavaScript](https://d

## Dependencies

Cedar isn't yet another JavaScript charting library. Instead, cedar is a very thin wrapper around other libraries that do the heavy lifting. Cedar uses [amCharts](https://www.amcharts.com/javascript-charts/) library as it's charting engine. Cedar also uses [@esri/arcgis-rest-feature-layer](https://esri.github.io/arcgis-rest-js/api/feature-layer/) and [@esri/arcgis-rest-request](https://esri.github.io/arcgis-rest-js/api/request/) to query feature data. You will need to include these libraries along with cedar in your application. If you [install cedar using npm or yarn](#installing-cedar) these libraries will be installed for you, but you will have to make sure that your module bundler can resolve and include them in your application. If you are loading cedar from a CDN, please refer to the [loading cedar](#loading-cedar) section above for the `<script>` tags that you will need to include.
Cedar isn't yet another JavaScript charting library. Instead, cedar is a very thin wrapper around other libraries that do the heavy lifting. Cedar uses [amCharts](https://www.amcharts.com/javascript-charts/) library as it's charting engine. Cedar also uses [@esri/arcgis-rest-feature-layer](https://esri.github.io/arcgis-rest-js/api/feature-layer/) and [@esri/arcgis-rest-request](https://esri.github.io/arcgis-rest-js/api/request/) to query feature data. You will need to [install](#installing-cedar) these libraries along with cedar in your application. If you are loading cedar from a CDN, please refer to the [loading cedar](#loading-cedar) section above for the `<script>` tags that you will need to include.

Cedar supports the [same browsers as ArcGIS Online](https://doc.arcgis.com/en/arcgis-online/reference/browsers.htm), however you may need to include polyfills for [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) and [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), if your application has to support browers that don't support them (i.e. IE or older versions of Safari/Android).

Expand Down
2 changes: 2 additions & 0 deletions packages/cedar/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

### Fixed
- make @esri/arcis-rest-* `peerDependencies` of @esri/cedar
### Changed
- update README and CHANGELOG for v1.0.0 release

Expand Down
11 changes: 8 additions & 3 deletions packages/cedar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@
"mapCoverage": true
},
"dependencies": {
"@esri/arcgis-rest-feature-layer": "^2.0.0",
"@esri/arcgis-rest-request": "^2.0.0",
"@esri/arcgis-rest-types": "^2.0.0",
"@esri/cedar-amcharts": "^1.0.0"
},
"devDependencies": {
"@esri/arcgis-rest-feature-layer": "^2.0.0",
"@esri/arcgis-rest-request": "^2.0.0",
"@esri/arcgis-rest-types": "^2.0.0",
"@types/jest": "^23.3.1",
"@types/node": "^10.5.7",
"jest": "^23.5.0",
Expand All @@ -85,5 +85,10 @@
"tslint": "^5.5.0",
"typedoc": "^0.13.0",
"typescript": "^3.0.1"
},
"peerDependencies": {
"@esri/arcgis-rest-feature-layer": "^2.0.0",
"@esri/arcgis-rest-request": "^2.0.0",
"@esri/arcgis-rest-types": "^2.0.0"
}
}
Loading

0 comments on commit fc6bc89

Please sign in to comment.