https://github.com/thecreation/jquery-asbreadcrumbs

A jquery plugin that make bootstrap breadcrumbs responisve.
https://github.com/thecreation/jquery-asbreadcrumbs

breadcrumbs jquery-plugin

Last synced: 3 months ago
JSON representation

A jquery plugin that make bootstrap breadcrumbs responisve.

Host: GitHub
URL: https://github.com/thecreation/jquery-asbreadcrumbs
Owner: thecreation
License: lgpl-3.0
Created: 2014-11-21T07:31:16.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2021-05-20T09:30:47.000Z (about 5 years ago)
Last Synced: 2025-08-09T09:02:08.664Z (10 months ago)
Topics: breadcrumbs, jquery-plugin
Language: JavaScript
Homepage:
Size: 410 KB
Stars: 8
Watchers: 4
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

          # [jQuery asBreadcrumbs](https://github.com/amazingSurge/jquery-asBreadcrumbs) ![bower][bower-image] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![prs-welcome]](#contributing)

> A jquery plugin that make bootstrap breadcrumbs responisve.

## Table of contents

- [Main files](#main-files)

- [Quick start](#quick-start)

- [Requirements](#requirements)

- [Usage](#usage)

- [Examples](#examples)

- [Options](#options)

- [Methods](#methods)

- [Events](#events)

- [No conflict](#no-conflict)

- [Browser support](#browser-support)

- [Contributing](#contributing)

- [Development](#development)

- [Changelog](#changelog)

- [Copyright and license](#copyright-and-license)

## Main files

```

dist/

├── jquery-asBreadcrumbs.js

├── jquery-asBreadcrumbs.es.js

├── jquery-asBreadcrumbs.min.js

└── css/

    ├── asBreadcrumbs.css

    └── asBreadcrumbs.min.css

```

## Quick start

Several quick start options are available:

#### Download the latest build

 * [Development](https://raw.githubusercontent.com/amazingSurge/jquery-asBreadcrumbs/master/dist/jquery-asBreadcrumbs.js) - unminified

 * [Production](https://raw.githubusercontent.com/amazingSurge/jquery-asBreadcrumbs/master/dist/jquery-asBreadcrumbs.min.js) - minified

#### Install From Bower

```sh

bower install jquery-asBreadcrumbs --save

```

#### Install From Npm

```sh

npm install jquery-asBreadcrumbs --save

```

#### Install From Yarn

```sh

yarn add jquery-asBreadcrumbs

```

#### Build From Source

If you want build from source:

```sh

git clone git@github.com:amazingSurge/jquery-asBreadcrumbs.git

cd jquery-asBreadcrumbs

npm install

npm install -g gulp-cli babel-cli

gulp build

```

Done!

## Requirements

`jquery-asBreadcrumbs` requires the latest version of [`jQuery`](https://jquery.com/download/) and [`bootstrap`](http://getbootstrap.com).

## Usage

#### Including files:

```html

```

#### Required HTML structure

```html



  Home

  Getting Started

  Library

  Document

  Components

  JavaScript

  Customize

  Data



```

#### Initialization

All you need to do is call the plugin on the element:

```javascript

jQuery(function($) {

  $('.example').asBreadcrumbs(); 

});

```

## Examples

There are some example usages that you can look at to get started. They can be found in the

[examples folder](https://github.com/amazingSurge/jquery-asBreadcrumbs/tree/master/examples).

## Options

`jquery-asBreadcrumbs` can accept an options object to alter the way it behaves. You can see the default options by call `$.asBreadcrumbs.setDefaults()`. The structure of an options object is as follows:

```

{

  namespace: 'breadcrumb',

  overflow: "left",

  responsive: true,

  ellipsisText: "…",

  ellipsisClass: null,

  hiddenClass: 'is-hidden',

  dropdownClass: null,

  dropdownMenuClass: null,

  dropdownItemClass: null,

  dropdownItemDisableClass: 'disabled',

  toggleClass: null,

  toggleIconClass: 'caret',

  getItems: function($parent) {

    return $parent.children();

  },

  getItemLink: function($item) {

    return $item.find('a');

  },

  // templates

  ellipsis: function(classes, label) {

    return `
${label}`;

  },

  dropdown: function(classes) {

    const dropdownClass = 'dropdown';

    let dropdownMenuClass = 'dropdown-menu';

    if (this.options.overflow === 'right') {

      dropdownMenuClass += ' dropdown-menu-right';

    }

    return `


      

        

      

      

    `;

  },

  dropdownItem: function(classes, label, href) {

    if(!href) {

      return `
${label}`;

    }

    return `${label}`;

  },

  // callbacks

  onInit: null,

  onReady: null

}

```

## Methods

Methods are called on asBreadcrumbs instances through the asBreadcrumbs method itself.

You can also save the instances to variable for further use.

```javascript

// call directly

$().asBreadcrumbs('destroy');

// or

var api = $().data('asBreadcrumbs');

api.destroy();

```

#### destroy()

Destroy the breadcrumbs instance.

```javascript

$().asBreadcrumbs('destroy');

```

## Events

`jquery-asBreadcrumbs` provides custom events for the plugin’s unique actions. 

```javascript

$('.breadcrumb').on('asBreadcrumbs::ready', function (e) {

  // on instance ready

});

```

Event   | Description

------- | -----------

init    | Fires when the instance is setup for the first time.

ready   | Fires when the instance is ready for API use.

update  | Fires after the breadcrumb layouts updated.

destroy | Fires when an instance is destroyed. 

## No conflict

If you have to use other plugin with the same namespace, just call the `$.asBreadcrumbs.noConflict` method to revert to it.

```html

  $.asBreadcrumbs.noConflict();

  // Code that uses other plugin's "$().asBreadcrumbs" can follow here.

```

## Browser support

Tested on all major browsers.

|  |  |  |  |  |  |

|:--:|:--:|:--:|:--:|:--:|:--:|

| Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |

As a jQuery plugin, you also need to see the [jQuery Browser Support](http://jquery.com/browser-support/).

## Contributing

Anyone and everyone is welcome to contribute. Please take a moment to

review the [guidelines for contributing](CONTRIBUTING.md). Make sure you're using the latest version of `jquery-asBreadcrumbs` before submitting an issue. There are several ways to help out:

* [Bug reports](CONTRIBUTING.md#bug-reports)

* [Feature requests](CONTRIBUTING.md#feature-requests)

* [Pull requests](CONTRIBUTING.md#pull-requests)

* Write test cases for open bug issues

* Contribute to the documentation

## Development

`jquery-asBreadcrumbs` is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:

```sh

npm install -g gulp

npm install -g babel-cli

npm install

```

Then you can generate new distributable files from the sources, using:

```

gulp build

```

More gulp tasks can be found [here](CONTRIBUTING.md#available-tasks).

## Changelog

To see the list of recent changes, see [Releases section](https://github.com/amazingSurge/jquery-asBreadcrumbs/releases).

## Copyright and license

Copyright (C) 2016 amazingSurge.

Licensed under [the LGPL license](LICENSE).

[⬆ back to top](#table-of-contents)

[bower-image]: https://img.shields.io/bower/v/jquery-asBreadcrumbs.svg?style=flat

[bower-link]: https://david-dm.org/amazingSurge/jquery-asBreadcrumbs/dev-status.svg

[npm-image]: https://badge.fury.io/js/jquery-asBreadcrumbs.svg?style=flat

[npm-url]: https://npmjs.org/package/jquery-asBreadcrumbs

[license]: https://img.shields.io/npm/l/jquery-asBreadcrumbs.svg?style=flat

[prs-welcome]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

[daviddm-image]: https://david-dm.org/amazingSurge/jquery-asBreadcrumbs.svg?style=flat

[daviddm-url]: https://david-dm.org/amazingSurge/jquery-asBreadcrumbs

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/thecreation/jquery-asbreadcrumbs

Awesome Lists containing this project

README