This is a Kotlin MultiPlatform library that provides RecyclerView/UITableView/UICollectionView filling from common code.
- Control UI lists from common code - content for
RecyclerView
/UITableView
/UICollectionView
creating from common kotlin code.
- Gradle version 6.8+
- Android API 16+
- iOS version 11.0+
root build.gradle
buildscript {
repositories {
gradlePluginPortal()
}
dependencies {
classpath("dev.icerock.moko:units-generator:0.8.0")
}
}
allprojects {
repositories {
mavenCentral()
}
}
project build.gradle
dependencies {
commonMainApi("dev.icerock.moko:units:0.8.0")
commonMainImplementation("dev.icerock.moko:units-basic:0.8.0")
commonTestImplementation("dev.icerock.moko:units-test:0.8.0")
}
On iOS, in addition to the Kotlin library add Pod in the Podfile.
pod 'MultiPlatformLibraryUnits', :git => 'https://github.com/icerockdev/moko-units.git', :tag => 'release/0.8.0'
MultiPlatformLibraryUnits
CocoaPod requires that the framework compiled from Kotlin be named
MultiPlatformLibrary
and be connected as a CocoaPod MultiPlatformLibrary
.
Here's an example.
To simplify integration with MultiPlatformFramework you can use mobile-multiplatform-plugin.
MultiPlatformLibraryUnits
CocoaPod contains an swift additions for UnitDataSource
s of UITableView
/UICollectionView
.
In android build.gradle
databinding usage
apply plugin: "dev.icerock.mobile.multiplatform-units"
dependencies {
implementation("dev.icerock.moko:units-databinding:0.8.0")
}
multiplatformUnits {
classesPackage = "org.example.library.units"
dataBindingPackage = "org.example.library"
layoutsSourceSet = "main"
}
viewbinding usage
dependencies {
implementation("dev.icerock.moko:units-viewbinding:0.8.0")
}
common:
interface UnitFactory {
fun createHeader(text: String): TableUnitItem
fun createProfileTile(profileId: Long, avatarUrl: String, username: String): TableUnitItem
}
class ViewModel(unitFactory: UnitFactory) {
val items = listOf(
unitFactory.createHeader("Programmers"),
unitFactory.createProfileTile(1, "url", "Mikhailov"),
unitFactory.createProfileTile(2, "url", "Babenko"),
unitFactory.createProfileTile(3, "url", "Tchernov"),
unitFactory.createHeader("Designers"),
unitFactory.createProfileTile(4, "url", "Eugeny")
)
}
android with databinding (using module units-databinding)
<androidx.recyclerview.widget.RecyclerView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:bindValue="@{viewModel.items}"
app:adapter="@{`dev.icerock.moko.units.adapter.UnitsRecyclerViewAdapter`}"
app:layoutManager="androidx.recyclerview.widget.LinearLayoutManager"/>
object UnitFactoryImpl: UnitFactory {
fun createHeader(text: String): TableUnitItem {
return LayoutHeader()
.setText(text)
.setItemId(text.hashCode())
}
fun createProfileTile(profileId: Long, avatarUrl: String, username: String): TableUnitItem {
return LayoutProfileTile()
.setAvatarUrl(avatarUrl)
.setUserName(username)
.setItemId(profileId)
}
}
mBinding.viewModel = ViewModel(UnitFactoryImpl)
android with viewbinding (using module units-viewbinding)
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="vertical">
<TextView
android:id="@+id/unit_blue_divider_textView"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="#2196F3" />
</LinearLayout>
For every unit_layout.xml
should create class using viewbinding-generated class UnitLayoutBinding
class UnitBlueDivider(override val itemId: Long) :
VBTableUnitItem<UnitBlueDividerBinding>() {
override val layoutId: Int = R.layout.unit_blue_divider
override fun bindView(view: View): UnitBlueDividerBinding {
return UnitBlueDividerBinding.bind(view)
}
override fun UnitBlueDividerBinding.bindData(
context: Context,
lifecycleOwner: LifecycleOwner,
viewHolder: VBViewHolder<UnitBlueDividerBinding>
) {
this.unitBlueDividerTextView.setBackgroundColor(Color.parseColor("#2196F3"))
}
}
override fun createBlueDividerUnit(id: Long): TableUnitItem {
return UnitBlueDivider(
itemId = id
)
}
On Android you can use units with viewbinding or with databinding, just plug in the corresponding module: units-viewbinding
or units-databinding
iOS:
class UnitFactoryImpl: NSObject, UnitFactory {
func createHeader(text: String) -> TableUnitItem {
let data = HeaderTableViewCell.CellModel(text: text)
return UITableViewCellUnit<HeaderTableViewCell>(
data: data,
itemId: text.hashCode(),
configurator: nil)
}
func createProfileTile(profileId: Long, avatarUrl: String, username: String) -> TableUnitItem {
let data = ProfileTableViewCell.CellModel(avatarUrl: avatarUrl, username: username)
return UITableViewCellUnit<ProfileTableViewCell>(
data: data,
itemId: profileId,
configurator: nil)
}
}
let viewModel = ViewModel(unitFactory: UnitFactoryImpl())
let tableDataSource = TableUnitsSourceKt.default(for: tableView)
tableDataSource.units = viewModel.items
tableView.reloadTable()
If you want to use units in dropdown list you should implement DropDownUnitItem
. Abstract class VBDropDownUnitItem
already implement it so you can use it.
If you want the units UI will be different when dropdown list is close or open, you need to implement another interface TableUnitItem
which already implemented in VBTableUnitItem
.
The sample you can see here
Only what you need to make different UI to units in closed and open dropdown list with databinding is an another layout with _dropdown postfix
sample_unit.xml
for sample unit, sample_unit_dropdown.xml
for dropdown unit
Please see more examples in the sample directory.
- The units directory contains the
units
library; - The gradle-plugin directory contains a gradle plugin with a
MR
class generator; - The sample directory contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
All development (both new features and bug fixes) is performed in the develop
branch. This way master
always contains the sources of the most recently released version. Please send PRs with bug fixes to the develop
branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in master
.
The develop
branch is pushed to master
on release.
For more details on contributing please see the contributing guide.
Copyright 2019 IceRock MAG Inc.
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.