Contents

init(localized:defaultValue:table:bundle:locale:comment:)

Creates a localized string from an arbitrary static string key.

Declaration

init(localized key: StaticString, defaultValue: String.LocalizationValue, table: String? = nil, bundle: Bundle? = nil, locale: Locale = .current, comment: StaticString? = nil)

Parameters

  • defaultValue:

    A default value to use if looking up a localized string from the bundle fails. This is typically the localizable string in the development language.

  • table:

    The bundle’s string table to search. If table is nil or is an empty string, the method attempts to use the table named Localizable. The default is nil.

  • bundle:

    The bundle to use for looking up strings. If nil, an app searches its main bundle. The default is nil.

  • locale:

    The locale to use when localizing interpolated values, such as numbers. This doesn’t change which locale the system uses to look up the localized string. If nil, this initializer uses the current locale. The default is nil.

  • comment:

    The comment to place above the key-value pair in the strings file. This parameter provides the translator with some context about the localized string’s presentation to the user.

Discussion

Use the defaultValue initializers when you want to use an explicit key to look up localized strings. This is useful if the localizable string in your development language is ambiguous. For example call in English can be a noun or a verb. In this case, you might want to use .strings file entries like CALL_NOUN and CALL_VERB to disambiguate the uses for localizers. You then use this initializer, providing both a key and a default value to use if the system can’t find the key at runtime.

// Assume the strings file or catalog contains the following:
// English: CALL_VERB = "Call", CALL_NOUN = "Call"
// French: CALL_VERB = "Appeler", CALL_NOUN = "Appel"
let callVerb = String(localized: "CALL_VERB", defaultValue: "Call")
let callNoun = String(localized: "CALL_NOUN", defaultValue: "Call")
// callVerb == "Call" in en locale, "Appeler" in fr locale.
// callNoun == "Call" in en locale, "Appel" in fr locale.

To use the default localization as the key rather than an explicit key, use init(localized:table:bundle:locale:comment:) instead. If you need to provide localized strings to another process that might be using a different locale, use init(localized:).

See Also

Creating a Localized String