# AddressBookUI

By [Mattt](https://nshipster.com/authors/mattt).
Published 2012-10-15.
Canonical URL: <https://nshipster.com/addressbookui>

> Apple deprecated the Address Book UI framework in iOS 9. To format a postal address today, use `CNPostalAddressFormatter` from the Contacts framework, which works on both iOS and macOS. Our article about [`Formatter`](https://nshipster.com/formatter/#cnpostaladdressformatter) shows how.

[Address Book UI](https://developer.apple.com/LIBRARY/ios/documentation/AddressBookUI/Reference/AddressBookUI_Framework/index.html) is an iOS framework for displaying, selecting, editing, and creating contacts in a user’s Address Book. Similar to the [Message UI](https://developer.apple.com/library/IOs/documentation/MessageUI/Reference/MessageUI_Framework_Reference/index.html) framework, Address Book UI contains a number of controllers that can be presented modally, to provide common system functionality in a uniform interface.

To use the framework, add both `AddressBook.framework` and `AddressBookUI.framework` to your project, under the “Link Binary With Libraries” build phase.

At first glance, it would seem that there’s nothing really remarkable about the Address Book UI framework.

However, tucked away from the rest of the controllers and protocols, there’s a single Address Book UI function that’s astoundingly useful:

`ABCreateStringWithAddressDictionary()` - Returns a localized, formatted address string from components.

The first argument for the function is a dictionary containing the address components, keyed by string constants:

- `kABPersonAddressStreetKey`
- `kABPersonAddressCityKey`
- `kABPersonAddressStateKey`
- `kABPersonAddressZIPKey`
- `kABPersonAddressCountryKey`
- `kABPersonAddressCountryCodeKey`

> `kABPersonAddressCountryCodeKey` is an especially important attribute, as it determines which locale is used to format the address string. If you are unsure of the country code, or one isn’t provided with your particular data set, `NSLocale` may be able to help you out:

```swift
let countryCode: String = NSLocale(localeIdentifier: "en_US").objectForKey(NSLocaleCountryCode) as String
```

```objc
[mutableAddressComponents setValue:[[[NSLocale alloc] initWithLocaleIdentifier:@"en_US"] objectForKey:NSLocaleCountryCode] forKey:(__bridge NSString *)kABPersonAddressCountryCodeKey];
```

The second argument is a boolean flag, `addCountryName`. When `YES`, the name of the country corresponding to the specified country code will be automatically appended to the address. This should only be used when the country code is known.

```swift
let addressComponents = [
    kABPersonAddressStreetKey: "70 NW Couch Street",
    kABPersonAddressCityKey: "Portland",
    kABPersonAddressStateKey: "OR",
    kABPersonAddressZIPKey: "97209",
    kABPersonAddressCountryCodeKey: "US"
]

ABCreateStringWithAddressDictionary(addressComponents, true)
```

```
70 NW Couch Street
Portland‎ OR‎ 97209
United States
```

Nowhere else in all of the other frameworks is this functionality provided. It’s not part of [`NSLocale`](https://nshipster.com/nslocale/), or even Map Kit or Core Location. For all of the care and attention to detail that Apple puts into localization, it’s surprising that such an important task is relegated to the corners of an obscure, somewhat-unrelated framework.

> Unfortunately, Address Book UI is not available in OS X, and it would appear that there’s no equivalent function provided on this platform.

For you see, address formats vary greatly across different regions. For example, addresses in the United States take the form:

```
Street Address
City State ZIP
Country
```

Whereas addresses in Japan follow a different convention:

```
Postal Code
Prefecture Municipality
Street Address
Country
```

This is at least as jarring a difference in localization as [swapping periods for commas as the radix point](https://en.wikipedia.org/wiki/Decimal_mark#Hindu.E2.80.93Arabic_numeral_system), so make sure to use this function anytime you’re displaying an address from its components.