@jamilservices/sb-module-router

The @jamilservices/sb-module-router is designed to provide a robust and flexible routing system for web applications built with SimplyBuilder. It integrates seamlessly with the SimplyBuilder environment, allowing developers to manage route changes, state transitions, and navigation events efficiently.

Features

• Dynamic Routing: Easily manage your app's routes with support for sound path matching.

• State Management: Easily obtain the status of your routes and navigations.

• Event Notifications: Receive route change events during navigation activities.

• Simplified API: Offers a simple API for subscribing to events, registering routes, cleaning listeners, and navigating between registered routes with minimal code.

• Module Integrity: The API is frozen to prevent runtime modifications, ensuring the reliability and security of the module.

Documentation

• Installation
• ESM Import Module
• Importing the Module
• Creating/Retrieving the Router Instance
• Subscribe/Unsubscribe to Router Events
• Register/UnRegister/Redirect/Integrate a Route
• Navigate/State Route

Contribution Guidelines

Interested in contributing? We welcome your contributions to enhance the frontend capabilities of @jamilservices/sb-module-router.
Please check our Contribution Guidelines for more details.

License

@jamilservices/sb-module-router is available under the MIT License by @jamilservicos.

• You are free to modify and reuse the code.
• The original license must be included with copies of this software.
• We encourage linking back to this repository if you use a significant portion of the source code.