Compose Component

TimeText

Layout to show the current time and a label at the top of the screen.

TimeText

Source set: Android

Added in 1.7.0-alpha01

@Composable
public fun TimeText(
    modifier: Modifier = Modifier,
    timeSource: TimeSource = TimeTextDefaults.timeSource(timeFormat()),
    timeTextStyle: TextStyle = TimeTextDefaults.timeTextStyle(),
    contentPadding: PaddingValues = TimeTextDefaults.ContentPadding,
    startLinearContent: (@Composable () -> Unit)? = null,
    startCurvedContent: (CurvedScope.() -> Unit)? = null,
    endLinearContent: (@Composable () -> Unit)? = null,
    endCurvedContent: (CurvedScope.() -> Unit)? = null,
    textLinearSeparator: @Composable () -> Unit = { TextSeparator(textStyle = timeTextStyle) },
    textCurvedSeparator: CurvedScope.() -> Unit = {
        CurvedTextSeparator(curvedTextStyle = CurvedTextStyle(timeTextStyle))
    },
)

Parameters
modifier Current modifier.
timeSource TimeSource which retrieves the current time and formats it.
timeTextStyle Optional textStyle for the time text itself
contentPadding The spacing values between the container and the content
startLinearContent a slot before the time which is used only on Square screens
startCurvedContent a slot before the time which is used only on Round screens
endLinearContent a slot after the time which is used only on Square screens
endCurvedContent a slot after the time which is used only on Round screens
textLinearSeparator a separator slot which is used only on Square screens
textCurvedSeparator a separator slot which is used only on Round screens

Last updated: