LouisCAD/Splitties LouisCAD/Splitties

  • Stars
    star
    2,503
  • Rank 18,340 (Top 0.4 %)
  • Language
    Kotlin
  • License
    Apache License 2.0
  • Created over 8 years ago
  • Updated 6 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
LouisCAD/Splitties
github

LouisCAD

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A collection of hand-crafted extensions for your Kotlin projects.

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.refresh_successful, Snackbar.LENGTH_SHORT)
    .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.deleted_x_items, 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.deleted_x_items, deletedCount)) {
    action(android.R.string.cancel, textColor = color(R.color.fancy_color)) {
        deleteOperation.requestRollback()
    }
}

Overview

System interaction (Android only):

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

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

  • 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)

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)

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:

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:

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.

More Repositories

1

CompleteKotlin

Gradle Plugin to enable auto-completion and symbol resolution for all Kotlin/Native platforms.
Kotlin
286
star
2

kotlin-libraries-playground

A playground to gain a wider and deeper knowledge of the libraries in the Kotlin ecosystem. Also the official sample for gradle refreshVersions.
Kotlin
180
star
3

GoogleDevelopersColorScheme

Color scheme for Android Studio and IntelliJ, inspired by code snippets style seen on Google Developers website
85
star
4

ResumeComposition

Resume of Louis CAD, made with Jetpack Compose. Supports the Web, Desktop, and Android.
Kotlin
22
star
5

Kotlin_Everywhere_Paris_2019_Coroutines_Workshop

"Les coroutines en détail", workshop for the Kotlin/Everywhere Paris 2019 event https://everywhere.kotlin.paris
Kotlin
2
star
6

LibPublishingHelpers

Tools for semi-auto library publishing (and other chores). Designed for Kotlin scripts.
Kotlin
2
star
7

PopularMovies

Popular Movies Android app for my Nanodegree @Udacity
Java
2
star
8

LouisCAD

1
star
9

solution.bike

Website for https://solution.bike made in Kotlin
Kotlin
1
star
10

android-dev-challenge-compose-timer

Android Dev Challenge: Week 2 - Countdown timer https://android-developers.googleblog.com/2021/03/android-dev-challenge-2.html
Kotlin
1
star
11

Kotline

A troll project where Kotlin stdlib is translated to French with Kotlin features like typealiases and extensions
1
star