Skip to main content
cngx-src documentation

CngxBreadcrumbConfig

Interface

projects/ui/breadcrumb/config/breadcrumb.config.ts

Import#

import { CngxBreadcrumbConfig } from '@cngx/ui/breadcrumb'

Description#

App-wide cascade for the breadcrumb family's ARIA labels, the router dataKey, and the default visual skin.

Resolution priority (high -> low):

  1. Per-instance Input binding (e.g. [label]="'Trail'", skin="pill").
  2. provideBreadcrumbConfigAt(...) in a parent component's viewProviders (component-scoped override).
  3. provideBreadcrumbConfig(...) at the application root.
  4. Library defaults (English; merged in via CNGX_BREADCRUMB_DEFAULTS).

Every key is optional - partial overrides deep-merge with the library defaults, so consumers declare only the keys they want to override.

Index#

Instance Properties#

ariaLabels#literal type
ReadonlyOptional

ARIA-string fallbacks for the bar landmark and the overflow/siblings dropdown triggers and lists. Per-instance [label]/[triggerLabel]/ [menuLabel] bindings still win over these.

router#literal type
ReadonlyOptional

Router-sync defaults shared by the trail (CngxBreadcrumbRouterSync) and siblings (CngxBreadcrumbSiblingsRouterSync) route directives.

ReadonlyOptional

App-wide default visual skin. Per-instance [skin] still wins; this only moves the cascade default. Unset resolves to 'classic' at the bar. A flat top-level scalar (like config.skin in tabs), not a nested sub-tree.