https://github.com/xdev-software/vaadin-breadcrumbs

A Breadcrumbs component for Vaadin Flow
https://github.com/xdev-software/vaadin-breadcrumbs

breadcrumbs vaadin vaadin-addon

Last synced: 9 months ago
JSON representation

A Breadcrumbs component for Vaadin Flow

• Host: GitHub
• URL: https://github.com/xdev-software/vaadin-breadcrumbs
• Owner: xdev-software
• License: apache-2.0
• Created: 2024-10-17T14:07:36.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2025-06-22T04:21:28.000Z (9 months ago)
• Last Synced: 2025-06-22T05:24:24.238Z (9 months ago)
• Topics: breadcrumbs, vaadin, vaadin-addon
• Language: Java
• Homepage: https://vaadin.com/directory/component/breadcrumbs-for-vaadin
• Size: 1.25 MB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/vaadin-breadcrumbs)

[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-breadcrumbs?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-breadcrumbs)

[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-breadcrumbs/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-breadcrumbs/actions/workflows/check-build.yml?query=branch%3Adevelop)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_vaadin-breadcrumbs&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_vaadin-breadcrumbs)

![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)

# vaadin-breadcrumbs

A Breadcrumbs component for Vaadin Flow.

![demo](assets/demo.png)

_What is a "Breadcrumb"?_ 


A component with a list of links that helps visualizing a page's location within a site's hierarchical structure, it allows navigation up to any of the ancestors.

## Installation

[Installation guide for the latest release](https://github.com/xdev-software/vaadin-breadcrumbs/releases/latest#Installation)

### Spring-Boot

* You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)

## Run the Demo

* Checkout the repo

* Run ``mvn install && mvn -f vaadin-breadcrumbs-demo spring-boot:run``

* Open http://localhost:8080

  Show example

  

  ![demo](assets/demo.avif)

## Support

If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).

## Contributing

See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.

## Dependencies and Licenses

View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-breadcrumbs/dependencies)

_This component [was sponsored](https://xdev.software/en/news/detail/collaboration-between-atu-and-xdev-leads-to-open-source-breadcrumb-component-for-vaadin) by [](https://atu.de)_