Code Samples
Community Forum

MultiSearch Autofill Address Form

The Autofill Address Form sample demonstrates how to use the the MultiSearch JS API details call to populate the address form.
  1. Example
  2. Running the Sample Locally

Example

MultiSearch Autofill Address Form
        const searchOptions = {
  apiOrder: ["localities", "places"],
  debounceTime: 0,
  localities: {
    key: "YOUR_API_KEY",
    fallbackBreakpoint: 0.4,
    params: {
      components: {
        country: ["gb"],
      },
      language: "en",
      types: ["address"],
    },
  },
  places: {
    key: "YOUR_GOOGLE_API_KEY",
    params: {
      types: ["address"],
      components: {
        country: ["gb"],
      },
      language: "en",
    },
  },
};
let multiSearch;
let inputElement: HTMLInputElement;
let suggestionsList: HTMLUListElement;
let clearSearchBtn: HTMLButtonElement;
let address2Field: HTMLInputElement;
let postalField: HTMLInputElement;
let localityField: HTMLInputElement;
let stateField: HTMLInputElement;
let countryField: HTMLInputElement;

function init(): void {
  if (inputElement && suggestionsList) {
    inputElement.addEventListener("input", handleAutocomplete);
    inputElement.addEventListener("keydown", (event) => {
      if (event.key === "Enter") {
        const firstLi = suggestionsList.querySelector("li");
        if (firstLi) {
          firstLi.click();
        }
      }
    });
  }
  clearSearchBtn.addEventListener("click", () => {
    inputElement.value = "";
    suggestionsList.style.display = "none";
    clearSearchBtn.style.display = "none";
    address2Field.value = "";
    postalField.value = "";
    localityField.value = "";
    stateField.value = "";
    countryField.value = "";
    inputElement.focus();
  });

  // @ts-ignore
  multiSearch = window.woosmap.multisearch(searchOptions);
}

function handleAutocomplete(): void {
  if (inputElement && suggestionsList) {
    const input = inputElement.value;
    input.replace('"', '\\"').replace(/^\s+|\s+$/g, "");
    if (input !== "") {
      multiSearch.autocompleteMulti(input).then(
        (results) => displaySuggestions(results),
        (error) => console.error(`Error autocomplete localities: ${error}`),
      );
    } else {
      suggestionsList.style.display = "none";
      clearSearchBtn.style.display = "none";
    }
  }
}

function handleNoResults(): void {
  const li = document.createElement("li");
  li.innerHTML = "<div class='prediction no-result'>No results found...</div>";
  suggestionsList.appendChild(li);
  suggestionsList.className = "";
  suggestionsList.style.display = "block";
}

function displaySuggestions(results) {
  if (inputElement && suggestionsList) {
    suggestionsList.innerHTML = "";
    if (results.length > 0) {
      results.forEach((result) => {
        const li = document.createElement("li");
        li.innerHTML = formatPredictionList(result) ?? "";
        li.addEventListener("click", () => {
          suggestionsList.style.display = "none";
          multiSearch
            .detailsMulti({ id: result.id, api: result.api })
            .then((details) => {
              displayMultiSearchResponse(details);
            });
        });
        suggestionsList.appendChild(li);
      });
      suggestionsList.className = results[0].api;
      suggestionsList.style.display = "block";
      clearSearchBtn.style.display = "block";
    } else {
      handleNoResults();
    }
  }
}

function formatPredictionList(result): string {
  const predictionClass = "no-viewpoint";
  const formatted_name = result.highlight;
  let html = "";
  html += `<div class="prediction ${predictionClass}">${formatted_name}</div>`;
  return html;
}

function displayMultiSearchResponse(result) {
  let shippingAddress = "";
  let shippingAddress2 = "";
  let postcode = "";
  for (const component of result.item.address_components) {
    const componentType = component.types[0];
    switch (componentType) {
      case "street_number": {
        shippingAddress = `${component.long_name} ${shippingAddress}`;
        break;
      }
      case "route": {
        shippingAddress += component.short_name;
        break;
      }
      case "postal_code": {
        postcode = `${component.long_name}${postcode}`;
        break;
      }
      case "postal_code_suffix": {
        postcode = `${postcode}-${component.long_name}`;
        break;
      }
      case "locality":
        localityField.value = component.long_name;
        break;

      case "state": {
        stateField.value = component.long_name;
        break;
      }
      case "administrative_area_level_1": {
        stateField.value = component.long_name;
        break;
      }
      case "country": {
        countryField.value = component.long_name;
        break;
      }
      case "premise": {
        shippingAddress2 = component.long_name;
        break;
      }
      default:
        break;
    }
  }
  if (postcode) {
    postalField.value = postcode;
  }
  if (shippingAddress) {
    inputElement.value = shippingAddress;
  }
  if (shippingAddress2) {
    address2Field.value = shippingAddress2;
  }
}

document.addEventListener("click", (event) => {
  const targetElement = event.target as Element;
  const isClickInsideAutocomplete = targetElement.closest(
    "#autocomplete-container",
  );

  if (!isClickInsideAutocomplete && suggestionsList) {
    suggestionsList.style.display = "none";
  }
});

document.addEventListener("DOMContentLoaded", () => {
  inputElement = document.getElementById(
    "autocomplete-input",
  ) as HTMLInputElement;
  suggestionsList = document.getElementById(
    "suggestions-list",
  ) as HTMLUListElement;
  clearSearchBtn = document.getElementsByClassName(
    "clear-searchButton",
  )[0] as HTMLButtonElement;
  address2Field = document.querySelector("#address2") as HTMLInputElement;
  postalField = document.querySelector("#postcode") as HTMLInputElement;
  localityField = document.querySelector("#locality") as HTMLInputElement;
  stateField = document.querySelector("#state") as HTMLInputElement;
  countryField = document.querySelector("#country") as HTMLInputElement;
  init();
});

declare global {
  interface Window {
    // currently, the MultiSearch JS API typings are not exported, so we use `any` here
    // @ts-ignore
    woosmap: {
      localities: {
        multisearch: (defaultSearchOptions: any) => any;
      };
    };
  }
}

    
        const searchOptions = {
  apiOrder: ["localities", "places"],
  debounceTime: 0,
  localities: {
    key: "YOUR_API_KEY",
    fallbackBreakpoint: 0.4,
    params: {
      components: {
        country: ["gb"],
      },
      language: "en",
      types: ["address"],
    },
  },
  places: {
    key: "YOUR_GOOGLE_API_KEY",
    params: {
      types: ["address"],
      components: {
        country: ["gb"],
      },
      language: "en",
    },
  },
};
let multiSearch;
let inputElement;
let suggestionsList;
let clearSearchBtn;
let address2Field;
let postalField;
let localityField;
let stateField;
let countryField;

function init() {
  if (inputElement && suggestionsList) {
    inputElement.addEventListener("input", handleAutocomplete);
    inputElement.addEventListener("keydown", (event) => {
      if (event.key === "Enter") {
        const firstLi = suggestionsList.querySelector("li");

        if (firstLi) {
          firstLi.click();
        }
      }
    });
  }

  clearSearchBtn.addEventListener("click", () => {
    inputElement.value = "";
    suggestionsList.style.display = "none";
    clearSearchBtn.style.display = "none";
    address2Field.value = "";
    postalField.value = "";
    localityField.value = "";
    stateField.value = "";
    countryField.value = "";
    inputElement.focus();
  });
  // @ts-ignore
  multiSearch = window.woosmap.multisearch(searchOptions);
}

function handleAutocomplete() {
  if (inputElement && suggestionsList) {
    const input = inputElement.value;

    input.replace('"', '\\"').replace(/^\s+|\s+$/g, "");
    if (input !== "") {
      multiSearch.autocompleteMulti(input).then(
        (results) => displaySuggestions(results),
        (error) => console.error(`Error autocomplete localities: ${error}`),
      );
    } else {
      suggestionsList.style.display = "none";
      clearSearchBtn.style.display = "none";
    }
  }
}

function handleNoResults() {
  const li = document.createElement("li");

  li.innerHTML = "<div class='prediction no-result'>No results found...</div>";
  suggestionsList.appendChild(li);
  suggestionsList.className = "";
  suggestionsList.style.display = "block";
}

function displaySuggestions(results) {
  if (inputElement && suggestionsList) {
    suggestionsList.innerHTML = "";
    if (results.length > 0) {
      results.forEach((result) => {
        const li = document.createElement("li");

        li.innerHTML = formatPredictionList(result) ?? "";
        li.addEventListener("click", () => {
          suggestionsList.style.display = "none";
          multiSearch
            .detailsMulti({ id: result.id, api: result.api })
            .then((details) => {
              displayMultiSearchResponse(details);
            });
        });
        suggestionsList.appendChild(li);
      });
      suggestionsList.className = results[0].api;
      suggestionsList.style.display = "block";
      clearSearchBtn.style.display = "block";
    } else {
      handleNoResults();
    }
  }
}

function formatPredictionList(result) {
  const predictionClass = "no-viewpoint";
  const formatted_name = result.highlight;
  let html = "";

  html += `<div class="prediction ${predictionClass}">${formatted_name}</div>`;
  return html;
}

function displayMultiSearchResponse(result) {
  let shippingAddress = "";
  let shippingAddress2 = "";
  let postcode = "";

  for (const component of result.item.address_components) {
    const componentType = component.types[0];

    switch (componentType) {
      case "street_number": {
        shippingAddress = `${component.long_name} ${shippingAddress}`;
        break;
      }

      case "route": {
        shippingAddress += component.short_name;
        break;
      }

      case "postal_code": {
        postcode = `${component.long_name}${postcode}`;
        break;
      }

      case "postal_code_suffix": {
        postcode = `${postcode}-${component.long_name}`;
        break;
      }
      case "locality":
        localityField.value = component.long_name;
        break;
      case "state": {
        stateField.value = component.long_name;
        break;
      }

      case "administrative_area_level_1": {
        stateField.value = component.long_name;
        break;
      }

      case "country": {
        countryField.value = component.long_name;
        break;
      }

      case "premise": {
        shippingAddress2 = component.long_name;
        break;
      }
      default:
        break;
    }
  }

  if (postcode) {
    postalField.value = postcode;
  }

  if (shippingAddress) {
    inputElement.value = shippingAddress;
  }

  if (shippingAddress2) {
    address2Field.value = shippingAddress2;
  }
}

document.addEventListener("click", (event) => {
  const targetElement = event.target;
  const isClickInsideAutocomplete = targetElement.closest(
    "#autocomplete-container",
  );

  if (!isClickInsideAutocomplete && suggestionsList) {
    suggestionsList.style.display = "none";
  }
});
document.addEventListener("DOMContentLoaded", () => {
  inputElement = document.getElementById("autocomplete-input");
  suggestionsList = document.getElementById("suggestions-list");
  clearSearchBtn = document.getElementsByClassName("clear-searchButton")[0];
  address2Field = document.querySelector("#address2");
  postalField = document.querySelector("#postcode");
  localityField = document.querySelector("#locality");
  stateField = document.querySelector("#state");
  countryField = document.querySelector("#country");
  init();
});

    
        /*
 * Always set the map height explicitly to define the size of the div element
 * that contains the map.
 */
#map {
  height: 100%;
}

/*
 * Optional: Makes the sample page fill the window.
 */
html,
body {
  height: 100%;
  margin: 0;
  padding: 0;
  font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Helvetica Neue, Arial, Noto Sans, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol, Noto Color Emoji;
}

#autocomplete-container {
  display: flex;
  position: absolute;
  top: 10px;
  left: 10px;
  z-index: 1;
  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.2), 0 -1px 0px rgba(0, 0, 0, 0.02);
  background: #fff;
  border-radius: 12px;
  padding: 0 12px;
  max-width: 320px;
  width: 100%;
  height: 42px;
  border: none;
  box-sizing: border-box;
  align-items: center;
  cursor: text;
  font-size: 15px;
}

#autocomplete-container .search-icon, #autocomplete-container .clear-icon {
  color: inherit;
  flex-shrink: 0;
  height: 16px;
  width: 16px;
}

#autocomplete-container .clear-icon {
  transform: scale(1.3);
}

#autocomplete-input {
  box-sizing: border-box;
  padding: 0;
  height: 40px;
  line-height: 24px;
  vertical-align: top;
  transition-property: color;
  transition-duration: 0.3s;
  width: 100%;
  text-overflow: ellipsis;
  background: transparent;
  border-radius: 0;
  border: 0;
  margin: 0 8px;
  outline: 0;
  overflow: visible;
  appearance: textfield;
  font-size: 100%;
}

.clear-searchButton {
  display: none;
  height: 18px;
  width: 22px;
  background: none;
  border: none;
  vertical-align: middle;
  pointer-events: all;
  cursor: pointer;
}

#suggestions-list {
  border-radius: 12px;
  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.2), 0 -1px 0px rgba(0, 0, 0, 0.02);
  box-sizing: border-box;
  position: absolute;
  max-width: 320px;
  width: 100%;
  top: 100%;
  left: 0;
  z-index: 1;
  list-style: none;
  max-height: 80vh;
  margin: 5px 0 0;
  padding: 0;
  display: none;
  overflow-y: auto;
  background-color: #fff;
}

#suggestions-list.visible {
  display: block;
}

#suggestions-list li {
  padding: 12px;
  cursor: pointer;
  transition: background-color 0.3s ease;
}

#suggestions-list li:hover {
  background-color: #f2f2f2;
}

body {
  background-color: #eee;
}

.title {
  margin-block-end: 0;
  font-weight: 500;
}

.note {
  margin-block-start: 4px;
  font-size: 13px;
}

#form-wrapper {
  padding: 15px;
}

#autocomplete-container {
  position: relative;
  left: 0;
  top: 0;
  max-width: 100%;
  border: 1px solid #686868;
  background: #FFF;
  box-shadow: none;
  border-radius: 3px;
}

form {
  display: flex;
  flex-wrap: wrap;
  align-items: center;
  max-width: 400px;
  box-sizing: border-box;
}

.input-wrapper {
  margin-top: 5px;
  border: 1px solid #686868;
  background: #FFF;
  border-radius: 3px;
  height: 40px;
}
.input-wrapper input {
  display: flex;
  width: 100%;
  height: 100%;
  outline: 0;
  padding: 12px;
  box-sizing: border-box;
  border-radius: 3px;
  border: none;
  font-size: 15px;
}

.form-label {
  width: 100%;
  padding: 0.5em 0;
}

.full-field {
  flex: 400px;
  margin: 12px 0;
  position: relative;
}

.field-left {
  flex: 1 150px;
  margin: 15px 15px 15px 0px;
}

.field-right {
  flex: 1 150px;
  margin: 15px 0px 15px 15px;
}

#suggestions-list {
  max-width: 100%;
}
#suggestions-list:after {
  content: "";
  box-sizing: border-box;
  text-align: right;
  display: block;
  background-position: right;
  background-repeat: no-repeat;
  background-size: contain;
}
#suggestions-list.places:after {
  padding: 1px 1px 1px 0;
  height: 18px;
  background-image: url(https://maps.gstatic.com/mapfiles/api-3/images/powered-by-google-on-white3_hdpi.png);
  background-size: 120px 14px;
}
#suggestions-list.localities:after {
  margin: 0 6px 3px;
  height: 16px;
  background-image: url(https://developers.woosmap.com/assets/images/woosmap-logo.svg);
}
#suggestions-list .no-result {
  opacity: 0.6;
}


    
        <html>
  <head>
    <title>MultiSearch Autofill Address Form</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta charset="utf-8" />

    <script src="https://sdk.woosmap.com/multisearch/multisearch.js"></script>

    <link rel="stylesheet" type="text/css" href="./style.css" />
    <script type="module" src="./index.js"></script>
  </head>
  <body>
    <div id="form-wrapper">
      <p class="title">
        Autofill address form with Woosmap Multisearch <em>(GB)</em>
      </p>
      <p class="note">
        <em>Input an address in "Deliver to" field to autofill the form</em>
      </p>
      <form id="address-form" action="" method="get" autocomplete="off">
        <div class="full-field">
          <label class="form-label" for="autocomplete-input">Deliver to*</label>
          <div id="autocomplete-container" class="input-wrapper">
            <svg class="search-icon" viewBox="0 0 16 16">
              <path
                d="M3.617 7.083a4.338 4.338 0 1 1 8.676 0 4.338 4.338 0 0 1-8.676 0m4.338-5.838a5.838 5.838 0 1 0 2.162 11.262l2.278 2.279a1 1 0 0 0 1.415-1.414l-1.95-1.95A5.838 5.838 0 0 0 7.955 1.245"
                fill-rule="evenodd"
                clip-rule="evenodd"
              ></path>
            </svg>

            <input
              type="text"
              id="autocomplete-input"
              name="autocomplete-input"
              placeholder="Search an address..."
              autocomplete="off"
            />
            <button aria-label="Clear" class="clear-searchButton" type="button">
              <svg class="clear-icon" viewBox="0 0 24 24">
                <path
                  d="M7.074 5.754a.933.933 0 1 0-1.32 1.317L10.693 12l-4.937 4.929a.931.931 0 1 0 1.319 1.317l4.938-4.93 4.937 4.93a.933.933 0 0 0 1.581-.662.93.93 0 0 0-.262-.655L13.331 12l4.937-4.929a.93.93 0 0 0-.663-1.578.93.93 0 0 0-.656.261l-4.938 4.93z"
                ></path>
              </svg>
            </button>
            <ul id="suggestions-list"></ul>
          </div>
        </div>
        <div class="full-field">
          <label class="form-label" for="address2"
            >Apartment, unit, suite, or floor #</label
          >
          <div class="input-wrapper">
            <input id="address2" name="address2" />
          </div>
        </div>
        <div class="full-field">
          <label class="form-label" for="locality">City*</label>
          <div class="input-wrapper">
            <input id="locality" name="locality" required />
          </div>
        </div>
        <div class="field-left">
          <label class="form-label" for="state">State/Province*</label>
          <div class="input-wrapper">
            <input id="state" name="state" required />
          </div>
        </div>
        <div class="field-right">
          <label class="form-label" for="postcode">Postal code*</label>
          <div class="input-wrapper">
            <input id="postcode" name="postcode" required />
          </div>
        </div>
        <div class="full-field">
          <label class="form-label" for="country">Country/Region*</label>
          <div class="input-wrapper">
            <input id="country" name="country" required />
          </div>
        </div>
      </form>
    </div>
  </body>
</html>

Running the Sample Locally

Before you can run this sample on your local machine, you need to have Git and Node.js installed. If they’re not already installed, follow these instructions to get them set up.

Once you have Git and Node.js installed, you can run the sample by following these steps:

  1. Clone the repository and navigate to the directory of the sample.

  2. Install the necessary dependencies.

  3. Start running the sample.

Here are the commands you can use in your terminal to do this:

Shell
        git clone -b sample/multisearch-address-form-autofill https://github.com/woosmap/js-samples.git
cd js-samples
npm i
npm start

You can experiment with other samples by switching to any branch that starts with the pattern sample/SAMPLE_NAME.

Shell
        git checkout sample/SAMPLE_NAME
npm i
npm start
Was this article helpful?
Have more questions? Submit a request