A small set of data formatting utilities for Kotlin Multiplatform (KMP).
This library only supports kotlinx-datetime.
The library is published to Maven Central.
dependencies {
implementation("nl.jacobras:Human-Readable:1.9.0")
}
An interactive demo is available at https://jacobras.github.io/Human-Readable/.
HumanReadable.timeAgo(now - 134.minutes) // "2 hours ago"
HumanReadable.timeAgo(now + 8.minutes) // "in 8 minutes"
HumanReadable.duration(5.seconds) // "5 seconds"
HumanReadable.duration(7.days) // "1 week"
HumanReadable.duration(544.hours) // "3 weeks"
Note: The formatter switches to a bigger unit (minute, hour, day, ...) as soon as it can. See Precision.
File size formatting uses base 1024. Note that these are not yet localised (#86).
HumanReadable.fileSize(333) // "333 B"
HumanReadable.fileSize(2_048, decimals = 1) // "2.0 kB"
HumanReadable.fileSize(21_947_282_882, decimals = 2) // "20.44 GB"
Available since version 1.8. Note that these are not yet localised (#86).
HumanReadable.abbreviation(3_000) // "3K"
HumanReadable.abbreviation(500_000) // "500K"
HumanReadable.abbreviation(2_500_000, decimals = 1) // "2.5M"
The formatter switches to a bigger unit (minute, hour, day, ...) as soon as it can. For example:
59.seconds
is "59 seconds" but60.seconds
becomes "1 minute"6.days
is "6 days" but7.days
becomes "1 week"29.days
is "29 days" but30.days
becomes "1 month"
There's also some rounding involved:
8.days
and10.days
are "1 week", but11.days
already becomes "2 weeks"
This behaviour may become configurable in future releases.
The library uses the small Libres library for its string resources. It detects the current locale by default, but it's changeable on runtime. See Libres: Changing Localization.
You don't need to manually import Libres, as Gradle already pulls it in along with HumanReadable.
HumanReadable.timeAgo(instant) // "3 days ago"
LibresSettings.languageCode = "nl"
HumanReadable.timeAgo(instant) // "3 dagen geleden"
LibresSettings.languageCode = "fr"
HumanReadable.timeAgo(instant) // "il y a 3 jours"
- Czech
- Chinese (since 1.3.0)
- Dutch
- English (default)
- Finnish (since 1.7.0)
- French
- German
- Italian
- Indonesian
- Japanese (since 1.5.0)
- Korean (since 1.5.0)
- Polish (since 1.3.0)
- Portuguese (since 1.9.0)
- Russian
- Spanish
- Turkish
- Ukrainian
- Uzbek (since 1.4.0)
- Vietnamese (since 1.6.0)
Missing a language? Feel free to open an issue about it. Or, add it yourself:
- Fork the code and navigate to src/commonMain/libres/strings/
- Add a file named
time_units_[LANGUAGE CODE].xml
(see Unicode: CLDR chart for the code & plural categories). - If the language deviates from English data units (like French does), also add
data_units_[LANGUAGE CODE].xml
. - Open a PR.