Compose Persian Date Picker

Compose Persian Date Picker is a library that allows developers to add a Persian date picker to their Jetpack Compose apps. The library provides a customizable dialog that lets users select a date using the Persian calendar, with options for updating the selected date and other settings.

Give a Star! ⭐

If you like or are using this project to learn or start your solution, please give it a star. Thanks!

Bottom Sheet	Dialog

Quickstart

Here's a quick example of how to use the library:

1. Add the JitPack repository to your project-level build.gradle or settings.gradle file:

	allprojects {
		repositories {
			maven { url 'https://jitpack.io' }
		}
	}

2. Add the library dependency to your app-level build.gradle file:

    dependencies {
            implementation 'com.github.razaghimahdi:Compose-Persian-Date-Picker:1.1.1'
    } 

3. Use the Persian Date Picker in your app:

val coroutine = rememberCoroutineScope()
val rememberPersianDialogDatePicker = rememberDialogDatePicker()
val rememberPersianBottomSheetDatePickerController = rememberDialogDatePicker()
val showDialog = remember { mutableStateOf(false) }
val bottomSheetState =  rememberModalBottomSheetState()

if (showDialog.value) {
    PersianLinearDatePickerDialog(
        rememberPersianDatePicker,
        Modifier.fillMaxWidth(),
        onDismissRequest = { showDialog.value = false },
        onDateChanged = { year, month, day ->
            // do something...
        })
}

if (bottomSheetState.isVisible) {
    DatePickerLinearModalBottomSheet(
        modifier = Modifier
            .fillMaxSize(),
        sheetState = bottomSheetState,
        controller = rememberPersianBottomSheetDatePickerController,
        onDismissRequest = {
            coroutine.launch {
                bottomSheetState.hide()
            }
        }
    )
}


Button(onClick = { showDialog.value = true }) {
    Text(text = "نمایش")
}

Button(onClick = { coroutine.launch { bottomSheetState.show() } }) {
    Text(text = "نمایش باتم شت")
}

4. Customize the settings by calling methods on the rememberPersianDatePicker object:

val rememberPersianDialogDatePicker = rememberDialogDatePicker()
val rememberPersianBottomSheetDatePickerController = rememberDialogDatePicker()

// 3 ways to update date

LaunchedEffect(key1 = Unit) {

    rememberPersianDialogDatePicker.updateDate(date = Date())
    rememberPersianDialogDatePicker.updateDate(timestamp = Date().time)
    rememberPersianDialogDatePicker.updateDate(
        persianYear = 1403,
        persianMonth = 7,
        persianDay = 20
    )

    rememberPersianBottomSheetDatePickerController.updateDate(date = Date())
    rememberPersianBottomSheetDatePickerController.updateDate(timestamp = Date().time)
    rememberPersianBottomSheetDatePickerController.updateDate(
        persianYear = 1403,
        persianMonth = 7,
        persianDay = 20
    )
}


rememberPersianDialogDatePicker.updateMaxYear(1420)
rememberPersianDialogDatePicker.updateMinYear(1395)
rememberPersianDialogDatePicker.updateYearRange(10)
rememberPersianDialogDatePicker.updateDisplayMonthNames(false)


rememberPersianBottomSheetDatePickerController.updateMaxYear(1420)
rememberPersianBottomSheetDatePickerController.updateMinYear(1395)

PersianLinearDatePickerDialog(
    rememberPersianDatePicker,
    Modifier.fillMaxWidth(),
    onDismissRequest = { showDialog.value = false },
    onDateChanged = { year, month, day ->
        // do something...
    }
)

DatePickerLinearModalBottomSheet(
    modifier = Modifier
        .fillMaxSize(),
    sheetState = bottomSheetState,
    controller = rememberPersianBottomSheetDatePickerController,
    onDismissRequest = {
        coroutine.launch {
            bottomSheetState.hide()
        }
    }
)

Example

For a more detailed example, check out the example app included in the repository.

Functions

rememberPersianDatePicker has these functions that can be useful:

Function Name	Description
getPersianYear()	Returns the Persian year of the current date.
getPersianMonth()	Returns the Persian month (1-12) of the current date.
getPersianDay()	Returns the Persian day (1-31) of the current date.
getGregorianYear()	Returns the Gregorian year of the current date.
getGregorianMonth()	Returns the Gregorian month (1-12) of the current date.
getGregorianDay()	Returns the Gregorian day (1-31) of the current date.
getDayOfWeek()	Returns the day of the week (1-7) of the current date.
getPersianMonthName()	Returns the name of the Persian month of the current date (e.g. "اردیبهشت").
getPersianDayOfWeekName()	Returns the name of the day of the week in Persian of the current date (e.g. "شنبه").
getPersianFullDate()	Returns the full Persian date of the current date in the format "dayOfWeek day monthName year" (e.g. "پنج‌شنبه 10 شهریور 1401").
getGregorianDate()	Returns the current date in the Gregorian calendar as a Date object.
getTimestamp()	Returns the Unix timestamp of the current date in milliseconds.

Screenshots

1.webm

Future Plan

Soon there will be more date picker with Such as Range Date Picker, Multi Date Picker and...

Contributing

Contributions are welcome! If you find a bug or would like to create a new feature, please submit a pull request.

License

This library is licensed under the MIT License. See LICENSE.txt

Developed by Mahdi Razzaghi Ghaleh