# LineBreak.WordBreak

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

  ```
  value class LineBreak.WordBreak
  ```

*** ** * ** ***

Describes how line breaks should be inserted within words.

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/LineBreak.WordBreak` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/LineBreak.WordBreak#Default()` Default word breaking rules for the locale. | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/LineBreak.WordBreak` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/LineBreak.WordBreak#Phrase()` Line breaking is based on phrases. | android |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/LineBreak.WordBreak` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/LineBreak.WordBreak#Unspecified()` This represents an unset value, a usual replacement for "null" when a primitive value is desired. | android |

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

## Public companion properties

### Default

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

```
val Default: LineBreak.WordBreak
```

Default word breaking rules for the locale. In latin scripts this means inserting line breaks between words, while in languages that don't use whitespace (e.g. Japanese) the line can break between characters.

```
+---+
| This is |
| an      |
| example |
| text.   |
| 今日は自  |
| 由が丘で  |
| 焼き鳥を  |
| 食べま   |
| す。     |
+---+
```

### Phrase

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

```
val Phrase: LineBreak.WordBreak
```

Line breaking is based on phrases. In languages that don't use whitespace (e.g. Japanese), line breaks are not inserted between characters that are part of the same phrase unit. This is ideal for short text such as titles and UI labels.

```
+---+
| This    |
| is an   |
| example |
| text.   |
| 今日は   |
| 自由が丘  |
| で焼き鳥  |
| を食べ   |
| ます。   |
+---+
```

### Unspecified

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

```
val Unspecified: LineBreak.WordBreak
```

This represents an unset value, a usual replacement for "null" when a primitive value is desired.

## Public functions

### toString

android

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