@microbadevs/address v1.0.4

@microbadevs/address

Address component with in built api integration for auto complete.

Usage

• In individual component

import addressComponent from '@microbadevs/address';

export default {
  components: {ModalAddress},
  methods: {
    updateExistingAddress (payload) {
        this.existingAddress = payload
    }
  }
  .
  .

// In Template section
  <addressComponent
  :countriesEnabled="countriesEnabled"
  :existingAddress="existingAddress" @update:existingAddress="updateExistingAddress"/>

• For system wide use

// in main.js
import addressComponent from '@microbadevs/address';

Vue.use(addressComponent)

Props

• countriesEnabled (Optional, Default: [])

  If countries enabled is not supplied, component renders all countries for selection. To restrict countries pass countries for example: countriesEnabled = 'AU', 'NZ' // Country codes only accepted

• existingAddress (Optional, Default: {externalIdentifier: null, provider: null, addressLine1: null, state: null, postcode: null, suburb: null, country: null})

• addressErrors (Optional, Default: {externalIdentifier: null, provider: null, addressLine1: null, state: null, postcode: null, suburb: null, country: null}).

  Parent decides the validation / errors or any business logic as long as Default have value supplied component will flag it visually as invalid-feedback.

• apiBaseUrl (Optional, Default: 'https://apiuat.microba.com)

  Api base URL used to route api call to various environments.

Events

• update:existingAddress

  Every time address is changed manually or by selection from autocomplete this event is raised with new address as payload in format ({externalIdentifier: null, provider: null, addressLine1: null, state: null, postcode: null, suburb: null, country: null})

Styles

Available classes to apply style definition as below:

• .address-component: full component wrapper class.
• .editAddressWrapper: wrapper around Edit Address link.
• .form-control: class for every input field.
• .invalid-feedback: class for validation messages.