https://github.com/rahulstech/javafx-routing

Efficiently navigate between JavaFX screens with animated transitions, backstack, controller lifecycle management, argument passing, and validation. Enjoy a declarative configuration approach or customize in code. Simplifies navigation and enhances user experience. Currently supports single scene navigation.
https://github.com/rahulstech/javafx-routing

java javafx navigation routing single-page-nav

Last synced: about 1 month ago
JSON representation

Efficiently navigate between JavaFX screens with animated transitions, backstack, controller lifecycle management, argument passing, and validation. Enjoy a declarative configuration approach or customize in code. Simplifies navigation and enhances user experience. Currently supports single scene navigation.

• Host: GitHub
• URL: https://github.com/rahulstech/javafx-routing
• Owner: rahulstech
• License: mit
• Created: 2024-08-19T15:35:53.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-09-28T03:51:06.000Z (about 2 months ago)
• Last Synced: 2024-09-29T03:20:44.654Z (about 2 months ago)
• Topics: java, javafx, navigation, routing, single-page-nav
• Language: Java
• Homepage:
• Size: 629 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## JavaFx Routing: Elegant Navigation for JavaFX Applications

[![Javadocs](https://img.shields.io/badge/javadoc-2.0.0-brightgreen.svg)](https://jitpack.io/com/github/rahulstech/javafx-routing/2.0.0/javadoc/)

[![](https://jitpack.io/v/rahulstech/javafx-routing.svg)](https://jitpack.io/#rahulstech/javafx-routing)

[![](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

**javafx-routing** is an open-source library designed to simplify and enhance navigation within your JavaFX applications. It provides a user-friendly and flexible approach to switching between different screens with smooth animations and seamless integration with existing development practices.

**Requirments:**  

Minimum requirements to run `javafx-routing` are

- jdk 11 or later

- openjavafx 11 or later

**Key Features:**

* **Powerful Abstraction:** The library's abstraction layer empowers you to use your own preferred methods and frameworks for specific tasks while seamlessly integrating them into the routing process. This abstraction covers layout controller creation, animation creation, and screen transitions.

* **Destination-Based Design:** Each screen in your application is considered a [`Destination`](./library/src/main/java/rahulstech/jfx/routing/element/Destination.java), providing a clear structure for navigation management.

  `Destination` is the information how the screen will be created rather than actual screen state.

* **Elegant Navigation:** Switch between views with ease using clear routing mechanisms and beautiful animations.

* **Single Scene Navigation:** Manage your application within a single scene, improving memory efficiency and visual flow.

* **Animation Abstraction:** Create custom animations using your preferred library while maintaining a consistent routing experience.

* **Backstack Management:** Keep track of previously visited views for efficient back navigation without losing application state.

* **Lifecycle Events:** Hook into dedicated lifecycle methods (create, initialize, start, hide, destroy) in your controllers.

    - Gain control over processing based on view visibility (foreground/background).

    - Start tasks like video playback when a view becomes visible and pause them when hidden.

    - Handle resource management (e.g., database connections) efficiently during the `destroy` phase.

* **Flexible Layout and Controller Creation:** Leverage the [`RouterExecutor`](./library/src/main/java/rahulstech/jfx/routing/RouterExecutor.java) to define your layouts and controllers in a way that works best for your project.

* **Transaction Mechanism:** The screen transitions are performed by [`Transaction`](./library/src/main/java/rahulstech/jfx/routing/Transaction.java) abstraction layer. Screen with state is called `Target`.

  `Transaction` stores multiple [`Target`](./library/src/main/java/rahulstech/jfx/routing/Transaction.java)s in its own backstack.

* **Flexible Configuration:** Configure routing effortlessly using a routing configuration XML file or Java code which even suits for you.

* **Type-Safe Argument Passing:** [`RouterArgument`](./library/src/main/java/rahulstech/jfx/routing/element/RouterArgument.java) ensures type-safe argument passing and automatic validation before displaying a screen. It raises exceptions for missing or invalid arguments.

  Also pass result to a previous screen while navigating back to a previous screen.

**Getting Started:**

To use `javafx-routing` just add the following two lines in your `build.gradle`. Check _jitpack_ badge above for the latest version.

```groovy

repositories {

  // other repositories

  maven { url 'https://jitpack.io'}

}

dependencies {

  implementation "com.github.rahulstech:javafx-routing:"

}

```

**Benefits:**

* **Improved User Experience:** Provide a more intuitive and visually appealing navigation experience for your users.

* **Simplified Development:** Focus on building your application logic rather than reinventing navigation mechanics.

* **Increased Maintainability:** Create a well-structured and maintainable codebase with clearly defined responsibilities.

* **Better Resource Management:** Optimize resource usage by handling lifecycle events effectively.

**Working Example**

See `javafx-routing` in action! This short animation demonstrates basic navigation using the library:

![running example of basic demo](./running-example.gif)

**More Examples:**

Explore the various functionalities of `javafx-routing` through these detailed examples:

1. [Basic Demo](./samples/basic-demo/ReadMe.md)

2. [Advance Demo](./samples/single-scene-demo/ReadMe.md)

3. [Nested Router Demo](./samples/nested-router-demo/ReadMe.md)

4. [History Demo](./samples/history-demo/ReadMe.md)

5. [Navigation UI Demo](/samples/backstackcallback-demo/ReadMe.md)

**Change Log:**  

Track the changes and features added in each version [here](CHANGELOG.md)

**Contributing:**

We welcome contributions to the `javafx-routing` project! Check the contribution [guideline](./CONTRIBUTING.md).

**License:**

This project is licensed under the `MIT` license. See the [LICENSE](LICENSE.txt) file for more information.

**Happy Routing with javafx-routing!**