ui/dev.shivathapaa.nepalidatepickerkmp/NepaliDateRangePicker

NepaliDateRangePicker

fun NepaliDateRangePicker(state: NepaliDateRangePickerState, modifier: Modifier = Modifier, title: @Composable () -> Unit? = { NepaliDatePickerDefaults.NepaliDateRangePickerTitle( modifier = Modifier.padding(NepaliDateRangePickerTitlePadding), language = state.locale.language, displayMode = state.displayMode, calendarSystem = state.displayedCalendarSystem ) }, headline: @Composable () -> Unit? = { NepaliDatePickerDefaults.NepaliDateRangePickerHeadline( modifier = Modifier.padding(NepaliDateRangePickerHeadlinePadding), selectedStartDate = state.selectedStartNepaliDate, selectedEndDate = state.selectedEndNepaliDate, locale = state.locale, selectedStartEnglishDate = state.selectedStartEnglishDate, selectedEndEnglishDate = state.selectedEndEnglishDate, calendarSystem = state.displayedCalendarSystem ) }, showModeToggle: Boolean = true, showTodayButton: Boolean = true, showMonthsVertically: Boolean = true, showYearPickerAndMonthNavigation: Boolean = true, secondaryDateLocale: NepaliDateLocale? = null, showCalendarSystemToggle: Boolean = false, showAdjacentMonthDays: Boolean = false, colors: NepaliDatePickerColors = NepaliDatePickerDefaults.colors(), dayDecorator: NepaliDayDecorator? = null)(source)

Nepali Date Range Picker let people select a range of Nepali dates and can be embedded into dialogs. See NepaliDatePickerDialog

Nepali date picker lets you pick Nepali dates via a calendar UI which displays Nepali dates.

Parameters

state

state of the Nepali date range picker. See rememberNepaliDateRangePickerState.

modifier

the Modifier to be applied to this Nepali date range picker.

title

the title to be displayed in the Nepali date range picker

headline

the headline to be displayed in the Nepali date range picker

showModeToggle

the boolean to let user toggle between Date Picker and Date Input

showTodayButton

the control to either show or hide TODAY button for navigating to today's date. It is also affected by showYearPickerAndMonthNavigation.

showMonthsVertically

the control to either show months vertically or horizontally. Note: When set to true (vertical display), the date picker uses vertical scrolling. This can lead to runtime errors if placed within a composable that also uses vertical scrolling, such as a Column with vertical scroll or a LazyColumn. Ensure your layout accommodates the vertical scrolling behavior to avoid these errors.

showYearPickerAndMonthNavigation

the control to either show or hide YearPicker button and MonthNavigation buttons. showTodayButton is affected by this.

secondaryDateLocale

when non-null, every day cell also shows the same day in the other calendar, using this NepaliDateLocale for its language and digits. null shows one calendar only.

showCalendarSystemToggle

the boolean to show the B.S. / A.D. switch, which drives NepaliDateRangePickerState.displayedCalendarSystem. It sits at the end of the title, so it is independent of showYearPickerAndMonthNavigation.

showAdjacentMonthDays

the boolean to fill each month's empty cells with the neighbouring months' days, drawn faded. Tapping one selects that day as the range's start or end and moves the grid to its month. A day the picker cannot select, because of NepaliSelectableDates or the year range, stays faded and inert. Off by default, matching the Material3 DateRangePicker.

colors

NepaliDatePickerColors that will be used to resolve the colors used for this date picker in different states. See NepaliDatePickerDefaults.colors.

dayDecorator

marks days that carry a holiday, a festival or an app's own event, with dots under the day number and a color for the number itself. null, the default, leaves every day as the theme draws it. A decoration never overrides the range shading or the disabled state. See NepaliDatePickerDefaults.eventDecorator and NepaliDatePickerDefaults.dayDecorator.

Example usage:

val defaultNepaliDateRangePickerState = rememberNepaliDateRangePickerState()

NepaliDateRangePicker(defaultNepaliDateRangePickerState)

NepaliDateRangePicker

Parameters

See also