RemoteTimeText

Functions summary

Unit
@RemoteComposable
@Composable
RemoteTimeText(
    modifier: RemoteModifier,
    time: RemoteString,
    fontSize: RemoteTextUnit?,
    fontFamily: RemoteFontFamily?,
    leadingText: RemoteString?,
    trailingText: RemoteString?,
    separator: RemoteString,
    color: RemoteColor?,
    style: RemoteTextStyle,
    fontFeatureSettings: String?,
    fontVariationSettings: FontVariation.Settings?
)

A remote composable for displaying the time and surrounding text, designed to curve along the top of a circular screen.

Functions

@RemoteComposable
@Composable
fun RemoteTimeText(
    modifier: RemoteModifier = RemoteModifier,
    time: RemoteString = RemoteTimeDefaults.defaultTimeString(),
    fontSize: RemoteTextUnit? = null,
    fontFamily: RemoteFontFamily? = null,
    leadingText: RemoteString? = null,
    trailingText: RemoteString? = null,
    separator: RemoteString = "·".rs,
    color: RemoteColor? = null,
    style: RemoteTextStyle = RemoteTimeTextDefaults.timeTextStyle,
    fontFeatureSettings: String? = null,
    fontVariationSettings: FontVariation.Settings? = null
): Unit

A remote composable for displaying the time and surrounding text, designed to curve along the top of a circular screen. This is a remote version of the TimeText composable.

RemoteTimeText is typically used at the top of the screen and is the remote equivalent of androidx.wear.compose.material3.TimeText.

Parameters
modifier: RemoteModifier = RemoteModifier

The RemoteModifier to be applied to the RemoteTimeText.

time: RemoteString = RemoteTimeDefaults.defaultTimeString()

The text to display as the time. Defaults to a formatted time string from the remote context.

fontSize: RemoteTextUnit? = null

The size of glyphs to use when painting the text.

fontFamily: RemoteFontFamily? = null

The font family to be used when rendering the text.

leadingText: RemoteString? = null

Text to be displayed before the time, or null if not present.

trailingText: RemoteString? = null

Text to be displayed after the time, or null if not present.

separator: RemoteString = "·".rs

The separator to be used between the leading/trailing text and the time. Defaults to "·".

color: RemoteColor? = null

The color of the text. Defaults to the onBackground color from the current RemoteMaterialTheme.

style: RemoteTextStyle = RemoteTimeTextDefaults.timeTextStyle

The RemoteTextStyle to be applied to the text. Defaults to RemoteTimeTextDefaults.timeTextStyle.

fontFeatureSettings: String? = null

The font feature settings to be applied to the text. Defaults to RemoteTimeTextDefaults.fontFeatureSettings.

fontVariationSettings: FontVariation.Settings? = null

The font variation settings to be applied to the text. Defaults to RemoteTimeTextDefaults.fontVariationSettings.