Class Controller

Reference to postcode lookup button

Ideal Postcodes API client

HTML Element in which postcode lookup tools live

Cache for recently retrieved data

Reference to the DOM, to which this.scope belongs

Reference to postcode lookup input field

Stores most recent lookup

Reference to message paragraph element

Caches options object

Scopes the DOM for fields which should receive address inputs

Scopes the DOM for the entire controller

Reference to dropdown containing address suggestions

Reference to HTMLElement that wraps the address dropdown

unhide

unhide: HTMLElement

Clickable element that triggers unhiding of address fields if enabled

Methods

createSelect

• createSelect(): HTMLSelectElement

• Creates Select HTML Element

  Returns HTMLSelectElement

createUnhide

• createUnhide(): HTMLElement

• Creates a clickable element that can trigger unhiding of fields

  Returns HTMLElement

disableButton

• disableButton(message?: string): void

• Prevents lookup button from being triggered

  Parameters

  • Optional message: string

  Returns void

enableButton

• enableButton(): void

• Enables lookup button to trigger searches

  Returns void

enableLookup

• enableLookup(): void

• Allows lookup button to be triggered and applies a cooloff timer if configured

  Returns void

executeSearch

• executeSearch(term: string): Promise<void>

• Triggers a search based on term and mounts addresses to DOM in the address dropdown

  Validate search term and then trigger postcode lookup

  • On successful search, display results in a dropdown menu
  • On successful search but no addresses, show error message
  • On failed search, show error message

  Parameters

  • term: string

  Returns Promise<void>

hideFields

• hideFields(): void

• Hides fields marked for hiding

  Returns void

hideMessage

• hideMessage(): void

• Hides any messages

  Returns void

init

• init(): void

• Call to initially render the DOM elements

  This will perform an optional keyCheck if required

  Returns void

mountSelect

• mountSelect(data?: GbrAddress[]): void

• Mounts dropdown menu to DOM and attach event listeners

  Removes dropdown from DOM if data is undefined

  Parameters

  • Optional data: GbrAddress[]

  Returns void

populateAddress

• populateAddress(address: GbrAddress): void

• Writes a selected to the input fields specified in the controller config

  Parameters

  • address: GbrAddress

  Returns void

removeAll

• removeAll(): void

• Removes all elements from DOM including dropdown, input, button and any error message

  • Remove all event listeners
  • Remove non-custom elements DOM

  Returns void

render

• render(): void

• Empties context and appends postcode lookup input, button, message field and select container

  Does not render element if a custom element has been provided

  Returns void

reset

• reset(): void

• Resets address search fields

  • Removes any existing address selection dropdown
  • Removes any visiable messages

  Returns void

selectAddress

• selectAddress(i: number): void

• Selects an address by its offset i in the list of address results

  Parameters

  • i: number

  Returns void

setMessage

• setMessage(message?: string): void

• Sets the error message

  Removes error message from DOM if undefined

  Parameters

  • Optional message: string

  Returns void

unhideFields

• unhideFields(): void

• Unhides fields marked for hiding and triggers callback

  Returns void

unmountButton

• unmountButton(): void

• unmountButton

  • Remove listener events
  • Remove button from DOM if generated by this controller

  Returns void

unmountContainer

• unmountContainer(): void

• Removes select container from DOM

  Returns void

unmountInput

• unmountInput(): void

• Removes address input artefacts from DOM

  • Removes event listeners from input field
  • Removes input field, unless input field is provided by the user

  Returns void

unmountMessage

• unmountMessage(): void

• Removes message container from DOM

  Returns void

unmountSelect

• unmountSelect(): void

• Remove dropdown from DOM

  Returns void

unmountUnhide

• unmountUnhide(): void

• Removes unhide elem from DOM

  Returns void