# KeyboardCapitalization

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/input/KeyboardCapitalization.kt+class:androidx.compose.ui.text.input.KeyboardCapitalization) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/AllAndroid/JVM
- Cmn

  ```
  value class KeyboardCapitalization
  ```

*** ** * ** ***

The capitalization style to be used in `KeyboardOptions`.

Only applicable to text-based `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType`s such as `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Text()` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardType#Ascii()`. IMEs may ignore this option.

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization#Characters()` Capitalizes all characters. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization#None()` Disables auto-capitalization. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization#Sentences()` Capitalizes the first character of every sentence. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization#Unspecified()` The capitalization behavior is not specified. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization#Words()` Capitalizes the first character of every word. | Cmn |

| ### Public functions |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization#toString()()` | Cmn |

## Public companion properties

### Characters

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

```
val Characters: KeyboardCapitalization
```

Capitalizes all characters.

**When to use it**: Ideal for coupon codes, state abbreviations, or license plates.

### None

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

```
val None: KeyboardCapitalization
```

Disables auto-capitalization.

**When to use it**: Ideal for passwords, email addresses, URLs, or search filters.

### Sentences

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

```
val Sentences: KeyboardCapitalization
```

Capitalizes the first character of every sentence.

**When to use it**: Ideal for chat messages, email bodies, or other free-form text.

### Unspecified

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

```
val Unspecified: KeyboardCapitalization
```

The capitalization behavior is not specified.

### Words

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

```
val Words: KeyboardCapitalization
```

Capitalizes the first character of every word.

**When to use it**: Ideal for mailing addresses or contact names.

## Public functions

### toString

Cmn

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