xng-breadcrumb
TypeScript icon, indicating that this package has built-in type declarations

11.0.0 • Public • Published

xng-breadcrumb

A lightweight, declarative and dynamic breadcrumbs solution for Angular 6 and beyond. https://www.npmjs.com/package/xng-breadcrumb

CI npm version bundle size license npm downloads

Twitter follow

All Contributors

About

  • In applications with deep navigation hierarchy, it is essential to have breadcrumbs.
  • Breadcrumbs easily allow going back to states higher up in the hierarchy.

Documentation

A step by step guide to integrate xng-breadcrumb into your Angular application

Demo

Demo App - A demo app showcasing xng-breadcrumb library usage in an Angular app. Navigate through different links to see breadcrumbs behavior.

xng-breadcrumb usage

Features

  • Zero configuration: Just add <xng-breadcrumb></xng-breadcrumb> anywhere in the app. Breadcrumb labels are auto-generated by analyzing Angular Route configuration in your App.

  • Custom labels: Each route can have a custom label defined via Angular Route Config. These labels are used automatically while generating breadcrumbs.

  • Update labels dynamically: Change breadcrumb labels dynamically using BreadcrumbService.set(). You can either use route path or route path alias to update label.

  • Skip breadcrumb: Skip specific routes from displaying in breadcrumbs, conditionally.

  • Disable breadcrumb: Disable specific routes so that navigation is disbaled to intermediate routes.

  • Customization: Customize breadcrumb template to show icons with label, use pipes on text, add i18n with ngx-translate, etc.

  • Styling: Separator and Styles can be customized with ease.

  • QueryParams and Fragment: Preserves QueryParams and Fragemnet while navigating via breadcrumbs

  • SSR: Supports server side rendering with nguniversal

Thanks goes to these wonderful people (emoji key):

Uday Vunnam
Uday Vunnam

💻 📖 🚧
anthonythiry
anthonythiry

💻
dedrazer
dedrazer

💻
Danny Feliz
Danny Feliz

📖
Kapsky
Kapsky

💻
Andrei Cojea
Andrei Cojea

📖
Jonathan
Jonathan

💻
Pavan Kumar Jadda
Pavan Kumar Jadda

💻
Leon Fretter
Leon Fretter

💻
Lukáš Matta
Lukáš Matta

📖
Glenn Latomme
Glenn Latomme

💻
Ovidiu Haureș
Ovidiu Haureș

💻
Add your contributions

Uday Vunnam

💻 📖 🚧

anthonythiry

💻

dedrazer

💻

Danny Feliz

📖

Kapsky

💻

Andrei Cojea

📖

Jonathan

💻

Pavan Kumar Jadda

💻 🚧

Leon Fretter

💻

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 <username> <contribution> Example: pnpm all-contributors add jfmengels code,doc

Package Sidebar

Install

npm i xng-breadcrumb

Weekly Downloads

16,807

Version

11.0.0

License

MIT

Unpacked Size

163 kB

Total Files

16

Last publish

Collaborators

  • udayvunnam