README.md

⚠️ Warning: this project as been moved

See the new trikot repository for releases starting from 3.0.0.

Trikot.viewmodels

ViewModels expose properties that can be binded to Android or iOS UI components. It allows 2 way interactions between Kotlin Multiplatform Common Code and platform UI.

The basics

Both iOS and Android comes with a binding library that supports basics UI components (View, Label, Button, Input, Image) designed to be bound to their ViewModel equivalent (ViewModel, LabelViewModel, ButtonViewModel, ImageViewModel, ect...). Since ViewModels are interfaces that are not meant to be modified, Mutable implementations are included to create each type of ViewModel (MutableViewModel, MutableLabelViewModel, MutableButtonViewModel, MutableImageViewModel, ect...). We suggest that custom ViewModel definition and implementation follow the same pattern.

All properties are reactive and observed by the platforms. They are ReactiveStreams Publisher<T>. See Trikot.streams for more inforamtion about Publishers.

Additionally, you can easily replace a property with another org.reactivestreams.Publisher<T> (Like a Flow Coroutine per example).

See (Sample application)[https://github.com/mirego/trikot.viewmodels/tree/master/sample] for all possibilities.

iOS UILabel	Android TextView

Interfaces provides documentation

• ViewModel
• ButtonViewModel
• LabelViewModel
• ImageViewModel
• InputTextViewModel

Multiplatform Sample

Common code

class SearchViewModel() {
    private val numberOfClickPublisher = Publishers.behaviorSubject(0)
    private val labelTextPublisher = numberOfClickPublisher.map { "Clicked $it times" }
    private val labelViewModel = MutableLabelViewModel().also {
        it.text = labelTextPublisher
    }
    private val buttonViewModel = MutableButtonViewModel().also {
        it.text = "Click Me".just() // .just() Transform any value into Single Publisher of this value
        it.action.value = ViewModelAction { numberOfClickPublisher.value += 1 }.just()
    }
}

iOS

See swift extensions for more information.

Helps connect a publisher to a variable in a reactive environment.

let label = UILabel()
let button = UIButton()
label.labelViewModel = searchViewModel.labelViewModel
button.buttonViewModel = searchViewModel.buttonViewModel

Android

 <TextView
            ...
            core:view_model="@{searchViewModel.labelViewModel}"
            app:lifecycleOwnerWrapper="@{lifecycleOwnerWrapper}"
            />
 <Button
            ...
            core:view_model="@{searchViewModel.buttonViewModel}"
            app:lifecycleOwnerWrapper="@{lifecycleOwnerWrapper}"
            />

Installation

Import dependencies

    api "com.mirego.trikot:viewmodels:$trikot_viewmodels_version"
    jvm "com.mirego.trikot:viewmodels-jvm:$trikot_viewmodels_version"
    js "com.mirego.trikot:viewmodels-js:$trikot_viewmodels_version"
    iosx64 "com.mirego.trikot:viewmodels-iosx64:$trikot_viewmodels_version"
    iosarm64 "com.mirego.trikot:viewmodels-iosarm64:$trikot_viewmodels_version"

License

Trikot.viewmodels is © 2018-2019 Mirego and may be freely distributed under the New BSD license. See the LICENSE.md file.

About Mirego

Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.

We also love open-source software and we try to give back to the community as much as we can.