core/dev.shivathapaa.nepalidatepickerkmp.data

Package-level declarations

Immutable calendar models (CustomCalendar, SimpleDate, SimpleTime, NepaliMonthCalendar), locale (NepaliDateLocale), digit scripts, and the NepaliDateFormatter contract that drives locale-aware rendering.

CalendarSystem is the named form of the era integer (1 = AD, 2 = BS) and MonthCalendar is the calendar-tagged counterpart of NepaliMonthCalendar, so month geometry can be handled without knowing which calendar produced it. Use toMonthCalendar and toNepaliMonthCalendar to move between the two.

Types

CalendarSystem

enum CalendarSystem : Enum<CalendarSystem>

The calendar a date is expressed in.

CustomCalendar

data class CustomCalendar(val year: Int, val month: Int, val dayOfMonth: Int, val era: Int, val firstDayOfMonth: Int, val lastDayOfMonth: Int, val totalDaysInMonth: Int, val dayOfWeekInMonth: Int = -1, val dayOfWeek: Int = -1, val dayOfYear: Int = -1, val weekOfMonth: Int = -1, val weekOfYear: Int = -1)

Represents a date in a custom calendar system with detailed information.

CustomDateTime

data class CustomDateTime(val customCalendar: CustomCalendar, val simpleTime: SimpleTime)

A data holder representing a CustomCalendar and SimpleTime.

DigitScript

enum DigitScript : Enum<DigitScript>

Numeral script used when rendering digits in localized dates / times.

MonthCalendar

data class MonthCalendar(val calendarSystem: CalendarSystem, val year: Int, val month: Int, val totalDaysInMonth: Int, val firstDayOfMonth: Int, val lastDayOfMonth: Int)

The geometry of one month in a given CalendarSystem: enough to lay out a weekday grid without knowing which calendar it came from.

NameFormat

enum NameFormat : Enum<NameFormat>

Represents the format for displaying names (e.g., weekdays or months).

NepaliDateFormatStyle

enum NepaliDateFormatStyle : Enum<NepaliDateFormatStyle>

Represents different styles for formatting Nepali dates.

NepaliDateFormatter

object NepaliDateFormatter

Parse and format SimpleDate for short numeric text-field input.

NepaliDateLocale

data class NepaliDateLocale(val language: NepaliDatePickerLang = NepaliDatePickerLang.ENGLISH, val dateFormat: NepaliDateFormatStyle = NepaliDateFormatStyle.LONG, val weekDayName: NameFormat = NameFormat.FULL, val monthName: NameFormat = NameFormat.FULL, val digitScript: DigitScript? = null)

Represents locale settings for Nepali date display and formatting.

NepaliDatePickerLang

enum NepaliDatePickerLang : Enum<NepaliDatePickerLang>

Represents the language used for Nepali date pickers.

NepaliEnglishMonthDay

data class NepaliEnglishMonthDay(val englishDayOfMonth: Int, val nepaliCalendar: CustomCalendar?)

One day of a Gregorian month beside the Bikram Sambat calendar it converts to, which is absent for a day the conversion table does not reach.

NepaliMonthCalendar

data class NepaliMonthCalendar(val year: Int, val month: Int, val totalDaysInMonth: Int, val firstDayOfMonth: Int, val lastDayOfMonth: Int, val daysFromStartOfWeekToFirstOfMonth: Int = firstDayOfMonth - 1)

Represents a calendar month in the Nepali calendar system.

NepaliMonthName

data class NepaliMonthName(val short: String, val full: String)

Represents the name of a month in the Nepali calendar.

NepaliTimeFormatter

object NepaliTimeFormatter

Parse and format SimpleTime as the library's canonical time-of-day wire string, HH:mm:ss with an optional nine-digit fractional part.

NepaliWeekdayName

data class NepaliWeekdayName(val short: String, val medium: String, val full: String)

Represents the name of a weekday in the Nepali calendar.

ReferenceDate

data class ReferenceDate(val englishDate: CustomCalendar, val nepaliDate: CustomCalendar)

SimpleDate

data class SimpleDate(val year: Int, val month: Int, val dayOfMonth: Int = 1) : Comparable<SimpleDate>

Represents a simple date with year, month, and day of the month.

SimpleTime

data class SimpleTime(val hour: Int, val minute: Int, val second: Int, val nanosecond: Int)

Represents a 24Hrs format time of day (hour, minute, second, nanosecond). Strictly adjusted to the Asia/Kathmandu TimeZone.

Properties

calendarSystem

val CustomCalendar.calendarSystem: CalendarSystem

The CalendarSystem this calendar is expressed in, or CalendarSystem.BIKRAM_SAMBAT when CustomCalendar.era holds an unrecognised value.

daysInMonthMap

val daysInMonthMap: Map<Int, IntArray>

englishDateMap

val englishDateMap: Map<Int, ReferenceDate>

One English/Bikram Sambat pair per English year, each falling on a Bikram Sambat new year.

nepaliDateMap

val nepaliDateMap: Map<Int, ReferenceDate>

The pairs of englishDateMap, keyed by Bikram Sambat year instead of English year.

Functions

defaultDigitScript

fun NepaliDatePickerLang.defaultDigitScript(): DigitScript

Default DigitScript for a given NepaliDatePickerLang.

latinDigitOrNull

fun Char.latinDigitOrNull(): Char?

Reverse lookup. If this char is a digit in any supported non-Latin script (Devanagari today), return the matching ASCII '0'..'9'. If it is already an ASCII digit, return it unchanged. Otherwise return null.

toMonthCalendar

fun NepaliMonthCalendar.toMonthCalendar(): MonthCalendar

Reads this Bikram Sambat month as a calendar-tagged MonthCalendar.

toNepaliMonthCalendar

fun CustomCalendar.toNepaliMonthCalendar(): NepaliMonthCalendar

Converts a CustomCalendar object to a NepaliMonthCalendar object.

fun MonthCalendar.toNepaliMonthCalendar(): NepaliMonthCalendar

Narrows this month to the Bikram Sambat-only NepaliMonthCalendar.

toSimpleDate

fun CustomCalendar.toSimpleDate(): SimpleDate

Converts a CustomCalendar object to a SimpleDate object.