Tworzenie układu ze szczegółami listy

implementation("androidx.compose.material3.adaptive:adaptive")
implementation("androidx.compose.material3.adaptive:adaptive-layout")
implementation("androidx.compose.material3.adaptive:adaptive-navigation")

implementation 'androidx.compose.material3.adaptive:adaptive'
implementation 'androidx.compose.material3.adaptive:adaptive-layout'
implementation 'androidx.compose.material3.adaptive:adaptive-navigation'

• adaptacyjne: elementy składowe niskiego poziomu, takie jak HingeInfo i Posture;
• adaptive-layout: układy adaptacyjne, np. ListDetailPaneScaffold i SupportingPaneScaffold;
• adaptive-navigation: komponenty kompozycyjne do nawigacji w ramach paneli i między nimi, a także układy adaptacyjne, które domyślnie obsługują nawigację, np. NavigableListDetailPaneScaffold i NavigableSupportingPaneScaffold;

Upewnij się, że projekt zawiera compose-material3-adaptive w wersji 1.1.0-beta1 lub nowszej.

Włączanie gestu przewidywanego przejścia wstecz

Aby włączyć animacje przewidywanego przejścia wstecz w Androidzie 15 lub starszym, musisz wyrazić zgodę na obsługę gestu przewidywanego przejścia wstecz. Aby wyrazić zgodę, dodaj android:enableOnBackInvokedCallback="true" do tagu <application> lub poszczególnych tagów <activity> w pliku AndroidManifest.xml. Więcej informacji znajdziesz w artykule Akceptacja gestu przewidywanego przejścia wstecz.

Gdy aplikacja jest kierowana na Androida 16 (API na poziomie 36) lub nowszego, funkcja przewidywanego przejścia wstecz jest domyślnie włączona.

Podstawowe użycie

Wdróż NavigableListDetailPaneScaffold w ten sposób:

1. Użyj klasy, która reprezentuje wybrane treści. Użyj klasy Parcelable, aby umożliwić zapisywanie i przywracanie wybranego elementu listy. Użyj wtyczki kotlin-parcelize, aby wygenerować kod.
2. Utwórz ThreePaneScaffoldNavigator za pomocą rememberListDetailPaneScaffoldNavigator.

Ten nawigator służy do przechodzenia między listą, szczegółami i dodatkowymi panelami. Deklarując typ ogólny, nawigator śledzi też stan widoku (czyli to, który widżet MyItem jest wyświetlany). Ten typ można przekazywać, więc nawigator może zapisywać i przywracać stan, aby automatycznie obsługiwać zmiany konfiguracji.

1. Przekaż nawigator do komponentu NavigableListDetailPaneScaffold.

2. Prześlij implementację panelu listy do NavigableListDetailPaneScaffold. Użyj AnimatedPane, aby podczas nawigacji zastosować domyślne animacje paneli. Następnie użyj ThreePaneScaffoldNavigator do przejścia do okienka szczegółów ListDetailPaneScaffoldRole.Detail i wyświetl przekazany element.

3. Umieść implementację panelu szczegółów w NavigableListDetailPaneScaffold.

Po zakończeniu nawigacji zmienna currentDestination zawiera panel, do którego aplikacja przeszła, w tym treść wyświetlaną w tym panelu. Właściwość contentKey jest tego samego typu co określony w pierwotnym wywołaniu, więc możesz uzyskać dostęp do wszystkich danych, które chcesz wyświetlić.

1. Opcjonalnie zmień wartość defaultBackBehavior w pliku NavigableListDetailPaneScaffold. Domyślnie usługa NavigableListDetailPaneScaffold używa PopUntilScaffoldValueChange w przypadku defaultBackBehavior.

Jeśli Twoja aplikacja wymaga innego wzorca przechodzenia wstecz, możesz zastąpić to zachowanie, określając inną opcję BackNavigationBehavior.

Liczba opcji: BackNavigationBehavior

W tej sekcji używamy przykładu aplikacji do poczty e-mail z listą e-maili w jednym panelu i widokiem szczegółowym w drugim.

PopUntilScaffoldValueChange (domyślny i zalecany w większości przypadków)

Dotyczy to zmian w ogólnej strukturze układu. W konfiguracji wielopanelowej zmiana treści e-maila w panelu szczegółowym nie zmienia struktury układu. Dlatego przycisk Wstecz może spowodować zamknięcie aplikacji lub bieżącego wykresu nawigacji, ponieważ w bieżącym kontekście nie ma zmiany układu, do której można by wrócić. W układzie z jednym panelem naciśnięcie przycisku Wstecz spowoduje pominięcie zmian treści w widoku szczegółowym i powrót do widoku listy, ponieważ jest to wyraźna zmiana układu.

Oto przykłady:

• Wielopanelowy: w panelu szczegółów wyświetlasz e-maila (element 1). Kliknięcie innego e-maila (element 2) powoduje zaktualizowanie panelu szczegółów, ale panele listy i szczegółów pozostają widoczne. Naciśnięcie przycisku Wstecz może spowodować zamknięcie aplikacji lub bieżącego procesu nawigacji.
• Jeden panel: wyświetlasz element 1, a następnie element 2. Naciśnięcie przycisku Wstecz spowoduje powrót bezpośrednio do panelu listy e-maili.

Używaj tego ustawienia, gdy chcesz, aby użytkownicy postrzegali wyraźne przejścia układu przy każdym działaniu „Wstecz”.

PopUntilContentChange

Takie działanie nadaje priorytet wyświetlanym treściom. Jeśli wyświetlisz Element 1, a potem Element 2, naciśnięcie przycisku Wstecz spowoduje powrót do Elementu 1, niezależnie od układu.

Oto przykłady:

• Wielopanelowy: wyświetlasz element 1 w panelu szczegółów, a następnie klikasz element 2 na liście. Okienko szczegółów zostanie zaktualizowane. Naciśnięcie przycisku Wstecz przywróci w okienku szczegółów element 1.
• Jeden panel: następuje przywrócenie tych samych treści.

Używaj tej opcji, gdy użytkownik oczekuje, że po kliknięciu przycisku Wstecz wróci do wcześniej wyświetlanych treści.

PopUntilCurrentDestinationChange

To działanie powoduje usunięcie z powrotem elementów z stosu wstecznego do momentu zmiany bieżącego miejsca docelowego nawigacji. Dotyczy to zarówno układów z 1 panelem, jak i z wieloma panelami.

Oto przykłady:

Niezależnie od tego, czy korzystasz z układu z jednym czy z wieloma panelami, naciśnięcie przycisku Wstecz zawsze przenosi fokus z zaznaczonego elementu nawigacji do poprzedniego miejsca docelowego. W aplikacji do poczty e-mail oznacza to, że wizualny wskaźnik wybranego panelu przesunie się.

Używaj tej opcji, gdy utrzymanie wyraźnego wizualnego wskazania bieżącej nawigacji ma kluczowe znaczenie dla wygody użytkownika.

PopLatest

Ta opcja usuwa z listy tylko ostatnie miejsce docelowe. Użyj tej opcji, aby przejść wstecz bez pomijania stanów pośrednich.

Po wykonaniu tych czynności kod powinien wyglądać podobnie do tego:

NavigableListDetailPaneScaffold(
    navigator = navigator,
    listPane = {
        AnimatedPane {
            ListContent(
                words = sampleWords,
                selectionState = navigator.currentDestination?.contentKey?.let {
                    SelectionVisibilityState.ShowSelection(it)
                } ?: SelectionVisibilityState.NoSelection,
                onWordClick = { word ->
                    scope.launch {
                        navigator.navigateTo(ListDetailPaneScaffoldRole.Detail, word)
                    }
                },
                animatedVisibilityScope = this@AnimatedPane,
                sharedTransitionScope = this@SharedTransitionLayout
            )
        }
    },
    detailPane = {
        AnimatedPane {
            DetailContent(
                definedWord = navigator.currentDestination?.contentKey,
                animatedVisibilityScope = this@AnimatedPane,
                sharedTransitionScope = this@SharedTransitionLayout,
                onClosePane = {
                    scope.launch {
                        navigator.navigateBack(
                            backNavigationBehavior = BackNavigationBehavior.PopUntilScaffoldValueChange
                        )

                    }
                }
            )
        }
    }
ListDetailSample.kt