LocaleList

public class LocaleList(public val localeList: List<Locale>) : Collection<Locale>

Defines a list of Locale objects.

Properties

size

public override val size: Int = localeList.size

Functions

get

public operator fun get(i: Int): Locale

Creates a LocaleList object from a list of Locales.

Members

Companion

public companion object

Properties

Empty

public val Empty: LocaleList = LocaleList(listOf())

An empty instance of LocaleList. Usually used to reference a lack of explicit Locale configuration.

current

@Deprecated(
            "LocaleList.current is not backed by snapshot state and does not notify readers on updates. " +
                "In @Composable functions, use LocalLocaleList.current instead. Outside composables, " +
                "pass the current locale list explicitly from an observable state source.",
            replaceWith =
                ReplaceWith(
                    "LocalLocaleList.current",
                    "androidx.compose.ui.platform.LocalLocaleList",
                ),
        )
        public val current: LocaleList

Returns Locale object which represents current locale