All files / breadcrumb-router si-breadcrumb-router.model.ts

50% Statements 1/2
100% Branches 0/0
0% Functions 0/1
50% Lines 1/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62                                                                                                                  1x        
/**
 * Copyright (c) Siemens 2016 - 2025
 * SPDX-License-Identifier: MIT
 */
import { inject, InjectionToken } from '@angular/core';
import { ActivatedRouteSnapshot } from '@angular/router';
import { BreadcrumbItem } from '@siemens/element-ng/breadcrumb';
import { TranslatableString } from '@siemens/element-translate-ng/translate';
import { Observable } from 'rxjs';
 
import { SiBreadcrumbDefaultResolverService } from './si-breadcrumb-default-resolver.service';
 
/**
 * Defines the title and link of a breadcrumb item in a
 * route configuration and compatible to {@link BreadcrumbItem}.
 *
 * ```
 * {
 *   path: 'user-manual',
 *   component: UserManualComponent,
 *   data: {
 *     siBreadcrumb: [
 *       { title: 'USER_MANUAL.HEADING', link: '/main/user-manual' }
 *     ]
 *   }
 * }
 * ```
 *
 */
export interface BreadcrumbRouterLink {
  /**
   * Angular router link for the breadcrumb item.
   */
  link?: string;
  /**
   * Breadcrumb item title that will be translated.
   */
  title: TranslatableString;
}
 
/**
 * Service interface to resolve the breadcrumb items on the base of a route.
 */
export interface SiBreadcrumbResolverService {
  resolve(route: ActivatedRouteSnapshot): BreadcrumbItem[] | Observable<BreadcrumbItem[]>;
}
 
/**
 * Injection token to provide your own `SiBreadcrumbResolverService` implementation.
 *
 * ```
 * providers: [{
 *   provide: SI_BREADCRUMB_RESOLVER_SERVICE,
 *   useClass: CustomBreadcrumbResolverService,
 * }]
 * ```
 */
export const SI_BREADCRUMB_RESOLVER_SERVICE = new InjectionToken<SiBreadcrumbResolverService>(
  'si.breadcrumb.resolver.service',
  { providedIn: 'root', factory: () => inject(SiBreadcrumbDefaultResolverService) }
);