RemoteTextStyle
class RemoteTextStyle
A remote-aware text style that mirrors androidx.compose.ui.text.TextStyle but uses remote types where applicable.
Summary
Public companion functions |
|
|---|---|
RemoteTextStyle |
fromTextStyle(style: TextStyle)Creates a |
Public companion properties |
|
|---|---|
RemoteTextStyle |
Public functions |
|
|---|---|
RemoteTextStyle |
copy(Creates a copy of this |
RemoteTextStyle |
merge(other: RemoteTextStyle?)Returns a new |
RemoteTextStyle |
merge( |
Public properties |
|
|---|---|
RemoteColor? |
The background color for the text. |
RemoteColor? |
The color of the text |
FontVariation.Settings? |
|
RemoteFontFamily? |
the font family to be used when rendering the text. |
String? |
The advanced typography settings provided by font in CSS format (e.g. "smcp" or "tnum"). |
RemoteTextUnit? |
the size of glyphs to use when painting the text in |
FontStyle? |
the font style to use when painting the text (e.g., |
FontVariation.Settings? |
The font variation settings to be applied to the text. |
FontWeight? |
the typeface thickness to use when painting the text (e.g., |
Hyphens |
The configuration of hyphenation. |
RemoteTextUnit? |
the amount of space to add between each letter in |
LineBreak |
The configuration of line break. |
RemoteTextUnit? |
Line height for the text in |
TextAlign? |
the alignment of the text within the lines of the paragraph. |
TextDecoration? |
the decorations to paint on the text (e.g., |
Public companion functions
fromTextStyle
fun fromTextStyle(style: TextStyle): RemoteTextStyle
Creates a RemoteTextStyle from a TextStyle.
Public companion properties
Public functions
copy
fun copy(
color: RemoteColor? = this.color,
fontSize: RemoteTextUnit? = this.fontSize,
fontWeight: FontWeight? = this.fontWeight,
fontStyle: FontStyle? = this.fontStyle,
fontFamily: RemoteFontFamily? = this.fontFamily,
letterSpacing: RemoteTextUnit? = this.letterSpacing,
background: RemoteColor? = this.background,
textAlign: TextAlign? = this.textAlign,
lineHeight: RemoteTextUnit? = this.lineHeight,
textDecoration: TextDecoration? = this.textDecoration,
lineBreak: LineBreak = this.lineBreak,
hyphens: Hyphens = this.hyphens,
fontFeatureSettings: String? = this.fontFeatureSettings,
fontVariationSettings: FontVariation.Settings? = this.fontVariationSettings
): RemoteTextStyle
Creates a copy of this RemoteTextStyle with the ability to override individual attributes.
merge
fun merge(other: RemoteTextStyle?): RemoteTextStyle
Returns a new RemoteTextStyle that is a combination of this style and the given other style.
If other is null, this style is returned. If other has any null properties, the values from this style are used for those properties.
| Parameters | |
|---|---|
other: RemoteTextStyle? |
The style to merge into this style. |
| Returns | |
|---|---|
RemoteTextStyle |
A new |
merge
fun merge(
color: RemoteColor? = null,
fontSize: RemoteTextUnit? = null,
fontWeight: FontWeight? = null,
fontStyle: FontStyle? = null,
fontFamily: RemoteFontFamily? = null,
letterSpacing: RemoteTextUnit? = null,
background: RemoteColor? = null,
textAlign: TextAlign? = null,
lineHeight: RemoteTextUnit? = null,
textDecoration: TextDecoration? = null,
lineBreak: LineBreak = LineBreak.Unspecified,
hyphens: Hyphens = Hyphens.Unspecified,
fontFeatureSettings: String? = null,
fontVariationSettings: FontVariation.Settings? = null
): RemoteTextStyle
Public properties
combinedFontVariationSettings
val combinedFontVariationSettings: FontVariation.Settings?
fontFamily
val fontFamily: RemoteFontFamily?
the font family to be used when rendering the text.
fontFeatureSettings
val fontFeatureSettings: String?
The advanced typography settings provided by font in CSS format (e.g. "smcp" or "tnum").
fontSize
val fontSize: RemoteTextUnit?
the size of glyphs to use when painting the text in RemoteTextUnit .
fontStyle
val fontStyle: FontStyle?
the font style to use when painting the text (e.g., FontStyle.Italic).
fontVariationSettings
val fontVariationSettings: FontVariation.Settings?
The font variation settings to be applied to the text.
fontWeight
val fontWeight: FontWeight?
the typeface thickness to use when painting the text (e.g., FontWeight.Bold).
letterSpacing
val letterSpacing: RemoteTextUnit?
the amount of space to add between each letter in RemoteTextUnit .
lineHeight
val lineHeight: RemoteTextUnit?
Line height for the text in RemoteTextUnit unit, e.g. SP or EM.
textDecoration
val textDecoration: TextDecoration?
the decorations to paint on the text (e.g., TextDecoration.Underline).