StructureFoundationEssentials

Locale.Language

iOS 16.0+ iPadOS 16.0+ Mac Catalyst 16.0+ macOS 13.0+ tvOS 16.0+ watchOS 9.0+

A type that represents a language, as used in a locale.

struct Language

Topics

struct Components
A type that identifies a language by its various components.

var characterDirection: Locale.LanguageDirection
The ordering of characters within a line.
var languageCode: Locale.LanguageCode?
The language code that identifies the language. Returns nil if it cannot be determined.
var lineLayoutDirection: Locale.LanguageDirection
Ordering of lines within a page. For example, top-to-bottom for English; right-to-left for Mongolian in the Mongolian Script
var maximalIdentifier: String
Returns a BCP-47 identifier that always includes the script: “zh-Hant-TW”, “en-Latn-US”
var minimalIdentifier: String
Returns a BCP-47 identifier in a minimalist form. Script and region may be omitted. For example, “zh-TW”, “en”
var parent: Locale.Language?
The parent language of this language, if available.
var region: Locale.Region?
The region of the language. Returns nil if it cannot be determined.
var script: Locale.Script?
The script of the language. Returns nil if it cannot be determined.

func hasCommonParent(with: Locale.Language) -> Bool
Returns a Boolean value that indicates if the given language shares a common parent with this language.
func isEquivalent(to: Locale.Language) -> Bool
Returns a Boolean value that indicates whether this language and another language are equivalent after expanding missing components.

static var systemLanguages: [Locale.Language]
An array of the system’s supported languages.