Xây dựng bố cục danh sách-chi tiết

Danh sách-chi tiết là một mẫu giao diện người dùng bao gồm bố cục ngăn đôi, trong đó một ngăn trình bày danh sách các mục và một ngăn khác hiển thị thông tin chi tiết về các mục được chọn từ danh sách.

Mẫu này đặc biệt hữu ích cho các ứng dụng cung cấp thông tin chuyên sâu về các phần tử của các bộ sưu tập lớn, ví dụ: một ứng dụng email có danh sách email và nội dung chi tiết của từng email. Bạn cũng có thể sử dụng thành phần hiển thị danh sách-chi tiết cho các đường dẫn ít quan trọng hơn, chẳng hạn như chia các tuỳ chọn của ứng dụng thành danh sách danh mục với các tuỳ chọn cho từng danh mục trong ngăn chi tiết.

Triển khai mẫu giao diện người dùng bằng ListDetailPaneScaffold

ListDetailPaneScaffold là một thành phần kết hợp giúp đơn giản hoá việc triển khai mẫu chi tiết danh sách trong ứng dụng. Cấu trúc chi tiết danh sách có thể bao gồm tối đa 3 ngăn: ngăn danh sách, ngăn chi tiết và một ngăn bổ sung không bắt buộc. Cấu trúc này xử lý các phép tính không gian màn hình. Khi có đủ kích thước màn hình, ngăn chi tiết sẽ hiển thị cùng với ngăn danh sách. Trên các kích thước màn hình nhỏ, ngăn xếp sẽ tự động chuyển sang hiển thị danh sách hoặc ngăn chi tiết ở chế độ toàn màn hình.

Khai báo phần phụ thuộc

ListDetailPaneScaffold là một phần của thư viện bố cục thích ứng Material 3.

Thêm ba phần phụ thuộc có liên quan sau vào tệp build.gradle của ứng dụng hoặc mô-đun:

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'

• thích ứng – Các khối xây dựng cấp thấp như HingeInfo và Posture
• adaptive-layout – Bố cục thích ứng như ListDetailPaneScaffold và SupportingPaneScaffold
• adaptive-navigation – Các thành phần kết hợp để điều hướng trong và giữa các ngăn

Cách sử dụng cơ bản

Triển khai ListDetailPaneScaffold như sau:

1. Sử dụng một lớp đại diện cho nội dung cần chọn. Lớp này phải là Parcelable để hỗ trợ việc lưu và khôi phục mục danh sách đã chọn. Sử dụng trình bổ trợ kotlin-parcelize để tạo mã cho bạn.

   @Parcelize
   class MyItem(val id: Int) : Parcelable
   SampleListDetailPaneScaffold.kt

2. Tạo ThreePaneScaffoldNavigator bằng rememberListDetailPaneScaffoldNavigator và thêm BackHandler. Trình điều hướng này được dùng để di chuyển giữa danh sách, chi tiết và các ngăn bổ sung. Bằng cách khai báo một loại chung, trình điều hướng cũng theo dõi trạng thái của ngăn xếp (tức là MyItem nào đang hiển thị). Vì loại này có thể phân đoạn, nên trình điều hướng có thể lưu và khôi phục trạng thái để tự động xử lý các thay đổi về cấu hình. BackHandler hỗ trợ thao tác quay lại bằng cử chỉ hoặc nút quay lại của hệ thống. Hành vi dự kiến của nút quay lại cho ListDetailPaneScaffold phụ thuộc vào kích thước cửa sổ và giá trị của giàn hiện tại. Nếu ListDetailPaneScaffold có thể hỗ trợ quay lại trạng thái hiện tại, thì canNavigateBack() là true, cho phép BackHandler.

   val navigator = rememberListDetailPaneScaffoldNavigator<MyItem>()
   
   BackHandler(navigator.canNavigateBack()) {
       navigator.navigateBack()
   }
   SampleListDetailPaneScaffold.kt

3. Truyền scaffoldState từ navigator đến thành phần kết hợp ListDetailPaneScaffold.

   ListDetailPaneScaffold(
       directive = navigator.scaffoldDirective,
       value = navigator.scaffoldValue,
       // ...
   )
   SampleListDetailPaneScaffold.kt

4. Cung cấp cách triển khai ngăn danh sách cho ListDetailPaneScaffold. Sử dụng AnimatedPane để áp dụng ảnh động ngăn mặc định trong quá trình điều hướng. Sau đó, hãy sử dụng ThreePaneScaffoldNavigator để chuyển đến ngăn chi tiết ListDetailPaneScaffoldRole.Detail và hiển thị mục đã truyền.

   ListDetailPaneScaffold(
       directive = navigator.scaffoldDirective,
       value = navigator.scaffoldValue,
       listPane = {
           AnimatedPane {
               MyList(
                   onItemClick = { item ->
                       // Navigate to the detail pane with the passed item
                       navigator.navigateTo(ListDetailPaneScaffoldRole.Detail, item)
                   }
               )
           }
       },
       // ...
   )
   SampleListDetailPaneScaffold.kt

5. Thêm cách triển khai ngăn chi tiết vào ListDetailPaneScaffold. Khi quá trình điều hướng hoàn tất, currentDestination sẽ chứa ngăn mà ứng dụng của bạn đã điều hướng đến, bao gồm cả nội dung hiển thị trong ngăn đó. Thuộc tính content có cùng loại được chỉ định trong lệnh gọi ghi nhớ ban đầu (MyItem trong ví dụ này), vì vậy, bạn cũng có thể truy cập vào thuộc tính này cho mọi dữ liệu mà bạn cần hiển thị.

   ListDetailPaneScaffold(
       directive = navigator.scaffoldDirective,
       value = navigator.scaffoldValue,
       listPane =
       // ...
       detailPane = {
           AnimatedPane {
               navigator.currentDestination?.content?.let {
                   MyDetails(it)
               }
           }
       },
   )
   SampleListDetailPaneScaffold.kt

Sau khi bạn triển khai các bước trên, mã của bạn sẽ có dạng như sau:

val navigator = rememberListDetailPaneScaffoldNavigator<MyItem>()

BackHandler(navigator.canNavigateBack()) {
    navigator.navigateBack()
}

ListDetailPaneScaffold(
    directive = navigator.scaffoldDirective,
    value = navigator.scaffoldValue,
    listPane = {
        AnimatedPane {
            MyList(
                onItemClick = { item ->
                    // Navigate to the detail pane with the passed item
                    navigator.navigateTo(ListDetailPaneScaffoldRole.Detail, item)
                },
            )
        }
    },
    detailPane = {
        AnimatedPane {
            // Show the detail pane content if selected item is available
            navigator.currentDestination?.content?.let {
                MyDetails(it)
            }
        }
    },
)
SampleListDetailPaneScaffold.kt