@pluginjs/breadcrumb

Breadcrumb

A flexible modern breadcrumb js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/breadcrumb

NPM

npm i @pluginjs/breadcrumb

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/breadcrumb/dist/breadcrumb.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/breadcrumb/dist/breadcrumb.css">

Production:

<script src="https://unpkg.com/@pluginjs/breadcrumb/dist/breadcrumb.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/breadcrumb/dist/breadcrumb.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Breadcrumb from "@pluginjs/breadcrumb"
import "@pluginjs/breadcrumb/dist/breadcrumb.css"

Breadcrumb.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/breadcrumb/dist/breadcrumb.css")
const Breadcrumb = require("@pluginjs/breadcrumb")

Breadcrumb.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/breadcrumb/dist/breadcrumb.css">
<script src="https://unpkg.com/@pluginjs/breadcrumb/dist/breadcrumb.js"></script>
<script>
  Pj.breadcrumb('.element', options)
</script>

API

Options

Options are called on breadcrumb instances through the breadcrumb options itself. You can also save the instances to variable for further use.

Name	Description	Default
"theme"	Add plugin theme option	null
"responsive"	Add responsive callback	true
"overflow"	Add direction of overflow	left
"ellipsisText"	Add is ellipsisText or not	…
"getItems"	Add getItems method	function() {...}
"getItemLink"	Add getItemLink method	function() {...}
"getDropdownMenu"	Add getDropdownMenu method	function() {...}
"templates"	Plugin default templates	{}

Events

Events are called on breadcrumb instances through the breadcrumb events itself. You can also save the instances to variable for further use.

Name	Description
"update"	Gets fired when plugin is destroy
"ready"	Gets fired when plugin is ready
"enable"	Gets fired when plugin is enabled
"disable"	Gets fired when plugin is disabled
"destroy"	Gets fired when plugin is destroy

Methods

Methods are called on breadcrumb instances through the breadcrumb method itself. You can also save the instances to variable for further use.

Name	Description
"enable"	Enabled plugin if plugin is disabled
"disable"	Disable plugin
"destroy"	Destroy plugin

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-breadcrumb "THEME" | Declare plugin theme | {namespace}--{theme} "OVERFLOW" | Declare overflow direction | {namespace}-{overflow} "ELEMENT" | Declare plugin element | {namespace} "TOGGLE" | Declare toggle element | {namespace}-toggle "TOGGLEICON" | Declare toggleicon element | caret "DROPDOWN" | Declare dropdown scope | dropdown "DROPDOWNMENU" | Declare dropdown menu node | dropdown-menu "DROPDOWNMENURIGHT" | Declare dropdown menu right space | dropdown-menu-right "DROPDOWNITEM" | Declare dropdown item node | `` "DROPDOWNITEMDISABLE" | Declare dropdown has disabled | `disabled` `"ELLIPSIS"` | Declare is Ellipsis element | `{namespace}-ellipsis` `"HIDDEN"` | Declare plugin has hidden | `{namespace}-hidden`

Browser support

Tested on all major browsers.

IE / Edge	Firefox	Chrome	Safari	Opera
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

License

@pluginjs/breadcrumb is Licensed under the GPL-v3 license.

If you want to use @pluginjs/breadcrumb project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [e-mail].

Copyright

Copyright (C) 2022 Creation Studio Limited.