Add README for time picker.

datetimepickers/src/main/java/com/marosseleng/compose/material3/datetimepickers/time/ui/dialog/TimePickerDialog.kt

@@ -22,6 +22,7 @@ import com.marosseleng.compose.material3.datetimepickers.time.domain.TimePickerC
 import com.marosseleng.compose.material3.datetimepickers.time.domain.TimePickerDefaults
 import com.marosseleng.compose.material3.datetimepickers.time.domain.TimePickerShapes
 import com.marosseleng.compose.material3.datetimepickers.time.domain.TimePickerTypography
+import com.marosseleng.compose.material3.datetimepickers.time.domain.noSeconds
 import com.marosseleng.compose.material3.datetimepickers.time.ui.TimePicker
 import java.time.LocalTime
 
@@ -40,7 +41,7 @@ public fun TimePickerDialog(
  onDismissRequest: () -> Unit,
  onTimeChange: (LocalTime) -> Unit,
  modifier: Modifier = Modifier,
- initialTime: LocalTime = LocalTime.now(),
+ initialTime: LocalTime = LocalTime.now().noSeconds(),
  colors: TimePickerColors = TimePickerDefaults.colors,
  shapes: TimePickerShapes = TimePickerDefaults.shapes,
  typography: TimePickerTypography = TimePickerDefaults.typography,

docs/timepicker/README.md

@@ -0,0 +1,59 @@
+# Time picker
+
+A highly customizable time picker for Jetpack Compose. Material3 theme-compatible.
+![demo-video](resources/timepicker-demo.webm)
+
+## Usage
+
+A base composable `fun TimePicker()` displays the time picker. It is recommended to wrap the time picker in an `(Alert)Dialog` composable.
+
+An example of such usage can be seen in `fun TimePickerDialog()`.
+
+There are 2 mandatory parameters for `TimePickerDialog`:
+
+- `onDismissRequest`: called when user wants to dismiss the dialog without selecting the time;
+- `onTimeChange`: called when user taps the confirmation button, the parameter is the `LocalTime` representing the selected time.
+
+Example of `TimePickerDialog` usage:
+
+ ```kotlin
+ var isDialogShown: Boolean by rememberSaveable {
+ mutableStateOf(false)
+ }
+ val (selectedTime, setSelectedTime) = rememberSaveable {
+ mutableStateOf(LocalTime.now().noSeconds())
+ }
+ if (isDialogShown) {
+ TimePickerDialog(
+ onDismissRequest = { isDialogShown = false },
+ initialTime = selectedTime,
+ onTimeChange = {
+ setSelectedTime(it)
+ isDialogShown = false
+ },
+ title = { Text(text = "Select time") }
+ )
+ }
+ ```
+
+## Customization
+The time picker is a highly customizable component. It allows to customize colors, shapes and typography.
+You can pass custom shapes of the digit-box as well as the AM/PM box:
+
+_It is not recommended to pass an anonymous instance of `TimePickerShapes`. Instead, create an implementation separately and use that to prevent creating a new instance each time the component is recomposed._
+
+ ```kotlin
+ TimePickerDialog(
+ // ...
+ shapes = object : TimePickerShapes {
+ override val clockDigitsShape: Shape
+ get() = CutCornerShape(topStart = 16.dp, topEnd = 3.dp, bottomStart = 0.dp, bottomEnd = 24.dp)
+ override val amPmSwitchShape: Shape
+ get() = CircleShape
+ }
+ )
+ ```
+produces
+![custom-shapes](resources/time-picker-day-custom-shapes.png)
+
+For default values see [TimePickerDefaults](../../datetimepickers/src/main/java/com/marosseleng/compose/material3/datetimepickers/time/domain/TimePickerDefaults.kt).