jas-breadcrumbs | Vaadin

Simple Breadcrumbs Menu

[ This description is mirrored from README.md at github.com/homerjonathan/jas-breadcrumbs on 2019-05-10 ]

<jas-breadcrumbs>

Simple Breadcrumbs Menu with Help Icon at the right side of the Page. A Polymer 2.0 Component Only.

Using the Component

<link rel="import" href="../bower_components/jas-breadcrumbs/jas-breadcrumbs.html">
<jas-breadcrumbs id="breadcrumbs" selected="{{page}}"></jas-breadcrumbs>

This will create a menu. When the item is select the 'id' above is set to the attribute and also a message is fired. You can use your most prefered method of processing the event.

You set the breadcrumbs by sending an array in this example format below. It uses text for what appears on the menu whilst the id is what is outputted when clicked.

var breadCrumbMenu = [];
         breadCrumbMenu.push({text: "Main", id: "main"});
         breadCrumbMenu.push({text: "Second", id: "second"});
         breadCrumbMenu.push({text: "Third", id: "third"});
         this.$.breadcrumbs.setMenu(breadCrumbMenu);

Setting Colours

This component supports

  • --app-primary-color For the Help Icon Colour
  • --breadcrumb-highlight Colour of Link when the Mouse Hovers over the Breadcrumb Option
  • --breadcrumb-color1 Normal Colour of Breadcrumb Text

Events

There are two ways. The first example below. So you can trap the output in the Polymer way.

<jas-breadcrumbs id="breadcrumbs" selected="{{page}}"></jas-breadcrumbs>

Or you can trap the fired dispatch event and you can use it to change the page. Enter this into your script to trap the message.

document.addEventListener("page_change", function(e) {
    console.log("Event: Page Change Requested - ", e.detail.page);
    // Do Your Page Change Stuff Here
});

When the help button is pressed it sets the attribute selected to "help_page" but also dispatches an event message of "page_help".

document.addEventListener("page_help", function(e) {
    console.log("Help Page Requested");
    // Do Your Help Page Stuff Here
});

Hooking into the Component

It also links itself to its base class. So the last instance will overwrite the value, but normally you would only have one of these anyhow. This is useful "other" way of talking to the component. If there is a neater way let me know!

JasBreadcrumbs.hook

Install

Link to this version
ImportedReleased 27 December 2017MIT License
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (0.1.2)
Browser Compatibility
Install with
bower install --save homerjonathan/jas-breadcrumbs"#0.2.10"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 0.2.10

Dependencies

  • polymer#Polymer/polymer#1.9 - 2
  • paper-icon-button#^2.0.0
  • iron-iconset-svg#^2.0.0
  • iron-icon#^2.0.0