Skip to content

Commit 18d2fa7

Browse files
HusamElbashirclaude
andcommitted
docs: add deprecation notices for Marker and HeatmapLayer components
- Mark Marker component as deprecated (deprecated Feb 2024) - Mark HeatmapLayer component as deprecated (deprecated May 2025) - Add TypeScript @deprecated annotations with migration guidance - Update README with GitHub-style warning alerts - Update VitePress documentation with warning containers - Add deprecation badges to component lists and table of contents Follows Google Maps JavaScript API deprecation timeline: - Marker API deprecated Feb 2024, migrate to AdvancedMarker - HeatmapLayer deprecated May 2025, migrate to deck.gl (sunset May 2026) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 52816cf commit 18d2fa7

File tree

6 files changed

+31
-5
lines changed

6 files changed

+31
-5
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Note: Please refer to the [documentation site](https://vue3-google-map.com/) for
1616
- [Your First Map](#your-first-map)
1717
- [Components](#components)
1818
- [Advanced Marker](#advanced-marker)
19-
- [Marker](#marker)
19+
- [Marker](#marker) ⚠️ **Deprecated**
2020
- [Polyline](#polyline)
2121
- [Polygon](#polygon)
2222
- [Rectangle](#rectangle)
@@ -25,7 +25,7 @@ Note: Please refer to the [documentation site](https://vue3-google-map.com/) for
2525
- [Custom Marker](#custom-marker)
2626
- [Custom Control](#custom-control)
2727
- [Marker Cluster](#marker-cluster)
28-
- [Heatmap Layer](#heatmap-layer)
28+
- [Heatmap Layer](#heatmap-layer) ⚠️ **Deprecated**
2929
- [Advanced Usage](#advanced-usage)
3030
- [Contribution](#contribution)
3131
- [License](#license)
@@ -87,7 +87,7 @@ This library is intended to be used in a composable fashion. Therefore you will
8787
The main mapping component is `GoogleMap`, however the following components are available at your disposal:
8888

8989
- [AdvancedMarker](#advanced-marker)
90-
- [Marker](#marker)
90+
- [Marker](#marker) ⚠️ **Deprecated** - Use AdvancedMarker instead
9191
- [Polyline](#polyline)
9292
- [Polygon](#polygon)
9393
- [Rectangle](#rectangle)
@@ -96,6 +96,7 @@ The main mapping component is `GoogleMap`, however the following components are
9696
- [CustomMarker](#custom-marker)
9797
- [CustomControl](#custom-control)
9898
- [MarkerCluster](#marker-cluster)
99+
- [HeatmapLayer](#heatmap-layer) ⚠️ **Deprecated**
99100

100101
### Advanced Marker
101102

@@ -157,6 +158,9 @@ You can listen for [the following events](https://developers.google.com/maps/doc
157158

158159
### Marker
159160

161+
> [!WARNING]
162+
> **DEPRECATED:** The `Marker` component is deprecated as of February 2024. Please use the [`AdvancedMarker`](#advanced-marker) component instead for new projects. The legacy `google.maps.Marker` API will be removed in a future version. [Learn more about the deprecation](https://developers.google.com/maps/deprecations#googlemapsmarker_in_the_deprecated_as_of_february_2024).
163+
160164
Use the `Marker` component to draw markers, drop pins or any custom icons on a map.
161165

162166
#### Options
@@ -709,6 +713,9 @@ You can listen for [the following events](https://googlemaps.github.io/js-marker
709713

710714
### Heatmap Layer
711715

716+
> [!WARNING]
717+
> **DEPRECATED:** The `HeatmapLayer` component was deprecated on **May 27, 2025** and will be sunset in **May 2026**. Google recommends migrating to third-party library integrations like [deck.gl](https://deck.gl/), which offers a HeatmapLayer implementation. [Learn more about the deprecation](https://developers.google.com/maps/deprecations).
718+
712719
Use the `HeatmapLayer` component to depict the intensity of data at geographical points on the map. Make sure to include the `visualization` library in the `libraries` prop of the `GoogleMap` component.
713720

714721
#### Options

docs/components/heatmap-layer.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ const heatmapData = [
2525

2626
# Heatmap Layer
2727

28+
::: warning DEPRECATED
29+
The `HeatmapLayer` component was deprecated on **May 27, 2025** and will be sunset in **May 2026**. Google recommends migrating to third-party library integrations like [deck.gl](https://deck.gl/), which offers a HeatmapLayer implementation. [Learn more about the deprecation](https://developers.google.com/maps/deprecations).
30+
:::
31+
2832
Use the `HeatmapLayer` component to depict the intensity of data at geographical points on the map. Make sure to include the `visualization` library in the `libraries` prop of the `GoogleMap` component.
2933

3034
## Options

docs/components/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This library is intended to be used in a composable fashion. Therefore you will
55
The main mapping component is `GoogleMap`, however the following components are available at your disposal:
66

77
- [AdvancedMarker](./advanced-marker.md)
8-
- [Marker](./marker.md)
8+
- [Marker](./marker.md) ⚠️ **Deprecated** - Use AdvancedMarker instead
99
- [Polyline](./polyline.md)
1010
- [Polygon](./polygon.md)
1111
- [Rectangle](./rectangle.md)
@@ -14,4 +14,4 @@ The main mapping component is `GoogleMap`, however the following components are
1414
- [Custom Marker](./custom-marker.md)
1515
- [Custom Control](./custom-control.md)
1616
- [Marker Cluster](./marker-cluster.md)
17-
- [Heatmap Layer](./heatmap-layer.md)
17+
- [Heatmap Layer](./heatmap-layer.md) ⚠️ **Deprecated**

docs/components/marker.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ const center = { lat: 40.689247, lng: -74.044502 }
77

88
# Marker
99

10+
::: warning DEPRECATED
11+
The `Marker` component is deprecated as of February 2024. Please use the [`AdvancedMarker`](./advanced-marker.md) component instead for new projects. The legacy `google.maps.Marker` API will be removed in a future version. [Learn more about the deprecation](https://developers.google.com/maps/deprecations#googlemapsmarker_in_the_deprecated_as_of_february_2024).
12+
:::
13+
1014
Use the `Marker` component to draw markers, drop pins or any custom icons on a map.
1115

1216
## Options

src/components/HeatmapLayer.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ interface ExtendedHeatmapLayerOptions extends Omit<HeatmapLayerOptions, "data">
88
data: HeatmapLayerOptions["data"] | (google.maps.LatLngLiteral | { location: google.maps.LatLngLiteral })[];
99
}
1010

11+
/**
12+
* @deprecated The HeatmapLayer component was deprecated on May 27, 2025 and will be sunset in May 2026.
13+
* Google recommends migrating to third-party library integrations like deck.gl, which offers a HeatmapLayer implementation.
14+
* @see {@link https://developers.google.com/maps/deprecations} for more information.
15+
*/
1116
export default defineComponent({
1217
name: "HeatmapLayer",
1318
props: {

src/components/Marker.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ const markerEvents = [
2828
"visible_changed",
2929
];
3030

31+
/**
32+
* @deprecated The Marker component is deprecated as of February 2024. Use AdvancedMarker instead.
33+
* The google.maps.Marker API is deprecated and will be removed in a future version.
34+
* Migrate to AdvancedMarker for the latest features and better performance.
35+
* @see {@link https://developers.google.com/maps/deprecations} for more information.
36+
*/
3137
export default defineComponent({
3238
name: "Marker",
3339
props: {

0 commit comments

Comments
 (0)