androidx.compose.ui.text
Interfaces
| Paragraph |
A paragraph of text that is laid out. |
| ParagraphIntrinsics |
Calculates and presents the intrinsic width and height of text. |
Classes
| AnnotatedString |
The basic data structure of text with multiple styles. |
| MultiParagraph |
Lays out and renders multiple paragraphs at once. |
| MultiParagraphIntrinsics |
Calculates and provides the intrinsic width and height of text that contains ParagraphStyle. |
| ParagraphStyle |
Paragraph styling configuration for a paragraph. |
| Placeholder |
A placeholder is a rectangle box inserted into text, which tells the text processor to leave an empty space. |
| SoftwareKeyboardController |
Provide software keyboard control. |
| SpanStyle |
Styling configuration for a text span. |
| TextLayoutInput |
The data class which holds the set of parameters of the text layout computation. |
| TextLayoutResult |
The data class which holds text layout result. |
| TextRange |
An immutable text range class, represents a text range from start (inclusive) to end (exclusive). |
| TextStyle |
Styling configuration for a |
| TtsAnnotation |
An annotation that contains the metadata intended for text-to-speech engine. |
| VerbatimTtsAnnotation |
The text associated with this annotation is a series of characters that have to be read verbatim. |
Type-aliases
| ParagraphStyleRange |
The class changes the paragraph level style of the specified range. |
| SpanStyleRange |
The class changes the character level style of the specified range. |
| StringAnnotation |
The class that stores a string type annotation. |
Annotations
| ExperimentalTextApi | |
| InternalTextApi |
Enums
| PlaceholderVerticalAlign |
The settings used to specify how a placeholder is vertically aligned within a text line. |
Top-level functions summary
| AnnotatedString |
AnnotatedString(text: String, spanStyle: SpanStyle, paragraphStyle: ParagraphStyle? = null)Create an AnnotatedString with a spanStyle that will apply to the whole text. |
| AnnotatedString |
AnnotatedString(text: String, paragraphStyle: ParagraphStyle)Create an AnnotatedString with a paragraphStyle that will apply to the whole text. |
| Paragraph |
Paragraph(text: String, style: TextStyle, spanStyles: List<AnnotatedString.Range<SpanStyle>> = listOf(), placeholders: List<AnnotatedString.Range<Placeholder>> = listOf(), maxLines: Int = DefaultMaxLines, ellipsis: Boolean = false, width: Float, density: Density, resourceLoader: Font.ResourceLoader)Lays out a given text with the given constraints. |
| Paragraph |
Paragraph(paragraphIntrinsics: ParagraphIntrinsics, maxLines: Int = DefaultMaxLines, ellipsis: Boolean = false, width: Float)Lays out the text in ParagraphIntrinsics with the given constraints. |
| ParagraphIntrinsics |
ParagraphIntrinsics(text: String, style: TextStyle, spanStyles: List<AnnotatedString.Range<SpanStyle>> = listOf(), placeholders: List<AnnotatedString.Range<Placeholder>> = listOf(), density: Density, resourceLoader: Font.ResourceLoader)Factory method to create a ParagraphIntrinsics. |
| TextRange |
Creates a TextRange where start is equal to end, and the value of those are index. |
| AnnotatedString |
annotatedString(builder: AnnotatedString.Builder.() -> Unit)Build a new AnnotatedString by populating newly created AnnotatedString.Builder provided by builder. |
| AnnotatedString |
buildAnnotatedString(builder: AnnotatedString.Builder.() -> Unit)Build a new AnnotatedString by populating newly created AnnotatedString.Builder provided by builder. |
| TextLayoutResult |
createTextLayoutResult(layoutInput: TextLayoutInput = TextLayoutInput(
text = AnnotatedString(""),
style = TextStyle(),
placeholders = emptyList(),
maxLines = 1,
softWrap = false,
overflow = TextOverflow.Clip,
density = Density(1f),
layoutDirection = LayoutDirection.Ltr,
resourceLoader = object : Font.ResourceLoader {
override fun load(font: Font): Any {
return false
}
},
constraints = Constraints()
), multiParagraph: MultiParagraph = MultiParagraph(
annotatedString = layoutInput.text,
style = layoutInput.style,
width = 0f,
density = layoutInput.density,
resourceLoader = layoutInput.resourceLoader
), size: IntSize = IntSize.Zero) |
| ParagraphStyle |
lerp(start: ParagraphStyle, stop: ParagraphStyle, fraction: Float)Interpolate between two ParagraphStyles. |
| SpanStyle |
Interpolate between two span styles. |
| TextStyle |
Interpolate between two text styles. |
| TextStyle |
resolveDefaults(style: TextStyle, direction: LayoutDirection)Fills missing values in TextStyle with default values and resolve TextDirection. |
Extension functions summary
| For kotlin.CharSequence | |
| String |
CharSequence.substring(range: TextRange) |
| For kotlin.String | |
| String |
String.capitalize(locale: Locale)Returns capitalized String. |
| String |
String.capitalize(localeList: LocaleList)Returns capitalized String. |
| String |
String.decapitalize(locale: Locale)Returns decapitalized String. |
| String |
String.decapitalize(localeList: LocaleList)Returns decapitalized String. |
| String |
String.toLowerCase(locale: |