compose-pickers/io.github.kezlab.compose.pickers

Package-level declarations

Types

DatePickerColumn

enum DatePickerColumn : Enum<DatePickerColumn>

Identifies a io.github.kezlab.compose.pickers.date.DatePicker column for layout ordering.

DatePickerConstraints

data class DatePickerConstraints(val minDate: LocalDate? = null, val maxDate: LocalDate? = null)

Date constraints applied by DatePickerItems.

DatePickerFormat

@Immutable

data class DatePickerFormat(val year: PickerItemFormat<Int>, val month: PickerItemFormat<Int>, val day: PickerItemFormat<Int>)

Value formatting for io.github.kezlab.compose.pickers.date.DatePicker.

DatePickerItems

data class DatePickerItems(val yearItems: List<Int>, val monthItems: List<Int>, val dayItems: List<Int>, val constraints: DatePickerConstraints = DatePickerConstraints())

Selectable item lists for io.github.kezlab.compose.pickers.date.DatePicker.

DatePickerLayout

@Immutable

data class DatePickerLayout(val yearWeight: Float?, val monthWeight: Float?, val dayWeight: Float?, val columnOrder: ImmutableList<DatePickerColumn> = persistentListOf( DatePickerColumn.YEAR, DatePickerColumn.MONTH, DatePickerColumn.DAY ))

Represents layout options used by io.github.kezlab.compose.pickers.date.DatePicker columns.

DatePickerSemantics

@Immutable

data class DatePickerSemantics(val year: PickerSemantics, val month: PickerSemantics, val day: PickerSemantics)

Semantics configuration for io.github.kezlab.compose.pickers.date.DatePicker.

DateRangePickerSemantics

@Immutable

data class DateRangePickerSemantics(val start: DatePickerSemantics, val end: DatePickerSemantics)

Semantics configuration for io.github.kezlab.compose.pickers.date.DateRangePicker.

DurationPickerColumn

enum DurationPickerColumn : Enum<DurationPickerColumn>

Identifies a io.github.kezlab.compose.pickers.duration.DurationPicker column for visual ordering.

DurationPickerConstraints

data class DurationPickerConstraints(val minDuration: Duration? = null, val maxDuration: Duration? = null)

Inclusive scalar bounds applied by DurationPickerItems.

DurationPickerFormat

@Immutable

data class DurationPickerFormat(val hour: PickerItemFormat<Int>, val minute: PickerItemFormat<Int>)

Value formatting for io.github.kezlab.compose.pickers.duration.DurationPicker.

DurationPickerItems

data class DurationPickerItems(val hourItems: List<Int>, val minuteItems: List<Int>, val constraints: DurationPickerConstraints = DurationPickerConstraints())

Selectable item sources for io.github.kezlab.compose.pickers.duration.DurationPicker.

DurationPickerLayout

@Immutable

data class DurationPickerLayout(val hourWeight: Float?, val minuteWeight: Float?, val columnOrder: ImmutableList<DurationPickerColumn> = persistentListOf( DurationPickerColumn.HOUR, DurationPickerColumn.MINUTE ))

Layout options for io.github.kezlab.compose.pickers.duration.DurationPicker.

DurationPickerSemantics

@Immutable

data class DurationPickerSemantics(val hour: PickerSemantics, val minute: PickerSemantics)

Accessibility configuration for io.github.kezlab.compose.pickers.duration.DurationPicker.

PickerColors

@Immutable

data class PickerColors(val dividerColor: Color, val selectedItemBackgroundColor: Color, val textColor: Color, val selectedTextColor: Color, val disabledDividerColor: Color = dividerColor.copy(alpha = dividerColor.alpha * DISABLED_CONTAINER_ALPHA), val disabledSelectedItemBackgroundColor: Color = selectedItemBackgroundColor.copy( alpha = selectedItemBackgroundColor.alpha * DISABLED_CONTAINER_ALPHA ), val disabledTextColor: Color = textColor.copy(alpha = textColor.alpha * DISABLED_CONTENT_ALPHA), val disabledSelectedTextColor: Color = selectedTextColor.copy( alpha = selectedTextColor.alpha * DISABLED_CONTENT_ALPHA ))

Represents the colors used by Picker and related components.

PickerDefaults

object PickerDefaults

Contains default values and factory methods for creating Picker styles. Follows Material3 component design patterns.

PickerDividerWidth

@Immutable

sealed interface PickerDividerWidth

Describes how wide the selection dividers of a Picker should be rendered.

PickerItemFormat

@Immutable

data class PickerItemFormat<T : Any>(val itemText: (T) -> String = { it.toString() }, val itemContentDescription: (T) -> String? = null)

Value formatting for one Picker column.

PickerItemScope

class PickerItemScope<T : Any>

Information passed to custom Picker item content.

PickerSelectionIndicator

@Immutable

data class PickerSelectionIndicator(val color: Color, val thickness: Dp, val shape: Shape, val horizontalInset: Dp, val isVisible: Boolean, val disabledColor: Color = color.copy(alpha = color.alpha * DISABLED_CONTAINER_ALPHA))

Describes the single selection band drawn by composite pickers (e.g. io.github.kezlab.compose.pickers.time.TimePicker, io.github.kezlab.compose.pickers.date.DatePicker).

PickerSemantics

@Immutable

data class PickerSemantics(val pickerLabel: String? = null, val previousItemActionLabel: String? = PickerDefaults.PreviousItemActionLabel, val nextItemActionLabel: String? = PickerDefaults.NextItemActionLabel)

Semantics configuration for one Picker column.

PickerStyle

@Immutable

data class PickerStyle(val visibleItemsCount: Int, val colors: PickerColors, val textStyles: PickerTextStyles, val selectedItemBackgroundShape: Shape, val itemPadding: PaddingValues, val fadingEdgeGradient: Brush, val horizontalAlignment: Alignment.Horizontal, val dividerThickness: Dp, val dividerShape: Shape, val dividerWidth: PickerDividerWidth, val isDividerVisible: Boolean)

Represents visual and layout styling shared by Picker and related components.

PickerTextStyles

@Immutable

data class PickerTextStyles(val textStyle: TextStyle, val selectedTextStyle: TextStyle)

Represents the text styles used by Picker and related components.

TimePickerColumn

enum TimePickerColumn : Enum<TimePickerColumn>

Identifies a io.github.kezlab.compose.pickers.time.TimePicker column for layout ordering.

TimePickerConstraints

data class TimePickerConstraints(val minTime: LocalTime? = null, val maxTime: LocalTime? = null)

Time constraints applied by TimePickerItems.

TimePickerFormat

@Immutable

data class TimePickerFormat(val hour: PickerItemFormat<Int>, val minute: PickerItemFormat<Int>, val period: PickerItemFormat<TimePeriod>)

Value formatting for io.github.kezlab.compose.pickers.time.TimePicker.

TimePickerItems

data class TimePickerItems(val minuteItems: List<Int>, val hour24Items: List<Int>, val hour12Items: List<Int>, val periodItems: List<TimePeriod>, val constraints: TimePickerConstraints = TimePickerConstraints())

Selectable item lists for io.github.kezlab.compose.pickers.time.TimePicker.

TimePickerLayout

@Immutable

data class TimePickerLayout(val periodWeight: Float?, val hourWeight: Float?, val minuteWeight: Float?, val columnOrder: ImmutableList<TimePickerColumn> = persistentListOf( TimePickerColumn.PERIOD, TimePickerColumn.HOUR, TimePickerColumn.MINUTE ))

Represents layout options used by io.github.kezlab.compose.pickers.time.TimePicker columns.

TimePickerSemantics

@Immutable

data class TimePickerSemantics(val hour: PickerSemantics, val minute: PickerSemantics, val period: PickerSemantics)

Semantics configuration for io.github.kezlab.compose.pickers.time.TimePicker.

YearMonthPickerColumn

enum YearMonthPickerColumn : Enum<YearMonthPickerColumn>

Identifies a io.github.kezlab.compose.pickers.date.YearMonthPicker column for layout ordering.

YearMonthPickerConstraints

data class YearMonthPickerConstraints(val minYearMonth: YearMonth? = null, val maxYearMonth: YearMonth? = null)

Year/month constraints applied by YearMonthPickerItems.

YearMonthPickerFormat

@Immutable

data class YearMonthPickerFormat(val year: PickerItemFormat<Int>, val month: PickerItemFormat<Int>)

Value formatting for io.github.kezlab.compose.pickers.date.YearMonthPicker.

YearMonthPickerItems

data class YearMonthPickerItems(val yearItems: List<Int>, val monthItems: List<Int>, val constraints: YearMonthPickerConstraints = YearMonthPickerConstraints())

Selectable item lists for io.github.kezlab.compose.pickers.date.YearMonthPicker.

YearMonthPickerLayout

@Immutable

data class YearMonthPickerLayout(val yearWeight: Float?, val monthWeight: Float?, val columnOrder: ImmutableList<YearMonthPickerColumn> = persistentListOf( YearMonthPickerColumn.YEAR, YearMonthPickerColumn.MONTH ))

Represents layout options used by io.github.kezlab.compose.pickers.date.YearMonthPicker columns.

YearMonthPickerSemantics

@Immutable

data class YearMonthPickerSemantics(val year: PickerSemantics, val month: PickerSemantics)

Semantics configuration for io.github.kezlab.compose.pickers.date.YearMonthPicker.

Functions

currentDate

fun currentDate(timeZone: TimeZone = TimeZone.currentSystemDefault()): LocalDate

Reads the current local date.

currentDateTime

fun currentDateTime(timeZone: TimeZone = TimeZone.currentSystemDefault()): LocalDateTime

Reads the current local date and time.

WheelPicker

@Composable

fun <T : Any> WheelPicker(items: List<T>, selectedItem: T, onSelectedItemChange: (T) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, format: PickerItemFormat<T> = PickerDefaults.itemFormat(), style: PickerStyle = PickerDefaults.style(), semantics: PickerSemantics = PickerDefaults.semantics(), isInfinity: Boolean = true, onSelectionSettled: (T) -> Unit = {}, content: @Composable (PickerItemScope<T>) -> Unit? = null)

A controlled single-column wheel picker with separate live and settled selection callbacks.