Composables
Docs Login
Tally

Main Navigation

Jetpack Compose Component

Download
package com.composables.tally.components

import androidx.compose.foundation.background
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.WindowInsets
import androidx.compose.foundation.layout.WindowInsetsSides
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.navigationBars
import androidx.compose.foundation.layout.only
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.safeDrawing
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.layout.union
import androidx.compose.foundation.layout.windowInsetsPadding
import androidx.compose.foundation.selection.selectable
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.vector.ImageVector
import androidx.compose.ui.semantics.Role
import androidx.compose.ui.unit.dp
import com.composables.compose.ripple.rememberRippleIndication
import com.composables.tally.theme.ChartBar
import com.composables.tally.theme.GearSix
import com.composables.tally.theme.House
import com.composables.tally.theme.Icons
import com.composables.tally.theme.Space
import com.composables.tally.theme.Theme

enum class Destination(val label: String, val icon: ImageVector) {
    Today("Today", Icons.House),
    Progress("Progress", Icons.ChartBar),
    Settings("Settings", Icons.GearSix),
}

@Composable
fun MainNavigation(
    selected: Destination,
    onSelect: (Destination) -> Unit,
    modifier: Modifier = Modifier,
) {
    Row(
        modifier
            .fillMaxWidth()
            .background(Theme.colors.background)
            .windowInsetsPadding(
                WindowInsets.navigationBars.union(
                    WindowInsets.safeDrawing.only(WindowInsetsSides.Horizontal)
                )
            )
            .padding(horizontal = Space * 4, vertical = Space * 2),
        horizontalArrangement = Arrangement.SpaceEvenly,
    ) {
        Destination.entries.forEach { destination ->
            val isSelected = destination == selected
            val tint = if (isSelected) Theme.colors.primary else Theme.colors.onBackgroundMuted
            Column(
                Modifier.weight(1f)
                    .clip(Theme.shapes.small)
                    .selectable(
                        selected = isSelected,
                        onClick = { onSelect(destination) },
                        role = Role.Tab,
                        interactionSource = remember { MutableInteractionSource() },
                        indication = rememberRippleIndication(color = Theme.colors.primary),
                    )
                    .padding(vertical = Space * 2),
                horizontalAlignment = Alignment.CenterHorizontally,
                verticalArrangement = Arrangement.spacedBy(Space),
            ) {
                Icon(
                    destination.icon,
                    contentDescription = null,
                    modifier = Modifier.size(24.dp),
                    tint = tint,
                )
                Text(destination.label, style = Theme.typography.caption, color = tint)
            }
        }
    }
}

@Composable
fun MainNavigationScaffold(
    selected: Destination,
    navigateToHome: () -> Unit,
    navigateToProgress: () -> Unit,
    navigateToSettings: () -> Unit,
    modifier: Modifier = Modifier,
    content: @Composable (contentPadding: PaddingValues) -> Unit,
) {
    ScreenScaffold(
        modifier = modifier,
        bottomBar = {
            MainNavigation(
                selected = selected,
                onSelect = { destination ->
                    when (destination) {
                        selected -> Unit
                        Destination.Today -> navigateToHome()
                        Destination.Progress -> navigateToProgress()
                        Destination.Settings -> navigateToSettings()
                    }
                },
            )
        },
    ) { contentPadding ->
        content(contentPadding)
    }
}

More components from Tally

by Alex Styl

Search screens and components

Screen flows

Screens

UI Elements

One Android lesson, every Wednesday

Building Android apps?

What Alex learned building Android apps for 14 years, so you don't have to. Reads in under a minute.

Join 3,500+ Android developers. Unsubscribe any time.

You're subscribed

The next lesson lands in on Wednesday.