vue-google-autocomplete
Advanced tools
A Vue.js (2.x) autosuggest component for the Google Maps Places API.
Live demo: olefirenko.github.io/vue-google-autocomplete
I have tried to use different Vue Google Autocomplete components, but did not find any that would solve my needs. So below I would like to mention what you can get from this exact component:
This component uses Google Maps Places API to get geo suggests for autocompletion, so you have to include the Google Maps Places API in the <head> of your HTML:
<!DOCTYPE html>
<html>
<head>
…
<script src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY_HERE&libraries=places"></script>
</head>
<body>
…
</body>
</html>
To obtain API key please visit the Google Developer Console. The API's that you have to enable in your Google API Manager Dashboard are Google Maps Geocoding API, Google Places API Web Service and Google Maps Javascript API.
The easiest way to use Vue Google Autocomplete is to install it from npm or yarn.
npm install vue-google-autocomplete --save
Or
yarn add vue-google-autocomplete
The Vue Google Autocomplete works out of the box by just including it.
import VueGoogleAutocomplete from "vue-google-autocomplete";
In your template you can use this syntax:
<vue-google-autocomplete id="map" classname="form-control" placeholder="Start typing" v-on:placechanged="getAddressData">
</vue-google-autocomplete>
Type: String
required ID for the input container.
Type: String
Class to the input container.
Type: String
Default: Start typing
The input field will get this placeholder text.
Type: String
Default: address
Types supported in place autocomplete requests. More info
You may find this example helpful.
Type: Array
Default: ['address_components', 'adr_address', 'alt_id', 'formatted_address', 'geometry', 'icon', 'id', 'name', 'permanently_closed', 'photo', 'place_id', 'scope', 'type', 'url', 'utc_offset', 'vicinity']
Set which data fields to return in the PlaceResult from the Google Autocomplete API when the user selects a place. Google Autocomplete API by default returns all available data fields for the selected place, which may result in additional charges and thus the API users might pay for data they don't need. This package sets a sensible default for the fields value, fetching only the Basic Data fields which do not result in any additional charges. If you want to fetch other fields in addition to the default ones, make sure that the array you pass in to the fields prop contains the default fields listed above, and not only the additional fields you want to fetch.
Refer to this page for more details on how certain data fields are billed.
Type: String|Array
Default: null
Option to restrict the autocomplete search to a particular country. Countries must be passed as a two-character, ISO 3166-1 Alpha-2 compatible country code (i.e. "br", "sg", "fr"). You can provide a single one, or an array of up to 5 country code strings.
Note: this is a dynamic property. You must pass it as :country="" to your component, otherwise it won't work. For example:
<vue-google-autocomplete :country="['au', 'nz']"></vue-google-autocomplete>
will restrict the countries to Australia and New Zealand.
Type: Boolean
Default: false
Bias the search towards user current location.
Type: Object
Default: {}
Allow to configure Options for navigator.getCurrentPosition
The component emits next events, which you can listen in your application:
Gets triggered when the address data got obtained. This data is available on the returned objects:
street_number, route, locality, administrative_area_level_1, country, postal_code, latitude, longitude.place - PlaceResult object is available as second parameter.id a String representing the ID of the autocomplete that triggered the event.Gets triggered when a user entered the name of a Place that was not suggested and pressed the Enter key, or the Place Details request failed.
object an object with a key name representing the user's input.Gets triggered when the autocomplete input field receives focus.
Gets triggered when the autocomplete input field loses focus.
Gets triggered every time autocomplete input got changed
Gets triggered when the autocomplete results got changed
Gets triggered when a key gets pressed
Gets triggered when an error is encountered
These functions are accessible by setting "ref" on the component (Refs documentation). See example below how to use these functions.
Call to clear the value of the user input.
Call focus to focus on the element
Call blur to blur (unfocus) the element
Call to update the user input with a new value
Call to force coordinates and update the input accordingly
Call to retrieve current position from navigator and update the input accordingly
Please note that you need to provide what method will listen (v-on:placechanged) to an event when the address data is obtained.
<template>
<div>
<h2>Your Address</h2>
<vue-google-autocomplete
ref="address"
id="map"
classname="form-control"
placeholder="Please type your address"
v-on:placechanged="getAddressData"
country="sg"
>
</vue-google-autocomplete>
</div>
</template>
<script>
import VueGoogleAutocomplete from "vue-google-autocomplete";
export default {
components: { VueGoogleAutocomplete },
data: function () {
return {
address: "",
};
},
mounted() {
// To demonstrate functionality of exposed component functions
// Here we make focus on the user input
this.$refs.address.focus();
},
methods: {
/**
* When the location found
* @param {Object} addressData Data of the found location
* @param {Object} placeResultData PlaceResult object
* @param {String} id Input container ID
*/
getAddressData: function (addressData, placeResultData, id) {
this.address = addressData;
},
},
};
</script>
The example below shows the correct usage of the types parameter, when limiting the search to cities:
<vue-google-autocomplete
id="map2"
ref="toAddress"
classname="form-control"
placeholder="Start typing"
v-on:placechanged="getToData"
types="(cities)"
country="us"
>
</vue-google-autocomplete>
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
Vue component to Google Places Autocomplete
The npm package vue-google-autocomplete receives a total of 13,987 weekly downloads. As such, vue-google-autocomplete popularity was classified as popular.
We found that vue-google-autocomplete demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
