Commit 17ffd6d7 authored by Fawad Mirzad's avatar Fawad Mirzad
Browse files

Improve docs

parent 16ad627d
Loading
Loading
Loading
Loading
+2 −7
Original line number Diff line number Diff line
@@ -43,22 +43,18 @@ module.exports = {
        link: 'https://github.com/fawmi/vue-google-maps.git'
      }
    ],
    sidebarDepth: 0,
    collapsable: false,
    sidebar: [
      {
        title: 'Getting started',
        path: '/docs/',
        sidebarDepth: 0,
        collapsable: false,
        children: [
        ]
      },
      {
        title: 'Components',
        collapsable: false,
        path: '/components/',
        sidebarDepth: 0,
        children: [
          '/components/introduction',
          '/components/map',
          '/components/marker',
          '/components/info-window',
@@ -69,7 +65,6 @@ module.exports = {
      },
      {
        title: 'Advanced',
        collapsable: false,
        path: '/advanced/',
        sidebarDepth: 0,
        children: [
+1 −0
Original line number Diff line number Diff line
# Components
[[toc]]

`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.

+2 −0
Original line number Diff line number Diff line
# Cluster
[[toc]]
## Cluster your markers
To cluster objects you simply wrap your markers with the cluster component.


+2 −0
Original line number Diff line number Diff line
# 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>
+0 −19
Original line number Diff line number Diff line
# 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)
Loading