Documentation

Introduction
Installation

Configuring Gradle Project

This page describes how to add JxBrowser to a Gradle project.

Repository

JxBrowser is distributed via the repository hosted by TeamDev. Please add the following repository reference to your build.gradle:

repositories {
    // The repository for JxBrowser binaries.
    maven { url = 'https://europe-maven.pkg.dev/jxbrowser/releases' }
}

repositories {
    // The repository for JxBrowser binaries.
    maven("https://europe-maven.pkg.dev/jxbrowser/releases")
}

The link to the https://europe-maven.pkg.dev/jxbrowser/releases Maven repository is not accessible in a web browser as it’s hosted on Google Cloud’s Artifact Registry.

The Maven repository for releases is available in US region at https://us-maven.pkg.dev/jxbrowser/releases.

Version Variable

We recommend to define a variable for the version of JxBrowser used in the project. The following sections reference such a variable.

ext {
    jxBrowserVersion = '7.32'
}

val jxBrowserVersion by extra { "7.32" }

However, it is not required, and you can have the version referenced in-place because most likely you are going to have only one dependency.

Dependencies

Cross-Platform

To add JxBrowser library that works on Windows, macOS, and Linux, please add the following code:

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-cross-platform:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-cross-platform:$jxBrowserVersion")
}

Platform-Specific

If you need JxBrowser JAR files only for a specific platform, you can use the appropriate dependency as described below.

If your Java application runs only on Windows and macOS platforms, and you do not need Linux dependency, you can include only Windows and macOS dependencies.

Windows 32-bit

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-win32:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-win32:$jxBrowserVersion")
}

Windows 64-bit

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-win64:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-win64:$jxBrowserVersion")
}

macOS 64-bit

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-mac:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-mac:$jxBrowserVersion")
}

macOS 64-bit ARM

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-mac-arm:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-mac-arm:$jxBrowserVersion")
}

Linux 64-bit

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-linux64:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-linux64:$jxBrowserVersion")
}

Linux 64-bit ARM

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-linux64-arm:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-linux64-arm:$jxBrowserVersion")
}

GUI Toolkit

Swing

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-swing:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-swing:$jxBrowserVersion")
}

JavaFX

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-javafx:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-javafx:$jxBrowserVersion")
}

SWT

dependencies {
    implementation "com.teamdev.jxbrowser:jxbrowser-swt:${jxBrowserVersion}"
}

dependencies {
    implementation("com.teamdev.jxbrowser:jxbrowser-swt:$jxBrowserVersion")
}

Summary

Here is the complete code of build.gradle:

buildscript {
    repositories {
        mavenCentral() // or other repositories that your project use.
    }
}

ext {
    jxBrowserVersion = '7.32'
}

subprojects {
    apply plugin: 'java'

    sourceCompatibility = 1.8
    targetCompatibility = 1.8

    repositories {
        // The repository for JxBrowser and other TeamDev products.
        maven { url = 'https://europe-maven.pkg.dev/jxbrowser/releases' }
    }

    dependencies {
        // Cross-platform
        implementation "com.teamdev.jxbrowser:jxbrowser-cross-platform:${jxBrowserVersion}"

        // Swing GUI toolkit
        implementation "com.teamdev.jxbrowser:jxbrowser-swing:${jxBrowserVersion}"

        // JavaFX GUI toolkit
        // implementation "com.teamdev.jxbrowser:jxbrowser-javafx:${jxBrowserVersion}"

        // SWT GUI toolkit
        // implementation "com.teamdev.jxbrowser:jxbrowser-swt:${jxBrowserVersion}"

        // Windows 32-bit
        // implementation "com.teamdev.jxbrowser:jxbrowser-win32:${jxBrowserVersion}"

        // Windows 64-bit
        // implementation "com.teamdev.jxbrowser:jxbrowser-win64:${jxBrowserVersion}"

        // macOS 64-bit
        // implementation "com.teamdev.jxbrowser:jxbrowser-mac:${jxBrowserVersion}"

        // macOS 64-bit ARM
        // implementation "com.teamdev.jxbrowser:jxbrowser-mac-arm:${jxBrowserVersion}"

        // Linux 64-bit
        // implementation "com.teamdev.jxbrowser:jxbrowser-linux64:${jxBrowserVersion}"

        // Linux 64-bit ARM
        // implementation "com.teamdev.jxbrowser:jxbrowser-linux64-arm:${jxBrowserVersion}"
    }
}

buildscript {
    repositories {
        mavenCentral() // or other repositories that your project use.
    }
}

val jxBrowserVersion by extra { "7.32" }

subprojects {
    apply(plugin = "java")

    java.sourceCompatibility = JavaVersion.VERSION_1_8
    java.targetCompatibility = JavaVersion.VERSION_1_8

    repositories {
        // The repository for JxBrowser and other TeamDev products.
        maven("https://europe-maven.pkg.dev/jxbrowser/releases")
    }

    dependencies {
        // Cross-platform
        implementation("com.teamdev.jxbrowser:jxbrowser-cross-platform:$jxBrowserVersion")

        // Swing GUI toolkit
        implementation("com.teamdev.jxbrowser:jxbrowser-swing:$jxBrowserVersion")

        // JavaFX GUI toolkit
        // implementation("com.teamdev.jxbrowser:jxbrowser-javafx:$jxBrowserVersion")

        // SWT GUI toolkit
        // implementation("com.teamdev.jxbrowser:jxbrowser-swt:$jxBrowserVersion")

        // Windows 32-bit
        // implementation("com.teamdev.jxbrowser:jxbrowser-win32:$jxBrowserVersion")

        // Windows 64-bit
        // implementation("com.teamdev.jxbrowser:jxbrowser-win64:$jxBrowserVersion")

        // macOS 64-bit
        // implementation("com.teamdev.jxbrowser:jxbrowser-mac:$jxBrowserVersion")

        // macOS 64-bit ARM
        // implementation("com.teamdev.jxbrowser:jxbrowser-mac-arm:$jxBrowserVersion")

        // Linux 64-bit
        // implementation("com.teamdev.jxbrowser:jxbrowser-linux64:$jxBrowserVersion")

        // Linux 64-bit ARM
        // implementation("com.teamdev.jxbrowser:jxbrowser-linux64-arm:$jxBrowserVersion")
    }
}
Go Top