TextRange

Added in 1.0.0

Cmn
```
value class TextRange
```

An immutable text range class, represents a text range from start (inclusive) to end (exclusive). end can be smaller than start and in those cases min and max can be used in order to fetch the values.

Summary

Public companion properties
`TextRange`	`Zero`	Cmn

Public functions
`operator Boolean`	`contains(offset: Int)` Returns true if the given offset is a part of this range.	Cmn
`operator Boolean`	`contains(other: TextRange)` Returns true if this range covers including equals with the given range.	Cmn
`Boolean`	`intersects(other: TextRange)` Returns true if the given range has intersection with this range	Cmn
`open String`	`toString()`	Cmn

Public properties
`Boolean`	`collapsed` Returns true if the range is collapsed	Cmn
`Int`	`end`	Cmn
`Int`	`length` Returns the length of the range.	Cmn
`Int`	`max` The maximum offset of the range.	Cmn
`Int`	`min` The minimum offset of the range.	Cmn
`Boolean`	`reversed` Returns true if the start offset is larger than the end offset.	Cmn
`Int`	`start`	Cmn

Extension functions
`TextRange`	`TextRange.coerceIn(minimumValue: Int, maximumValue: Int)` Ensures that `TextRange.start` and `TextRange.end` values lies in the specified range `minimumValue` and `maximumValue`.	Cmn

Public companion properties

Zero

Cmn

Added in 1.0.0

val Zero: TextRange

Public functions

contains

Cmn

Added in 1.1.0

operator fun contains(offset: Int): Boolean

Returns true if the given offset is a part of this range.

contains

Cmn

Added in 1.10.0

operator fun contains(other: TextRange): Boolean

Returns true if this range covers including equals with the given range.

intersects

Cmn

Added in 1.10.0

fun intersects(other: TextRange): Boolean

Returns true if the given range has intersection with this range

toString

Cmn

open fun toString(): String

Public properties

collapsed

Cmn

Added in 1.2.0

val collapsed: Boolean

Returns true if the range is collapsed

end

Cmn

Added in 1.2.0

val end: Int

length

Cmn

Added in 1.2.0

val length: Int

Returns the length of the range.

max

Cmn

Added in 1.2.0

val max: Int

The maximum offset of the range.

min

Cmn

Added in 1.2.0

val min: Int

The minimum offset of the range.

reversed

Cmn

Added in 1.2.0

val reversed: Boolean

Returns true if the start offset is larger than the end offset.

start

Cmn

Added in 1.2.0

val start: Int

Extension functions

TextRange.coerceIn

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

fun TextRange.coerceIn(minimumValue: Int, maximumValue: Int): TextRange

Ensures that TextRange.start and TextRange.end values lies in the specified range minimumValue and maximumValue. For each TextRange.start and TextRange.end values:

if value is smaller than minimumValue, value is replaced by minimumValue
if value is greater than maximumValue, value is replaced by maximumValue

Parameters
`minimumValue: Int`	the minimum value that `TextRange.start` or `TextRange.end` can be.
`maximumValue: Int`	the exclusive maximum value that `TextRange.start` or `TextRange.end` can be.