Bermigrasi dari Swipeable ke AnchoredDraggable

Swipeable adalah Compose Material API yang membantu Anda mem-build komponen yang dapat digeser di antara status terpisah, seperti sheet bawah, panel samping, atau geser untuk menutup. Untuk mendukung kasus penggunaan lanjutan dengan lebih baik, seperti anchor yang bergantung pada ukuran komponen, penerusnya dipublikasikan di Compose-Foundation 1.6.0-alpha01: AnchoredDraggable. AnchoredDraggable adalah Foundation API untuk membuat komponen yang dapat ditarik dengan status yang disematkan, seperti sheet bawah, panel samping, atau geser untuk menutup.

API Swipeable Material tidak digunakan lagi dan diganti dengan AnchoredDraggable Foundation dan akan dihapus dalam rilis mendatang. Panduan ini menjelaskan cara bermigrasi dari Swipeable API ke AnchoredDraggable.

Memigrasikan SwipeableState ke AnchoredDraggableState

Mulailah dengan mengidentifikasi perubahan pada holder status Anda. AnchoredDraggableState tidak dapat diwarisi, dan offset direpresentasikan sebagai Float.NaN sebelum diinisialisasi.

Memperbarui holder status

AnchoredDraggableState adalah class final, yang berarti tidak dapat diwariskan. Jika komponen yang ada mewarisi dari SwipeableState, perbarui holder status untuk menyimpan referensi ke AnchoredDraggableState, bukan mewarisi darinya:

class MySwitchState: SwipeableState()

class MySwitchState {
    private val anchoredDraggableState = AnchoredDraggableState(...)
}

Karena holder status Anda tidak lagi mewarisi dari SwipeableState, Anda mungkin harus mengekspos API sendiri. API paling umum yang dapat Anda gunakan adalah offset, progress, currentValue, dan targetValue.

Mengakses offset

Tidak seperti di Swipeable, offset AnchoredDraggableState adalah Float.NaN sebelum diinisialisasi. Di AnchoredDraggable, anchor dapat diteruskan ke konstruktor AnchoredDraggableState atau diperbarui melalui AnchoredDraggableState#updateAnchors. Meneruskan anchor ke konstruktor AnchoredDraggableState akan langsung melakukan inisialisasi offset.

Jika anchor Anda bergantung pada tata letak atau dapat berubah, gunakan AnchoredDraggableState#updateAnchors untuk menghindari pembuatan ulang status saat anchor berubah.

Jika Anda menggunakan updateAnchors, offset-nya akan menjadi Float.NaN sebelum meneruskan anchor ke updateAnchors. Untuk menghindari penerusan Float.NaN secara tidak sengaja ke komponen, gunakan AnchoredDraggableState#requireOffset untuk mewajibkan offset telah diinisialisasi saat membacanya. Hal ini membantu Anda menemukan inkonsistensi atau kemungkinan bug sejak awal.

@Composable
fun AnchoredDraggableBox() {
    val state = remember { AnchoredDraggableState(...) }
    val density = LocalDensity.current
    val anchors = remember { DraggableAnchors { ... } }
    SideEffect {
        state.updateAnchors(anchors)
    }
    Box(
        Modifier.offset { IntOffset(x = state.requireOffset(), y = 0) }
    }
}

Memigrasikan Modifier.swipeable ke Modifier.anchoredDraggable

Modifier.anchoredDraggable() menggantikan Modifier.swipeable. Beberapa parameter Modifier.swipeable() telah dipindahkan ke AnchoredDraggableState secara langsung, seperti yang dijelaskan di bagian berikut.

Menentukan anchor

Tentukan anchor menggunakan metode builder DraggableAnchors. Kemudian, teruskan ke konstruktor AnchoredDraggableState#updateAnchors atau AnchoredDraggableState:

enum class DragValue { Start, Center, End }

@Composable
fun AnchoredDraggableBox() {
    val anchors = DraggableAnchors {
        Start at -100.dp.toPx()
        Center at 0f
        End at 100.dp.toPx()
    }
    val state = remember {
        AnchoredDraggableState(anchors = anchors)
    }
    Box(
        Modifier.offset { IntOffset(x = state.requireOffset(), y = 0) }
    )
}

enum class DragValue { Start, Center, End }

@Composable
fun AnchoredDraggableBox() {
    val state = remember { AnchoredDraggableState(...) }
    val density = LocalDensity.current
    val anchors = with (density) {
        DraggableAnchors {
            Start at -100.dp.toPx()
            Center at 0f
            End at 100.dp.toPx()
        }
    }
    SideEffect {
        state.updateAnchors(anchors)
    }
    Box(
        Modifier.offset { IntOffset(x = state.requireOffset(), y = 0) }
    )
}

Jika anchor bersifat statis, teruskan ke konstruktor. Jika bergantung pada tata letak, atau tidak statis, gunakan updateAnchors.

Menentukan nilai minimum posisi

Jenis dan nama parameter nilai minimum telah berubah. Daripada memiliki antarmuka ThresholdConfig terpisah, AnchoredDraggableState memiliki parameter positionalThreshold yang menggunakan fungsi lambda yang menampilkan posisi nilai minimum. Misalnya, nilai minimum posisi sebesar 50% dapat dinyatakan sebagai:

val anchoredDraggableState = AnchoredDraggableState(
    positionalThreshold = { distance -> distance * 0.5f },
    ...
)

Batas posisi 56dp dapat dinyatakan sebagai:

val density = LocalDensity.current
val anchoredDraggableState = AnchoredDraggableState(
    positionalThreshold = { with(density) { 56.dp.toPx() } },
    ...
)

Menentukan nilai minimum kecepatan

Batas kecepatan juga diteruskan ke konstruktor AnchoredDraggableState, dan juga dinyatakan sebagai lambda:

val density = LocalDensity.current
val anchoredDraggableState = AnchoredDraggableState(
    velocityThreshold = { with(density) { 125.dp.toPx() } },
    ...
)

Perubahan pada platform API

Temukan ringkasan perubahan pada platform API di bawah.

AnchoredDraggableState

Modifier.anchoredDraggable