npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@daffodil/external-router

v0.79.0

Published

A platform-agnostic package that connects the @angular/router with an external routing service (e.g. an API), allowing for runtime route resolution.

Downloads

251

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. This is 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.

Table of Contents

Installation

To install @daffodil/external-router, use the following commands in your terminal.

Install with npm:

npm install @daffodil/external-router --save

Install with yarn:

yarn add @daffodil/external-router

Usage

To get started with @daffodil/external-router, follow these steps:

  1. Add provideExternalRouter to the providers of your appConfig or AppModule :
import { ApplicationConfig } from '@angular/core';
...
import { provideExternalRouter } from '@daffodil/external-router';

export const appConfig: ApplicationConfig = {
 providers: [
  provideRouter(routes),
  provideClientHydration(),
  provideExternalRouter(),
 ],
};
  1. Configure your driver of choice (this example uses the testing driver):
import { ApplicationConfig, importProvidersFrom } from '@angular/core';
import { DaffExternalRouterDriverTestingModule } from '@daffodil/external-router/driver/testing';

export const appConfig: ApplicationConfig = {
 providers: [
  provideRouter(routes),
  provideClientHydration(),
  provideExternalRouter(),
  provideDaffExternalRouterTestingDriver({
    'test-page': 'TEST_TYPE',
    'other-page': 'OTHER_TYPE',
    'another-page': 'OTHER_TYPE',
  }),
 ],
};
  1. Configure your routes to use the daffExternalMatcherTypeGuard
import { Routes } from '@angular/router';

import { daffExternalMatcherTypeGuard } from '@daffodil/external-router/routing';

export const routes: Routes = [
 {
  path: '',
  pathMatch: 'full',
  component: HomeComponent,
 },
 {
  path: '**',
  component: TestComponent,
  canMatch: [daffExternalMatcherTypeGuard('TEST_TYPE')],
 },
 {
  path: '**',
  component: OtherTypeComponent,
  canMatch: [daffExternalMatcherTypeGuard('OTHER_TYPE')],
 },
];

You can use whatever type values you would like, just ensure they match the types set in provideDaffExternalRouterTestingDriver. These components are also just examples, you can replace them with whatever components you want.

  1. Add links to your AppComponent:
@Component({
 selector: 'app-root',
 standalone: true,
 imports: [RouterOutlet, RouterLink],
 templateUrl: './app.component.html',
 styleUrl: './app.component.scss',
})
export class AppComponent {}
<ul>
 <li><a routerLink="/">Home</a></li>
 <li><a routerLink="/test-page">Test</a></li>
 <li><a routerLink="/other-page">Other Type</a></li>
  <li><a routerLink="/another-page">Other Type (another)</a></li>
</ul>
<router-outlet></router-outlet>
  1. Serve your app.

You can now navigate to "/test-page", "/other-page", and "/another-page" as if it was defined in your Angular routes.

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.