دستور العمل رابط کاربری رایج

این دستورالعمل نحوه پیاده‌سازی یک الگوی رابط کاربری ناوبری رایج با یک نوار ناوبری پایین و چندین پشته پشتی را نشان می‌دهد، که در آن هر برگه در نوار ناوبری تاریخچه ناوبری خاص خود را دارد.

چگونه کار می‌کند؟

این مثال سه مقصد سطح بالا دارد: Home ، ChatList و Camera . مقصد ChatList همچنین یک زیرمسیر به ChatDetail دارد.

TopLevelBackStack

هسته اصلی این دستورالعمل، کلاس TopLevelBackStack است که وظیفه مدیریت وضعیت ناوبری را بر عهده دارد. این کلاس به شرح زیر عمل می‌کند:

  • برای هر مقصد سطح بالا (تب) یک پشته پشتی جداگانه نگهداری می‌کند.
  • این مسیر، مقصد سطح بالای انتخاب‌شده‌ی فعلی را ردیابی می‌کند.
  • این یک پشته پشتی مسطح و واحد ارائه می‌دهد که می‌تواند توسط NavDisplay composable مورد استفاده قرار گیرد. این پشته پشتی مسطح ترکیبی از پشته‌های پشتی جداگانه همه تب‌ها است.

ساختار رابط کاربری

رابط کاربری با استفاده از یک Scaffold composable ساخته شده است و یک NavigationBar به عنوان bottomBar دارد.

  • NavigationBar برای هر مقصد سطح بالا، یک آیتم نمایش می‌دهد. وقتی روی یک آیتم کلیک می‌شود، topLevelBackStack.addTopLevel را برای رفتن به تب مربوطه فراخوانی می‌کند و تاریخچه ناوبری هر تب را حفظ می‌کند.
  • کامپوننت NavDisplay در قسمت محتوای Scaffold قرار می‌گیرد. این کامپوننت مسئول نمایش صفحه فعلی بر اساس back stack مسطح ارائه شده توسط TopLevelBackStack است.

این رویکرد امکان ایجاد یک الگوی ناوبری مشترک را فراهم می‌کند که در آن کاربران می‌توانند بین بخش‌های مختلف برنامه جابجا شوند و هر بخش تاریخچه ناوبری خود را حفظ می‌کند.

حفاظت از ایالت

توجه به نحوه مدیریت وضعیت ناوبری در این دستورالعمل مهم است. وقتی کاربر از یک مقصد سطح بالا خارج می‌شود (مثلاً با فشار دادن دکمه برگشت تا زمانی که به برگه قبلی برگردد)، کل تاریخچه ناوبری آن مقصد پاک می‌شود. وضعیت ذخیره نمی‌شود. وقتی کاربر بعداً به آن برگه برگردد، از صفحه اولیه آن شروع خواهد کرد.

نکته : در این مثال، مسیر Home می‌تواند بالاتر از مسیرهای ChatList و Camera حرکت کند، به این معنی که بازگشت از Home لزوماً به معنای خروج از برنامه نیست. برنامه زمانی خارج می‌شود که کاربر از یک مسیر سطح بالای باقی‌مانده در back stack برگردد.

/*
 * Copyright 2025 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.example.nav3recipes.commonui

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Face
import androidx.compose.material.icons.filled.Home
import androidx.compose.material.icons.filled.PlayArrow
import androidx.compose.material3.Button
import androidx.compose.material3.Icon
import androidx.compose.material3.NavigationBar
import androidx.compose.material3.NavigationBarItem
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateListOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.runtime.snapshots.SnapshotStateList
import androidx.compose.ui.graphics.vector.ImageVector
import androidx.lifecycle.compose.dropUnlessResumed
import androidx.navigation3.runtime.entryProvider
import androidx.navigation3.ui.NavDisplay
import com.example.nav3recipes.content.ContentBlue
import com.example.nav3recipes.content.ContentGreen
import com.example.nav3recipes.content.ContentPurple
import com.example.nav3recipes.content.ContentRed
import com.example.nav3recipes.ui.setEdgeToEdgeConfig

private sealed interface TopLevelRoute {
    val icon: ImageVector
}
private data object Home : TopLevelRoute { override val icon = Icons.Default.Home }
private data object ChatList : TopLevelRoute { override val icon = Icons.Default.Face }
private data object ChatDetail
private data object Camera : TopLevelRoute { override val icon = Icons.Default.PlayArrow }

private val TOP_LEVEL_ROUTES : List<TopLevelRoute> = listOf(Home, ChatList, Camera)

class CommonUiActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)
        setContent {
            val topLevelBackStack = remember { TopLevelBackStack<Any>(Home) }

            Scaffold(
                bottomBar = {
                    NavigationBar {
                        TOP_LEVEL_ROUTES.forEach { topLevelRoute ->

                            val isSelected = topLevelRoute == topLevelBackStack.topLevelKey
                            NavigationBarItem(
                                selected = isSelected,
                                onClick = {
                                    topLevelBackStack.addTopLevel(topLevelRoute)
                                },
                                icon = {
                                    Icon(
                                        imageVector = topLevelRoute.icon,
                                        contentDescription = null
                                    )
                                }
                            )
                        }
                    }
                }
            ) { _ ->
                NavDisplay(
                    backStack = topLevelBackStack.backStack,
                    onBack = { topLevelBackStack.removeLast() },
                    entryProvider = entryProvider {
                        entry<Home>{
                            ContentRed("Home screen")
                        }
                        entry<ChatList>{
                            ContentGreen("Chat list screen"){
                                Button(onClick = dropUnlessResumed {
                                    topLevelBackStack.add(ChatDetail)
                                }) {
                                    Text("Go to conversation")
                                }
                            }
                        }
                        entry<ChatDetail>{
                            ContentBlue("Chat detail screen")
                        }
                        entry<Camera>{
                            ContentPurple("Camera screen")
                        }
                    },
                )
            }
        }
    }
}

class TopLevelBackStack<T: Any>(startKey: T) {

    // Maintain a stack for each top level route
    private var topLevelStacks : LinkedHashMap<T, SnapshotStateList<T>> = linkedMapOf(
        startKey to mutableStateListOf(startKey)
    )

    // Expose the current top level route for consumers
    var topLevelKey by mutableStateOf(startKey)
        private set

    // Expose the back stack so it can be rendered by the NavDisplay
    val backStack = mutableStateListOf(startKey)

    private fun updateBackStack() =
        backStack.apply {
            clear()
            addAll(topLevelStacks.flatMap { it.value })
        }

    fun addTopLevel(key: T){

        // If the top level doesn't exist, add it
        if (topLevelStacks[key] == null){
            topLevelStacks.put(key, mutableStateListOf(key))
        } else {
            // Otherwise just move it to the end of the stacks
            topLevelStacks.apply {
                remove(key)?.let {
                    put(key, it)
                }
            }
        }
        topLevelKey = key
        updateBackStack()
    }

    fun add(key: T){
        topLevelStacks[topLevelKey]?.add(key)
        updateBackStack()
    }

    fun removeLast(){
        val removedKey = topLevelStacks[topLevelKey]?.removeLastOrNull()
        // If the removed key was a top level key, remove the associated top level stack
        topLevelStacks.remove(removedKey)
        topLevelKey = topLevelStacks.keys.last()
        updateBackStack()
    }
}