search

vaadin-component-factory / breadcrumb

Java API for vcf-breadcrumb
https://incubator.app.fi/breadcrumb-demo/breadcrumbs
Apache License 2.0
2 stars 0 forks source link

readme

Component Factory Breadcrumb for Vaadin 10+

Breadcrumb is the Java API for web component for Vaadin 10+. Support for Vaadin 14+ is starting from version 2.0.0. It provides an easy way to display breadcrumb on web pages.

Live Demo ↗

Screenshot of incubator-breadcrumbs

Usage

Create instance of Breadcrumbs and instances of Breadcrumb. You can set breadcrumb text and href. Also you can set property shift, which will indicate whether breadcrumb should be hidden for mobile view(when viewport is smaller then 420px).

Breadcrumbs breadcrumbs = new Breadcrumbs();
breadcrumbs.add(
    new Breadcrumb("Home","breadcrumbs/#", true),
    new Breadcrumb("Components", "breadcrumbs/#", true),
    new Breadcrumb("VCF Components", "breadcrumbs/#"),
    new Breadcrumb("Breadcrumbs"));

Breadcrumbs "Home" and "Components" will be hidden when viewport is less then 420px

Setting up for development:

Clone the project in GitHub (or fork it if you plan on contributing)

https://github.com/vaadin-component-factory/vcf-breadcrumb

To build and install the project into the local repository run

mvn install

Demo

To run demo go to breadcrumbs-demo/ subfolder and run mvn jetty:run. After server startup, you'll be able find demo at http://localhost:8080/breadcrumbs

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 and Pricing