郵便番号から住所を検索する jQuery lookup プラグイン

ホーム > Postal Search Ajax API with jQuery

jQuery lookup プラグインは Postal Search Ajax API の Postal.Lookup クラスを jQuery プラグインにラップしたものです。jQuery lookup プラグインを使うと Postal.Lookup クラスが持つ郵便番号から住所を検索する機能を jQuery のメソッドチェーンの中で利用できます。

郵便番号から住所を検索するときは lookup メソッドを使います。lookup メソッドの引数には郵便番号とコールバック関数を指定します。lookup メソッドはその中で Postal.Lookup クラスをを使って郵便番号から住所を検索し、その結果をコールバック関数を使って伝えます。このときの検索は非同期です。

コールバック関数の引数は検索結果とステータスコードです。検索結果は Postal.Lookup クラスの response プロパティに対応します。郵便番号から住所が見つからないときは空の配列になります。ステータスコードは Postal.Lookup クラスの status プロパティに該当します。エラーが発生したときは 200 以外の値になります。

デモ

次のデモは郵便番号 160-0021 の住所を検索するものです。はじめに検索中を表す loading ... というテキストを表示し、その後 lookup メソッドを使って郵便番号から住所を検索しています。住所が見つかったときは、前述の loading... を上書きして住所を表示しています。

Loading ...

<div id="r1"></div>

<script type="text/javascript">
//<![CDATA[
jQuery(function($) {
  $('#r1')
    .lookup('160-0021', function(response) {
        if (response.length > 0) {
          var addr = response[0];
          $(this).text(addr.a);
        }
      });
});
//]]>
</script>

検索のタイムアウトを長くするときは $.lookupSetup メソッドを使います。タイムアウトの初期値は30秒です。通常は変更せずそのまま使います。$.lookupSetup メソッドは Postal.Lookup クラスのコンストラクタのオプションに対応します。

$.lookupSetup({
  timeout: 180
});

jQuery lookup プラグインは Postal Search Ajax API に組み込んで配布しています。詳しくは Postal Search Ajax API リファレンスをご覧ください。

郵便番号から住所を検索する jQuery lookup プラグイン

デモ

関連情報