|
2 years ago | |
---|---|---|
.. | ||
README.md | 2 years ago | |
screen1.png | 4 years ago | |
screen2.gif | 4 years ago | |
screen3.png | 4 years ago | |
screen4.png | 4 years ago | |
screen5.png | 4 years ago | |
screen6.png | 3 years ago |
README.md
Getting Started with Compose Multiplatform
What is covered
In this tutorial we will create a simple desktop UI application using Compose Multiplatform UI framework.
Prerequisites
Compose for Desktop can produce applications for macOS, Linux and Windows platforms. So any of these platforms can be used for this tutorial.
The following software has to be preinstalled:
- JDK 11 or later
- IntelliJ IDEA Community Edition or Ultimate Edition 2020.3 or later (other editors could be used, but we assume you are using IntelliJ IDEA in this tutorial)
Creating a new project
New project wizard
Kotlin support in IDEA IDE starting with the version 2020.3 comes with the new project wizard capable to create a Compose application automatically.
Note that JDK must be at least JDK 11, and to use the native distribution packaging JDK 15 or later must be used.
![Create new project 1](/github/compose-jb/media/commit/62a657b6cd0cd3a17d1059bbda92ae226fdd5aba/tutorials/Getting_Started/screen3.png)
![Create new project 2](/github/compose-jb/media/commit/62a657b6cd0cd3a17d1059bbda92ae226fdd5aba/tutorials/Getting_Started/screen4.png)
![Create new project 3](/github/compose-jb/media/commit/62a657b6cd0cd3a17d1059bbda92ae226fdd5aba/tutorials/Getting_Started/screen5.png)
IDE plugin
Compose Multiplatform IDEA plugin
can simplify compose development by adding support for @Preview
annotation on argument-less
@Composable
functions. One could see how particular composable function looks like
directly in IDE panel. This plugin could also be discovered via plugins marketplace,
just search for "Compose Multiplatform".
Update the wizard plugin
The Compose plugin version used in the wizard above may be not the last. Update the version of the plugin to the latest available by editing the build.gradle.kts
file, finding and updating the version information as shown below. For the latest versions, see the latest versions site and the Kotlin site.
plugins {
kotlin("jvm") version "1.6.10"
id("org.jetbrains.compose") version "1.1.0"
}
Create new Compose project without the wizard
It is also possible to create Compose project manually.
The recommended way of building Compose for Desktop projects is by using Gradle. JetBrains provides a simple way of building Compose for Desktop projects using a special Gradle plugin.
One could clone an existing template for a desktop or multiplatform application, or create it from scratch.
First create a new directory, named sample
.
mkdir sample
cd sample
Create settings.gradle.kts
as follows:
pluginManagement {
repositories {
gradlePluginPortal()
maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
}
}
Then create build.gradle.kts
with the following content:
import org.jetbrains.compose.compose
plugins {
kotlin("jvm") version "1.6.10"
id("org.jetbrains.compose") version "1.1.0"
}
repositories {
mavenCentral()
maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
google()
}
dependencies {
implementation(compose.desktop.currentOs)
}
compose.desktop {
application {
mainClass = "MainKt"
}
}
Then create src/main/kotlin/main.kt
and put the following code in there:
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.material.Button
import androidx.compose.material.MaterialTheme
import androidx.compose.material.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import androidx.compose.ui.window.Window
import androidx.compose.ui.window.application
import androidx.compose.ui.window.rememberWindowState
fun main() = application {
Window(
onCloseRequest = ::exitApplication,
title = "Compose for Desktop",
state = rememberWindowState(width = 300.dp, height = 300.dp)
) {
val count = remember { mutableStateOf(0) }
MaterialTheme {
Column(Modifier.fillMaxSize(), Arrangement.spacedBy(5.dp)) {
Button(modifier = Modifier.align(Alignment.CenterHorizontally),
onClick = {
count.value++
}) {
Text(if (count.value == 0) "Hello World" else "Clicked ${count.value}!")
}
Button(modifier = Modifier.align(Alignment.CenterHorizontally),
onClick = {
count.value = 0
}) {
Text("Reset")
}
}
}
}
}
Running the project
Open build.gradle.kts
as a project in IntelliJ IDEA.
![New project](/github/compose-jb/media/commit/62a657b6cd0cd3a17d1059bbda92ae226fdd5aba/tutorials/Getting_Started/screen1.png)
After you download the Compose for Desktop dependencies from the Maven repositories your new project is ready
to go. Open the Gradle toolbar on the right, and select sample/Tasks/compose desktop/run
.
The first run may take some time, but afterwards the following dialog will be shown:
![Application running](/github/compose-jb/media/commit/62a657b6cd0cd3a17d1059bbda92ae226fdd5aba/tutorials/Getting_Started/screen2.gif)
You can click on the button several times and see that the application reacts and updates the UI.
Running and debugging the main()
function using run gutter is also supported.
![Application running](/github/compose-jb/media/commit/62a657b6cd0cd3a17d1059bbda92ae226fdd5aba/tutorials/Getting_Started/screen6.png)