core/dev.shivathapaa.nepalidatepickerkmp.calendar_model/NepaliCalendarModel

NepaliCalendarModel

class NepaliCalendarModel(val locale: NepaliDateLocale = NepaliDateLocale())(source)

Locale-aware engine behind the pickers: BS↔AD conversion, month details, formatting, and date comparison. This is the workhorse the :ui composables construct and pass down internally.

For application code, prefer the NepaliDateConverter object facade - it exposes the same conversion / formatting / comparison utilities as ready-to-call functions, so you don't need to construct (and thread) a model instance. Reach for NepaliCalendarModel directly only when you want a single instance pinned to one locale.

Constructors

NepaliCalendarModel

constructor(locale: NepaliDateLocale = NepaliDateLocale())

Properties

currentTime

val currentTime: SimpleTime

locale

val locale: NepaliDateLocale

today

val ~~today~~: CustomCalendar

todayEnglish

val ~~todayEnglish~~: SimpleDate

todayEnglishCalendar

val todayEnglishCalendar: CustomCalendar

todayEnglishSimpleDate

val todayEnglishSimpleDate: SimpleDate

todayNepaliCalendar

val todayNepaliCalendar: CustomCalendar

todayNepaliSimpleDate

val todayNepaliSimpleDate: SimpleDate

Functions

addOrSubtractDaysToSimpleDate

fun addOrSubtractDaysToSimpleDate(year: Int, month: Int, dayOfMonth: Int, daysToAdjust: Int): CustomCalendar

compareDates

fun compareDates(calendar: CustomCalendar, year: Int, month: Int, dayOfMonth: Int): Int

Compares a CustomCalendar instance with a date represented by the given year, month, and dayOfMonth.

fun compareDates(simpleDate: SimpleDate, year: Int, month: Int, dayOfMonth: Int): Int

convertToEnglishDate

fun convertToEnglishDate(nepaliYYYY: Int, nepaliMM: Int, nepaliDD: Int): CustomCalendar

convertToNepaliCalendar

fun convertToNepaliCalendar(englishYYYY: Int, englishMM: Int, englishDD: Int): CustomCalendar

formatEnglishDate

fun formatEnglishDate(year: Int, month: Int, dayOfMonth: Int, dayOfWeek: Int, locale: NepaliDateLocale): String

Formats a English date based on the specified user preferences.

formatEnglishDateByUnicodePattern

fun formatEnglishDateByUnicodePattern(unicodePattern: String, calendar: CustomCalendar, language: NepaliDatePickerLang): String

formatEnglishDateNepaliTimeToIsoFormat

fun formatEnglishDateNepaliTimeToIsoFormat(englishDate: SimpleDate, time: SimpleTime): String

formatEnglishDateTimeByUnicodePattern

fun formatEnglishDateTimeByUnicodePattern(unicodePattern: String, calendar: CustomCalendar, time: SimpleTime?, language: NepaliDatePickerLang): String

formatNepaliDate

fun formatNepaliDate(customCalendar: CustomCalendar, locale: NepaliDateLocale): String

Overload function of above formatNepaliDate function without date range validation.

fun formatNepaliDate(year: Int, month: Int, dayOfMonth: Int, dayOfWeek: Int, locale: NepaliDateLocale): String

Formats a Nepali date based on the specified user preferences. (Without validation)

formatNepaliDateByUnicodePattern

fun formatNepaliDateByUnicodePattern(unicodePattern: String, calendar: CustomCalendar, language: NepaliDatePickerLang): String

formatNepaliDateTimeByUnicodePattern

fun formatNepaliDateTimeByUnicodePattern(unicodePattern: String, calendar: CustomCalendar, time: SimpleTime?, language: NepaliDatePickerLang): String

formatNepaliDateTimeToIsoFormat

fun formatNepaliDateTimeToIsoFormat(nepaliDate: SimpleDate, time: SimpleTime): String

formatTimeByUnicodePattern

fun formatTimeByUnicodePattern(unicodePattern: String, time: SimpleTime, language: NepaliDatePickerLang): String

getEnglishCalendar

fun getEnglishCalendar(simpleEnglishDate: SimpleDate): CustomCalendar

A fully populated Gregorian CustomCalendar for a date given in the Gregorian calendar.

getEnglishCalendarsInMonth

fun getEnglishCalendarsInMonth(englishYear: Int, englishMonth: Int): List<CustomCalendar>

Every day of a Gregorian month as a CustomCalendar, in day order.

getEnglishCalendarsInNepaliMonth

fun getEnglishCalendarsInNepaliMonth(nepaliYear: Int, nepaliMonth: Int): List<CustomCalendar>

The English equivalent of every day of a Nepali month, in day order.

getEnglishDateNepaliTimeFromIsoFormat

fun getEnglishDateNepaliTimeFromIsoFormat(isoDateTime: String): CustomDateTime

getEnglishMonth

fun getEnglishMonth(englishYear: Int, englishMonth: Int): MonthCalendar

Grid geometry of a Gregorian month, the counterpart of getNepaliMonth.

getEnglishMonthName

fun getEnglishMonthName(month: Int, language: NepaliDatePickerLang, format: NameFormat = NameFormat.FULL): String

getNepaliCalendar

fun getNepaliCalendar(simpleNepaliDate: SimpleDate): CustomCalendar

getNepaliCalendarsInEnglishMonth

fun getNepaliCalendarsInEnglishMonth(englishYear: Int, englishMonth: Int): List<CustomCalendar?>

The Bikram Sambat equivalent of every day of a Gregorian month, in day order, with null for days before the conversion anchor.

getNepaliDateTimeFromIsoFormat

fun getNepaliDateTimeFromIsoFormat(isoDateTime: String): CustomDateTime

getNepaliMonth

fun getNepaliMonth(nepaliYear: Int, nepaliMonth: Int): NepaliMonthCalendar

getNepaliMonthName

fun getNepaliMonthName(monthOfYear: Int, format: NameFormat, language: NepaliDatePickerLang = locale.language): String

getTotalDaysInEnglishMonth

fun getTotalDaysInEnglishMonth(year: Int, month: Int): Int

getTotalDaysInNepaliMonth

fun getTotalDaysInNepaliMonth(year: Int, month: Int): Int

isEnglishDateConvertible

fun isEnglishDateConvertible(englishYYYY: Int, englishMM: Int, englishDD: Int): Boolean

Whether the given English date has a Bikram Sambat equivalent in the supported table.

localizeNumber

fun localizeNumber(stringToLocalize: String, locale: NepaliDatePickerLang): String

minusNepaliMonths

fun minusNepaliMonths(fromNepaliCalendar: NepaliMonthCalendar, subtractedMonthsCount: Int): NepaliMonthCalendar

nepaliDaysInBetween

fun nepaliDaysInBetween(startDate: SimpleDate, endDate: SimpleDate): Int

parse

fun parse(dateString: String): CustomCalendar?

Parses a date string into a CustomCalendar.

parseEnglish

fun parseEnglish(dateString: String): CustomCalendar?

Parses a date string into an English CustomCalendar, the counterpart of parse.

plusNepaliMonths

fun plusNepaliMonths(fromNepaliCalendar: NepaliMonthCalendar, addedMonthsCount: Int): NepaliMonthCalendar