Sesame

Sesame

Sesame is a set of architecture components for Android development. It is based on modern technologies including coroutines and Flow. Sesame is simple to learn and easy to use. It is ideally suited for MVVM and MVI architectures.

Some Sesame features are inspired by RxPM library.

Components

property - provides observable properties and one-time commands.
dialog - allows to control dialogs from View Models.
navigation - gives an universal way to navigate between screens.
activable - equips View Models with a very simple lifecycle.
loading - helps to manage state for data loading (including paged one).
loop - provides a simple MVI implementation.
localized string - helps to deal with string resources.
form - provides input field validation.
compose-form - same as form but for Jetpack Compose.

Sesame components are separate modules. Use only that you like.

Gradle Setup

dependencies {
    implementation 'com.github.aartikov:sesame-property:1.5.0'
    implementation 'com.github.aartikov:sesame-dialog:1.5.0'
    implementation 'com.github.aartikov:sesame-navigation:1.5.0'
    implementation 'com.github.aartikov:sesame-activable:1.5.0'
    implementation 'com.github.aartikov:sesame-loading:1.5.0'
    implementation 'com.github.aartikov:sesame-loop:1.5.0'
    implementation 'com.github.aartikov:sesame-localized-string:1.5.0'
    implementation 'com.github.aartikov:sesame-form:1.5.0'
    implementation 'com.github.aartikov:sesame-compose-form:1.5.0'
}

Sample

The sample application consists of several screens. Each screen demonstrates certain Sesame feature.

COUNTER - shows how to use properties and commands from property.
PROFILE - loads ordinary data with loading.
DIALOGS - shows how to use dialog and localized string.
MOVIES - loads paged data with loading.
CLOCK - shows how to use activable.
FORM - validates input fields with form.
The whole app - demonstrates navigation.

There is no sample for loop. See LoadingLoop and PagedLoadingLoop as good examples how to use it.

Compose Sample

The compose sample shows how to use Sesame with Jetpack Compose and Decompose. Each screen demonstrates certain Sesame feature.

COUNTER - shows that we don’t need property to manage Jetpack Compose state. mutableStateOf and derivedStateOf are used instead.
PROFILE - loads ordinary data with loading.
DIALOGS - shows how to use dialog and localized string.
MOVIES - loads paged data with loading.
FORM - validates input fields with compose-form.

Contact the author

Artur Artikov [email protected]

License

The MIT License (MIT)

Copyright (c) 2021 Artur Artikov, Alexander Rovnov, Pavel Aleksandrov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.