TitleBar

Composable Function

Android

@SuppressLint("ComposableLambdaParameterNaming") // lint thinks `actions` should be called `content`
@Composable
public fun TitleBar(
    startIcon: ImageProvider,
    title: String,
    iconColor: ColorProvider? = GlanceTheme.colors.onSurface,
    textColor: ColorProvider = GlanceTheme.colors.onSurface,
    modifier: GlanceModifier = GlanceModifier,
    fontFamily: FontFamily? = null,
    actions: @Composable RowScope.() -> Unit = {},
)

A Title Bar. Contains an Icon, Text, and actions. Intended to be placed at the top of a widget.

Parameters


startIcon	A tintable icon representing your app or brand.
title	Text to be displayed. Generally the name of your widget or app. Title should be shortened or omitted when the widget's width is narrow. The width can be checked using `LocalSize.current.width`
iconColor	The color which `startIcon` will be tinted.
textColor	The color which `title` will be tinted.
modifier	GlanceModifier.
fontFamily	Optional override for `title`'s font family. Leave null to use the default.
actions	A slot api for buttons. Use `CircleIconButton` with backgroundColor = null. Buttons will be placed in a `Row`.