OSKit Compose

An opinionated architecture/library for Jetbrains Compose Multiplatform development with an implementation of the VISCE architecture

Abstract

OSKit Compose is primarily a tool for us here at Outside Source. That being said, feel free to use this library in your own code. We strive to adhere to semantic versioning.

Contributions

Contributions are appreciated and welcome, but we are a small team and make no guarantees that your changes will be implemented.

OSKitKMP Version Compatibility

• 5.0.0+

Documentation

https://outsidesource.github.io/OSKit-Compose-KMP/

Feature Highlights

• Common
  • Screen Wake Lock
    • KmpScreenWakeLockEffect
  • Animation
    • TransitionAnimatedContent (AnimatedContent with flexible transitions)
    • Common CubicBezier transitions
  • Canvas
    • Blur
    • URL Image painter
    • Bitmap Painter
    • Painter to Bitmap converter
  • Layouts
    • Arrangement.spacedByWithPadding()
    • FixedTableRow
    • FlexRow
    • PanAndScale
    • WrappableRow
  • Popups (able to be placed anywhere in composable tree)
    • BottomSheet
    • Drawer
    • Modal
    • Popover
    • Popup
  • OSKit Integration
    • Router
      • Compose implementation of OSKit Router
      • Backpress handling
      • Route transitions
    • Interactor
      • Compose implementation of OSKit Interactor
  • Markdown
    • Markdown renderer
    • Customizable styles with sane defaults
    • Load local or remote images and specify alignment and size
    • Asynchronous image loading
  • Modifier
    • borderTop, borderBottom, borderStart, borderEnd
    • innerShadow, outerShadow
    • disablePointerInput, preventClickPropagationToParent
    • Desktop external drag and drop support
  • Resources
    • Fonts
    • Images
    • Strings with localization
  • System UI
    • Application Lifecycle Observer
    • Customizable Window Insets
    • Customizable system bar colors
    • Window info
  • Misc
    • rememberLastNonNullValue()
• Android
  • Context helpers
• Desktop
  • Persisted window state
  • SizedWindow for windows with enforced minimum size

Supported Platforms

Currently supported platforms include:

• Android
• JVM (MacOS/Windows/Linux)
• iOS

Installation

implementation("com.outsidesource:oskit-compose:4.0.0")

Example App

https://github.com/outsidesource/OSKit-Example-App-KMP

Changelog

4.0.1 - 2025-05-20

• Kotlin 2.1.10 support
• Compose multiplatform 1.8.0

4.0.0 - 2025-02-07

Added

• Kotlin 2.1.0 support
• Compose multiplatform 1.7.3 support
• WindowInsets.ime
• Fixes for KmpWheelPicker to properly handle mouse wheel scrolling
• Added onDestroy parameter for rememberInjectForRoute
• Added FadeRouteTransition as a ComposeRouteTransition for Router
• Added onDestroy for rememberForRoute
• Added KmpScreenWakeLockEffect

Breaking Changes

• Adopted Upper Camel Case for all acronym prefixes on class and function names (i.e. KMP changed to Kmp)
• KMPDeepLinkEffect renamed to AndroidDeepLinkEffect and only available on Android
• kmpUrlImagePainter is now a suspending function
• Renamed rememberLastNonNullState to rememberLastNonNullValue
• Modifier.kmpOnExternalDrag was renamed and reworked to Modifier.kmpOnExternalDragAndDrop

3.7.2 - 2024-08-30

Fixed

• Non-fullscreen popups (i.e. Popover) on Android had a regression where they were not positioned correctly

3.7.1 - 2024-07-12

Fixed

• Back handling and key events in Android Popups

3.7.0 - 2024-05-30

Added

• onKeyEvent to BottomSheet
• KmpBackHandler/BackHandler to KmpPopup

3.6.0 - 2024-05-21

Added

• Focusable parameter to Popover
• KmpDisableScreenIdleTimeoutEffect

Breaking Changes

• Fixed typo in KmpTimePicker. Previously TimeMerdiem was TimeMeridian

3.5.0 - 2024-03-23

Added

• Support for Jetbrains Compose 1.6
• Support for Kotlin 1.9.23

Removed

• KmpResource - No longer works with compose 1.6
• KmpFont - No longer works with compose 1.6
• KmpImage - No longer works with compose 1.6

3.4.0 - 2024-03-06

Added

• KmpTimePicker
• KmpDatePicker
• KmpWheelPicker

3.3.0 - 2024-02-16

Added

• rememberKmpWindowInfo()
• createInteractor()
• KmpAppLifecycleObserver
• Context helper functions
• rememberLastNonNullState()
• Fallback locale for KmpString
• Markdown
  • Async image loading
  • Loading Markdown from other sources
• PopupShapeCaretPosition

Fixed

• iOS window insets issues

Breaking Changes

• Markdown onLinkClick now accepts a second parameter