https://github.com/scaccogatto/vue-geolocation

ask to your users their coordinates, and wrap them into a Promise
https://github.com/scaccogatto/vue-geolocation

geolocation promise vue

Last synced: 2 days ago
JSON representation

ask to your users their coordinates, and wrap them into a Promise

• Host: GitHub
• URL: https://github.com/scaccogatto/vue-geolocation
• Owner: scaccogatto
• License: mit
• Created: 2017-03-31T09:58:08.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-11T12:07:53.000Z (almost 3 years ago)
• Last Synced: 2024-09-19T01:13:35.737Z (15 days ago)
• Topics: geolocation, promise, vue
• Language: JavaScript
• Homepage:
• Size: 68.4 KB
• Stars: 88
• Watchers: 4
• Forks: 15
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-geolocation

> ask to your users their coordinates, and wrap them into a Promise

[![Build Status](https://travis-ci.org/scaccogatto/vue-geolocation.svg?branch=master)](https://travis-ci.org/scaccogatto/vue-geolocation)

## Plugin install

```sh

yarn add vue-browser-geolocation

````

or

```sh

npm install vue-browser-geolocation

````

in  your main.js

```

import VueGeolocation from 'vue-browser-geolocation';

Vue.use(VueGeolocation);

```

## Usage

Inside a Vue Component

```

this.$getLocation(options)

  .then(coordinates => {

    console.log(coordinates);

  });

```

Will prompt a [Geolocation Request](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/Using_geolocation)

or to watch a location

```

this.$watchLocation(options)

  .then(coordinates => {

    console.log(coordinates);

  })

```

you can clear the watcher

```

this.$clearLocationWatch(watchID)

```

please refer to the Geolocation docs to reference how to get a watchID

### Options

See [PositionOptions](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions)

#### Example

```

this.$getLocation({

	enableHighAccuracy: bool, //defaults to false

	timeout: Infinity, //defaults to Infinity

	maximumAge: int //defaults to 0

	

})

  .then(coordinates => {

    console.log(coordinates);

  });

```

### Forcing failure in automated testing

If you need to setup automated testing in your application, and you need to force failure of geolocation to test how your application behaves, you can pass a second argument (forceReject) to this.$getGelocation and this.$watchLocation:

```

this.$getLocation(positionOptions, forceReject)

this.$watchLocation(positionOptions, forceReject)

```

if the parameter is `true`, the promise will be rejected with a special error message.