indramahkota / compose-cupertino

Compose Multiplatform UI components for iOS (Cupertino Widgets)

Compose Cupertino

Compose.Cuepertino.mp4

Compose Cupertino is a Kotlin Multiplatform library for the Compose Multiplatform UI framework. It provides various UI components for making native-looking iOS applications, including

• cupertino - Compose Multiplatform implementation of iOS-like Cupertino theme and widgets, based on compose.foundation. Inspired by compose.material3 and SwiftUI APIs;
• cupertino-native - UIKit native wrappers for Cupertino Widgets. Allows to seamlessly use some UIKit widgets for iOS and their equivalents from cupertino for other platforms;
• cupertino-adaptive - adaptive theme and wrappers for Cupertino and Material3 widgets. Allows to seamlessly use both widgets from shared code with correct content color and font style;
• cupertino-icons-extended - more than 800 most used monochrome Apple SF Symbols as Compose ImageVectors. These symbols are copyrighted. Please read licence agreement first. If you don't need these icons for platform other than iOS, you can use ios bundled icons using converters from cupertino-native.
• cupertino-decompose - iOS-like swipe-back animation for the 'predictive back' navigation feature of the Decompose library + NativeChildren wrapper over UINavigationController. Provides native-feeling or truly native page transitions and swipe gestures.

Installation

Important

The project is in the experimental phase. All APIs can change incompatibly or be dropped without the deprecation cycle!

Add the dependency to your build.gradle.kts file.

Module	Dependency
cupertino	io.github.alexzhirkevich:cupertino:<version>
cupertino-native	io.github.alexzhirkevich:cupertino-native:<version>
cupertino-adaptive	io.github.alexzhirkevich:cupertino-adaptive:<version>
cupertino-decompose	io.github.alexzhirkevich:cupertino-decompose:<version>
cupertino-icons-extended	io.github.alexzhirkevich:cupertino-icons-extended:<version>

Usage

To use iOS-like widgets with Compose Cupertino and view available components, see Cupertino.

To use widgets that change based on the platform (looking like either Material You or iOS) and view available components, see Adaptive.

License

Copyright (c) 2023 Compose Cupertino project and open source contributors.

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.