Locale

struct · iOS 8.0+ · SDK 27.1

struct Locale

Information about linguistic, cultural, and technological conventions for use in formatting data for presentation. `Locale` encapsulates information about linguistic, cultural, and technological conventions and standards. Examples of information encapsulated by a locale include the symbol used for the decimal separator in numbers and the formatting conventions for dates and times. Apps use locales to provide, format, and interpret information about and according to the user's customs and preferences. Data formatting APIs commonly make use of locales to present data in a locale-appropriate way. You can create a `Locale` from a common identifier like `en-US`, or by specifying its components. More commonly, you access the current system locale with the ``current`` or ``autoupdatingCurrent`` static variables. ### Working with locale components A `Locale` exposes its various traits — the appropriate measurement system, currency symbols, date and time conventions, and more — as strongly-typed properties like ``currency``, `numberingSystem`, and `firstDayOfWeek`. In addition, the ``language`` property allows you examine traits of languages, through the ``Language`` type, in contast with `NSLocale`, where `NSLocale.languageCode` is just a string identifier. You can use a locale's language to compare whether two locales use the same language, or if one language is a parent of another. The following example creates a `Locale` from the identifier `zh-CN`, for Chinese. It then accesses this locale's ``language`` to get the language's ``Language/script``, and uses a US English locale to get a localized string describing the script: "Simplified Han". With the locale `zh-Hant-CN`, for Traditional Chinese, the script would be "Traditional Han" instead. ```swift let zhCN = Locale(identifier: "zh-CN") if let script = zhCN.language.script { let enUS = Locale(identifier: "en-US") let localizedScript = enUS.localizedString(forScript: script) // "Simplified Han" } ``` ### Creating custom locales from components You can create a custom locale by creating a `Locale` instance from a customized ``Components``. Do this when you want to tweak specific aspects of a locale. The following example creates a locale that uses language conventions of British English (language region `GB`), but otherwise uses US conventions for things like currency and measurement. ```swift var components = Locale.Components(languageCode: "en", languageRegion: "GB") components.region = Locale.Region("US") let en_GB_US = Locale(components: components) ``` Creating a custom locale like this isn't necessarily common in apps, but can be useful in unit testing your app's localizations.

Members (65)

static windowsLocaleCode(identifier: string): (number) | null

static func windowsLocaleCode(fromIdentifier identifier: String) -> Int?

static components(string: string): Record<string, string>

static func components(fromIdentifier string: String) -> [String : String]

static initComponents(components: Locale_Components): Locale

init(components: Locale.Components)

static identifierFromWindowsLocaleCode(code: number): (string) | null

static func identifier(fromWindowsLocaleCode code: Int) -> String?

static identifierFromComponents(components: Record<string, string>): string

static func identifier(fromComponents components: [String : String]) -> String

static initIdentifier(identifier: string): Locale

init(identifier: String)

get identifier(): string

var identifier: String { get }

static identifierFrom(type: Locale_IdentifierType, string: string): string

static func identifier(_ type: Locale.IdentifierType, from string: String) -> String

identifier75222(type: Locale_IdentifierType): string

func identifier(_ type: Locale.IdentifierType) -> String

get regionCode(): (string) | null

var regionCode: String? { get }

get scriptCode(): (string) | null

var scriptCode: String? { get }

get description(): string

var description: String { get }

get subdivision(): (Locale_Subdivision) | null

var subdivision: Locale.Subdivision? { get }

get variantCode(): (string) | null

var variantCode: String? { get }

get currencyCode(): (string) | null

var currencyCode: String? { get }

get customMirror(): SDKHandle

var customMirror: Mirror { get }

static initLanguageCodeScriptLanguageRegion(languageCode?: (Locale_LanguageCode) | null, script?: (Locale_Script) | null, languageRegion?: (Locale_Region) | null): Locale

init(languageCode: Locale.LanguageCode? = nil, script: Locale.Script? = nil, languageRegion: Locale.Region? = nil)

get languageCode(): (string) | null

var languageCode: String? { get }

static lineDirection(isoLangCode: string): NSLocale_LanguageDirection

static func lineDirection(forLanguage isoLangCode: String) -> Locale.LanguageDirection

get currencySymbol(): (string) | null

var currencySymbol: String? { get }

get firstDayOfWeek(): Locale_Weekday

var firstDayOfWeek: Locale.Weekday { get }

static get isoRegionCodes(): Array<string>

static var isoRegionCodes: [String] { get }

localizedStringForIdentifier(identifier: string): (string) | null

func localizedString(forIdentifier identifier: String) -> String?

localizedStringForRegionCode(regionCode: string): (string) | null

func localizedString(forRegionCode regionCode: String) -> String?

localizedStringForScriptCode(scriptCode: string): (string) | null

func localizedString(forScriptCode scriptCode: String) -> String?

localizedStringForVariantCode(variantCode: string): (string) | null

func localizedString(forVariantCode variantCode: String) -> String?

localizedStringForCurrencyCode(currencyCode: string): (string) | null

func localizedString(forCurrencyCode currencyCode: String) -> String?

localizedStringForLanguageCode(languageCode: string): (string) | null

func localizedString(forLanguageCode languageCode: String) -> String?

localizedStringForCollatorIdentifier(collatorIdentifier: string): (string) | null

func localizedString(forCollatorIdentifier collatorIdentifier: String) -> String?

localizedStringForCollationIdentifier(collationIdentifier: string): (string) | null

func localizedString(forCollationIdentifier collationIdentifier: String) -> String?

localizedStringFor(calendarIdentifier: Calendar_Identifier): (string) | null

func localizedString(for calendarIdentifier: Calendar.Identifier) -> String?

get numberingSystem(): Locale_NumberingSystem

var numberingSystem: Locale.NumberingSystem { get }

get debugDescription(): string

var debugDescription: String { get }

get decimalSeparator(): (string) | null

var decimalSeparator: String? { get }

static get isoCurrencyCodes(): Array<string>

static var isoCurrencyCodes: [String] { get }

static get isoLanguageCodes(): Array<string>

static var isoLanguageCodes: [String] { get }

static get preferredLocales(): Array<Locale>

static var preferredLocales: [Locale] { get }

get usesMetricSystem(): boolean

var usesMetricSystem: Bool { get }

get groupingSeparator(): (string) | null

var groupingSeparator: String? { get }

get measurementSystem(): Locale_MeasurementSystem

var measurementSystem: Locale.MeasurementSystem { get }

static characterDirection(isoLangCode: string): NSLocale_LanguageDirection

static func characterDirection(forLanguage isoLangCode: String) -> Locale.LanguageDirection

get collatorIdentifier(): (string) | null

var collatorIdentifier: String? { get }

static initLanguageComponents(languageComponents: Locale_Language_Components): Locale

init(languageComponents: Locale.Language.Components)

static get preferredLanguages(): Array<string>

static var preferredLanguages: [String] { get }

static get autoupdatingCurrent(): Locale

static var autoupdatingCurrent: Locale { get }

static canonicalIdentifier(string: string): string

static func canonicalIdentifier(from string: String) -> String

get collationIdentifier(): (string) | null

var collationIdentifier: String? { get }

static get availableIdentifiers(): Array<string>

static var availableIdentifiers: [String] { get }

get exemplarCharacterSet(): (CharacterSet) | null

var exemplarCharacterSet: CharacterSet? { get }

get quotationEndDelimiter(): (string) | null

var quotationEndDelimiter: String? { get }

static get commonISOCurrencyCodes(): Array<string>

static var commonISOCurrencyCodes: [String] { get }

get quotationBeginDelimiter(): (string) | null

var quotationBeginDelimiter: String? { get }

get availableNumberingSystems(): Array<Locale_NumberingSystem>

var availableNumberingSystems: [Locale.NumberingSystem] { get }

static canonicalLanguageIdentifier(string: string): string

static func canonicalLanguageIdentifier(from string: String) -> String

get alternateQuotationEndDelimiter(): (string) | null

var alternateQuotationEndDelimiter: String? { get }

get alternateQuotationBeginDelimiter(): (string) | null

var alternateQuotationBeginDelimiter: String? { get }

get region(): (Locale_Region) | null

var region: Locale.Region? { get }

static get current(): Locale

static var current: Locale { get }

get variant(): (Locale_Variant) | null

var variant: Locale.Variant? { get }

get calendar(): Calendar

var calendar: Calendar { get }

get currency(): (Locale_Currency) | null

var currency: Locale.Currency? { get }

get language(): Locale_Language

var language: Locale.Language { get }

get timeZone(): (TimeZone) | null

var timeZone: TimeZone? { get }

get collation(): Locale_Collation

var collation: Locale.Collation { get }

get hourCycle(): Locale_HourCycle

var hourCycle: Locale.HourCycle { get }

All Foundation types →