@vis.gl/react-google-maps
Advanced tools
@vis.gl/react-google-maps - npm Package Compare versions
Comparing version 0.11.2 to 1.0.0
@@ -67,5 +67,5 @@ /// <reference types="google.maps" /> | ||
| /** | ||
| * Component to wrap the Google Maps React components and load the Google Maps JavaScript API | ||
| * Component to wrap the components from this library and load the Google Maps JavaScript API | ||
| */ | ||
| export declare const APIProvider: (props: PropsWithChildren<APIProviderProps>) => ReactElement | null; | ||
| export {}; |
@@ -13,4 +13,4 @@ /// <reference types="google.maps" /> | ||
| /** | ||
| * Component to render a Google Maps Info Window | ||
| * Component to render an Info Window with the Maps JavaScript API | ||
| */ | ||
| export declare const InfoWindow: (props: PropsWithChildren<InfoWindowProps>) => React.JSX.Element; |
@@ -17,3 +17,3 @@ /// <reference types="google.maps" /> | ||
| /** | ||
| * Props for the Google Maps Map Component | ||
| * Props for the Map Component | ||
| */ | ||
@@ -20,0 +20,0 @@ export type MapProps = google.maps.MapOptions & MapEventProps & DeckGlCompatProps & { |
@@ -15,3 +15,3 @@ /// <reference types="google.maps" /> | ||
| /** | ||
| * Component to render a Google Maps Marker on a map | ||
| * Component to render a marker on a map | ||
| */ | ||
@@ -18,0 +18,0 @@ export declare const Marker: React.ForwardRefExoticComponent<Omit<google.maps.MarkerOptions, "map"> & MarkerEventProps & React.RefAttributes<google.maps.Marker>>; |
@@ -8,4 +8,4 @@ /// <reference types="google.maps" /> | ||
| /** | ||
| * Component to render a google maps marker Pin View | ||
| * Component to configure the appearance of an AdvancedMarker | ||
| */ | ||
| export declare const Pin: (props: PropsWithChildren<PinProps>) => import("react").ReactPortal; |
| /** | ||
| * Hook to check if the Google Maps API is loaded | ||
| * Hook to check if the Maps JavaScript API is loaded | ||
| */ | ||
| export declare function useApiIsLoaded(): boolean; |
| /** | ||
| * Internally used to bind events to google maps API objects. | ||
| * Internally used to bind events to Maps JavaScript API objects. | ||
| * @internal | ||
| */ | ||
| export declare function useMapsEventListener<T extends (...args: any[]) => void>(target?: object | null, name?: string, callback?: T | null): void; |
@@ -31,3 +31,3 @@ import { APILoadingStatus } from './api-loading-status'; | ||
| /** | ||
| * Loads the Google Maps API with the specified parameters. | ||
| * Loads the Maps JavaScript API with the specified parameters. | ||
| * Since the Maps library can only be loaded once per page, this will | ||
@@ -34,0 +34,0 @@ * produce a warning when called multiple times with different |
| /** | ||
| * Function to limit the tilt range of the google maps map when updating the view state | ||
| * Function to limit the tilt range of the Google map when updating the view state | ||
| */ | ||
| export declare const limitTiltRange: ({ viewState }: any) => any; |
| { | ||
| "name": "@vis.gl/react-google-maps", | ||
| "version": "0.11.2", | ||
| "description": "React components and hooks for Google Maps.", | ||
| "version": "1.0.0", | ||
| "description": "React components and hooks for the Google Maps JavaScript API", | ||
| "source": "src/index.ts", | ||
@@ -47,6 +47,7 @@ "main": "dist/index.umd.js", | ||
| "React", | ||
| "React components", | ||
| "React hooks", | ||
| "React Components", | ||
| "React Hooks", | ||
| "Google Maps", | ||
| "Google Maps components" | ||
| "Google Maps JavaScript API", | ||
| "Maps" | ||
| ], | ||
@@ -53,0 +54,0 @@ "dependencies": { |
@@ -1,23 +0,1 @@ | ||
| > [!IMPORTANT] | ||
| > This project is still in its alpha phase. | ||
| > | ||
| > When using it be aware that things may not yet work as expected and can | ||
| > break at any point. Releases happen often, so when you experience problems, | ||
| > make sure you are using the latest version (check with `npm outdated` in | ||
| > your project) before opening an issue. | ||
| > | ||
| > We are still in a phase where we can easily make bigger changes, so we ask | ||
| > you to please [provide feedback](https://github.com/visgl/react-google-maps/issues/new) | ||
| > on everything you notice - including, but not limited to | ||
| > | ||
| > - developer experience (installation, typings, sourcemaps, framework integration, ...) | ||
| > - hard to understand concepts and APIs | ||
| > - wrong, missing, outdated or inaccurate documentation | ||
| > - use-cases not covered by the API | ||
| > - missing features | ||
| > - and of course any bugs you encounter | ||
| > | ||
| > Also, feel free to use [GitHub discussions](https://github.com/visgl/react-google-maps/discussions) to ask questions or start a new | ||
| > discussion. | ||
| # React Components for the Google Maps JavaScript API | ||
@@ -53,3 +31,3 @@ | ||
| Import the [`APIProvider`][api-provider] and wrap it around all components that should have | ||
| access to the Google Maps API. | ||
| access to the Maps JavaScript API. | ||
| Any component within the context of the `APIProvider` can use the hooks and | ||
@@ -124,3 +102,3 @@ components provided by this library. | ||
| return ( | ||
| <APIProvider apiKey={...}> | ||
| <APIProvider apiKey={'YOUR API KEY HERE'}> | ||
| <MyComponent /> | ||
@@ -137,2 +115,31 @@ </APIProvider> | ||
| ## Terms of Service | ||
| `@vis.gl/react-google-maps` uses Google Maps Platform services. Use of Google | ||
| Maps Platform services through this library is subject to the | ||
| [Google Maps Platform Terms of Service][gmp-tos]. | ||
| This library is not a Google Maps Platform Core Service. | ||
| Therefore, the Google Maps Platform Terms of Service (e.g., Technical | ||
| Support Services, Service Level Agreements, and Deprecation Policy) | ||
| do not apply to this library. | ||
| ## Support | ||
| This library is offered via an open source license. It is not governed by the | ||
| Google Maps Platform [Support Technical Support Services Guidelines][gmp-tssg], | ||
| the [SLA][gmp-sla], or the [Deprecation Policy][gmp-dp] (however, any Google | ||
| Maps Platform services used by this library remain subject to the Google Maps | ||
| Platform Terms of Service). | ||
| If you find a bug, or have a feature request, please [file an issue][rgm-issues] | ||
| on GitHub. If you would like to get answers to technical questions from | ||
| other Google Maps Platform developers, feel free to open a thread in the | ||
| [discussions section on GitHub][rgm-discuss] or ask a question through one of | ||
| our [developer community channels][gmp-community]. | ||
| If you'd like to contribute, please check the [Contributing guide][rgm-contrib]. | ||
| You can also discuss this library on [our Discord server][gmp-discord]. | ||
| [api-provider]: https://visgl.github.io/react-google-maps/docs/api-reference/components/api-provider | ||
@@ -149,1 +156,11 @@ [api-map]: https://visgl.github.io/react-google-maps/docs/api-reference/components/map | ||
| [npm-package]: https://www.npmjs.com/package/@vis.gl/react-google-maps | ||
| [gmp-tos]: https://cloud.google.com/maps-platform/terms | ||
| [gmp-tssg]: https://cloud.google.com/maps-platform/terms/tssg | ||
| [gmp-sla]: https://cloud.google.com/maps-platform/terms/sla | ||
| [gmp-dp]: https://cloud.google.com/maps-platform/terms/other/deprecation-policy | ||
| [rgm-issues]: https://github.com/visgl/react-google-maps/issues | ||
| [rgm-discuss]: https://github.com/visgl/react-google-maps/discussions | ||
| [rgm-contrib]: https://visgl.github.io/react-google-maps/docs/contributing | ||
| [gmp-community]: https://developers.google.com/maps/developer-community | ||
| [gmp-discord]: https://discord.gg/f4hvx8Rp2q | ||
| import {useApiLoadingStatus} from './use-api-loading-status'; | ||
| import {APILoadingStatus} from '../libraries/api-loading-status'; | ||
| /** | ||
| * Hook to check if the Google Maps API is loaded | ||
| * Hook to check if the Maps JavaScript API is loaded | ||
| */ | ||
@@ -6,0 +6,0 @@ export function useApiIsLoaded(): boolean { |
@@ -5,3 +5,3 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ | ||
| /** | ||
| * Internally used to bind events to google maps API objects. | ||
| * Internally used to bind events to Maps JavaScript API objects. | ||
| * @internal | ||
@@ -8,0 +8,0 @@ */ |
@@ -40,3 +40,3 @@ import {APILoadingStatus} from './api-loading-status'; | ||
| /** | ||
| * Loads the Google Maps API with the specified parameters. | ||
| * Loads the Maps JavaScript API with the specified parameters. | ||
| * Since the Maps library can only be loaded once per page, this will | ||
@@ -43,0 +43,0 @@ * produce a warning when called multiple times with different |
@@ -22,3 +22,3 @@ const mapLinear = (x: number, a1: number, a2: number, b1: number, b2: number) => | ||
| /** | ||
| * Function to limit the tilt range of the google maps map when updating the view state | ||
| * Function to limit the tilt range of the Google map when updating the view state | ||
| */ | ||
@@ -25,0 +25,0 @@ // eslint-disable-next-line @typescript-eslint/no-explicit-any |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Fixed alerts
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.23%
538177
- Lines of code
- increased by0.04%
7203
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by11.64%
163