Topics

#android #android-library #coroutines #ios #ios-library #kotlin #kotlin-android #kotlin-coroutines #kotlin-dsl #kotlin-extensions #kotlin-library #kotlin-multiplatform #kotlin-native #lightweight #macos #material-design #watchos

Language breakdown

No language data available.

▸ Files click to expand

README

Splitties

Splitties is a collection of small Kotlin multiplatform libraries (with Android as first target).

These libraries are intended to reduce the amount of code you have to write, freeing code reading and writing time, so you can focus more on what you want to build for your users (even if you're the only one), or have more time to have fun.

This project is named "Splitties" because it is split in small modules, distributed as independent libraries, so you can add only the ones you need to your project/module, helping reduce the size of the final binary that users devices will need to download and keep in the limited storage (BTW, everything is limited).

Some Android targeting modules have a content similar to what Anko offers. See a short comparison of Splitties with Anko here.

Each module has been designed to have a small footprint and be as efficient as possible.

A few examples

Splitties is all about simplifying your code. Here are a few examples:

Kotlin:

startActivity(Intent(this, DemoActivity::class.java))

Kotlin with Splitties Activities:

start<DemoActivity>()

Kotlin:

Snackbar.make(root, R.string.refreshsuccessful, Snackbar.LENGTHSHORT)     .show()

Kotlin with Splitties Snackbar:

root.snack(R.string.refresh_successful)

Racing coroutines: (raceOf(…) comes from the Coroutines module)

suspend fun awaitUserChoice(ui: SomeUi, choices: List<Stuff>): Stuff? = raceOf({
    ui.awaitSomeUserAction(choices)
}, {
    ui.awaitDismissal()
    null
}, {
    ui.showSomethingInRealtimeUntilCancelled() // Returns Nothing, will run, but never "win".
})

Kotlin:

Snackbar.make(root, getString(R.string.deletedxitems, deletedCount), Snackbar.LENGTH_LONG)     .setAction(android.R.string.cancel) {         deleteOperation.requestRollback()     }     .setActionTextColor(ContextCompat.getColor(this, R.color.fancy_color))     .show()

Kotlin with Splitties Snackbar:

root.longSnack(str(R.string.deletedxitems, deletedCount)) {     action(android.R.string.cancel, textColor = color(R.color.fancy_color)) {         deleteOperation.requestRollback()     } }

Overview

System interaction (Android only)
User input and user interface related splits

- Small messages (Android only) - Dialogs (Android only) - System UI (Android only) - Extensions for Views (Android only) - Creating View based UIs with the power of Kotlin (Android only) - Various UI utilities (Android only) - Material Design helpers (Android only)

Inter and cross app communication: Activities, Fragments, Intents, and Bundles
Concurrency (Multiplatform)
Data persistence (Multiplatform)
Utilities (Multiplatform)
Debugging (Android only)
Legacy (Android only)

System interaction (Android only):

App Context: Always have your application Context at hand with appCtx.
System Services: No more context.getSystemService(NAMEOF_SERVICE) as NameOfManager.

User input and user interface related splits:

Small messages (Android only)

Snackbar: Grab a snack without ceremony with snack(…) and longSnack(…).
Toast: Show a toast by just calling toast(yourText), and dodge API 25

BadTokenException.

Dialogs (Android only)

Alert Dialog: Create simple alert dialogs with simple code.
Alert Dialog AppCompat: AppCompat version of

Alert Dialog.

Alert Dialog AppCompat Coroutines:

showAndAwait extension functions for AppCompat AlertDialog.

Alert Dialog Material: Material Components extension of

Alert Dialog AppCompat.

System UI (Android only)

Dangerous permissions: Request runtime permissions without polluting your codebase.

Extensions for Views (Android only)

Views: Extensions function and properties on Views.
Views AppCompat: AppCompat extension of Views. Includes helpers for ImageView tinting, ActionBar and tooltip.
Views CardView: CardView extension of Views. Provides a contentPadding property.
Views Material: Material Components extension of Views.
Views Coroutines Material: Material Components + Kotlin coroutines.
Views RecyclerView: RecyclerView extension of Views.
Views Coroutines: Android Views + Kotlin coroutines.

Creating View based UIs with the power of Kotlin (Android only)

Views DSL: Create UIs with readable Kotlin code (IDE preview supported).
Views DSL AppCompat: AppCompat extension of Views DSL.
Views DSL ConstraintLayout: ConstraintLayout extension of

Views DSL.

Views DSL CoordinatorLayout: CoordinatorLayout extension of

Views DSL.

Views DSL Material: Material Components extension of Views DSL.
Views DSL RecyclerView: RecyclerView extension of Views DSL.

Various UI utilities (Android only)

Resources: Extensions to get resources like strings, colors or drawables easily,

with support for themed attributes.

Dimensions: Android dp extensions for View and Context.

Particularly handy when using Views DSL.

Selectable views

- Selectable Views: Selectable Views with foreground property before API 23. - Selectable Views AppCompat: Selectable Views for AppCompatTextView. - Selectable Views ConstraintLayout: Selectable Views for ConstraintLayout.

Typesafe RecyclerView: Typesafe ViewHolder and ItemViewHolder for easy basic usage of RecyclerView.

Material Design helpers (Android only)

Material Colors: 2014 Material Design color palettes as color resources.
- Material Lists: List item Views implementing Material Design guidelines (perfect for usage in a RecyclerView).
  Inter and cross app communication: Activities, Fragments, Intents, and Bundles
  - Activities: Start activities with minimal boilerplate.
  - Intents: Transform companion objects into powerful typesafe intent specs,
  and create PendingIntents the clean and easy way.
  - Fragments: Start activities from fragments and do transactions with
  minimal boilerplate.
  - Fragment Args: Fragment arguments without ceremony thanks to
  delegated properties.
  - Bundle: BundleSpec to use Bundle with property syntax for Intent
  extras and more.
  Concurrency (Multiplatform)
  - Coroutines: General purpose extensions to kotlinx.coroutines.
  - Lifecycle Coroutines (Android only): Coroutines integration with AndroidX
  Lifecycle.
  - Main Thread: Properties and precondition checkers related to the main thread.
  - Main Handler (Android only): Top-level mainHandler property to stop allocating multiple
  Handlers for main Looper.
  - Checked Lazy (Android only): mainThreadLazy that checks property access on
  Data persistence (Multiplatform)
  - Preferences: Property syntax for Android's SharedPreferences/DataStore and macOS/iOS/watchOS NSUserDefaults.
  - Arch Room: Room helpers to instantiate your DB and perform
  transactions in Kotlin.
  Utilities (Multiplatform)
  - Bit Flags: hasFlag, withFlag and minusFlag extensions on Long, Int, Short, Byte, and their unsigned counterparts.
  - Collections: forEach for Lists without Iterator allocation.
  Debugging (Android only)
  - Stetho init: Have Stetho for your debug
  builds, without writing any code!
  Legacy (Android only)
  - Exceptions: unexpectedValue(…), unsupportedAction(…) and similar
  functions that return Nothing.
  - Arch Lifecycle: Extensions to get ViewModels, use LiveData and
  observe Lifecycles.
  Download
  
  Gradle instructions
  
  Make sure you have mavenCentral() in the repositories defined in your project's (root) build.gradle file (default for new Android Studio projects).
  
  To make it easier to take advantage of the contents of Splitties for your Android projects, there are grouping artifacts that include most splits.
  
  Android base
  
  Adding with refreshVersions: Splitties.pack.androidBase or Splitties.pack.androidBaseWithViewsDsl.
  
  These 2 packs don't include AppCompat and are suitable for WearOS apps.
  
  Includes the following modules:
  Gradle dependency:
```
implementation("com.louiscad.splitties:splitties-fun-pack-android-base:3.0.0")
```
  There's also a version with Views DSL. It additionally includes the following modules:
  Gradle dependency:
```
implementation("com.louiscad.splitties:splitties-fun-pack-android-base-with-views-dsl:3.0.0")
```
  Android AppCompat
  
  Adding with refreshVersions: Splitties.pack.appCompat or Splitties.pack.appCompatWithViewsDsl.
  
  These 2 packs include the Android base pack, and the following modules:
  Gradle dependency:
```
implementation("com.louiscad.splitties:splitties-fun-pack-android-appcompat:3.0.0")
```
  There's also a version with Views DSL. It additionally includes the Views DSL version of the Android base pack and the following module:
  - views-dsl-appcompat
  Gradle dependency:
```
implementation("com.louiscad.splitties:splitties-fun-pack-android-appcompat-with-views-dsl:3.0.0")
```
  Android Material Components
  
  Adding with refreshVersions: Splitties.pack.androidMdc or Splitties.pack.androidMdcWithViewsDsl.
  
  These 2 packs include the Android AppCompat pack, and the following modules:
  Gradle dependency:
```
implementation("com.louiscad.splitties:splitties-fun-pack-android-material-components:3.0.0")
```
  There's also a version with Views DSL. It additionally includes the Views DSL version of the Android AppCompat pack and the following modules:
  - views-dsl-coordinatorlayout
  - views-dsl-material
  Gradle dependency:
```
implementation("com.louiscad.splitties:splitties-fun-pack-android-material-components-with-views-dsl:3.0.0")
```
  All the artifacts (47)
  
  Since you might use multiple artifacts, to not repeat yourself, we recommend you to put the version in a central place, so it's little effort to upgrade to newer versions.
  
  The best way to do this is to use refreshVersions, it has built-in dependency notations for Splitties, and also many other popular and qualitative libraries, like kotlinx, AndroidX, libraries from Square/CashApp and libraries from Google.
  
  Most importantly, with it, running the refreshVersions task will show you the available updates in a matter of seconds, for all of your dependencies, right into the versions.properties, in a way that makes upgrading effortless, even with just the keyboard.
  
  FYI, the current latest release of Splitties is the version 3.0.0
  Here are the maven coordinates of all the artifacts of this library, for reference. (Click to expand)
```
com.louiscad.splitties:splitties-activities
com.louiscad.splitties:splitties-alertdialog
com.louiscad.splitties:splitties-alertdialog-appcompat
com.louiscad.splitties:splitties-alertdialog-appcompat-coroutines
com.louiscad.splitties:splitties-appctx
com.louiscad.splitties:splitties-arch-lifecycle
com.louiscad.splitties:splitties-arch-room
com.louiscad.splitties:splitties-bitflags
com.louiscad.splitties:splitties-bundle
com.louiscad.splitties:splitties-checkedlazy
com.louiscad.splitties:splitties-collections
com.louiscad.splitties:splitties-coroutines
com.louiscad.splitties:splitties-dimensions
com.louiscad.splitties:splitties-exceptions
com.louiscad.splitties:splitties-fragments
com.louiscad.splitties:splitties-fragmentargs
com.louiscad.splitties:splitties-intents
com.louiscad.splitties:splitties-lifecycle-coroutines
com.louiscad.splitties:splitties-mainhandler
com.louiscad.splitties:splitties-mainthread
com.louiscad.splitties:splitties-material-colors
com.louiscad.splitties:splitties-material-lists
com.louiscad.splitties:splitties-permissions
com.louiscad.splitties:splitties-preferences
com.louiscad.splitties:splitties-resources
com.louiscad.splitties:splitties-snackbar
com.louiscad.splitties:splitties-stetho-init
com.louiscad.splitties:splitties-systemservices
com.louiscad.splitties:splitties-toast
com.louiscad.splitties:splitties-typesaferecyclerview
com.louiscad.splitties:splitties-views
com.louiscad.splitties:splitties-views-appcompat
com.louiscad.splitties:splitties-views-cardview
com.louiscad.splitties:splitties-views-coroutines
com.louiscad.splitties:splitties-views-coroutines-material
com.louiscad.splitties:splitties-views-dsl
com.louiscad.splitties:splitties-views-dsl-appcompat
com.louiscad.splitties:splitties-views-dsl-constraintlayout
com.louiscad.splitties:splitties-views-dsl-coordinatorlayout
com.louiscad.splitties:splitties-views-dsl-ide-preview
com.louiscad.splitties:splitties-views-dsl-material
com.louiscad.splitties:splitties-views-dsl-recyclerview
com.louiscad.splitties:splitties-views-material
com.louiscad.splitties:splitties-views-recyclerview
com.louiscad.splitties:splitties-views-selectable
com.louiscad.splitties:splitties-views-selectable-appcompat
com.louiscad.splitties:splitties-views-selectable-constraintlayout
```
  Snapshots
  
  Let's say you need to try a new feature or a fix that did not make it to a release yet:
  
  You can grab it in the snapshot version by adding the corresponding repository as shown below, and changing the library version to the latest snapshot, 3.0.0-SNAPSHOT:
```
allProjects {
    repositories {
        mavenCentral()
        google() // Add sonatype snapshots repo below
        maven(url = "https://oss.sonatype.org/content/repositories/snapshots")
    }
}
```
  New versions notifications
  
  Releases are announced on GitHub, you can subscribe by clicking on "Watch", then "Releases only".
  
  However, if you use refreshVersions, you'll also learn about updates when you run the refreshVersions task right in the versions.properties file.
  
  Improve this library
  
  If you want this library to have a new feature or an improvement in a new or in an existing module, please, open an issue or vote/comment a similar one first, so it can be discussed.
  
  Documentation contributions are also welcome. For typos or other small improvements, feel free to submit a PR (pull request) directly. For more significant doc contributions, please open an issue first, so it can be discussed.
  
  If you find a bug, please open an issue with all the important details. If you know a simple fix that is not API breaking and that does not have side effects that need to be considered, you may also directly submit a PR.
  
  You can also join the discussion on Kotlin's Slack in the #splitties channel (you can get an invitation here).
  
  What is a split
  
  A "split" is a module of the Splitties library that you can add as a dependency. It only includes the required transitive dependencies. This allows you to only add what you need in your app or library module, so the final apk/ipa/app is as small as possible and doesn't include stuff not used by your app.
  
  Let's say you're building a Wear OS app using the Views DSL. Wear OS apps don't need AppCompat. Including it would be a waste of bandwidth and storage. The Views DSL core module relies on the Android SDK but not on AppCompat, so you don't bloat your wrist app with AppCompat by using Views DSL. However, if you are building a phone, tablet or computer Android app, there's a Views DSL AppCompat split with a few extensions for you to use.
  
  Credits
  
  Special thanks to Jovche Mitrejchevski for helping in taking decisions for this project.
  
  Thanks to JetBrains and the contributors for Anko, which was a great source of inspiration, especially for Views DSL, and of course thanks for the excellent Kotlin programming language that makes this project possible.
  
  Thanks to Doug Stevenson for his articles "Kotlin & Android: A Brass Tacks Experiment". It is fair to say that Views DSL has its root in this experiment.
  
  License
  
  This library is published under Apache License version 2.0 which you can see here.