Milchreis / UiBooster

🚀 Creates fast and easy dialogs for utility tools
GNU General Public License v3.0
117 stars 12 forks source link
cli confirmation-dialog dark-theme dialog easy-dialogs fast form gui java login login-dialog progress-dialog selection-dialog swing table table-dialog ui utility

Release GitHub Snyk Known Vulnerabilities Ko-Fi

UiBooster is a lean library to create fast and easy dialogs for utility tools. It equips your applications blazing fast with GUI components to increase the comfort for your users.

It's based on Java swing components to run on current JREs without any struggle. This library encapsulates the long and sometimes complicated GUI code and leaves more clarity in your project.

I decided to create this project, because I missed something like zenity for my Java applications.

If you like this project, and you want to keep me awake ðŸĪŠ, please:

Buy Me a Coffee at ko-fi.com

Components

Information dialogs

screenshot info dialog screenshot warn dialog screenshot error dialog

new UiBooster().showInfoDialog("UiBooster is a lean library to ....");
new UiBooster().showWarningDialog("Your computer has a low battery ....", "WARN");
new UiBooster().showErrorDialog("The connection to SQL database is failed.", "ERROR");

Text input dialog

screenshot input dialog

String opinion = new UiBooster().showTextInputDialog("What do you think?");

Confirmation dialog

screenshot confirm dialog

new UiBooster().showConfirmDialog(
                "Do you really want this action?",
                "Are you sure?",
                () -> System.out.println("Action accepted"),
                () -> System.out.println("Action declined"));

Password input dialog

screenshot password dialog

String password = booster.showPasswordDialog("Whats your password?", "Password");

Selection dialog

screenshot selection dialog

String selection = new UiBooster().showSelectionDialog(
        "What's your favorite movie?",
        "Favorite Movie?",
        Arrays.asList("Pulp Fiction", "Bambi", "The Godfather", "Hangover"));

Multiple selection dialog

screenshot multiple selection dialog

 List<String> selectedElement = new UiBooster().showMultipleSelection(
            "What are your favorite hobbies?",
            "Your hobbies",
            "Reading", "Traveling", "Fishing", "Music", "Gardening", "Sport", "Television",
            "Video Games", "Crafting", "Bird Watching", "Collecting");

Slider dialog

screenshot slider dialog

Integer numberOfHotDogs = new UiBooster().showSlider("How many HotDogs do you want?", "Your order", 
                0, 10, 2, 5, 1);

Colorpicker

screenshot color dialog

Color selectedColor = new UiBooster().showColorPicker("Choose your favorite color", "Color picking");

library by @dheid: colorpicker

Font Chooser

screenshot font dialog

Font selectedFont = new UiBooster().showFontChooser("Choose your favorite font", "Font choosing");

library by @dheid: fontchooser

Datepicker

screenshot datepicker

Date birthday = new UiBooster().showDatePicker("What's your birthday?", "Birthday");

File and directory selection dialogs

screenshot file dialog

UiBooster booster = new UiBooster();
File file = booster.showFileSelection();
File directory = booster.showDirectorySelection();
File fileOrDirectory = booster.showFileOrDirectorySelection();

Text area dialog

screenshot text area dialog

new UiBooster().showTextArea("Want to read some lorem ipsum?", "Message for you",
    "Lorem ipsum dolor sit amet ...",
    10, 40, false);
);

HTML text dialog

screenshot html text dialog

new UiBooster().showHtmlText("My menu", "Menu overview",
    "<h1>📜 Menu</h1>" +
    "<ul>" +
    "<li>🍕 Pizza </li>" +
    "<li>🍔 Cheeseburger</li>" +
    "<li>ðŸĨ— Caesar-Salat</li>" +
    "</ul>");

Exception dialog

screenshot exception dialog

new UiBooster().showException(
    "An error occurred", 
    "Exception message",
    new Exception("Something went wrong ...")
);

List dialog

screenshot list dialog

ListElement selectedElement = new UiBooster().showList(
    "Select a robot", 
    "Avatars from RoboHash.org",
    element -> System.out.println("Selected: " + element.toString()),
    new ListElement("Robo 1", "Green and strong",         "src/test/resources/avatar1.png"),
    new ListElement("Robo 2", "Shy without an avatar!"),
    new ListElement("Robo 3", "- Crazy\n- Fast\n- Funny", "src/test/resources/avatar2.png"),
    new ListElement("Robo 4", null,                       "src/test/resources/avatar3.png")
);

Login dialog

screenshot login dialog

LoginCredentials credentials = new UiBooster().showLogin(
        "Login",
        "Internal area",
        "Username",
        "Password",
        "Go",
        "Cancel");

Waiting dialog

screenshot waiting dialog

WaitingDialog dialog = new UiBooster().showWaitingDialog("Starting", "Please wait");
dialog.setMessage("Ready");
dialog.close();

screenshot waiting with message dialog

WaitingDialog dialog = new UiBooster().showWaitingDialog("Starting", "Please wait");
dialog.setMessage("Initializing");
dialog.setLargeMessage("Some more information...\nMaybe from log files or other resources. \nBe transparent to the user to understand long processes...");
dialog.close();

Progress dialog

screenshot progress dialog

ProgressDialog dialog = new UiBooster().showProgressDialog("Please wait", "Waiting", 0, 120);
dialog.setProgress(10);
// ...
dialog.setProgress(120);
dialog.setMessage("Ready");
dialog.close();

Table dialog

screenshot table dialog

String[][] modifiedData = new UiBooster().showTable(    // showTableImmutable for immutable tables
        new String[][]{
                {"Jimmy Johnson", "35", "Zombieland"},
                {"Danny Durango", "23", "Hangover"},
                {"Larry Berry", "54", ""}
        },
        Arrays.asList("Name", "Age", "Favorite movie"),
        "Favorite movies");

Gallery dialog

screenshot gallery dialog

new UiBooster().showPictures(
        "My picture",
        Arrays.asList(
            new File("/home/nick/pictures/img-01.jpg"),
            new File("/home/nick/pictures/img-02.jpg")
        )
);

Form dialog

screenshot gallery dialog

UiBooster booster = new UiBooster();
Form form = booster.createForm("Personal information")
            .addText("Whats your first name?")
            .addTextArea("Tell me something about you")
            .addSelection(
                    "Whats your favorite movie?",
                    Arrays.asList("Pulp Fiction", "Bambi", "The Godfather", "Hangover"))
            .addLabel("Choose an action")
            .addButton("half full", () -> booster.showInfoDialog("Optimist"))
            .addButton("half empty", () -> booster.showInfoDialog("Pessimist"))
            .addSlider("How many liters did you drink today?", 0, 5, 1, 5, 1)
            .show();

// use .run() instead of show() to open the formBuilder without blocking.

The form is very powerful and provides a lot of features:

Splash screen

screenshot splash screen

Splashscreen splash = new UiBooster().showSplashscreen("/path/to/your/splash.png");
// do your stuff
splash.hide();

System tray

screenshot gallery dialog

UiBooster booster = new UiBooster();
booster.createTrayMenu("Food", "screenshots/color.jpg")
        .withPopupMenu()
        .addMenu("Hotdogs", () -> booster.showInfoDialog("Sausage in a roll"))
        .addMenu("Fries", () -> booster.showInfoDialog("Fried potatoes"))
        .addMenu("Pizza", () -> booster.showInfoDialog("Dough with tomato sauce"));

Notification

screenshot gallery dialog

new UiBooster().createNotification("It's hot and delicious", "Dinner is ready");

Options

UiBooster booster = new UiBooster(
    UiBoosterOptions.Theme.DARK_THEME,
    "/path/to/your/custom-window-icon.png"
);

See some examples for UiBoosterOptions here

More themes powered by flatlaf

  1. Add themes as maven dependency

    <dependency>
    <groupId>com.formdev</groupId>
    <artifactId>flatlaf-intellij-themes</artifactId>
    <version>3.2.1</version>
    </dependency>
  2. Create a new UiBooster with theme as UiBoosterOption

    UiBooster booster = new UiBooster(new UiBoosterOptions(new com.formdev.flatlaf.intellijthemes.materialthemeuilite.FlatMaterialOceanicIJTheme(), null, null));
    booster.showInfoDialog("Info Message Empty Constructor");

screenshot custom theme

List with beautiful themes

Include to project

Maven

If you want to use UiBooster than add the following to your pom.xml.

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>
<dependency>
    <groupId>com.github.milchreis</groupId>
  <artifactId>uibooster</artifactId>
  <version>1.21.1</version>
</dependency>

Gradle

If you want to use UiBooster with gradle than add the repo, and the dependency to your root build.gradle file.

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
dependencies {
        implementation 'com.github.milchreis:uibooster:1.21.1'
}