Address selector
<nsx-address-selector> Overview
Address selector is used to search a specific address, add / edit a new address.
Examples
Guidance
Implementation
Placement
The nsx-address-selector component can only be used as a child of the <ns-form> element.
Specification
Attributes
selected-address
- Property
selectedAddress- Description
- The selected address.
- Type
object
selectedaddress
- Property
selectedaddress- Description
- Use `selectedAddress / selected-address` property / attribute.
- Type
object
postcode
- Property
postcode- Description
- The postcode of the address selector.
- Type
string- Default
addresses
- Property
addresses- Description
- The array of addresses available for the postcode.
- Type
Array- Default
[]
required
- Property
required- Description
- Use `validation=['isRequired']` attribute.
- Type
boolean- Default
false
manual-form-enabled
- Property
manualFormEnabled- Description
- Whether the manual address form should be shown.
- Type
boolean- Default
false
allow-manual-address
- Property
allowManualAddress- Description
- Whether an address can be manually editted.
- Type
boolean- Default
false
validation
- Property
validation- Type
never[]- Default
[]
disableNative
- Property
disableNative- Type
boolean- Default
false
showMessage
- Property
showMessage- Type
boolean- Default
true
name
- Property
name- Description
- The form name of the address selector.
- Type
string- Default
address-selector
value
- Property
value- Description
- The value of the address selector.
- Type
string- Default
labelID
- Property
labelID- Type
string- Default
heading
- Property
heading- Type
string- Default
type
- Property
type- Type
string- Default
standard
Events
| Name | Description |
|---|---|
postcode-selected | The event fired when the postcode is selected. Returns the postcode. |
address-selected | The event fired when the address is selected. Returns the address. |
manual-address-click | The event fired when the manual address button is clicked. |
change |