وصفة DSL الأساسية

تعرض هذه الوصفة مثالاً أساسيًا على كيفية استخدام واجهة برمجة التطبيقات Navigation 3 مع شاشتَين، وذلك باستخدام لغة entryProvider الخاصة بالمجال (DSL) وسجلّ رجوع ثابت.

آلية العمل

يشبه هذا المثال الوصفة الأساسية، ولكن مع بعض الاختلافات الرئيسية:

  1. سجلّ الرجوع الدائم: يستخدم rememberNavBackStack(RouteA) لإنشاء سجلّ الرجوع وتذكُّره. ويؤدي ذلك إلى استمرار عمل سجلّ الرجوع أثناء تغييرات الإعدادات (مثل تدوير الشاشة). لاستخدام rememberNavBackStack، يجب أن تكون مفاتيح التنقّل قابلة للتسلسل، وهذا هو السبب في أنّ RouteA وRouteB يتمّ وضع تعليقات توضيحية لهما باستخدام @Serializable وتنفيذ واجهة NavKey.

  2. entryProvider DSL: بدلاً من عبارة when، يستخدم هذا المثال entryProvider DSL لتحديد محتوى كل مسار. تُستخدَم الدالة entry<RouteType> لربط نوع مسار بالمحتوى القابل للإنشاء.

تظلّ منطق التنقّل كما هو: للانتقال من RouteA إلى RouteB، نضيف مثيلاً من RouteB إلى حزمة الخلف.

/*
 * 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.basicdsl

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material3.Button
import androidx.compose.material3.Text
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.entryProvider
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.ui.NavDisplay
import com.example.nav3recipes.content.ContentBlue
import com.example.nav3recipes.content.ContentGreen
import com.example.nav3recipes.ui.setEdgeToEdgeConfig
import kotlinx.serialization.Serializable

@Serializable
private data object RouteA : NavKey

@Serializable
private data class RouteB(val id: String) : NavKey

class BasicDslActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)
        setContent {
            val backStack = rememberNavBackStack(RouteA)

            NavDisplay(
                backStack = backStack,
                onBack = { backStack.removeLastOrNull() },
                entryProvider = entryProvider {
                    entry<RouteA> {
                        ContentGreen("Welcome to Nav3") {
                            Button(onClick = {
                                backStack.add(RouteB("123"))
                            }) {
                                Text("Click to navigate")
                            }
                        }
                    }
                    entry<RouteB> { key ->
                        ContentBlue("Route id: ${key.id} ")
                    }
                }
            )
        }
    }
}