24eb8389d2
- ts-api-guardian will now error if a new public symbol is added with a stability marker (`@stable`, `@experimental`, `@deprecated`) - DomEventsPlugin and KeyEventsPlugin were removed from public api surface - these classes is an implementation detail - deprecated BROWSER_PROVIDERS was removed completely - `@angular/compiler` was removed from the ts-api-guardian check since this package shouldn't contain anything that users need to directly import - the rest of the api surface was conservatively marked as stable or experimental BREAKING CHANGES: DomEventsPlugin and KeyEventsPlugin previously exported from core are no longer public - these classes are implementation detail. Previously deprecated BROWSER_PROVIDERS was completely removed from platform-browser. Closes #9236 Closes #9235 Ref #9234
107 lines
3.3 KiB
TypeScript
107 lines
3.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {Location, LocationStrategy, PathLocationStrategy} from '@angular/common';
|
|
import {APP_INITIALIZER, ApplicationRef, ComponentResolver, Injector, OpaqueToken} from '@angular/core';
|
|
|
|
import {RouterConfig} from './config';
|
|
import {Router} from './router';
|
|
import {RouterOutletMap} from './router_outlet_map';
|
|
import {ActivatedRoute} from './router_state';
|
|
import {DefaultUrlSerializer, UrlSerializer} from './url_tree';
|
|
|
|
export const ROUTER_CONFIG = new OpaqueToken('ROUTER_CONFIG');
|
|
export const ROUTER_OPTIONS = new OpaqueToken('ROUTER_OPTIONS');
|
|
|
|
/**
|
|
* @experimental
|
|
*/
|
|
export interface ExtraOptions { enableTracing?: boolean; }
|
|
|
|
export function setupRouter(
|
|
ref: ApplicationRef, resolver: ComponentResolver, urlSerializer: UrlSerializer,
|
|
outletMap: RouterOutletMap, location: Location, injector: Injector, config: RouterConfig,
|
|
opts: ExtraOptions) {
|
|
if (ref.componentTypes.length == 0) {
|
|
throw new Error('Bootstrap at least one component before injecting Router.');
|
|
}
|
|
const componentType = ref.componentTypes[0];
|
|
const r =
|
|
new Router(componentType, resolver, urlSerializer, outletMap, location, injector, config);
|
|
ref.registerDisposeListener(() => r.dispose());
|
|
|
|
if (opts.enableTracing) {
|
|
r.events.subscribe(e => {
|
|
console.group(`Router Event: ${(<any>e.constructor).name}`);
|
|
console.log(e.toString());
|
|
console.log(e);
|
|
console.groupEnd();
|
|
});
|
|
}
|
|
|
|
return r;
|
|
}
|
|
|
|
export function setupRouterInitializer(injector: Injector) {
|
|
// https://github.com/angular/angular/issues/9101
|
|
// Delay the router instantiation to avoid circular dependency (ApplicationRef ->
|
|
// APP_INITIALIZER -> Router)
|
|
setTimeout(() => {
|
|
const appRef = injector.get(ApplicationRef);
|
|
if (appRef.componentTypes.length == 0) {
|
|
appRef.registerBootstrapListener(() => { injector.get(Router).initialNavigation(); });
|
|
} else {
|
|
injector.get(Router).initialNavigation();
|
|
}
|
|
}, 0);
|
|
return (): any => null;
|
|
}
|
|
|
|
/**
|
|
* A list of {@link Provider}s. To use the router, you must add this to your application.
|
|
*
|
|
* ### Example
|
|
*
|
|
* ```
|
|
* @Component({directives: [ROUTER_DIRECTIVES]})
|
|
* class AppCmp {
|
|
* // ...
|
|
* }
|
|
*
|
|
* const router = [
|
|
* {path: '/home', component: Home}
|
|
* ];
|
|
*
|
|
* bootstrap(AppCmp, [provideRouter(router)]);
|
|
* ```
|
|
*
|
|
* @experimental
|
|
*/
|
|
export function provideRouter(_config: RouterConfig, _opts: ExtraOptions): any[] {
|
|
return [
|
|
{provide: ROUTER_CONFIG, useValue: _config}, {provide: ROUTER_OPTIONS, useValue: _opts},
|
|
Location, {provide: LocationStrategy, useClass: PathLocationStrategy},
|
|
{provide: UrlSerializer, useClass: DefaultUrlSerializer},
|
|
|
|
{
|
|
provide: Router,
|
|
useFactory: setupRouter,
|
|
deps: [
|
|
ApplicationRef, ComponentResolver, UrlSerializer, RouterOutletMap, Location, Injector,
|
|
ROUTER_CONFIG, ROUTER_OPTIONS
|
|
]
|
|
},
|
|
|
|
RouterOutletMap,
|
|
{provide: ActivatedRoute, useFactory: (r: Router) => r.routerState.root, deps: [Router]},
|
|
|
|
// Trigger initial navigation
|
|
{provide: APP_INITIALIZER, multi: true, useFactory: setupRouterInitializer, deps: [Injector]}
|
|
];
|
|
}
|