# VerticalTextStyle

Artifact: [androidx.text:text-vertical-compose](https://developer.android.com/jetpack/androidx/releases/text) [View Source](https://cs.android.com/search?q=file:androidx/text/vertical/compose/VerticalTextStyle.kt+class:androidx.text.vertical.compose.VerticalTextStyle) Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)


```
class VerticalTextStyle
```

<br />

*** ** * ** ***

A style object for vertical text, containing only members supported by `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalText.composable#VerticalText(kotlin.CharSequence,androidx.compose.ui.Modifier,androidx.text.vertical.compose.VerticalTextStyle,androidx.compose.ui.text.style.TextOverflow,kotlin.Int,kotlin.Int,androidx.text.vertical.TextOrientation)`.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#Default()` Default `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` with all members unspecified. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#VerticalTextStyle(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.TextUnit,androidx.compose.ui.text.font.FontWeight,androidx.compose.ui.text.font.FontStyle,androidx.compose.ui.text.font.FontSynthesis,androidx.compose.ui.text.font.FontFamily,kotlin.String,androidx.compose.ui.graphics.Color,androidx.compose.ui.text.intl.LocaleList)( color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, fontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit, fontWeight: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight?, fontStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontStyle?, fontSynthesis: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontSynthesis?, fontFamily: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontFamily?, fontFeatureSettings: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, background: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, localeList: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList? )` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#copy(androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.TextUnit,androidx.compose.ui.text.font.FontWeight,androidx.compose.ui.text.font.FontStyle,androidx.compose.ui.text.font.FontSynthesis,androidx.compose.ui.text.font.FontFamily,kotlin.String,androidx.compose.ui.graphics.Color,androidx.compose.ui.text.intl.LocaleList)( color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, fontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit, fontWeight: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight?, fontStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontStyle?, fontSynthesis: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontSynthesis?, fontFamily: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontFamily?, fontFeatureSettings: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, background: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, localeList: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList? )` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#hashCode()()` |
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#merge(androidx.text.vertical.compose.VerticalTextStyle)(other: https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle?)` Returns a new `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` that is a combination of this style and the given `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#merge(androidx.text.vertical.compose.VerticalTextStyle)` style. |
| `operator https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#plus(androidx.text.vertical.compose.VerticalTextStyle)(other: https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle)` Plus operator overload for `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#merge(androidx.text.vertical.compose.VerticalTextStyle)`. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#background()` The background color for the text. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#color()` The text color. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontFamily?` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#fontFamily()` The font family to use when rendering the text. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#fontFeatureSettings()` The advanced typography settings for the font. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#fontSize()` The size of glyphs to use when painting the text. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontStyle?` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#fontStyle()` The typeface variant to use when drawing the letters (e.g., italic). |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontSynthesis?` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#fontSynthesis()` Whether to synthesize font weight and/or style when they are not available in the font family. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight?` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#fontWeight()` The thickness of the glyph strokes. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList?` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#localeList()` The locales of the text. |

## Public companion properties

### Default

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
val Default: VerticalTextStyle
```

Default `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` with all members unspecified.

## Public constructors

### VerticalTextStyle

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
VerticalTextStyle(
    color: Color = Color.Unspecified,
    fontSize: TextUnit = TextUnit.Unspecified,
    fontWeight: FontWeight? = null,
    fontStyle: FontStyle? = null,
    fontSynthesis: FontSynthesis? = null,
    fontFamily: FontFamily? = null,
    fontFeatureSettings: String? = null,
    background: Color = Color.Unspecified,
    localeList: LocaleList? = null
)
```

| Parameters |
|---|---|
| `color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The text color. |
| `fontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit = TextUnit.Unspecified` | The size of glyphs to use when painting the text. |
| `fontWeight: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight? = null` | The thickness of the glyph strokes. |
| `fontStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontStyle? = null` | The typeface variant to use when drawing the letters (e.g., italic). |
| `fontSynthesis: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontSynthesis? = null` | Whether to synthesize font weight and/or style when they are not available in the font family. |
| `fontFamily: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontFamily? = null` | The font family to use when rendering the text. |
| `fontFeatureSettings: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | The advanced typography settings for the font. |
| `background: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The background color for the text. |
| `localeList: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/intl/LocaleList? = null` | The locales of the text. |

## Public functions

### copy

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
fun copy(
    color: Color = this.color,
    fontSize: TextUnit = this.fontSize,
    fontWeight: FontWeight? = this.fontWeight,
    fontStyle: FontStyle? = this.fontStyle,
    fontSynthesis: FontSynthesis? = this.fontSynthesis,
    fontFamily: FontFamily? = this.fontFamily,
    fontFeatureSettings: String? = this.fontFeatureSettings,
    background: Color = this.background,
    localeList: LocaleList? = this.localeList
): VerticalTextStyle
```

### equals

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

### hashCode

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

### merge

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
fun merge(other: VerticalTextStyle?): VerticalTextStyle
```

Returns a new `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` that is a combination of this style and the given `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#merge(androidx.text.vertical.compose.VerticalTextStyle)` style.

If a property is specified in `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#merge(androidx.text.vertical.compose.VerticalTextStyle)`, it will be used in the result. Otherwise, the property from this style will be used.

### plus

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
operator fun plus(other: VerticalTextStyle): VerticalTextStyle
```

Plus operator overload for `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle#merge(androidx.text.vertical.compose.VerticalTextStyle)`.

### toString

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

## Public properties

### background

```
val background: Color
```

The background color for the text.

### color

```
val color: Color
```

The text color.

### fontFamily

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
val fontFamily: FontFamily?
```

The font family to use when rendering the text.

### fontFeatureSettings

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
val fontFeatureSettings: String?
```

The advanced typography settings for the font.

### fontSize

```
val fontSize: TextUnit
```

The size of glyphs to use when painting the text.

### fontStyle

```
val fontStyle: FontStyle?
```

The typeface variant to use when drawing the letters (e.g., italic).

### fontSynthesis

```
val fontSynthesis: FontSynthesis?
```

Whether to synthesize font weight and/or style when they are not available in the font family.

### fontWeight

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
val fontWeight: FontWeight?
```

The thickness of the glyph strokes.

### localeList

Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
val localeList: LocaleList?
```

The locales of the text.