README.md

*** NY VERSION ***

Der er lavet en ny og forbedret version af DAWA autocomplete, som kan findes her. Vi anbefaler alle at anvende den nye version af DAWA autocomplete.

Denne udgave af DAWA autocomplete bliver ikke længere videreudviklet.

DAWA Autocomplete

DAWA autocomplete er en JavaScript komponent, som giver mulighed for at indtaste en dansk adresse i ét input-felt ved hjælp af autocomplete. Komponenten anvender Danmarks Adressers Web API (DAWA).

Komponenten er baseret på JQueryUI's autocomplete widget. Den har ingen andre afhængigheder end JQuery.

Du kan se en demo af komponenten på dawa.aws.dk.

Installation

Komponenten kan installeres via bower:

bower install dawa-autocomplete

Eksempler

Aktivering af DAWA autocomplete:

  $('#autocomplete-adresse').dawaautocomplete({
      select: function(event, adresse) {
        // denne funktion bliver kaldt når brugeren vælger en adresse.
      }
  });

Angiv konfigurationsparametre:

$('#myInput').dawaautocomplete({
  jsonp: false,
  baseUrl: 'http://dawa.aws.dk',
  minLength: 2,
  delay: 0,
  adgangsadresserOnly: false,
  params: {},
  timeout: 10000,
  select: function(event, adresse) {
    // denne funktion bliver kaldt når brugeren vælger en adresse.
  },
  error: function(xhr, status, error) {
    // denne funktion bliver kaldt ved fejl
  }
});

Options

Det er muligt at angive følgende options:

• jsonp: Anvend JSONP i stedet for JSON (som default anvendes JSON hvis CORS er supporteret af browseren).
• baseUrl: URL til API (default http://dawa.aws.dk)
• minLength: Antal karakterer, der skal være tastet for autocomplete vises (default 2)
• params: Angiver yderligere parametre (eksempelvis postnr, kommunekode), som sendes med ved kald til DAWA
• adgangsadresserOnly: Angiver, at der indtastes en adgangsadresse og ikke en fuld adresse (default: false)
• timeout: Antal millisekunder der ventes på svar fra serveren før der gives op (default: 10000)
• error: Callback-funktion ved fejl eller timeout. (default: null). Se JQuery's dokumentation for en beskrivelse af parametre til funktionen

Events

DAWA Autocomplete udsender følgende events:

• select: Når brugeren har valgt en adresse
• error: Ved fejl under kald af DAWA