multiplatform: Add desktop support (WIP)

Co-authored-by: Patryk Goworowski <[email protected]>

.gitignore

@@ -4,6 +4,7 @@
 .externalNativeBuild
 .gradle
 .kotlin
+/.idea/.artifacts/
 /.idea/AndroidProjectSystem.xml
 /.idea/assetWizardSettings.xml
 /.idea/caches

sample/app/build.gradle.kts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import org.jetbrains.compose.desktop.application.dsl.TargetFormat
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 plugins {
@@ -53,6 +54,7 @@ kotlin {
       isStatic = true
     }
   }
+  jvm("desktop")
   sourceSets {
     androidMain.dependencies {
       implementation(libs.activityCompose)
@@ -66,5 +68,17 @@ kotlin {
       implementation(libs.composeNavigation)
       implementation(project(":sample:multiplatform"))
     }
+    val desktopMain by getting
+    desktopMain.dependencies { implementation(compose.desktop.currentOs) }
+  }
+}
+
+compose.desktop {
+  application {
+    mainClass = "com.patrykandpatrick.vico.sample.MainKt"
+    nativeDistributions {
+      packageName = "com.patrykandpatrick.vico.sample"
+      targetFormats(TargetFormat.Dmg, TargetFormat.Msi, TargetFormat.Deb)
+    }
   }
 }

sample/app/src/desktopMain/kotlin/com/patrykandpatrick/vico/sample/Charts.desktop.kt

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2025 by Patryk Goworowski and Patrick Michalik.
+ *
+ * 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.
+ */
+
+package com.patrykandpatrick.vico.sample
+
+actual val Charts.overridden: LinkedHashMap<UIFramework, List<Chart>>?
+  get() = null

sample/app/src/desktopMain/kotlin/com/patrykandpatrick/vico/sample/Main.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2025 by Patryk Goworowski and Patrick Michalik.
+ *
+ * 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.
+ */
+
+package com.patrykandpatrick.vico.sample
+
+import androidx.compose.ui.window.Window
+import androidx.compose.ui.window.application
+
+fun main() {
+  application { Window(onCloseRequest = ::exitApplication, title = "Vico") { SampleApp() } }
+}

sample/multiplatform/build.gradle.kts

@@ -36,6 +36,7 @@ kotlin {
       isStatic = true
     }
   }
+  jvm("desktop")
   sourceSets {
     commonMain.dependencies {
       implementation(compose.foundation)

vico/multiplatform-m2/build.gradle.kts

@@ -41,6 +41,7 @@ kotlin {
       isStatic = true
     }
   }
+  jvm("desktop")
   sourceSets {
     commonMain.dependencies {
       api(project(":vico:multiplatform"))

vico/multiplatform-m3/build.gradle.kts

@@ -41,6 +41,7 @@ kotlin {
       isStatic = true
     }
   }
+  jvm("desktop")
   sourceSets {
     commonMain.dependencies {
       api(project(":vico:multiplatform"))

vico/multiplatform/build.gradle.kts

@@ -41,6 +41,7 @@ kotlin {
       isStatic = true
     }
   }
+  jvm("desktop")
   sourceSets {
     commonMain.dependencies {
       implementation(compose.foundation)

vico/multiplatform/src/androidMain/kotlin/com/patrykandpatrick/vico/multiplatform/cartesian/Modifier.android.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2025 by Patryk Goworowski and Patrick Michalik.
+ *
+ * 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.
+ */
+
+package com.patrykandpatrick.vico.multiplatform.cartesian
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+
+@Composable internal actual fun Modifier.extraPointerInput(scrollState: VicoScrollState) = this

vico/multiplatform/src/commonMain/kotlin/com/patrykandpatrick/vico/multiplatform/cartesian/CartesianChartHost.kt

@@ -155,13 +155,12 @@ internal fun CartesianChartHostImpl(
   Canvas(
     modifier =
       Modifier.fillMaxSize()
-        .chartTouchEvent(
-          setTouchPoint =
+        .pointerInput(
+          scrollState = scrollState,
+          onPointerPositionChange =
             remember(chart.marker == null) {
               if (chart.marker != null) pointerPosition.component2() else null
             },
-          isScrollEnabled = scrollState.scrollEnabled,
-          scrollState = scrollState,
           onZoom =
             remember(zoomState, scrollState, chart, coroutineScope) {
               if (zoomState.zoomEnabled) {

vico/multiplatform/src/commonMain/kotlin/com/patrykandpatrick/vico/multiplatform/cartesian/Modifier.kt

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2025 by Patryk Goworowski and Patrick Michalik.
+ *
+ * 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.
+ */
+
+package com.patrykandpatrick.vico.multiplatform.cartesian
+
+import androidx.compose.foundation.gestures.Orientation
+import androidx.compose.foundation.gestures.scrollable
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.geometry.Offset
+import androidx.compose.ui.input.pointer.PointerEventType
+import androidx.compose.ui.input.pointer.pointerInput
+import com.patrykandpatrick.vico.multiplatform.common.Point
+import com.patrykandpatrick.vico.multiplatform.common.detectZoomGestures
+
+private const val BASE_SCROLL_ZOOM_DELTA = 0.1f
+
+private fun Offset.toPoint() = Point(x, y)
+
+@Composable internal expect fun Modifier.extraPointerInput(scrollState: VicoScrollState): Modifier
+
+@Composable
+internal fun Modifier.pointerInput(
+  scrollState: VicoScrollState,
+  onPointerPositionChange: ((Point?) -> Unit)?,
+  onZoom: ((Float, Offset) -> Unit)?,
+) =
+  scrollable(
+      state = scrollState.scrollableState,
+      orientation = Orientation.Horizontal,
+      enabled = scrollState.scrollEnabled,
+      reverseDirection = true,
+    )
+    .pointerInput(onPointerPositionChange, onZoom) {
+      awaitPointerEventScope {
+        while (true) {
+          val event = awaitPointerEvent()
+          when {
+            event.type == PointerEventType.Scroll && scrollState.scrollEnabled && onZoom != null ->
+              onZoom(
+                1 - event.changes[0].scrollDelta.y * BASE_SCROLL_ZOOM_DELTA,
+                event.changes[0].position,
+              )
+            onPointerPositionChange == null -> continue
+            event.type == PointerEventType.Press ->
+              onPointerPositionChange(event.changes[0].position.toPoint())
+            event.type == PointerEventType.Release -> onPointerPositionChange(null)
+            event.type == PointerEventType.Move && !scrollState.scrollEnabled ->
+              onPointerPositionChange(event.changes[0].position.toPoint())
+          }
+        }
+      }
+      if (onZoom == null) return@pointerInput
+      detectZoomGestures { centroid, zoom ->
+        onPointerPositionChange?.invoke(null)
+        onZoom(zoom, centroid)
+      }
+    }
+    .extraPointerInput(scrollState)

vico/multiplatform/src/desktopMain/kotlin/com/patrykandpatrick/vico/multiplatform/cartesian/Modifier.desktop.kt

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2025 by Patryk Goworowski and Patrick Michalik.
+ *
+ * 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.
+ */
+
+package com.patrykandpatrick.vico.multiplatform.cartesian
+
+import androidx.compose.animation.core.AnimationState
+import androidx.compose.animation.core.animateDecay
+import androidx.compose.animation.rememberSplineBasedDecay
+import androidx.compose.foundation.gestures.Orientation
+import androidx.compose.foundation.gestures.draggable
+import androidx.compose.foundation.gestures.rememberDraggableState
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.ui.Modifier
+import com.patrykandpatrick.vico.multiplatform.common.getValue
+import com.patrykandpatrick.vico.multiplatform.common.rememberWrappedValue
+import com.patrykandpatrick.vico.multiplatform.common.setValue
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
+
+@Composable
+internal actual fun Modifier.extraPointerInput(scrollState: VicoScrollState): Modifier {
+  var scrollJob by rememberWrappedValue<Job?>(null)
+  val coroutineScope = rememberCoroutineScope()
+  val animationSpec = rememberSplineBasedDecay<Float>()
+  return draggable(
+    state =
+      rememberDraggableState { delta ->
+        scrollJob?.cancel()
+        coroutineScope.launch { scrollState.scroll(Scroll.Relative.pixels(delta)) }
+      },
+    orientation = Orientation.Horizontal,
+    onDragStopped = { velocity ->
+      scrollJob =
+        coroutineScope.launch {
+          AnimationState(scrollState.value, velocity).animateDecay(animationSpec) {
+            runBlocking { scrollState.scroll(Scroll.Absolute.pixels(value)) }
+          }
+        }
+    },
+    reverseDirection = true,
+  )
+}

vico/multiplatform/src/iosMain/kotlin/com/patrykandpatrick/vico/multiplatform/cartesian/Modifier.ios.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2025 by Patryk Goworowski and Patrick Michalik.
+ *
+ * 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.
+ */
+
+package com.patrykandpatrick.vico.multiplatform.cartesian
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+
+@Composable internal actual fun Modifier.extraPointerInput(scrollState: VicoScrollState) = this