Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-parcelize
@Parcelize support for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-parcelize
android ios kotlin kotlin-multiplatform kotlin-native moko parcelable
Last synced: 3 months ago
JSON representation
@Parcelize support for mobile (android & ios) Kotlin Multiplatform development
- Host: GitHub
- URL: https://github.com/icerockdev/moko-parcelize
- Owner: icerockdev
- License: apache-2.0
- Created: 2019-10-15T03:29:16.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T14:28:24.000Z (over 1 year ago)
- Last Synced: 2024-07-12T21:12:31.076Z (4 months ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-native, moko, parcelable
- Language: Kotlin
- Homepage: https://moko.icerock.dev
- Size: 209 KB
- Stars: 59
- Watchers: 6
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- kmp-awesome - MOKO Parcelize - Parcelize in common code (Libraries / 🗃 Serializer)
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/parcelize) 
# MOKO Parcelize
This is a Kotlin Multiplatform library that supports Parcelize in common code.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#setup-locally)
- [Contributing](#contributing)
- [License](#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
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:parcelize:0.9.0")
}
```
Enable [kotlin parcelize](https://developer.android.com/kotlin/parcelize):
```groovy
apply plugin: 'kotlin-parcelize'
```
## Usage
### Parcelize
Mark common code classes with the annotation `@Parcelize` like in the Android code for automatically generated `Parcelable` implementation.
```kotlin
@Parcelize
data class User(
val firstName: String,
val lastName: String
) : Parcelable
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [parcelize directory](parcelize) contains the `parcelize` library;
- The [sample directory](sample) 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](CONTRIBUTING.md).
## 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.