JavaFX Gradle Plugin

Simplifies working with JavaFX 11+ for gradle projects.

Getting started

To use the plugin, apply the following two steps:

1. Apply the plugin

Using the plugins DSL:

Groovy

plugins {
    id 'org.openjfx.javafxplugin' version '0.0.13'
}

Kotlin

plugins {
    id("org.openjfx.javafxplugin") version "0.0.13"
}

Alternatively, you can use the buildscript DSL:

Groovy

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath 'org.openjfx:javafx-plugin:0.0.13'
    }
}
apply plugin: 'org.openjfx.javafxplugin'

Kotlin

buildscript {
    repositories {
        maven {
            setUrl("https://plugins.gradle.org/m2/")
        }
    }
    dependencies {
        classpath("org.openjfx:javafx-plugin:0.0.13")
    }
}
apply(plugin = "org.openjfx.javafxplugin")

2. Specify JavaFX modules

Specify all the JavaFX modules that your project uses:

Groovy

javafx {
    modules = [ 'javafx.controls', 'javafx.fxml' ]
}

Kotlin

javafx {
    modules("javafx.controls", "javafx.fxml")
}

3. Specify JavaFX version

To override the default JavaFX version, a version string can be declared. This will make sure that all the modules belong to this specific version:

Groovy

javafx {
    version = '17'
    modules = [ 'javafx.controls', 'javafx.fxml' ]
}

Kotlin

javafx {
    version = "17"
    modules("javafx.controls", "javafx.fxml")
}

4. Cross-platform projects and libraries

The plugin will include JavaFX dependencies for the current platform. However, a different target platform can also be specified.

Supported targets are:

• linux
• linux-aarch64
• win or windows
• osx or mac or macos
• osx-aarch64 or mac-aarch64 or macos-aarch64 (support added in JavaFX 11.0.12 LTS and JavaFX 17 GA)

Groovy

javafx {
    modules = [ 'javafx.controls', 'javafx.fxml' ]
    platform = 'mac'
}

Kotlin

javafx {
    modules("javafx.controls", "javafx.fxml")
    platform = 'mac'
}

5. Dependency scope

JavaFX application require native binaries for each platform to run. By default, the plugin will include these binaries for the target platform. Native dependencies can be avoided by declaring the dependency configuration as compileOnly.

Groovy

javafx {
    modules = [ 'javafx.controls', 'javafx.fxml' ] 
    configuration = 'compileOnly'
}

Kotlin

javafx {
    modules("javafx.controls", "javafx.fxml")
    configuration = "compileOnly"
}

Multiple configurations can also be targeted by using configurations. For example, JavaFX dependencies can be added to both implementation and testImplementation.

Groovy

javafx {
    modules = [ 'javafx.controls', 'javafx.fxml' ]
    configurations = [ 'implementation', 'testImplementation' ]
}

Kotlin

javafx {
    modules("javafx.controls", "javafx.fxml")
    configurations("implementation", "testImplementation")
}

5. Using a local JavaFX SDK

By default, JavaFX modules are retrieved from Maven Central. However, a local JavaFX SDK can be used instead, for instance in the case of a custom build of OpenJFX.

Setting a valid path to the local JavaFX SDK will take precedence:

Groovy

javafx {
    sdk = '/path/to/javafx-sdk'
    modules = [ 'javafx.controls', 'javafx.fxml' ]
}

Kotlin

javafx {
    sdk = "/path/to/javafx-sdk"
    modules("javafx.controls", "javafx.fxml")
}

Issues and Contributions

Issues can be reported to the Issue tracker.

Contributions can be submitted via Pull requests, providing you have signed the Gluon Individual Contributor License Agreement (CLA).