JSDOCS.md

Vuetify Google Autocomplete

For more detailed HTML output of the JSDocs, refer to the ./docs directory.

vuetify-google-autocomplete

Author: Madimetja Shika [email protected]

• vuetify-google-autocomplete
  • .props
    • .addressComponents
    • .append-icon : String
    • .append-outer-icon : Boolean
    • .autofocus : Boolean
    • .background-color : Boolean
    • .browserAutocomplete : String
    • .clear-icon : Boolean
    • .clearable : Boolean
    • .color : String
    • .counter : Boolean | Number | String
    • .country : String | Array
    • .dark : Boolean
    • .dense : Boolean
    • .disabled : Boolean
    • .enable-geolocation : Boolean
    • .error : Boolean
    • .error-count : Boolean
    • .error-messages : Array
    • .filled : Array
    • .fields : String | Array
    • .flat : Boolean
    • .full-width : Boolean
    • .hide-details : Boolean
    • .hint : String
    • .id : String
    • .label : String
    • .light : Boolean
    • .loader-height : Boolean | String
    • .loading : Boolean | String
    • .loading : Boolean | String
    • .mask : Object | String
    • .no-resize : Boolean
    • .outlined : Boolean
    • .persistent-hint : Boolean
    • .placeholder : String
    • .placeName : Boolean
    • .prefix : String
    • .prepend-icon : String
    • .prepend-inner-icon : String
    • .readonly : Boolean
    • .required : Boolean
    • .return-masked-value : Boolean
    • .reverse : Boolean
    • .rounded : Boolean
    • .rows : Number | String
    • .rules : Array
    • .shaped : Array
    • .single-line : Boolean
    • .solo : Boolean
    • .solo-inverted : Boolean
    • .spellcheck : String
    • .suffix : String
    • .success : String
    • .success-messages : String
    • .tabindex : *
    • .textarea : Boolean
    • .toggle-keys : Array
    • .type : String
    • .types : String
    • .validate-on-blur : Boolean
    • .value : String
  • .data
  • .methods
  • .created
  • .mounted
  • .destroyed
  • .render
  • .watch
    • .autocompleteText()
    • .country()
    • .fields()
    • .enableGeolocation()
    • .types()
  • .name
  • .autocapitalize : Boolean
  • .autocorrect : Boolean

vuetify-google-autocomplete.props

Exposed component props.

Kind: static mixin of vuetify-google-autocomplete

• .props
  • .addressComponents
  • .append-icon : String
  • .append-outer-icon : Boolean
  • .autofocus : Boolean
  • .background-color : Boolean
  • .browserAutocomplete : String
  • .clear-icon : Boolean
  • .clearable : Boolean
  • .color : String
  • .counter : Boolean | Number | String
  • .country : String | Array
  • .dark : Boolean
  • .dense : Boolean
  • .disabled : Boolean
  • .enable-geolocation : Boolean
  • .error : Boolean
  • .error-count : Boolean
  • .error-messages : Array
  • .filled : Array
  • .fields : String | Array
  • .flat : Boolean
  • .full-width : Boolean
  • .hide-details : Boolean
  • .hint : String
  • .id : String
  • .label : String
  • .light : Boolean
  • .loader-height : Boolean | String
  • .loading : Boolean | String
  • .loading : Boolean | String
  • .mask : Object | String
  • .no-resize : Boolean
  • .outlined : Boolean
  • .persistent-hint : Boolean
  • .placeholder : String
  • .placeName : Boolean
  • .prefix : String
  • .prepend-icon : String
  • .prepend-inner-icon : String
  • .readonly : Boolean
  • .required : Boolean
  • .return-masked-value : Boolean
  • .reverse : Boolean
  • .rounded : Boolean
  • .rows : Number | String
  • .rules : Array
  • .shaped : Array
  • .single-line : Boolean
  • .solo : Boolean
  • .solo-inverted : Boolean
  • .spellcheck : String
  • .suffix : String
  • .success : String
  • .success-messages : String
  • .tabindex : *
  • .textarea : Boolean
  • .toggle-keys : Array
  • .type : String
  • .types : String
  • .validate-on-blur : Boolean
  • .value : String

props.addressComponents

Select Address Types and Address Component Types https://developers.google.com/maps/documentation/javascript/geocoding#GeocodingAddressTypes

Kind: static property of props

props.append-icon : String

Maps to Vuetify 'append-icon' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.append-outer-icon : Boolean

Maps to Vuetify 'append-outer-icon' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.autofocus : Boolean

Maps to Vuetify 'autofocus' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.background-color : Boolean

Maps to Vuetify 'background-color' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.browserAutocomplete : String

Maps to Vuetify 'browser-autocomplete' prop.

Kind: static property of props
Default: 'off'
See: https://vuetifyjs.com/en/components/text-fields

props.clear-icon : Boolean

Maps to Vuetify 'clear-icon' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.clearable : Boolean

Maps to Vuetify 'clearable' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.color : String

Maps to Vuetify 'color' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.counter : Boolean | Number | String

Maps to Vuetify 'counter' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.country : String | Array

Restrict the autocomplete search to a particular country or set of countries.

Kind: static property of props
See: https://developers.google.com/places/web-service/autocomplete

props.dark : Boolean

Maps to Vuetify 'dark' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.dense : Boolean

Maps to Vuetify 'dense' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.disabled : Boolean

Maps to Vuetify 'disabled' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.enable-geolocation : Boolean

Bias the search towards user's current location.

Kind: static property of props
See: https://developers.google.com/places/web-service/autocomplete

props.error : Boolean

Maps to Vuetify 'error' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.error-count : Boolean

Maps to Vuetify 'error-count' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.error-messages : Array

Maps to Vuetify 'error-messages' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.filled : Array

Maps to Vuetify 'filled' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.fields : String | Array

Fields to be included for the Place in the details response when the details are successfully retrieved, which will be billed for.

Kind: static property of props
See: https://developers.google.com/maps/documentation/javascript/reference/places-widget#AutocompleteOptions.fields

props.flat : Boolean

Maps to Vuetify 'flat' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.full-width : Boolean

Maps to Vuetify 'full-width' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.hide-details : Boolean

Maps to Vuetify 'hide-details' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.hint : String

Maps to Vuetify 'hint' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.id : String

ID Attribute for the text field. Is required.

Kind: static property of props

props.label : String

Maps to Vuetify 'label' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.light : Boolean

Maps to Vuetify 'light' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.loader-height : Boolean | String

Maps to Vuetify 'loader-height' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.loading : Boolean | String

Maps to Vuetify 'loading' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.loading : Boolean | String

Maps to Vuetify 'loading' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.mask : Object | String

Maps to Vuetify 'mask' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.no-resize : Boolean

Maps to Vuetify 'no-resize' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.outlined : Boolean

Maps to Vuetify 'outlined' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.persistent-hint : Boolean

Maps to Vuetify 'persistent-hint' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.placeholder : String

Maps to Vuetify 'placeholder' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.placeName : Boolean

Display place name when selecting a result

Kind: static property of props
See: https://developers.google.com/places/web-service/autocomplete

props.prefix : String

Maps to Vuetify 'prefix' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.prepend-icon : String

Maps to Vuetify 'prepend-icon' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.prepend-inner-icon : String

Maps to Vuetify 'prepend-inner-icon' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.readonly : Boolean

Maps to Vuetify 'readonly' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.required : Boolean

Maps to Vuetify 'required' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.return-masked-value : Boolean

Maps to Vuetify 'return-masked-value' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.reverse : Boolean

Maps to Vuetify 'reverse' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.rounded : Boolean

Maps to Vuetify 'rounded' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.rows : Number | String

Maps to Vuetify 'rows' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.rules : Array

Maps to Vuetify 'rules' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.shaped : Array

Maps to Vuetify 'shaped' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.single-line : Boolean

Maps to Vuetify 'single-line' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.solo : Boolean

Maps to Vuetify 'solo' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.solo-inverted : Boolean

Maps to Vuetify 'solo-inverted' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.spellcheck : String

Maps to native HTML5 spellcheck attribute.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.suffix : String

Maps to Vuetify 'suffix' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.success : String

Maps to Vuetify 'success' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.success-messages : String

Maps to Vuetify 'success-messages' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.tabindex : *

Maps to Vuetify 'tabindex' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.textarea : Boolean

Maps to Vuetify 'textarea' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.toggle-keys : Array

Maps to Vuetify 'toggle-keys' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.type : String

Maps to Vuetify 'type' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.types : String

Types supported in place autocomplete requests.

Kind: static property of props
See

• https://developers.google.com/places/supported_types#table3
• https://developers.google.com/places/web-service/autocomplete

props.validate-on-blur : Boolean

Maps to Vuetify 'validate-on-blur' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

props.value : String

Maps to Vuetify 'value' prop.

Kind: static property of props
See: https://vuetifyjs.com/en/components/text-fields

vuetify-google-autocomplete.data

See code for members.

Kind: static mixin of vuetify-google-autocomplete

vuetify-google-autocomplete.methods

See code for members.

Kind: static mixin of vuetify-google-autocomplete

vuetify-google-autocomplete.created

Updates the autocompleteText member if a v-model was provided.

Kind: static mixin of vuetify-google-autocomplete

vuetify-google-autocomplete.mounted

Loads the Google Autocomplete SDK.

Kind: static mixin of vuetify-google-autocomplete

vuetify-google-autocomplete.destroyed

Resets the autocomplete loaded state.

Kind: static mixin of vuetify-google-autocomplete

vuetify-google-autocomplete.render

See code.

Kind: static mixin of vuetify-google-autocomplete

vuetify-google-autocomplete.watch

Kind: static mixin of vuetify-google-autocomplete

• .watch
  • .autocompleteText()
  • .country()
  • .fields()
  • .enableGeolocation()
  • .types()

watch.autocompleteText()

Emit the new autocomplete text whenever it changes.

Kind: static method of watch

watch.country()

Update the SDK country option whenever it changes from the parent.

Kind: static method of watch

watch.fields()

Update the SDK fields option whenever it changes from the parent.

Kind: static method of watch

watch.enableGeolocation()

Watches for changes on the Geolocation option.

Kind: static method of watch

watch.types()

Update the SDK types option whenever it changes from the parent.

Kind: static method of watch

vuetify-google-autocomplete.name

Component name. Returns 'vuetify-google-autocomplete'.

Kind: static property of vuetify-google-autocomplete

vuetify-google-autocomplete.autocapitalize : Boolean

Maps to native HTML5 autocapitalize attribute.

Kind: static property of vuetify-google-autocomplete
See: https://vuetifyjs.com/en/components/text-fields

vuetify-google-autocomplete.autocorrect : Boolean

Maps to native HTML5 autocorrect attribute.

Kind: static property of vuetify-google-autocomplete
See: https://vuetifyjs.com/en/components/text-fields