mirror of
https://github.com/InsanusMokrassar/docs.git
synced 2024-11-22 08:13:59 +00:00
add resources docs
This commit is contained in:
parent
83c095af8f
commit
cc49dca724
44
docs/micro_utils/resources.md
Normal file
44
docs/micro_utils/resources.md
Normal file
@ -0,0 +1,44 @@
|
||||
# Resources
|
||||
|
||||
**Package**: `dev.inmo:micro_utils.resources`
|
||||
|
||||
This package aimed to make some multiplatform support for resources of your application. As for now, __there is only
|
||||
support for strings__. Sample:
|
||||
|
||||
```kotlin
|
||||
object Translations {
|
||||
val someVariable = buildStringResource(
|
||||
"Sample default string"
|
||||
) {
|
||||
IetfLanguageCode.German variant lazy "Beispiel für eine Standardzeichenkette"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In this case, you will be able to use it with next logic:
|
||||
|
||||
```kotlin
|
||||
Translation.someVariable.translation(IetfLanguageCode.French) // "Sample default string" as default one
|
||||
Translation.someVariable.translation(IetfLanguageCode.German) // "Beispiel für eine Standardzeichenkette" as available variant
|
||||
Translation.someVariable.translation(IetfLanguageCode.German.DE) // "Beispiel für eine Standardzeichenkette" as available parent variant
|
||||
```
|
||||
|
||||
## Additional opportunities on Android platform
|
||||
|
||||
On Android you may use `Configuration` (as well as `Resources` or `Context`) to get translation for current locale. For
|
||||
example:
|
||||
|
||||
```kotlin
|
||||
val context: Context = // context retrieving
|
||||
|
||||
context.translation(Translation.someVariable)
|
||||
```
|
||||
|
||||
## Additional opportunities on JVM platform
|
||||
|
||||
On JVM platform you usually may use `Locale.getDefault()` to get `Locale` object and pass it to `translation` extension:
|
||||
|
||||
```kotlin
|
||||
Translation.someVariable.translation(Locale.getDefault())
|
||||
Translation.someVariable.translation() // Locale.getDefault() hidden
|
||||
```
|
@ -10,6 +10,7 @@ nav:
|
||||
- Home: 'index.md'
|
||||
- 'MicroUtils':
|
||||
- 'micro_utils/index.md'
|
||||
- 'micro_utils/resources.md'
|
||||
- 'Telegram Bot API':
|
||||
- 'tgbotapi/index.md'
|
||||
- KDocs: 'https://tgbotapi.inmo.dev'
|
||||
|
Loading…
Reference in New Issue
Block a user