Bermigrasi dari Swipeable ke AnchoredDraggable

Swipeable adalah API Material Compose yang membantu Anda membuat komponen yang dapat di-swipe di antara status diskret, seperti sheet bawah, panel samping, atau swipe untuk menutup. Untuk mendukung kasus penggunaan lanjutan dengan lebih baik, seperti penanda 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 ditambatkan, seperti sheet bawah, panel samping, atau geser untuk menutup.

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

Migrasikan SwipeableState ke AnchoredDraggableState

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

Memperbarui holder status Anda

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

class MySwitchState: SwipeableState()

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

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

Mengakses offset

Tidak seperti di Swipeable, offset AnchoredDraggableState adalah Float.NaN sebelum diinisialisasi. Di AnchoredDraggable, penanda dapat diteruskan ke konstruktor AnchoredDraggableState atau diperbarui melalui AnchoredDraggableState#updateAnchors. Meneruskan penanda ke konstruktor AnchoredDraggableState akan segera menginisialisasi offset.

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

Jika Anda menggunakan updateAnchors, offset akan menjadi Float.NaN sebelum meneruskan anchor ke updateAnchors. Untuk menghindari pengiriman Float.NaN ke komponen secara tidak sengaja, gunakan AnchoredDraggableState#requireOffset untuk mewajibkan offset 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) }
    }
}

Migrasikan Modifier.swipeable ke Modifier.anchoredDraggable

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

Menentukan anchor

Tentukan penanda 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 penanda bersifat statis, teruskan ke konstruktor. Jika bergantung pada tata letak, atau tidak statis, gunakan updateAnchors.

Menentukan batas posisi

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

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

Nilai minimum posisi 56dp dapat dinyatakan sebagai:

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

Menentukan batas kecepatan

Nilai minimum 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