Update docs

This commit is contained in:
Fawad Mirzad
2020-10-19 17:09:15 +02:00
parent 0d3f550c8a
commit 34dbed6f85
5 changed files with 55 additions and 69 deletions

View File

@@ -2,30 +2,40 @@
## Install
to install it via NPM
```bash
npm install -S @fawmi/vue-google-maps
```
You can also install via Yarn
```bash
yarn add @fawmi/vue-google-maps
```
## Example
Here is a basic example
This is the base Map component. If no props are provided, it shows an empty map component with default controls.
```javascript
import { createApp } from 'vue'
import googleMap from '@fawmi/vue-google-maps'
import App from './App.vue';
const googleMapOption = {
apiKey: 'here_comes_your_api_key',
}
const app = createApp(App);
app.use(googleMap, googleMapOption)
app.mount('#app')
<GoogleMap />
```
## Provide your own style
You can provide custom map styling as prop.
You can generate custom map styles at [https://mapstyle.withgoogle.com/](https://mapstyle.withgoogle.com/)
```javascript
<GoogleMap
:style="mapStyles"
/>
```
## Disable ui elements
You can disable all ui components at once
```javascript
<GoogleMap
:disableDefaultUI="true"
/>
```
You can also disable specific UI components
```vue
<GoogleMap
:options="{
zoomControl: true,
mapTypeControl: true,
scaleControl: true,
streetViewControl: true,
rotateControl: true,
fullscreenControl: true,
}"
/>
```