Pemilih tanggal

Pemilih tanggal memungkinkan pengguna memilih tanggal, rentang tanggal, atau keduanya. Mereka menggunakan dialog kalender atau input teks untuk memungkinkan pengguna memilih tanggal.

Jenis

Ada tiga jenis pemilih tanggal:

• Terpasang ke dok: Muncul secara inline dalam tata letak. Ini cocok untuk tata letak ringkas saat dialog khusus mungkin terasa mengganggu.
• Modal: Muncul sebagai dialog yang menempatkan konten aplikasi. Hal ini memberikan fokus yang jelas pada pemilihan tanggal.
• Input modal: Menggabungkan kolom teks dengan pemilih tanggal modal.

Anda dapat menerapkan pemilih tanggal ini di aplikasi Anda menggunakan composable:

• DatePicker: Composable umum untuk pemilih tanggal. Penampung yang Anda gunakan menentukan apakah penampung tersebut di-dock atau model.
• DatePickerDialog: Penampung untuk pemilih tanggal input modal dan modal.
• DateRangePicker: Untuk pemilih tanggal apa pun tempat pengguna dapat memilih rentang dengan tanggal mulai dan akhir.

Catatan: DatePicker, DatePickerDialog, dan DateRangePicker bersifat eksperimental. Laporkan masalah apa pun di Issue Tracker.

Status

Parameter utama yang sama-sama dimiliki oleh berbagai composable pemilih tanggal adalah state, yang menggunakan objek DatePickerState atau DateRangePickerState. Properti mereka mengambil informasi tentang pilihan pengguna menggunakan pemilih tanggal, seperti tanggal yang dipilih saat ini.

Untuk informasi selengkapnya tentang cara memanfaatkan tanggal yang dipilih, lihat dokumen bagian tanggal yang dipilih.

Pemilih tanggal yang dikaitkan ke dok

Pada contoh berikut, ada kolom teks yang meminta pengguna untuk memasukkan tanggal lahir mereka. Ketika mereka mengeklik ikon kalender di bidang, hal itu akan membuka pemilih tanggal dipasang ke dok di bawah kolom input.

@Composable
fun DatePickerDocked() {
    var showDatePicker by remember { mutableStateOf(false) }
    val datePickerState = rememberDatePickerState()
    val selectedDate = datePickerState.selectedDateMillis?.let {
        convertMillisToDate(it)
    } ?: ""

    Box(
        modifier = Modifier.fillMaxWidth()
    ) {
        OutlinedTextField(
            value = selectedDate,
            onValueChange = { },
            label = { Text("DOB") },
            readOnly = true,
            trailingIcon = {
                IconButton(onClick = { showDatePicker = !showDatePicker }) {
                    Icon(
                        imageVector = Icons.Default.DateRange,
                        contentDescription = "Select date"
                    )
                }
            },
            modifier = Modifier
                .fillMaxWidth()
                .height(64.dp)
        )

        if (showDatePicker) {
            Popup(
                onDismissRequest = { showDatePicker = false },
                alignment = Alignment.TopStart
            ) {
                Box(
                    modifier = Modifier
                        .fillMaxWidth()
                        .offset(y = 64.dp)
                        .shadow(elevation = 4.dp)
                        .background(MaterialTheme.colorScheme.surface)
                        .padding(16.dp)
                ) {
                    DatePicker(
                        state = datePickerState,
                        showModeToggle = false
                    )
                }
            }
        }
    }
}

@Composable
fun DatePickerFieldToModal(modifier: Modifier = Modifier) {
    var selectedDate by remember { mutableStateOf<Long?>(null) }
    var showModal by remember { mutableStateOf(false) }

    OutlinedTextField(
        value = selectedDate?.let { convertMillisToDate(it) } ?: "",
        onValueChange = { },
        label = { Text("DOB") },
        placeholder = { Text("MM/DD/YYYY") },
        trailingIcon = {
            Icon(Icons.Default.DateRange, contentDescription = "Select date")
        },
        modifier = modifier
            .fillMaxWidth()
            .pointerInput(selectedDate) {
                awaitEachGesture {
                    // Modifier.clickable doesn't work for text fields, so we use Modifier.pointerInput
                    // in the Initial pass to observe events before the text field consumes them
                    // in the Main pass.
                    awaitFirstDown(pass = PointerEventPass.Initial)
                    val upEvent = waitForUpOrCancellation(pass = PointerEventPass.Initial)
                    if (upEvent != null) {
                        showModal = true
                    }
                }
            }
    )

    if (showModal) {
        DatePickerModal(
            onDateSelected = { selectedDate = it },
            onDismiss = { showModal = false }
        )
    }
}

fun convertMillisToDate(millis: Long): String {
    val formatter = SimpleDateFormat("MM/dd/yyyy", Locale.getDefault())
    return formatter.format(Date(millis))
}
DatePickers.kt

Catatan: Contoh ini bersifat mandiri. Untuk mengetahui cara mengekspos tanggal yang dipilih ke composable induk, lihat contoh lainnya.

Poin penting tentang kode

• Alat pilih tanggal muncul saat pengguna mengklik IconButton.
  • Tombol ikon berfungsi sebagai argumen untuk parameter trailingIcon OutlinedTextField.
  • Variabel status showDatePicker mengontrol visibilitas pemilih tanggal yang di-dock.
• Penampung pemilih tanggal adalah composable Popup, yang menempatkan konten tanpa mempengaruhi tata letak elemen lain.
• selectedDate menangkap nilai tanggal yang dipilih dari objek DatePickerState dan memformatnya menggunakan convertMillisToDate fungsi tersebut.
• Tanggal yang dipilih akan muncul di kolom teks.
• Pemilih tanggal yang dipasang ke dok diposisikan di bawah kolom teks menggunakan offset pengubah.
• Box digunakan sebagai penampung root untuk memungkinkan pelapisan kolom teks dan pemilih tanggal yang tepat.

Hasil

Setelah mengklik ikon kalender, implementasi ini akan muncul sebagai berikut:

Gambar 1. Pemilih tanggal yang di-dock.

Pemilih tanggal modal

Pemilih tanggal modal menampilkan dialog yang mengambang di atas layar. Untuk menerapkannya, buat DatePickerDialog dan teruskan DatePicker.

@Composable
fun DatePickerModal(
    onDateSelected: (Long?) -> Unit,
    onDismiss: () -> Unit
) {
    val datePickerState = rememberDatePickerState()

    DatePickerDialog(
        onDismissRequest = onDismiss,
        confirmButton = {
            TextButton(onClick = {
                onDateSelected(datePickerState.selectedDateMillis)
                onDismiss()
            }) {
                Text("OK")
            }
        },
        dismissButton = {
            TextButton(onClick = onDismiss) {
                Text("Cancel")
            }
        }
    ) {
        DatePicker(state = datePickerState)
    }
}
DatePickers.kt

Poin penting tentang kode

• Fungsi composable DatePickerModal menampilkan pemilih tanggal modal.
• Ekspresi lambda onDateSelected dijalankan saat pengguna memilih tanggal.
  • Fungsi ini mengekspos tanggal yang dipilih ke composable induk.
• Ekspresi lambda onDismiss dijalankan saat pengguna menutup dialog.

Hasil

Implementasi ini muncul sebagai berikut:

Gambar 2. Pemilih tanggal modal.

Input pemilih tanggal modal

Pemilih tanggal modal dengan input menampilkan dialog yang mengambang di atas layar dan memungkinkan pengguna memasukkan tanggal.

@Composable
fun DatePickerModalInput(
    onDateSelected: (Long?) -> Unit,
    onDismiss: () -> Unit
) {
    val datePickerState = rememberDatePickerState(initialDisplayMode = DisplayMode.Input)

    DatePickerDialog(
        onDismissRequest = onDismiss,
        confirmButton = {
            TextButton(onClick = {
                onDateSelected(datePickerState.selectedDateMillis)
                onDismiss()
            }) {
                Text("OK")
            }
        },
        dismissButton = {
            TextButton(onClick = onDismiss) {
                Text("Cancel")
            }
        }
    ) {
        DatePicker(state = datePickerState)
    }
}
DatePickers.kt

Poin penting tentang kode

Ini sangat mirip dengan contoh pemilih tanggal modal. Perbedaan utama adalah sebagai berikut:

• Parameter initialDisplayMode menetapkan mode tampilan awal ke DisplayMode.Input.

Gambar 3. Pemilih tanggal modal dengan input.

Pemilih tanggal dengan rentang

Anda dapat membuat pemilih tanggal yang memungkinkan pengguna memilih rentang antara tanggal mulai dan akhir. Untuk melakukannya, gunakan DateRangePicker.

Penggunaan DateRangePicker pada dasarnya sama dengan DatePicker. Anda dapat menggunakannya untuk pemilih yang di-dock sebagai turunan PopUp, atau Anda dapat menggunakannya sebagai pemilih modal dan meneruskannya ke DatePickerDialog. Perbedaan utamanya adalah Anda menggunakan DateRangePickerState, bukan DatePickerState.

Cuplikan berikut menunjukkan cara membuat pemilih tanggal modal dengan rentang:

@Composable
fun DateRangePickerModal(
    onDateRangeSelected: (Pair<Long?, Long?>) -> Unit,
    onDismiss: () -> Unit
) {
    val dateRangePickerState = rememberDateRangePickerState()

    DatePickerDialog(
        onDismissRequest = onDismiss,
        confirmButton = {
            TextButton(
                onClick = {
                    onDateRangeSelected(
                        Pair(
                            dateRangePickerState.selectedStartDateMillis,
                            dateRangePickerState.selectedEndDateMillis
                        )
                    )
                    onDismiss()
                }
            ) {
                Text("OK")
            }
        },
        dismissButton = {
            TextButton(onClick = onDismiss) {
                Text("Cancel")
            }
        }
    ) {
        DateRangePicker(
            state = dateRangePickerState,
            title = {
                Text(
                    text = "Select date range"
                )
            },
            showModeToggle = false,
            modifier = Modifier
                .fillMaxWidth()
                .height(500.dp)
                .padding(16.dp)
        )
    }
}
DatePickers.kt

Poin penting tentang kode

• Parameter onDateRangeSelected adalah callback yang menerima Pair<Long?, Long?> yang menunjukkan tanggal mulai dan akhir yang dipilih. Ini memberi composable induk akses ke rentang yang dipilih.
• rememberDateRangePickerState() membuat status untuk pemilih rentang tanggal.
• DatePickerDialog membuat container dialog modal.
• Di pengendali onClick tombol konfirmasi, onDateRangeSelected akan diteruskan rentang yang dipilih ke composable induk.
• Composable DateRangePicker berfungsi sebagai konten dialog.

Hasil

Implementasi ini muncul sebagai berikut:

Gambar 4. Pemilih tanggal modal dengan rentang yang dipilih.

Gunakan tanggal yang dipilih

Untuk mengambil tanggal yang dipilih, lacak di composable induk sebagai Long dan teruskan nilai ke DatePicker di onDateSelected. Cuplikan berikut menunjukkan hal ini, meskipun Anda dapat melihat implementasi lengkapnya di aplikasi cuplikan resmi.

// ...
    var selectedDate by remember { mutableStateOf<Long?>(null) }
// ...
        if (selectedDate != null) {
            val date = Date(selectedDate!!)
            val formattedDate = SimpleDateFormat("MMM dd, yyyy", Locale.getDefault()).format(date)
            Text("Selected date: $formattedDate")
        } else {
            Text("No date selected")
        }
// ...
        DatePickerModal(
            onDateSelected = {
                selectedDate = it
                showModal = false
            },
            onDismiss = { showModal = false }
        )
    }
// ...
DatePickers.kt

Pada dasarnya, hal yang sama berlaku untuk pemilih tanggal rentang, meskipun Anda harus gunakan Pair<Long?, Long?> atau class data untuk mengambil nilai awal dan akhir.

Penting: Daripada menggunakan Long untuk tanggal yang dipilih, Anda dapat meneruskan status objek itu sendiri dari composable induk ke turunan. Melakukan hal itu akan Anda mengambil status lengkap di induk.

Lihat juga

• Pemilih tanggal Desain Material
• Pemilih waktu