docs: add new tutorial that explains how to use the UrlMatcher for custom route matching (#42138)
PR Close #42138
This commit is contained in:
David Shevitz
Zach Arend
parent
d6bc61ab5f
commit
99f5b872e1
|
|
@ -584,7 +584,9 @@ groups:
|
|||
'aio/content/guide/router-reference.md',
|
||||
'aio/content/examples/router-tutorial/**',
|
||||
'aio/content/examples/router/**',
|
||||
'aio/content/images/guide/router/**'
|
||||
'aio/content/images/guide/router/**',
|
||||
'aio/content/guide/routing-with-urlmatcher.md',
|
||||
'aio/content/examples/routing-with-urlmatcher/**'
|
||||
])
|
||||
reviewers:
|
||||
users:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
import { browser, element, by } from 'protractor';
|
||||
|
||||
describe('Routing with Custom Matching', () => {
|
||||
|
||||
beforeAll(() => browser.get(''));
|
||||
|
||||
it('should display Routing with Custom Matching ', async () => {
|
||||
expect(await element(by.css('h2')).getText()).toEqual('Routing with Custom Matching');
|
||||
});
|
||||
|
||||
});
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
p {
|
||||
font-family: Lato;
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<h2>Routing with Custom Matching</h2>
|
||||
|
||||
Navigate to <a routerLink="/@Angular">my profile</a>
|
||||
|
||||
<router-outlet></router-outlet>
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
import { Component, VERSION } from '@angular/core';
|
||||
|
||||
@Component({
|
||||
selector: 'my-app',
|
||||
templateUrl: './app.component.html',
|
||||
styleUrls: [ './app.component.css' ]
|
||||
})
|
||||
export class AppComponent {
|
||||
name = 'Angular ' + VERSION.major;
|
||||
}
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
import { NgModule } from '@angular/core';
|
||||
import { BrowserModule } from '@angular/platform-browser';
|
||||
import { FormsModule } from '@angular/forms';
|
||||
// #docregion import
|
||||
import { RouterModule, UrlSegment } from '@angular/router';
|
||||
// #enddocregion import
|
||||
|
||||
import { AppComponent } from './app.component';
|
||||
import { ProfileComponent } from './profile/profile.component';
|
||||
|
||||
// #docregion imports-array
|
||||
@NgModule({
|
||||
imports: [
|
||||
BrowserModule,
|
||||
FormsModule,
|
||||
RouterModule.forRoot([
|
||||
{
|
||||
// #enddocregion imports-array
|
||||
// #docregion matcher
|
||||
matcher: (url) => {
|
||||
if (url.length === 1 && url[0].path.match(/^@[\w]+$/gm)) {
|
||||
return {
|
||||
consumed: url,
|
||||
posParams: {
|
||||
username: new UrlSegment(url[0].path.substr(1), {})
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
return null;
|
||||
},
|
||||
component: ProfileComponent
|
||||
}
|
||||
// #enddocregion matcher
|
||||
// #docregion imports-array
|
||||
])],
|
||||
declarations: [ AppComponent, ProfileComponent ],
|
||||
bootstrap: [ AppComponent ]
|
||||
})
|
||||
// #enddocregion imports-array
|
||||
export class AppModule { }
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<p>
|
||||
Hello {{ username$ | async }}!
|
||||
</p>
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
import { Component, OnInit } from '@angular/core';
|
||||
// #docregion activated-route-and-parammap
|
||||
import { ActivatedRoute, ParamMap } from '@angular/router';
|
||||
// #enddocregion activated-route-and-parammap
|
||||
// #docregion rxjs-map
|
||||
import { map } from 'rxjs/operators';
|
||||
// #enddocregion rxjs-map
|
||||
|
||||
@Component({
|
||||
selector: 'app-profile',
|
||||
templateUrl: './profile.component.html',
|
||||
styleUrls: ['./profile.component.css']
|
||||
})
|
||||
export class ProfileComponent implements OnInit {
|
||||
// #docregion subscribe
|
||||
username$ = this.route.paramMap
|
||||
.pipe(
|
||||
map((params: ParamMap) => params.get('username'))
|
||||
);
|
||||
// #enddocregion subscribe
|
||||
// #docregion activatedroute
|
||||
constructor(private route: ActivatedRoute) { }
|
||||
// #enddocregion activatedroute
|
||||
ngOnInit() {
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<base href="/">
|
||||
<title>Angular App</title>
|
||||
</head>
|
||||
<body>
|
||||
<my-app>loading</my-app>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
// #docregion
|
||||
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
|
||||
|
||||
import { AppModule } from './app/app.module';
|
||||
|
||||
platformBrowserDynamic().bootstrapModule(AppModule);
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Router",
|
||||
"files":[
|
||||
"!**/*.d.ts",
|
||||
"!**/*.js",
|
||||
"!**/*.[0-9].*"
|
||||
],
|
||||
"tags": ["router-with-custom-matching"]
|
||||
}
|
||||
|
|
@ -0,0 +1,140 @@
|
|||
# Tutorial: Creating custom route matches
|
||||
|
||||
The Angular Router supports a powerful matching strategy that you can use to help users navigate your application. This matching strategy supports static routes, variable routes with parameters, wildcard routes, and so on. You can also build your own custom pattern matching for situations in which the URLs are more complicated.
|
||||
|
||||
In this tutorial, you'll build a custom route matcher using Angular's `UrlMatcher`. This matcher looks for a Twitter handle in the URL.
|
||||
|
||||
For a working example of the final version of this tutorial, see the <live-example></live-example>.
|
||||
|
||||
## Objectives
|
||||
|
||||
Implement Angular's `UrlMatcher` to create a custom route matcher.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To complete this tutorial, you should have a basic understanding of the following concepts:
|
||||
|
||||
* JavaScript
|
||||
* HTML
|
||||
* CSS
|
||||
* [Angular CLI](/cli)
|
||||
|
||||
If you are unfamiliar with how Angular's router works, we recommend you review [Using Angular routes in a single-page application](guide/router-tutorial).
|
||||
|
||||
## Create a sample application
|
||||
|
||||
Using the Angular CLI, create a new application, _angular-custom-route-match_. In addition to the default Angular application framework, you will also create a _profile_ component.
|
||||
|
||||
1. Create a new Angular project, _angular-custom-route-match_.
|
||||
|
||||
<code-example language="sh">
|
||||
ng new angular-custom-route-match
|
||||
</code-example>
|
||||
|
||||
When prompted with `Would you like to add Angular routing?`, select `Y`.
|
||||
|
||||
When prompted with `Which stylesheet format would you like to use?`, select `CSS`.
|
||||
|
||||
After a few moments, a new project, `angular-custom-route-match`, is ready.
|
||||
|
||||
1. From your terminal, navigate to the `angular-custom-route-match` directory.
|
||||
|
||||
1. Create a component, _profile_.
|
||||
|
||||
<code-example language="sh">
|
||||
ng generate component profile
|
||||
</code-example>
|
||||
|
||||
1. In your code editor, locate the file, `profile.component.html` and replace
|
||||
the placeholder content with the following HTML.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/profile/profile.component.html" header="routing-with-urlmatcher/src/app/profile/profile.component.html"></code-example>
|
||||
|
||||
1. In your code editor, locate the file, `app.component.html` and replace
|
||||
the placeholder content with the following HTML.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/profile/profile.component.html" header="routing-with-urlmatcher/src/app/profile/profile.component.html"></code-example>
|
||||
|
||||
## Configure your routes for your application
|
||||
|
||||
With your application framework in place, you next need to add routing capabilities to the `app.module.ts` file. As a part of this process, you will create a custom URL matcher that looks for a Twitter handle in the URL. This handle is identified by a preceding `@` symbol.
|
||||
|
||||
1. In your code editor, open your `app.module.ts` file.
|
||||
|
||||
1. Add an `import` statement for Angular's `RouterModule` and `UrlMatcher`.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/app.module.ts" header="routing-with-urlmatcher/src/app/app.module.ts" region="import"></code-example>
|
||||
|
||||
1. In the imports array, add a `RouterModule.forRoot([])` statement.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/app.module.ts" header="routing-with-urlmatcher/src/app/app.module.ts" region="imports-array"></code-example>
|
||||
|
||||
1. Define the custom route matcher by adding the following code to the `RouterModule.forRoot()` statement.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/app.module.ts" header="routing-with-urlmatcher/src/app/app.module.ts" region="matcher"></code-example>
|
||||
|
||||
This custom matcher is a function that performs the following tasks:
|
||||
|
||||
* The matcher verifies that the array contains only one segment.
|
||||
* The matcher employs a regular expression to ensure that the format of the username is a match.
|
||||
* If there is a match, the function returns the entire URL, defining a `username` route parameter as a substring of the path.
|
||||
* If there isn't a match, the function returns null and the router continues to look for other routes that match the URL.
|
||||
|
||||
<div class="is-helpful">
|
||||
|
||||
A custom URL matcher behaves like any other route definition. You can define child routes or lazy loaded routes as you would with any other route.
|
||||
|
||||
</div>
|
||||
|
||||
## Subscribe to the route parameters
|
||||
|
||||
With the custom matcher in place, you now need to subscribe to the route parameters in the `profile` component.
|
||||
|
||||
1. In your code editor, open your `profile.component.ts` file.
|
||||
|
||||
1. Add an `import` statement for Angular's `ActivatedRoute` and `ParamMap`.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/profile/profile.component.ts" header="routing-with-urlmatcher/src/app/profile/profile.component.ts" region="activated-route-and-parammap"></code-example>
|
||||
|
||||
1. Add an `import` statement for RxJS `map`.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/profile/profile.component.ts" header="routing-with-urlmatcher/src/app/profile/profile.component.ts" region="rxjs-map"></code-example>
|
||||
|
||||
1. Subscribe to the `username` route parameter.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/profile/profile.component.ts" header="routing-with-urlmatcher/src/app/profile/profile.component.ts" region="subscribe"></code-example>
|
||||
|
||||
1. Inject the `ActivatedRoute` into the component's constructor.
|
||||
|
||||
<code-example path="routing-with-urlmatcher/src/app/profile/profile.component.ts" header="routing-with-urlmatcher/src/app/profile/profile.component.ts" region="activatedroute"></code-example>
|
||||
|
||||
## Test your custom URL matcher
|
||||
|
||||
With your code in place, you can now test your custom URL matcher.
|
||||
|
||||
1. From a terminal window, run the `ng serve` command.
|
||||
|
||||
<code-example language="sh">
|
||||
ng serve
|
||||
</code-example>
|
||||
|
||||
1. Open a browser to `http://localhost:4200`.
|
||||
|
||||
You should see a single web page, consisting of a sentence that reads `Navigate to my profile`.
|
||||
|
||||
1. Click the **my profile** hyperlink.
|
||||
|
||||
A new sentence, reading `Hello, Angular!` appears on the page.
|
||||
|
||||
## Next steps
|
||||
|
||||
Pattern matching with the Angular Router provides you with a lot of flexibility when you have dynamic URLs in your application. To learn more about the Angular Router, see the following topics:
|
||||
|
||||
* [In-app Routing and Navigation](/guide/router)
|
||||
* [Router API](/api/router)
|
||||
|
||||
<div class="alert is-helpful">
|
||||
|
||||
This content is based on [Custom Route Matching with the Angular Router](https://medium.com/@brandontroberts/custom-route-matching-with-the-angular-router-fbdd48665483), by [Brandon Roberts](https://twitter.com/brandontroberts).
|
||||
|
||||
</div>
|
||||
|
|
@ -276,6 +276,11 @@
|
|||
"title": "Tutorial: Routing in Single-page Applications",
|
||||
"tooltip": "A tutorial that covers many patterns associated with Angular routing."
|
||||
},
|
||||
{
|
||||
"url": "guide/routing-with-urlmatcher",
|
||||
"title": "Tutorial: Creating custom route matches",
|
||||
"tooltip": "Learn how to create a custom URL matcher with the Angular router."
|
||||
},
|
||||
{
|
||||
"url": "guide/router-tutorial-toh",
|
||||
"title": "Tutorial: Adding routing to Tour of Heroes",
|
||||
|
|
|
|||
Loading…
Reference in New Issue