Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dansoftowner/jsystemthemedetector
Java library for detecting that the (desktop) operating system uses dark UI theme or not
https://github.com/dansoftowner/jsystemthemedetector
desktop java java-library java-native-access javafx jfa jna linux macos macosx native-library swing windows
Last synced: 1 day ago
JSON representation
Java library for detecting that the (desktop) operating system uses dark UI theme or not
- Host: GitHub
- URL: https://github.com/dansoftowner/jsystemthemedetector
- Owner: Dansoftowner
- License: apache-2.0
- Created: 2020-10-31T18:36:50.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T07:29:53.000Z (2 months ago)
- Last Synced: 2025-01-01T15:03:47.412Z (1 day ago)
- Topics: desktop, java, java-library, java-native-access, javafx, jfa, jna, linux, macos, macosx, native-library, swing, windows
- Language: Java
- Homepage:
- Size: 489 KB
- Stars: 200
- Watchers: 5
- Forks: 24
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jSystemThemeDetector
[](https://jitpack.io/#Dansoftowner/jSystemThemeDetector)
[](https://github.com/Dansoftowner/jSystemThemeDetector/commits/master)
[](https://github.com/Dansoftowner/jSystemThemeDetector/issues)
[](LICENSE)
In most modern operating systems there is a dark mode option. This library is created for detecting
this using java.
It can be useful for example if you want to synchronize your GUI App's look and feel with the operating system.
> This library is inspired by the dark-theme detection in [Intellij Idea](https://github.com/JetBrains/intellij-community).
# Compatibility
It works on **Windows 10**, **MacOS Mojave** (or later) and even on **some Linux distributions**.
# Requirements
**Java 11 or higher**
# Basic examples
#### Simple detection
```java
final OsThemeDetector detector = OsThemeDetector.getDetector();
final boolean isDarkThemeUsed = detector.isDark();
if (isDarkThemeUsed) {
//The OS uses a dark theme
} else {
//The OS uses a light theme
}
```
#### Listening to changes
```java
final OsThemeDetector detector = OsThemeDetector.getDetector();
detector.registerListener(isDark -> {
if (isDark) {
//The OS switched to a dark theme
} else {
//The OS switched to a light theme
}
});
```
#### Using it with JavaFX/Swing
If you use the listener for changing the UI in a **JavaFX** application, make sure you use `Platform.runLater` in it:
```java
final OsThemeDetector detector = OsThemeDetector.getDetector();
detector.registerListener(isDark -> {
Platform.runLater(() -> {
if (isDark) {
// The OS switched to a dark theme
} else {
// The OS switched to a light theme
}
});
});
```
It's important because if you are doing JavaFX specific stuff in the listener, you should execute it on the UI thread (`JavaFX Application Thread`).
Otherwise, you might face some serious issues.
In case of **AWT/Swing**, use `SwingUtilities.invokeLater` for the same reason:
```java
final OsThemeDetector detector = OsThemeDetector.getDetector();
detector.registerListener(isDark -> {
SwingUtilities.invokeLater(() -> {
if (isDark) {
// The OS switched to a dark theme
} else {
// The OS switched to a light theme
}
});
});
```
# Using it with Gradle, Maven... etc
It's available on [JitPack](https://jitpack.io/#Dansoftowner/jSystemThemeDetector)!
Gradle example:
```groovy
repositories {
...
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.Dansoftowner:jSystemThemeDetector:3.6'
}
```
# GUI Demo application
There is a Demo application available [here](src/test/java/GuiDemo.java). It's
a basic JavaFX application that changes the UI when the OS switched to a dark/light theme.
### Linux/Ubuntu example
### Windows 10 example
# Projects using `jSystemThemeDetector`
* [Boomega](https://github.com/Dansoftowner/Boomega) - A modern book explorer & catalog application
* [Document Archiver](https://github.com/Document-Archiver/com.sophisticatedapps.archiving.document-archiver) - Archive all your documents in a consistent way, which enables you to retrieve them later fast and easy.
* [pearletj](https://github.com/eth3-peth/pearletj) - Cross-platform multi-chain thick wallet for Cryto-currencies
If this library is used by your project, feel free to create a PR and mention that in this section!
# Used libraries
- [SLF4J](http://www.slf4j.org/) - Simple Logging Facade for Java
- [Jetbrains Annotations](https://github.com/JetBrains/java-annotations) - Annotations for JVM-based languages
- [JNA](https://github.com/java-native-access/jna) - Java Native Access
- [JFA](https://github.com/0x4a616e/jfa) - Java Foundation Access
- [OSHI](https://github.com/oshi/oshi) - Operating system & hardware information
- [Version Compare](https://github.com/G00fY2/version-compare) - Lightweight Android & Java library to compare version strings.