Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.65 KB

README.md

File metadata and controls

106 lines (74 loc) · 3.65 KB

Techsenger StagePro

Support the Project!
This project is open-source and free to use, both commercially and non-commercially, which is why we need your help in its development. If you like it, please give it a star ⭐ on GitHub — it helps others discover the project and increases its visibility. You can also contribute, for example, by fixing bugs 🐛 or suggesting improvements 💡, see Contributing. If you can, financial support 💰 is always appreciated, see Support Us. Thank you for your support!

Table of Contents

Overview

Techsenger StagePro is a library that allows you to create custom stages with nearly any configuration, while remaining easy to use. The project also includes a sampler module, featuring key samples to help you get started with the library.

Demo

StagePro Demo

Features

Key features include:

  • Fully customizable title bar configurations.
  • Support for dynamic configuration changes.
  • Ability to place basic buttons on either the left or right side.
  • Two policies for the maximize button.
  • Styling with CSS.
  • Dark mode support.
  • Size effect (disabled by default).
  • Only two events triggered during resizing (start and finish).

Currently, shadow for Stage is not supported, as it seems there is no way to set a shadow around a Stage using JavaFX. It is likely that this can only be achieved using native code.

Requirements

Due to some bugs, use JavaFX versions 16–20, or a version of JavaFX after 24-ea+19 (see JDK-8344372).

Dependencies

This project is available on Maven Central:

<dependency>
    <groupId>com.techsenger.stagepro</groupId>
    <artifactId>stagepro-core</artifactId>
    <version>${stagepro.version}</version>
</dependency>

Usage

To create a standard Stage, use the code below. To explore all features, check out the examples in the sampler.

@Override
public void start(Stage stage) {
    var controller = new StandardStageController(stage, 800, 600);
    var content = new VBox(...);
    controller.setContent(content);
    stage.show();
}

Code Building

To build the library use standard Git and Maven commands:

git clone https://github.com/techsenger/stagepro
cd stagepro
mvn clean install

Running Sampler

To run the sampler execute the following commands in the root of the project:

cd stagepro-sampler
mvn javafx:run

Please note, that debugger settings are in stagepro-sampler/pom.xml file.

License

Techsenger StagePro is licensed under the Apache License, Version 2.0.

Contributing

We welcome all contributions. You can help by reporting bugs, suggesting improvements, or submitting pull requests with fixes and new features. If you have any questions, feel free to reach out — we’ll be happy to assist you.

👉 Support Us

You can support us financially through GitHub Sponsors. Your contribution directly helps us keep our open-source projects active, improve their features, and offer ongoing support. Besides, we offer multiple sponsorship tiers, with different rewards.