Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 5.16 KB

README.md

File metadata and controls

112 lines (78 loc) · 5.16 KB

KMPUtils

CI Docs CodeFactor GitHub top language GitHub GitHub issues GitHub last commit AndroidWeekly #556

badge badge badge badge badge badge badge badge badge badge badge-wasm

KMP Utils is a collection of all the things that are missing from Kotlin STL, popular KMP libraries & platform SDKs. The library is meant to be a drop-in dependency - no need to study anything - just add and enjoy the expanded API of the things you are used to, relying on autocompletion to come up with suggestions for you.

Features

  • InputForms: A stateful and composable text input field validation framework with clean DSL.
  • Common: Kotlin standard library extensions
  • Datetime: All the things missing from kotlinx.datetime and Java Calendar & DateTime API.
  • Coroutines: Things missing from Coroutines & Flows API.

Quickstart

Documentation: https://opensource.respawn.pro/KMPUtils
API Docs: /KMPUtils/javadocs
Maven Central

[versions]
kmputils = "< Badge above 👆🏻 >"

[dependencies]
kmputils-common = { module = "pro.respawn.kmmutils:common", version.ref = "kmputils" }
kmputils-datetime = { module = "pro.respawn.kmmutils:datetime", version.ref = "kmputils" }
kmputils-coroutines = { module = "pro.respawn.kmmutils:coroutines", version.ref = "kmputils" }
kmputils-inputforms = { module = "pro.respawn.kmmutils:inputforms", version.ref = "kmputils" }

[bundles]
kmputils = [
    "kmputils-common",
    "kmputils-datetime",
    "kmputils-coroutines",
    "kmputils-inputforms"
]
dependencies {
    val kmputils = "< version badge above 👆🏻 >"
    commonMainImplementation("pro.respawn.kmmutils:common:$kmputils")
    commonMainImplementation("pro.respawn.kmmutils:datetime:$kmputils")
    commonMainImplementation("pro.respawn.kmmutils:coroutines:$kmputils")
    commonMainImplementation("pro.respawn.kmmutils:inputforms:$kmputils")
}

License

Copyright 2022-2024 Respawn Team and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Name Change notice

Since the "KMM" abbreviation was deprecated by JetBrains, the repository has been renamed to "KMPUtils" and all the associated urls were changed. Unfortunately there is no way to change the group ID of the library without breaking the resolution of dependencies, so the group ID will stay the same for now.