Skip to main content
cngx-src documentation

provideBreadcrumbConfig

Functionui/breadcrumbv0.1.0

projects/ui/breadcrumb/config/provide-breadcrumb-config.ts

Description#

Application-root configuration cascade for the breadcrumb family. Pass any combination of withBreadcrumbAriaLabels, withBreadcrumbDataKey, withBreadcrumbIconKey, and withBreadcrumbSkin features in bootstrapApplication's providers array.

Resolution priority (high -> low):

  1. Per-instance Input binding.
  2. provideBreadcrumbConfigAt(...) in a parent component's viewProviders.
  3. provideBreadcrumbConfig(...) at the application root.
  4. Library defaults (CNGX_BREADCRUMB_DEFAULTS).

The provider deep-merges supplied features with the library defaults so consumers only declare keys they want to override.

bootstrapApplication(AppComponent, {
  providers: [
    provideBreadcrumbConfig(
      withBreadcrumbAriaLabels({ bar: 'Navigation trail' }),
      withBreadcrumbDataKey('crumb'),
    ),
  ],
});

Signature#

provideBreadcrumbConfig(...features: undefined)

Parameters#

@paramfeatures

Returns#

EnvironmentProviders