README.md

Material-UI-Swing

Description

A modern, Material Design UI for Java Swing

Overview

• Introduction
• Component Supported
• Material Theming
• Develop a new Theme
• Screenshots
• How Contribute
• Built with
• Community
• License

Repository

Maven

<dependency>
 <groupId>io.github.vincenzopalazzo</groupId>
 <artifactId>material-ui-swing</artifactId>
 <version>1.1.2</version>
</dependency>

Gradle (Groovy)

implementation 'io.github.vincenzopalazzo:material-ui-swing:1.1.2'

Gradle (Kotlin DSL)

implementation("io.github.vincenzopalazzo:material-ui-swing:1.1.2")

Others version here

Snapshot version

Each master version has a SNAPSHOT version that is the official version x.x.x + 1, so for example for the version v1.1.2-rc1 the version on if exist a new version of the master branch is v1.1.2-rc2-SNAPSHOT

An example of gradle configuration is reported below

Gradle (Kotlin DSL)

configurations.all {
    resolutionStrategy.cacheDynamicVersionsFor(0, "seconds")
    resolutionStrategy.cacheChangingModulesFor(0, "seconds")
}

repositories {
    ... other suff
    maven("https://oss.sonatype.org/content/repositories/snapshots")
}

dependencies {
    ... other stuff
    implementation("io.github.vincenzopalazzo:material-ui-swing:1.1.3-rc1-SNAPSHOT")
}

Excluding Swingx

While swingx is a transitive dependency for Material-UI-Swing, it is not strictly required for it to work. Projects that wish to exclude it can use dependency exclusion on Maven or Gradle.

Code Style

We live in a world where robots can drive a car, so we shouldn't just write code, we should write elegant code.

This repository use google-java-format to maintains the code of the repository elegant, so before submit the code check the Java format with the following command on the root of the directory

./gradlew verifyGoogleJavaFormat

If any error are reported please run the following command to fix them

./gradlew googleJavaFormat

P.S.: The gradle plugin works with all the JDK versions >= 9 (or better with java byte code version compatible with the version 55.0)

For more details about the JDK support see this issue and to know more about the Google Java code Style see this reference

Build with Material-UI-Swing

List of projects with Material-UI-Swing theme

• Krayon for SBGN
• JMars 5: Used by NASA and United Arab Emirates (UAE) for the last Mars missions.

Contact us if you use this look and feel, so we can add your project to the list 🙂

Donors

• lilili87222
• Arizona State University
• zanderson9

You can support the project on the Material-UI-Swing donation site

Supporters

JetBrains' support

The YourKit is used also by Google, Microsoft, PayPal, ecc.

• YourKit: it supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

License

Copyright (c) 2018 atharva washimkar.

Copyright (c) 2019-2020 atharva washimkar, Vincenzo Palazzo [email protected]

Copyright (c) 2021 Vincenzo Palazzo [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.