MOKO Parcelize

This is a Kotlin Multiplatform library that supports Parcelize in common code.

Table of Contents

• Features
• Requirements
• Installation
• Usage
• Samples
• Set Up Locally
• Contributing
• License

Features

• Parcelize in common code (specially for Android target);
• All Kotlin Multiplatform targets support.

Requirements

• Gradle version 6.8+
• Android API 16+
• iOS version 11.0+

Installation

root build.gradle

allprojects {
    repositories {
        mavenCentral()
    }
}

project build.gradle

dependencies {
    commonMainApi("dev.icerock.moko:parcelize:0.9.0")
}

Enable kotlin parcelize:

apply plugin: 'kotlin-parcelize'

Usage

Parcelize

Mark common code classes with the annotation @Parcelize like in the Android code for automatically generated Parcelable implementation.

@Parcelize
data class User(
  val firstName: String,
  val lastName: String
) : Parcelable

Samples

Please see more examples in the sample directory.

Set Up Locally

• The parcelize directory contains the parcelize library;
• The sample directory contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
• For publish to MavenLocal repository run ./gradlew publishToMavenLocal -DIS_MAIN_HOST=true

Contributing

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.

License

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.