TextLayoutInput

Added in 1.0.0

Cmn
```
class TextLayoutInput
```

The data class which holds the set of parameters of the text layout computation.

Summary

Public constructors
`TextLayoutInput( text: AnnotatedString, style: TextStyle, placeholders: List<AnnotatedString.Range<Placeholder>>, maxLines: Int, softWrap: Boolean, overflow: TextOverflow, density: Density, layoutDirection: LayoutDirection, fontFamilyResolver: FontFamily.Resolver, constraints: Constraints )`	Cmn
`TextLayoutInput( text: AnnotatedString, style: TextStyle, placeholders: List<AnnotatedString.Range<Placeholder>>, maxLines: Int, softWrap: Boolean, overflow: TextOverflow, density: Density, layoutDirection: LayoutDirection, resourceLoader: Font.ResourceLoader, constraints: Constraints )` This function is deprecated. Font.ResourceLoader is replaced with FontFamily.Resolver	Cmn

Public functions
`TextLayoutInput`	`copy( text: AnnotatedString, style: TextStyle, placeholders: List<AnnotatedString.Range<Placeholder>>, maxLines: Int, softWrap: Boolean, overflow: TextOverflow, density: Density, layoutDirection: LayoutDirection, resourceLoader: Font.ResourceLoader, constraints: Constraints )` This function is deprecated. Font.ResourceLoader is deprecated	Cmn
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`Constraints`	`constraints` The minimum width provided while calculating this text layout.	Cmn
`Density`	`density` The density param used for computing this text layout.	Cmn
`FontFamily.Resolver`	`fontFamilyResolver` The font resolver used for computing this text layout.	Cmn
`LayoutDirection`	`layoutDirection` The layout direction used for computing this text layout.	Cmn
`Int`	`maxLines` The maxLines param used for computing this text layout.	Cmn
`TextOverflow`	`overflow` The overflow param used for computing this text layout	Cmn
`List<AnnotatedString.Range<Placeholder>>`	`placeholders` A list of `Placeholder`s inserted into text layout that reserves space to embed icons or custom emojis.	Cmn
`Font.ResourceLoader`	`resourceLoader` This property is deprecated. Replaced with FontFamily.Resolver	Cmn
`Boolean`	`softWrap` The maxLines param used for computing this text layout.	Cmn
`TextStyle`	`style` The text layout used for computing this text layout.	Cmn
`AnnotatedString`	`text` The text used for computing text layout.	Cmn

Public constructors

TextLayoutInput

Cmn

TextLayoutInput(
    text: AnnotatedString,
    style: TextStyle,
    placeholders: List<AnnotatedString.Range<Placeholder>>,
    maxLines: Int,
    softWrap: Boolean,
    overflow: TextOverflow,
    density: Density,
    layoutDirection: LayoutDirection,
    fontFamilyResolver: FontFamily.Resolver,
    constraints: Constraints
)

TextLayoutInput

Cmn

TextLayoutInput(
    text: AnnotatedString,
    style: TextStyle,
    placeholders: List<AnnotatedString.Range<Placeholder>>,
    maxLines: Int,
    softWrap: Boolean,
    overflow: TextOverflow,
    density: Density,
    layoutDirection: LayoutDirection,
    resourceLoader: Font.ResourceLoader,
    constraints: Constraints
)

Public functions

copy

Cmn

fun copy(
    text: AnnotatedString = this.text,
    style: TextStyle = this.style,
    placeholders: List<AnnotatedString.Range<Placeholder>> = this.placeholders,
    maxLines: Int = this.maxLines,
    softWrap: Boolean = this.softWrap,
    overflow: TextOverflow = this.overflow,
    density: Density = this.density,
    layoutDirection: LayoutDirection = this.layoutDirection,
    resourceLoader: Font.ResourceLoader = this.resourceLoader,
    constraints: Constraints = this.constraints
): TextLayoutInput

equals

Cmn

Added in 1.0.0

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

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

constraints

Cmn

Added in 1.0.0

val constraints: Constraints

The minimum width provided while calculating this text layout.

density

Cmn

Added in 1.0.0

val density: Density

The density param used for computing this text layout.

fontFamilyResolver

Cmn

Added in 1.2.0

val fontFamilyResolver: FontFamily.Resolver

The font resolver used for computing this text layout.

layoutDirection

Cmn

Added in 1.0.0

val layoutDirection: LayoutDirection

The layout direction used for computing this text layout.

maxLines

Cmn

Added in 1.0.0

val maxLines: Int

The maxLines param used for computing this text layout.

overflow

Cmn

Added in 1.0.0

val overflow: TextOverflow

The overflow param used for computing this text layout

placeholders

Cmn

Added in 1.0.0

val placeholders: List<AnnotatedString.Range<Placeholder>>

A list of Placeholders inserted into text layout that reserves space to embed icons or custom emojis. A list of bounding boxes will be returned in TextLayoutResult.placeholderRects that corresponds to this input.

See also
`placeholderRects`
`MultiParagraph`
`MultiParagraphIntrinsics`

resourceLoader

Cmn

Added in 1.0.0

Deprecated in 1.2.0

val resourceLoader: Font.ResourceLoader

softWrap

Cmn

Added in 1.0.0

val softWrap: Boolean

The maxLines param used for computing this text layout.

style

Cmn

Added in 1.0.0

val style: TextStyle

The text layout used for computing this text layout.

text

Cmn

Added in 1.0.0

val text: AnnotatedString

The text used for computing text layout.