基本的な Parcelable レシピ

このレシピでは、kotlinx.serialization を使用せずに、構成の変更後も維持される永続的なバックスタックを作成する方法の基本的な例を示します。代わりに、Android の Parcelable と kotlin-parcelize プラグインを使用して、ナビゲーションの状態を保存して復元します。

仕組み

この例では、RouteA と RouteB はマーカー インターフェース Route を実装しています。このインターフェース自体が Parcelable を拡張しています。また、kotlin-parcelize プラグインの @Parcelize アノテーションも付いています。これにより、Parcelable の実装が自動的に生成されます。

sealed interface Route : Parcelable

@Parcelize
data object RouteA : Route

@Parcelize
data class RouteB(val id: String) : Route

バックスタックを永続的にするために、このレシピでは rememberParcelableBackStack 関数を定義します。NavDisplay やその他のコンポーザブルがバックスタックの変更を認識できるように、バックスタックは SnapshotStateList に保存されます。

@Composable
fun <T : Parcelable> rememberParcelableBackStack(vararg elements: T): SnapshotStateList<T> {
    return rememberSaveable {
        mutableStateListOf(*elements)
    }
}

これは、kotlinx.serialization に依存する androidx.navigation3.runtime の組み込み rememberNavBackStack の代替として機能します。アプリケーションで Parcelable を厳密に優先し、kotlinx.serialization に依存しない場合は、この方法を使用します。

/*
 * Copyright 2026 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.basicparcelable

import android.os.Bundle
import android.os.Parcelable
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material3.Button
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.mutableStateListOf
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.snapshots.SnapshotStateList
import androidx.lifecycle.compose.dropUnlessResumed
import androidx.navigation3.runtime.NavEntry
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.parcelize.Parcelize

sealed interface Route : Parcelable

@Parcelize
data object RouteA : Route

@Parcelize
data class RouteB(val id: String) : Route

/**
 * Creates and remembers a [SnapshotStateList] to hold a back stack of [Parcelable] routes
 * that survives configuration changes and process death.
 *
 * @param T The route type, which must implement [Parcelable].
 * @param elements The initial routes to populate the back stack.
 * @return A reactive [SnapshotStateList] managing the navigation back stack.
 */
@Composable
fun <T : Parcelable> rememberParcelableBackStack(vararg elements: T): SnapshotStateList<T> {
    return rememberSaveable {
        mutableStateListOf(*elements)
    }
}

class BasicParcelableActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)
        setContent {
            val backStack = rememberParcelableBackStack<Route>(RouteA)

            NavDisplay(
                backStack = backStack,
                onBack = { backStack.removeLastOrNull() },
                entryProvider = { key ->
                    when (key) {
                        is RouteA -> NavEntry(key) {
                            ContentGreen("Welcome to Nav3") {
                                Button(onClick = dropUnlessResumed {
                                    backStack.add(RouteB("123"))
                                }) {
                                    Text("Click to navigate")
                                }
                            }
                        }

                        is RouteB -> NavEntry(key) {
                            ContentBlue("Route id: ${key.id} ")
                        }
                    }
                }
            )
        }
    }
}