Selektory dat

Selektory daty umożliwiają użytkownikom wybieranie daty, zakresu dat lub obu tych opcji. Używają okna kalendarza lub pola tekstowego, aby umożliwić użytkownikom wybieranie dat.

Typy

Istnieją 3 rodzaje selektorów daty:

  • Zadokowany: pojawia się w układzie. Sprawdza się w kompaktowych układach, w których dedykowane okno może wydawać się zbyt inwazyjne.
  • Modalne: wyświetlają się jako okno dialogowe nakładające się na zawartość aplikacji. Dzięki temu użytkownik może skupić się na wyborze daty.
  • Dane wejściowe w oknie: łączy pole tekstowe z selektorem daty w oknie.

Te selektory daty możesz zaimplementować w aplikacji za pomocą tych funkcji kompozycyjnych:

  • DatePicker: ogólny element kompozycyjny selektora daty. Używany kontener określa, czy jest on zadokowany czy modelowy.
  • DatePickerDialog: kontener dla modalnych selektorów daty i modalnych selektorów daty do wprowadzania.
  • DateRangePicker: w przypadku dowolnego selektora daty, w którym użytkownik może wybrać zakres z datą rozpoczęcia i zakończenia.

Stan

Kluczowym parametrem, który jest wspólny dla różnych funkcji kompozycyjnych selektora daty, jest state, który przyjmuje obiekt DatePickerState lub DateRangePickerState. Ich właściwości rejestrują informacje o wyborze użytkownika za pomocą selektora daty, np. aktualnie wybraną datę.

Więcej informacji o tym, jak możesz wykorzystać wybraną datę, znajdziesz w sekcji dotyczącej używania wybranej daty.

Zadokowany selektor daty

W przykładzie poniżej znajduje się pole tekstowe, w którym użytkownik jest proszony o wpisanie daty urodzenia. Gdy klikną ikonę kalendarza w polu, otworzy się zadokowany selektor daty pod polem do wprowadzania danych.

@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))
}

Najważniejsze informacje o kodzie

  • Selektor daty pojawia się, gdy użytkownik kliknie IconButton.
    • Przycisk ikony służy jako argument parametru trailingIcon elementu OutlinedTextField.
    • Zmienna stanu showDatePicker kontroluje widoczność zadokowanego selektora daty.
  • Kontener selektora daty to funkcja kompozycyjna Popup, która nakłada się na treść bez wpływu na układ innych elementów.
  • selectedDate pobiera wartość wybranej daty z obiektu DatePickerState i formatuje ją za pomocą funkcji convertMillisToDate.
  • Wybrana data pojawi się w polu tekstowym.
  • Zadokowany selektor daty jest umieszczany pod polem tekstowym za pomocą modyfikatora offset.
  • Jako kontener główny używany jest element Box, który umożliwia prawidłowe nakładanie pola tekstowego i selektora daty.

Wyniki

Po kliknięciu ikony kalendarza ta implementacja wygląda tak:

Przykład zadokowanego selektora daty.
Rysunek 1. Zadokowany selektor daty.

Modalny selektor daty wyświetla okno, które unosi się nad ekranem. Aby go zaimplementować, utwórz obiekt DatePickerDialog i przekaż mu obiekt 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)
    }
}

  • Funkcja typu „composable” DatePickerModal wyświetla modalny selektor daty.
  • Wyrażenie lambda onDateSelected jest wykonywane, gdy użytkownik wybierze datę.
    • Udostępnia wybraną datę nadrzędnemu elementowi kompozycyjnemu.
  • Wyrażenie lambda onDismiss jest wykonywane, gdy użytkownik zamknie okno.

Wyniki

Implementacja wygląda tak:

Przykład modalnego selektora daty.
Rysunek 2. Selektor daty w oknie.

Selektor daty w oknie modalnym wprowadzania danych

Modalny selektor daty z polem do wprowadzania danych wyświetla okno, które unosi się nad ekranem i umożliwia użytkownikowi wpisanie daty.

@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)
    }
}

Jest to bardzo podobne do przykładu modalnego selektora daty. Główna różnica jest taka:

  • Parametr initialDisplayMode ustawia początkowy tryb wyświetlania na DisplayMode.Input.
Modalny selektor daty z polem tekstowym.
Rysunek 3. Modalny selektor daty z polem do wpisywania.

Selektor daty z zakresem

Możesz utworzyć selektor daty, który umożliwia użytkownikowi wybranie zakresu między datą rozpoczęcia a datą zakończenia. Aby to zrobić, użyj DateRangePicker.

Użycie DateRangePicker jest zasadniczo takie samo jak DatePicker. Możesz go używać jako zadokowanego selektora jako elementu podrzędnego PopUp lub jako selektora modalnego i przekazać go do DatePickerDialog. Główna różnica polega na tym, że używasz DateRangePickerState zamiast DatePickerState.

Poniższy fragment kodu pokazuje, jak utworzyć modalny selektor daty z zakresem:

@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)
        )
    }
}

Najważniejsze informacje o kodzie

  • Parametr onDateRangeSelected to wywołanie zwrotne, które otrzymuje obiekt Pair<Long?, Long?> reprezentujący wybrane daty rozpoczęcia i zakończenia. Dzięki temu nadrzędny element kompozycyjny ma dostęp do wybranego zakresu.
  • rememberDateRangePickerState() tworzy stan selektora zakresu dat.
  • DatePickerDialog tworzy kontener okna modalnego.
  • W module obsługi onClick przycisku potwierdzenia onDateRangeSelected przekazuje wybrany zakres do nadrzędnego elementu kompozycyjnego.
  • Funkcja kompozycyjna DateRangePicker służy jako treść okna.

Wyniki

Implementacja wygląda tak:

Przykład selektora zakresu dat w oknie.
Rysunek 4. Modalny selektor daty z wybranym zakresem.

Użyj wybranej daty

Aby zapisać wybraną datę, śledź ją w funkcji kompozycyjnej nadrzędnej jako Long i przekaż wartość do DatePicker w onDateSelected. Poniższy fragment kodu pokazuje, jak to zrobić. Pełną implementację znajdziesz w oficjalnej aplikacji z fragmentami kodu.

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

W zasadzie to samo dotyczy selektorów zakresu dat, ale musisz użyć klasy Pair<Long?, Long?> lub klasy danych, aby przechwycić wartości początkowe i końcowe.

Zobacz też