Package-level declarations

Types

Link copied to clipboard

Jetpack button default values.

Link copied to clipboard

Jetpack chip default values.

Link copied to clipboard

Jetpack icon button default values.

Link copied to clipboard

Jetpack navigation default values.

Link copied to clipboard

Jetpack navigation suite scope for setting item properties.

Link copied to clipboard

Jetpack tab default values.

Link copied to clipboard

Jetpack tag default values.

Link copied to clipboard
data class ToggleOption(@StringRes val text: Int, val icon: ImageVector)

A data class representing a toggle option.

Functions

Link copied to clipboard
fun AppBackground(modifier: Modifier = Modifier, content: @Composable () -> Unit)

The main background for the app. Uses LocalBackgroundTheme to set the color and tonal elevation of a Surface.

Link copied to clipboard
fun AppGradientBackground(modifier: Modifier = Modifier, gradientColors: GradientColors = LocalGradientColors.current, content: @Composable () -> Unit)

A gradient background for select screens. Uses LocalGradientColors to set the gradient colors of a Box within a Surface.

Link copied to clipboard
fun DividerWithText(@StringRes text: Int, modifier: Modifier = Modifier)

A divider with text in the middle.

Link copied to clipboard
fun DynamicAsyncImage(imageUrl: String, contentDescription: String?, modifier: Modifier = Modifier, placeholder: Painter = painterResource(R.drawable.ic_placeholder))

A wrapper around AsyncImage which determines the colorFilter based on the theme.

Link copied to clipboard
fun JetpackActionBar(@StringRes titleRes: Int, @StringRes actionRes: Int, onActionClick: () -> Unit, onNavigateBackClick: () -> Unit, modifier: Modifier = Modifier, colors: TopAppBarColors = TopAppBarDefaults.topAppBarColors())

A Jetpack Compose top app bar with a title, navigation icon, and action button.

Link copied to clipboard
fun JetpackButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, content: @Composable RowScope.() -> Unit)

Jetpack filled button with generic content slot. Wraps Material 3 Button.

fun JetpackButton(onClick: () -> Unit, text: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, leadingIcon: @Composable () -> Unit? = null)

Jetpack filled button with text and icon content slots.

Link copied to clipboard
fun JetpackExtendedFab(icon: ImageVector, @StringRes text: Int, onClick: () -> Unit, modifier: Modifier = Modifier)

Jetpack extended floating action button.

Link copied to clipboard
fun JetpackFilterChip(selected: Boolean, onSelectedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, label: @Composable () -> Unit)

Jetpack filter chip with included leading checked icon as well as text content slot.

Link copied to clipboard
fun JetpackIconToggleButton(checked: Boolean, onCheckedChange: (Boolean) -> Unit, icon: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, checkedIcon: @Composable () -> Unit = icon)

Jetpack toggle button with icon and checked icon content slots. Wraps Material 3 FilledIconToggleButton.

Link copied to clipboard
fun JetpackLoadingWheel(contentDesc: String, modifier: Modifier = Modifier)

An animated loading indicator with 12 rotating lines that fade in and out.

Link copied to clipboard
fun JetpackNavigationBar(modifier: Modifier = Modifier, content: @Composable RowScope.() -> Unit)

Jetpack navigation bar with content slot. Wraps Material 3 NavigationBar.

Link copied to clipboard
fun RowScope.JetpackNavigationBarItem(selected: Boolean, onClick: () -> Unit, icon: @Composable () -> Unit, modifier: Modifier = Modifier, selectedIcon: @Composable () -> Unit = icon, enabled: Boolean = true, label: @Composable () -> Unit? = null, alwaysShowLabel: Boolean = true)

Jetpack navigation bar item with icon and label content slots. Wraps Material 3 NavigationBarItem.

Link copied to clipboard
fun JetpackNavigationRail(modifier: Modifier = Modifier, header: @Composable ColumnScope.() -> Unit? = null, content: @Composable ColumnScope.() -> Unit)

Jetpack navigation rail with header and content slots. Wraps Material 3 NavigationRail.

Link copied to clipboard
fun JetpackNavigationRailItem(selected: Boolean, onClick: () -> Unit, icon: @Composable () -> Unit, modifier: Modifier = Modifier, selectedIcon: @Composable () -> Unit = icon, enabled: Boolean = true, label: @Composable () -> Unit? = null, alwaysShowLabel: Boolean = true)

Jetpack navigation rail item with icon and label content slots. Wraps Material 3 NavigationRailItem.

Link copied to clipboard
fun JetpackNavigationSuiteScaffold(navigationSuiteItems: JetpackNavigationSuiteScope.() -> Unit, modifier: Modifier = Modifier, windowAdaptiveInfo: WindowAdaptiveInfo = currentWindowAdaptiveInfo(), content: @Composable () -> Unit)

Jetpack navigation suite scaffold with item and content slots. Wraps Material 3 NavigationSuiteScaffold.

Link copied to clipboard
fun JetpackOutlinedButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, content: @Composable RowScope.() -> Unit)

Jetpack outlined button with generic content slot. Wraps Material 3 OutlinedButton.

fun JetpackOutlinedButton(onClick: () -> Unit, text: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, leadingIcon: @Composable () -> Unit? = null)

Jetpack outlined button with text and icon content slots.

Link copied to clipboard
fun JetpackOverlayLoadingWheel(contentDesc: String, modifier: Modifier = Modifier)

A loading wheel with a semi-transparent surface background and elevation.

Link copied to clipboard
fun JetpackPasswordFiled(value: String, onValueChange: (String) -> Unit, label: @Composable () -> Unit, leadingIcon: @Composable () -> Unit, modifier: Modifier = Modifier, errorMessage: String? = null)

A Jetpack Compose password field with visibility toggle and error message display.

Link copied to clipboard
fun JetpackTab(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, text: @Composable () -> Unit)

Jetpack tab. Wraps Material 3 Tab and shifts text label down.

Link copied to clipboard
fun JetpackTabRow(selectedTabIndex: Int, modifier: Modifier = Modifier, tabs: @Composable () -> Unit)

Jetpack tab row. Wraps Material 3 TabRow.

Link copied to clipboard
fun JetpackTag(followed: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, text: @Composable () -> Unit)

Jetpack tag.

Link copied to clipboard
fun JetpackTextButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, content: @Composable RowScope.() -> Unit)

Jetpack text button with generic content slot. Wraps Material 3 TextButton.

fun JetpackTextButton(onClick: () -> Unit, text: @Composable () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, leadingIcon: @Composable () -> Unit? = null)

Jetpack text button with text and icon content slots.

Link copied to clipboard
fun JetpackTextFiled(value: String, onValueChange: (String) -> Unit, label: @Composable () -> Unit, leadingIcon: @Composable () -> Unit, modifier: Modifier = Modifier, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, trailingIcon: @Composable () -> Unit = {}, errorMessage: String? = null)

A Jetpack Compose text field with customizable appearance and optional error message display.

Link copied to clipboard
fun JetpackToggleOptions(options: List<ToggleOption>, selectedIndex: Int, onSelectionChange: (Int) -> Unit, modifier: Modifier = Modifier)

A row of toggle options that can be selected. Displays a segmented button-style selector with animated transitions between states.

Link copied to clipboard
fun JetpackTopAppBar(@StringRes titleRes: Int, actionIcon: ImageVector, actionIconContentDescription: String?, modifier: Modifier = Modifier, colors: TopAppBarColors = TopAppBarDefaults.topAppBarColors(), onActionClick: () -> Unit = {})

A Jetpack Compose top app bar with a title and action icon.

fun JetpackTopAppBar(@StringRes titleRes: Int, navigationIcon: ImageVector, navigationIconContentDescription: String?, actionIcon: ImageVector, actionIconContentDescription: String?, modifier: Modifier = Modifier, colors: TopAppBarColors = TopAppBarDefaults.topAppBarColors(), onNavigationClick: () -> Unit = {}, onActionClick: () -> Unit = {})

A Jetpack Compose top app bar with a title, navigation icon, and action icon.

Link copied to clipboard
fun JetpackTopAppBarWithAvatar(@StringRes titleRes: Int, avatarUri: String?, avatarContentDescription: String?, modifier: Modifier = Modifier, colors: TopAppBarColors = TopAppBarDefaults.topAppBarColors(), onAvatarClick: () -> Unit = {})

A Jetpack Compose top app bar with a title and avatar.

Link copied to clipboard
fun SwipeToDismiss(onDelete: () -> Unit, modifier: Modifier = Modifier, content: @Composable () -> Unit)

A composable that allows swiping from end to start to dismiss an item.