依赖文件

2025-03-20 17:35:53 +08:00
parent 634fe57349
commit 021ffc6052
1134 changed files with 137518 additions and 132 deletions
@@ -0,0 +1,117 @@
+# Google Maps JavaScript API Loader
+
+[![npm](https://img.shields.io/npm/v/@googlemaps/js-api-loader)](https://www.npmjs.com/package/@googlemaps/js-api-loader)
+![Build](https://github.com/googlemaps/js-api-loader/workflows/Test/badge.svg)
+![Release](https://github.com/googlemaps/js-api-loader/workflows/Release/badge.svg)
+[![codecov](https://codecov.io/gh/googlemaps/js-api-loader/branch/main/graph/badge.svg)](https://codecov.io/gh/googlemaps/js-api-loader)
+![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-api-loader?color=green)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)](https://discord.gg/jRteCzP)
+
+## Description
+Load the Google Maps JavaScript API script dynamically. This takes inspiration from the [google-maps](https://www.npmjs.com/package/google-maps) npm package but updates it with ES6, Promises, and TypeScript.
+
+## Install
+
+Available via npm as the package [@googlemaps/js-api-loader](https://www.npmjs.com/package/@googlemaps/js-api-loader).
+
+```sh
+npm i @googlemaps/js-api-loader
+```
+
+Alternatively you may add the umd package directly to the html document using the unpkg link.
+
+```html
+<script src="https://unpkg.com/@googlemaps/js-api-loader@1.x/dist/index.min.js"></script>
+```
+
+When adding via unpkg, the loader can be accessed at `google.maps.plugins.loader.Loader`.
+
+### TypeScript 
+
+TypeScript users need to install the following types package.
+
+```sh
+npm i -D @types/google.maps
+```
+
+## Documentation
+
+The reference documentation can be found at this [link](https://googlemaps.github.io/js-api-loader/index.html). The Google Maps JavaScript API [documentation](https://developers.google.com/maps/documentation/javascript/tutorial) is the authoritative source for the loader options.
+
+
+## Example
+
+```javascript
+import { Loader } from '@googlemaps/js-api-loader';
+
+const loader = new Loader({
+  apiKey: "",
+  version: "weekly",
+  libraries: ["places"]
+});
+
+const mapOptions = {
+  center: {
+    lat: 0,
+    lng: 0
+  },
+  zoom: 4
+};
+
+```
+
+Using a promise for a specific library.
+
+```javascript
+// Promise for a specific library
+loader
+  .importLibrary('maps')
+  .then(({Map}) => {
+    new Map(document.getElementById("map"), mapOptions);
+  })
+  .catch((e) => {
+    // do something
+  });
+```
+
+Using a promise for when the script has loaded.
+
+```javascript
+// Promise
+loader
+  .load()
+  .then((google) => {
+    new google.maps.Map(document.getElementById("map"), mapOptions);
+  })
+  .catch(e => {
+    // do something
+  });
+```
+
+Alternatively, if you want to use a callback.
+
+```javascript
+// Callback
+loader.loadCallback(e => {
+  if (e) {
+    console.log(e);
+  } else {
+    new google.maps.Map(document.getElementById("map"), mapOptions);
+  }
+});
+```
+
+View the package in action [here](https://googlemaps.github.io/js-api-loader/examples/index.html).
+
+
+## Support
+
+This library is community supported. We're comfortable enough with the stability and features of
+the library that we want you to build real production applications on it.
+
+If you find a bug, or have a feature suggestion, please [log an issue][issues]. If you'd like to
+contribute, please read [How to Contribute][contrib].
+
+[issues]: https://github.com/googlemaps/js-api-loader/issues
+[contrib]: https://github.com/googlemaps/js-api-loader/blob/main/CONTRIBUTING.md