Darklaf - A themeable swing Look and Feel based on Darcula-Laf
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
weisj 5a7bd22a79 Removed overriding of shared dummy ui. 5 years ago
.github Font test (#170) 5 years ago
buildSrc Rename MacOSSdkPathTask.gradle.kt to MacOSSdkPathTask.kt 5 years ago
core Removed overriding of shared dummy ui. 5 years ago
dependencies-bom Add MigLayout for test code 5 years ago
gradle/wrapper Automatically insert suppression for unused properties. 5 years ago
img Updated preview images. 5 years ago
licenses Split projects, migrate to Kotlin DSL 5 years ago
macos Fixed log formatting for library loggers. 5 years ago
native-utils Fixed log formatting for library loggers. 5 years ago
platform-base Fixed popups not having a shadow [windows]. 5 years ago
property-loader Fixed font size for auto created ui tables. 5 years ago
theme Fixed question icon color for light icons. 5 years ago
utils Use SystemInfo.undefinedArchitecture. 5 years ago
windows Use SystemInfo.undefinedArchitecture. 5 years ago
.editorconfig Formatting rules for eclipse formatter. 5 years ago
.gitattributes Add .gitattributes to ensure files have expected line endings 5 years ago
.gitignore Add eclipse settings and project files to gitignore 5 years ago
LICENSE moved and updates license 5 years ago
README.md Updated README. 5 years ago
build.gradle.kts Automatically insert suppression for unused properties. 5 years ago
change_notes.md Removed lambda parameter from PaintUtil.drawString in favour of an additional PaintUtil.drawStringUnderlineCharAt method to reduce painting overhead. 5 years ago
darklaf_cpp.eclipseformat.xml Updated formatting for c++. 5 years ago
darklaf_java.eclipseformat.xml Updated formatting rules. 5 years ago
gradle.properties new rc. 5 years ago
gradlew Split projects, migrate to Kotlin DSL 5 years ago
gradlew.bat Upgrade Gradle: 6.1.1 -> 6.3 5 years ago
settings.gradle.kts Autostyle setup and initial formatting. 5 years ago

README.md

Darklaf - A themeable swing Look and Feel

CI Status Native Libraries Autostyle Maven Central

This project is based on the darcula look and feel for Swing.

Screenshots

IntelliJ Darcula
Solarized Light Solarized Dark
High Contrast Light High Contrast Dark

Usage & Features

A list of all features can be found here. The LaF is compatible with Java >=1.8 (you need >=1.9 to get proper scaling).

You can find all property values on weisj.github.io/darklaf-docs

This project is available on Maven Central:

Maven

<dependency>
  <groupId>com.github.weisj</groupId>
  <artifactId>darklaf-core</artifactId>
  <version>[2.1.1,)</version>
</dependency>
<dependency>
  <!-- For the themes-->
  <groupId>com.github.weisj</groupId>
  <artifactId>darklaf-theme</artifactId>
  <version>[2.1.1,)</version>
</dependency>

Gradle

implementation("com.github.weisj:darklaf-core:[2.1.1,)")
implementation("com.github.weisj:darklaf-theme:[2.1.1,)") // For the themes

Installation

The LookAndFeel can be easily installed using the LafManager

LafManager.install(); // For default theme (IntelliJ)

or

LafManager.install(new DarculaTheme()); // Specify the used theme.

or by using the UIManager

LafManager.setTheme(new DarculaTheme());
UIManager.setLookAndFeel(DarkLaf.class.getCanonicalName());

Note: The recommended method is using the LafManager as it automatically handles reloading the ui.

Choosing a theme

It is highly encouraged to provide users more than one theme. Forcing users to use a light/dark theme because of personal preferences might be degrading their experience in certain situations. For the visually impaired darklaf provides a set of high contrast themes, HighContrastThemeLight and HighContrastThemeDark.

Darklaf supports detecting the system theme on macOS and Windows with the ability to automatically change the theme if the settings change.

// This returns the preferred theme of the system settings.
LafManager.themeForPreferredStyle(getPreferredThemeStyle());

The following settings are picked up by darklaf:

Windows macOS Setting
Light/Dark mode
High contrast mode
Accent color
Selection color
Font size

You can use the ThemeSettings class with ThemeSettings#showSettingsDialog or ThemeSettings#getSettingsPanel to provide the user the most possible customization.

Example

import com.github.weisj.darklaf.LafManager;
import javax.swing.*;
import java.awt.*;

public class DarklafDemo {

    public static void main(final String[] args) {
         SwingUtilities.invokeLater(() -> {
            LafManager.install();

            JFrame frame = new JFrame("Darklaf - A themeable LaF for Swing");
            frame.setSize(600, 400);

            JButton button = new JButton("Click here!");

            JPanel content = new JPanel();
            content.add(button);

            frame.setLocationRelativeTo(null);
            frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
            frame.setContentPane(content);
            frame.setVisible(true);
        });
    }
}

All custom component-variants and settings can be enabled by setting the appropriate client property of the component. They can be found here.

This LookAndFeel supports custom window decorations (only on Windows at this point). In contrast to most other LaFs the native window behaviour is not compromised giving a seamless experience that still looks native.

Build

./gradlew build

When building on Windows, you need a C++ toolchain installed to build native extension.

When building on macOS you need to have XCode (or the command line tools) installed to build the native extension.

If you want to build for platforms different from your machine you can download the respective native libraries from the latest successful run of the Build Native Libraries Action and place it in the corresponding <variant>/libraries folder. Further details can be found in the respective library.md file. The libraries are then automatically included in the jar when building the project. When building the project there will be a message for every library that needs to be manually included.

Note: You can still build the project without the libraries, but then custom decorations won't be supported.

Contribute

Here is a list of things that currently are not finished or need refinement. This list is a work in progress and being updated regulary. If you find any problems with the LaF feel free to submit an issue:

Artifacts

  • Group ID: com.github.weisj
  • Version: 2.1.1
  • Artifact IDs:
    • darklaf-core The LaF itself. Include this in your project to use the LaF. Includes all other artifacts.
    • darklaf-theme The themes to use with the LaF.
    • darklaf-property-loader Library to load and parse property files and icon.
    • darklaf-utils Shared utility classes for other modules.
    • darklaf-native-utils Loading of native libraries.
    • darklaf-platform-base Common classes for the platform modules.
    • darklaf-windows Code specific to Windows.
    • darklaf-macos Code specific to macOS.

Projects using Darklaf

Please send me your project and I'll add it here.

License

This project is licensed under the MIT license.