Improve docs

This commit is contained in:
Fawad Mirzad
2021-02-14 13:33:59 +01:00
parent 16ad627d9b
commit 17ffd6d779
12 changed files with 14 additions and 148 deletions

View File

@@ -1,4 +1,5 @@
# Components
[[toc]]
`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.

View File

@@ -1,4 +1,6 @@
# Cluster
[[toc]]
## Cluster your markers
To cluster objects you simply wrap your markers with the cluster component.

View File

@@ -1,4 +1,6 @@
# Info Window
[[toc]]
## Add info window to your components
You can create info window by passing custom HTML or Vue components as the child of `Marker` component.
```vue
<GMapMap>

View File

@@ -1,19 +0,0 @@
# Components
`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.
Currently `Map`, `Marker`, `InfoWindow`, `Cluster`, `Polygon` and `Rectangle` are supported.
Checkout the docs page for each component to see how to use it.
[Map](./map.md)
[Marker](./marker.md)
[InfoWindow](./info-window.md)
[Cluster](./cluster.md)
[Polygon](./polygon.md)
[Rectangle](./rectangle.md)

View File

@@ -1,5 +1,5 @@
# Map
[[toc]]
## Install
This is the base Map component. If no props are provided, it shows an empty map component with default controls.

View File

@@ -1,5 +1,7 @@
# Marker
[[toc]]
## Add marker to your components
With a marker, you can show specific locations on the map
```vue
<template>

View File

@@ -1,2 +1,4 @@
# Polygon
[[toc]]
Polygon is a simple wrapper around google's polygon component.

View File

@@ -1,3 +1,4 @@
# Rectangle
[[toc]]
Polygon is a simple wrapper around google's polygon component.