xng-breadcrumb

> A lightweight, declarative and dynamic breadcrumbs solution for Angular 6 and beyond.

![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml)
![npm version](https://www.npmjs.com/package/xng-breadcrumb)
!bundle size
![license](https://github.com/udayvunnam/xng-breadcrumb/blob/main/LICENSE)
!npm downloads

!Twitter follow

![All Contributors](#contributors-)

Why Choose Breadcrumbs?

Simplify Navigation: Breadcrumbs are vital in applications with deep navigation hierarchies, offering users an intuitive way to traverse back to higher levels effortlessly.

Documentation

For a step by step guide on integrating xng-breadcrumb into your Angular application, visit the Documentation.

Demo App

Explore our Demo App - showcasing the power of xng-breadcrumb in an Angular setup. Experience seamless breadcrumb navigation as you browse through various links!

Features

- ✅ Zero configuration: Just add anywhere in the app.Breadcrumb labels are automatically generated by analyzing Angular Route configurations.

- ✅ Custom labels:Define custom labels for each route via Angular Route Configurations, enhancing breadcrumb clarity and relevance.

- ✅ Update labels dynamically: Change breadcrumb labels dynamically using BreadcrumbService.set(), utilizing either _route path_ or _route alias_.

- ✅ Skip breadcrumb: Conditionally exclude specific routes from breadcrumb display

- ✅ Disable breadcrumb: Can disable specific routes in breadcrumbs to prevent navigation to intermediate states .

- ✅ Customization: Customize breadcrumb template to display icons with label, apply text formatting using pipes, integrate i18n with ngx-translate, and more.

- ✅ Styling and Seperators: Easily customize breadcrumb separators and styles to match your application's design

- ✅ QueryParams and Fragment: Preserves QueryParams and Fragement while navigating via breadcrumbs

- ✅ SSR: Supports server side rendering with nguniversal

❤️ Become a Sponsor!

Thanks goes to these wonderful people (emoji key):

_{Uday Vunnam} 💻 📖 🚧	_anthonythiry 💻	_dedrazer 💻	_{Danny Feliz} 📖	_Kapsky 💻	_{Andrei Cojea} 📖	_Jonathan 💻
_{Pavan Kumar Jadda} 💻	_{Leon Fretter} 💻	_{Lukáš Matta} 📖	_{Glenn Latomme} 💻	_{Ovidiu Haureș} 💻	_{Kristof Gilis} 💻	_Aleksander 💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

To add new contributor _username_, who made a contribution of type _contribution_:

pnpm all-contributors add Example: pnpm all-contributors add jfmengels code,doc