packages/common/src/navigation/platform_navigation.ts - main - githubmirror/angular

packages/common/src/navigation/platform_navigation.ts
68 строк3 KB
Andrew Scott
refactor(common): Add token to indicate whether precommit handler is supported
07 янв 2026, 00:10
07 янв 2026, 00:10dd58c4b
/**
 * @license
 * Copyright Google LLC 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.dev/license
 */

import {
  Injectable,
  InjectionToken,
  ɵNavigateEvent as NavigateEvent,
  ɵNavigation as Navigation,
  ɵNavigationCurrentEntryChangeEvent as NavigationCurrentEntryChangeEvent,
  ɵNavigationHistoryEntry as NavigationHistoryEntry,
  ɵNavigationNavigateOptions as NavigationNavigateOptions,
  ɵNavigationOptions as NavigationOptions,
  ɵNavigationReloadOptions as NavigationReloadOptions,
  ɵNavigationResult as NavigationResult,
  ɵNavigationTransition as NavigationTransition,
  ɵNavigationUpdateCurrentEntryOptions as NavigationUpdateCurrentEntryOptions,
} from '@angular/core';

/**
 * @see https://developer.mozilla.org/en-US/docs/Web/API/NavigationPrecommitController
 * @see https://developer.mozilla.org/en-US/docs/Web/API/NavigateEvent/intercept#precommithandler
 */
export const PRECOMMIT_HANDLER_SUPPORTED = new InjectionToken<boolean>('', {
  factory: () => {
    return (
      typeof window !== 'undefined' &&
      typeof (window as any).NavigationPrecommitController !== 'undefined'
    );
  },
});

/**
 * This class wraps the platform Navigation API which allows server-specific and test
 * implementations.
 *
 * Browser support is limited, so this API may not be available in all environments,
 * may contain bugs, and is experimental.
 *
 * @experimental 21.0.0
 */
@Injectable({providedIn: 'platform', useFactory: () => (window as any).navigation})
export abstract class PlatformNavigation implements Navigation {
  abstract entries(): NavigationHistoryEntry[];
  abstract currentEntry: NavigationHistoryEntry | null;
  abstract updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void;
  abstract transition: NavigationTransition | null;
  abstract canGoBack: boolean;
  abstract canGoForward: boolean;
  abstract navigate(url: string, options?: NavigationNavigateOptions | undefined): NavigationResult;
  abstract reload(options?: NavigationReloadOptions | undefined): NavigationResult;
  abstract traverseTo(key: string, options?: NavigationOptions | undefined): NavigationResult;
  abstract back(options?: NavigationOptions | undefined): NavigationResult;
  abstract forward(options?: NavigationOptions | undefined): NavigationResult;
  abstract onnavigate: ((this: Navigation, ev: NavigateEvent) => any) | null;
  abstract onnavigatesuccess: ((this: Navigation, ev: Event) => any) | null;
  abstract onnavigateerror: ((this: Navigation, ev: ErrorEvent) => any) | null;
  abstract oncurrententrychange:
    | ((this: Navigation, ev: NavigationCurrentEntryChangeEvent) => any)
    | null;
  abstract addEventListener(type: unknown, listener: unknown, options?: unknown): void;
  abstract removeEventListener(type: unknown, listener: unknown, options?: unknown): void;
  abstract dispatchEvent(event: Event): boolean;
}