Compose material3 Date1 and Time pickers
Highly customizable Jetpack Compose components with material3 support for date & time picking.
0.7.2 (Changelog)
| Dependency | Version |
|---|---|
| Kotlin | 1.8.21 |
| Compose compiler | 1.4.7 |
| Compose BOM | 2023.05.01 |
| Material3 | 1.1.0 |
To use this library in your project, in your app module's build.gradle.kts add:
dependencies {
implementation("com.marosseleng.android:compose-material3-datetime-pickers:<LATEST_VERSION>")
}To display a datepicker dialog for a single-date selection, just call
@Composable
fun DatePickerDialog(
onDismissRequest: () -> Unit,
onDateChange: (LocalDate) -> Unit,
modifier: Modifier = Modifier,
initialDate: LocalDate? = null,
locale: Locale = LocalConfiguration.current.getDefaultLocale(),
today: LocalDate = LocalDate.now(),
showDaysAbbreviations: Boolean = true,
highlightToday: Boolean = true,
colors: DatePickerColors = DatePickerDefaults.colors(),
shapes: DatePickerShapes = DatePickerDefaults.shapes(),
typography: DatePickerTypography = DatePickerDefaults.typography(),
title: @Composable (() -> Unit)? = null,
buttonColors: ButtonColors = ButtonDefaults.textButtonColors(),
shape: Shape = AlertDialogDefaults.shape,
containerColor: Color = AlertDialogDefaults.containerColor,
titleContentColor: Color = AlertDialogDefaults.titleContentColor,
tonalElevation: Dp = AlertDialogDefaults.TonalElevation,
properties: DialogProperties = DialogProperties(usePlatformDefaultWidth = false),
)There are only 2 required parameters:
-
onDismissRequest- called when the dialog should be dismissed without user selecting a value -
onDateChange- called when user selected a value, passing it as a parameter
It is, however, recommended to also fill the title parameter, as it provides the title for the dialog.
Remaining parameters as well as the customization guide is described in the separate README.
To display a timepicker dialog, call
@Composable
fun TimePickerDialog(
onDismissRequest: () -> Unit,
onTimeChange: (LocalTime) -> Unit,
modifier: Modifier = Modifier,
initialTime: LocalTime = LocalTime.now().noSeconds(),
locale: Locale = LocalConfiguration.current.getDefaultLocale(),
is24HourFormat: Boolean = DateFormat.is24HourFormat(LocalContext.current),
colors: TimePickerColors = TimePickerDefaults.colors(),
shapes: TimePickerShapes = TimePickerDefaults.shapes(),
typography: TimePickerTypography = TimePickerDefaults.typography(),
title: @Composable (() -> Unit)? = null,
buttonColors: ButtonColors = ButtonDefaults.textButtonColors(),
shape: Shape = AlertDialogDefaults.shape,
containerColor: Color = AlertDialogDefaults.containerColor,
tonalElevation: Dp = AlertDialogDefaults.TonalElevation,
properties: DialogProperties = DialogProperties(),
)The 2 required parameters are:
-
onDismissRequest- called when the dialog should be dismissed without user selecting a value -
onTimeChange- called when user selected a value, passing it as a parameter
It is, however, recommended to also fill the title parameter, as it provides the title for the dialog.
Remaining parameters as well as the customization guide is described in the separate README.
This library uses the Java 8's java.time APIs such as LocalDate and LocalTime. If your targetSdk is less than 26, you have to enable desugaring:
In your module's build.gradle.kts add:
android {
// ...
compileOptions {
isCoreLibraryDesugaringEnabled = true
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}
}
dependencies {
// ...
coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.2.2")
}While the library is currently ready to use as-is, until version 1.0.0 is released, it's API isn't considered stable. Contributions in the form of API changes suggestions and discussions are very welcome.
Copyright 2022 Maroš Šeleng
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
Date picker for range selection is still a work in progress. ↩
