@daffodil/external-router
v0.93.0
Published
Platform-agnostic package that connects the Angular router with an external routing service for runtime route resolution. Part of the Daffodil ecommerce framework.
Readme
@daffodil/external-router
@daffodil/external-router extends @angular/router and allows you to render routes defined in external systems like Wordpress, Magento, Contentful, etc, as if you had defined the routes statically in your Angular Routes.
Overview
It's useful when generating user-friendly routes in external applications and resolving them by their user-friendly URI, such as /sweatshirts instead of /category/6 or category/sweatshirts.
Installation
To install @daffodil/external-router, use the following commands in your terminal.
Install with npm:
npm install @daffodil/external-router --saveInstall with yarn:
yarn add @daffodil/external-routerGetting Started
See the usage guide for a step-by-step walkthrough of setting up external routing in your application.
Configuration
Configure the external router behavior with custom options. See the configuration guide for available options.
Drivers
We provide a driver interface along with a few pre-fabricated drivers for you to simply drop into your app and get started with external route resolution.
- Custom Driver - Create your own driver for any external system
- In-Memory Driver - Store routes in memory for development
- Magento Driver - Integration with Magento 2 URL resolution
- Testing Driver - Mock driver for unit testing
Testing
Learn how to test your external router configuration and route guards. See the testing guide for examples and best practices.
