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.

122 lines
5.4 KiB

5 years ago
# Darklaf - A Darcula Look and Feel
[![CI Status](https://github.com/weisJ/darklaf/workflows/CI/badge.svg?branch=master)](https://github.com/weisJ/darklaf/actions)
5 years ago
[![Build Native Libraries](https://github.com/weisJ/darklaf/workflows/Build%20Native%20Libraries/badge.svg)](https://github.com/weisJ/darklaf/actions?query=workflow%3A%22Build+Native+Libraries%22)
[![Maven Central](https://img.shields.io/maven-central/v/com.github.weisj/darklaf-core?label=Maven%20Central)](https://search.maven.org/artifact/com.github.weisj/darklaf-core)
5 years ago
5 years ago
This project is based on the [darcula](https://github.com/bulenkov/Darcula) look and feel for Swing.
5 years ago
# Screenshots
5 years ago
![Darcula Theme](https://github.com/weisJ/darklaf/blob/master/img/file_chooser_darcula.png) | ![IntelliJ Theme](https://github.com/weisJ/darklaf/blob/master/img/file_chooser_intellij.png)
:-------------------------:|:-------------------------:
Darcula Theme | IntelliJ Theme
![Solarized Dark Theme](https://github.com/weisJ/darklaf/blob/master/img/file_chooser_solarized_dark.png) | ![Solarized Light Theme](https://github.com/weisJ/darklaf/blob/master/img/file_chooser_solarized_light.png)
:-------------------------:|:-------------------------:
5 years ago
Solarized Dark Theme | Solarized Light Theme
5 years ago
5 years ago
# Usage & [Features](https://github.com/weisJ/darklaf/wiki/Features)
A list of all features can be found [here](https://github.com/weisJ/darklaf/wiki/Features).
5 years ago
The LaF is compatible with Java >=1.8 (you need >=1.9 to get proper scaling).
5 years ago
This project is available on Maven Central:
5 years ago
### Maven
5 years ago
````xml
<dependency>
<groupId>com.github.weisj</groupId>
5 years ago
<artifactId>darklaf-core</artifactId>
5 years ago
<version>[1.4.2.0,)</version>
5 years ago
</dependency>
````
5 years ago
### Gradle
5 years ago
````
5 years ago
implementation 'com.github.weisj:darklaf-core:[1.4.2.0,)'
5 years ago
````
5 years ago
## Installation
5 years ago
The LookAndFeel can be easily installed using the 'LafManager'
````java
5 years ago
LafManager.install(); //For default theme (IntelliJ)
LafManager.install(new DarculaTheme()); //Specify the used theme.
5 years ago
````
5 years ago
or by using the UIManager
````java
LafManager.setTheme(new DarculaTheme());
UIManager.setLookAndFeel(DarkLaf.class.getCanonicalName());
````
5 years ago
## Example
````java
5 years ago
import com.github.weisj.darklaf.LafManager;
5 years ago
import javax.swing.*;
import java.awt.*;
public class DarklafDemo {
public static void main(final String[] args) {
5 years ago
SwingUtilities.invokeLater(() -> {
5 years ago
LafManager.install();
5 years ago
5 years ago
JFrame frame = new JFrame("Darklaf - A themeable LaF for Swing");
5 years ago
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);
});
}
}
````
5 years ago
All custom component-variants and settings can be enabled by setting the appropriate client
5 years ago
property of the component.
5 years ago
They can be found [here](https://github.com/weisJ/darklaf/wiki/Features#alternative-visualsbehaviour-for-components).
5 years ago
5 years ago
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.
5 years ago
# Build
./gradlew build
When building on Windows, you need a C++ toolchain installed to build native extension.
If you wan't to build for platforms different than your machine you can download the respective native libraries
from the latest run of the [Build Native Libraries Action](https://github.com/weisJ/darklaf/actions?query=workflow%3A%22Build+Native+Libraries%22) 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.
5 years ago
# 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:
- [Native window decorations on Linux and MacOS.](https://github.com/weisJ/darklaf/issues/2)
* See [/windows](https://github.com/weisJ/darklaf/tree/master/windows) for the windows implementation.
5 years ago
- [Adjustment of platform specific properties](https://github.com/weisJ/darklaf/issues/2)
* See the [properties folder](https://github.com/weisJ/darklaf/tree/master/src/main/resources/com/github/weisj/darklaf/properties) especially the platform folder.
- Create missing demo classes. (See Todo's in test/ui/)
5 years ago
5 years ago
# Artifacts
- Group ID: `com.github.weisj`
5 years ago
- Version: `1.4.2.0`
5 years ago
- Artifact IDs:
- `darklaf-core` The LaF itself. Include this in your project to use the LaF. Includes all other artifacts.
- `darklaf-property-loader` Library to load and parse property files and icon.
- `darklaf-utils` Shared utility classes for other modules.
- `darklaf-decorations-base` Common classes for the decorations modules.
- `darklaf-native-utils` Loading of native libraries.
- `darklaf-windows` Code specific to window decorations on windows.
- `darklaf-macos` Code specific to window decorations on macOS.
5 years ago
5 years ago
# License
This project is licensed under the [MIT license](https://github.com/weisJ/darklaf/blob/master/LICENSE).