Breadcrumb Component - Vaadin Add-on Directory
Component providing an easy way to display breadcrumb on web pages
## Usage
Component providing an easy way to display breadcrumb on web pages. Breadcrumbs will be separated by ">" symbol. Clicking on any breadcrumb(except last one) will navigate user to page which is represented by this breadcrumb. It's possible to hide some of breadcrumbs on smaller viewports.
### Updates since version 3.0.0
- Web component part (version [2.0.0](https://github.com/vaadin-component-factory/vcf-breadcrumb/tree/v2.0.0)) is now Lit based.
- The first item in the breadcrumb is always shown in full.
- The items can be collapsed when space runs out. This is configurable by using the attribute `collapse`. When availabe space is not enough to display the full label, then the label is shown with ellipsis.
- If space is even more limited, and some breadcrumbs have the `collapse` attribute:
- Consecutive collapsed items are grouped into ranges.
- Each range is hidden when necessary and replaced with an ellipsis element.
- `shift` attribute from previous version was removed. Responsive behavior is now given by the `collapse` attribute implementation.
For example:
```
Breadcrumbs breadcrumbs = new Breadcrumbs();
breadcrumbs.add(
new Breadcrumb("Home","breadcrumbs/#"),
new Breadcrumb("Directory","breadcrumbs/#"),
new Breadcrumb("Components", "breadcrumbs/#", true),
new Breadcrumb("VCF Components", "breadcrumbs/#", true),
new Breadcrumb("Breadcrumbs"));
```
Breadcrumb "Components" & "VCF Components" will collapse and show ellipsis when space available for display is not enough.
#### Since version 3.1.0
- New feature to display a popover when clicking on the ellipsis element, to show the hidden breadcrumbs items .
#### Since version 3.2.0
- Update web component version to [2.2.0](https://github.com/vaadin-component-factory/vcf-breadcrumb/releases/tag/v2.2.0). This version adds support for [Mobile Mode](https://github.com/vaadin-component-factory/vcf-breadcrumb/issues/6), which can be triggered in two ways:
- Based on a fixed breakpoint (same as other Vaadin components): `(max-width: 450px), (max-height: 450px)` or
- Programmatically, using the flag `forceMobileMode`, which allows to enable mobile layout manually
### Client-side implementation
This is the server-side (Java) API for Vaadin Platform for the vcf-breadcrumb component. Looking for the client-side version? It can be found [here](https://www.npmjs.com/package/@vaadin-component-factory/vcf-breadcrumb).
## Vaadin platform version
- Support for Vaadin 14+ is starting from version 2.0.0.
- Support for Vaadin 24.5+ starts from version 3.0.0.
## License & Author
This Add-on is distributed under Apache 2.0
Component Factory Breadcrumb is written by Vaadin Ltd.
### Sponsored development
Major pieces of development of this add-on has been sponsored by multiple customers of Vaadin. Read more about Expert on Demand at: [Support](https://vaadin.com/support) and [Pricing](https://vaadin.com/pricing)
View on GitHub
Online Demo
Web-component
Breadcrumb Component version 1.2.0
updated client-side dependency to vcf-breadcrumb v1.2.0
Breadcrumb Component version 2.0.0
### Version 2.0.0
- Vaadin 14 compatible with both compatibility and npm mode
Breadcrumb Component version 2.0.1
Update the license to Apache 2.0
Breadcrumb Component version 3.0.0
Version 3.0.0 includes support for Vaadin 24.5+ and uses new web-component version 2.0.0 based on Lit.
Breadcrumb Component version 3.0.1
* Update web-component dependency to 2.0.1. This new web-component version includes fixes for:
- Remove a "hidden" class added to the anchors in the breadcrumb that is no needed
- Update on the exports value to fix a problem with the imports in the server side implementation of the component
Breadcrumb Component version 3.1.0
* Update web-component version to 2.1.0. This new version includes:
- New feature to display a popover showing the hidden breadcrumbs items on ellipsis element
- A fix to the resizing logic to avoid flickering
Breadcrumb Component version 3.1.1
Update web-component version to 2.1.1. This new web-component version contains fix to show focus ring without clipping.
Breadcrumb Component version 3.2.0
#### New features:
* Add support for mobile mode (web-component version 2.2.0).