TextDirection

Added in 1.0.0

Cmn
```
value class TextDirection
```

Defines the algorithm used to determine text direction.

See also
`ResolvedTextDirection`

Summary

Public companion functions
`TextDirection`	`valueOf(value: Int)` Creates `TextDirection` from `value`.	Cmn

Public companion properties
`TextDirection`	`Content` Resolves direction using the first strong directional character according to the Unicode Bidirectional Algorithm.	Cmn
`TextDirection`	`ContentOrLtr` Resolves direction based on the first strong directional character according to the Unicode Bidirectional Algorithm.	Cmn
`TextDirection`	`ContentOrRtl` Resolves direction based on the first strong directional character according to the Unicode Bidirectional Algorithm.	Cmn
`TextDirection`	`Ltr` Sets the text direction to Left-to-Right.	Cmn
`TextDirection`	`Rtl` Sets the text direction to Right-to-Left.	Cmn
`TextDirection`	`Unspecified` Represents an unset `TextDirection` value.	Cmn

Public functions
`open String`	`toString()`	Cmn

Public properties
`Int`	`value` internal integer representation of the text direction.	Cmn

Extension functions
`inline TextDirection`	`TextDirection.takeOrElse(block: () -> TextDirection)` If `isSpecified` is true then this is returned, otherwise `block` is executed and its result is returned.	Cmn

Extension properties
`Boolean`	`TextDirection.isSpecified` Returns `true` if this `TextDirection` is not `TextDirection.Unspecified`.	Cmn

Public companion functions

valueOf

Cmn

Added in 1.10.0

fun valueOf(value: Int): TextDirection

Creates TextDirection from value.

Useful for serialization/deserialization.

Parameters
`value: Int`	internal integer representation.

Throws
`IllegalArgumentException`	if `value` is invalid.

See also
`value`

Public companion properties

Content

Cmn

Added in 1.0.0

val Content: TextDirection

Resolves direction using the first strong directional character according to the Unicode Bidirectional Algorithm.

If no strong directional characters are present, falls back to androidx.compose.ui.unit.LayoutDirection, or to androidx.compose.ui.text.intl.LocaleList when creating a androidx.compose.ui.text.Paragraph (ignoring androidx.compose.ui.unit.LayoutDirection).

ContentOrLtr

Cmn

Added in 1.0.0

val ContentOrLtr: TextDirection

Resolves direction based on the first strong directional character according to the Unicode Bidirectional Algorithm.

Falls back to Left-to-Right if no strong directional characters are found.

ContentOrRtl

Cmn

Added in 1.0.0

val ContentOrRtl: TextDirection

Resolves direction based on the first strong directional character according to the Unicode Bidirectional Algorithm.

Falls back to Right-to-Left if no strong directional characters are found.

Ltr

Cmn

Added in 1.0.0

val Ltr: TextDirection

Sets the text direction to Left-to-Right.

Rtl

Cmn

Added in 1.0.0

val Rtl: TextDirection

Sets the text direction to Right-to-Left.

Unspecified

Cmn

Added in 1.6.0

val Unspecified: TextDirection

Represents an unset TextDirection value.

Public functions

toString

Cmn

open fun toString(): String

Public properties

value

Cmn

Added in 1.10.0

val value: Int

internal integer representation of the text direction.

Extension functions

TextDirection.takeOrElse

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

inline fun TextDirection.takeOrElse(block: () -> TextDirection): TextDirection

If isSpecified is true then this is returned, otherwise block is executed and its result is returned.

Extension properties

TextDirection.isSpecified

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

val TextDirection.isSpecified: Boolean

Returns true if this TextDirection is not TextDirection.Unspecified.

See also
`Unspecified`