{"id":13659468,"url":"https://github.com/mori-atsushi/insetsx","last_synced_at":"2025-04-24T14:33:22.561Z","repository":{"id":99475570,"uuid":"547877469","full_name":"mori-atsushi/insetsx","owner":"mori-atsushi","description":"WindowInsets utility for compose multiplatform","archived":false,"fork":false,"pushed_at":"2025-04-21T19:04:41.000Z","size":488,"stargazers_count":231,"open_issues_count":17,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-21T20:23:32.851Z","etag":null,"topics":["compose-multiplatform","jetpack-compose","kotlin","kotlin-multiplatform"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mori-atsushi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-10-08T13:26:58.000Z","updated_at":"2025-03-19T11:36:07.000Z","dependencies_parsed_at":"2024-01-17T03:16:14.006Z","dependency_job_id":"ea3ec41c-a679-4c1f-bf99-2a4716164227","html_url":"https://github.com/mori-atsushi/insetsx","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mori-atsushi%2Finsetsx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mori-atsushi%2Finsetsx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mori-atsushi%2Finsetsx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mori-atsushi%2Finsetsx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mori-atsushi","download_url":"https://codeload.github.com/mori-atsushi/insetsx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250643745,"owners_count":21464228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compose-multiplatform","jetpack-compose","kotlin","kotlin-multiplatform"],"created_at":"2024-08-02T05:01:09.089Z","updated_at":"2025-04-24T14:33:22.278Z","avatar_url":"https://github.com/mori-atsushi.png","language":"Kotlin","funding_links":[],"categories":["Libraries","Uncategorized"],"sub_categories":["🍎 Compose UI","Uncategorized"],"readme":"## InsetsX  [🚧 Work in progress 🚧]\n[![](https://img.shields.io/badge/Kotlin-Multiplatform-%237f52ff?logo=kotlin)](https://kotlinlang.org/docs/multiplatform.html)\n[![](https://img.shields.io/maven-central/v/com.moriatsushi.insetsx/insetsx)](https://mvnrepository.com/artifact/com.moriatsushi.insetsx/insetsx)\n[![](https://img.shields.io/github/license/mori-atsushi/insetsx)](https://github.com/mori-atsushi/insetsx/blob/main/LICENSE)\n\n![](https://github.com/mori-atsushi/koject/assets/13435109/12ce8727-fcee-43a9-9f2c-34a58316728f)\n\nInsetsX provides a [WindowInsets](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/WindowInsets) utility for [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/).\n\nThe goal is to have a unified interface for handling WindowInsets across iOS and Android.\n\nOnce the official library supports WindowInsets, this library will be archived.\n\n## Setup\nTo use InsetsX, add the following dependency:\n\n```kotlin\nkotlin {\n    /* ... */\n\n    sourceSets {\n        val commonMain by getting {\n            dependencies {\n                implementation(\"com.moriatsushi.insetsx:insetsx:0.1.0-alpha10\")\n            }\n        }\n    }\n}\n```\n\n### Android\n1. (option) If you are using insets for IME support, set the activity's `windowSoftInputMode` to `adjustResize` in your AndroidManifest.xml file.\n\n```xml\n\u003cactivity\n      android:name=\".MyActivity\"\n      android:windowSoftInputMode=\"adjustResize\"\u003e\n\u003c/activity\u003e\n```\n\n2. Call `WindowCompat.setDecorFitsSystemWindows()` with `false` in the `onCreate` method of the activity .\n\n```kotlin\noverride fun onCreate(savedInstanceState: Bundle?) {\n    super.onCreate(savedInstanceState)\n\n    WindowCompat.setDecorFitsSystemWindows(window, false)\n}\n```\n\nDetail: [Lay out your app within window insets](https://developer.android.com/develop/ui/views/layout/insets)\n\n### iOS\n\n1. (option) If you want to use the `WindowInsetsController`, use `WindowInsetsUIViewController` instead of `ComposeUIViewController`.\n\n```kotlin\nfun MainUIViewController(): UIViewController {\n    return WindowInsetsUIViewController {\n        MyApp()\n    }\n}\n```\n\n## How to use\n### WindowInsets\nThis works much like Android's WindowInsets.\nPlease note that the package name is different.\n\n```kotlin\nimport androidx.compose.foundation.layout.windowInsetsPadding\nimport androidx.compose.foundation.layout.WindowInsets\nimport androidx.compose.runtime.Composable\nimport androidx.compose.ui.Modifier\nimport com.moriatsushi.insetsx.systemBars\nimport com.moriatsushi.insetsx.systemBarsPadding\n\n@Composable\nfun Sample() {\n    val modifier1 = Modifier\n        .windowInsetsPadding(WindowInsets.safeDrawing)\n\n    val modifier2 = Modifier\n        .safeDrawingPadding()\n}\n```\n\nAPI|android|ios\n:--|:--|:--\nWindowInsets.safeArea|system bars + display cutouts|SafeArea\nWindowInsets.systemBars|status bar + navigation bar|home indicator + status bar\nWindowInsets.navigationBars|navigation bar|home indicator\nWindowInsets.statusBars|status bar|status bar\nWindowInsets.ime *1|software keyboard|software keyboard\nWindowInsets.safeDrawing *1|system bars + software keyboard|SafeArea + software keyboard\n(Modifier)||\nModifier.safeAreaPadding()|system bars + display cutouts|SafeArea\nModifier.systemBarsPadding()|status bar + navigation bar|home indicator + status bar\nModifier.navigationBarsPadding()|navigation bar|home indicator\nModifier.statusBarsPadding()|status bar|status bar\nModifier.imePadding() *1|software keyboard|software keyboard\nModifier.safeDrawingPadding() *1|system bars + software keyboard|SafeArea + software keyboard\n\n*1 is experimental\n\n### WindowInsetsController\n`WindowInsetsController` can be used to change colors of system bars.\n\n```kotlin\n@Composable\nfun Sample() {\n    val windowInsetsController = rememberWindowInsetsController()\n    LaunchedEffect(Unit) {\n        // The status bars icon + content will change to a light color\n        windowInsetsController?.setStatusBarContentColor(dark = false)\n        // The navigation bars icons will change to a light color (android only)\n        windowInsetsController?.setNavigationBarsContentColor(dark = false)\n    }\n}\n```\n\nYou can also hide WindowInsets.\n\n```kotlin\n@Composable\nfun Sample() {\n    val windowInsetsController = rememberWindowInsetsController()\n    LaunchedEffect(Unit) {\n        // Hide the status bars\n        windowInsetsController?.setIsStatusBarsVisible(false)\n        // Hide the navigation bars\n        windowInsetsController?.setIsNavigationBarsVisible(false)\n        // Change an options for behavior when system bars are hidden\n        windowInsetsController?.setSystemBarsBehavior(SystemBarsBehavior.Immersive)\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmori-atsushi%2Finsetsx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmori-atsushi%2Finsetsx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmori-atsushi%2Finsetsx/lists"}