# LocaleList

Artifact: [androidx.compose.ui:ui-text](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/text/intl/LocaleList.kt+class:androidx.compose.ui.text.intl.LocaleList) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/AllAndroid/JVM
- Cmn

  ```
  class LocaleList : Collection<Locale>
  ```

*** ** * ** ***

Defines a list of `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale` objects.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle` |   |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/SpanStyle` |   |

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#Empty()` An empty instance of `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#current()` **This property is deprecated.** LocaleList.current is not backed by snapshot state and does not notify readers on updates. | Cmn |

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#LocaleList(kotlin.String)(languageTags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Create a `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` object from comma separated language tags. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#LocaleList(kotlin.collections.List)(localeList: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale>)` | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#LocaleList(kotlin.Array)(vararg locales: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale)` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` object from a list of `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale`s. | Cmn |

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#contains(androidx.compose.ui.text.intl.Locale)(element: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#containsAll(kotlin.collections.Collection)(elements: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale>)` | Cmn |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | Cmn |
| `operator https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#get(kotlin.Int)(i: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#hashCode()()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#isEmpty()()` | Cmn |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterator/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#iterator()()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#toString()()` | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#localeList()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList#size()` | Cmn |

## Public companion properties

### Empty

Cmn Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val Empty: LocaleList
```

An empty instance of `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList`. Usually used to reference a lack of explicit `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale` configuration.

### current

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.13.0-rc01](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.13.0-rc01)

```
val current: LocaleList
```

> [!CAUTION]
> **This property is 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, use this instead:
>
> ```kotlin
> LocalLocaleList.current
> ```

Returns Locale object which represents current locale

## Public constructors

### LocaleList

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
LocaleList(languageTags: String)
```

Create a `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` object from comma separated language tags.

| Parameters |
|---|---|
| `languageTags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | A comma separated [IETF BCP47](https://tools.ietf.org/html/bcp47) compliant language tag. |

### LocaleList

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
LocaleList(localeList: List<Locale>)
```

### LocaleList

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
LocaleList(vararg locales: Locale)
```

Creates a `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList` object from a list of `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/Locale`s.

## Public functions

### contains

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
open operator fun contains(element: Locale): Boolean
```

### containsAll

Cmn Added in [1.11.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.11.0)

```
open fun containsAll(elements: Collection<Locale>): Boolean
```

### equals

Cmn

```
open operator fun equals(other: Any?): Boolean
```

### get

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
operator fun get(i: Int): Locale
```

### hashCode

Cmn

```
open fun hashCode(): Int
```

### isEmpty

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
open fun isEmpty(): Boolean
```

### iterator

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
open operator fun iterator(): Iterator<Locale>
```

### toString

Cmn

```
open fun toString(): String
```

## Public properties

### localeList

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val localeList: List<Locale>
```

### size

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
open val size: Int
```