30 lines
1.7 KiB
Markdown
30 lines
1.7 KiB
Markdown
|
# [](http://ncuillery.github.io/angular-breadcrumb/)
|
||
|
|
[](https://travis-ci.org/ncuillery/angular-breadcrumb) [](https://coveralls.io/r/ncuillery/angular-breadcrumb)
|
||
|
|
|
||
|
|
Angular-breadcrumb is a module for [AngularJS](http://angularjs.org), which generates a breadcrumb for any page of your application. It is strongly based on the [ui-router](https://github.com/angular-ui/ui-router) framework and its hierarchical tree of states.
|
||
|
|
|
||
|
|
## Key features
|
||
|
|
- Build a breadcrumb with a step for each state in the current state's hierarchy,
|
||
|
|
- Display a human readable label for each step and allows angular binding in it,
|
||
|
|
- Work with minimal configuration,
|
||
|
|
- Allow custom template (default is a predefined [Bootstrap 3 breadcrumb template](http://getbootstrap.com/components/#breadcrumbs)).
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
- [Getting started](https://github.com/ncuillery/angular-breadcrumb/wiki/Getting-started)
|
||
|
|
- [API Reference](https://github.com/ncuillery/angular-breadcrumb/wiki/API-Reference)
|
||
|
|
- [Templating](https://github.com/ncuillery/angular-breadcrumb/wiki/Templating)
|
||
|
|
|
||
|
|
## Sample
|
||
|
|
See angular-breadcrumb in action [here](http://ncuillery.github.io/angular-breadcrumb/#/sample)
|
||
|
|
|
||
|
|
## Release History
|
||
|
|
See [CHANGELOG.md](https://github.com/ncuillery/angular-breadcrumb/blob/master/CHANGELOG.md)
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
See [CONTRIBUTING.md](https://github.com/ncuillery/angular-breadcrumb/blob/master/CONTRIBUTING.md)
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
Copyright (c) 2013 Nicolas Cuillery
|
||
|
|
Licensed under the MIT license.
|