# @jasoftware/jas-breadcrumbs

> Simple Breadcrumbs Menu

Latest version **3.0.6** (published 2019-09-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jasoftware/jas-breadcrumbs
pnpm add @jasoftware/jas-breadcrumbs
yarn add @jasoftware/jas-breadcrumbs
bun add @jasoftware/jas-breadcrumbs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.6 |
| Published | 2019-09-06 |
| First published | 2019-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 12.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | jasoftware |

## Links

- npm: https://www.npmjs.com/package/@jasoftware/jas-breadcrumbs
- Repository: https://github.com/homerjonathan/jas-breadcrumbs
- Homepage: https://github.com/homerjonathan/jas-breadcrumbs#readme
- Issues: https://github.com/homerjonathan/jas-breadcrumbs/issues
- npm.io page: https://npm.io/package/@jasoftware/jas-breadcrumbs

## Dependencies (4)

- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@polymer/iron-icon](https://npm.io/package/@polymer/iron-icon.md) ^3.0.0
- [@polymer/iron-iconset-svg](https://npm.io/package/@polymer/iron-iconset-svg.md) ^3.0.0
- [@polymer/paper-icon-button](https://npm.io/package/@polymer/paper-icon-button.md) ^3.0.0

## Recent versions

- 3.0.6 (latest) — 2019-09-06
- 3.0.5 — 2019-08-23
- 3.0.4 — 2019-04-07
- 3.0.3 — 2019-04-07
- 3.0.2 — 2019-04-07
- 3.0.1 — 2019-04-07
- 3.0.0 — 2019-04-06

## README

[![Published on Vaadin  Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg?style=flat-square)](https://vaadin.com/directory/component/homerjonathanjas-breadcrumbs)
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/homerjonathanjas-breadcrumbs.svg?style=flat-square)](https://vaadin.com/directory/component/homerjonathanjas-breadcrumbs)

<!--
```
<custom-element-demo>
<template>
    <link rel="import" href="jas-breadcrumbs.html">
    <jas-breadcrumbs id="breadcrumbs" selected="{{page}}"></jas-breadcrumbs>
    <script>
        document.addEventListener("DOMContentLoaded", function(event) {
          var breadCrumbMenu = [];
          breadCrumbMenu.push({text: "Main", id: "main"});
          breadCrumbMenu.push({text: "Second", id: "second"});
          breadCrumbMenu.push({text: "Third", id: "third"});
          JasBreadcrumbs.hook.setMenu(breadCrumbMenu);
        });
    </script>
</template>
</custom-element-demo>
```
-->

# \<jas-breadcrumbs\>

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

## Using the Component

```html

  <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.

```javascript
 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.

```html
  <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.

```javascript
    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".

```javascript
    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!

```javascript

  JasBreadcrumbs.hook 
  
```

---
_Source: https://npm.io/package/@jasoftware/jas-breadcrumbs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._