UI Toolkit Router

Router for Unity UI Toolkit.

Work in progress

For now the development is focused on current project needs but open for feedback. Package is targeting UITK for runtime but should probably work for editor extensions as well.

Features

• named routes
• nested routing
• navigation guards

Vue Router Inspiration

The implementation is heavily inspired by vue.js router and trying to mimic the functionality documented in the guide.

Not all vue router features are as important for UI Toolkit use cases as they are for the web. So for everybody coming from vue.js here are some differences:

• obviously c# and not js and all the good and bad which comes with it
• only the vue router, not the framework, so no $watch for example
• only named routes, no path routing
• no integrated transitions
• no <router link> support (yet)
• not all nav guard types

Todo / Ideas

• global router access (planned)
• more per component nav guards (planned)
• reusing loaded components (planned)
• generic router for extensibility (idea)
• Route meta object (idea)
• global router.watch (idea)
• alternative to string params (idea)
• named views (idea)
• navigation failure (idea)
• configure routes via ScriptableObject (idea)
• more guard types like beforeResolve or per route (low prio)
• async exception handling (issue)