@vaadin-component-factory/vcf-breadcrumb
v1.2.2
Published
Web Component providing an easy way to display breadcrumb.
Downloads
21
Readme
<vcf-breadcrumb>
This is the npm version vcf-breadcrumb developed using Polymer 3.
Live demo ↗ | API documentation ↗
Installation
Install vcf-breadcrumb
:
npm i @vaadin-component-factory/vcf-breadcrumb --save
Usage
Once installed, import it in your application:
import '@vaadin-component-factory/vcf-breadcrumb';
Add <vcf-breadcrumbs>
element to the page. Inside added element add few <vcf-breadcrumb>
child elements, with href
attribute. In case you want some <vcf-breadcrumb>
elements to not be shown in mobile view, add attribute shift
to those elements. When user click on <vcf-breadcrumb>
element he/she will be navigated to ULR from href
attribute of the element.
<vcf-breadcrumbs>
<vcf-breadcrumb shift href="#">Home</vcf-breadcrumb>
<vcf-breadcrumb href="#">Directory</vcf-breadcrumb>
<vcf-breadcrumb href="#">Breadcrumb</vcf-breadcrumb>
</vcf-breadcrumbs>
Running demo
Fork the
vcf-breadcrumb
repository and clone it locally.Make sure you have npm installed.
When in the
vcf-breadcrumb
directory, runnpm install
to install dependencies.Run
npm start
to open the demo.
Contributing
To contribute to the component, please read the guideline first.
Vaadin Prime
This component is available in the Vaadin Prime subscription. It is still open source, but you need to have a valid CVAL license in order to use it. Read more at: https://vaadin.com/pricing
License
Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.